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

   1 package org.apache.archiva.consumers.metadata;
   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.archiva.checksum.ChecksumAlgorithm;
  29 import org.apache.archiva.checksum.ChecksummedFile;
  30 import org.apache.archiva.metadata.model.ArtifactMetadata;
  31 import org.apache.archiva.metadata.model.ProjectMetadata;
  32 import org.apache.archiva.metadata.model.ProjectVersionMetadata;
  33 import org.apache.archiva.metadata.repository.MetadataRepository;
  34 import org.apache.archiva.metadata.repository.MetadataResolutionException;
  35 import org.apache.archiva.metadata.repository.storage.StorageMetadataResolver;
  36 import org.apache.maven.archiva.common.utils.VersionUtil;
  37 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  38 import org.apache.maven.archiva.configuration.ConfigurationNames;
  39 import org.apache.maven.archiva.configuration.FileTypes;
  40 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  41 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
  42 import org.apache.maven.archiva.consumers.ConsumerException;
  43 import org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer;
  44 import org.apache.maven.archiva.model.ArtifactReference;
  45 import org.apache.maven.archiva.repository.ManagedRepositoryContent;
  46 import org.apache.maven.archiva.repository.layout.LayoutException;
  47 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable;
  48 import org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
  49 import org.codehaus.plexus.registry.Registry;
  50 import org.codehaus.plexus.registry.RegistryListener;
  51 import org.slf4j.Logger;
  52 import org.slf4j.LoggerFactory;
  53
  54 /**
  55  * Take an artifact off of disk and put it into the metadata repository.
  56  *
  57  * @version $Id: ArtifactUpdateDatabaseConsumer.java 718864 2008-11-19 06:33:35Z brett $
  58  * @plexus.component role="org.apache.maven.archiva.consumers.KnownRepositoryContentConsumer"
  59  * role-hint="create-archiva-metadata" instantiation-strategy="per-lookup"
  60  */
  61 public class ArchivaMetadataCreationConsumer
  62     extends AbstractMonitoredConsumer
  63     implements KnownRepositoryContentConsumer, RegistryListener, Initializable
  64 {
  65     /**
  66      * @plexus.configuration default-value="create-archiva-metadata"
  67      */
  68     private String id;
  69
  70     /**
  71      * @plexus.configuration default-value="Create basic metadata for Archiva to be able to reference the artifact"
  72      */
  73     private String description;
  74
  75     /**
  76      * @plexus.requirement
  77      */
  78     private ArchivaConfiguration configuration;
  79
  80     /**
  81      * @plexus.requirement
  82      */
  83     private FileTypes filetypes;
  84
  85     private Date whenGathered;
  86
  87     /**
  88      * @plexus.requirement
  89      */
  90     private ManagedRepositoryContent repository;
  91
  92     private List<String> includes = new ArrayList<String>();
  93
  94     /**
  95      * @plexus.requirement
  96      */
  97     private MetadataRepository metadataRepository;
  98
  99     /**
 100      * FIXME: this needs to be configurable based on storage type, and availability of proxy module
 101      * ... could be a different type since we need methods to modify the storage metadata, which would also allow more
 102      * appropriate methods to pass in the already determined repository configuration, for example, instead of the ID
 103      *
 104      * @plexus.requirement role-hint="maven2"
 105      */
 106     private StorageMetadataResolver storageResolver;
 107
 108     private static final Logger log = LoggerFactory.getLogger( ArchivaMetadataCreationConsumer.class );
 109
 110     public String getId()
 111     {
 112         return this.id;
 113     }
 114
 115     public String getDescription()
 116     {
 117         return this.description;
 118     }
 119
 120     public boolean isPermanent()
 121     {
 122         return true;
 123     }
 124
 125     public List<String> getExcludes()
 126     {
 127         return getDefaultArtifactExclusions();
 128     }
 129
 130     public List<String> getIncludes()
 131     {
 132         return this.includes;
 133     }
 134
 135     public void beginScan( ManagedRepositoryConfiguration repo, Date whenGathered )
 136         throws ConsumerException
 137     {
 138         this.repository.setRepository( repo );
 139         this.whenGathered = whenGathered;
 140     }
 141
 142     public void processFile( String path )
 143         throws ConsumerException
 144     {
 145         // note that we do minimal processing including checksums and POM information for performance of
 146         // the initial scan. Any request for this information will be intercepted and populated on-demand
 147         // or picked up by subsequent scans
 148         ArtifactReference artifact;
 149         try
 150         {
 151             artifact = repository.toArtifactReference( path );
 152         }
 153         catch ( LayoutException e )
 154         {
 155             throw new ConsumerException( e.getMessage(), e );
 156         }
 157
 158         File file = new File( repository.getRepoRoot(), path );
 159
 160         ProjectMetadata project = new ProjectMetadata();
 161         project.setNamespace( artifact.getGroupId() );
 162         project.setId( artifact.getArtifactId() );
 163
 164         String projectVersion = VersionUtil.getBaseVersion( artifact.getVersion() );
 165         // TODO: maybe not too efficient since it may have already been read and stored for this artifact
 166         ProjectVersionMetadata versionMetadata = null;
 167         try
 168         {
 169             versionMetadata =
 170                 storageResolver.getProjectVersion( repository.getId(), artifact.getGroupId(), artifact.getArtifactId(),
 171                                                    projectVersion );
 172         }
 173         catch ( MetadataResolutionException e )
 174         {
 175             log.warn( "Error occurred resolving POM for artifact: " + path + "; message: " + e.getMessage() );
 176         }
 177
 178         boolean createVersionMetadata = false;
 179         if ( versionMetadata == null )
 180         {
 181             log.warn( "Missing or invalid POM for artifact: " + path + "; creating empty metadata" );
 182             versionMetadata = new ProjectVersionMetadata();
 183             versionMetadata.setId( projectVersion );
 184             versionMetadata.setIncomplete( true );
 185             createVersionMetadata = true;
 186         }
 187
 188         ArtifactMetadata artifactMeta = new ArtifactMetadata();
 189         artifactMeta.setRepositoryId( repository.getId() );
 190         artifactMeta.setNamespace( artifact.getGroupId() );
 191         artifactMeta.setProject( artifact.getArtifactId() );
 192         artifactMeta.setId( file.getName() );
 193         artifactMeta.setFileLastModified( file.lastModified() );
 194         artifactMeta.setSize( file.length() );
 195         artifactMeta.setVersion( artifact.getVersion() );
 196         artifactMeta.setWhenGathered( whenGathered );
 197
 198         ChecksummedFile checksummedFile = new ChecksummedFile( file );
 199         try
 200         {
 201             artifactMeta.setMd5( checksummedFile.calculateChecksum( ChecksumAlgorithm.MD5 ) );
 202         }
 203         catch ( IOException e )
 204         {
 205             log.error( "Error attempting to get MD5 checksum for " + file + ": " + e.getMessage() );
 206         }
 207         try
 208         {
 209             artifactMeta.setSha1( checksummedFile.calculateChecksum( ChecksumAlgorithm.SHA1 ) );
 210         }
 211         catch ( IOException e )
 212         {
 213             log.error( "Error attempting to get SHA-1 checksum for " + file + ": " + e.getMessage() );
 214         }
 215
 216         // TODO: transaction
 217         // read the metadata and update it if it is newer or doesn't exist
 218         metadataRepository.updateArtifact( repository.getId(), project.getNamespace(), project.getId(), projectVersion,
 219                                            artifactMeta );
 220         if ( createVersionMetadata )
 221         {
 222             metadataRepository.updateProjectVersion( repository.getId(), project.getNamespace(), project.getId(),
 223                                                      versionMetadata );
 224         }
 225         metadataRepository.updateProject( repository.getId(), project );
 226     }
 227
 228     public void completeScan()
 229     {
 230         /* do nothing */
 231     }
 232
 233     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 234     {
 235         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 236         {
 237             initIncludes();
 238         }
 239     }
 240
 241     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 242     {
 243         /* do nothing */
 244     }
 245
 246     private void initIncludes()
 247     {
 248         includes.clear();
 249
 250         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 251     }
 252
 253     public void initialize()
 254         throws InitializationException
 255     {
 256         configuration.addChangeListener( this );
 257
 258         initIncludes();
 259     }
 260 }