package org.apache.maven.index;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.util.ArrayList;
import java.util.List;
import org.apache.lucene.document.Document;
import org.apache.lucene.document.Field;
import org.apache.lucene.document.Field.Index;
import org.apache.lucene.document.Field.Store;
import org.apache.maven.index.artifact.Gav;
import org.apache.maven.index.context.IndexCreator;
import org.apache.maven.index.context.IndexingContext;
import org.apache.maven.index.util.zip.ZipFacade;
import org.apache.maven.index.util.zip.ZipHandle;
import org.apache.maven.model.Model;
import org.codehaus.plexus.util.xml.Xpp3Dom;
import org.codehaus.plexus.util.xml.Xpp3DomBuilder;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* An artifact context used to provide information about artifact during scanning. It is passed to the
* {@link IndexCreator}, which can populate {@link ArtifactInfo} for the given artifact.
*
* @see IndexCreator#populateArtifactInfo(ArtifactContext)
* @see Indexer#scan(IndexingContext)
* @author Jason van Zyl
* @author Tamas Cservenak
*/
public class ArtifactContext
{
private final File pom;
private final File artifact;
private final File metadata;
private final ArtifactInfo artifactInfo;
private final Gav gav;
private final List<Exception> errors = new ArrayList<Exception>();
public ArtifactContext( File pom, File artifact, File metadata, ArtifactInfo artifactInfo, Gav gav )
throws IllegalArgumentException
{
if ( artifactInfo == null )
{
throw new IllegalArgumentException( "Parameter artifactInfo must not be null." );
}
this.pom = pom;
this.artifact = artifact;
this.metadata = metadata;
this.artifactInfo = artifactInfo;
this.gav = gav == null ? artifactInfo.calculateGav() : gav;
}
public File getPom()
{
return pom;
}
public Model getPomModel()
{
// First check for local pom file
if ( getPom() != null && getPom().exists() )
{
try
{
return new ModelReader().readModel( new FileInputStream( getPom() ) );
}
catch ( FileNotFoundException e )
{
}
}
// Otherwise, check for pom contained in maven generated artifact
else if ( getArtifact() != null )
{
ZipHandle handle = null;
try
{
handle = ZipFacade.getZipHandle( getArtifact() );
final String embeddedPomPath =
"META-INF/maven/" + getGav().getGroupId() + "/" + getGav().getArtifactId() + "/pom.xml";
if ( handle.hasEntry( embeddedPomPath ) )
{
return new ModelReader().readModel( handle.getEntryContent( embeddedPomPath ) );
}
}
catch ( IOException e )
{
}
finally
{
try
{
ZipFacade.close( handle );
}
catch ( Exception e )
{
}
}
}
return null;
}
public File getArtifact()
{
return artifact;
}
public File getMetadata()
{
return metadata;
}
public ArtifactInfo getArtifactInfo()
{
return artifactInfo;
}
public Gav getGav()
{
return gav;
}
public List<Exception> getErrors()
{
return errors;
}
public void addError( Exception e )
{
errors.add( e );
}
/**
* Creates Lucene Document using {@link IndexCreator}s from the given {@link IndexingContext}.
*/
public Document createDocument( IndexingContext context )
{
Document doc = new Document();
// unique key
doc.add( new Field( ArtifactInfo.UINFO, getArtifactInfo().getUinfo(), Store.YES, Index.NOT_ANALYZED ) );
doc.add( new Field( ArtifactInfo.LAST_MODIFIED, //
Long.toString( System.currentTimeMillis() ), Store.YES, Index.NO ) );
for ( IndexCreator indexCreator : context.getIndexCreators() )
{
try
{
indexCreator.populateArtifactInfo( this );
}
catch ( IOException ex )
{
addError( ex );
}
}
// need a second pass in case index creators updated document attributes
for ( IndexCreator indexCreator : context.getIndexCreators() )
{
indexCreator.updateDocument( getArtifactInfo(), doc );
}
return doc;
}
public static class ModelReader
{
public Model readModel( InputStream pom )
{
if ( pom == null )
{
return null;
}
Model model = new Model();
Xpp3Dom dom = readPomInputStream( pom );
if ( dom == null )
{
return null;
}
if ( dom.getChild( "packaging" ) != null )
{
model.setPackaging( dom.getChild( "packaging" ).getValue() );
}
// Special case, packaging should be null instead of default .jar if not set in pom
else
{
model.setPackaging( null );
}
if ( dom.getChild( "name" ) != null )
{
model.setName( dom.getChild( "name" ).getValue() );
}
if ( dom.getChild( "description" ) != null )
{
model.setDescription( dom.getChild( "description" ).getValue() );
}
return model;
}
private Xpp3Dom readPomInputStream( InputStream is )
{
Reader r = new InputStreamReader( is );
try
{
return Xpp3DomBuilder.build( r );
}
catch ( XmlPullParserException e )
{
}
catch ( IOException e )
{
}
finally
{
try
{
r.close();
}
catch ( IOException e )
{
}
}
return null;
}
}
}