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