package org.apache.maven.report.projectinfo;
/*
* 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.ArtifactMetadataSource;
import org.apache.maven.artifact.repository.metadata.RepositoryMetadataManager;
import org.apache.maven.artifact.resolver.filter.ArtifactFilter;
import org.apache.maven.artifact.resolver.filter.ScopeArtifactFilter;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProjectBuilder;
import org.apache.maven.report.projectinfo.dependencies.Dependencies;
import org.apache.maven.report.projectinfo.dependencies.DependenciesReportConfiguration;
import org.apache.maven.report.projectinfo.dependencies.RepositoryUtils;
import org.apache.maven.report.projectinfo.dependencies.renderer.DependenciesRenderer;
import org.apache.maven.shared.dependency.graph.DependencyGraphBuilder;
import org.apache.maven.shared.dependency.graph.DependencyGraphBuilderException;
import org.apache.maven.shared.dependency.graph.DependencyNode;
import org.apache.maven.shared.jar.classes.JarClassesAnalysis;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.LineNumberReader;
import java.util.Locale;
/**
* Generates the Project Dependencies report.
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl </a>
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton </a>
* @version $Id: DependenciesReport.java 1359783 2012-07-10 16:57:48Z tchemit $
* @since 2.0
*/
@Mojo( name = "dependencies", requiresDependencyResolution = ResolutionScope.TEST )
public class DependenciesReport
extends AbstractProjectInfoReport
{
/**
* Images resources dir
*/
private static final String RESOURCES_DIR = "org/apache/maven/report/projectinfo/resources";
// ----------------------------------------------------------------------
// Mojo components
// ----------------------------------------------------------------------
/**
* Maven Project Builder component.
*/
@Component
private MavenProjectBuilder mavenProjectBuilder;
/**
* Artifact metadata source component.
*/
@Component
protected ArtifactMetadataSource artifactMetadataSource;
/**
* Wagon manager component.
*
* @since 2.1
*/
@Component
private WagonManager wagonManager;
/**
* Dependency graph builder component.
*
* @since 2.5
*/
@Component( hint = "default" )
private DependencyGraphBuilder dependencyGraphBuilder;
/**
* Jar classes analyzer component.
*
* @since 2.1
*/
@Component
private JarClassesAnalysis classesAnalyzer;
/**
* Repository metadata component.
*
* @since 2.1
*/
@Component
private RepositoryMetadataManager repositoryMetadataManager;
/**
* Maven Artifact Factory component.
*
* @since 2.1
*/
@Component
private ArtifactFactory artifactFactory;
// ----------------------------------------------------------------------
// Mojo parameters
// ----------------------------------------------------------------------
/**
* Display file details for each dependency, such as: file size, number of
* classes, number of packages etc.
*
* @since 2.1
*/
@Parameter( property = "dependency.details.enabled", defaultValue = "true" )
private boolean dependencyDetailsEnabled;
/**
* Display the repository locations of the dependencies. If Maven is configured to be offline, this parameter
* will be ignored.
*
* @since 2.1
*/
@Parameter( property = "dependency.locations.enabled", defaultValue = "true" )
private boolean dependencyLocationsEnabled;
// ----------------------------------------------------------------------
// Public methods
// ----------------------------------------------------------------------
@Override
public void executeReport( Locale locale )
{
if ( settings.isOffline() && dependencyLocationsEnabled )
{
getLog().warn( "The parameter 'dependencyLocationsEnabled' is ignored in offline mode." );
dependencyLocationsEnabled = false;
}
try
{
copyResources( new File( getOutputDirectory() ) );
}
catch ( IOException e )
{
getLog().error( "Cannot copy ressources", e );
}
@SuppressWarnings( "unchecked" ) RepositoryUtils repoUtils =
new RepositoryUtils( getLog(), wagonManager, settings, mavenProjectBuilder, factory, resolver,
project.getRemoteArtifactRepositories(), project.getPluginArtifactRepositories(),
localRepository, repositoryMetadataManager );
DependencyNode dependencyNode = resolveProject();
Dependencies dependencies = new Dependencies( project, dependencyNode, classesAnalyzer );
DependenciesReportConfiguration config =
new DependenciesReportConfiguration( dependencyDetailsEnabled, dependencyLocationsEnabled );
DependenciesRenderer r =
new DependenciesRenderer( getSink(), locale, getI18N( locale ), getLog(), settings, dependencies,
dependencyNode, config, repoUtils, artifactFactory, mavenProjectBuilder,
remoteRepositories, localRepository );
r.render();
}
/**
* {@inheritDoc}
*/
public String getOutputName()
{
return "dependencies";
}
@Override
protected String getI18Nsection()
{
return "dependencies";
}
// ----------------------------------------------------------------------
// Private methods
// ----------------------------------------------------------------------
/**
* @return resolve the dependency tree
*/
private DependencyNode resolveProject()
{
try
{
ArtifactFilter artifactFilter = new ScopeArtifactFilter( Artifact.SCOPE_TEST );
return dependencyGraphBuilder.buildDependencyGraph( project, artifactFilter );
}
catch ( DependencyGraphBuilderException e )
{
getLog().error( "Unable to build dependency tree.", e );
return null;
}
}
/**
* @param outputDirectory the wanted output directory
* @throws IOException if any
*/
private void copyResources( File outputDirectory )
throws IOException
{
InputStream resourceList = null;
LineNumberReader reader = null;
try
{
resourceList = getClass().getClassLoader().getResourceAsStream( RESOURCES_DIR + "/resources.txt" );
if ( resourceList != null )
{
reader = new LineNumberReader( new InputStreamReader( resourceList, ReaderFactory.US_ASCII ) );
String line = reader.readLine();
while ( line != null )
{
InputStream is = getClass().getClassLoader().getResourceAsStream( RESOURCES_DIR + "/" + line );
if ( is == null )
{
throw new IOException( "The resource " + line + " doesn't exist." );
}
File outputFile = new File( outputDirectory, line );
if ( !outputFile.getParentFile().exists() )
{
outputFile.getParentFile().mkdirs();
}
FileOutputStream w = null;
try
{
w = new FileOutputStream( outputFile );
IOUtil.copy( is, w );
}
finally
{
IOUtil.close( is );
IOUtil.close( w );
}
line = reader.readLine();
}
}
}
finally
{
IOUtil.close( resourceList );
IOUtil.close( reader );
}
}
}