X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FRepackage.java;h=2bbce7825b5e6149a3d1e57284d4bff810381dc5;hb=dbd921f63b5d59541dc2e0514716cee7be8bb11e;hp=e2a9e64b38b48176efc7be8b4ebf8ca8bf8931d6;hpb=abfc87b5d18e7c5a8db62b5aa086d8d5710c6f79;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Repackage.java b/src/org/argeo/build/Repackage.java index e2a9e64..2bbce78 100644 --- a/src/org/argeo/build/Repackage.java +++ b/src/org/argeo/build/Repackage.java @@ -8,7 +8,10 @@ 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_MERGE; import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_M2_REPO; +import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_URI; +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; @@ -16,6 +19,7 @@ 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.BufferedWriter; import java.io.File; import java.io.FileNotFoundException; import java.io.IOException; @@ -43,7 +47,9 @@ import java.util.List; 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; @@ -60,16 +66,20 @@ import aQute.bnd.osgi.Jar; * 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; + /** Whether repackaging should run in parallel or sequentially. */ + final static boolean parallel = true; + + // cache + /** Summary of all license seen during the repackaging. */ + final static Map> licensesUsed = new TreeMap<>(); /** Main entry point. */ public static void main(String[] args) { @@ -90,31 +100,45 @@ public class Repackage { 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"; + /** 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 A2_ORIGIN = "A2-ORIGIN"; /** 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> mirrors = new HashMap>(); + 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) { @@ -218,16 +242,21 @@ public class Repackage { URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact); Path downloaded = downloadMaven(url, artifact); - Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact); + A2Origin origin = new A2Origin(); + Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact, origin); downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir); - createJar(targetBundleDir); + createJar(targetBundleDir, origin); } catch (Exception e) { throw new RuntimeException("Cannot process " + bndFile, e); } } - /** Process multiple Maven artifacts. */ + /** + * 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. + */ void processM2BasedDistributionUnit(Path duDir) { try { Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent()); @@ -273,7 +302,7 @@ public class Repackage { 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); @@ -282,7 +311,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(); @@ -298,9 +327,10 @@ public class Repackage { URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact); Path downloaded = downloadMaven(url, artifact); - Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergeProps, artifact); + A2Origin origin = new A2Origin(); + Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergeProps, artifact, origin); downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir); - createJar(targetBundleDir); + createJar(targetBundleDir, origin); } } catch (IOException e) { throw new RuntimeException("Cannot process " + duDir, e); @@ -327,23 +357,23 @@ public class Repackage { 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()); String[] artifacts = artifactsStr.split(","); artifacts: for (String str : artifacts) { @@ -360,29 +390,44 @@ 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/")) + if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".SF")) { + origin.deleted.add("cryptographic signatures from " + artifact); continue entries; - else if (entry.getName().equals("module-info.class")) - continue entries; - else if (entry.getName().equals("META-INF/NOTICE")) - continue entries; - else if (entry.getName().equals("META-INF/NOTICE.txt")) + } + 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/LICENSE")) + } + 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.md")) + } + if (entry.getName().equals("META-INF/DEPENDENCIES")) { + origin.deleted.add("dependency list (META-INF/DEPENDENCIES) from " + artifact); continue entries; - else if (entry.getName().equals("META-INF/LICENSE-notice.md")) + } + 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/DEPENDENCIES")) + } + if (entry.getName().startsWith(".cache/")) { // Apache SSHD + origin.deleted.add("cache directory (.cache) 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(A2_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); @@ -393,6 +438,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; @@ -402,16 +448,16 @@ public class Repackage { } logger.log(TRACE, () -> "Copied " + target); } - } - downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir); + origin.added.add("binary content of " + artifact); + downloadAndProcessM2Sources(repoStr, artifact, bundleDir); } // 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()); @@ -424,7 +470,7 @@ public class Repackage { 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(); @@ -447,7 +493,7 @@ 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); @@ -457,19 +503,19 @@ public class Repackage { try (OutputStream out = Files.newOutputStream(manifestPath)) { manifest.write(out); } - createJar(targetBundleDir); + createJar(bundleDir, origin); } /** Generate MANIFEST using BND. */ - Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact) { + 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 - + // Note: we always force the symbolic name if (doNotModify) { fileEntries: for (Object key : fileProps.keySet()) { if (ManifestConstants.ARGEO_ORIGIN_M2.toString().equals(key)) @@ -514,7 +560,7 @@ public class Repackage { } } } - Path targetBundleDir = processBundleJar(downloaded, targetCategoryBase, additionalEntries); + Path targetBundleDir = processBundleJar(downloaded, targetCategoryBase, additionalEntries, origin); logger.log(DEBUG, () -> "Processed " + downloaded); return targetBundleDir; } catch (Exception e) { @@ -538,24 +584,32 @@ public class Repackage { } /** Integrate sources from a downloaded jar file. */ - void processM2SourceJar(Path file, Path targetBundleDir) throws IOException { + void processM2SourceJar(Path file, Path bundleDir) throws IOException { try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) { - Path targetSourceDir = sourceBundles - ? targetBundleDir.getParent().resolve(targetBundleDir.toString() + ".src") - : targetBundleDir.resolve("OSGI-OPT/src"); + A2Origin origin = new A2Origin(); + 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 + if (entry.getName().startsWith("META-INF")) {// skip META-INF entries + origin.deleted.add("META-INF directory from the sources"); 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)"); continue entries; - if (entry.getName().startsWith("/")) // absolute paths + } + if (entry.getName().startsWith("/")) { // absolute paths + // TODO does it really happen? + logger.log(WARNING, entry.getName() + " has an absolute path"); + origin.deleted.add(entry.getName() + " from the sources"); continue entries; - Path target = targetSourceDir.resolve(entry.getName()); + } + Path target = sourceDir.resolve(entry.getName()); Files.createDirectories(target.getParent()); if (!Files.exists(target)) { Files.copy(jarIn, target); @@ -564,6 +618,13 @@ public class Repackage { logger.log(TRACE, () -> target + " already exists, skipping..."); } } + // write the changes + if (sourceBundles) { + origin.appendChanges(sourceDir); + } else { + origin.added.add("source code under OSGI-OPT/src"); + origin.appendChanges(bundleDir); + } } } @@ -600,12 +661,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); @@ -635,6 +696,8 @@ public class Repackage { } } + // keys are the bundle directories + Map origins = new HashMap<>(); Files.walkFileTree(zipFs.getRootDirectories().iterator().next(), new SimpleFileVisitor() { @Override @@ -654,7 +717,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 bundleDirectory = processBundleJar(file, targetCategoryBase, map, origin); + origins.put(bundleDirectory, origin); logger.log(DEBUG, () -> "Processed " + file); } break includeMatchers; @@ -667,7 +732,9 @@ 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); + A2Origin origin = origins.get(dir); + Objects.requireNonNull(origin, "No A2 origin found for " + dir); + createJar(dir, origin); } } catch (IOException e) { throw new RuntimeException("Cannot process " + duDir, e); @@ -715,17 +782,16 @@ public class Repackage { * COMMON PROCESSING */ /** Normalise a bundle. */ - Path processBundleJar(Path file, Path targetBase, Map entries) throws IOException { + Path processBundleJar(Path file, Path targetBase, Map entries, A2Origin origin) throws IOException { NameVersion nameVersion; - Path targetBundleDir; + Path bundleDir; try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) { Manifest sourceManifest = jarIn.getManifest(); Manifest 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(";"); @@ -755,7 +821,7 @@ public class Repackage { nameVersion.setName(ourSymbolicName); } } - targetBundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); + bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); // force Java 9 module name entries.put(ManifestConstants.AUTOMATIC_MODULE_NAME.toString(), nameVersion.getName()); @@ -763,9 +829,9 @@ public class Repackage { 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(); } @@ -775,27 +841,38 @@ public class Repackage { entries: while ((entry = jarIn.getNextJarEntry()) != null) { if (entry.isDirectory()) continue entries; - if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".SF")) + if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".SF")) { + origin.deleted.add("cryptographic signatures"); continue entries; - if (entry.getName().endsWith("module-info.class")) // skip Java 9 module info + } + 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 + } + if (entry.getName().startsWith("META-INF/versions/")) { // skip multi-version + origin.deleted.add("additional Java versions (META-INF/versions)"); 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")) + 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 + } + 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"; @@ -820,7 +897,7 @@ public class Repackage { } // copy MANIFEST - Path manifestPath = targetBundleDir.resolve("META-INF/MANIFEST.MF"); + Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF"); Files.createDirectories(manifestPath.getParent()); if (isSingleton && entries.containsKey(BUNDLE_SYMBOLICNAME.toString())) { @@ -844,8 +921,8 @@ public class Repackage { keepPrevious = true; if (keepPrevious) { - if (logger.isLoggable(TRACE)) - logger.log(TRACE, file.getFileName() + ": " + key + " was NOT modified, value kept is " + if (logger.isLoggable(DEBUG)) + logger.log(DEBUG, file.getFileName() + ": " + key + " was NOT modified, value kept is " + previousValue + ", not overriden with " + value); value = previousValue; } @@ -866,11 +943,26 @@ public class Repackage { manifest.getMainAttributes().remove(key); } } + + // license 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()); + } + + // write the MANIFEST try (OutputStream out = Files.newOutputStream(manifestPath)) { manifest.write(out); } } - return targetBundleDir; + origin.modified.add("jar MANIFEST (META-INF/MANIFEST.MF"); + return bundleDir; } /* @@ -980,7 +1072,9 @@ public class Repackage { } /** Create a JAR file from a directory. */ - Path createJar(Path bundleDir) throws IOException { + Path createJar(Path bundleDir, A2Origin origin) throws IOException { + // write changes + origin.appendChanges(bundleDir); // Create the jar Path jarPath = bundleDir.getParent().resolve(bundleDir.getFileName() + ".jar"); Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF"); @@ -1062,6 +1156,8 @@ public class Repackage { 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. */ @@ -1070,8 +1166,14 @@ public class Repackage { /** 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 /** @@ -1081,7 +1183,7 @@ public class Repackage { 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. */ + /** 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 @@ -1108,6 +1210,34 @@ public class Repackage { } } +/** + * Gathers modifications performed on the original binaries and sources, + * especially in order to comply with their license requirements. + */ +class A2Origin { + 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("A2-ORIGIN/changes"); + Files.createDirectories(changesFile.getParent()); + try (BufferedWriter writer = Files.newBufferedWriter(changesFile, StandardOpenOption.APPEND, + StandardOpenOption.CREATE)) { + for (String msg : modified) + writer.write("- Modified " + msg + ".\n"); + for (String msg : added) + writer.write("- Added " + msg + ".\n"); + for (String msg : deleted) + writer.write("- Deleted " + msg + ".\n"); + for (String msg : moved) + writer.write("- Moved " + msg + ".\n"); + } + } +} + /** Simple representation of an M2 artifact. */ class M2Artifact extends CategoryNameVersion { private String classifier;