package org.apache.maven.tools.plugin.extractor;
   
   /*
    * 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 org.apache.maven.plugin.descriptor.InvalidPluginDescriptorException;
  import org.apache.maven.plugin.descriptor.PluginDescriptor;
  import org.apache.maven.project.MavenProject;
  import org.codehaus.plexus.logging.AbstractLogEnabled;
  import org.codehaus.plexus.util.DirectoryScanner;
  import org.codehaus.plexus.util.FileUtils;
  import org.codehaus.plexus.util.StringUtils;
  
  import java.io.File;
  import java.io.IOException;
  import java.util.HashSet;
  import java.util.Iterator;
  import java.util.List;
  import java.util.Map;
  import java.util.Set;
  import java.util.TreeMap;
  
  /**
   * @author jdcasey
   */
  public abstract class AbstractScriptedMojoDescriptorExtractor
      extends AbstractLogEnabled
      implements MojoDescriptorExtractor
  {
      public List execute( MavenProject project, PluginDescriptor pluginDescriptor )
          throws ExtractionException, InvalidPluginDescriptorException
      {
          String metadataExtension = getMetadataFileExtension();
          String scriptExtension = getScriptFileExtension();
  
          Map scriptFilesKeyedByBasedir =
              gatherFilesByBasedir( project.getBasedir(), project.getScriptSourceRoots(), scriptExtension );
  
          List mojoDescriptors;
          if ( !StringUtils.isEmpty( metadataExtension ) )
          {
              Map metadataFilesKeyedByBasedir =
                  gatherFilesByBasedir( project.getBasedir(), project.getScriptSourceRoots(), metadataExtension );
  
              mojoDescriptors = extractMojoDescriptorsFromMetadata( metadataFilesKeyedByBasedir, pluginDescriptor );
          }
          else
          {
              mojoDescriptors = extractMojoDescriptors( scriptFilesKeyedByBasedir, pluginDescriptor );
          }
  
          copyScriptsToOutputDirectory( scriptFilesKeyedByBasedir, project.getBuild().getOutputDirectory() );
  
          return mojoDescriptors;
      }
  
      protected void copyScriptsToOutputDirectory( Map scriptFilesKeyedByBasedir, String outputDirectory )
          throws ExtractionException
      {
          File outputDir = new File( outputDirectory );
  
          if ( !outputDir.exists() )
          {
              outputDir.mkdirs();
          }
  
          for ( Iterator it = scriptFilesKeyedByBasedir.entrySet().iterator(); it.hasNext(); )
          {
              Map.Entry entry = (Map.Entry) it.next();
  
              File sourceDir = new File( (String) entry.getKey() );
  
              Set scripts = (Set) entry.getValue();
  
              for ( Iterator scriptIterator = scripts.iterator(); scriptIterator.hasNext(); )
              {
                  File scriptFile = (File) scriptIterator.next();
  
                  String relativePath = scriptFile.getPath().substring( sourceDir.getPath().length() );
  
                  if ( relativePath.charAt( 0 ) == File.separatorChar )
                  {
                      relativePath = relativePath.substring( 1 );
                 }
 
                 File outputFile = new File( outputDir, relativePath ).getAbsoluteFile();
 
                 if ( !outputFile.getParentFile().exists() )
                 {
                     outputFile.getParentFile().mkdirs();
                 }
 
                 try
                 {
                     FileUtils.copyFile( scriptFile, outputFile );
                 }
                 catch ( IOException e )
                 {
                     throw new ExtractionException(
                         "Cannot copy script file: " + scriptFile + " to output: " + outputFile, e );
                 }
             }
         }
     }
 
     protected Map gatherFilesByBasedir( File basedir, List directories, String scriptFileExtension )
     {
         Map sourcesByBasedir = new TreeMap();
 
         for ( Iterator it = directories.iterator(); it.hasNext(); )
         {
             Set sources = new HashSet();
 
             String resourceDir = (String) it.next();
 
             File dir = new File( basedir, resourceDir ).getAbsoluteFile();
 
             resourceDir = dir.getPath();
 
             if ( dir.exists() )
             {
                 DirectoryScanner scanner = new DirectoryScanner();
 
                 scanner.setBasedir( dir );
                 scanner.addDefaultExcludes();
                 scanner.setIncludes( new String[]{"**/*" + scriptFileExtension} );
                 scanner.scan();
 
                 String[] relativePaths = scanner.getIncludedFiles();
 
                 for ( int i = 0; i < relativePaths.length; i++ )
                 {
                     String relativePath = relativePaths[i];
                     File scriptFile = new File( dir, relativePath ).getAbsoluteFile();
 
                     if ( scriptFile.isFile() && relativePath.endsWith( scriptFileExtension ) )
                     {
                         sources.add( scriptFile );
                     }
                 }
 
                 sourcesByBasedir.put( resourceDir, sources );
             }
         }
 
         return sourcesByBasedir;
     }
 
     protected List extractMojoDescriptorsFromMetadata( Map metadataFilesKeyedByBasedir,
                                                        PluginDescriptor pluginDescriptor )
         throws ExtractionException, InvalidPluginDescriptorException
     {
         return null;
     }
 
     protected String getMetadataFileExtension()
     {
         return null;
     }
 
     protected List extractMojoDescriptors( Map scriptFilesKeyedByBasedir, PluginDescriptor pluginDescriptor )
         throws ExtractionException, InvalidPluginDescriptorException
     {
         return null;
     }
 
     protected abstract String getScriptFileExtension();
 
 }