package org.codehaus.mojo.versions;
/*
* 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.manager.WagonManager;
import org.apache.maven.artifact.metadata.ArtifactMetadataRetrievalException;
import org.apache.maven.artifact.metadata.ArtifactMetadataSource;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.artifact.resolver.ArtifactResolver;
import org.apache.maven.artifact.versioning.ArtifactVersion;
import org.apache.maven.artifact.versioning.VersionRange;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.siterenderer.Renderer;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.path.PathTranslator;
import org.apache.maven.reporting.AbstractMavenReport;
import org.apache.maven.reporting.MavenReportException;
import org.apache.maven.settings.Settings;
import org.codehaus.mojo.versions.api.ArtifactVersions;
import org.codehaus.mojo.versions.api.DefaultVersionsHelper;
import org.codehaus.mojo.versions.api.VersionsHelper;
import org.codehaus.plexus.i18n.I18N;
import java.io.File;
import java.util.List;
import java.util.Locale;
/**
* Base class for all versions reports.
*
* @author Stephen Connolly
* @since 1.0-alpha-3
*/
public abstract class AbstractVersionsReport
extends AbstractMavenReport
{
/**
* Doxia Site Renderer component.
*
* @since 1.0-alpha-3
*/
@Component
private Renderer siteRenderer;
/**
* Internationalization component.
*
* @since 1.0-alpha-3
*/
@Component
private I18N i18n;
/**
* The Maven Project.
*
* @since 1.0-alpha-3
*/
@Parameter(defaultValue = "${project}", required = true, readonly = true)
private MavenProject project;
/**
* @since 1.0-alpha-3
*/
@Component
protected ArtifactFactory artifactFactory;
/**
* @component
* @since 1.0-alpha-3
*/
@Component
private ArtifactResolver resolver;
/**
* The output directory for the report. Note that this parameter is only evaluated if the goal is run directly from
* the command line. If the goal is run indirectly as part of a site generation, the output directory configured in
* the Maven Site Plugin is used instead.
*
* @since 1.0-alpha-3
*/
@Parameter (defaultValue = "${project.reporting.outputDirectory}", required = true)
private File outputDirectory;
/**
* Skip entire check.
*
* @since 1.0-alpha-3
*/
@Parameter (property = "versions.skip")
private Boolean skip;
/**
* The artifact metadata source to use.
*
* @since 1.0-alpha-1
*/
@Component
protected ArtifactMetadataSource artifactMetadataSource;
/**
* @since 1.0-alpha-3
*/
@Parameter(defaultValue = "${project.remoteArtifactRepositories}", readonly = true)
protected List remoteArtifactRepositories;
/**
* @since 1.0-alpha-3
*/
@Parameter(defaultValue = "${project.pluginArtifactRepositories}", readonly = true)
protected List remotePluginRepositories;
/**
* @since 1.0-alpha-1
*/
@Parameter(defaultValue = "${localRepository}", readonly = true)
protected ArtifactRepository localRepository;
/**
* @since 1.0-alpha-3
*/
@Component
private WagonManager wagonManager;
/**
* @since 1.0-alpha-3
*/
@Parameter (defaultValue = "${settings}", readonly = true)
private Settings settings;
/**
* settings.xml's server id for the URL. This is used when wagon needs extra authentication information.
*
* @since 1.0-alpha-3
*/
@Parameter (property = "maven.version.rules.serverId", defaultValue = "serverId")
private String serverId;
/**
* The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
*
* @since 1.0-alpha-3
*/
@Parameter(property = "maven.version.rules")
private String rulesUri;
/**
* The versioning rule to use when comparing versions. Valid values are <code>maven</code>, <code>numeric</code>
* which will handle long version numbers provided all components are numeric, or <code>mercury</code> which will
* use the mercury version number comparison rules.
*
* @since 1.0-alpha-1
*/
@Parameter (property = "comparisonMethod")
protected String comparisonMethod;
/**
* Whether to allow snapshots when searching for the latest version of an artifact.
*
* @since 1.0-alpha-3
*/
@Parameter (property = "allowSnapshots", defaultValue = "false")
protected Boolean allowSnapshots;
/**
* Our versions helper.
*/
private VersionsHelper helper;
/**
* The Maven Session.
*
* @since 1.0-beta-1
*/
@Parameter(defaultValue = "${session}", required = true, readonly = true)
protected MavenSession session;
@Component
protected PathTranslator pathTranslator;
@Component
protected ArtifactResolver artifactResolver;
// --------------------- GETTER / SETTER METHODS ---------------------
public VersionsHelper getHelper()
throws MavenReportException
{
if ( helper == null )
{
try
{
helper = new DefaultVersionsHelper( artifactFactory, artifactResolver, artifactMetadataSource,
remoteArtifactRepositories, remotePluginRepositories,
localRepository, wagonManager, settings, serverId, rulesUri,
getLog(), session, pathTranslator );
}
catch ( MojoExecutionException e )
{
throw new MavenReportException( e.getMessage(), e );
}
}
return helper;
}
/**
* {@inheritDoc}
*/
protected void executeReport( Locale locale )
throws MavenReportException
{
if ( !Boolean.TRUE.equals( skip ) )
{
try
{
doGenerateReport( locale, getSink() );
}
catch ( MojoExecutionException e )
{
throw new MavenReportException( e.getMessage(), e );
}
}
}
/**
* generates the report.
*
* @param locale the locale to generate the report for.
* @param sink the report formatting tool.
* @throws MavenReportException when things go wrong.
*/
protected abstract void doGenerateReport( Locale locale, Sink sink )
throws MavenReportException, MojoExecutionException;
/**
* Finds the latest version of the specified artifact that matches the version range.
*
* @param artifact The artifact.
* @param versionRange The version range.
* @param allowingSnapshots <code>null</code> for no override, otherwise the local override to apply.
* @return The latest version of the specified artifact that matches the specified version range or
* <code>null</code> if no matching version could be found.
* @throws MojoExecutionException If the artifact metadata could not be found.
* @since 1.0-alpha-1
*/
protected ArtifactVersion findLatestVersion( Artifact artifact, VersionRange versionRange,
Boolean allowingSnapshots, boolean usePluginRepositories )
throws MavenReportException
{
boolean includeSnapshots = Boolean.TRUE.equals( this.allowSnapshots );
if ( Boolean.TRUE.equals( allowingSnapshots ) )
{
includeSnapshots = true;
}
if ( Boolean.FALSE.equals( allowingSnapshots ) )
{
includeSnapshots = false;
}
try
{
final ArtifactVersions artifactVersions =
getHelper().lookupArtifactVersions( artifact, usePluginRepositories );
return artifactVersions.getNewestVersion( versionRange, includeSnapshots );
}
catch ( ArtifactMetadataRetrievalException e )
{
throw new MavenReportException( e.getMessage(), e );
}
}
/**
* @see org.apache.maven.reporting.AbstractMavenReport#getProject()
*/
protected MavenProject getProject()
{
return project;
}
/**
* @see org.apache.maven.reporting.AbstractMavenReport#getOutputDirectory()
*/
protected String getOutputDirectory()
{
if ( !outputDirectory.isAbsolute() )
{
outputDirectory = new File( project.getBasedir(), outputDirectory.getPath() );
}
return outputDirectory.getAbsolutePath();
}
/**
* @see org.apache.maven.reporting.AbstractMavenReport#getSiteRenderer()
*/
protected Renderer getSiteRenderer()
{
return siteRenderer;
}
/**
* @see org.apache.maven.reporting.MavenReport#getDescription(java.util.Locale)
*/
public String getDescription( Locale locale )
{
return getText( locale, "report.description" );
}
/**
* @see org.apache.maven.reporting.MavenReport#getName(java.util.Locale)
*/
public String getName( Locale locale )
{
return getText( locale, "report.title" );
}
/**
* Gets the localized message for this report.
*
* @param locale the locale.
* @param key the message key.
* @return the message.
*/
public String getText( Locale locale, String key )
{
return i18n.getString( getOutputName(), locale, key );
}
public Boolean getAllowSnapshots()
{
return this.allowSnapshots;
}
public String getComparisonMethod()
{
return comparisonMethod;
}
public ArtifactResolver getResolver()
{
return resolver;
}
public I18N getI18n()
{
return i18n;
}
}