-
-
Notifications
You must be signed in to change notification settings - Fork 302
/
Builder.java
2050 lines (1762 loc) · 58.9 KB
/
Builder.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 aQute.bnd.osgi;
import static aQute.bnd.exceptions.FunctionWithException.asFunction;
import static java.util.stream.Collectors.toList;
import java.io.File;
import java.io.FileFilter;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Function;
import java.util.jar.Manifest;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Stream;
import java.util.zip.ZipException;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import aQute.bnd.cdi.CDIAnnotations;
import aQute.bnd.component.DSAnnotations;
import aQute.bnd.differ.DiffPluginImpl;
import aQute.bnd.header.Attrs;
import aQute.bnd.header.OSGiHeader;
import aQute.bnd.header.Parameters;
import aQute.bnd.help.instructions.BuilderInstructions;
import aQute.bnd.make.Make;
import aQute.bnd.make.MakeBnd;
import aQute.bnd.make.MakeCopy;
import aQute.bnd.make.component.ServiceComponent;
import aQute.bnd.maven.PomPropertiesResource;
import aQute.bnd.maven.PomResource;
import aQute.bnd.metatype.MetatypeAnnotations;
import aQute.bnd.osgi.Descriptors.PackageRef;
import aQute.bnd.osgi.Descriptors.TypeRef;
import aQute.bnd.plugin.jpms.JPMSAnnotations;
import aQute.bnd.plugin.jpms.JPMSModuleInfoPlugin;
import aQute.bnd.plugin.spi.SPIDescriptorGenerator;
import aQute.bnd.service.SignerPlugin;
import aQute.bnd.service.diff.Delta;
import aQute.bnd.service.diff.Diff;
import aQute.bnd.service.diff.Tree;
import aQute.bnd.service.diff.Type;
import aQute.bnd.service.specifications.BuilderSpecification;
import aQute.bnd.stream.MapStream;
import aQute.bnd.version.Version;
import aQute.lib.collections.Logic;
import aQute.lib.collections.MultiMap;
import aQute.lib.hex.Hex;
import aQute.lib.io.IO;
import aQute.lib.regex.PatternConstants;
import aQute.lib.strings.Strings;
import aQute.lib.zip.ZipUtil;
import aQute.libg.generics.Create;
/**
* Include-Resource: ( [name '=' ] file )+ Private-Package: package-decl ( ','
* package-decl )* Export-Package: package-decl ( ',' package-decl )*
* Import-Package: package-decl ( ',' package-decl )* @version $Revision: 1.27 $
*/
public class Builder extends Analyzer {
private final static Logger logger = LoggerFactory.getLogger(Builder.class);
private final static Pattern IR_PATTERN = Pattern
.compile("[{]?-?@?(?:[^=]+=)?\\s*([^}!]+).*");
private final DiffPluginImpl differ = new DiffPluginImpl();
private Pattern xdoNotCopy = null;
private static final int SPLIT_MERGE_LAST = 1;
private static final int SPLIT_MERGE_FIRST = 2;
private static final int SPLIT_ERROR = 3;
private static final int SPLIT_FIRST = 4;
private static final int SPLIT_DEFAULT = 0;
private final List<File> sourcePath = new ArrayList<>();
private final Make make = new Make(this);
private Instructions defaultPreProcessMatcher = null;
private BuilderInstructions buildInstrs = getInstructions(BuilderInstructions.class);
private final Map<Integer, String> cachedSystemCalls;
public Builder(Processor parent) {
super(parent);
cachedSystemCalls = new ConcurrentHashMap<>();
}
public Builder(Builder parent) {
super(parent);
cachedSystemCalls = parent.cachedSystemCalls;
}
public Builder() {
cachedSystemCalls = new ConcurrentHashMap<>();
}
public Jar build() throws Exception {
logger.debug("build");
init();
if (isTrue(getProperty(NOBUNDLES)))
return null;
if (getProperty(CONDUIT) != null)
error("Specified " + CONDUIT + " but calls build() instead of builds() (might be a programmer error");
Jar dot = getBuildJar();
doExpand(dot);
doIncludeResources(dot);
doWab(dot);
// Check if we override the calculation of the
// manifest. We still need to calculated it because
// we need to have analyzed the classpath.
Manifest manifest = calcManifest();
String mf = getProperty(MANIFEST);
if (mf != null) {
File mff = getFile(mf);
if (mff.isFile()) {
updateModified(mff.lastModified(), "Manifest " + mff);
try (InputStream in = IO.stream(mff)) {
manifest = new Manifest(in);
} catch (Exception e) {
exception(e, "%s: exception while reading manifest file", MANIFEST);
}
} else {
error("%s: no such file %s", MANIFEST, mf);
}
}
if (!isTrue(getProperty(NOMANIFEST))) {
dot.setManifest(manifest);
String manifestName = getProperty(MANIFEST_NAME);
if (manifestName != null)
dot.setManifestName(manifestName);
} else {
dot.setDoNotTouchManifest();
}
// This must happen after we analyzed so
// we know what it is on the classpath
addSources(dot);
doPom(dot);
if (!isNoBundle())
doVerify(dot);
Map<String, Resource> resources = dot.getResources();
if (resources.isEmpty() || ((resources.size() == 1) && resources.get("module-info.class") != null))
warning(
"The JAR is empty: The instructions for the JAR named %s did not cause any content to be included, this is likely wrong",
getBsn());
dot.updateModified(lastModified(), "Last Modified Processor");
dot.setName(getBsn());
doDigests(dot);
sign(dot);
doSaveManifest(dot);
doDiff(dot); // check if need to diff this bundle
doBaseline(dot); // check for a baseline
String expand = getProperty("-expand");
if (expand != null) {
File out = getFile(expand);
IO.mkdirs(out);
dot.expand(out);
}
return dot;
}
private Jar getBuildJar() {
Jar dot = getJar();
if (dot == null) {
dot = new Jar("dot");
setJar(dot);
}
buildInstrs.compression()
.ifPresent(dot::setCompression);
dot.setReproducible(getProperty(REPRODUCIBLE));
try {
long modified = Long.parseLong(getProperty("base.modified"));
dot.updateModified(modified, "Base modified");
} catch (Exception e) {
// Ignore
}
return dot;
}
void doPom(Jar dot) throws Exception, IOException {
try (Processor scoped = new Processor(this)) {
String bsn = getBsn();
if (bsn != null)
scoped.setProperty("@bsn", bsn);
String version = getBundleVersion();
if (version != null)
scoped.setProperty("@version", version);
String pom = scoped.getProperty(POM);
if (isTrue(pom)) {
dot.removeSubDirs("META-INF/maven/");
scoped.addProperties(OSGiHeader.parseProperties(pom));
PomResource pomXml = new PomResource(scoped, dot.getManifest());
String v = pomXml.validate();
if (v != null) {
error("Invalid pom for %s: %s", getBundleSymbolicName(), v);
}
PomPropertiesResource pomProperties = new PomPropertiesResource(pomXml);
dot.putResource(pomXml.getWhere(), pomXml);
if (!pomProperties.getWhere()
.equals(pomXml.getWhere())) {
dot.putResource(pomProperties.getWhere(), pomProperties);
}
}
}
}
/**
* Check if we need to calculate any checksums.
*
* @param dot
* @throws Exception
*/
private void doDigests(Jar dot) throws Exception {
Parameters ps = OSGiHeader.parseHeader(getProperty(DIGESTS));
if (ps.isEmpty())
return;
logger.debug("digests {}", ps);
String[] digests = ps.keySet()
.toArray(new String[0]);
dot.setDigestAlgorithms(digests);
}
/**
* Allow any local initialization by subclasses before we build.
*/
public void init() throws Exception {
begin();
doRequireBnd();
// Check if we have sensible setup
if (getClasspath().isEmpty() && (getProperty(EXPORT_PACKAGE) != null || getProperty(PRIVATE_PACKAGE) != null
|| getProperty(PRIVATEPACKAGE) != null))
warning("Classpath is empty. " + Constants.PRIVATE_PACKAGE + ", " + Constants.PRIVATEPACKAGE + ", and "
+ EXPORT_PACKAGE + " can only expand from the classpath when there is one");
}
/**
* Turn this normal bundle in a web and add any resources.
*
* @throws Exception
*/
private Jar doWab(Jar dot) throws Exception {
String wab = getProperty(WAB);
String wablib = getProperty(WABLIB);
if (wab == null && wablib == null)
return dot;
logger.debug("wab {} {}", wab, wablib);
setBundleClasspath(append("WEB-INF/classes", getProperty(BUNDLE_CLASSPATH)));
dot.getResources()
.keySet()
.stream()
.filter(path -> !pathStartsWith(path, "WEB-INF") && Constants.METAPACKAGES.stream()
.noneMatch(meta -> pathStartsWith(path, meta)))
// we collect since we need to mutate the source set
.collect(toList())
.forEach(path -> {
logger.debug("wab: moving: {}", path);
dot.rename(path, "WEB-INF/classes/" + path);
});
Parameters clauses = parseHeader(getProperty(WABLIB));
for (Map.Entry<String, Attrs> entry : clauses.entrySet()) {
File f = getFile(entry.getKey());
addWabLib(dot, f, entry.getKey(), entry.getValue());
}
doIncludeResource(dot, wab);
return dot;
}
private static boolean pathStartsWith(String path, String prefix) {
return path.startsWith(prefix) && ((path.length() == prefix.length()) || (path.charAt(prefix.length()) == '/'));
}
/**
* Add a wab lib to the jar.
*
* @param f
*/
private void addWabLib(Jar dot, File f, String name, Map<String, String> attrs) throws Exception {
if (f.exists()) {
Jar jar = new Jar(f);
jar.setDoNotTouchManifest();
buildInstrs.compression()
.ifPresent(jar::setCompression);
addClose(jar);
String path = "WEB-INF/lib/" + f.getName();
dot.putResource(path, new JarResource(jar));
setProperty(BUNDLE_CLASSPATH, append(getProperty(BUNDLE_CLASSPATH), path));
Manifest m = jar.getManifest();
if (m != null) {
String cp = m.getMainAttributes()
.getValue("Class-Path");
if (cp != null) {
Collection<String> parts = split(cp);
for (String part : parts) {
File sub = getFile(f.getParentFile(), part);
if (!sub.exists() || !sub.getParentFile()
.equals(f.getParentFile())) {
warning("Invalid Class-Path entry %s in %s, must exist and must reside in same directory",
sub, f);
} else {
addWabLib(dot, sub, part, Collections.emptyMap());
}
}
}
}
} else {
doIncludeResource(dot, name, attrs);
}
}
/**
* Get the manifest and write it out separately if -savemanifest is set
*
* @param dot
*/
private void doSaveManifest(Jar dot) throws Exception {
String output = getProperty(SAVEMANIFEST);
if (output == null)
return;
File f = getFile(output);
if (f.isDirectory()) {
f = new File(f, "MANIFEST.MF");
}
if (!f.exists() || f.lastModified() < dot.lastModified()) {
IO.delete(f);
File fp = f.getParentFile();
IO.mkdirs(fp);
try (OutputStream out = IO.outputStream(f)) {
Jar.writeManifest(dot.getManifest(), out);
}
changedFile(f);
}
}
protected void changedFile(@SuppressWarnings("unused") File f) {}
/**
* Sign the jar file. -sign : <alias> [ ';' 'password:=' <password> ] [ ';'
* 'keystore:=' <keystore> ] [ ';' 'sign-password:=' <pw> ] ( ',' ... )*
*/
void sign(@SuppressWarnings("unused") Jar jar) throws Exception {
String signing = getProperty(SIGN);
if (signing == null)
return;
logger.debug("Signing {}, with {}", getBsn(), signing);
List<SignerPlugin> signers = getPlugins(SignerPlugin.class);
Parameters infos = parseHeader(signing);
for (String alias : infos.keySet()) {
for (SignerPlugin signer : signers) {
signer.sign(this, alias);
}
}
}
public boolean hasSources() {
return isTrue(getProperty(SOURCES));
}
/**
* Answer extra packages. In this case we implement conditional package. Any
*/
@Override
protected Jar getExtra() throws Exception {
Parameters conditionals = getMergedParameters(CONDITIONAL_PACKAGE);
// TODO change the decorated call to remove the second arg.
conditionals.putAll(decorated(CONDITIONALPACKAGE, true));
if (conditionals.isEmpty())
return null;
logger.debug("do Conditional Package {}", conditionals);
Instructions instructions = new Instructions(conditionals);
Collection<PackageRef> referred = instructions.select(getReferred().keySet(), false);
referred.removeAll(getContained().keySet());
if (referred.isEmpty()) {
logger.debug("no additional conditional packages to add");
return null;
}
Jar jar = new Jar(CONDITIONALPACKAGE);
addClose(jar);
for (PackageRef pref : referred) {
for (Jar cpe : getClasspath()) {
Map<String, Resource> map = cpe.getDirectory(pref.getPath());
if (map != null) {
copy(jar, cpe, pref.getPath(), false);
break;
}
}
}
if (jar.getDirectories()
.isEmpty()) {
logger.debug("extra dirs {}", jar.getDirectories());
return null;
}
return jar;
}
/**
* Intercept the call to analyze and cleanup versions after we have analyzed
* the setup. We do not want to cleanup if we are going to verify.
*/
@Override
public void analyze() throws Exception {
super.analyze();
cleanupVersion(getImports(), null, Constants.IMPORT_PACKAGE);
cleanupVersion(getExports(), getVersion(), Constants.EXPORT_PACKAGE);
String version = getProperty(BUNDLE_VERSION);
if (version != null) {
version = cleanupVersion(version);
version = doSnapshot(version);
setProperty(BUNDLE_VERSION, version);
}
}
private String doSnapshot(String version) {
String snapshot = getProperty(SNAPSHOT);
if (snapshot == null) {
return version;
}
if (snapshot.isEmpty()) {
snapshot = null;
}
Version v = Version.parseVersion(version);
String q = v.getQualifier();
if (q == null) {
return version;
}
if (q.equals("SNAPSHOT")) {
q = snapshot;
} else if (q.endsWith("-SNAPSHOT")) {
int end = q.length() - "SNAPSHOT".length();
if (snapshot == null) {
q = q.substring(0, end - 1);
} else {
q = q.substring(0, end) + snapshot;
}
} else {
return version;
}
return new Version(v.getMajor(), v.getMinor(), v.getMicro(), q).toString();
}
public void cleanupVersion(Packages packages, String defaultVersion) {
cleanupVersion(packages, defaultVersion, "external");
}
public void cleanupVersion(Packages packages, String defaultVersion, String what) {
if (defaultVersion != null) {
Matcher m = Verifier.VERSION.matcher(defaultVersion);
if (m.matches()) {
// Strip qualifier from default package version
defaultVersion = Version.parseVersion(defaultVersion)
.toStringWithoutQualifier();
}
}
Set<String> visited = new HashSet<>();
for (Map.Entry<PackageRef, Attrs> entry : packages.entrySet()) {
String packageName = Processor.removeDuplicateMarker(entry.getKey().fqn);
Attrs attributes = entry.getValue();
String v = attributes.get(Constants.VERSION_ATTRIBUTE);
if (v == null && defaultVersion != null) {
if (visited.contains(packageName)) {
SetLocation warning = warning(
"%s duplicate package name (%s) that uses the default version because no version is specified (%s). Remove duplicate package or add an explicit version to it.",
what, packageName, defaultVersion);
try {
getHeader(Constants.EXPORT_PACKAGE, entry.getKey().fqn);
} catch (Exception e) {
// not so important
}
}
if (!isTrue(getProperty(Constants.NODEFAULTVERSION))) {
v = defaultVersion;
if (isPedantic())
warning("Used bundle version %s for exported package %s", v, entry.getKey());
} else {
if (isPedantic())
warning("No export version for exported package %s", entry.getKey());
}
}
if (v != null)
attributes.put(Constants.VERSION_ATTRIBUTE, cleanupVersion(v));
visited.add(packageName);
}
}
private static final String[] fixed = {
"packageinfo", "package.html", "module-info.java", "package-info.java"
};
/**
* @throws IOException
*/
private void addSources(Jar dot) throws Exception {
if (!hasSources())
return;
Set<PackageRef> packages = Create.set();
for (TypeRef typeRef : getClassspace().keySet()) {
PackageRef packageRef = typeRef.getPackageRef();
String sourcePath = typeRef.getSourcePath();
String packagePath = packageRef.getPath();
for (File root : getSourcePath()) {
File f = getFile(root, sourcePath);
if (f.exists()) {
if (!packages.contains(packageRef)) {
packages.add(packageRef);
for (String element : fixed) {
for (File sp : getSourcePath()) {
File bdir = getFile(sp, packagePath);
File ff = getFile(bdir, element);
if (ff.isFile()) {
String name = "OSGI-OPT/src/" + packagePath + "/" + element;
dot.putResource(name, new FileResource(ff));
break;
}
}
}
}
if (packageRef.isDefaultPackage())
logger.debug("Package reference is default package");
dot.putResource("OSGI-OPT/src/" + sourcePath, new FileResource(f));
}
}
if (getSourcePath().isEmpty())
warning("Including sources but " + SOURCEPATH + " does not contain any source directories ");
// TODO copy from the jars where they came from
}
}
boolean firstUse = true;
private Tree tree;
public Collection<File> getSourcePath() {
if (firstUse) {
firstUse = false;
String sp = mergeProperties(SOURCEPATH);
if (sp != null) {
Parameters map = parseHeader(sp);
for (String file : map.keySet()) {
if (!isDuplicate(file)) {
File f = getFile(file);
if (!f.isDirectory()) {
error("Adding a sourcepath that is not a directory: %s", f).header(SOURCEPATH)
.context(file);
} else {
sourcePath.add(f);
}
}
}
}
}
return sourcePath;
}
private void doVerify(@SuppressWarnings("unused") Jar dot) throws Exception {
// Give the verifier the benefit of our analysis
// prevents parsing the files twice
try (Verifier verifier = new Verifier(this)) {
verifier.setFrombuilder(true);
verifier.verify();
getInfo(verifier);
}
}
private void doExpand(Jar dot) throws Exception {
// Build an index of the class path that we can then
// use destructively
MultiMap<String, Jar> packages = new MultiMap<>();
for (Jar srce : getClasspath()) {
dot.updateModified(srce.lastModified(), srce + " (" + srce.lastModifiedReason() + ")");
MapStream.of(srce.getDirectories())
.filterValue(Objects::nonNull)
.keys()
.forEachOrdered(path -> packages.add(path, srce));
}
Parameters private_package = getParameters(PRIVATE_PACKAGE);
// TODO change the decorated call to remove the second arg.
Parameters privatepackage = decorated(PRIVATEPACKAGE, true);
Parameters testpackage = new Parameters();
// TODO change the decorated call to remove the second arg.
Parameters includepackage = decorated(INCLUDEPACKAGE, true);
if (buildInstrs.undertest()) {
String h = mergeProperties(Constants.TESTPACKAGES, "test;presence:=optional");
testpackage = parseHeader(h);
}
Parameters includedPackages = new Parameters();
includedPackages.putAll(private_package);
includedPackages.putAll(privatepackage);
includedPackages.putAll(testpackage);
includedPackages.putAll(includepackage);
if (!includedPackages.isEmpty()) {
Instructions privateFilter = new Instructions(includedPackages);
Set<Instruction> unused = doExpand(dot, packages, privateFilter);
unused.removeIf(Instruction::isAny); // allow 0 matches
if (!unused.isEmpty()) {
String header = Constants.PRIVATEPACKAGE;
if (Logic.hasOverlap(private_package.keySet(), unused))
header = Constants.PRIVATE_PACKAGE;
else if (Logic.hasOverlap(testpackage.keySet(), unused))
header = Constants.TESTPACKAGES;
else if (Logic.hasOverlap(includepackage.keySet(), unused))
header = Constants.INCLUDEPACKAGE;
warning(
"Unused %s instructions , no such package(s) on the class path: %s", header, unused).header(header)
.context(unused.iterator()
.next()
.getInput());
}
}
Parameters exportedPackage = getExportPackage();
if (!exportedPackage.isEmpty()) {
Instructions exportedFilter = new Instructions(exportedPackage);
// We ignore unused instructions for exports, they should show
// up as errors during analysis. Otherwise any overlapping
// packages with the private packages should show up as
// unused
doExpand(dot, packages, exportedFilter);
}
}
/**
* Destructively filter the packages from the build up index. This index is
* used by the Export Package as well as the Private Package
*/
private Set<Instruction> doExpand(Jar jar, MultiMap<String, Jar> index, Instructions filter) throws Exception {
Set<Instruction> unused = Create.set();
for (Entry<Instruction, Attrs> e : filter.entrySet()) {
Instruction instruction = e.getKey();
if (instruction.isDuplicate())
continue;
Attrs directives = e.getValue();
// We can optionally filter on the
// source of the package. We assume
// they all match but this can be overridden
// on the instruction
Instruction from = new Instruction(directives.get(FROM_DIRECTIVE, "*"));
boolean used = false;
for (Iterator<Entry<String, List<Jar>>> entry = index.entrySet()
.iterator(); entry.hasNext();) {
Entry<String, List<Jar>> p = entry.next();
String directory = p.getKey();
PackageRef packageRef = getPackageRef(directory);
// Skip * and meta data, we're talking packages!
if (packageRef.isMetaData() && instruction.isAny())
continue;
if (!instruction.matches(packageRef.getFQN()))
continue;
// Ensure it is never matched again
entry.remove();
// ! effectively removes it from consideration by others (this
// includes exports)
if (instruction.isNegated()) {
used = true;
continue;
}
// Do the from: directive, filters on the JAR type
List<Jar> providers = filterFrom(from, p.getValue());
if (providers.isEmpty())
continue;
int splitStrategy = getSplitStrategy(directives.get(SPLIT_PACKAGE_DIRECTIVE));
copyPackage(jar, providers, directory, splitStrategy);
Attrs contained = getContained().put(packageRef);
contained.put(INTERNAL_SOURCE_DIRECTIVE, getName(providers.get(0)));
used = true;
}
if (!used && !isTrue(directives.get("optional:")))
unused.add(instruction);
}
return unused;
}
/**
* @param from
*/
private List<Jar> filterFrom(Instruction from, List<Jar> providers) {
if (from.isAny())
return providers;
List<Jar> np = new ArrayList<>();
for (Jar j : providers) {
if (from.matches(j.getName()) ^ from.isNegated()) {
np.add(j);
}
}
return np;
}
/**
* Copy the package from the providers based on the split package strategy.
*/
private void copyPackage(Jar dest, List<Jar> providers, String path, int splitStrategy) {
switch (splitStrategy) {
case SPLIT_MERGE_LAST :
for (Jar srce : providers) {
copy(dest, srce, path, true);
}
break;
case SPLIT_MERGE_FIRST :
for (Jar srce : providers) {
copy(dest, srce, path, false);
}
break;
case SPLIT_ERROR :
error("%s", diagnostic(path, providers));
break;
case SPLIT_FIRST :
copy(dest, providers.get(0), path, false);
break;
default :
if (providers.size() > 1)
warning("%s", diagnostic(path, providers));
for (Jar srce : providers) {
copy(dest, srce, path, false);
}
break;
}
}
/**
* Copy
*/
private void copy(Jar dest, Jar srce, String path, boolean overwrite) {
logger.debug("copy d={} s={} p={}", dest, srce, path);
dest.copy(srce, path, overwrite);
if (hasSources()) {
dest.copy(srce, appendPath("OSGI-OPT/src", path), overwrite);
}
// bnd.info sources must be preprocessed
String bndInfoPath = appendPath(path, "bnd.info");
Resource r = dest.getResource(bndInfoPath);
if (r != null && !(r instanceof PreprocessResource)) {
logger.debug("preprocessing bnd.info");
PreprocessResource pp = new PreprocessResource(this, r);
dest.putResource(bndInfoPath, pp);
}
if (hasSources()) {
String srcPath = appendPath("OSGI-OPT/src", path);
Map<String, Resource> srcContents = srce.getDirectory(srcPath);
if (srcContents != null) {
dest.addDirectory(srcContents, overwrite);
}
}
}
/**
* Analyze the classpath for a split package
*/
private String diagnostic(String pack, List<Jar> culprits) {
// Default is like merge-first, but with a warning
return "Split package, multiple jars provide the same package:" + pack
+ "\nUse Import/Export Package directive -split-package:=(merge-first|merge-last|error|first) to get rid of this warning\n"
+ "Package found in " + culprits + "\n" //
+ "Class path " + getClasspath();
}
private int getSplitStrategy(String type) {
if (type == null)
return SPLIT_DEFAULT;
if (type.equals("merge-last"))
return SPLIT_MERGE_LAST;
if (type.equals("merge-first"))
return SPLIT_MERGE_FIRST;
if (type.equals("error"))
return SPLIT_ERROR;
if (type.equals("first"))
return SPLIT_FIRST;
error("Invalid strategy for split-package: %s", type);
return SPLIT_DEFAULT;
}
/**
* Matches the instructions against a package.
*
* @param instructions The list of instructions
* @param pack The name of the package
* @param unused The total list of patterns, matched patterns are removed
* @param source The name of the source container, can be filtered upon with
* the from: directive.
*/
private Instruction matches(Instructions instructions, String pack, Set<Instruction> unused, String source) {
for (Entry<Instruction, Attrs> entry : instructions.entrySet()) {
Instruction pattern = entry.getKey();
// It is possible to filter on the source of the
// package with the from: directive. This is an
// instruction that must match the name of the
// source class path entry.
String from = entry.getValue()
.get(FROM_DIRECTIVE);
if (from != null) {
Instruction f = new Instruction(from);
if (!(f.matches(source) ^ f.isNegated()))
continue;
}
// Now do the normal
// matching
if (pattern.matches(pack)) {
if (unused != null)
unused.remove(pattern);
return pattern;
}
}
return null;
}
/**
* Parse the Bundle-Includes header. Files in the bundles Include header are
* included in the jar. The source can be a directory or a file.
*
* @throws IOException
* @throws FileNotFoundException
*/
private void doIncludeResources(Jar jar) throws Exception {
Parameters includes = parseHeader(getProperty("Bundle-Includes"));
if (includes.isEmpty()) {
// TODO change the decorated call to remove the second arg.
includes = decorated(Constants.INCLUDERESOURCE, true);
includes.putAll(getMergedParameters(Constants.INCLUDE_RESOURCE));
} else {
warning("Please use -includeresource instead of Bundle-Includes");
}
doIncludeResource(jar, includes);
}
private void doIncludeResource(Jar jar, String includes) throws Exception {
Parameters clauses = parseHeader(includes);
doIncludeResource(jar, clauses);
}
private void doIncludeResource(Jar jar, Parameters clauses) throws ZipException, IOException, Exception {
for (Entry<String, Attrs> entry : clauses.entrySet()) {
String key = removeDuplicateMarker(entry.getKey());
doIncludeResource(jar, key, entry.getValue());
}
}
private void doIncludeResource(Jar jar, String name, Map<String, String> extra)
throws ZipException, IOException, Exception {
Instructions preprocess = null;
boolean absentIsOk = false;
if (name.startsWith("{") && name.endsWith("}")) {
preprocess = getPreProcessMatcher(extra);
name = name.substring(1, name.length() - 1)
.trim();
}
String parts[] = name.split("\\s*=\\s*");
String source = parts[0];
String destination = parts[0];
if (parts.length == 2)
source = parts[1];
if (source.startsWith("-")) {
source = source.substring(1);
absentIsOk = true;
}
if (source.startsWith("@")) {
extractFromJar(jar, source.substring(1), parts.length == 1 ? "" : destination, absentIsOk, extra);
} else if (extra.containsKey("cmd")) {
doCommand(jar, source, destination, extra, preprocess, absentIsOk);
} else if (extra.containsKey(LITERAL_ATTRIBUTE)) {
String literal = extra.get(LITERAL_ATTRIBUTE);
Resource r = new EmbeddedResource(literal, 0L);
addExtra(r, extra.get("extra"));
copy(jar, name, r, extra);
if (preprocess != null) {
warning("Preprocessing does not work for literals: %s", name);
}
} else if (extra.containsKey(Constants.CLASS_ATTRIBUTE)) {
doClassAttribute(jar, name, extra, preprocess, absentIsOk);
} else {
File sourceFile;
String destinationPath;
sourceFile = getFile(source);
if (parts.length == 1) {
// Directories should be copied to the root
// but files to their file name ...
if (sourceFile.isDirectory())
destinationPath = "";
else
destinationPath = sourceFile.getName();
} else {
destinationPath = parts[0];
}
// Handle directories
if (sourceFile.isDirectory()) {
destinationPath = doResourceDirectory(jar, extra, preprocess, sourceFile, destinationPath);
return;
}
// destinationPath = checkDestinationPath(destinationPath);
if (!sourceFile.exists()) {
if (absentIsOk)
return;
noSuchFile(jar, name, extra, source, destinationPath);
} else
copy(jar, destinationPath, sourceFile, preprocess, extra);
}
}