org.codehaus.mojo.license.api.DefaultThirdPartyHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of license-maven-plugin Show documentation
Show all versions of license-maven-plugin Show documentation
Maven plugin to download and collect license files from project dependencies.
package org.codehaus.mojo.license.api;
/*
* #%L
* License Maven Plugin
* %%
* Copyright (C) 2012 CodeLutin, Codehaus, Tony Chemit
* %%
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Lesser Public License for more details.
*
* You should have received a copy of the GNU General Lesser Public
* License along with this program. If not, see
* .
* #L%
*/
import org.apache.commons.collections.CollectionUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.ProjectBuildingException;
import org.codehaus.mojo.license.model.LicenseMap;
import org.codehaus.mojo.license.utils.SortedProperties;
import java.io.File;
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedMap;
import java.util.SortedSet;
import java.util.TreeMap;
/**
* Default implementation of the {@link org.codehaus.mojo.license.api.ThirdPartyHelper}.
*
* @author tchemit [email protected]
* @since 1.1
*/
public class DefaultThirdPartyHelper
implements ThirdPartyHelper
{
/**
* DependenciesTool to load dependencies.
*
* @see DependenciesTool
*/
private final DependenciesTool dependenciesTool;
/**
* ThirdPartyTool to load third-parties descriptors.
*
* @see ThirdPartyTool
*/
private final ThirdPartyTool thirdPartyTool;
/**
* Local repository used.
*/
private final ArtifactRepository localRepository;
/**
* List of remote repositories.
*/
private final List remoteRepositories;
/**
* Current maven project.
*/
private final MavenProject project;
/**
* Encoding used to read and write files.
*/
private final String encoding;
/**
* Verbose flag.
*/
private final boolean verbose;
/**
* Instance logger.
*/
private final Log log;
/**
* Cache of dependencies (as maven project) loaded.
*/
private static SortedMap artifactCache;
/**
* Constructor of the helper.
*
* @param project Current maven project
* @param encoding Encoding used to read and write files
* @param verbose Verbose flag
* @param dependenciesTool tool to load dependencies
* @param thirdPartyTool tool to load third-parties descriptors
* @param localRepository maven local repository
* @param remoteRepositories maven remote repositories
* @param log logger
*/
public DefaultThirdPartyHelper( MavenProject project, String encoding, boolean verbose,
DependenciesTool dependenciesTool, ThirdPartyTool thirdPartyTool,
ArtifactRepository localRepository, List remoteRepositories,
Log log )
{
this.project = project;
this.encoding = encoding;
this.verbose = verbose;
this.dependenciesTool = dependenciesTool;
this.thirdPartyTool = thirdPartyTool;
this.localRepository = localRepository;
this.remoteRepositories = remoteRepositories;
this.log = log;
this.thirdPartyTool.setVerbose( verbose );
}
/**
* {@inheritDoc}
*/
public SortedMap getArtifactCache()
{
if ( artifactCache == null )
{
artifactCache = new TreeMap();
}
return artifactCache;
}
/**
* {@inheritDoc}
*/
public SortedMap loadDependencies( MavenProjectDependenciesConfigurator configuration )
{
return dependenciesTool.loadProjectDependencies( project, configuration, localRepository, remoteRepositories,
getArtifactCache() );
}
/**
* {@inheritDoc}
*/
public SortedProperties loadThirdPartyDescriptorForUnsafeMapping( Set topLevelDependencies,
SortedSet unsafeDependencies,
Collection projects,
LicenseMap licenseMap )
throws ThirdPartyToolException, IOException
{
return thirdPartyTool.loadThirdPartyDescriptorsForUnsafeMapping( topLevelDependencies, encoding, projects,
unsafeDependencies, licenseMap,
localRepository, remoteRepositories );
}
/**
* {@inheritDoc}
*/
public SortedProperties loadUnsafeMapping( LicenseMap licenseMap, File missingFile,
SortedMap projectDependencies )
throws IOException
{
return thirdPartyTool.loadUnsafeMapping( licenseMap, projectDependencies, encoding, missingFile );
}
/**
* {@inheritDoc}
*/
public LicenseMap createLicenseMap( SortedMap dependencies )
{
LicenseMap licenseMap = new LicenseMap();
for ( MavenProject project : dependencies.values() )
{
thirdPartyTool.addLicense( licenseMap, project, project.getLicenses() );
}
return licenseMap;
}
/**
* {@inheritDoc}
*/
public void attachThirdPartyDescriptor( File file )
{
thirdPartyTool.attachThirdPartyDescriptor( project, file );
}
/**
* {@inheritDoc}
*/
public SortedSet getProjectsWithNoLicense( LicenseMap licenseMap )
{
return thirdPartyTool.getProjectsWithNoLicense( licenseMap, verbose );
}
/**
* {@inheritDoc}
*/
@SuppressWarnings("unchecked") // project.getArtifacts()
public SortedProperties createUnsafeMapping( LicenseMap licenseMap, File missingFile,
boolean useRepositoryMissingFiles,
SortedSet unsafeDependencies,
SortedMap projectDependencies )
throws ProjectBuildingException, IOException, ThirdPartyToolException
{
SortedProperties unsafeMappings = loadUnsafeMapping( licenseMap, missingFile, projectDependencies );
if ( CollectionUtils.isNotEmpty( unsafeDependencies ) )
{
// there is some unresolved license
if ( useRepositoryMissingFiles )
{
// try to load missing third party files from dependencies
Collection projects = new ArrayList( projectDependencies.values() );
projects.remove( project );
projects.removeAll( unsafeDependencies );
SortedProperties resolvedUnsafeMapping =
loadThirdPartyDescriptorForUnsafeMapping( project.getArtifacts(), unsafeDependencies, projects,
licenseMap );
// push back resolved unsafe mappings (only for project dependencies)
for (Object coord : resolvedUnsafeMapping.keySet()) {
String s = (String) coord;
if (projectDependencies.containsKey(s)){
unsafeMappings.put(s, resolvedUnsafeMapping.get(s));
}
}
}
}
return unsafeMappings;
}
/**
* {@inheritDoc}
*/
public void mergeLicenses( List licenseMerges, LicenseMap licenseMap )
throws MojoFailureException
{
Set licenseFound = new HashSet();
if ( !CollectionUtils.isEmpty( licenseMerges ) )
{
// check where is not multi licenses merged main licenses (see MLICENSE-23)
Map> mergedLicenses = new HashMap>();
for ( String merge : licenseMerges )
{
merge = merge.trim();
String[] split = merge.split( "\\s*\\|\\s*" );
String mainLicense = split[0];
Set mergeList;
if ( mergedLicenses.containsKey( mainLicense ) )
{
mergeList = mergedLicenses.get( mainLicense );
}
else
{
mergeList = new HashSet();
}
for ( int i = 0; i < split.length; i++ )
{
String licenseToAdd = split[i];
if ( i == 0 )
{
// mainLicense will not be merged (to itself)
continue;
}
// check license not already described to be merged
if ( mergeList.contains( licenseToAdd ) || licenseFound.contains( licenseToAdd ) )
{
// this license to merge was already described, fail the build...
throw new MojoFailureException(
"The license " + licenseToAdd + " was already registred in the " +
"configuration, please use only one such entry as describe in example " +
"http://mojo.codehaus.org/license-maven-plugin/examples/example-thirdparty.html#Merge_licenses." );
}
// can add this license for merge
mergeList.add( licenseToAdd );
licenseFound.add( licenseToAdd );
}
// push back licenses to merge for this main license
mergedLicenses.put( mainLicense, mergeList );
}
// merge licenses in license map
for ( Map.Entry> entry : mergedLicenses.entrySet() )
{
String mainLicense = entry.getKey();
Set mergedLicense = entry.getValue();
if ( verbose )
{
log.info( "Will merge to *" + mainLicense + "*, licenses: " + mergedLicense );
}
thirdPartyTool.mergeLicenses( licenseMap, mainLicense, mergedLicense );
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy