X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FRepackage.java;h=ee15af42f324362d6c7e02d5b6d9c1016b1bfdd4;hb=7adb1db5c7613a3ba1b49cb642b33068b30720dc;hp=ac3c9a62981a75f22e5e5e8f0c5cf2f0cf8f2344;hpb=d304d3c10b977a45453106d1c65a76cb595c05ca;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Repackage.java b/src/org/argeo/build/Repackage.java index ac3c9a6..ee15af4 100644 --- a/src/org/argeo/build/Repackage.java +++ b/src/org/argeo/build/Repackage.java @@ -6,12 +6,24 @@ import static java.lang.System.Logger.Level.INFO; 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 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_SYMBOLICNAME; -import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_VERSION; -import static org.argeo.build.Repackage.ManifestConstants.EXPORT_PACKAGE; - +import static java.nio.file.StandardOpenOption.APPEND; +import static java.nio.file.StandardOpenOption.CREATE; +import static java.util.jar.Attributes.Name.MANIFEST_VERSION; +import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2; +import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_MERGE; +import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_REPO; +import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_NO_METADATA_GENERATION; +import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_URI; +import static org.argeo.build.Repackage.ManifestHeader.AUTOMATIC_MODULE_NAME; +import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_LICENSE; +import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_SYMBOLICNAME; +import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_VERSION; +import static org.argeo.build.Repackage.ManifestHeader.ECLIPSE_SOURCE_BUNDLE; +import static org.argeo.build.Repackage.ManifestHeader.EXPORT_PACKAGE; +import static org.argeo.build.Repackage.ManifestHeader.IMPORT_PACKAGE; +import static org.argeo.build.Repackage.ManifestHeader.SPDX_LICENSE_IDENTIFIER; + +import java.io.BufferedWriter; import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; @@ -30,6 +42,7 @@ import java.nio.file.Path; import java.nio.file.PathMatcher; import java.nio.file.Paths; import java.nio.file.SimpleFileVisitor; +import java.nio.file.StandardCopyOption; import java.nio.file.StandardOpenOption; import java.nio.file.attribute.BasicFileAttributes; import java.util.ArrayList; @@ -39,7 +52,10 @@ import java.util.List; import java.util.Map; import java.util.Objects; import java.util.Properties; +import java.util.Set; +import java.util.StringJoiner; import java.util.TreeMap; +import java.util.TreeSet; import java.util.concurrent.CompletableFuture; import java.util.jar.Attributes; import java.util.jar.JarEntry; @@ -51,24 +67,25 @@ import java.util.zip.Deflater; import aQute.bnd.osgi.Analyzer; import aQute.bnd.osgi.Jar; -/** - * Simple tool repackaging existing jar files into OSGi bundles in an A2 - * repository. - */ +/** Repackages existing jar files into OSGi bundles in an A2 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"; + /** Environment variable on whether operations should be parallelised. */ + final static String ENV_ARGEO_BUILD_SEQUENTIAL = "ARGEO_BUILD_SEQUENTIAL"; - /** Whethere repackaging should run in parallel or sequentially. */ - private final static boolean parallel = true; + /** Whether repackaging should run in parallel (default) or sequentially. */ + final static boolean sequential = Boolean.parseBoolean(System.getenv(ENV_ARGEO_BUILD_SEQUENTIAL)); /** Main entry point. */ public static void main(String[] args) { + if (sequential) + logger.log(INFO, "Build will be sequential"); if (args.length < 2) { System.err.println("Usage: ..."); System.exit(1); @@ -80,37 +97,135 @@ public class Repackage { List> toDos = new ArrayList<>(); for (int i = 1; i < args.length; i++) { Path p = Paths.get(args[i]); - if (parallel) - toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(p))); - else + if (sequential) factory.processCategory(p); + else + toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(p))); + } + if (!sequential) + 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); + } + + /** MANIFEST headers. */ + enum ManifestHeader { + // OSGi + /** OSGi bundle symbolic name. */ + BUNDLE_SYMBOLICNAME("Bundle-SymbolicName"), // + /** OSGi bundle version. */ + BUNDLE_VERSION("Bundle-Version"), // + /** OSGi bundle license. */ + BUNDLE_LICENSE("Bundle-License"), // + /** OSGi exported packages list. */ + EXPORT_PACKAGE("Export-Package"), // + /** OSGi imported packages list. */ + IMPORT_PACKAGE("Import-Package"), // + /** OSGi path to embedded jar. */ + BUNDLE_CLASSPATH("Bundle-Classpath"), // + // 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 + * merge.bnd. + */ + ARGEO_ORIGIN_M2("Argeo-Origin-M2"), // + /** List of Maven coordinates to merge. */ + ARGEO_ORIGIN_M2_MERGE("Argeo-Origin-M2-Merge"), // + /** Maven repository, if not the default one. */ + ARGEO_ORIGIN_M2_REPO("Argeo-Origin-M2-Repo"), // + /** + * Do not perform BND analysis of the origin component. Typically Import_package + * and Export-Package will be kept untouched. + */ + ARGEO_ORIGIN_NO_METADATA_GENERATION("Argeo-Origin-NoMetadataGeneration"), // +// /** +// * Embed the original jar without modifying it (may be required by some +// * proprietary licenses, such as JCR Day License). +// */ +// ARGEO_ORIGIN_EMBED("Argeo-Origin-Embed"), // + /** + * Do not modify original jar (may be required by some proprietary licenses, + * such as JCR Day License). + */ + ARGEO_DO_NOT_MODIFY("Argeo-Origin-Do-Not-Modify"), // + /** + * Origin (non-Maven) URI of the component. It may be anything (jar, archive, + * etc.). + */ + ARGEO_ORIGIN_URI("Argeo-Origin-URI"), // + ; + + final String value; + + private ManifestHeader(String value) { + this.value = value; + } + + @Override + public String toString() { + return value; } - CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join(); } - private final static String COMMON_BND = "common.bnd"; - private final static String MERGE_BND = "merge.bnd"; + /** Name of the file centralising information for multiple M2 artifacts. */ + final static String COMMON_BND = "common.bnd"; + /** Name of the file centralising information for mergin M2 artifacts. */ + final static String MERGE_BND = "merge.bnd"; + /** + * Subdirectory of the jar file where origin informations (changes, legal + * notices etc. are stored) + */ + final static String ARGEO_ORIGIN = "ARGEO-ORIGIN"; + /** File detailing modifications to the original component. */ + final static String CHANGES = ARGEO_ORIGIN + "/changes"; + /** + * Name of the file at the root of the repackaged jar, which prominently + * notifies that the component has be repackaged. + */ + final static String README_REPACKAGED = "README.repackaged"; + + // cache + /** Summary of all license seen during the repackaging. */ + final static Map> licensesUsed = new TreeMap<>(); /** Directory where to download archives */ - private Path originBase; + final Path originBase; /** Directory where to download Maven artifacts */ - private Path mavenBase; + final Path mavenBase; /** A2 repository base for binary bundles */ - private Path a2Base; + final Path a2Base; /** A2 repository base for source bundles */ - private Path a2SrcBase; + final Path a2SrcBase; /** A2 base for native components */ - private Path a2LibBase; + final Path a2LibBase; /** Location of the descriptors driving the packaging */ - private Path descriptorsBase; + final Path descriptorsBase; /** URIs of archives to download */ - private Properties uris = new Properties(); + final Properties uris = new Properties(); /** Mirrors for archive download. Key is URI prefix, value list of base URLs */ - private Map> mirrors = new HashMap>(); + final Map> mirrors = new HashMap>(); /** Whether sources should be packaged separately */ - private final boolean sourceBundles; + final boolean sourceBundles; /** Constructor initialises the various variables */ public Repackage(Path a2Base, Path descriptorsBase) { @@ -163,7 +278,7 @@ public class Repackage { * MAVEN ORIGIN */ /** Process a whole category/group id. */ - public void processCategory(Path categoryRelativePath) { + void processCategory(Path categoryRelativePath) { try { Path targetCategoryBase = descriptorsBase.resolve(categoryRelativePath); DirectoryStream bnds = Files.newDirectoryStream(targetCategoryBase, @@ -187,7 +302,7 @@ public class Repackage { } /** 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); @@ -200,8 +315,8 @@ public class Repackage { ? fileProps.getProperty(ARGEO_ORIGIN_M2_REPO.toString()) : null; + // use file name as symbolic name if (!fileProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) { - // use file name as symbolic name String symbolicName = bndFile.getFileName().toString(); symbolicName = symbolicName.substring(0, symbolicName.length() - ".bnd".length()); fileProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName); @@ -214,17 +329,44 @@ public class Repackage { URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact); Path downloaded = downloadMaven(url, artifact); - Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact); - downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir); + // some proprietary artifacts do not allow any modification + // when releasing (with separate sources) we just copy it + boolean doNotModify = Boolean.parseBoolean( + fileProps.getOrDefault(ManifestHeader.ARGEO_DO_NOT_MODIFY.toString(), "false").toString()); + if (doNotModify && sourceBundles) { + Path unmodifiedTarget = targetCategoryBase.resolve( + fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch() + ".jar"); + Files.copy(downloaded, unmodifiedTarget, StandardCopyOption.REPLACE_EXISTING); + Path bundleDir = targetCategoryBase + .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch()); + downloadAndProcessM2Sources(repoStr, artifact, bundleDir, false); + Manifest manifest; + try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(unmodifiedTarget))) { + manifest = jarIn.getManifest(); + } + createSourceJar(bundleDir, manifest); + return; + } - createJar(targetBundleDir); + // regular processing + A2Origin origin = new A2Origin(); + Path bundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact, origin); + downloadAndProcessM2Sources(repoStr, artifact, bundleDir, false); + createJar(bundleDir, origin); } catch (Exception e) { throw new RuntimeException("Cannot process " + bndFile, e); } } - /** Process multiple Maven artifacts. */ - public void processM2BasedDistributionUnit(Path duDir) { + /** + * Process multiple Maven artifacts coming from a same project and therefore + * with information in common (typically the version), generating single bundles + * or merging them if necessary. + * + * @see #COMMON_BND + * @see #MERGE_BND + */ + void processM2BasedDistributionUnit(Path duDir) { try { Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent()); Path targetCategoryBase = a2Base.resolve(categoryRelativePath); @@ -262,14 +404,19 @@ public class Repackage { } String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString()); M2Artifact artifact = new M2Artifact(m2Coordinates); - artifact.setVersion(m2Version); + if (artifact.getVersion() == null) { + artifact.setVersion(m2Version); + } else { + logger.log(WARNING, p.getFileName() + " : Using version " + artifact.getVersion() + + " specified in descriptor rather than " + m2Version + " specified in " + COMMON_BND); + } // prepare manifest entries Properties mergeProps = new Properties(); mergeProps.putAll(commonProps); fileEntries: for (Object key : fileProps.keySet()) { - if (ManifestConstants.ARGEO_ORIGIN_M2.toString().equals(key)) + if (ARGEO_ORIGIN_M2.toString().equals(key)) continue fileEntries; String value = fileProps.getProperty(key.toString()); Object previousValue = mergeProps.put(key.toString(), value); @@ -278,7 +425,7 @@ public class Repackage { commonBnd + ": " + key + " was " + previousValue + ", overridden with " + value); } } - mergeProps.put(ManifestConstants.ARGEO_ORIGIN_M2.toString(), artifact.toM2Coordinates()); + mergeProps.put(ARGEO_ORIGIN_M2.toString(), artifact.toM2Coordinates()); if (!mergeProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) { // use file name as symbolic name String symbolicName = p.getFileName().toString(); @@ -294,9 +441,10 @@ public class Repackage { URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact); Path downloaded = downloadMaven(url, artifact); - Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergeProps, artifact); - downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir); - createJar(targetBundleDir); + A2Origin origin = new A2Origin(); + Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergeProps, artifact, origin); + downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir, false); + createJar(targetBundleDir, origin); } } catch (IOException e) { throw new RuntimeException("Cannot process " + duDir, e); @@ -304,43 +452,51 @@ public class Repackage { } /** 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); Properties mergeProps = new Properties(); + // first, load common properties + Path commonBnd = duDir.resolve(COMMON_BND); + if (Files.exists(commonBnd)) + try (InputStream in = Files.newInputStream(commonBnd)) { + mergeProps.load(in); + } + // then, the merge properties themselves try (InputStream in = Files.newInputStream(mergeBnd)) { mergeProps.load(in); } String m2Version = mergeProps.getProperty(ARGEO_ORIGIN_M2.toString()); if (m2Version == null) { - logger.log(WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit"); + logger.log(WARNING, "Ignoring merging in " + duDir + " as it is not an M2-based distribution unit"); return;// ignore, this is probably an Eclipse archive } if (!m2Version.startsWith(":")) { throw new IllegalStateException("Only the M2 version can be specified: " + m2Version); } m2Version = m2Version.substring(1); - mergeProps.put(ManifestConstants.BUNDLE_VERSION.toString(), m2Version); + mergeProps.put(BUNDLE_VERSION.toString(), m2Version); - String artifactsStr = mergeProps.getProperty(ManifestConstants.ARGEO_ORIGIN_M2_MERGE.toString()); + String artifactsStr = mergeProps.getProperty(ARGEO_ORIGIN_M2_MERGE.toString()); if (artifactsStr == null) - throw new IllegalArgumentException( - mergeBnd + ": " + ManifestConstants.ARGEO_ORIGIN_M2_MERGE + " must be set"); + throw new IllegalArgumentException(mergeBnd + ": " + ARGEO_ORIGIN_M2_MERGE + " must be set"); String repoStr = mergeProps.containsKey(ARGEO_ORIGIN_M2_REPO.toString()) ? mergeProps.getProperty(ARGEO_ORIGIN_M2_REPO.toString()) : null; - String bundleSymbolicName = mergeProps.getProperty(ManifestConstants.BUNDLE_SYMBOLICNAME.toString()); + String bundleSymbolicName = mergeProps.getProperty(BUNDLE_SYMBOLICNAME.toString()); if (bundleSymbolicName == null) throw new IllegalArgumentException("Bundle-SymbolicName must be set in " + mergeBnd); CategoryNameVersion nameVersion = new M2Artifact(category + ":" + bundleSymbolicName + ":" + m2Version); - Path targetBundleDir = targetCategoryBase.resolve(bundleSymbolicName + "." + nameVersion.getBranch()); + A2Origin origin = new A2Origin(); + Path bundleDir = targetCategoryBase.resolve(bundleSymbolicName + "." + nameVersion.getBranch()); + StringJoiner originDesc = new StringJoiner(","); String[] artifacts = artifactsStr.split(","); artifacts: for (String str : artifacts) { String m2Coordinates = str.trim(); @@ -349,6 +505,7 @@ public class Repackage { M2Artifact artifact = new M2Artifact(m2Coordinates.trim()); if (artifact.getVersion() == null) artifact.setVersion(m2Version); + originDesc.add(artifact.toString()); URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact); Path downloaded = downloadMaven(url, artifact); JarEntry entry; @@ -356,29 +513,56 @@ public class Repackage { entries: while ((entry = jarIn.getNextJarEntry()) != null) { if (entry.isDirectory()) continue entries; - else if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".SF")) - continue entries; - else if (entry.getName().startsWith("META-INF/versions/")) - continue entries; - else if (entry.getName().startsWith("META-INF/maven/")) - continue entries; - else if (entry.getName().equals("module-info.class")) + if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".DSA") + || entry.getName().endsWith(".SF")) { + origin.deleted.add("cryptographic signatures from " + artifact); continue entries; - else if (entry.getName().equals("META-INF/NOTICE")) + } + if (entry.getName().endsWith("module-info.class")) { // skip Java 9 module info + origin.deleted.add("Java module information (module-info.class) from " + artifact); continue entries; - else if (entry.getName().equals("META-INF/NOTICE.txt")) + } + if (entry.getName().startsWith("META-INF/versions/")) { // skip multi-version + origin.deleted.add("additional Java versions (META-INF/versions) from " + artifact); continue entries; - else if (entry.getName().equals("META-INF/LICENSE")) + } + if (entry.getName().startsWith("META-INF/maven/")) { + origin.deleted.add("Maven information (META-INF/maven) from " + artifact); continue entries; - else if (entry.getName().equals("META-INF/LICENSE.md")) + } + if (entry.getName().startsWith(".cache/")) { // Apache SSHD + origin.deleted.add("cache directory (.cache) from " + artifact); continue entries; - else if (entry.getName().equals("META-INF/LICENSE-notice.md")) + } + if (entry.getName().equals("META-INF/DEPENDENCIES")) { + origin.deleted.add("Dependencies (META-INF/DEPENDENCIES) from " + artifact); continue entries; - else if (entry.getName().equals("META-INF/DEPENDENCIES")) + } + if (entry.getName().equals("META-INF/MANIFEST.MF")) { + Path originalManifest = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId()) + .resolve(artifact.getArtifactId()).resolve("MANIFEST.MF"); + Files.createDirectories(originalManifest.getParent()); + try (OutputStream out = Files.newOutputStream(originalManifest)) { + Files.copy(jarIn, originalManifest); + } + origin.added.add( + "original MANIFEST (" + bundleDir.relativize(originalManifest) + ") from " + artifact); continue entries; - if (entry.getName().startsWith(".cache/")) // Apache SSHD + } + + if (entry.getName().endsWith("NOTICE") || entry.getName().endsWith("NOTICE.txt") + || entry.getName().endsWith("LICENSE") || entry.getName().endsWith("LICENSE.md") + || entry.getName().endsWith("LICENSE-notice.md") || entry.getName().endsWith("COPYING") + || entry.getName().endsWith("COPYING.LESSER")) { + Path artifactOriginDir = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId()) + .resolve(artifact.getArtifactId()); + Path target = artifactOriginDir.resolve(entry.getName()); + Files.createDirectories(target.getParent()); + Files.copy(jarIn, target); + origin.moved.add(entry.getName() + " in " + artifact + " to " + bundleDir.relativize(target)); continue entries; - Path target = targetBundleDir.resolve(entry.getName()); + } + Path target = bundleDir.resolve(entry.getName()); Files.createDirectories(target.getParent()); if (!Files.exists(target)) { Files.copy(jarIn, target); @@ -389,6 +573,7 @@ public class Repackage { jarIn.transferTo(out); logger.log(DEBUG, artifact.getArtifactId() + " - Appended " + entry.getName()); } + origin.modified.add(entry.getName() + ", merging from " + artifact); } else if (entry.getName().startsWith("org/apache/batik/")) { logger.log(TRACE, "Skip " + entry.getName()); continue entries; @@ -398,29 +583,33 @@ public class Repackage { } logger.log(TRACE, () -> "Copied " + target); } - } - downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir); + origin.added.add("binary content of " + artifact); + + // process sources + downloadAndProcessM2Sources(repoStr, artifact, bundleDir, true); } // additional service files Path servicesDir = duDir.resolve("services"); if (Files.exists(servicesDir)) { for (Path p : Files.newDirectoryStream(servicesDir)) { - Path target = targetBundleDir.resolve("META-INF/services/").resolve(p.getFileName()); + Path target = bundleDir.resolve("META-INF/services/").resolve(p.getFileName()); try (InputStream in = Files.newInputStream(p); OutputStream out = Files.newOutputStream(target, StandardOpenOption.APPEND);) { out.write("\n".getBytes()); in.transferTo(out); logger.log(DEBUG, "Appended " + p); } + origin.added.add(bundleDir.relativize(target).toString()); } } + // BND analysis Map entries = new TreeMap<>(); try (Analyzer bndAnalyzer = new Analyzer()) { bndAnalyzer.setProperties(mergeProps); - Jar jar = new Jar(targetBundleDir.toFile()); + Jar jar = new Jar(bundleDir.toFile()); bndAnalyzer.setJar(jar); Manifest manifest = bndAnalyzer.calcManifest(); @@ -434,8 +623,10 @@ public class Repackage { continue keys; } if ("Require-Capability".equals(key.toString()) - && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) + && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) { + origin.deleted.add("MANIFEST header " + key); continue keys;// hack for very old classes + } entries.put(key.toString(), value.toString()); } } catch (Exception e) { @@ -443,33 +634,34 @@ public class Repackage { } Manifest manifest = new Manifest(); - Path manifestPath = targetBundleDir.resolve("META-INF/MANIFEST.MF"); + Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF"); Files.createDirectories(manifestPath.getParent()); for (String key : entries.keySet()) { String value = entries.get(key); manifest.getMainAttributes().putValue(key, value); } + manifest.getMainAttributes().putValue(ARGEO_ORIGIN_M2.toString(), originDesc.toString()); + + processLicense(bundleDir, manifest); + // write MANIFEST try (OutputStream out = Files.newOutputStream(manifestPath)) { manifest.write(out); } - createJar(targetBundleDir); + createJar(bundleDir, origin); } - /** Generate MANIFEST using BND. */ - protected Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact) { - + /** Generates MANIFEST using BND. */ + Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact, + A2Origin origin) { try { Map additionalEntries = new TreeMap<>(); - boolean doNotModify = Boolean.parseBoolean(fileProps - .getOrDefault(ManifestConstants.ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED.toString(), "false").toString()); - - // we always force the symbolic name + boolean doNotModifyManifest = Boolean.parseBoolean( + fileProps.getOrDefault(ARGEO_ORIGIN_NO_METADATA_GENERATION.toString(), "false").toString()); - if (doNotModify) { - fileEntries: for (Object key : fileProps.keySet()) { - if (ManifestConstants.ARGEO_ORIGIN_M2.toString().equals(key)) - continue fileEntries; + // Note: we always force the symbolic name + if (doNotModifyManifest) { + for (Object key : fileProps.keySet()) { String value = fileProps.getProperty(key.toString()); additionalEntries.put(key.toString(), value); } @@ -488,6 +680,7 @@ public class Repackage { "*;version=\"" + fileProps.getProperty(BUNDLE_VERSION.toString()) + "\""); } + // BND analysis try (Analyzer bndAnalyzer = new Analyzer()) { bndAnalyzer.setProperties(fileProps); Jar jar = new Jar(downloaded.toFile()); @@ -504,15 +697,15 @@ public class Repackage { continue keys; } 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 + && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) { + origin.deleted.add("MANIFEST header " + key); + continue keys;// !! hack for very old classes + } additionalEntries.put(key.toString(), value.toString()); - // logger.log(DEBUG, () -> key + "=" + value); - } } } - Path targetBundleDir = processBundleJar(downloaded, targetCategoryBase, additionalEntries); + Path targetBundleDir = processBundleJar(downloaded, targetCategoryBase, additionalEntries, origin); logger.log(DEBUG, () -> "Processed " + downloaded); return targetBundleDir; } catch (Exception e) { @@ -522,13 +715,13 @@ public class Repackage { } /** Download and integrates sources for a single Maven artifact. */ - protected void downloadAndProcessM2Sources(String repoStr, M2Artifact artifact, Path targetBundleDir) + void downloadAndProcessM2Sources(String repoStr, M2Artifact artifact, Path targetBundleDir, boolean merging) throws IOException { try { M2Artifact sourcesArtifact = new M2Artifact(artifact.toM2Coordinates(), "sources"); URL sourcesUrl = M2ConventionsUtils.mavenRepoUrl(repoStr, sourcesArtifact); Path sourcesDownloaded = downloadMaven(sourcesUrl, artifact, true); - processM2SourceJar(sourcesDownloaded, targetBundleDir); + processM2SourceJar(sourcesDownloaded, targetBundleDir, merging ? artifact : null); logger.log(TRACE, () -> "Processed source " + sourcesDownloaded); } catch (Exception e) { logger.log(ERROR, () -> "Cannot download source for " + artifact); @@ -537,24 +730,42 @@ public class Repackage { } /** Integrate sources from a downloaded jar file. */ - protected void processM2SourceJar(Path file, Path targetBundleDir) throws IOException { + void processM2SourceJar(Path file, Path bundleDir, M2Artifact mergingFrom) throws IOException { + A2Origin origin = new A2Origin(); + Path sourceDir = sourceBundles ? bundleDir.getParent().resolve(bundleDir.toString() + ".src") + : bundleDir.resolve("OSGI-OPT/src"); try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) { - Path targetSourceDir = sourceBundles - ? targetBundleDir.getParent().resolve(targetBundleDir.toString() + ".src") - : targetBundleDir.resolve("OSGI-OPT/src"); - Files.createDirectories(targetSourceDir); + String mergingMsg = ""; + if (mergingFrom != null) + mergingMsg = " of " + mergingFrom; + + Files.createDirectories(sourceDir); JarEntry entry; entries: while ((entry = jarIn.getNextJarEntry()) != null) { + String relPath = entry.getName(); if (entry.isDirectory()) continue entries; - if (entry.getName().startsWith("META-INF"))// skip META-INF entries + if (entry.getName().startsWith("META-INF")) {// skip META-INF entries + origin.deleted.add("META-INF directory from the sources" + mergingMsg); continue entries; - if (entry.getName().startsWith("module-info.java"))// skip META-INF entries + } + if (entry.getName().startsWith("module-info.java")) {// skip Java module information + origin.deleted.add("Java module information from the sources (module-info.java)" + mergingMsg); continue entries; - if (entry.getName().startsWith("/")) // absolute paths + } + if (entry.getName().startsWith("/")) { // absolute paths + int metaInfIndex = entry.getName().indexOf("META-INF"); + if (metaInfIndex >= 0) { + relPath = entry.getName().substring(metaInfIndex); + origin.moved.add(" to " + relPath + " entry with absolute path " + entry.getName()); + } else { + logger.log(WARNING, entry.getName() + " has an absolute path"); + origin.deleted.add(entry.getName() + " from the sources" + mergingMsg); + } continue entries; - Path target = targetSourceDir.resolve(entry.getName()); + } + Path target = sourceDir.resolve(relPath); Files.createDirectories(target.getParent()); if (!Files.exists(target)) { Files.copy(jarIn, target); @@ -564,16 +775,22 @@ public class Repackage { } } } - + // write the changes + if (sourceBundles) { + origin.appendChanges(sourceDir); + } else { + origin.added.add("source code under OSGI-OPT/src"); + origin.appendChanges(bundleDir); + } } /** 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"); @@ -583,7 +800,7 @@ public class Repackage { * 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); @@ -599,12 +816,12 @@ public class Repackage { try (InputStream in = Files.newInputStream(commonBnd)) { commonProps.load(in); } - String url = commonProps.getProperty(ManifestConstants.ARGEO_ORIGIN_URI.toString()); + String url = commonProps.getProperty(ARGEO_ORIGIN_URI.toString()); if (url == null) { url = uris.getProperty(duDir.getFileName().toString()); if (url == null) throw new IllegalStateException("No url available for " + duDir); - commonProps.put(ManifestConstants.ARGEO_ORIGIN_URI.toString(), url); + commonProps.put(ARGEO_ORIGIN_URI.toString(), url); } Path downloaded = tryDownloadArchive(url, originBase); @@ -634,6 +851,8 @@ public class Repackage { } } + // keys are the bundle directories + Map origins = new HashMap<>(); Files.walkFileTree(zipFs.getRootDirectories().iterator().next(), new SimpleFileVisitor() { @Override @@ -653,7 +872,9 @@ public class Repackage { Map map = new HashMap<>(); for (Object key : commonProps.keySet()) map.put(key.toString(), commonProps.getProperty(key.toString())); - processBundleJar(file, targetCategoryBase, map); + A2Origin origin = new A2Origin(); + Path bundleDir = processBundleJar(file, targetCategoryBase, map, origin); + origins.put(bundleDir, origin); logger.log(DEBUG, () -> "Processed " + file); } break includeMatchers; @@ -665,8 +886,10 @@ public class Repackage { DirectoryStream dirs = Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p) && p.getFileName().toString().indexOf('.') >= 0 && !p.getFileName().toString().endsWith(".src")); - for (Path dir : dirs) { - createJar(dir); + for (Path bundleDir : dirs) { + A2Origin origin = origins.get(bundleDir); + Objects.requireNonNull(origin, "No A2 origin found for " + bundleDir); + createJar(bundleDir, origin); } } catch (IOException e) { throw new RuntimeException("Cannot process " + duDir, e); @@ -675,34 +898,43 @@ public class Repackage { } /** 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; + A2Origin origin = new A2Origin(); + Path bundleDir; 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); - targetBundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); + bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); - Path targetSourceDir = sourceBundles - ? targetBundleDir.getParent().resolve(targetBundleDir.toString() + ".src") - : targetBundleDir.resolve("OSGI-OPT/src"); + Path sourceDir = sourceBundles ? bundleDir.getParent().resolve(bundleDir.toString() + ".src") + : bundleDir.resolve("OSGI-OPT/src"); - Files.createDirectories(targetSourceDir); + Files.createDirectories(sourceDir); JarEntry entry; entries: while ((entry = jarIn.getNextJarEntry()) != null) { if (entry.isDirectory()) continue entries; if (entry.getName().startsWith("META-INF"))// skip META-INF entries continue entries; - Path target = targetSourceDir.resolve(entry.getName()); + Path target = sourceDir.resolve(entry.getName()); Files.createDirectories(target.getParent()); Files.copy(jarIn, target); logger.log(TRACE, () -> "Copied source " + target); } + + // write the changes + if (sourceBundles) { + origin.appendChanges(sourceDir); + } else { + origin.added.add("source code under OSGI-OPT/src"); + origin.appendChanges(bundleDir); + } } } catch (IOException e) { throw new IllegalStateException("Cannot process " + file, e); @@ -712,18 +944,22 @@ public class Repackage { /* * COMMON PROCESSING */ - /** Normalise a bundle. */ - protected Path processBundleJar(Path file, Path targetBase, Map entries) throws IOException { + /** Normalise a single (that is, non-merged) bundle. */ + Path processBundleJar(Path file, Path targetBase, Map entries, A2Origin origin) throws IOException { +// boolean embed = Boolean.parseBoolean(entries.getOrDefault(ARGEO_ORIGIN_EMBED.toString(), "false").toString()); + boolean doNotModify = Boolean + .parseBoolean(entries.getOrDefault(ManifestHeader.ARGEO_DO_NOT_MODIFY.toString(), "false").toString()); NameVersion nameVersion; - Path targetBundleDir; + Path bundleDir; + // singleton + boolean isSingleton = false; + Manifest manifest; + Manifest sourceManifest; try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) { - Manifest sourceManifest = jarIn.getManifest(); - Manifest manifest = sourceManifest != null ? new Manifest(sourceManifest) : new Manifest(); + sourceManifest = jarIn.getManifest(); + manifest = sourceManifest != null ? new Manifest(sourceManifest) : new Manifest(); - // singleton - boolean isSingleton = false; - String rawSourceSymbolicName = manifest.getMainAttributes() - .getValue(ManifestConstants.BUNDLE_SYMBOLICNAME.toString()); + String rawSourceSymbolicName = manifest.getMainAttributes().getValue(BUNDLE_SYMBOLICNAME.toString()); if (rawSourceSymbolicName != null) { // make sure there is no directive String[] arr = rawSourceSymbolicName.split(";"); @@ -753,47 +989,76 @@ public class Repackage { nameVersion.setName(ourSymbolicName); } } - targetBundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); + bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); + + // copy original MANIFEST + if (sourceManifest != null) { + Path originalManifest = bundleDir.resolve(ARGEO_ORIGIN).resolve("MANIFEST.MF"); + Files.createDirectories(originalManifest.getParent()); + try (OutputStream out = Files.newOutputStream(originalManifest)) { + sourceManifest.write(out); + } + origin.moved.add("original MANIFEST to " + bundleDir.relativize(originalManifest)); + } // force Java 9 module name - entries.put(ManifestConstants.AUTOMATIC_MODULE_NAME.toString(), nameVersion.getName()); + entries.put(ManifestHeader.AUTOMATIC_MODULE_NAME.toString(), nameVersion.getName()); boolean isNative = false; String os = null; String arch = null; - if (targetBundleDir.startsWith(a2LibBase)) { + if (bundleDir.startsWith(a2LibBase)) { isNative = true; - Path libRelativePath = a2LibBase.relativize(targetBundleDir); + Path libRelativePath = a2LibBase.relativize(bundleDir); os = libRelativePath.getName(0).toString(); arch = libRelativePath.getName(1).toString(); } +// if (!embed) { // copy entries JarEntry entry; entries: while ((entry = jarIn.getNextJarEntry()) != null) { if (entry.isDirectory()) continue entries; - if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".SF")) - continue entries; - if (entry.getName().endsWith("module-info.class")) // skip Java 9 module info - continue entries; - if (entry.getName().startsWith("META-INF/versions/")) // skip multi-version - continue entries; - // skip file system providers as they cause issues with native image - if (entry.getName().startsWith("META-INF/services/java.nio.file.spi.FileSystemProvider")) - continue entries; - if (entry.getName().startsWith("OSGI-OPT/src/")) // skip embedded sources + if (!doNotModify) { + if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".DSA") + || entry.getName().endsWith(".SF")) { + origin.deleted.add("cryptographic signatures"); + continue entries; + } + if (entry.getName().endsWith("module-info.class")) { // skip Java 9 module info + origin.deleted.add("Java module information (module-info.class)"); + continue entries; + } + if (entry.getName().startsWith("META-INF/versions/")) { // skip multi-version + origin.deleted.add("additional Java versions (META-INF/versions)"); + continue entries; + } + if (entry.getName().startsWith("META-INF/maven/")) { + origin.deleted.add("Maven information (META-INF/maven)"); + continue entries; + } + // skip file system providers as they cause issues with native image + if (entry.getName().startsWith("META-INF/services/java.nio.file.spi.FileSystemProvider")) { + origin.deleted + .add("file system providers (META-INF/services/java.nio.file.spi.FileSystemProvider)"); + continue entries; + } + } + if (entry.getName().startsWith("OSGI-OPT/src/")) { // skip embedded sources + origin.deleted.add("embedded sources"); continue entries; - Path target = targetBundleDir.resolve(entry.getName()); + } + Path target = bundleDir.resolve(entry.getName()); Files.createDirectories(target.getParent()); Files.copy(jarIn, target); // native libraries if (isNative && (entry.getName().endsWith(".so") || entry.getName().endsWith(".dll") || entry.getName().endsWith(".jnilib"))) { - Path categoryDir = targetBundleDir.getParent(); + Path categoryDir = bundleDir.getParent(); boolean copyDll = false; - Path targetDll = categoryDir.resolve(targetBundleDir.relativize(target)); + Path targetDll = categoryDir.resolve(bundleDir.relativize(target)); if (nameVersion.getName().equals("com.sun.jna")) { if (arch.equals("x86_64")) arch = "x86-64"; @@ -813,49 +1078,141 @@ public class Repackage { Files.copy(target, targetDll); } Files.delete(target); + origin.deleted.add(bundleDir.relativize(target).toString()); } logger.log(TRACE, () -> "Copied " + target); +// } } + } + + // copy MANIFEST + Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF"); + Files.createDirectories(manifestPath.getParent()); - // copy MANIFEST - Path manifestPath = targetBundleDir.resolve("META-INF/MANIFEST.MF"); - Files.createDirectories(manifestPath.getParent()); + if (isSingleton && entries.containsKey(BUNDLE_SYMBOLICNAME.toString())) { + entries.put(BUNDLE_SYMBOLICNAME.toString(), + entries.get(BUNDLE_SYMBOLICNAME.toString()) + ";singleton:=true"); + } - if (isSingleton && entries.containsKey(BUNDLE_SYMBOLICNAME.toString())) { - entries.put(BUNDLE_SYMBOLICNAME.toString(), - entries.get(BUNDLE_SYMBOLICNAME.toString()) + ";singleton:=true"); - } +// if (embed) {// copy embedded jar +// Files.copy(file, bundleDir.resolve(file.getFileName())); +// entries.put(ManifestHeader.BUNDLE_CLASSPATH.toString(), file.getFileName().toString()); +// } - 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"); - else - logger.log(WARNING, file.getFileName() + ": " + key + " was " + previousValue - + ", overridden with " + value); + // Final MANIFEST decisions + // We also check the original OSGi metadata and compare with our changes + for (String key : entries.keySet()) { + String value = entries.get(key); + 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(DEBUG)) + logger.log(DEBUG, file.getFileName() + ": " + key + " was NOT modified, value kept is " + + previousValue + ", not overriden with " + value); + value = previousValue; } + } - // !! hack to remove unresolvable - if (key.equals("Provide-Capability") || key.equals("Require-Capability")) - if (nameVersion.getName().equals("osgi.core") || nameVersion.getName().equals("osgi.cmpn")) { - manifest.getMainAttributes().remove(key); - } + 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 if (BUNDLE_SYMBOLICNAME.toString().equals(key) || AUTOMATIC_MODULE_NAME.toString().equals(key)) + logger.log(DEBUG, + file.getFileName() + ": " + key + " was " + previousValue + ", overridden with " + value); + else + logger.log(WARNING, + file.getFileName() + ": " + key + " was " + previousValue + ", overridden with " + value); + origin.modified.add("MANIFEST header " + key); } - try (OutputStream out = Files.newOutputStream(manifestPath)) { - manifest.write(out); + + // !! hack to remove unresolvable + if (key.equals("Provide-Capability") || key.equals("Require-Capability")) + if (nameVersion.getName().equals("osgi.core") || nameVersion.getName().equals("osgi.cmpn")) { + manifest.getMainAttributes().remove(key); + origin.deleted.add("MANIFEST header " + key); + } + } + + // de-pollute MANIFEST + for (Iterator> manifestEntries = manifest.getMainAttributes().entrySet() + .iterator(); manifestEntries.hasNext();) { + Map.Entry manifestEntry = manifestEntries.next(); + switch (manifestEntry.getKey().toString()) { + case "Archiver-Version": + case "Build-By": + case "Created-By": + case "Originally-Created-By": + case "Tool": + case "Bnd-LastModified": + manifestEntries.remove(); + origin.deleted.add("MANIFEST header " + manifestEntry.getKey()); + break; + default: + if (sourceManifest != null && !sourceManifest.getMainAttributes().containsKey(manifestEntry.getKey())) + origin.added.add("MANIFEST header " + manifestEntry.getKey()); } } - return targetBundleDir; + + processLicense(bundleDir, manifest); + + origin.modified.add("MANIFEST (META-INF/MANIFEST.MF)"); + // write the MANIFEST + try (OutputStream out = Files.newOutputStream(manifestPath)) { + manifest.write(out); + } + return bundleDir; + } + + /** Process SPDX license identifier. */ + void processLicense(Path bundleDir, Manifest manifest) { + String spdxLicenceId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString()); + String bundleLicense = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString()); + if (spdxLicenceId == null) { + logger.log(ERROR, bundleDir.getFileName() + ": " + SPDX_LICENSE_IDENTIFIER + " not available, " + + BUNDLE_LICENSE + " is " + bundleLicense); + } else { + // only use the first licensing option + int orIndex = spdxLicenceId.indexOf(" OR "); + if (orIndex >= 0) + spdxLicenceId = spdxLicenceId.substring(0, orIndex).trim(); + + String bundleDirName = bundleDir.getFileName().toString(); + // force licenses of some well-known components + // even if we say otherwise (typically because from an Eclipse archive) + if (bundleDirName.startsWith("org.apache.")) + spdxLicenceId = "Apache-2.0"; + if (bundleDirName.startsWith("com.sun.jna.")) + spdxLicenceId = "Apache-2.0"; + if (bundleDirName.startsWith("com.ibm.icu.")) + spdxLicenceId = "ICU"; + if (bundleDirName.startsWith("javax.annotation.")) + spdxLicenceId = "GPL-2.0-only WITH Classpath-exception-2.0"; + if (bundleDirName.startsWith("javax.inject.")) + spdxLicenceId = "Apache-2.0"; + if (bundleDirName.startsWith("org.osgi.")) + spdxLicenceId = "Apache-2.0"; + + manifest.getMainAttributes().putValue(SPDX_LICENSE_IDENTIFIER.toString(), spdxLicenceId); + if (!licensesUsed.containsKey(spdxLicenceId)) + licensesUsed.put(spdxLicenceId, new TreeSet<>()); + licensesUsed.get(spdxLicenceId).add(bundleDir.getParent().getFileName() + "/" + bundleDir.getFileName()); + } } /* * 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() { @@ -876,21 +1233,21 @@ public class Repackage { } /** 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()); + String symbolicName = attrs.getValue(ManifestHeader.BUNDLE_SYMBOLICNAME.toString()); if (symbolicName == null) return null; // make sure there is no directive symbolicName = symbolicName.split(";")[0]; - String version = attrs.getValue(ManifestConstants.BUNDLE_VERSION.toString()); + String version = attrs.getValue(ManifestHeader.BUNDLE_VERSION.toString()); return new NameVersion(symbolicName, version); } /** 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 urlBases = null; String uriPrefix = null; @@ -927,12 +1284,12 @@ public class Repackage { * 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) { @@ -958,14 +1315,18 @@ public class Repackage { } /** Create a JAR file from a directory. */ - protected Path createJar(Path bundleDir) throws IOException { - // Create the jar - Path jarPath = bundleDir.getParent().resolve(bundleDir.getFileName() + ".jar"); + Path createJar(Path bundleDir, A2Origin origin) throws IOException { Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF"); Manifest manifest; try (InputStream in = Files.newInputStream(manifestPath)) { manifest = new Manifest(in); } + // legal requirements + origin.appendChanges(bundleDir); + createReadMe(bundleDir, manifest); + + // create the jar + Path jarPath = bundleDir.getParent().resolve(bundleDir.getFileName() + ".jar"); try (JarOutputStream jarOut = new JarOutputStream(Files.newOutputStream(jarPath), manifest)) { jarOut.setLevel(Deflater.DEFAULT_COMPRESSION); Files.walkFileTree(bundleDir, new SimpleFileVisitor() { @@ -985,100 +1346,154 @@ public class Repackage { } deleteDirectory(bundleDir); - if (sourceBundles) { - Path bundleCategoryDir = bundleDir.getParent(); - Path sourceDir = bundleCategoryDir.resolve(bundleDir.toString() + ".src"); - if (!Files.exists(sourceDir)) { - logger.log(WARNING, sourceDir + " does not exist, skipping..."); - return jarPath; + if (sourceBundles) + createSourceJar(bundleDir, manifest); - } + return jarPath; + } - Path relPath = a2Base.relativize(bundleCategoryDir); - Path srcCategoryDir = a2SrcBase.resolve(relPath); - Path srcJarP = srcCategoryDir.resolve(sourceDir.getFileName() + ".jar"); - Files.createDirectories(srcJarP.getParent()); - - String bundleSymbolicName = manifest.getMainAttributes().getValue("Bundle-SymbolicName").toString(); - // 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")); - - try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) { - srcJarOut.setLevel(Deflater.BEST_COMPRESSION); - Files.walkFileTree(sourceDir, new SimpleFileVisitor() { - - @Override - public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { - if (file.getFileName().toString().equals("MANIFEST.MF")) - return super.visitFile(file, attrs); - JarEntry entry = new JarEntry( - sourceDir.relativize(file).toString().replace(File.separatorChar, '/')); - srcJarOut.putNextEntry(entry); - Files.copy(file, srcJarOut); + /** Package sources separately, in the Eclipse-SourceBundle format. */ + void createSourceJar(Path bundleDir, Manifest manifest) throws IOException { + Path bundleCategoryDir = bundleDir.getParent(); + Path sourceDir = bundleCategoryDir.resolve(bundleDir.toString() + ".src"); + if (!Files.exists(sourceDir)) { + logger.log(WARNING, sourceDir + " does not exist, skipping..."); + return; + } + createReadMe(sourceDir, manifest); + + Path relPath = a2Base.relativize(bundleCategoryDir); + Path srcCategoryDir = a2SrcBase.resolve(relPath); + Path srcJarP = srcCategoryDir.resolve(sourceDir.getFileName() + ".jar"); + Files.createDirectories(srcJarP.getParent()); + + String bundleSymbolicName = manifest.getMainAttributes().getValue("Bundle-SymbolicName").toString(); + // in case there are additional directives + bundleSymbolicName = bundleSymbolicName.split(";")[0]; + Manifest srcManifest = new Manifest(); + 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); + Files.walkFileTree(sourceDir, new SimpleFileVisitor() { + + @Override + public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { + if (file.getFileName().toString().equals("MANIFEST.MF")) return super.visitFile(file, attrs); - } + JarEntry entry = new JarEntry( + sourceDir.relativize(file).toString().replace(File.separatorChar, '/')); + srcJarOut.putNextEntry(entry); + Files.copy(file, srcJarOut); + return super.visitFile(file, attrs); + } - }); + }); + } + deleteDirectory(sourceDir); + } + + /** + * Generate a readme clarifying and prominently notifying of the repackaging and + * modifications. + */ + void createReadMe(Path jarDir, Manifest manifest) throws IOException { + // write repackaged README + try (BufferedWriter writer = Files.newBufferedWriter(jarDir.resolve(README_REPACKAGED))) { + boolean merged = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2_MERGE.toString()) != null; + if (merged) + writer.append("This component is a merging of third party components" + + " in order to comply with A2 packaging standards.\n"); + else + writer.append("This component is a repackaging of a third party component" + + " in order to comply with A2 packaging standards.\n"); + + // license + String spdxLicenseId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString()); + if (spdxLicenseId == null) + throw new IllegalStateException("An SPDX license id must have beend defined at this stage."); + writer.append("\nIt is redistributed under the following license:\n\n"); + writer.append("SPDX-Identifier: " + spdxLicenseId + "\n\n"); + + if (!spdxLicenseId.startsWith("LicenseRef")) {// standard + int withIndex = spdxLicenseId.indexOf(" WITH "); + if (withIndex >= 0) { + String simpleId = spdxLicenseId.substring(0, withIndex).trim(); + String exception = spdxLicenseId.substring(withIndex + " WITH ".length()); + writer.append("which are available here: https://spdx.org/licenses/" + simpleId + + "\nand here: https://spdx.org/licenses/" + exception + "\n"); + } else { + writer.append("which is available here: https://spdx.org/licenses/" + spdxLicenseId + "\n"); + } + } else { + String url = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString()); + if (url != null) { + writer.write("which is available here: " + url + "\n"); + } else { + logger.log(ERROR, "No licne URL for " + jarDir); + } + } + writer.write("\n"); + + // origin + String m2Repo = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2_REPO.toString()); + String originDesc = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2.toString()); + if (originDesc != null) + writer.append("The original component has M2 coordinates:\n" + originDesc.replace(',', '\n') + "\n" + + (m2Repo != null ? "\nin M2 repository " + m2Repo + "\n" : "")); + else { + originDesc = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_URI.toString()); + if (originDesc != null) + writer.append("The original component comes from " + originDesc + ".\n"); + else + logger.log(ERROR, "Cannot find origin information in " + jarDir); + } + + writer.append("\nA detailed list of changes is available under " + CHANGES + ".\n"); + if (!jarDir.getFileName().endsWith(".src")) {// binary archive + if (sourceBundles) + writer.append("Corresponding sources are available in the related archive named " + + jarDir.toString() + ".src.jar.\n"); + else + writer.append("Corresponding sources are available under OSGI-OPT/src.\n"); } - deleteDirectory(sourceDir); } - return jarPath; } - /** MANIFEST headers. */ - enum ManifestConstants { - // OSGi - /** OSGi bundle symbolic name. */ - BUNDLE_SYMBOLICNAME("Bundle-SymbolicName"), // - /** OSGi bundle version. */ - BUNDLE_VERSION("Bundle-Version"), // -// BUNDLE_LICENSE("Bundle-License"), // - /** OSGi exported packages list. */ - EXPORT_PACKAGE("Export-Package"), // - /** OSGi imported packages list. */ - IMPORT_PACKAGE("Import-Package"), // - // Java - /** Java module name. */ - AUTOMATIC_MODULE_NAME("Automatic-Module-Name"), // - // Argeo Origin - /** - * Maven coordinates of the origin, possibly partial when using common.bnd or - * merge.bnd. - */ - ARGEO_ORIGIN_M2("Argeo-Origin-M2"), // - /** List of Maven coordinates to merge. */ - ARGEO_ORIGIN_M2_MERGE("Argeo-Origin-M2-Merge"), // - /** Maven repository if not the default one. */ - ARGEO_ORIGIN_M2_REPO("Argeo-Origin-M2-Repo"), // - /** - * Do not perform BND analysis of the origin component. Typically IMport_package - * and Export-Package will be kept untouched. - */ - ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED("Argeo-Origin-ManifestNotModified"), // - /** - * Origin (non-Maven) URI of the component. It may be anything (jar, archive, - * etc.). - */ - ARGEO_ORIGIN_URI("Argeo-Origin-URI"), // - ; - - final String value; + /** + * Gathers modifications performed on the original binaries and sources, + * especially in order to comply with their license requirements. + */ + class A2Origin { + A2Origin() { - private ManifestConstants(String value) { - this.value = value; } - @Override - public String toString() { - return value; + Set modified = new TreeSet<>(); + Set deleted = new TreeSet<>(); + Set added = new TreeSet<>(); + Set moved = new TreeSet<>(); + + /** Append changes to the A2-ORIGIN/changes file. */ + void appendChanges(Path baseDirectory) throws IOException { + Path changesFile = baseDirectory.resolve(CHANGES); + Files.createDirectories(changesFile.getParent()); + try (BufferedWriter writer = Files.newBufferedWriter(changesFile, APPEND, CREATE)) { + for (String msg : added) + writer.write("- Added " + msg + ".\n"); + for (String msg : modified) + writer.write("- Modified " + msg + ".\n"); + for (String msg : moved) + writer.write("- Moved " + msg + ".\n"); + for (String msg : deleted) + writer.write("- Deleted " + msg + ".\n"); + } } } }