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

   1 package org.apache.maven.archiva.discoverer;
   2
   3 /*
   4  * Licensed to the Apache Software Foundation (ASF) under one
   5  * or more contributor license agreements.  See the NOTICE file
   6  * distributed with this work for additional information
   7  * regarding copyright ownership.  The ASF licenses this file
   8  * to you under the Apache License, Version 2.0 (the
   9  * "License"); you may not use this file except in compliance
  10  * with the License.  You may obtain a copy of the License at
  11  *
  12  *   http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  17  * KIND, either express or implied.  See the License for the
  18  * specific language governing permissions and limitations
  19  * under the License.
  20  */
  21
  22 import org.apache.maven.archiva.common.consumers.Consumer;
  23 import org.apache.maven.artifact.repository.ArtifactRepository;
  24 import org.codehaus.plexus.logging.AbstractLogEnabled;
  25 import org.codehaus.plexus.util.DirectoryWalker;
  26 import org.codehaus.plexus.util.FileUtils;
  27
  28 import java.io.File;
  29 import java.util.ArrayList;
  30 import java.util.Arrays;
  31 import java.util.Iterator;
  32 import java.util.List;
  33
  34 /**
  35  * Discoverer Implementation.
  36  *
  37  * @author <a href="mailto:brett@apache.org">Brett Porter</a>
  38  * @author <a href="mailto:joakime@apache.org">Joakim Erdfelt</a>
  39  * @plexus.component role="org.apache.maven.archiva.discoverer.Discoverer"
  40  */
  41 public class DefaultDiscoverer
  42     extends AbstractLogEnabled
  43     implements Discoverer
  44 {
  45     /**
  46      * Standard patterns to exclude from discovery as they are usually noise.
  47      */
  48     private static final String[] STANDARD_DISCOVERY_EXCLUDES = {
  49         "bin/**",
  50         "reports/**",
  51         ".index",
  52         ".reports/**",
  53         ".maven/**",
  54         "**/*snapshot-version",
  55         "*/website/**",
  56         "*/licences/**",
  57         "**/.htaccess",
  58         "**/*.html",
  59         "**/*.txt",
  60         "**/README*",
  61         "**/CHANGELOG*",
  62         "**/KEYS*" };
  63
  64     public DefaultDiscoverer()
  65     {
  66     }
  67
  68     public DiscovererStatistics walkRepository( ArtifactRepository repository, List consumers, boolean includeSnapshots )
  69         throws DiscovererException
  70     {
  71         return walkRepository( repository, consumers, includeSnapshots, 0, null, null );
  72     }
  73
  74     public DiscovererStatistics walkRepository( ArtifactRepository repository, List consumers,
  75                                                 boolean includeSnapshots, long onlyModifiedAfterTimestamp,
  76                                                 List extraFileExclusions, List extraFileInclusions )
  77         throws DiscovererException
  78     {
  79         // Sanity Check
  80
  81         if ( repository == null )
  82         {
  83             throw new IllegalArgumentException( "Unable to operate on a null repository." );
  84         }
  85
  86         if ( !"file".equals( repository.getProtocol() ) )
  87         {
  88             throw new UnsupportedOperationException( "Only filesystem repositories are supported." );
  89         }
  90
  91         File repositoryBase = new File( repository.getBasedir() );
  92
  93         if ( !repositoryBase.exists() )
  94         {
  95             throw new UnsupportedOperationException( "Unable to scan a repository, directory "
  96                 + repositoryBase.getAbsolutePath() + " does not exist." );
  97         }
  98
  99         if ( !repositoryBase.isDirectory() )
 100         {
 101             throw new UnsupportedOperationException( "Unable to scan a repository, path "
 102                 + repositoryBase.getAbsolutePath() + " is not a directory." );
 103         }
 104
 105         // Setup Includes / Excludes.
 106
 107         List allExcludes = new ArrayList();
 108         List allIncludes = new ArrayList();
 109
 110         // Exclude all of the SCM patterns.
 111         allExcludes.addAll( FileUtils.getDefaultExcludesAsList() );
 112
 113         // Exclude all of the archiva noise patterns.
 114         allExcludes.addAll( Arrays.asList( STANDARD_DISCOVERY_EXCLUDES ) );
 115
 116         if ( !includeSnapshots )
 117         {
 118             allExcludes.add( "**/*-SNAPSHOT*" );
 119         }
 120
 121         if ( extraFileExclusions != null )
 122         {
 123             allExcludes.addAll( extraFileExclusions );
 124         }
 125
 126         Iterator it = consumers.iterator();
 127         while ( it.hasNext() )
 128         {
 129             Consumer consumer = (Consumer) it.next();
 130
 131             /* NOTE: Do not insert the consumer exclusion patterns here.
 132              * Exclusion patterns are handled by RepositoryScanner.wantsFile(Consumer, String)
 133              *
 134              * addUniqueElements( consumer.getExcludePatterns(), allExcludes );
 135              */
 136             addUniqueElements( consumer.getIncludePatterns(), allIncludes );
 137         }
 138
 139         if ( extraFileInclusions != null )
 140         {
 141             allIncludes.addAll( extraFileInclusions );
 142         }
 143
 144         // Setup Directory Walker
 145
 146         DirectoryWalker dirWalker = new DirectoryWalker();
 147
 148         dirWalker.setBaseDir( repositoryBase );
 149
 150         dirWalker.setIncludes( allIncludes );
 151         dirWalker.setExcludes( allExcludes );
 152
 153         // Setup the Scan Instance
 154         RepositoryScanner repoScanner = new RepositoryScanner( repository, consumers );
 155         repoScanner.setOnlyModifiedAfterTimestamp( onlyModifiedAfterTimestamp );
 156
 157         repoScanner.setLogger( getLogger() );
 158         dirWalker.addDirectoryWalkListener( repoScanner );
 159
 160         // Execute scan.
 161         dirWalker.scan();
 162
 163         return repoScanner.getStatistics();
 164     }
 165
 166     private void addUniqueElements( List fromList, List toList )
 167     {
 168         Iterator itFrom = fromList.iterator();
 169         while ( itFrom.hasNext() )
 170         {
 171             Object o = itFrom.next();
 172             if ( !toList.contains( o ) )
 173             {
 174                 toList.add( o );
 175             }
 176         }
 177     }
 178 }