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

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