org.apache.maven.plugin.dependency.BuildClasspathMojo Maven / Gradle / Ivy
package org.apache.maven.plugin.dependency;
/*
* 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.BufferedReader;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.dependency.utils.DependencyUtil;
import org.apache.maven.project.MavenProjectHelper;
import org.apache.maven.shared.artifact.filter.collection.ArtifactsFilter;
import org.codehaus.plexus.util.StringUtils;
/**
* This goal will output a classpath string of dependencies from the local repository to a file or log.
*
* @goal build-classpath
* @requiresDependencyResolution test
* @phase generate-sources
* @author ankostis
* @version $Id: BuildClasspathMojo.java 614346 2008-01-22 22:05:09Z brianf $
* @since 2.0-alpha-2
*/
public class BuildClasspathMojo
extends AbstractDependencyFilterMojo
implements Comparator
{
/**
* Strip artifact version during copy (only works if prefix is set)
*
* @parameter expression="${mdep.stripVersion}" default-value="false"
* @parameter
*/
private boolean stripVersion = false;
/**
* The prefix to prepend on each dependent artifact. If undefined, the paths refer to the actual files store in the
* local repository (the stipVersion parameter does nothing then).
*
* @parameter expression="${mdep.prefix}"
*/
private String prefix;
/**
* The file to write the classpath string. If undefined, it just prints the classpath as [INFO].
* This parameter is deprecated. Use outputFile instead.
* @parameter expression="${mdep.cpFile}"
* @deprecated use outputFile instead
* @since 2.0-alpha-5
*/
private File cpFile;
/**
* The file to write the classpath string. If undefined, it just prints the classpath as [INFO].
* @parameter expression="${mdep.outputFile}"
*/
private File outputFile;
/**
* If 'true', it skips the up-to-date-check, and always regenerates the classpath file.
*
* @parameter default-value="false" expression="${mdep.regenerateFile}"
*/
private boolean regenerateFile;
/**
* Override the char used between the paths. This field is initialized to contain the first character of the value
* of the system property file.separator. On UNIX systems the value of this field is '/'; on Microsoft Windows
* systems it is '\'. The default is File.separator
*
* @since 2.0-alpha-5
* @parameter default-value="" expression="${mdep.fileSeparator}"
*/
private String fileSeparator;
/**
* Override the char used between path folders. The system-dependent path-separator character. This field is
* initialized to contain the first character of the value of the system property path.separator. This character is
* used to separate filenames in a sequence of files given as a path list. On UNIX systems, this character is ':';
* on Microsoft Windows systems it is ';'.
*
* @since 2.0-alpha-5
* @parameter default-value="" expression="${mdep.pathSeparator}"
*/
private String pathSeparator;
/**
* Replace the absolute path to the local repo with this property. This field is ignored it prefix is declared. The
* value will be forced to "${M2_REPO}" if no value is provided AND the attach flag is true.
*
* @since 2.0-alpha-5
* @parameter default-value="" expression="${mdep.localRepoProperty}"
*/
private String localRepoProperty;
/**
* Attach the classpath file to the main artifact so it can be installed and deployed.
*
* @since 2.0-alpha-5
* @parameter default-value=false
*/
boolean attach;
/**
* Write out the classpath in a format compatible with filtering (classpath=xxxxx)
*
* @since 2.0-alpha-5
* @parameter default-value=false expression="${mdep.outputFilterFile}"
*/
boolean outputFilterFile;
/**
* Maven ProjectHelper
*
* @component
* @readonly
*/
private MavenProjectHelper projectHelper;
boolean isFileSepSet = true;
boolean isPathSepSet = true;
/**
* Main entry into mojo. Gets the list of dependencies and iterates through calling copyArtifact.
*
* @throws MojoExecutionException with a message if an error occurs.
* @see #getDependencies
* @see #copyArtifact(Artifact, boolean)
*/
public void execute()
throws MojoExecutionException
{
if (cpFile != null)
{
getLog().warn( "The parameter cpFile is deprecated. Use outputFile instead." );
this.outputFile = cpFile;
}
// initialize the separators.
if ( StringUtils.isEmpty( fileSeparator ) )
{
isFileSepSet = false;
}
else
{
isFileSepSet = true;
}
if ( StringUtils.isEmpty( pathSeparator ) )
{
isPathSepSet = false;
}
else
{
isPathSepSet = true;
}
//don't allow them to have absolute paths when they attach.
if ( attach && StringUtils.isEmpty( localRepoProperty ) )
{
localRepoProperty = "${M2_REPO}";
}
Set artifacts = getResolvedDependencies( true );
if ( artifacts == null || artifacts.isEmpty() )
{
getLog().info( "No dependencies found." );
}
List artList = new ArrayList( artifacts );
StringBuffer sb = new StringBuffer();
Iterator i = artList.iterator();
if ( i.hasNext() )
{
appendArtifactPath( (Artifact) i.next(), sb );
while ( i.hasNext() )
{
sb.append( isPathSepSet ? this.pathSeparator : File.pathSeparator );
appendArtifactPath( (Artifact) i.next(), sb );
}
}
String cpString = sb.toString();
// if file separator is set, I need to replace the default one from all
// the file paths the where pulled from the artifacts
if ( isFileSepSet )
{
String separator = File.separator;
// if the file sep is "\" then I need to escape it for the regex
if ( File.separator.equals( "\\" ) )
{
separator = "\\\\";
}
cpString = cpString.replaceAll( separator, fileSeparator );
}
//make the string valid for filtering
if (outputFilterFile)
{
cpString = "classpath="+ cpString;
}
if ( outputFile == null )
{
getLog().info( "Dependencies classpath:\n" + cpString );
}
else
{
if ( regenerateFile || !isUpdToDate( cpString ) )
{
storeClasspathFile( cpString, outputFile );
}
else
{
this.getLog().info( "Skipped writing classpath file '" + outputFile + "'. No changes found." );
}
}
if ( attach )
{
attachFile( cpString );
}
}
protected void attachFile( String cpString )
throws MojoExecutionException
{
File attachedFile = new File( project.getBuild().getDirectory(), "classpath" );
storeClasspathFile( cpString, attachedFile );
projectHelper.attachArtifact( project, attachedFile, "classpath" );
}
/**
* Appends the artifact path into the specified stringBuffer.
*
* @param art
* @param sb
*/
protected void appendArtifactPath( Artifact art, StringBuffer sb )
{
if ( prefix == null )
{
String file = art.getFile().getPath();
// substitute the property for the local repo path to make the classpath file portable.
if ( StringUtils.isNotEmpty( localRepoProperty ) )
{
file = StringUtils.replace( file, local.getBasedir(), localRepoProperty );
}
sb.append( file );
}
else
{
// TODO: add param for prepending groupId and version.
sb.append( prefix );
sb.append( File.separator );
sb.append( DependencyUtil.getFormattedFileName( art, this.stripVersion ) );
}
}
/**
* Checks that new classpath differs from that found inside the old classpathFile.
*
* @param cpString
* @return true if the specified classpath equals to that found inside the file, false otherwise (including when
* file does not exists but new classpath does).
*/
private boolean isUpdToDate( String cpString )
{
try
{
String oldCp = readClasspathFile();
return ( cpString == oldCp || ( cpString != null && cpString.equals( oldCp ) ) );
}
catch ( Exception ex )
{
this.getLog().warn( "Error while reading old classpath file '" + outputFile + "' for up-to-date check: " + ex );
return false;
}
}
/**
* It stores the specified string into that file.
*
* @param cpString the string to be written into the file.
* @throws MojoExecutionException
*/
private void storeClasspathFile( String cpString, File out )
throws MojoExecutionException
{
//make sure the parent path exists.
out.getParentFile().mkdirs();
try
{
Writer w = new BufferedWriter( new FileWriter( out ) );
try
{
w.write( cpString );
getLog().info( "Wrote classpath file '" + out + "'." );
}
catch ( IOException ex )
{
throw new MojoExecutionException( "Error while writting to classpath file '" + out + "': " +
ex.toString(), ex );
}
finally
{
w.close();
}
}
catch ( IOException ex )
{
throw new MojoExecutionException( "Error while opening/closing classpath file '" + out + "': " +
ex.toString(), ex );
}
}
/**
* Reads into a string the file specified by the mojo param 'outputFile'. Assumes, the instance variable 'outputFile' is not
* null.
*
* @return the string contained in the classpathFile, if exists, or null ortherwise.
* @throws MojoExecutionException
*/
protected String readClasspathFile()
throws IOException
{
if ( outputFile == null )
{
throw new IllegalArgumentException(
"The outputFile parameter cannot be null if the file is intended to be read." );
}
if ( !outputFile.isFile() )
{
return null;
}
StringBuffer sb = new StringBuffer();
BufferedReader r = new BufferedReader( new FileReader( outputFile ) );
try
{
String l;
while ( ( l = r.readLine() ) != null )
{
sb.append( l );
}
return sb.toString();
}
finally
{
r.close();
}
}
/**
* Compares artifacts lexicographically, using pattern [group_id][artifact_id][version].
*
* @param arg1 first object
* @param arg2 second object
* @return the value 0 if the argument string is equal to this string; a value less than
* 0 if this string is lexicographically less than the string argument; and a value greater
* than 0 if this string is lexicographically greater than the string argument.
*/
public int compare( Object arg1, Object arg2 )
{
if ( arg1 instanceof Artifact && arg2 instanceof Artifact )
{
if ( arg1 == arg2 )
{
return 0;
}
else if ( arg1 == null )
{
return -1;
}
else if ( arg2 == null )
{
return +1;
}
Artifact art1 = (Artifact) arg1;
Artifact art2 = (Artifact) arg2;
String s1 = art1.getGroupId() + art1.getArtifactId() + art1.getVersion();
String s2 = art2.getGroupId() + art2.getArtifactId() + art2.getVersion();
return s1.compareTo( s2 );
}
else
{
return 0;
}
}
protected ArtifactsFilter getMarkedArtifactFilter()
{
return null;
}
/**
* @return the outputFile
*/
public File getCpFile()
{
return this.outputFile;
}
/**
* @param theCpFile the outputFile to set
*/
public void setCpFile( File theCpFile )
{
this.outputFile = theCpFile;
}
/**
* @return the fileSeparator
*/
public String getFileSeparator()
{
return this.fileSeparator;
}
/**
* @param theFileSeparator the fileSeparator to set
*/
public void setFileSeparator( String theFileSeparator )
{
this.fileSeparator = theFileSeparator;
}
/**
* @return the pathSeparator
*/
public String getPathSeparator()
{
return this.pathSeparator;
}
/**
* @param thePathSeparator the pathSeparator to set
*/
public void setPathSeparator( String thePathSeparator )
{
this.pathSeparator = thePathSeparator;
}
/**
* @return the prefix
*/
public String getPrefix()
{
return this.prefix;
}
/**
* @param thePrefix the prefix to set
*/
public void setPrefix( String thePrefix )
{
this.prefix = thePrefix;
}
/**
* @return the regenerateFile
*/
public boolean isRegenerateFile()
{
return this.regenerateFile;
}
/**
* @param theRegenerateFile the regenerateFile to set
*/
public void setRegenerateFile( boolean theRegenerateFile )
{
this.regenerateFile = theRegenerateFile;
}
/**
* @return the stripVersion
*/
public boolean isStripVersion()
{
return this.stripVersion;
}
/**
* @param theStripVersion the stripVersion to set
*/
public void setStripVersion( boolean theStripVersion )
{
this.stripVersion = theStripVersion;
}
public String getLocalRepoProperty()
{
return localRepoProperty;
}
public void setLocalRepoProperty( String localRepoProperty )
{
this.localRepoProperty = localRepoProperty;
}
public boolean isFileSepSet()
{
return isFileSepSet;
}
public void setFileSepSet( boolean isFileSepSet )
{
this.isFileSepSet = isFileSepSet;
}
public boolean isPathSepSet()
{
return isPathSepSet;
}
public void setPathSepSet( boolean isPathSepSet )
{
this.isPathSepSet = isPathSepSet;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy