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

   1 package org.apache.maven.archiva.consumers.core;
   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 java.io.File;
  23 import java.io.IOException;
  24 import java.util.ArrayList;
  25 import java.util.Date;
  26 import java.util.List;
  27
  28 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  29 import org.apache.maven.archiva.configuration.ConfigurationNames;
  30 import org.apache.maven.archiva.configuration.FileTypes;
  31 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  32 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
  33 import org.apache.maven.archiva.consumers.ConsumerException;
  34 import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
  35 import org.apache.maven.archiva.model.ArtifactReference;
  36 import org.apache.maven.archiva.model.ProjectReference;
  37 import org.apache.maven.archiva.model.VersionedReference;
  38 import org.apache.maven.archiva.repository.ContentNotFoundException;
  39 import org.apache.maven.archiva.repository.ManagedRepositoryContent;
  40 import org.apache.maven.archiva.repository.RepositoryContentFactory;
  41 import org.apache.maven.archiva.repository.RepositoryException;
  42 import org.apache.maven.archiva.repository.RepositoryNotFoundException;
  43 import org.apache.maven.archiva.repository.layout.LayoutException;
  44 import org.apache.maven.archiva.repository.metadata.MetadataTools;
  45 import org.apache.maven.archiva.repository.metadata.RepositoryMetadataException;
  46 import org.codehaus.plexus.registry.Registry;
  47 import org.codehaus.plexus.registry.RegistryListener;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50 import org.springframework.context.annotation.Scope;
  51 import org.springframework.stereotype.Service;
  52
  53 import javax.annotation.PostConstruct;
  54 import javax.inject.Inject;
  55
  56 /**
  57  * MetadataUpdaterConsumer will create and update the metadata present within the repository.
  58  *
  59  * @version $Id$
  60  */
  61 @Service("knownRepositoryContentConsumer#metadata-updater")
  62 @Scope("prototype")
  63 public class MetadataUpdaterConsumer
  64     extends AbstractMonitoredConsumer
  65     implements KnownRepositoryContentConsumer, RegistryListener
  66 {
  67     private Logger log = LoggerFactory.getLogger( MetadataUpdaterConsumer.class );
  68
  69     /**
  70      * plexus.configuration default-value="metadata-updater"
  71      */
  72     private String id = "metadata-updater";
  73
  74     /**
  75      * plexus.configuration default-value="Update / Create maven-metadata.xml files"
  76      */
  77     private String description = "Update / Create maven-metadata.xml files";
  78
  79     /**
  80      * plexus.requirement
  81      */
  82     @Inject
  83     private RepositoryContentFactory repositoryFactory;
  84
  85     /**
  86      * plexus.requirement
  87      */
  88     @Inject
  89     private MetadataTools metadataTools;
  90
  91     /**
  92      * plexus.requirement
  93      */
  94     @Inject
  95     private ArchivaConfiguration configuration;
  96
  97     /**
  98      * plexus.requirement
  99      */
 100     @Inject
 101     private FileTypes filetypes;
 102
 103     private static final String TYPE_METADATA_BAD_INTERNAL_REF = "metadata-bad-internal-ref";
 104
 105     private static final String TYPE_METADATA_WRITE_FAILURE = "metadata-write-failure";
 106
 107     private static final String TYPE_METADATA_IO = "metadata-io-warning";
 108
 109     private ManagedRepositoryContent repository;
 110
 111     private File repositoryDir;
 112
 113     private List<String> includes = new ArrayList<String>();
 114
 115     private long scanStartTimestamp = 0;
 116
 117     public String getDescription()
 118     {
 119         return description;
 120     }
 121
 122     public String getId()
 123     {
 124         return id;
 125     }
 126
 127     public void setIncludes( List<String> includes )
 128     {
 129         this.includes = includes;
 130     }
 131
 132     public void beginScan( ManagedRepositoryConfiguration repoConfig, Date whenGathered )
 133         throws ConsumerException
 134     {
 135         try
 136         {
 137             this.repository = repositoryFactory.getManagedRepositoryContent( repoConfig.getId() );
 138             this.repositoryDir = new File( repository.getRepoRoot() );
 139             this.scanStartTimestamp = System.currentTimeMillis();
 140         }
 141         catch ( RepositoryNotFoundException e )
 142         {
 143             throw new ConsumerException( e.getMessage(), e );
 144         }
 145         catch ( RepositoryException e )
 146         {
 147             throw new ConsumerException( e.getMessage(), e );
 148         }
 149     }
 150
 151     public void beginScan( ManagedRepositoryConfiguration repository, Date whenGathered, boolean executeOnEntireRepo )
 152         throws ConsumerException
 153     {
 154         beginScan( repository, whenGathered );
 155     }
 156
 157     public void completeScan()
 158     {
 159         /* do nothing here */
 160     }
 161
 162     public void completeScan( boolean executeOnEntireRepo )
 163     {
 164         completeScan();
 165     }
 166
 167     public List<String> getExcludes()
 168     {
 169         return getDefaultArtifactExclusions();
 170     }
 171
 172     public List<String> getIncludes()
 173     {
 174         return this.includes;
 175     }
 176
 177     public void processFile( String path )
 178         throws ConsumerException
 179     {
 180         // Ignore paths like .index etc
 181         if ( !path.startsWith( "." ) )
 182         {
 183             try
 184             {
 185                 ArtifactReference artifact = repository.toArtifactReference( path );
 186                 updateVersionMetadata( artifact, path );
 187                 updateProjectMetadata( artifact, path );
 188             }
 189             catch ( LayoutException e )
 190             {
 191                 log.info( "Not processing path that is not an artifact: " + path + " (" + e.getMessage() + ")" );
 192             }
 193         }
 194     }
 195
 196     public void processFile( String path, boolean executeOnEntireRepo )
 197         throws Exception
 198     {
 199         processFile( path );
 200     }
 201
 202     private void updateProjectMetadata( ArtifactReference artifact, String path )
 203     {
 204         ProjectReference projectRef = new ProjectReference();
 205         projectRef.setGroupId( artifact.getGroupId() );
 206         projectRef.setArtifactId( artifact.getArtifactId() );
 207
 208         try
 209         {
 210             String metadataPath = this.metadataTools.toPath( projectRef );
 211
 212             File projectMetadata = new File( this.repositoryDir, metadataPath );
 213
 214             if ( projectMetadata.exists() && ( projectMetadata.lastModified() >= this.scanStartTimestamp ) )
 215             {
 216                 // This metadata is up to date. skip it.
 217                 log.debug( "Skipping uptodate metadata: {}", this.metadataTools.toPath( projectRef ) );
 218                 return;
 219             }
 220
 221             metadataTools.updateMetadata( this.repository, projectRef );
 222             log.debug( "Updated metadata: {}", this.metadataTools.toPath( projectRef ) );
 223         }
 224         catch ( LayoutException e )
 225         {
 226             triggerConsumerWarning( TYPE_METADATA_BAD_INTERNAL_REF, "Unable to convert path [" + path
 227                 + "] to an internal project reference: " + e.getMessage() );
 228         }
 229         catch ( RepositoryMetadataException e )
 230         {
 231             triggerConsumerError( TYPE_METADATA_WRITE_FAILURE, "Unable to write project metadata for artifact [" + path
 232                 + "]: " + e.getMessage() );
 233         }
 234         catch ( IOException e )
 235         {
 236             triggerConsumerWarning( TYPE_METADATA_IO, "Project metadata not written due to IO warning: "
 237                 + e.getMessage() );
 238         }
 239         catch ( ContentNotFoundException e )
 240         {
 241             triggerConsumerWarning( TYPE_METADATA_IO,
 242                                     "Project metadata not written because no versions were found to update: "
 243                                         + e.getMessage() );
 244         }
 245     }
 246
 247     private void updateVersionMetadata( ArtifactReference artifact, String path )
 248     {
 249         VersionedReference versionRef = new VersionedReference();
 250         versionRef.setGroupId( artifact.getGroupId() );
 251         versionRef.setArtifactId( artifact.getArtifactId() );
 252         versionRef.setVersion( artifact.getVersion() );
 253
 254         try
 255         {
 256             String metadataPath = this.metadataTools.toPath( versionRef );
 257
 258             File projectMetadata = new File( this.repositoryDir, metadataPath );
 259
 260             if ( projectMetadata.exists() && ( projectMetadata.lastModified() >= this.scanStartTimestamp ) )
 261             {
 262                 // This metadata is up to date. skip it.
 263                 log.debug( "Skipping uptodate metadata: {}", this.metadataTools.toPath( versionRef ) );
 264                 return;
 265             }
 266
 267             metadataTools.updateMetadata( this.repository, versionRef );
 268             log.debug( "Updated metadata: {}", this.metadataTools.toPath( versionRef ) );
 269         }
 270         catch ( LayoutException e )
 271         {
 272             triggerConsumerWarning( TYPE_METADATA_BAD_INTERNAL_REF, "Unable to convert path [" + path
 273                 + "] to an internal version reference: " + e.getMessage() );
 274         }
 275         catch ( RepositoryMetadataException e )
 276         {
 277             triggerConsumerError( TYPE_METADATA_WRITE_FAILURE, "Unable to write version metadata for artifact [" + path
 278                 + "]: " + e.getMessage() );
 279         }
 280         catch ( IOException e )
 281         {
 282             triggerConsumerWarning( TYPE_METADATA_IO, "Version metadata not written due to IO warning: "
 283                 + e.getMessage() );
 284         }
 285         catch ( ContentNotFoundException e )
 286         {
 287             triggerConsumerWarning( TYPE_METADATA_IO,
 288                                     "Version metadata not written because no versions were found to update: "
 289                                         + e.getMessage() );
 290         }
 291     }
 292
 293     public boolean isPermanent()
 294     {
 295         return false;
 296     }
 297
 298     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 299     {
 300         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 301         {
 302             initIncludes();
 303         }
 304     }
 305
 306     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 307     {
 308         /* do nothing here */
 309     }
 310
 311     private void initIncludes()
 312     {
 313         includes.clear();
 314
 315         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 316     }
 317
 318     @PostConstruct
 319     public void initialize()
 320     {
 321         configuration.addChangeListener( this );
 322
 323         initIncludes();
 324     }
 325 }