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

   1 package org.apache.maven.archiva.reporting.artifact;
   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.Enumeration;
  26 import java.util.HashMap;
  27 import java.util.List;
  28 import java.util.Map;
  29 import java.util.jar.JarEntry;
  30 import java.util.jar.JarFile;
  31
  32 import org.apache.commons.lang.StringUtils;
  33 import org.apache.maven.archiva.configuration.ArchivaConfiguration;
  34 import org.apache.maven.archiva.configuration.ConfigurationNames;
  35 import org.apache.maven.archiva.configuration.FileTypes;
  36 import org.apache.maven.archiva.configuration.ManagedRepositoryConfiguration;
  37 import org.apache.maven.archiva.consumers.AbstractMonitoredConsumer;
  38 import org.apache.maven.archiva.consumers.ArchivaArtifactConsumer;
  39 import org.apache.maven.archiva.consumers.ConsumerException;
  40 import org.apache.maven.archiva.database.ArchivaDAO;
  41 import org.apache.maven.archiva.database.ArchivaDatabaseException;
  42 import org.apache.maven.archiva.model.ArchivaArtifact;
  43 import org.apache.maven.archiva.model.ArchivaProjectModel;
  44 import org.apache.maven.archiva.model.RepositoryProblem;
  45 import org.apache.maven.archiva.repository.ManagedRepositoryContent;
  46 import org.apache.maven.archiva.repository.RepositoryContentFactory;
  47 import org.apache.maven.archiva.repository.RepositoryException;
  48 import org.codehaus.plexus.personality.plexus.lifecycle.phase.Initializable;
  49 import org.codehaus.plexus.personality.plexus.lifecycle.phase.InitializationException;
  50 import org.codehaus.plexus.registry.Registry;
  51 import org.codehaus.plexus.registry.RegistryListener;
  52 import org.codehaus.plexus.util.SelectorUtils;
  53 import org.slf4j.Logger;
  54 import org.slf4j.LoggerFactory;
  55
  56 /**
  57  * Validate the location of the artifact based on the values indicated
  58  * in its pom (both the pom packaged with the artifact & the pom in the
  59  * file system).
  60  *
  61  * @version $Id$
  62  * @plexus.component role="org.apache.maven.archiva.consumers.ArchivaArtifactConsumer"
  63  * role-hint="validate-artifacts-location"
  64  */
  65 public class LocationArtifactsConsumer
  66     extends AbstractMonitoredConsumer
  67     implements ArchivaArtifactConsumer, RegistryListener, Initializable
  68 {
  69     private Logger log = LoggerFactory.getLogger( LocationArtifactsConsumer.class );
  70
  71     /**
  72      * @plexus.configuration default-value="duplicate-artifacts"
  73      */
  74     private String id;
  75
  76     /**
  77      * @plexus.configuration default-value="Check for Duplicate Artifacts via SHA1 Checksums"
  78      */
  79     private String description;
  80
  81     /**
  82      * @plexus.requirement
  83      */
  84     private ArchivaConfiguration configuration;
  85
  86     /**
  87      * @plexus.requirement
  88      */
  89     private FileTypes filetypes;
  90
  91     /**
  92      * @plexus.requirement role-hint="jdo"
  93      */
  94     private ArchivaDAO dao;
  95
  96     /**
  97      * @plexus.requirement
  98      */
  99     private RepositoryContentFactory repositoryFactory;
 100
 101     private Map repositoryMap = new HashMap();
 102
 103     // TODO: why is this not used? If it should be, what about excludes?
 104     private List<String> includes = new ArrayList<String>();
 105
 106     public String getId()
 107     {
 108         return id;
 109     }
 110
 111     public String getDescription()
 112     {
 113         return description;
 114     }
 115
 116     public boolean isPermanent()
 117     {
 118         return false;
 119     }
 120
 121     public void beginScan()
 122     {
 123         /* do nothing */
 124     }
 125
 126     public void completeScan()
 127     {
 128         /* do nothing */
 129     }
 130
 131     public List getIncludedTypes()
 132     {
 133         return null;
 134     }
 135
 136     /**
 137      * Check whether the artifact is in its proper location. The location of the artifact
 138      * is validated first against the groupId, artifactId and versionId in the specified model
 139      * object (pom in the file system). Then unpack the artifact (jar file) and get the model (pom)
 140      * included in the package. If a model exists inside the package, then check if the artifact's
 141      * location is valid based on the location specified in the pom. Check if the both the location
 142      * specified in the file system pom and in the pom included in the package is the same.
 143      */
 144     public void processArchivaArtifact( ArchivaArtifact artifact )
 145         throws ConsumerException
 146     {
 147         ManagedRepositoryConfiguration repository = findRepository( artifact );
 148
 149         File artifactFile = new File( repository.getLocation(), toPath( artifact ) );
 150         ArchivaProjectModel fsModel = readFilesystemModel( artifactFile );
 151         ArchivaProjectModel embeddedModel = readEmbeddedModel( artifact, artifactFile );
 152
 153         validateAppropriateModel( "Filesystem", artifact, fsModel );
 154         validateAppropriateModel( "Embedded", artifact, embeddedModel );
 155     }
 156
 157     private void validateAppropriateModel( String location, ArchivaArtifact artifact, ArchivaProjectModel model )
 158         throws ConsumerException
 159     {
 160         if ( model != null )
 161         {
 162             if ( !StringUtils.equals( model.getGroupId(), artifact.getGroupId() ) )
 163             {
 164                 addProblem( artifact, "The groupId of the " + location +
 165                     " project model doesn't match with the artifact, expected <" + artifact.getGroupId() +
 166                     ">, but was actually <" + model.getGroupId() + ">" );
 167             }
 168
 169             if ( !StringUtils.equals( model.getArtifactId(), artifact.getArtifactId() ) )
 170             {
 171                 addProblem( artifact, "The artifactId of the " + location +
 172                     " project model doesn't match with the artifact, expected <" + artifact.getArtifactId() +
 173                     ">, but was actually <" + model.getArtifactId() + ">" );
 174             }
 175
 176             if ( !StringUtils.equals( model.getVersion(), artifact.getVersion() ) )
 177             {
 178                 addProblem( artifact, "The version of the " + location +
 179                     " project model doesn't match with the artifact, expected <" + artifact.getVersion() +
 180                     ">, but was actually <" + model.getVersion() + ">" );
 181             }
 182         }
 183     }
 184
 185     private ArchivaProjectModel readEmbeddedModel( ArchivaArtifact artifact, File artifactFile )
 186         throws ConsumerException
 187     {
 188         try
 189         {
 190             JarFile jar = new JarFile( artifactFile );
 191
 192             // Get the entry and its input stream.
 193             JarEntry expectedEntry = jar.getJarEntry(
 194                 "META-INF/maven/" + artifact.getGroupId() + "/" + artifact.getArtifactId() + "/pom.xml" );
 195
 196             if ( expectedEntry != null )
 197             {
 198                 // TODO: read and resolve model here.
 199                 return null;
 200             }
 201
 202             /* Expected Entry not found, look for alternate that might
 203             * indicate that the artifact is, indeed located in the wrong place.
 204             */
 205
 206             List actualPomXmls = findJarEntryPattern( jar, "META-INF/maven/**/pom.xml" );
 207             if ( actualPomXmls.isEmpty() )
 208             {
 209                 // No check needed.
 210
 211             }
 212
 213             // TODO: test for invalid actual pom.xml
 214             // TODO: test
 215         }
 216         catch ( IOException e )
 217         {
 218             // Not able to read from the file.
 219             String emsg = "Unable to read file contents: " + e.getMessage();
 220             addProblem( artifact, emsg );
 221         }
 222
 223         return null;
 224     }
 225
 226     private List<JarEntry> findJarEntryPattern( JarFile jar, String pattern )
 227     {
 228         List<JarEntry> hits = new ArrayList<JarEntry>();
 229
 230         Enumeration<JarEntry> entries = jar.entries();
 231         while ( entries.hasMoreElements() )
 232         {
 233             JarEntry entry = entries.nextElement();
 234             if ( SelectorUtils.match( pattern, entry.getName() ) )
 235             {
 236                 hits.add( entry );
 237             }
 238         }
 239
 240         return hits;
 241     }
 242
 243     private void addProblem( ArchivaArtifact artifact, String msg )
 244         throws ConsumerException
 245     {
 246         RepositoryProblem problem = new RepositoryProblem();
 247         problem.setRepositoryId( artifact.getModel().getRepositoryId() );
 248         problem.setPath( toPath( artifact ) );
 249         problem.setGroupId( artifact.getGroupId() );
 250         problem.setArtifactId( artifact.getArtifactId() );
 251         problem.setVersion( artifact.getVersion() );
 252         problem.setType( LocationArtifactsReport.PROBLEM_TYPE_BAD_ARTIFACT_LOCATION );
 253         problem.setOrigin( getId() );
 254         problem.setMessage( msg );
 255
 256         try
 257         {
 258             dao.getRepositoryProblemDAO().saveRepositoryProblem( problem );
 259         }
 260         catch ( ArchivaDatabaseException e )
 261         {
 262             String emsg = "Unable to save problem with artifact location to DB: " + e.getMessage();
 263             log.warn( emsg, e );
 264             throw new ConsumerException( emsg, e );
 265         }
 266     }
 267
 268     private ArchivaProjectModel readFilesystemModel( File artifactFile )
 269     {
 270         File pomFile = createPomFileReference( artifactFile );
 271
 272         // TODO: read and resolve model here.
 273
 274         return null;
 275     }
 276
 277     private File createPomFileReference( File artifactFile )
 278     {
 279         String pomFilename = artifactFile.getAbsolutePath();
 280
 281         int pos = pomFilename.lastIndexOf( '.' );
 282         if ( pos <= 0 )
 283         {
 284             // Invalid filename.
 285             return null;
 286         }
 287
 288         pomFilename = pomFilename.substring( 0, pos ) + ".pom";
 289         return new File( pomFilename );
 290     }
 291
 292     private ManagedRepositoryConfiguration findRepository( ArchivaArtifact artifact )
 293     {
 294         return (ManagedRepositoryConfiguration) this.repositoryMap.get( artifact.getModel().getRepositoryId() );
 295     }
 296
 297     private String toPath( ArchivaArtifact artifact )
 298     {
 299         try
 300         {
 301             String repoId = artifact.getModel().getRepositoryId();
 302             ManagedRepositoryContent repo = repositoryFactory.getManagedRepositoryContent( repoId );
 303             return repo.toPath( artifact );
 304         }
 305         catch ( RepositoryException e )
 306         {
 307             log.warn( "Unable to calculate path for artifact: " + artifact );
 308             return "";
 309         }
 310     }
 311
 312     public void afterConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 313     {
 314         if ( ConfigurationNames.isManagedRepositories( propertyName ) )
 315         {
 316             initRepositoryMap();
 317         }
 318
 319         if ( ConfigurationNames.isRepositoryScanning( propertyName ) )
 320         {
 321             initIncludes();
 322         }
 323     }
 324
 325     public void beforeConfigurationChange( Registry registry, String propertyName, Object propertyValue )
 326     {
 327         /* do nothing */
 328     }
 329
 330     private void initIncludes()
 331     {
 332         includes.clear();
 333
 334         includes.addAll( filetypes.getFileTypePatterns( FileTypes.ARTIFACTS ) );
 335     }
 336
 337     private void initRepositoryMap()
 338     {
 339         synchronized ( this.repositoryMap )
 340         {
 341             this.repositoryMap.clear();
 342
 343             Map<String, ManagedRepositoryConfiguration> map =
 344                 configuration.getConfiguration().getManagedRepositoriesAsMap();
 345
 346             for ( Map.Entry<String, ManagedRepositoryConfiguration> entry : map.entrySet() )
 347             {
 348                 this.repositoryMap.put( entry.getKey(), entry.getValue() );
 349             }
 350         }
 351     }
 352
 353     public void initialize()
 354         throws InitializationException
 355     {
 356         initRepositoryMap();
 357         initIncludes();
 358         configuration.addChangeListener( this );
 359     }
 360 }