package org.apache.maven.plugin.dependency;

 /*

  * 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.    

  */

 import java.io.File;

 import java.util.Iterator;

 import java.util.Set;

 import org.apache.maven.artifact.Artifact;

 import org.apache.maven.plugin.MojoExecutionException;

 import org.apache.maven.plugin.dependency.utils.DependencyStatusSets;

 import org.apache.maven.plugin.dependency.utils.DependencyUtil;

 import org.apache.maven.plugin.dependency.utils.filters.MarkerFileFilter;

 import org.apache.maven.plugin.dependency.utils.markers.DefaultFileMarkerHandler;

 import org.apache.maven.plugin.logging.Log;

 import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;

 import org.codehaus.plexus.archiver.manager.ArchiverManager;

 /**

  * Goal that unpacks the project dependencies from the repository to a defined

  * location.

  * 

  * @goal unpack-dependencies

  * @requiresDependencyResolution test

  * @phase process-sources

  * @author <a href="mailto:brianf@apache.org">Brian Fox</a>

  * @version $Id: UnpackDependenciesMojo.java 728546 2008-12-21 22:56:51Z bentmann $

  * @since 1.0

  */

 public class UnpackDependenciesMojo

     extends AbstractFromDependenciesMojo

 {

         /**

      * A comma separated list of file patterns to include when unpacking the

      * artifact.  i.e.  **\/*.xml,**\/*.properties NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)

      * @since 2.0

      * @parameter expression="${mdep.unpack.includes}"

      */

     private String includes;

     /**

      * A comma separated list of file patterns to exclude when unpacking the

      * artifact.  i.e.  **\/*.xml,**\/*.properties. NOTE: Excludes patterns override the includes. (component code = return isIncluded( name ) AND !isExcluded( name );)

      * @since 2.0

      * @parameter expression="${mdep.unpack.excludes}"

      */

     private String excludes;

     /**

      * Main entry into mojo. This method gets the dependencies and iterates

      * through each one passing it to DependencyUtil.unpackFile().

      * 

      * @throws MojoExecutionException

      *             with a message if an error occurs.

      * 

      * @see #getDependencies

      * @see DependencyUtil#unpackFile(Artifact, File, File, ArchiverManager,

      *      Log)

      */

     public void execute()

         throws MojoExecutionException

     {

         DependencyStatusSets dss = getDependencySets( this.failOnMissingClassifierArtifact );

         Set artifacts = dss.getResolvedDependencies();

         for ( Iterator i = artifacts.iterator(); i.hasNext(); )

         {

             Artifact artifact = (Artifact) i.next();

             File destDir;

             destDir = DependencyUtil.getFormattedOutputDirectory( useSubDirectoryPerType, useSubDirectoryPerArtifact,

                                                                   useRepositoryLayout, stripVersion, outputDirectory,

                                                                   artifact );

             unpack( artifact.getFile(), destDir, getIncludes(), getExcludes() );

             DefaultFileMarkerHandler handler = new DefaultFileMarkerHandler( artifact, this.markersDirectory );

             handler.setMarker();

         }

         artifacts = dss.getSkippedDependencies();

         for ( Iterator i = artifacts.iterator(); i.hasNext(); )

         {

             Artifact artifact = (Artifact) i.next();

             getLog().info( artifact.getFile().getName() + " already exists in destination." );

         }

     }

     protected ArtifactsFilter getMarkedArtifactFilter()

     {

         return new MarkerFileFilter( this.overWriteReleases, this.overWriteSnapshots, this.overWriteIfNewer,

                                      new DefaultFileMarkerHandler( this.markersDirectory ) );

     }

     /**

      * @return Returns a comma separated list of excluded items

      */

     public String getExcludes ()

     {

         return this.excludes;

     }

     /**

      * @param excludes 

      *                         A comma separated list of items to exclude 

      *                         i.e.  **\/*.xml, **\/*.properties

      */

     public void setExcludes ( String excludes )

     {

         this.excludes = excludes;

     }

     /**

      * @return Returns a comma seperated list of included items

      */

     public String getIncludes()

     {

             return this.includes;

     }

     /**

      * @param includes

      *                         A comma seperated list of items to inmclude 

      *                         i.e.  **\/*.xml, **\/*.properties

      */

     public void setIncludes ( String includes )

     {

         this.includes = includes;

     }

 }