View Javadoc
1   /*
2    * This file is part of dependency-check-maven.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   *
16   * Copyright (c) 2015 Jeremy Long. All Rights Reserved.
17   */
18  package org.owasp.dependencycheck.maven;
19  
20  import java.io.File;
21  import java.io.IOException;
22  import java.util.Locale;
23  import org.apache.maven.plugin.MojoExecutionException;
24  import org.apache.maven.plugin.MojoFailureException;
25  import org.apache.maven.plugins.annotations.LifecyclePhase;
26  import org.apache.maven.plugins.annotations.Mojo;
27  import org.apache.maven.plugins.annotations.ResolutionScope;
28  import org.owasp.dependencycheck.utils.Settings;
29  
30  /**
31   * Maven Plugin that purges the local copy of the NVD data.
32   *
33   * @author Jeremy Long
34   */
35  @Mojo(
36          name = "purge",
37          defaultPhase = LifecyclePhase.GENERATE_RESOURCES,
38          threadSafe = false,
39          requiresDependencyResolution = ResolutionScope.NONE,
40          requiresOnline = true
41  )
42  public class PurgeMojo extends BaseDependencyCheckMojo {
43  
44      /**
45       * Returns false; this mojo cannot generate a report.
46       *
47       * @return <code>false</code>
48       */
49      @Override
50      public boolean canGenerateReport() {
51          return false;
52      }
53  
54      /**
55       * Purges the local copy of the NVD.
56       *
57       * @throws MojoExecutionException thrown if there is an exception executing the goal
58       * @throws MojoFailureException thrown if dependency-check is configured to fail the build
59       */
60      @Override
61      public void runCheck() throws MojoExecutionException, MojoFailureException {
62  
63          if (getConnectionString() != null && !getConnectionString().isEmpty()) {
64              getLog().error("Unable to purge the local NVD when using a non-default connection string");
65          } else {
66              populateSettings();
67              File db;
68              try {
69                  db = new File(Settings.getDataDirectory(), "dc.h2.db");
70                  if (db.exists()) {
71                      if (db.delete()) {
72                          getLog().info("Database file purged; local copy of the NVD has been removed");
73                      } else {
74                          getLog().error(String.format("Unable to delete '%s'; please delete the file manually", db.getAbsolutePath()));
75                      }
76                  } else {
77                      getLog().error(String.format("Unable to purge database; the database file does not exists: %s", db.getAbsolutePath()));
78                  }
79              } catch (IOException ex) {
80                  getLog().error("Unable to delete the database");
81              }
82              Settings.cleanup();
83          }
84      }
85  
86      /**
87       * Returns the report name.
88       *
89       * @param locale the location
90       * @return the report name
91       */
92      @Override
93      public String getName(Locale locale) {
94          return "dependency-check-purge";
95      }
96  
97      /**
98       * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
99       *
100      * @param locale The Locale to get the description for
101      * @return the description
102      */
103     @Override
104     public String getDescription(Locale locale) {
105         return "Purges the local cache of the NVD dataT.";
106     }
107 
108 }