/*
    * This file is part of dependency-check-maven.
    *
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    *
    *     http://www.apache.org/licenses/LICENSE-2.0
    *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   *
   * Copyright (c) 2013 Jeremy Long. All Rights Reserved.
   */
  package org.owasp.dependencycheck.maven;
  
  import java.util.Locale;
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.maven.plugin.MojoFailureException;
  import org.apache.maven.plugins.annotations.LifecyclePhase;
  import org.apache.maven.plugins.annotations.Mojo;
  import org.apache.maven.plugins.annotations.ResolutionScope;
  import org.owasp.dependencycheck.data.nvdcve.DatabaseException;
  import org.owasp.dependencycheck.utils.Settings;
  
  /**
   * Maven Plugin that checks the project dependencies to see if they have any known published vulnerabilities.
   *
   * @author Jeremy Long
   */
  @Mojo(
          name = "update-only",
          defaultPhase = LifecyclePhase.GENERATE_RESOURCES,
          threadSafe = false,
          requiresDependencyResolution = ResolutionScope.NONE,
          requiresOnline = true
  )
  public class UpdateMojo extends BaseDependencyCheckMojo {
  
      /**
       * Returns false; this mojo cannot generate a report.
       *
       * @return <code>false</code>
       */
      @Override
      public boolean canGenerateReport() {
          return false;
      }
  
      /**
       * Executes the dependency-check engine on the project's dependencies and generates the report.
       *
       * @throws MojoExecutionException thrown if there is an exception executing the goal
       * @throws MojoFailureException thrown if dependency-check is configured to fail the build
       */
      @Override
      public void runCheck() throws MojoExecutionException, MojoFailureException {
          final Engine engine;
          try {
              engine = initializeEngine();
              engine.update();
          } catch (DatabaseException ex) {
              if (getLog().isDebugEnabled()) {
                  getLog().debug("Database connection error", ex);
              }
              throw new MojoExecutionException("An exception occured connecting to the local database. Please see the log file for more details.", ex);
          }
          engine.cleanup();
          Settings.cleanup();
      }
  
      /**
       * Returns the report name.
       *
       * @param locale the location
       * @return the report name
       */
      @Override
      public String getName(Locale locale) {
          return "dependency-check-update";
      }
  
      /**
       * Gets the description of the Dependency-Check report to be displayed in the Maven Generated Reports page.
       *
       * @param locale The Locale to get the description for
       * @return the description
       */
      @Override
      public String getDescription(Locale locale) {
          return "Updates the local cache of the NVD data from NIST.";
      }
  
  }