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

   1 package org.apache.maven.archiva.reporting;
   2
   3 /*
   4  * Copyright 2005-2006 The Apache Software Foundation.
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the "License");
   7  * you may not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18
  19 import org.apache.maven.artifact.Artifact;
  20 import org.apache.maven.artifact.factory.ArtifactFactory;
  21 import org.apache.maven.artifact.handler.DefaultArtifactHandler;
  22 import org.apache.maven.artifact.repository.ArtifactRepository;
  23 import org.apache.maven.model.Model;
  24 import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
  25 import org.apache.maven.project.MavenProjectBuilder;
  26 import org.codehaus.plexus.util.IOUtil;
  27 import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
  28
  29 import java.io.File;
  30 import java.io.IOException;
  31 import java.io.InputStream;
  32 import java.io.InputStreamReader;
  33 import java.io.Reader;
  34 import java.util.Arrays;
  35 import java.util.HashSet;
  36 import java.util.Set;
  37 import java.util.jar.JarEntry;
  38 import java.util.jar.JarFile;
  39
  40 /**
  41  * Validate the location of the artifact based on the values indicated
  42  * in its pom (both the pom packaged with the artifact & the pom in the
  43  * file system).
  44  *
  45  * @plexus.component role="org.apache.maven.archiva.reporting.ArtifactReportProcessor" role-hint="artifact-location"
  46  */
  47 public class LocationArtifactReportProcessor
  48     implements ArtifactReportProcessor
  49 {
  50     /**
  51      * @plexus.requirement
  52      */
  53     private ArtifactFactory artifactFactory;
  54
  55     // TODO: share with other code with the same
  56     private static final Set JAR_FILE_TYPES =
  57         new HashSet( Arrays.asList( new String[]{"jar", "war", "par", "ejb", "ear", "rar", "sar"} ) );
  58
  59     /**
  60      * @plexus.requirement
  61      */
  62     private MavenProjectBuilder projectBuilder;
  63
  64     private static final String POM = "pom";
  65
  66     /**
  67      * Check whether the artifact is in its proper location. The location of the artifact
  68      * is validated first against the groupId, artifactId and versionId in the specified model
  69      * object (pom in the file system). Then unpack the artifact (jar file) and get the model (pom)
  70      * included in the package. If a model exists inside the package, then check if the artifact's
  71      * location is valid based on the location specified in the pom. Check if the both the location
  72      * specified in the file system pom and in the pom included in the package is the same.
  73      */
  74     public void processArtifact( Artifact artifact, Model model, ReportingDatabase reporter )
  75     {
  76         ArtifactRepository repository = artifact.getRepository();
  77
  78         if ( !"file".equals( repository.getProtocol() ) )
  79         {
  80             // We can't check other types of URLs yet. Need to use Wagon, with an exists() method.
  81             throw new UnsupportedOperationException(
  82                 "Can't process repository '" + repository.getUrl() + "'. Only file based repositories are supported" );
  83         }
  84
  85         adjustDistributionArtifactHandler( artifact );
  86
  87         String artifactPath = repository.pathOf( artifact );
  88
  89         if ( model != null )
  90         {
  91             // only check if it is a standalone POM, or an artifact other than a POM
  92             // ie, don't check the location of the POM for another artifact matches that of the artifact
  93             if ( !POM.equals( artifact.getType() ) || POM.equals( model.getPackaging() ) )
  94             {
  95                 //check if the artifact is located in its proper location based on the info
  96                 //specified in the model object/pom
  97                 Artifact modelArtifact = artifactFactory.createArtifactWithClassifier( model.getGroupId(),
  98                                                                                        model.getArtifactId(),
  99                                                                                        model.getVersion(),
 100                                                                                        artifact.getType(),
 101                                                                                        artifact.getClassifier() );
 102
 103                 adjustDistributionArtifactHandler( modelArtifact );
 104                 String modelPath = repository.pathOf( modelArtifact );
 105                 if ( !modelPath.equals( artifactPath ) )
 106                 {
 107                     reporter.addFailure( artifact,
 108                                          "The artifact is out of place. It does not match the specified location in the repository pom: " +
 109                                              modelPath );
 110                 }
 111             }
 112         }
 113
 114         //get the location of the artifact itself
 115         File file = new File( repository.getBasedir(), artifactPath );
 116
 117         if ( file.exists() )
 118         {
 119             if ( JAR_FILE_TYPES.contains( artifact.getType() ) )
 120             {
 121                 //unpack the artifact (using the groupId, artifactId & version specified in the artifact object itself
 122                 //check if the pom is included in the package
 123                 Model extractedModel = readArtifactModel( file, artifact, reporter );
 124
 125                 if ( extractedModel != null )
 126                 {
 127                     Artifact extractedArtifact = artifactFactory.createBuildArtifact( extractedModel.getGroupId(),
 128                                                                                       extractedModel.getArtifactId(),
 129                                                                                       extractedModel.getVersion(),
 130                                                                                       extractedModel.getPackaging() );
 131                     if ( !repository.pathOf( extractedArtifact ).equals( artifactPath ) )
 132                     {
 133                         reporter.addFailure( artifact,
 134                                              "The artifact is out of place. It does not match the specified location in the packaged pom." );
 135                     }
 136                 }
 137             }
 138         }
 139         else
 140         {
 141             throw new IllegalStateException( "Couldn't find artifact " + file );
 142         }
 143     }
 144
 145     private static void adjustDistributionArtifactHandler( Artifact artifact )
 146     {
 147         // need to tweak these as they aren't currently in the known type converters. TODO - add them in Maven
 148         if ( "distribution-zip".equals( artifact.getType() ) )
 149         {
 150             artifact.setArtifactHandler( new DefaultArtifactHandler( "zip" ) );
 151         }
 152         else if ( "distribution-tgz".equals( artifact.getType() ) )
 153         {
 154             artifact.setArtifactHandler( new DefaultArtifactHandler( "tar.gz" ) );
 155         }
 156     }
 157
 158     private Model readArtifactModel( File file, Artifact artifact, ReportingDatabase reporter )
 159     {
 160         Model model = null;
 161
 162         JarFile jar = null;
 163         try
 164         {
 165             jar = new JarFile( file );
 166
 167             //Get the entry and its input stream.
 168             JarEntry entry = jar.getJarEntry(
 169                 "META-INF/maven/" + artifact.getGroupId() + "/" + artifact.getArtifactId() + "/pom.xml" );
 170
 171             // If the entry is not null, extract it.
 172             if ( entry != null )
 173             {
 174                 model = readModel( jar.getInputStream( entry ) );
 175
 176                 if ( model.getGroupId() == null )
 177                 {
 178                     model.setGroupId( model.getParent().getGroupId() );
 179                 }
 180                 if ( model.getVersion() == null )
 181                 {
 182                     model.setVersion( model.getParent().getVersion() );
 183                 }
 184             }
 185         }
 186         catch ( IOException e )
 187         {
 188             reporter.addWarning( artifact, "Unable to read artifact to extract model: " + e );
 189         }
 190         catch ( XmlPullParserException e )
 191         {
 192             reporter.addWarning( artifact, "Unable to parse extracted model: " + e );
 193         }
 194         finally
 195         {
 196             if ( jar != null )
 197             {
 198                 //noinspection UnusedCatchParameter
 199                 try
 200                 {
 201                     jar.close();
 202                 }
 203                 catch ( IOException e )
 204                 {
 205                     // ignore
 206                 }
 207             }
 208         }
 209         return model;
 210     }
 211
 212     private Model readModel( InputStream entryStream )
 213         throws IOException, XmlPullParserException
 214     {
 215         Reader isReader = new InputStreamReader( entryStream );
 216
 217         Model model;
 218         try
 219         {
 220             MavenXpp3Reader pomReader = new MavenXpp3Reader();
 221             model = pomReader.read( isReader );
 222         }
 223         finally
 224         {
 225             IOUtil.close( isReader );
 226         }
 227         return model;
 228     }
 229
 230 }