forked from mojohaus/license-maven-plugin
/
AbstractAddThirdPartyMojo.java
1194 lines (1058 loc) · 42 KB
/
AbstractAddThirdPartyMojo.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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package org.codehaus.mojo.license;
/*
* #%L
* License Maven Plugin
* %%
* Copyright (C) 2008 - 2011 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
* <http://www.gnu.org/licenses/lgpl-3.0.html>.
* #L%
*/
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.artifact.repository.ArtifactRepository;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.apache.maven.plugin.logging.Log;
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.ProjectBuildingException;
import org.codehaus.mojo.license.api.DefaultThirdPartyHelper;
import org.codehaus.mojo.license.api.DependenciesTool;
import org.codehaus.mojo.license.api.ThirdPartyHelper;
import org.codehaus.mojo.license.api.ThirdPartyTool;
import org.codehaus.mojo.license.api.ThirdPartyToolException;
import org.codehaus.mojo.license.model.LicenseMap;
import org.codehaus.mojo.license.utils.FileUtil;
import org.codehaus.mojo.license.utils.MojoHelper;
import org.codehaus.mojo.license.utils.SortedProperties;
import org.codehaus.mojo.license.utils.StringToList;
import org.codehaus.mojo.license.utils.UrlRequester;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
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 org.codehaus.mojo.license.api.DependenciesToolException;
import org.eclipse.aether.resolution.ArtifactResolutionException;
import org.eclipse.aether.transfer.ArtifactNotFoundException;
/**
* Abstract mojo for all third-party mojos.
*
* @author tchemit dev@tchemit.fr
* @since 1.0
*/
public abstract class AbstractAddThirdPartyMojo
extends AbstractLicenseMojo
{
// ----------------------------------------------------------------------
// Mojo Parameters
// ----------------------------------------------------------------------
/**
* Directory where to generate files.
*
* @since 1.0
*/
@Parameter( property = "license.outputDirectory",
defaultValue = "${project.build.directory}/generated-sources/license", required = true )
protected File outputDirectory;
/**
* Attach the 'missing' file as an additional artifact so that it is deployed in the deploy phase.
*
* @since 1.0
*/
@Parameter( property = "license.deployMissingFile", defaultValue = "true" )
protected boolean deployMissingFile;
/**
* Load files supplying information for missing third party licenses from repositories.
* The plugin looks for Maven artifacts with coordinates of the form G:A:V:properties:third-party, where
* the group, artifact, and version are those for dependencies of your project,
* while the type is 'properties' and the classifier is 'third-party'.
*
* @since 1.0
*/
@Parameter( property = "license.useRepositoryMissingFiles", defaultValue = "true" )
protected boolean useRepositoryMissingFiles;
/**
* If {@code true} the mojo will be executed for reactor projects having any packaging (including {@code pom});
* otherwise the mojo will be executed only for projects that do <b>not</b> have packaging {@code pom}.
* <p>
* Since 1.18, when {@code acceptPomPackaging} is {@code true}, {@code aggregate-add-third-party} mojo is executed
* also for the Maven session root project - i.e. the one out whose directory the mojo was executed.
* <b>
* Before 1.18, when {@code acceptPomPackaging} was {@code true}, {@code aggregate-add-third-party} mojo was
* iterating over all modules in the reactor but the Maven session root project was skipped.
*
* @since 1.1
*/
@Parameter( property = "license.acceptPomPackaging", defaultValue = "false" )
protected boolean acceptPomPackaging;
/**
* A comma separated list of scopes to exclude: e.g. {@code <excludedScopes>test,provided</excludedScopes>}
* or {@code -Dlicense.excludedScopes=test,provided}.
* <p>
* This filter is applied on the list of direct dependencies (and
* their transitive dependencies) of the projects in the reactor.
* <p>
* By default if an artifact is excluded its transitive dependencies
* are not automatically excluded. To enforce this behavior refer to
* {@link #excludeTransitiveDependencies}.
*
* @since 1.1
*/
@Parameter( property = "license.excludedScopes", defaultValue = "system" )
protected String excludedScopes;
/**
* A comma separated list of scopes to include: e.g. {@code <includedScopes>test,provided</includedScopes>}
* or {@code -Dlicense.includedScopes=test,provided}.
* <p>
* This filter is applied on the list of direct dependencies (and
* their transitive dependencies) of the projects in the reactor.
* <p>
* By default if an artifact is included also its transitive
* dependencies are included. To suppress this behavior refer to
* {@link #includeTransitiveDependencies}.
*
* @since 1.1
*/
@Parameter( property = "license.includedScopes" )
protected String includedScopes;
/**
* A comma separated list of types to exclude: e.g. {@code <excludedTypes>war,pom</excludedTypes>}
* or {@code -Dlicense.excludedTypes=was,pom}.
* <p>
* This filter is applied on the list of direct dependencies (and
* their transitive dependencies) of the projects in the reactor.
* <p>
* By default if an artifact is excluded its transitive dependencies
* are not automatically excluded. To enforce this behavior refer to
* {@link #excludeTransitiveDependencies}.
*
* @since 1.15
*/
@Parameter( property = "license.excludedTypes" )
protected String excludedTypes;
/**
* A comma separated list of types to include.
* <p>
* This filter is applied on the list of direct dependencies (and
* their transitive dependencies) of the projects in the reactor.
* <p>
* By default if an artifact is included also its transitive
* dependencies are included. To suppress this behavior refer to
* {@link #includeTransitiveDependencies}.
*
* @since 1.15
*/
@Parameter( property = "license.includedTypes" )
protected String includedTypes;
/**
* A regular expression (not glob pattern) used as filter to exclude
* artifacts that have matching groupId. Match could be also partial for
* example {@code ^org\.}
* <p>
* This filter is applied on the list of direct dependencies (and
* their transitive dependencies) of the projects in the reactor.
* <p>
* By default if an artifact is excluded its transitive dependencies
* are not automatically excluded. To enforce this behavior refer to
* {@link #excludeTransitiveDependencies}.
*
* @since 1.1
*/
@Parameter( property = "license.excludedGroups" )
protected String excludedGroups;
/**
* A regular expression (not glob pattern) used as filter to include
* only artifacts that have matching groupId.
* <p>
* This filter is applied on the list of direct dependencies (and
* their transitive dependencies) of the projects in the reactor.
* <p>
* By default if an artifact is included also its transitive
* dependencies are included. To suppress this behavior refer to
* {@link #includeTransitiveDependencies}.
*
* @since 1.1
*/ @Parameter( property = "license.includedGroups" )
protected String includedGroups;
/**
* A regular expression (not glob pattern) used as filter to exclude
* artifacts that have matching artifactId. Match could be also partial for
* example {@code ^org\.}
* <p>
* This filter is applied on the list of direct dependencies (and
* their transitive dependencies) of the projects in the reactor.
* <p>
* By default if an artifact is excluded its transitive dependencies
* are not automatically excluded. To enforce this behavior refer to
* {@link #excludeTransitiveDependencies}.
*
* @since 1.1
*/
@Parameter( property = "license.excludedArtifacts" )
protected String excludedArtifacts;
/**
* A regular expression (not glob pattern) used as filter to include
* only artifacts that have matching artifactId.
* <p>
* This filter is applied on the list of direct dependencies (and
* their transitive dependencies) of the projects in the reactor.
* <p>
* By default if an artifact is included also its transitive
* dependencies are included. To suppress this behavior refer to
* {@link #includeTransitiveDependencies}.
*
* @since 1.1
*/
@Parameter( property = "license.includedArtifacts" )
protected String includedArtifacts;
/**
* If {@code true} enforces including transitive dependencies of the
* projects in the reactor; otherwise only direct dependencies of the
* reactor projects are considered.
*
* @since 1.1
*/
@Parameter( property = "license.includeTransitiveDependencies", defaultValue = "true" )
boolean includeTransitiveDependencies;
/**
* If {@code true} enforces excluding transitive dependencies of the
* excluded artifacts in the reactor; otherwise only artifacts that match
* exclude filters are excluded.
*
* @since 1.13
*/
@Parameter( property = "license.excludeTransitiveDependencies", defaultValue = "false" )
boolean excludeTransitiveDependencies;
/**
* If {@code true} both optional and non-optional dependencies will be included in the list of artifacts for
* creating the license report; otherwise only non-optional dependencies will be considered.
*
* @since 1.19
*/
@Parameter( property = "license.includeOptional", defaultValue = "true" )
boolean includeOptional;
/**
* File where to write the third-party file.
*
* @since 1.0
*/
@Parameter( property = "license.thirdPartyFilename", defaultValue = "THIRD-PARTY.txt", required = true )
protected String thirdPartyFilename;
/**
* A flag to use the missing licenses file to consolidate the THID-PARTY file.
*
* @since 1.0
*/
@Parameter( property = "license.useMissingFile", defaultValue = "false" )
protected boolean useMissingFile;
/**
* The file to write with a license information template for dependencies with unknown license.
*
* @since 1.0
*/
@Parameter( property = "license.missingFile", defaultValue = "src/license/THIRD-PARTY.properties" )
protected File missingFile;
/**
* The Url that holds the missing license dependency entries. This is an extension to {@link #missingFile}.
* If set then the entries that will be found at this URL will be added additionally to the entries of the
* missing file.<br>
* <br>
* <b>NOTE:</b><br>
* the response of the URL endpoint must return content that matches the THIRD-PARTY.properties file!
*
* @since 1.15
*/
@Parameter( property = "license.missingFileUrl" )
protected String missingFileUrl;
/**
* To resolve third party licenses from an artifact.
*
* @since 1.14
*/
@Parameter( property = "license.missingLicensesFileArtifact" )
protected String missingLicensesFileArtifact;
/**
* A file containing the override license information for dependencies.
* <b>Note:</b> Specify either {@link #overrideUrl} (preferred) or {@link #overrideFile}.
* If none of these is specified, then {@value LicenseMojoUtils#DEFAULT_OVERRIDE_THIRD_PARTY} resolved against
* <code>${basedir}</code> will be used if it exists.
*
* @since 1.12
* @deprecated Use {@link #overrideUrl} instead
*/
@Deprecated
@Parameter( property = "license.overrideFile" )
private File overrideFile;
/**
* A URL pointing at a property file with the override license information for dependencies.
* <b>Note:</b> Specify either {@link #overrideUrl} (preferred) or {@link #overrideFile}.
* If none of these is specified, then {@value LicenseMojoUtils#DEFAULT_OVERRIDE_THIRD_PARTY} resolved against
* <code>${basedir}</code> will be used if it exists.
* <p>
* An example of the file content:
* <pre>
* org.jboss.xnio--xnio-api--3.3.6.Final=The Apache Software License, Version 2.0
* </pre>
*
* @since 1.17
*/
@Parameter( property = "license.overrideUrl" )
private String overrideUrl;
/**
* A URL prepared either our of {@link #overrideFile} or {@link #overrideUrl} or the default value.
*
* @see LicenseMojoUtils#prepareThirdPartyOverrideUrl(URL, File, String, File)
*/
protected String resolvedOverrideUrl;
/**
* To merge licenses in final file.
* <p>
* Each entry represents a merge (first license is main license to keep), licenses are separated by {@code |}.
* <p>
* Example :
* <p>
* <pre>
* <licenseMerges>
* <licenseMerge>The Apache Software License|Version 2.0,Apache License, Version 2.0</licenseMerge>
* </licenseMerges>
* </pre>
*
* <b>Note:</b> This option will be overridden by {@link #licenseMergesUrl} if it is used by command line.
* @since 1.0
*/
@Parameter
protected List<String> licenseMerges;
/**
* The file with the merge licenses in order to be used by command line.
* <b>Note:</b> This option overrides {@link #licenseMerges}.
*
* @since 1.15
* @deprecated prefer use now {@link #licenseMergesUrl}
*/
@Deprecated
@Parameter( property = "license.licenseMergesFile" )
protected String licenseMergesFile;
/**
* Location of file with the merge licenses in order to be used by command line.
* <b>Note:</b> This option overrides {@link #licenseMerges}.
*
* @since 1.17
*/
@Parameter( property = "license.licenseMergesUrl" )
protected String licenseMergesUrl;
/**
* To specify some licenses to include.
* <p>
* If this parameter is filled and a license is not in this {@code whitelist} then build will fail when
* property {@link #failOnBlacklist} is <tt>true</tt>.
* <p>
* Since version {@code 1.4}, there are three ways to fill this parameter :
* <ul>
* <li>A simple string (separated by {@code |}), the way to use by property configuration:
*
* <pre>
* <includedLicenses>licenseA|licenseB</includedLicenses>
* </pre>
*
* or
*
* <pre>
* -Dlicense.includedLicenses=licenseA|licenseB
* </pre>
*
* </li>
* <li>A list of string (can only be used in plugin configuration, not via property configuration)
*
* <pre>
* <includedLicenses>
* <includedLicense>licenseA</includedLicense>
* <includedLicenses>licenseB</includedLicense>
* </includedLicenses>
* </pre>
*
* </li>
* <li>Since version {@code 1.15}<br>
* a URL that contains a set of license names at the target source (only a single URL is accepted as
* parameter)
*
* <pre>
* <includedLicenses>http://my.license.host.com/my-whitelist</includedLicenses>
* </pre>
*
* the license-list on the given URL is expected to be list with a line-break after every entry e.g.:
* <ul style="list-style-type:none;">
* <li>The Apache Software License, Version 2.0</li>
* <li>Apache License, Version 2.0</li>
* <li>Bouncy Castle Licence</li>
* <li>MIT License</li>
* </ul>
* empty lines will be ignored.</li>
* </ul>
*
* @since 1.1
*/
@Parameter( property = "license.includedLicenses" )
protected IncludedLicenses includedLicenses;
/**
* To specify some licenses to exclude.
* <p>
* If a such license is found then build will fail when property {@link #failOnBlacklist} is <tt>true</tt>.
* <p>
* Since version {@code 1.4}, there are three ways to fill this parameter :
* <ul>
* <li>A simple string (separated by {@code |}), the way to use by property configuration:
*
* <pre>
* <excludedLicenses>licenseA|licenseB</excludedLicenses>
* </pre>
*
* or
*
* <pre>
* -Dlicense.excludedLicenses=licenseA|licenseB
* </pre>
*
* </li>
* <li>A list of string (can only be used in plugin configuration, not via property configuration)
*
* <pre>
* <excludedLicenses>
* <excludedLicense>licenseA</excludedLicense>
* <excludedLicense>licenseB</excludedLicense>
* </excludedLicenses>
* </pre>
*
* </li>
* <li>Since version {@code 1.15}<br>
* a URL that contains a set of license names at the target source (only a single URL is accepted as
* parameter)
*
* <pre>
* <includedLicenses>http://my.license.host.com/my-blacklist</includedLicenses>
* </pre>
*
* the license-list on the given URL is expected to be list with a line-break after every entry e.g.:
* <ul style="list-style-type:none;">
* <li>The Apache Software License, Version 2.0</li>
* <li>Apache License, Version 2.0</li>
* <li>Bouncy Castle Licence</li>
* <li>MIT License</li>
* </ul>
* empty lines will be ignored.</li>
* </ul>
*
* @since 1.1
*/
@Parameter( property = "license.excludedLicenses" )
protected ExcludedLicenses excludedLicenses;
/**
* The path of the bundled third party file to produce when
* {@link #generateBundle} is on.
* <p>
* <b>Note:</b> This option is not available for {@code pom} module types.
*
* @since 1.0
*/
@Parameter( property = "license.bundleThirdPartyPath",
defaultValue = "META-INF/${project.artifactId}-THIRD-PARTY.txt" )
protected String bundleThirdPartyPath;
/**
* A flag to copy a bundled version of the third-party file. This is useful
* to avoid for a final application collision name of third party file.
* <p>
* The file will be copied at the {@link #bundleThirdPartyPath} location.
*
* @since 1.0
*/
@Parameter( property = "license.generateBundle", defaultValue = "false" )
protected boolean generateBundle;
/**
* To force generation of the third-party file even if everything is up to date.
*
* @since 1.0
*/
@Parameter( property = "license.force", defaultValue = "false" )
protected boolean force;
/**
* A flag to fail the build if at least one dependency was detected without a license.
*
* @since 1.0
* @deprecated since 1.14, use now {@link #failOnMissing} or {@link #failOnBlacklist}.
*/
@Deprecated
@Parameter( property = "license.failIfWarning", defaultValue = "false" )
protected boolean failIfWarning;
/**
* A flag to fail the build if at least one dependency was detected without a license.
*
* @since 1.14
*/
@Parameter( property = "license.failOnMissing", defaultValue = "false" )
protected boolean failOnMissing;
/**
* A flag to fail the build if at least one dependency was blacklisted.
*
* @since 1.14
*/
@Parameter( property = "license.failOnBlacklist", defaultValue = "false" )
protected boolean failOnBlacklist;
/**
* A flag to sort artifact by name in the generated third-party file.
* <p>
* If not then artifacts are sorted by <pre>groupId:artifactId:version</pre>
*
* @since 1.6
*/
@Parameter( property = "license.sortArtifactByName", defaultValue = "false" )
protected boolean sortArtifactByName;
/**
* Template used to build the third-party file.
* <p>
* (This template uses freemarker).
* <p>
* <b>Note:</b> This property can either point to a file or a resource on
* the classpath. In case it points to a file and this plugin is used within
* a sub-module as part of a multi-module build, you need to make this path
* resolvable, e.g. by prepending {@code basedir}.
*
* @since 1.1
*/
@Parameter( property = "license.fileTemplate", defaultValue = "/org/codehaus/mojo/license/third-party-file.ftl" )
protected String fileTemplate;
/**
* Local Repository.
*
* @since 1.0.0
*/
@Parameter( property = "localRepository", required = true, readonly = true )
protected ArtifactRepository localRepository;
/**
* The set of dependencies for the current project, used to locate license databases.
*/
@Parameter( property = "project.artifacts", required = true, readonly = true )
protected Set<Artifact> dependencies;
// ----------------------------------------------------------------------
// Plexus components
// ----------------------------------------------------------------------
/**
* Third party tool (much of the logic of these mojos is implemented here).
*
* @since 1.0
*/
@Component
private ThirdPartyTool thirdPartyTool;
/**
* Dependencies tool. (pluggable component to find dependencies that match up with
* criteria).
*
* @since 1.1
*/
@Component
protected DependenciesTool dependenciesTool;
// ----------------------------------------------------------------------
// Private fields
// ----------------------------------------------------------------------
/**
* Third-party helper (high level tool with common code for mojo and report).
*/
private ThirdPartyHelper helper;
protected SortedMap<String, MavenProject> projectDependencies;
protected LicenseMap licenseMap;
protected SortedSet<MavenProject> unsafeDependencies;
private File thirdPartyFile;
protected SortedProperties unsafeMappings;
/**
* Flag computed in the {@link #init()} method to know if there is something has to be generated.
*/
protected boolean doGenerate;
/**
* Flag computed in the {@link #init()} method to know if a bundle version has to be generated.
*/
protected boolean doGenerateBundle;
/**
* Map from G/A/V as string to license key, obtained from global dependencies of type=.ld.properties.
* This could probably be refactored to have more in common with the classifier-based loader.
*
* @since 1.4
*/
private Map<String, String> globalKnownLicenses;
/**
* A URL returning a plain text file that contains include/exclude artifact filters in the following format:
* <pre>
* {@code
* # this is a comment
* include gaPattern org\.my-org:my-artifact
* include gaPattern org\.other-org:other-artifact
* exclude gaPattern org\.yet-anther-org:.*
* include scope compile
* include scope test
* exclude scope system
* include type jar
* exclude type war
* }</pre>
*
* @since 1.18
*/
@Parameter( property = "license.artifactFiltersUrl" )
protected String artifactFiltersUrl;
// ----------------------------------------------------------------------
// Abstract Methods
// ----------------------------------------------------------------------
/**
* Loads the dependencies of the project (as {@link MavenProject}, indexed by their gav.
*
* @return the map of dependencies of the maven project indexed by their gav.
* @throws DependenciesToolException if the dependencies could not be loaded
*/
protected abstract SortedMap<String, MavenProject> loadDependencies() throws DependenciesToolException;
/**
* Creates the unsafe mapping (says dependencies with no license given by their pom).
* <p>
* Can come from loaded missing file or from dependencies with no license at all.
*
* @return the map of usafe mapping indexed by their gav.
* @throws ProjectBuildingException if could not create maven project for some dependencies
* @throws IOException if could not load missing file
* @throws ThirdPartyToolException for third party tool error
* @throws DependenciesToolException if the dependencies could not be loaded
*/
protected abstract SortedProperties createUnsafeMapping()
throws ProjectBuildingException, IOException, ThirdPartyToolException,
MojoExecutionException, DependenciesToolException;
// ----------------------------------------------------------------------
// AbstractLicenseMojo Implementaton
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
@Override
protected void init()
throws Exception
{
Log log = getLog();
if ( log.isDebugEnabled() )
{
// always be verbose in debug mode
setVerbose( true );
}
thirdPartyFile = new File( outputDirectory, thirdPartyFilename );
long buildTimestamp = getBuildTimestamp();
if ( isVerbose() || getLog().isDebugEnabled() )
{
log.debug( "Build start at : " + buildTimestamp );
log.debug( "third-party file : " + thirdPartyFile.lastModified() );
}
doGenerate = force || !thirdPartyFile.exists() || buildTimestamp > thirdPartyFile.lastModified();
if ( generateBundle )
{
File bundleFile = FileUtil.getFile( outputDirectory, bundleThirdPartyPath );
if ( isVerbose() || getLog().isDebugEnabled() )
{
log.debug( "bundle third-party file : " + bundleFile.lastModified() );
}
doGenerateBundle = force || !bundleFile.exists() || buildTimestamp > bundleFile.lastModified();
}
else
{
// not generating bundled file
doGenerateBundle = false;
}
projectDependencies = loadDependencies();
licenseMap = getHelper().createLicenseMap( projectDependencies );
if ( licenseMergesFile != null )
{
if ( licenseMergesUrl != null )
{
throw new MojoExecutionException( "You can't use both licenseMergesFile and licenseMergesUrl" );
}
getLog().warn( "" );
getLog().warn( "!!! licenseMergesFile is deprecated, use now licenseMergesUrl !!!" );
getLog().warn( "" );
getLog().warn( "licenseMerges will be overridden by licenseMergesFile." );
getLog().warn( "" );
licenseMerges = FileUtils.readLines( new File( licenseMergesFile ), "utf-8" );
}
else if ( licenseMergesUrl != null )
{
getLog().warn( "" );
getLog().warn( "licenseMerges will be overridden by licenseMergesUrl." );
getLog().warn( "" );
if ( UrlRequester.isStringUrl( licenseMergesUrl ) )
{
licenseMerges = Arrays.asList( UrlRequester.getFromUrl( licenseMergesUrl ).split( "[\n\r]+" ) );
}
}
resolvedOverrideUrl = LicenseMojoUtils.prepareThirdPartyOverrideUrl( resolvedOverrideUrl, overrideFile,
overrideUrl, project.getBasedir(), getLog() );
}
void consolidate() throws IOException, ArtifactNotFoundException, ArtifactResolutionException, MojoFailureException,
ProjectBuildingException, ThirdPartyToolException,
MojoExecutionException, DependenciesToolException
{
unsafeDependencies = getHelper().getProjectsWithNoLicense( licenseMap );
if ( !CollectionUtils.isEmpty( unsafeDependencies ) )
{
if ( useMissingFile && doGenerate )
{
// load unsafeMapping from local file and/or third-party classified items.
unsafeMappings = createUnsafeMapping();
}
}
getHelper().mergeLicenses( licenseMerges, licenseMap );
if ( CollectionUtils.isNotEmpty( unsafeDependencies ) )
{
resolveUnsafeDependenciesFromFile( missingFile );
}
if ( !StringUtils.isBlank( missingLicensesFileArtifact ) && CollectionUtils.isNotEmpty( unsafeDependencies ) )
{
String[] tokens = StringUtils.split( missingLicensesFileArtifact, ":" );
if ( tokens.length != 3 )
{
throw new MojoFailureException(
"Invalid missing licenses artifact, you must specify groupId:artifactId:version "
+ missingLicensesFileArtifact );
}
String groupId = tokens[0];
String artifactId = tokens[1];
String version = tokens[2];
resolveUnsafeDependenciesFromArtifact( groupId, artifactId, version );
}
overrideLicenses();
}
/**
* @return list of license to exclude.
*/
private List<String> getExcludedLicenses()
{
return excludedLicenses.getData();
}
/**
* @return list of license to include.
*/
private List<String> getIncludedLicenses()
{
return includedLicenses.getData();
}
/**
* Fill the {@link #includedLicenses} parameter from a simple string to split.
*
* @param includedLicenses license to excludes separated by a {@code |}.
*/
public void setIncludedLicenses( String includedLicenses ) throws MojoExecutionException
{
this.includedLicenses = new IncludedLicenses( includedLicenses );
}
/**
* Fill the {@link #excludedLicenses} parameter from a simple string to split.
*
* @param excludedLicenses license to excludes separated by a {@code |}.
*/
public void setExcludedLicenses( String excludedLicenses ) throws MojoExecutionException
{
this.excludedLicenses = new ExcludedLicenses( excludedLicenses );
}
// ----------------------------------------------------------------------
// Protected Methods
// ----------------------------------------------------------------------
protected ThirdPartyHelper getHelper()
{
if ( helper == null )
{
helper = new DefaultThirdPartyHelper( getProject(), getEncoding(), isVerbose(), dependenciesTool,
thirdPartyTool, getProject().getRemoteArtifactRepositories(),
getProject().getRemoteProjectRepositories(), getLog() );
}
return helper;
}
void resolveUnsafeDependenciesFromArtifact( String groupId, String artifactId, String version )
throws ArtifactNotFoundException, IOException, ArtifactResolutionException, MojoExecutionException
{
File missingLicensesFromArtifact = thirdPartyTool.resolveMissingLicensesDescriptor( groupId, artifactId,
version, getProject().getRemoteProjectRepositories() );
resolveUnsafeDependenciesFromFile( missingLicensesFromArtifact );
}
void resolveUnsafeDependenciesFromFile( File missingLicenses ) throws IOException, MojoExecutionException
{
if ( missingLicenses == null )
{
return;
}
// there are missing licenses available from the artifact
SortedProperties unsafeMappings = new SortedProperties( getEncoding() );
if ( missingLicenses.exists() && missingLicenses.length() > 0 )
{
// load the missing file
unsafeMappings.load( missingLicenses );
}
if ( useMissingFile && UrlRequester.isStringUrl( missingFileUrl ) )
{
String httpRequestResult = UrlRequester.getFromUrl( missingFileUrl );
unsafeMappings.load( new ByteArrayInputStream( httpRequestResult.getBytes() ) );
}
if ( !unsafeMappings.isEmpty() )
{
Set<MavenProject> resolvedDependencies = new HashSet<>();
for ( MavenProject unsafeDependency : unsafeDependencies )
{
String id = MojoHelper.getArtifactId( unsafeDependency.getArtifact() );
if ( unsafeMappings.containsKey( id ) && StringUtils.isNotBlank( unsafeMappings.getProperty( id ) ) )
{
// update license map
thirdPartyTool.addLicense( licenseMap, unsafeDependency, unsafeMappings.getProperty( id ) );
// remove
resolvedDependencies.add( unsafeDependency );
}
}
// remove resolvedDependencies from unsafeDeps;
unsafeDependencies.removeAll( resolvedDependencies );
}
}
void checkUnsafeDependencies()
{
if ( CollectionUtils.isNotEmpty( unsafeDependencies ) )
{
Log log = getLog();
if ( log.isWarnEnabled() )
{
boolean plural = unsafeDependencies.size() > 1;
String message = String.format( "There %s %d %s with no license :",
plural ? "are" : "is",
unsafeDependencies.size(),
plural ? "dependencies" : "dependency" );
log.warn( message );
for ( MavenProject dep : unsafeDependencies )
{
// no license found for the dependency
log.warn( " - " + MojoHelper.getArtifactId( dep.getArtifact() ) );
}
}
}
}
boolean checkForbiddenLicenses()
{
List<String> whiteLicenses = getIncludedLicenses();
List<String> blackLicenses = getExcludedLicenses();
Set<String> unsafeLicenses = new HashSet<>();
if ( CollectionUtils.isNotEmpty( blackLicenses ) )
{
Set<String> licenses = licenseMap.keySet();
getLog().info( "Excluded licenses (blacklist): " + blackLicenses );
for ( String excludeLicense : blackLicenses )
{
if ( licenses.contains( excludeLicense )
&& CollectionUtils.isNotEmpty( licenseMap.get( excludeLicense ) ) )
{
//bad license found
unsafeLicenses.add( excludeLicense );
}
}
}
if ( CollectionUtils.isNotEmpty( whiteLicenses ) )
{
Set<String> dependencyLicenses = licenseMap.keySet();
getLog().info( "Included licenses (whitelist): " + whiteLicenses );
for ( String dependencyLicense : dependencyLicenses )
{
getLog().debug( "Testing license '" + dependencyLicense + "'" );
if ( !whiteLicenses.contains( dependencyLicense )
&& CollectionUtils.isNotEmpty( licenseMap.get( dependencyLicense ) ) )
{
getLog().debug( "Testing dependency license '" + dependencyLicense
+ "' against all other licenses" );
for ( MavenProject dependency : licenseMap.get( dependencyLicense ) )
{
getLog().debug( " testing dependency " + dependency );
boolean forbiddenLicenseUsed = true;
for ( String otherLicense : dependencyLicenses )
{
// skip this license if it is the same as the dependency license
// skip this license if it has no projects assigned