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.components.registry.Registry;
  25 import org.apache.archiva.components.registry.RegistryListener;
  26 import org.apache.commons.collections4.CollectionUtils;
  27 import org.apache.commons.collections4.IterableUtils;
  28 import org.apache.commons.collections4.Predicate;
  29 import org.springframework.stereotype.Service;
  30
  31 import javax.annotation.PostConstruct;
  32 import javax.inject.Inject;
  33 import javax.inject.Named;
  34 import java.nio.file.FileSystems;
  35 import java.nio.file.Paths;
  36 import java.util.ArrayList;
  37 import java.util.Collections;
  38 import java.util.HashMap;
  39 import java.util.List;
  40 import java.util.Map;
  41
  42 /**
  43  * FileTypes
  44  */
  45 @Service("fileTypes")
  46 public class FileTypes
  47     implements RegistryListener
  48 {
  49     public static final String ARTIFACTS = "artifacts";
  50
  51     public static final String AUTO_REMOVE = "auto-remove";
  52
  53     public static final String INDEXABLE_CONTENT = "indexable-content";
  54
  55     public static final String IGNORED = "ignored";
  56
  57     @Inject
  58     @Named(value = "archivaConfiguration#default")
  59     private ArchivaConfiguration archivaConfiguration;
  60
  61
  62     public FileTypes() {
  63
  64     }
  65
  66     /**
  67      * Map of default values for the file types.
  68      */
  69     private Map<String, List<String>> defaultTypeMap = new HashMap<>();
  70
  71     private List<String> artifactPatterns;
  72
  73     /**
  74      * Default exclusions from artifact consumers that are using the file types. Note that this is simplistic in the
  75      * case of the support files (based on extension) as it is elsewhere - it may be better to match these to actual
  76      * artifacts and exclude later during scanning.
  77      *
  78      * @deprecated
  79      */
  80     public static final List<String> DEFAULT_EXCLUSIONS = FileTypeUtils.DEFAULT_EXCLUSIONS;
  81
  82     public void setArchivaConfiguration( ArchivaConfiguration archivaConfiguration )
  83     {
  84         this.archivaConfiguration = archivaConfiguration;
  85     }
  86
  87     /**
  88      * Get the list of patterns for a specified filetype.
  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                 IterableUtils.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 ( FileSystems.getDefault().getPathMatcher( "glob:" + pattern).matches( Paths.get( relativePath ) ) )
 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 ( FileSystems.getDefault().getPathMatcher( "glob:" + pattern).matches( Paths.get( relativePath ) ) )
 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         initialiseTypeMap( this.archivaConfiguration.getConfiguration() );
 169
 170         this.archivaConfiguration.addChangeListener( this );
 171     }
 172
 173     private void initialiseTypeMap( Configuration configuration )
 174     {
 175         defaultTypeMap.clear();
 176
 177         // Store the default file type declaration.
 178         List<FileType> filetypes = configuration.getRepositoryScanning().getFileTypes();
 179         for ( FileType filetype : filetypes )
 180         {
 181             List<String> patterns = defaultTypeMap.get( filetype.getId() );
 182             if ( patterns == null )
 183             {
 184                 patterns = new ArrayList<>( filetype.getPatterns().size() );
 185             }
 186             patterns.addAll( filetype.getPatterns() );
 187
 188             defaultTypeMap.put( filetype.getId(), patterns );
 189         }
 190     }
 191
 192     @Override
 193     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 194     {
 195         if ( propertyName.contains( "fileType" ) )
 196         {
 197             artifactPatterns = null;
 198
 199             initialiseTypeMap( archivaConfiguration.getConfiguration() );
 200         }
 201     }
 202
 203     @Override
 204     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 205     {
 206         /* nothing to do */
 207     }
 208 }