import static java.lang.System.Logger.Level.TRACE;
import static java.lang.System.Logger.Level.WARNING;
import static java.nio.file.FileVisitResult.CONTINUE;
+import static java.util.jar.Attributes.Name.MANIFEST_VERSION;
import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_M2;
import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_M2_REPO;
+import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_LICENSE;
import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_SYMBOLICNAME;
import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_VERSION;
+import static org.argeo.build.Repackage.ManifestConstants.ECLIPSE_SOURCE_BUNDLE;
import static org.argeo.build.Repackage.ManifestConstants.EXPORT_PACKAGE;
+import static org.argeo.build.Repackage.ManifestConstants.IMPORT_PACKAGE;
+import static org.argeo.build.Repackage.ManifestConstants.SPDX_LICENSE_IDENTIFIER;
import java.io.File;
import java.io.FileNotFoundException;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;
+import java.util.Set;
import java.util.TreeMap;
+import java.util.TreeSet;
import java.util.concurrent.CompletableFuture;
import java.util.jar.Attributes;
import java.util.jar.JarEntry;
* repository.
*/
public class Repackage {
- private final static Logger logger = System.getLogger(Repackage.class.getName());
+ final static Logger logger = System.getLogger(Repackage.class.getName());
/**
* Environment variable on whether sources should be packaged separately or
* integrated in the bundles.
*/
- private final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES";
+ final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES";
/** Whethere repackaging should run in parallel or sequentially. */
- private final static boolean parallel = true;
+ final static boolean parallel = true;
+
+ // cache
+ /** Summary of all license seen during the repackaging. */
+ final static Map<String, Set<String>> licensesUsed = new TreeMap<>();
/** Main entry point. */
public static void main(String[] args) {
factory.processCategory(p);
}
CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join();
+
+ // Summary
+ StringBuilder sb = new StringBuilder();
+ for (String licenseId : licensesUsed.keySet())
+ for (String name : licensesUsed.get(licenseId))
+ sb.append((licenseId.equals("") ? "Proprietary" : licenseId) + "\t\t" + name + "\n");
+ logger.log(INFO, "# License summary:\n" + sb);
}
- private final static String COMMON_BND = "common.bnd";
- private final static String MERGE_BND = "merge.bnd";
+ final static String COMMON_BND = "common.bnd";
+ final static String MERGE_BND = "merge.bnd";
/** Directory where to download archives */
- private Path originBase;
+ Path originBase;
/** Directory where to download Maven artifacts */
- private Path mavenBase;
+ Path mavenBase;
/** A2 repository base for binary bundles */
- private Path a2Base;
+ Path a2Base;
/** A2 repository base for source bundles */
- private Path a2SrcBase;
+ Path a2SrcBase;
/** A2 base for native components */
- private Path a2LibBase;
+ Path a2LibBase;
/** Location of the descriptors driving the packaging */
- private Path descriptorsBase;
+ Path descriptorsBase;
/** URIs of archives to download */
- private Properties uris = new Properties();
+ Properties uris = new Properties();
/** Mirrors for archive download. Key is URI prefix, value list of base URLs */
- private Map<String, List<String>> mirrors = new HashMap<String, List<String>>();
+ Map<String, List<String>> mirrors = new HashMap<String, List<String>>();
/** Whether sources should be packaged separately */
- private final boolean sourceBundles;
+ final boolean sourceBundles;
/** Constructor initialises the various variables */
public Repackage(Path a2Base, Path descriptorsBase) {
* MAVEN ORIGIN
*/
/** Process a whole category/group id. */
- public void processCategory(Path categoryRelativePath) {
+ void processCategory(Path categoryRelativePath) {
try {
Path targetCategoryBase = descriptorsBase.resolve(categoryRelativePath);
DirectoryStream<Path> bnds = Files.newDirectoryStream(targetCategoryBase,
}
/** Process a standalone Maven artifact. */
- public void processSingleM2ArtifactDistributionUnit(Path bndFile) {
+ void processSingleM2ArtifactDistributionUnit(Path bndFile) {
try {
Path categoryRelativePath = descriptorsBase.relativize(bndFile.getParent());
Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
}
/** Process multiple Maven artifacts. */
- public void processM2BasedDistributionUnit(Path duDir) {
+ void processM2BasedDistributionUnit(Path duDir) {
try {
Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent());
Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
}
/** Merge multiple Maven artifacts. */
- protected void mergeM2Artifacts(Path mergeBnd) throws IOException {
+ void mergeM2Artifacts(Path mergeBnd) throws IOException {
Path duDir = mergeBnd.getParent();
String category = duDir.getParent().getFileName().toString();
Path targetCategoryBase = a2Base.resolve(category);
}
/** Generate MANIFEST using BND. */
- protected Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact) {
+ Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact) {
try {
Map<String, String> additionalEntries = new TreeMap<>();
}
if ("Require-Capability".equals(key.toString())
&& value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\""))
- continue keys;// hack for very old classes
+ continue keys;// !! hack for very old classes
additionalEntries.put(key.toString(), value.toString());
- // logger.log(DEBUG, () -> key + "=" + value);
-
}
}
}
}
/** Download and integrates sources for a single Maven artifact. */
- protected void downloadAndProcessM2Sources(String repoStr, M2Artifact artifact, Path targetBundleDir)
- throws IOException {
+ void downloadAndProcessM2Sources(String repoStr, M2Artifact artifact, Path targetBundleDir) throws IOException {
try {
M2Artifact sourcesArtifact = new M2Artifact(artifact.toM2Coordinates(), "sources");
URL sourcesUrl = M2ConventionsUtils.mavenRepoUrl(repoStr, sourcesArtifact);
}
/** Integrate sources from a downloaded jar file. */
- protected void processM2SourceJar(Path file, Path targetBundleDir) throws IOException {
+ void processM2SourceJar(Path file, Path targetBundleDir) throws IOException {
try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) {
Path targetSourceDir = sourceBundles
? targetBundleDir.getParent().resolve(targetBundleDir.toString() + ".src")
}
/** Download a Maven artifact. */
- protected Path downloadMaven(URL url, M2Artifact artifact) throws IOException {
+ Path downloadMaven(URL url, M2Artifact artifact) throws IOException {
return downloadMaven(url, artifact, false);
}
/** Download a Maven artifact. */
- protected Path downloadMaven(URL url, M2Artifact artifact, boolean sources) throws IOException {
+ Path downloadMaven(URL url, M2Artifact artifact, boolean sources) throws IOException {
return download(url, mavenBase, artifact.getGroupId().replace(".", "/") //
+ '/' + artifact.getArtifactId() + '/' + artifact.getVersion() //
+ '/' + artifact.getArtifactId() + "-" + artifact.getVersion() + (sources ? "-sources" : "") + ".jar");
* ECLIPSE ORIGIN
*/
/** Process an archive in Eclipse format. */
- public void processEclipseArchive(Path duDir) {
+ void processEclipseArchive(Path duDir) {
try {
Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent());
Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
}
/** Process sources in Eclipse format. */
- protected void processEclipseSourceJar(Path file, Path targetBase) throws IOException {
+ void processEclipseSourceJar(Path file, Path targetBase) throws IOException {
try {
Path targetBundleDir;
try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) {
Manifest manifest = jarIn.getManifest();
- String[] relatedBundle = manifest.getMainAttributes().getValue("Eclipse-SourceBundle").split(";");
+ String[] relatedBundle = manifest.getMainAttributes().getValue(ECLIPSE_SOURCE_BUNDLE.toString())
+ .split(";");
String version = relatedBundle[1].substring("version=\"".length());
version = version.substring(0, version.length() - 1);
NameVersion nameVersion = new NameVersion(relatedBundle[0], version);
* COMMON PROCESSING
*/
/** Normalise a bundle. */
- protected Path processBundleJar(Path file, Path targetBase, Map<String, String> entries) throws IOException {
+ Path processBundleJar(Path file, Path targetBase, Map<String, String> entries) throws IOException {
NameVersion nameVersion;
Path targetBundleDir;
try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) {
entries.get(BUNDLE_SYMBOLICNAME.toString()) + ";singleton:=true");
}
+ // Final MANIFEST decisions
+ // This also where we check the original OSGi metadata and compare with our
+ // changes
for (String key : entries.keySet()) {
String value = entries.get(key);
- Object previousValue = manifest.getMainAttributes().putValue(key, value);
- if (previousValue != null && !previousValue.equals(value)) {
- if (ManifestConstants.IMPORT_PACKAGE.toString().equals(key)
- || ManifestConstants.EXPORT_PACKAGE.toString().equals(key))
- logger.log(TRACE, file.getFileName() + ": " + key + " was modified");
+ String previousValue = manifest.getMainAttributes().getValue(key);
+ boolean wasDifferent = previousValue != null && !previousValue.equals(value);
+ boolean keepPrevious = false;
+ if (wasDifferent) {
+ if (SPDX_LICENSE_IDENTIFIER.toString().equals(key) && previousValue != null)
+ keepPrevious = true;
+ else if (BUNDLE_VERSION.toString().equals(key) && wasDifferent)
+ if (previousValue.equals(value + ".0")) // typically a Maven first release
+ keepPrevious = true;
+
+ if (keepPrevious) {
+ if (logger.isLoggable(TRACE))
+ logger.log(TRACE, file.getFileName() + ": " + key + " was NOT modified, value kept is "
+ + previousValue + ", not overriden with " + value);
+ value = previousValue;
+ }
+ }
+
+ manifest.getMainAttributes().putValue(key, value);
+ if (wasDifferent && !keepPrevious) {
+ if (IMPORT_PACKAGE.toString().equals(key) || EXPORT_PACKAGE.toString().equals(key))
+ logger.log(TRACE, () -> file.getFileName() + ": " + key + " was modified");
else
logger.log(WARNING, file.getFileName() + ": " + key + " was " + previousValue
+ ", overridden with " + value);
manifest.getMainAttributes().remove(key);
}
}
+
+ // last checks
+ String spdxLicenceId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString());
+ String bundleLicense = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString());
+ if (spdxLicenceId == null) {
+ logger.log(ERROR, file.getFileName() + ": " + SPDX_LICENSE_IDENTIFIER + " not available, "
+ + BUNDLE_LICENSE + " is " + bundleLicense);
+ } else {
+ if (!licensesUsed.containsKey(spdxLicenceId))
+ licensesUsed.put(spdxLicenceId, new TreeSet<>());
+ licensesUsed.get(spdxLicenceId).add(nameVersion.toString());
+ }
+
try (OutputStream out = Files.newOutputStream(manifestPath)) {
manifest.write(out);
}
* UTILITIES
*/
/** Recursively deletes a directory. */
- private static void deleteDirectory(Path path) throws IOException {
+ static void deleteDirectory(Path path) throws IOException {
if (!Files.exists(path))
return;
Files.walkFileTree(path, new SimpleFileVisitor<Path>() {
}
/** Extract name/version from a MANIFEST. */
- protected NameVersion nameVersionFromManifest(Manifest manifest) {
+ NameVersion nameVersionFromManifest(Manifest manifest) {
Attributes attrs = manifest.getMainAttributes();
// symbolic name
String symbolicName = attrs.getValue(ManifestConstants.BUNDLE_SYMBOLICNAME.toString());
}
/** Try to download from an URI. */
- protected Path tryDownloadArchive(String uri, Path dir) throws IOException {
+ Path tryDownloadArchive(String uri, Path dir) throws IOException {
// find mirror
List<String> urlBases = null;
String uriPrefix = null;
* Effectively download. Synchronised in order to avoid downloading twice in
* parallel.
*/
- protected synchronized Path downloadArchive(URL url, Path dir) throws IOException {
+ synchronized Path downloadArchive(URL url, Path dir) throws IOException {
return download(url, dir, (String) null);
}
/** Effectively download. */
- protected Path download(URL url, Path dir, String name) throws IOException {
+ Path download(URL url, Path dir, String name) throws IOException {
Path dest;
if (name == null) {
}
/** Create a JAR file from a directory. */
- protected Path createJar(Path bundleDir) throws IOException {
+ Path createJar(Path bundleDir) throws IOException {
// Create the jar
Path jarPath = bundleDir.getParent().resolve(bundleDir.getFileName() + ".jar");
Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF");
// in case there are additional directives
bundleSymbolicName = bundleSymbolicName.split(";")[0];
Manifest srcManifest = new Manifest();
- srcManifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1.0");
- srcManifest.getMainAttributes().putValue("Bundle-SymbolicName", bundleSymbolicName + ".src");
- srcManifest.getMainAttributes().putValue("Bundle-Version",
- manifest.getMainAttributes().getValue("Bundle-Version").toString());
- srcManifest.getMainAttributes().putValue("Eclipse-SourceBundle",
- bundleSymbolicName + ";version=\"" + manifest.getMainAttributes().getValue("Bundle-Version"));
+ srcManifest.getMainAttributes().put(MANIFEST_VERSION, "1.0");
+ srcManifest.getMainAttributes().putValue(BUNDLE_SYMBOLICNAME.toString(), bundleSymbolicName + ".src");
+ srcManifest.getMainAttributes().putValue(BUNDLE_VERSION.toString(),
+ manifest.getMainAttributes().getValue(BUNDLE_VERSION.toString()).toString());
+ srcManifest.getMainAttributes().putValue(ECLIPSE_SOURCE_BUNDLE.toString(), bundleSymbolicName
+ + ";version=\"" + manifest.getMainAttributes().getValue(BUNDLE_VERSION.toString()));
try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) {
srcJarOut.setLevel(Deflater.BEST_COMPRESSION);
BUNDLE_SYMBOLICNAME("Bundle-SymbolicName"), //
/** OSGi bundle version. */
BUNDLE_VERSION("Bundle-Version"), //
-// BUNDLE_LICENSE("Bundle-License"), //
+ /** OSGi bundle license. */
+ BUNDLE_LICENSE("Bundle-License"), //
/** OSGi exported packages list. */
EXPORT_PACKAGE("Export-Package"), //
/** OSGi imported packages list. */
// Java
/** Java module name. */
AUTOMATIC_MODULE_NAME("Automatic-Module-Name"), //
+ // Eclipse
+ /** Eclipse source bundle. */
+ ECLIPSE_SOURCE_BUNDLE("Eclipse-SourceBundle"), //
+ // SPDX
+ /**
+ * SPDX license identifier.
+ *
+ * @see https://spdx.org/licenses/
+ */
+ SPDX_LICENSE_IDENTIFIER("SPDX-License-Identifier"), //
// Argeo Origin
/**
* Maven coordinates of the origin, possibly partial when using common.bnd or
projects / cc0 / argeo-build.git / blobdiff