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.configuration.util.PathMatcher;
  26 import org.apache.archiva.components.registry.Registry;
  27 import org.apache.archiva.components.registry.RegistryException;
  28 import org.apache.archiva.components.registry.RegistryListener;
  29 import org.apache.archiva.components.registry.commons.CommonsConfigurationRegistry;
  30 import org.apache.commons.collections4.CollectionUtils;
  31 import org.apache.commons.collections4.IterableUtils;
  32 import org.apache.commons.collections4.Predicate;
  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     public FileTypes() {
  66
  67     }
  68
  69     /**
  70      * Map of default values for the file types.
  71      */
  72     private Map<String, List<String>> defaultTypeMap = new HashMap<>();
  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      * @deprecated
  82      */
  83     public static final List<String> DEFAULT_EXCLUSIONS = FileTypeUtils.DEFAULT_EXCLUSIONS;
  84
  85     public void setArchivaConfiguration( ArchivaConfiguration archivaConfiguration )
  86     {
  87         this.archivaConfiguration = archivaConfiguration;
  88     }
  89
  90     /**
  91      * Get the list of patterns for a specified filetype.
  92      * You will always get a list.  In this order.
  93      * <ul>
  94      * <li>The Configured List</li>
  95      * <li>The Default List</li>
  96      * <li>A single item list of <code>&quot;**&#47;*&quot;</code></li>
  97      * </ul>
  98      *
  99      * @param id the id to lookup.
 100      * @return the list of patterns.
 101      */
 102     public List<String> getFileTypePatterns( String id )
 103     {
 104         Configuration config = archivaConfiguration.getConfiguration();
 105         Predicate selectedFiletype = new FiletypeSelectionPredicate( id );
 106         RepositoryScanningConfiguration repositoryScanningConfiguration = config.getRepositoryScanning();
 107         if ( repositoryScanningConfiguration != null )
 108         {
 109             FileType filetype =
 110                 IterableUtils.find( config.getRepositoryScanning().getFileTypes(), selectedFiletype );
 111
 112             if ( ( filetype != null ) && CollectionUtils.isNotEmpty( filetype.getPatterns() ) )
 113             {
 114                 return filetype.getPatterns();
 115             }
 116         }
 117         List<String> defaultPatterns = defaultTypeMap.get( id );
 118
 119         if ( CollectionUtils.isEmpty( defaultPatterns ) )
 120         {
 121             return Collections.singletonList( "**/*" );
 122         }
 123
 124         return defaultPatterns;
 125     }
 126
 127     public synchronized boolean matchesArtifactPattern( String relativePath )
 128     {
 129         // Correct the slash pattern.
 130         relativePath = relativePath.replace( '\\', '/' );
 131
 132         if ( artifactPatterns == null )
 133         {
 134             artifactPatterns = getFileTypePatterns( ARTIFACTS );
 135         }
 136
 137         for ( String pattern : artifactPatterns )
 138         {
 139             if ( PathMatcher.matchPath( pattern, relativePath, false ) )
 140             {
 141                 // Found match
 142                 return true;
 143             }
 144         }
 145
 146         // No match.
 147         return false;
 148     }
 149
 150     public boolean matchesDefaultExclusions( String relativePath )
 151     {
 152         // Correct the slash pattern.
 153         relativePath = relativePath.replace( '\\', '/' );
 154
 155         for ( String pattern : DEFAULT_EXCLUSIONS )
 156         {
 157             if ( PathMatcher.matchPath( pattern, relativePath, false ) )
 158             {
 159                 // Found match
 160                 return true;
 161             }
 162         }
 163
 164         // No match.
 165         return false;
 166     }
 167
 168     @PostConstruct
 169     public void initialize()
 170     {
 171         initialiseTypeMap( this.archivaConfiguration.getConfiguration() );
 172
 173         this.archivaConfiguration.addChangeListener( this );
 174     }
 175
 176     private void initialiseTypeMap( Configuration configuration )
 177     {
 178         defaultTypeMap.clear();
 179
 180         // Store the default file type declaration.
 181         List<FileType> filetypes = configuration.getRepositoryScanning().getFileTypes();
 182         for ( FileType filetype : filetypes )
 183         {
 184             List<String> patterns = defaultTypeMap.get( filetype.getId() );
 185             if ( patterns == null )
 186             {
 187                 patterns = new ArrayList<>( filetype.getPatterns().size() );
 188             }
 189             patterns.addAll( filetype.getPatterns() );
 190
 191             defaultTypeMap.put( filetype.getId(), patterns );
 192         }
 193     }
 194
 195     @Override
 196     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 197     {
 198         if ( propertyName.contains( "fileType" ) )
 199         {
 200             artifactPatterns = null;
 201
 202             initialiseTypeMap( archivaConfiguration.getConfiguration() );
 203         }
 204     }
 205
 206     @Override
 207     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 208     {
 209         /* nothing to do */
 210     }
 211 }