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     implements ArtifactDiscoverer
  38 {
  39     /**
  40      * Standard patterns to exclude from discovery as they are not artifacts.
  41      */
  42     private static final String[] STANDARD_DISCOVERY_EXCLUDES = {"bin/**", "reports/**", ".maven/**", "**/*.md5",
  43         "**/*.MD5", "**/*.sha1", "**/*.SHA1", "**/*snapshot-version", "*/website/**", "*/licenses/**", "*/licences/**",
  44         "**/.htaccess", "**/*.html", "**/*.asc", "**/*.txt", "**/*.xml", "**/README*", "**/CHANGELOG*", "**/KEYS*"};
  45
  46     private static final String[] EMPTY_STRING_ARRAY = new String[0];
  47
  48     private List excludedPaths = new ArrayList();
  49
  50     private List kickedOutPaths = new ArrayList();
  51
  52     /**
  53      * Scan the repository for artifact paths.
  54      *
  55      * @todo replace blacklisted patterns by an artifact filter
  56      */
  57     protected String[] scanForArtifactPaths( File repositoryBase, String blacklistedPatterns )
  58     {
  59         List allExcludes = new ArrayList();
  60         allExcludes.addAll( FileUtils.getDefaultExcludesAsList() );
  61         allExcludes.addAll( Arrays.asList( STANDARD_DISCOVERY_EXCLUDES ) );
  62
  63         if ( blacklistedPatterns != null && blacklistedPatterns.length() > 0 )
  64         {
  65             allExcludes.addAll( Arrays.asList( blacklistedPatterns.split( "," ) ) );
  66         }
  67
  68         DirectoryScanner scanner = new DirectoryScanner();
  69         scanner.setBasedir( repositoryBase );
  70         scanner.setExcludes( (String[]) allExcludes.toArray( EMPTY_STRING_ARRAY ) );
  71
  72         scanner.scan();
  73
  74         excludedPaths.addAll( Arrays.asList( scanner.getExcludedFiles() ) );
  75
  76         return scanner.getIncludedFiles();
  77     }
  78
  79     /**
  80      * Add a path to the list of files that were kicked out due to being invalid.
  81      *
  82      * @param path the path to add
  83      * @todo add a reason
  84      */
  85     protected void addKickedOutPath( String path )
  86     {
  87         kickedOutPaths.add( path );
  88     }
  89
  90     public Iterator getExcludedPathsIterator()
  91     {
  92         return excludedPaths.iterator();
  93     }
  94
  95     public Iterator getKickedOutPathsIterator()
  96     {
  97         return kickedOutPaths.iterator();
  98     }
  99 }