package org.apache.maven.artifact.ant;
/*
* 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 org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.factory.ArtifactFactory;
import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.resolver.ArtifactNotFoundException;
import org.apache.maven.artifact.resolver.ArtifactResolutionException;
import org.apache.maven.artifact.resolver.ArtifactResolver;
import org.apache.maven.model.Build;
import org.apache.maven.model.CiManagement;
import org.apache.maven.model.DependencyManagement;
import org.apache.maven.model.DistributionManagement;
import org.apache.maven.model.IssueManagement;
import org.apache.maven.model.Model;
import org.apache.maven.model.Organization;
import org.apache.maven.model.Parent;
import org.apache.maven.model.Reporting;
import org.apache.maven.model.Scm;
import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectBuilder;
import org.apache.maven.project.MavenProjectHelper;
import org.apache.maven.project.ProjectBuildingException;
import org.apache.maven.project.artifact.MavenMetadataSource;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.PropertyHelper;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.introspection.ReflectionValueExtractor;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.util.Collections;
import java.util.List;
/**
* A POM typedef.
*
* Also an Ant Task that registers a handler called POMPropertyHelper
* that intercepts all calls to property value resolution and replies instead
* of Ant to properties that start with the id of the pom.
*
* Example:
* ${maven.project.artifactId}
*
* @author <a href="mailto:brett@apache.org">Brett Porter</a>
* @author <a href="mailto:nicolaken@apache.org">Nicola Ken Barozzi</a>
* @version $Id: Pom.java 633204 2008-03-03 17:46:50Z hboutemy $
*/
public class Pom
extends AbstractArtifactWithRepositoryTask
{
private String refid;
private String antId;
private MavenProject mavenProject;
private File file;
/**
* The property interceptor.
*/
private final POMPropertyHelper helper = new POMPropertyHelper();
public String getRefid()
{
return refid;
}
public void setRefid( String refid )
{
this.refid = refid;
}
public void setId( String id )
{
this.antId = id;
}
protected Pom getInstance()
{
Pom instance = this;
if ( refid != null )
{
instance = (Pom) getProject().getReference( refid );
if ( instance == null )
{
throw new BuildException( "Invalid reference: '" + refid + "'" );
}
}
return instance;
}
public void setMavenProject( MavenProject mavenProject )
{
getInstance().mavenProject = mavenProject;
}
public File getFile()
{
return getInstance().file;
}
public void setFile( File file )
{
this.file = file;
}
public Artifact getArtifact()
{
return getMavenProject().getArtifact();
}
public void attach( AttachedArtifact attached )
{
MavenProjectHelper helper = (MavenProjectHelper) lookup( MavenProjectHelper.ROLE );
MavenProject project = getMavenProject();
if (attached.getClassifier() != null) {
helper.attachArtifact( project, attached.getType(), attached.getClassifier(), attached.getFile() );
}
else {
helper.attachArtifact( project, attached.getType(), attached.getFile() );
}
}
public List getAttachedArtifacts()
{
return getMavenProject().getAttachedArtifacts();
}
void initialise( MavenProjectBuilder builder, ArtifactRepository localRepository )
{
if ( mavenProject != null )
{
log( "POM is already initialized for: " + mavenProject.getId(), Project.MSG_DEBUG );
return;
}
// TODO: should this be in execute() too? Would that work when it is used as a type?
if ( file != null )
{
checkParentPom();
try
{
mavenProject = builder.build( file, localRepository, getProfileManager() );
}
catch ( ProjectBuildingException e )
{
throw new BuildException( "Unable to initialize POM " + file.getName() + ": " + e.getMessage(), e );
}
}
else if ( refid != null )
{
getInstance().initialise( builder, localRepository );
}
}
private void checkParentPom()
{
Model model = null;
try
{
Reader reader = ReaderFactory.newXmlReader( file );
model = new MavenXpp3Reader().read( reader );
}
catch ( IOException e )
{
throw new BuildException( "IO error while reading pom: " + e.getMessage(), e );
}
catch ( XmlPullParserException e )
{
throw new BuildException( "Error parsing pom: " + e.getMessage(), e );
}
if ( model.getParent() != null && model.getParent().getRelativePath() != null )
{
// resolve parent pom
Parent parent = model.getParent();
String groupId = parent.getGroupId();
String artifactId = parent.getArtifactId();
String version = parent.getVersion();
ArtifactFactory factory = (ArtifactFactory) lookup( ArtifactFactory.ROLE );
Artifact parentArtifact = factory.createParentArtifact( groupId, artifactId, version );
try
{
MavenMetadataSource metadataSource = (MavenMetadataSource) lookup( ArtifactMetadataSource.ROLE );
ArtifactResolver resolver = (ArtifactResolver) lookup( ArtifactResolver.ROLE );
List remoteRepositories = createRemoteArtifactRepositories( model.getRepositories() );
resolver.resolveTransitively( Collections.singleton( parentArtifact ),
createDummyArtifact(), createLocalArtifactRepository(),
remoteRepositories, metadataSource, null );
}
catch ( ArtifactResolutionException e )
{
// MANTTASKS-87: don't fail if parent pom is not resolved immediately
log( "Error downloading parent pom " + parent.getId() + ": " + e.getMessage(), Project.MSG_WARN );
}
catch ( ArtifactNotFoundException e )
{
throw new BuildException( "Unable to download parent pom " + parent.getId() + " in remote repository: " + e.getMessage(), e );
}
}
}
protected MavenProject getMavenProject()
{
return getInstance().mavenProject;
}
public String getArtifactId()
{
return getMavenProject().getArtifactId();
} //-- String getArtifactId()
public Build getBuild()
{
return getMavenProject().getBuild();
} //-- Build getBuild()
public CiManagement getCiManagement()
{
return getMavenProject().getCiManagement();
} //-- CiManagement getCiManagement()
public List getContributors()
{
return getMavenProject().getContributors();
} //-- List getContributors()
public List getDependencies()
{
return getMavenProject().getDependencies();
} //-- List getDependencies()
public DependencyManagement getDependencyManagement()
{
return getMavenProject().getDependencyManagement();
} //-- DependencyManagement getDependencyManagement()
public String getDescription()
{
return getMavenProject().getDescription();
} //-- String getDescription()
public List getDevelopers()
{
return getMavenProject().getDevelopers();
} //-- List getDevelopers()
public DistributionManagement getDistributionManagement()
{
return getMavenProject().getDistributionManagement();
} //-- DistributionManagement getDistributionManagement()
public String getGroupId()
{
return getMavenProject().getGroupId();
} //-- String getGroupId()
public String getInceptionYear()
{
return getMavenProject().getInceptionYear();
} //-- String getInceptionYear()
public IssueManagement getIssueManagement()
{
return getMavenProject().getIssueManagement();
} //-- IssueManagement getIssueManagement()
public List getLicenses()
{
return getMavenProject().getLicenses();
} //-- List getLicenses()
public List getMailingLists()
{
return getMavenProject().getMailingLists();
} //-- List getMailingLists()
public String getModelVersion()
{
return getMavenProject().getModelVersion();
} //-- String getModelVersion()
public List getModules()
{
return getMavenProject().getModules();
} //-- List getModules()
public String getName()
{
return getMavenProject().getName();
} //-- String getName()
public Organization getOrganization()
{
return getMavenProject().getOrganization();
} //-- Organization getOrganization()
public String getPackaging()
{
return getMavenProject().getPackaging();
} //-- String getPackaging()
public List getPluginRepositories()
{
return getMavenProject().getPluginRepositories();
} //-- List getPluginRepositories()
public Reporting getReporting()
{
return getMavenProject().getReporting();
} //-- Reports getReports()
public List getRepositories()
{
return getMavenProject().getRepositories();
} //-- List getRepositories()
public Scm getScm()
{
return getMavenProject().getScm();
} //-- Scm getScm()
public String getUrl()
{
return getMavenProject().getUrl();
} //-- String getUrl()
public String getVersion()
{
return getMavenProject().getVersion();
} //-- String getVersion()
public String getId()
{
return getMavenProject().getId();
}
/**
* Registers POMPropertyHelper as a property interceptor
*/
protected void doExecute()
{
ArtifactRepository localRepo = createLocalArtifactRepository();
MavenProjectBuilder projectBuilder = (MavenProjectBuilder) lookup( MavenProjectBuilder.ROLE );
initialise( projectBuilder, localRepo );
Project project = getProject();
// Add a reference to this task/type
project.addReference( antId, this );
// Register the property interceptor
PropertyHelper phelper = PropertyHelper.getPropertyHelper( project );
helper.setNext( phelper.getNext() );
helper.setProject( project );
phelper.setNext( helper );
}
/**
* The property interceptor that handles the calls for "pom." properties
*/
private class POMPropertyHelper
extends PropertyHelper
{
/**
* The method that gets called by Ant with every request of property
*/
public Object getPropertyHook( String ns, String name, boolean user )
{
String prefix = antId + ".";
if ( !name.startsWith( prefix ) )
{
// pass on to next interceptor
return super.getPropertyHook( ns, name, user );
}
try
{
// else handle the property resolution
String expression = name.substring( prefix.length() );
return getPOMValue( "project." + expression );
}
catch ( Exception ex )
{
ex.printStackTrace();
return null;
}
}
private Object getPOMValue( String expression )
{
Object value = null;
try
{
if ( expression.startsWith( "project.properties." ) )
{
expression = expression.substring( 19 );
value = getMavenProject().getProperties().get( expression );
}
else
{
value = ReflectionValueExtractor.evaluate( expression, getMavenProject() );
}
}
catch ( Exception e )
{
throw new BuildException( "Error extracting expression from POM", e );
}
return value;
}
}
}