package org.apache.maven.shared.filtering;
   
   /*
    * 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.io.Reader;
  import java.util.ArrayList;
  import java.util.List;
  
  import org.apache.maven.execution.MavenSession;
  import org.apache.maven.project.MavenProject;
  import org.codehaus.plexus.interpolation.Interpolator;
  import org.codehaus.plexus.interpolation.RegexBasedInterpolator;
  import org.codehaus.plexus.interpolation.StringSearchInterpolator;
  import org.codehaus.plexus.interpolation.ValueSource;
  import org.codehaus.plexus.util.FileUtils;
  import org.codehaus.plexus.util.FileUtils.FilterWrapper;
  
  /**
   * A bean to configure a resources filtering execution.
   *
   * @author <a href="mailto:olamy@apache.org">olamy</a>
   * @version $Id: MavenResourcesExecution.java 1057398 2011-01-10 22:18:08Z dennisl $
   */
  public class MavenResourcesExecution
      extends AbstractMavenFilteringRequest
  {
     
      /** @see org.apache.maven.model.Resource  */
      private List resources;
  
      private File outputDirectory;
  
      private List nonFilteredFileExtensions;
  
      /** @see FileUtils.FilterWrapper */
      private List filterWrappers;
  
      private File resourcesBaseDirectory;
  
      private boolean useDefaultFilterWrappers = false;
      
      /**
       * Overwrite existing files even if the destination files are newer.
       * <code>false</code> by default.
       *
       * @since 1.0-beta-2
       */
      private boolean overwrite = false;
      
      /**
       * Copy any empty directories included in the Resources.
       *
       * @since 1.0-beta-2
       */
      private boolean includeEmptyDirs = false;
      
      /**
       * Do not stop trying to filter tokens when reaching EOL.
       *
       * @since 1.0
       */
      private boolean supportMultiLineFiltering;    
      
      public MavenResourcesExecution()
      {
          // no op
      }
      
      /**
       * As we use a Maven project <code>useDefaultFilterWrappers</code> will be set to <code>true</code>.
       *
       * @param resources
       * @param outputDirectory
       * @param mavenProject
       * @param encoding
       * @param fileFilters
       * @param nonFilteredFileExtensions
       * @param mavenSession
       */
      public MavenResourcesExecution( List resources, File outputDirectory, MavenProject mavenProject, String encoding,
                                      List fileFilters, List nonFilteredFileExtensions, MavenSession mavenSession )
     {
         super( mavenProject, fileFilters, encoding, mavenSession );
         this.resources = resources;
         this.outputDirectory = outputDirectory;
         this.nonFilteredFileExtensions = nonFilteredFileExtensions;
         this.useDefaultFilterWrappers = true;
         this.resourcesBaseDirectory = mavenProject.getBasedir();
     }
 
     public MavenResourcesExecution( List resources, File outputDirectory, String encoding, List filterWrappers,
                                     File resourcesBaseDirectory, List nonFilteredFileExtensions )
     {
         this();
         this.resources = resources;
         this.outputDirectory = outputDirectory;
         this.filterWrappers = filterWrappers;
         this.nonFilteredFileExtensions = nonFilteredFileExtensions;
         this.resourcesBaseDirectory = resourcesBaseDirectory;
         this.useDefaultFilterWrappers = false;
         setEncoding( encoding );
     }
 
     
     /**
      * @return List of {@link org.apache.maven.model.Resource}
      */
     public List getResources()
     {
         return resources;
     }
 
     /**
      * @param resources List of {@link org.apache.maven.model.Resource}
      */
     public void setResources( List resources )
     {
         this.resources = resources;
     }
 
     public File getOutputDirectory()
     {
         return outputDirectory;
     }
 
     public void setOutputDirectory( File outputDirectory )
     {
         this.outputDirectory = outputDirectory;
     }
 
     /**
      * @return List of {@link String} file extensions to not filter
      */
     public List getNonFilteredFileExtensions()
     {
         return nonFilteredFileExtensions;
     }
 
     /**
      * @param nonFilteredFileExtensions List of {@link String} file extensions to not filter
      */
     public void setNonFilteredFileExtensions( List nonFilteredFileExtensions )
     {
         this.nonFilteredFileExtensions = nonFilteredFileExtensions;
     }
 
     /**
      * @return List of {@link FileUtils.FilterWrapper}
      */
     public List getFilterWrappers()
     {
         return filterWrappers;
     }
 
     /**
      * @param filterWrappers List of {@link FileUtils.FilterWrapper}
      */
     public void setFilterWrappers( List filterWrappers )
     {
         this.filterWrappers = filterWrappers;
     }
     
     public void addFilterWrapper( FilterWrapper filterWrapper )
     {
         if ( this.filterWrappers == null )
         {
             this.filterWrappers = new ArrayList();
         }
         this.filterWrappers.add( filterWrapper );
     }
     
     /**
      * Helper to add {@link FileUtils.FilterWrapper}, will {@link RegexBasedInterpolator} with default regex Exp ${ } 
      * and InterpolatorFilterReaderLineEnding with defaultTokens ${ }.
      *
      * @param valueSource 
      * @deprecated This doesn't support escaping use {@link #addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
      */
     public void addFilerWrapper( final ValueSource valueSource )
     {
         addFilterWrapper( new FileUtils.FilterWrapper()
         {
             public Reader getReader( Reader reader )
             {
                 Interpolator propertiesInterpolator = new RegexBasedInterpolator();
                 propertiesInterpolator.addValueSource( valueSource );
                 return new InterpolatorFilterReaderLineEnding( reader, propertiesInterpolator,
                                                                InterpolatorFilterReaderLineEnding.DEFAULT_BEGIN_TOKEN,
                                                                InterpolatorFilterReaderLineEnding.DEFAULT_END_TOKEN,
                                                                false );
             }
         } );
     }
 
     /**
      * @param valueSource
      * @param startRegExp
      * @param endRegExp
      * @param startToken
      * @param endToken
      * @deprecated This doesn't support escaping use {@link #addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
      */
     public void addFilerWrapper( final ValueSource valueSource, final String startRegExp, final String endRegExp,
                                  final String startToken, final String endToken )
     {
         addFilterWrapper( new FileUtils.FilterWrapper()
         {
             public Reader getReader( Reader reader )
             {
                 Interpolator propertiesInterpolator = new RegexBasedInterpolator( startRegExp, endRegExp );
                 propertiesInterpolator.addValueSource( valueSource );
                 return new InterpolatorFilterReaderLineEnding( reader, propertiesInterpolator, startToken, endToken,
                                                                false );
             }
         } );
     }  
     
     /**
      * @param valueSource
      * @param startExp start token like ${
      * @param endExp endToken }
      * @since 1.0-beta-2
      * @param escapeString
      * @deprecated This doesn't support escaping use {@link #addFilerWrapperWithEscaping(ValueSource, String, String, String, boolean)}
      */
     public void addFilerWrapperWithEscaping( final ValueSource valueSource, final String startExp, final String endExp,
                                              final String escapeString )
     {
         addFilterWrapper( new FileUtils.FilterWrapper()
         {
             public Reader getReader( Reader reader )
             {
                 StringSearchInterpolator propertiesInterpolator = new StringSearchInterpolator( startExp, endExp );
                 propertiesInterpolator.addValueSource( valueSource );
                 propertiesInterpolator.setEscapeString( escapeString );
                 InterpolatorFilterReaderLineEnding interpolatorFilterReader
                     = new InterpolatorFilterReaderLineEnding( reader,
                                                               propertiesInterpolator,
                                                               startExp, endExp, false );
                 interpolatorFilterReader.setInterpolateWithPrefixPattern( false );
                 return interpolatorFilterReader;
             }
         } );
     } 
     
     /**
      * @param valueSource
      * @param startExp start token like ${
      * @param endExp endToken }
      * @param escapeString
      * @param supportMultiLineFiltering do we support or use filtering on multi lines with start and endtoken on multi lines
      * @since 1.0
      */
     public void addFilerWrapperWithEscaping( final ValueSource valueSource, final String startExp, final String endExp,
                                              final String escapeString, final boolean supportMultiLineFiltering )
     {
         addFilterWrapper( new FileUtils.FilterWrapper()
         {
             public Reader getReader( Reader reader )
             {
                 StringSearchInterpolator propertiesInterpolator = new StringSearchInterpolator( startExp, endExp );
                 propertiesInterpolator.addValueSource( valueSource );
                 propertiesInterpolator.setEscapeString( escapeString );
                 InterpolatorFilterReaderLineEnding interpolatorFilterReader
                     = new InterpolatorFilterReaderLineEnding( reader,
                                                               propertiesInterpolator,
                                                               startExp, endExp, supportMultiLineFiltering );
                 interpolatorFilterReader.setInterpolateWithPrefixPattern( false );
                 return interpolatorFilterReader;
             }
         } );
     }    
     
     
     public File getResourcesBaseDirectory()
     {
         return resourcesBaseDirectory;
     }
 
     public void setResourcesBaseDirectory( File resourcesBaseDirectory )
     {
         this.resourcesBaseDirectory = resourcesBaseDirectory;
     }
 
     public boolean isUseDefaultFilterWrappers()
     {
         return useDefaultFilterWrappers;
     }
 
     public void setUseDefaultFilterWrappers( boolean useDefaultFilterWrappers )
     {
         this.useDefaultFilterWrappers = useDefaultFilterWrappers;
     }
 
     /**
      * Overwrite existing files even if the destination files are newer.
      *
      * @since 1.0-beta-2
      */
     public boolean isOverwrite()
     {
         return overwrite;
     }
 
     /**
      * Overwrite existing files even if the destination files are newer.
      *
      * @param overwrite
      * @since 1.0-beta-2
      */
     public void setOverwrite( boolean overwrite )
     {
         this.overwrite = overwrite;
     }
 
     /**
      * Copy any empty directories included in the Resources.
      *
      * @since 1.0-beta-2
      */
     public boolean isIncludeEmptyDirs()
     {
         return includeEmptyDirs;
     }
 
     /**
      * Copy any empty directories included in the Resources.
      *
      * @param includeEmptyDirs
      * @since 1.0-beta-2
      */
     public void setIncludeEmptyDirs( boolean includeEmptyDirs )
     {
         this.includeEmptyDirs = includeEmptyDirs;
     }
     
     public MavenResourcesExecution copyOf()
     {
         MavenResourcesExecution mre = new MavenResourcesExecution();
         mre.setAdditionalProperties( mre.getAdditionalProperties() );
         mre.setEncoding( mre.getEncoding() );
         mre.setEscapedBackslashesInFilePath( mre.isEscapedBackslashesInFilePath() );
         mre.setEscapeString( mre.getEscapeString() );
         mre.setFileFilters( copyList( mre.getFileFilters() ) );
         mre.setFilterWrappers( copyList( mre.getFilterWrappers() ) );
         mre.setIncludeEmptyDirs( mre.isIncludeEmptyDirs() );
         mre.setInjectProjectBuildFilters( mre.isInjectProjectBuildFilters() );
         mre.setMavenProject( mre.getMavenProject() );
         mre.setMavenSession( mre.getMavenSession() );
         mre.setNonFilteredFileExtensions( copyList( mre.getNonFilteredFileExtensions() ) );
         mre.setOutputDirectory( mre.getOutputDirectory() );
         mre.setOverwrite( mre.isOverwrite() );
         mre.setProjectStartExpressions( copyList( mre.getProjectStartExpressions() ) );
         mre.setResources( copyList( mre.getResources() ) );
         mre.setResourcesBaseDirectory( mre.getResourcesBaseDirectory() );
         mre.setUseDefaultFilterWrappers( mre.isUseDefaultFilterWrappers() );
         mre.setSupportMultiLineFiltering( mre.isSupportMultiLineFiltering() );
         return mre;
     }
    
     private List copyList( List lst )
     {
         if ( lst == null )
         {
             return null;
         }
         else if ( lst.isEmpty() )
         {
             return new ArrayList();
         }
         else
         {
             return new ArrayList( lst );
         }
     }
 
     public boolean isSupportMultiLineFiltering()
     {
         return supportMultiLineFiltering;
     }
 
     public void setSupportMultiLineFiltering( boolean supportMultiLineFiltering )
     {
         this.supportMultiLineFiltering = supportMultiLineFiltering;
     }
 }