/*
    * Licensed to the Apache Software Foundation (ASF) under one
    * or more contributor license agreements.  See the NOTICE file
    * distributed with this work for additional information
    * regarding copyright ownership.  The ASF licenses this file
    * to you 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.
   */
  package org.apache.maven.plugins.dependency.resolvers;
  
  import java.io.IOException;
  import java.util.HashSet;
  import java.util.LinkedHashSet;
  import java.util.Objects;
  import java.util.Set;
  
  import org.apache.maven.RepositoryUtils;
  import org.apache.maven.artifact.Artifact;
  import org.apache.maven.plugin.MojoExecutionException;
  import org.apache.maven.plugins.annotations.LifecyclePhase;
  import org.apache.maven.plugins.annotations.Mojo;
  import org.apache.maven.plugins.annotations.Parameter;
  import org.apache.maven.plugins.dependency.utils.DependencyUtil;
  import org.apache.maven.project.ProjectBuildingRequest;
  import org.apache.maven.shared.artifact.filter.collection.ArtifactFilterException;
  import org.apache.maven.shared.artifact.filter.collection.ArtifactIdFilter;
  import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
  import org.apache.maven.shared.artifact.filter.collection.ClassifierFilter;
  import org.apache.maven.shared.artifact.filter.collection.FilterArtifacts;
  import org.apache.maven.shared.artifact.filter.collection.GroupIdFilter;
  import org.apache.maven.shared.artifact.filter.collection.ScopeFilter;
  import org.apache.maven.shared.artifact.filter.collection.TypeFilter;
  import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResolverException;
  import org.apache.maven.shared.transfer.artifact.resolve.ArtifactResult;
  import org.apache.maven.shared.transfer.dependencies.DefaultDependableCoordinate;
  import org.apache.maven.shared.transfer.dependencies.DependableCoordinate;
  import org.apache.maven.shared.transfer.dependencies.resolve.DependencyResolverException;
  import org.eclipse.aether.resolution.ArtifactResolutionException;
  
  /**
   * Goal that resolves all project plugins and reports and their dependencies.
   *
   * @author <a href="mailto:brianf@apache.org">Brian Fox</a>
   * @since 2.0
   */
  @Mojo(name = "resolve-plugins", defaultPhase = LifecyclePhase.GENERATE_SOURCES, threadSafe = true)
  public class ResolvePluginsMojo extends AbstractResolveMojo {
  
      @Parameter(property = "outputEncoding", defaultValue = "${project.reporting.outputEncoding}")
      private String outputEncoding;
  
      /**
       * Output absolute filename for resolved artifacts
       *
       * @since 2.0
       */
      @Parameter(property = "outputAbsoluteArtifactFilename", defaultValue = "false")
      private boolean outputAbsoluteArtifactFilename;
  
      /**
       * Main entry into mojo. Gets the list of dependencies and iterates through displaying the resolved version.
       *
       * @throws MojoExecutionException with a message if an error occurs.
       */
      @Override
      protected void doExecute() throws MojoExecutionException {
          try {
              // ideally this should either be DependencyCoordinates or DependencyNode
              final Set<Artifact> plugins = resolvePluginArtifacts();
  
              StringBuilder sb = new StringBuilder();
              sb.append(System.lineSeparator());
              sb.append("The following plugins have been resolved:");
              sb.append(System.lineSeparator());
              if (plugins == null || plugins.isEmpty()) {
                  sb.append("   none");
                  sb.append(System.lineSeparator());
              } else {
                  for (Artifact plugin : plugins) {
                      String artifactFilename = null;
                      if (outputAbsoluteArtifactFilename) {
                          try {
                              // we want to print the absolute file name here
                              artifactFilename =
                                      plugin.getFile().getAbsoluteFile().getPath();
                          } catch (NullPointerException e) {
                              // ignore the null pointer, we'll output a null string
                              artifactFilename = null;
                          }
                     }
 
                     String id = plugin.toString();
                     sb.append("   ")
                             .append(id)
                             .append(outputAbsoluteArtifactFilename ? ":" + artifactFilename : "")
                             .append(System.lineSeparator());
 
                     if (!excludeTransitive) {
                         DefaultDependableCoordinate pluginCoordinate = new DefaultDependableCoordinate();
                         pluginCoordinate.setGroupId(plugin.getGroupId());
                         pluginCoordinate.setArtifactId(plugin.getArtifactId());
                         pluginCoordinate.setVersion(plugin.getVersion());
 
                         for (final Artifact artifact : resolveArtifactDependencies(pluginCoordinate)) {
                             artifactFilename = null;
                             if (outputAbsoluteArtifactFilename) {
                                 try {
                                     // we want to print the absolute file name here
                                     artifactFilename =
                                             artifact.getFile().getAbsoluteFile().getPath();
                                 } catch (NullPointerException e) {
                                     // ignore the null pointer, we'll output a null string
                                     artifactFilename = null;
                                 }
                             }
 
                             id = artifact.toString();
                             sb.append("      ")
                                     .append(id)
                                     .append(outputAbsoluteArtifactFilename ? ":" + artifactFilename : "")
                                     .append(System.lineSeparator());
                         }
                     }
                 }
                 sb.append(System.lineSeparator());
 
                 String output = sb.toString();
                 if (outputFile == null) {
                     DependencyUtil.log(output, getLog());
                 } else {
                     String encoding = Objects.toString(outputEncoding, "UTF-8");
                     DependencyUtil.write(output, outputFile, appendOutput, encoding);
                 }
             }
         } catch (IOException
                 | ArtifactFilterException
                 | ArtifactResolverException
                 | DependencyResolverException
                 | ArtifactResolutionException e) {
             throw new MojoExecutionException(e.getMessage(), e);
         }
     }
 
     /**
      * This method resolves all transitive dependencies of an artifact.
      *
      * @param artifact the artifact used to retrieve dependencies
      * @return resolved set of dependencies
      * @throws DependencyResolverException in case of error while resolving artifacts.
      */
     private Set<Artifact> resolveArtifactDependencies(final DependableCoordinate artifact)
             throws DependencyResolverException {
         ProjectBuildingRequest buildingRequest = newResolveArtifactProjectBuildingRequest();
 
         Iterable<ArtifactResult> artifactResults =
                 getDependencyResolver().resolveDependencies(buildingRequest, artifact, null);
 
         Set<Artifact> artifacts = new LinkedHashSet<>();
 
         for (final ArtifactResult artifactResult : artifactResults) {
             artifacts.add(artifactResult.getArtifact());
         }
 
         return artifacts;
     }
 
     /**
      * @return {@link FilterArtifacts}
      */
     private FilterArtifacts getArtifactsFilter() {
         final FilterArtifacts filter = new FilterArtifacts();
 
         if (excludeReactor) {
 
             filter.addFilter(new ExcludeReactorProjectsArtifactFilter(reactorProjects, getLog()));
         }
 
         filter.addFilter(new ScopeFilter(
                 DependencyUtil.cleanToBeTokenizedString(this.includeScope),
                 DependencyUtil.cleanToBeTokenizedString(this.excludeScope)));
 
         filter.addFilter(new TypeFilter(
                 DependencyUtil.cleanToBeTokenizedString(this.includeTypes),
                 DependencyUtil.cleanToBeTokenizedString(this.excludeTypes)));
 
         filter.addFilter(new ClassifierFilter(
                 DependencyUtil.cleanToBeTokenizedString(this.includeClassifiers),
                 DependencyUtil.cleanToBeTokenizedString(this.excludeClassifiers)));
 
         filter.addFilter(new GroupIdFilter(
                 DependencyUtil.cleanToBeTokenizedString(this.includeGroupIds),
                 DependencyUtil.cleanToBeTokenizedString(this.excludeGroupIds)));
 
         filter.addFilter(new ArtifactIdFilter(
                 DependencyUtil.cleanToBeTokenizedString(this.includeArtifactIds),
                 DependencyUtil.cleanToBeTokenizedString(this.excludeArtifactIds)));
 
         return filter;
     }
 
     /**
      * This method resolves the plugin artifacts from the project.
      *
      * @return set of resolved plugin artifacts
      * @throws ArtifactFilterException in case of an error
      * @throws ArtifactResolverException in case of an error
      */
     private Set<Artifact> resolvePluginArtifacts()
             throws ArtifactFilterException, ArtifactResolverException, ArtifactResolutionException {
         final Set<Artifact> plugins = getProject().getPluginArtifacts();
         final Set<Artifact> reports = getProject().getReportArtifacts();
 
         Set<Artifact> artifacts = new HashSet<>();
         artifacts.addAll(reports);
         artifacts.addAll(plugins);
 
         final FilterArtifacts filter = getArtifactsFilter();
         artifacts = filter.filter(artifacts);
 
         Set<Artifact> result = new HashSet<>();
         for (final Artifact artifact : new LinkedHashSet<>(artifacts)) {
 
             org.eclipse.aether.artifact.Artifact resolveArtifact = getResolverUtil()
                     .resolveArtifact(
                             RepositoryUtils.toArtifact(artifact), getProject().getRemotePluginRepositories());
             result.add(RepositoryUtils.toArtifact(resolveArtifact));
         }
         return result;
     }
 
     @Override
     protected ArtifactsFilter getMarkedArtifactFilter() {
         return null;
     }
 }