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