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

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