source.dussan.org Git - archiva.git/blob

   1 package org.apache.maven.repository.discovery;
   2
   3 /*
   4  * Copyright 2005-2006 The Apache Software Foundation.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 import org.codehaus.plexus.logging.AbstractLogEnabled;
  20 import org.codehaus.plexus.util.DirectoryScanner;
  21 import org.codehaus.plexus.util.FileUtils;
  22
  23 import java.io.File;
  24 import java.util.ArrayList;
  25 import java.util.Arrays;
  26 import java.util.Iterator;
  27 import java.util.List;
  28
  29 /**
  30  * Base class for artifact discoverers.
  31  *
  32  * @author John Casey
  33  * @author Brett Porter
  34  */
  35 public abstract class AbstractArtifactDiscoverer
  36     extends AbstractLogEnabled
  37 {
  38     /**
  39      * Standard patterns to exclude from discovery as they are not artifacts.
  40      */
  41     private static final String[] STANDARD_DISCOVERY_EXCLUDES = {"bin/**", "reports/**", ".maven/**", "**/*.md5",
  42         "**/*.MD5", "**/*.sha1", "**/*.SHA1", "**/*snapshot-version", "*/website/**", "*/licenses/**", "*/licences/**",
  43         "**/.htaccess", "**/*.html", "**/*.asc", "**/*.txt", "**/*.xml", "**/README*", "**/CHANGELOG*", "**/KEYS*"};
  44
  45     private static final String[] EMPTY_STRING_ARRAY = new String[0];
  46
  47     private List excludedPaths = new ArrayList();
  48
  49     private List kickedOutPaths = new ArrayList();
  50
  51     /**
  52      * Scan the repository for artifact paths.
  53      */
  54     protected String[] scanForArtifactPaths( File repositoryBase, String blacklistedPatterns )
  55     {
  56         return scanForArtifactPaths( repositoryBase, blacklistedPatterns, null, STANDARD_DISCOVERY_EXCLUDES );
  57     }
  58
  59     /**
  60      * Scan the repository for artifact paths.
  61      */
  62     protected String[] scanForArtifactPaths( File repositoryBase, String blacklistedPatterns, String[] includes,
  63                                              String[] excludes )
  64     {
  65         List allExcludes = new ArrayList();
  66         allExcludes.addAll( FileUtils.getDefaultExcludesAsList() );
  67         if ( excludes != null )
  68         {
  69             allExcludes.addAll( Arrays.asList( excludes ) );
  70         }
  71
  72         if ( blacklistedPatterns != null && blacklistedPatterns.length() > 0 )
  73         {
  74             allExcludes.addAll( Arrays.asList( blacklistedPatterns.split( "," ) ) );
  75         }
  76
  77         DirectoryScanner scanner = new DirectoryScanner();
  78         scanner.setBasedir( repositoryBase );
  79         if ( includes != null )
  80         {
  81             scanner.setIncludes( includes );
  82         }
  83         scanner.setExcludes( (String[]) allExcludes.toArray( EMPTY_STRING_ARRAY ) );
  84
  85         scanner.scan();
  86
  87         excludedPaths.addAll( Arrays.asList( scanner.getExcludedFiles() ) );
  88
  89         return scanner.getIncludedFiles();
  90     }
  91
  92     /**
  93      * Add a path to the list of files that were kicked out due to being invalid.
  94      *
  95      * @param path the path to add
  96      * @todo add a reason
  97      */
  98     protected void addKickedOutPath( String path )
  99     {
 100         kickedOutPaths.add( path );
 101     }
 102
 103     public Iterator getExcludedPathsIterator()
 104     {
 105         return excludedPaths.iterator();
 106     }
 107
 108     public Iterator getKickedOutPathsIterator()
 109     {
 110         return kickedOutPaths.iterator();
 111     }
 112 }