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.commons.collections.CollectionUtils;
  23 import org.apache.commons.collections.Predicate;
  24 import org.apache.commons.configuration.CombinedConfiguration;
  25 import org.apache.archiva.common.FileTypeUtils;
  26 import org.apache.archiva.configuration.functors.FiletypeSelectionPredicate;
  27 import org.apache.archiva.configuration.io.registry.ConfigurationRegistryReader;
  28 import org.codehaus.plexus.registry.Registry;
  29 import org.codehaus.plexus.registry.RegistryException;
  30 import org.codehaus.plexus.registry.RegistryListener;
  31 import org.codehaus.plexus.util.SelectorUtils;
  32 import org.codehaus.redback.components.registry.commons.CommonsConfigurationRegistry;
  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  * @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      *
  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      * @deprecated
  81      */
  82     public static final List<String> DEFAULT_EXCLUSIONS = FileTypeUtils.DEFAULT_EXCLUSIONS;
  83
  84     public void setArchivaConfiguration( ArchivaConfiguration archivaConfiguration )
  85     {
  86         this.archivaConfiguration = archivaConfiguration;
  87     }
  88
  89     /**
  90      * <p>
  91      * Get the list of patterns for a specified filetype.
  92      * </p>
  93      * <p/>
  94      * <p>
  95      * You will always get a list.  In this order.
  96      * <ul>
  97      * <li>The Configured List</li>
  98      * <li>The Default List</li>
  99      * <li>A single item list of <code>"**<span>/</span>*"</code></li>
 100      * </ul>
 101      * </p>
 102      *
 103      * @param id the id to lookup.
 104      * @return the list of patterns.
 105      */
 106     public List<String> getFileTypePatterns( String id )
 107     {
 108         Configuration config = archivaConfiguration.getConfiguration();
 109         Predicate selectedFiletype = new FiletypeSelectionPredicate( id );
 110         FileType filetype =
 111             (FileType) CollectionUtils.find( config.getRepositoryScanning().getFileTypes(), selectedFiletype );
 112
 113         if ( ( filetype != null ) && CollectionUtils.isNotEmpty( filetype.getPatterns() ) )
 114         {
 115             return filetype.getPatterns();
 116         }
 117
 118         List<String> defaultPatterns = defaultTypeMap.get( id );
 119
 120         if ( CollectionUtils.isEmpty( defaultPatterns ) )
 121         {
 122             return Collections.singletonList( "**/*" );
 123         }
 124
 125         return defaultPatterns;
 126     }
 127
 128     public synchronized boolean matchesArtifactPattern( String relativePath )
 129     {
 130         // Correct the slash pattern.
 131         relativePath = relativePath.replace( '\\', '/' );
 132
 133         if ( artifactPatterns == null )
 134         {
 135             artifactPatterns = getFileTypePatterns( ARTIFACTS );
 136         }
 137
 138         for ( String pattern : artifactPatterns )
 139         {
 140             if ( SelectorUtils.matchPath( pattern, relativePath, false ) )
 141             {
 142                 // Found match
 143                 return true;
 144             }
 145         }
 146
 147         // No match.
 148         return false;
 149     }
 150
 151     public boolean matchesDefaultExclusions( String relativePath )
 152     {
 153         // Correct the slash pattern.
 154         relativePath = relativePath.replace( '\\', '/' );
 155
 156         for ( String pattern : DEFAULT_EXCLUSIONS )
 157         {
 158             if ( SelectorUtils.matchPath( pattern, relativePath, false ) )
 159             {
 160                 // Found match
 161                 return true;
 162             }
 163         }
 164
 165         // No match.
 166         return false;
 167     }
 168
 169     @PostConstruct
 170     public void initialize()
 171     {
 172         // TODO: why is this done by hand?
 173
 174         // TODO: ideally, this would be instantiated by configuration instead, and not need to be a component
 175
 176         String errMsg = "Unable to load default archiva configuration for FileTypes: ";
 177
 178         try
 179         {
 180             CommonsConfigurationRegistry commonsRegistry = new CommonsConfigurationRegistry();
 181
 182             // Configure commonsRegistry
 183             Field fld = commonsRegistry.getClass().getDeclaredField( "configuration" );
 184             fld.setAccessible( true );
 185             fld.set( commonsRegistry, new CombinedConfiguration() );
 186             commonsRegistry.addConfigurationFromResource(
 187                 "org/apache/archiva/configuration/default-archiva.xml" );
 188
 189             // Read configuration as it was intended.
 190             ConfigurationRegistryReader configReader = new ConfigurationRegistryReader();
 191             Configuration defaultConfig = configReader.read( commonsRegistry );
 192
 193             initialiseTypeMap( defaultConfig );
 194         }
 195         catch ( RegistryException e )
 196         {
 197             throw new RuntimeException( errMsg + e.getMessage(), e );
 198         }
 199         catch ( SecurityException e )
 200         {
 201             throw new RuntimeException( errMsg + e.getMessage(), e );
 202         }
 203         catch ( NoSuchFieldException e )
 204         {
 205             throw new RuntimeException( errMsg + e.getMessage(), e );
 206         }
 207         catch ( IllegalArgumentException e )
 208         {
 209             throw new RuntimeException( errMsg + e.getMessage(), e );
 210         }
 211         catch ( IllegalAccessException e )
 212         {
 213             throw new RuntimeException( errMsg + e.getMessage(), e );
 214         }
 215
 216         this.archivaConfiguration.addChangeListener( this );
 217     }
 218
 219     private void initialiseTypeMap( Configuration configuration )
 220     {
 221         defaultTypeMap.clear();
 222
 223         // Store the default file type declaration.
 224         List<FileType> filetypes = configuration.getRepositoryScanning().getFileTypes();
 225         for ( FileType filetype : filetypes )
 226         {
 227             List<String> patterns = defaultTypeMap.get( filetype.getId() );
 228             if ( patterns == null )
 229             {
 230                 patterns = new ArrayList<String>();
 231             }
 232             patterns.addAll( filetype.getPatterns() );
 233
 234             defaultTypeMap.put( filetype.getId(), patterns );
 235         }
 236     }
 237
 238     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 239     {
 240         if ( propertyName.contains( "fileType" ) )
 241         {
 242             artifactPatterns = null;
 243
 244             initialiseTypeMap( archivaConfiguration.getConfiguration() );
 245         }
 246     }
 247
 248     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 249     {
 250         /* nothing to do */
 251     }
 252 }