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

   1 package org.apache.maven.archiva.configuration;
   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.commons.collections.CollectionUtils;
  23 import org.apache.commons.collections.Predicate;
  24 import org.apache.commons.configuration.CombinedConfiguration;
  25 import org.apache.maven.archiva.common.utils.Slf4JPlexusLogger;
  26 import org.apache.maven.archiva.configuration.functors.FiletypeSelectionPredicate;
  27 import org.apache.maven.archiva.configuration.io.registry.ConfigurationRegistryReader;
  28 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable;
  29 import org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
  30 import org.codehaus.plexus.registry.Registry;
  31 import org.codehaus.plexus.registry.RegistryException;
  32 import org.codehaus.plexus.registry.RegistryListener;
  33 import org.codehaus.plexus.registry.commons.CommonsConfigurationRegistry;
  34 import org.codehaus.plexus.util.SelectorUtils;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 import java.lang.reflect.Field;
  39 import java.util.ArrayList;
  40 import java.util.Arrays;
  41 import java.util.Collections;
  42 import java.util.HashMap;
  43 import java.util.List;
  44 import java.util.Map;
  45
  46 /**
  47  * FileTypes
  48  *
  49  * @author <a href="mailto:joakime@apache.org">Joakim Erdfelt</a>
  50  * @version $Id$
  51  *
  52  * @plexus.component role="org.apache.maven.archiva.configuration.FileTypes"
  53  */
  54 public class FileTypes
  55     implements Initializable, RegistryListener
  56 {
  57     private Logger log = LoggerFactory.getLogger(FileTypes.class);
  58
  59     public static final String ARTIFACTS = "artifacts";
  60
  61     public static final String AUTO_REMOVE = "auto-remove";
  62
  63     public static final String INDEXABLE_CONTENT = "indexable-content";
  64
  65     public static final String IGNORED = "ignored";
  66
  67     /**
  68      * @plexus.requirement
  69      */
  70     private ArchivaConfiguration archivaConfiguration;
  71
  72     /**
  73      * Map of default values for the file types.
  74      */
  75     private Map<String, List<String>> defaultTypeMap = new HashMap<String, List<String>>();
  76
  77     private List<String> artifactPatterns;
  78
  79     /**
  80      * Default exclusions from artifact consumers that are using the file types. Note that this is simplistic in the
  81      * case of the support files (based on extension) as it is elsewhere - it may be better to match these to actual
  82      * artifacts and exclude later during scanning.
  83      */
  84     public static final List<String> DEFAULT_EXCLUSIONS = Arrays.asList( "**/maven-metadata.xml",
  85                                                                           "**/maven-metadata-*.xml", "**/*.sha1",
  86                                                                           "**/*.asc", "**/*.md5", "**/*.pgp" );
  87
  88     public void setArchivaConfiguration( ArchivaConfiguration archivaConfiguration )
  89     {
  90         this.archivaConfiguration = archivaConfiguration;
  91     }
  92
  93     /**
  94      * <p>
  95      * Get the list of patterns for a specified filetype.
  96      * </p>
  97      *
  98      * <p>
  99      * You will always get a list.  In this order.
 100      *   <ul>
 101      *     <li>The Configured List</li>
 102      *     <li>The Default List</li>
 103      *     <li>A single item list of <code>"**<span>/</span>*"</code></li>
 104      *   </ul>
 105      * </p>
 106      *
 107      * @param id the id to lookup.
 108      * @return the list of patterns.
 109      */
 110     public List<String> getFileTypePatterns( String id )
 111     {
 112         Configuration config = archivaConfiguration.getConfiguration();
 113         Predicate selectedFiletype = new FiletypeSelectionPredicate( id );
 114         FileType filetype = (FileType) CollectionUtils.find( config.getRepositoryScanning().getFileTypes(),
 115                                                              selectedFiletype );
 116
 117         if ( ( filetype != null ) && CollectionUtils.isNotEmpty( filetype.getPatterns() ) )
 118         {
 119             return filetype.getPatterns();
 120         }
 121
 122         List<String> defaultPatterns = defaultTypeMap.get( id );
 123
 124         if ( CollectionUtils.isEmpty( defaultPatterns ) )
 125         {
 126             return Collections.singletonList( "**/*" );
 127         }
 128
 129         return defaultPatterns;
 130     }
 131
 132     public synchronized boolean matchesArtifactPattern( String relativePath )
 133     {
 134         // Correct the slash pattern.
 135         relativePath = relativePath.replace( '\\', '/' );
 136
 137         if ( artifactPatterns == null )
 138         {
 139             artifactPatterns = getFileTypePatterns( ARTIFACTS );
 140         }
 141
 142         for ( String pattern : artifactPatterns )
 143         {
 144             if ( SelectorUtils.matchPath( pattern, relativePath, false ) )
 145             {
 146                 // Found match
 147                 return true;
 148             }
 149         }
 150
 151         // No match.
 152         return false;
 153     }
 154
 155     public boolean matchesDefaultExclusions( String relativePath )
 156     {
 157         // Correct the slash pattern.
 158         relativePath = relativePath.replace( '\\', '/' );
 159
 160         for ( String pattern : DEFAULT_EXCLUSIONS )
 161         {
 162             if ( SelectorUtils.matchPath( pattern, relativePath, false ) )
 163             {
 164                 // Found match
 165                 return true;
 166             }
 167         }
 168
 169         // No match.
 170         return false;
 171     }
 172
 173     public void initialize()
 174         throws InitializationException
 175     {
 176         // TODO: why is this done by hand?
 177
 178         String errMsg = "Unable to load default archiva configuration for FileTypes: ";
 179
 180         try
 181         {
 182             CommonsConfigurationRegistry commonsRegistry = new CommonsConfigurationRegistry();
 183
 184             // Configure commonsRegistry
 185             Field fld = commonsRegistry.getClass().getDeclaredField( "configuration" );
 186             fld.setAccessible( true );
 187             fld.set( commonsRegistry, new CombinedConfiguration() );
 188             commonsRegistry.enableLogging( new Slf4JPlexusLogger( FileTypes.class ) );
 189             commonsRegistry.addConfigurationFromResource( "org/apache/maven/archiva/configuration/default-archiva.xml" );
 190
 191             // Read configuration as it was intended.
 192             ConfigurationRegistryReader configReader = new ConfigurationRegistryReader();
 193             Configuration defaultConfig = configReader.read( commonsRegistry );
 194
 195             initialiseTypeMap( defaultConfig );
 196         }
 197         catch ( RegistryException e )
 198         {
 199             throw new InitializationException( errMsg + e.getMessage(), e );
 200         }
 201         catch ( SecurityException e )
 202         {
 203             throw new InitializationException( errMsg + e.getMessage(), e );
 204         }
 205         catch ( NoSuchFieldException e )
 206         {
 207             throw new InitializationException( errMsg + e.getMessage(), e );
 208         }
 209         catch ( IllegalArgumentException e )
 210         {
 211             throw new InitializationException( errMsg + e.getMessage(), e );
 212         }
 213         catch ( IllegalAccessException e )
 214         {
 215             throw new InitializationException( errMsg + e.getMessage(), e );
 216         }
 217
 218         this.archivaConfiguration.addChangeListener( this );
 219     }
 220
 221     private void initialiseTypeMap( Configuration configuration )
 222     {
 223         defaultTypeMap.clear();
 224
 225         // Store the default file type declaration.
 226         List<FileType> filetypes = configuration.getRepositoryScanning().getFileTypes();
 227         for ( FileType filetype : filetypes )
 228         {
 229             List<String> patterns = defaultTypeMap.get( filetype.getId() );
 230             if ( patterns == null )
 231             {
 232                 patterns = new ArrayList<String>();
 233             }
 234             patterns.addAll( filetype.getPatterns() );
 235
 236             defaultTypeMap.put( filetype.getId(), patterns );
 237         }
 238     }
 239
 240     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 241     {
 242         if ( propertyName.contains( "fileType" ) )
 243         {
 244             artifactPatterns = null;
 245
 246             initialiseTypeMap( archivaConfiguration.getConfiguration() );
 247         }
 248     }
 249
 250     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 251     {
 252         /* nothing to do */
 253     }
 254 }