forked from mojohaus/license-maven-plugin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
LicensesXmlInsertVersionsMojo.java
179 lines (157 loc) · 6.43 KB
/
LicensesXmlInsertVersionsMojo.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
package org.codehaus.mojo.license;
/*
* #%L
* License Maven Plugin
* %%
* Copyright (C) 2019 MojoHaus
* %%
* 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
* <http://www.gnu.org/licenses/lgpl-3.0.html>.
* #L%
*/
import java.io.File;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.codehaus.mojo.license.api.ArtifactFilters;
import org.codehaus.mojo.license.api.MavenProjectDependenciesConfigurator;
import org.codehaus.mojo.license.api.ResolvedProjectDependencies;
import org.codehaus.mojo.license.download.LicenseSummaryReader;
import org.codehaus.mojo.license.download.LicensedArtifact;
import org.codehaus.mojo.license.download.ProjectLicenseInfo;
import org.codehaus.mojo.license.utils.FileUtil;
/**
* Insert versions into a {@code licenses.xml} file that might have been generated by a {@code *download-licenses} mojo
* with {@code writeVersions} set to {@code false}.
*
* @since 1.19
*/
@Mojo( name = "licenses-xml-insert-versions", requiresDependencyResolution = ResolutionScope.TEST,
defaultPhase = LifecyclePhase.PACKAGE )
public class LicensesXmlInsertVersionsMojo
extends AbstractLicensesXmlMojo
{
/**
* The file whose XML content will be used as a base for adding versions. Defaults to
* {@link AbstractLicensesXmlMojo#licensesOutputFile}
*
* @since 1.19
*/
@Parameter( property = "license.licensesInputFile" )
protected File licensesInputFile;
/**
* A flag to skip the goal.
*
* @since 1.19
*/
@Parameter( property = "license.skipDownloadLicenses", defaultValue = "false" )
private boolean skipDownloadLicenses;
@SuppressWarnings( "unchecked" )
public void execute()
throws MojoExecutionException, MojoFailureException
{
if ( skipDownloadLicenses )
{
getLog().info( "Skipping due to skipDownloadLicenses = true" );
return;
}
if ( licensesInputFile == null )
{
licensesInputFile = licensesOutputFile;
}
try
{
FileUtil.createDirectoryIfNecessary( licensesOutputFile.getParentFile() );
final List<ProjectLicenseInfo> projectLicenseInfos =
LicenseSummaryReader.parseLicenseSummary( licensesInputFile );
if ( projectLicenseInfos.isEmpty() && licensesInputFile.equals( licensesOutputFile ) )
{
getLog().info( "Nothing to do. The licensesInputFile \"" + licensesInputFile
+ "\" is either empty or does not exist." );
return;
}
final ArtifactFilters.Builder artifactFiltersBuilder = ArtifactFilters.buidler();
for ( ProjectLicenseInfo dep : projectLicenseInfos )
{
artifactFiltersBuilder.includeGa( "\\Q" + dep.getGroupId() + ":" + dep.getArtifactId() + "\\E" );
}
final ArtifactFilters artifactFilters = artifactFiltersBuilder.build();
final MavenProjectDependenciesConfigurator config = new MavenProjectDependenciesConfigurator()
{
@Override
public boolean isVerbose()
{
return getLog().isDebugEnabled();
}
@Override
public boolean isIncludeTransitiveDependencies()
{
return true;
}
@Override
public boolean isExcludeTransitiveDependencies()
{
return false;
}
@Override
public ArtifactFilters getArtifactFilters()
{
return artifactFilters;
}
};
final Map<String, LicensedArtifact> resolvedDeps = new TreeMap<String, LicensedArtifact>();
licensedArtifactResolver.loadProjectDependencies(
new ResolvedProjectDependencies( project.getArtifacts(), project.getDependencyArtifacts() ),
config, remoteRepositories, resolvedDeps );
final Map<String, LicensedArtifact> resolvedDepsMap = new HashMap<>( resolvedDeps.size() );
for ( LicensedArtifact dep : resolvedDeps.values() )
{
resolvedDepsMap.put( dep.getGroupId() + ":" + dep.getArtifactId(), dep );
}
for ( ProjectLicenseInfo dependencyLicenseInfo : projectLicenseInfos )
{
getLog().debug( "Checking licenses for project " + dependencyLicenseInfo.toString() );
final String id = dependencyLicenseInfo.getId();
final LicensedArtifact dependency = resolvedDepsMap.get( id );
if ( dependency == null )
{
throw new MojoFailureException( "Could not resolve version of " + id + " in file "
+ licensesOutputFile );
}
dependencyLicenseInfo.setVersion( dependency.getVersion() );
}
writeLicenseSummary( projectLicenseInfos, licensesOutputFile, true );
}
catch ( MojoFailureException e )
{
throw e;
}
catch ( Exception e )
{
throw new MojoExecutionException( "Unable to write license summary file: " + licensesOutputFile, e );
}
}
protected Path[] getAutodetectEolFiles()
{
return new Path[] { licensesInputFile.toPath(), licensesOutputFile.toPath() };
}
}