org.codehaus.mojo.license.DefaultDependenciesTool 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.
/**
* Copyright 2010-2012 The Kuali Foundation
*
* Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
*
* 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.
*/
package org.codehaus.mojo.license;
import java.util.List;
import java.util.Set;
import java.util.SortedMap;
import java.util.TreeMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.regex.PatternSyntaxException;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.project.MavenProject;
import org.apache.maven.project.MavenProjectBuilder;
import org.apache.maven.project.ProjectBuildingException;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.logging.Logger;
/**
* Default implementation of the {@link DependenciesTool}.
*
* @author tchemit
* @version $Id: DefaultDependenciesTool.java 14411 2011-08-10 22:09:34Z tchemit $
* @plexus.component role="org.codehaus.mojo.license.DependenciesTool" role-hint="default"
* @since 1.0
*/
public class DefaultDependenciesTool extends AbstractLogEnabled implements DependenciesTool {
public static final String INVALID_PATTERN_MESSAGE = "The pattern specified by expression <%s> seems to be invalid.";
/**
* Project builder.
*
* @plexus.requirement
*/
private MavenProjectBuilder mavenProjectBuilder;
/**
* {@inheritDoc}
*/
@Override
public SortedMap loadProjectDependencies(MavenProject project,
MavenProjectDependenciesConfigurator configuration, ArtifactRepository localRepository,
List remoteRepositories, SortedMap cache) {
boolean haveNoIncludedGroups = StringUtils.isEmpty(configuration.getIncludedGroups());
boolean haveNoIncludedArtifacts = StringUtils.isEmpty(configuration.getIncludedArtifacts());
boolean haveExcludedGroups = StringUtils.isNotEmpty(configuration.getExcludedGroups());
boolean haveExcludedArtifacts = StringUtils.isNotEmpty(configuration.getExcludedArtifacts());
boolean haveExclusions = haveExcludedGroups || haveExcludedArtifacts;
Pattern includedGroupPattern = null;
Pattern includedArtifactPattern = null;
Pattern excludedGroupPattern = null;
Pattern excludedArtifactPattern = null;
if (!haveNoIncludedGroups) {
includedGroupPattern = Pattern.compile(configuration.getIncludedGroups());
}
if (!haveNoIncludedArtifacts) {
includedArtifactPattern = Pattern.compile(configuration.getIncludedArtifacts());
}
if (haveExcludedGroups) {
excludedGroupPattern = Pattern.compile(configuration.getExcludedGroups());
}
if (haveExcludedArtifacts) {
excludedArtifactPattern = Pattern.compile(configuration.getExcludedArtifacts());
}
Set depArtifacts;
if (configuration.isIncludeTransitiveDependencies()) {
// All project dependencies
depArtifacts = project.getArtifacts();
} else {
// Only direct project dependencies
depArtifacts = project.getDependencyArtifacts();
}
List includedScopes = configuration.getIncludedScopes();
List excludeScopes = configuration.getExcludedScopes();
boolean verbose = configuration.isVerbose();
SortedMap result = new TreeMap();
for (Object o : depArtifacts) {
Artifact artifact = (Artifact) o;
String scope = artifact.getScope();
if (CollectionUtils.isNotEmpty(includedScopes) && !includedScopes.contains(scope)) {
// not in included scopes
continue;
}
{
if (excludeScopes.contains(scope)) {
// in excluded scopes
continue;
}
}
Logger log = getLogger();
String id = MojoHelper.getArtifactId(artifact);
if (verbose) {
log.info("detected artifact " + id);
}
// Check if the project should be included
// If there is no specified artifacts and group to include, include all
boolean isToInclude = haveNoIncludedArtifacts && haveNoIncludedGroups
|| isIncludable(artifact, includedGroupPattern, includedArtifactPattern);
// Check if the project should be excluded
boolean isToExclude = isToInclude && haveExclusions
&& isExcludable(artifact, excludedGroupPattern, excludedArtifactPattern);
if (!isToInclude || isToExclude) {
if (verbose) {
log.info("skip artifact " + id);
}
continue;
}
MavenProject depMavenProject = null;
if (cache != null) {
// try to get project from cache
depMavenProject = cache.get(id);
}
if (depMavenProject != null) {
if (verbose) {
log.info("add dependency [" + id + "] (from cache)");
}
} else {
// build project
try {
depMavenProject = mavenProjectBuilder.buildFromRepository(artifact, remoteRepositories,
localRepository, true);
} catch (ProjectBuildingException e) {
log.warn("Unable to obtain POM for artifact : " + artifact, e);
continue;
}
if (verbose) {
log.info("add dependency [" + id + "]");
}
if (cache != null) {
// store it also in cache
cache.put(id, depMavenProject);
}
}
// keep the project
result.put(id, depMavenProject);
}
return result;
}
protected boolean isIncludable(Artifact project, Pattern includedGroupPattern, Pattern includedArtifactPattern) {
Logger log = getLogger();
// check if the groupId of the project should be included
if (includedGroupPattern != null) {
// we have some defined license filters
try {
Matcher matchGroupId = includedGroupPattern.matcher(project.getGroupId());
if (matchGroupId.find()) {
if (log.isDebugEnabled()) {
log.debug("Include " + project.getGroupId());
}
return true;
}
} catch (PatternSyntaxException e) {
log.warn(String.format(INVALID_PATTERN_MESSAGE, includedGroupPattern.pattern()));
}
}
// check if the artifactId of the project should be included
if (includedArtifactPattern != null) {
// we have some defined license filters
try {
Matcher matchGroupId = includedArtifactPattern.matcher(project.getArtifactId());
if (matchGroupId.find()) {
if (log.isDebugEnabled()) {
log.debug("Include " + project.getArtifactId());
}
return true;
}
} catch (PatternSyntaxException e) {
log.warn(String.format(INVALID_PATTERN_MESSAGE, includedArtifactPattern.pattern()));
}
}
return false;
}
protected boolean isExcludable(Artifact project, Pattern excludedGroupPattern, Pattern excludedArtifactPattern) {
Logger log = getLogger();
// check if the groupId of the project should be included
if (excludedGroupPattern != null) {
// we have some defined license filters
try {
Matcher matchGroupId = excludedGroupPattern.matcher(project.getGroupId());
if (matchGroupId.find()) {
if (log.isDebugEnabled()) {
log.debug("Exclude " + project.getGroupId());
}
return true;
}
} catch (PatternSyntaxException e) {
log.warn(String.format(INVALID_PATTERN_MESSAGE, excludedGroupPattern.pattern()));
}
}
// check if the artifactId of the project should be included
if (excludedArtifactPattern != null) {
// we have some defined license filters
try {
Matcher matchGroupId = excludedArtifactPattern.matcher(project.getArtifactId());
if (matchGroupId.find()) {
if (log.isDebugEnabled()) {
log.debug("Exclude " + project.getArtifactId());
}
return true;
}
} catch (PatternSyntaxException e) {
log.warn(String.format(INVALID_PATTERN_MESSAGE, excludedArtifactPattern.pattern()));
}
}
return false;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy