X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FRepackage.java;h=88b2f37a44fbd81854344baa11b05639c56bb6af;hb=a6ebf62be67d594d8c05eb56036ba4816c43c6e5;hp=65317e5ad5b98ff65a951b87ff1f67f9d75bf005;hpb=fcab5f7ad558e61a6be56762b1ea460f4a80b1c8;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Repackage.java b/src/org/argeo/build/Repackage.java index 65317e5..88b2f37 100644 --- a/src/org/argeo/build/Repackage.java +++ b/src/org/argeo/build/Repackage.java @@ -7,8 +7,12 @@ 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_EMBED; 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_MANIFEST_NOT_MODIFIED; +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; @@ -17,6 +21,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; @@ -35,6 +40,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; @@ -71,10 +77,11 @@ public class Repackage { */ final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES"; - /** Whethere repackaging should run in parallel or sequentially. */ + /** 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. */ @@ -97,32 +104,41 @@ public class Repackage { } CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join(); - logger.log(INFO, "# License summary:"); + // Summary + StringBuilder sb = new StringBuilder(); for (String licenseId : licensesUsed.keySet()) for (String name : licensesUsed.get(licenseId)) - logger.log(INFO, licenseId + "\t" + name); + sb.append((licenseId.equals("") ? "Proprietary" : licenseId) + "\t\t" + name + "\n"); + logger.log(INFO, "# License summary:\n" + sb); } + /** 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 */ - Path originBase; + final Path originBase; /** Directory where to download Maven artifacts */ - Path mavenBase; + final Path mavenBase; /** A2 repository base for binary bundles */ - Path a2Base; + final Path a2Base; /** A2 repository base for source bundles */ - Path a2SrcBase; + final Path a2SrcBase; /** A2 base for native components */ - Path a2LibBase; + final Path a2LibBase; /** Location of the descriptors driving the packaging */ - Path descriptorsBase; + final Path descriptorsBase; /** URIs of archives to download */ - Properties uris = new Properties(); + final Properties uris = new Properties(); /** Mirrors for archive download. Key is URI prefix, value list of base URLs */ - Map> mirrors = new HashMap>(); + final Map> mirrors = new HashMap>(); /** Whether sources should be packaged separately */ final boolean sourceBundles; @@ -229,16 +245,40 @@ 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(ManifestConstants.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(unmodifiedTarget, 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. */ + /** + * 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()); @@ -284,7 +324,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); @@ -293,7 +333,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(); @@ -309,9 +349,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); @@ -338,23 +379,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) { @@ -371,29 +412,55 @@ 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")) + } + 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(A2_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(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); @@ -404,6 +471,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; @@ -413,29 +481,32 @@ 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()); } } 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(); @@ -458,7 +529,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); @@ -468,22 +539,21 @@ 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()); + boolean doNotModifyManifest = Boolean.parseBoolean( + fileProps.getOrDefault(ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED.toString(), "false").toString()); - // we always force the symbolic name - - if (doNotModify) { + // Note: we always force the symbolic name + if (doNotModifyManifest) { 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()); additionalEntries.put(key.toString(), value); @@ -525,7 +595,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) { @@ -535,12 +605,13 @@ public class Repackage { } /** Download and integrates sources for a single Maven artifact. */ - void downloadAndProcessM2Sources(String repoStr, M2Artifact artifact, Path targetBundleDir) throws IOException { + 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); @@ -549,24 +620,36 @@ public class Repackage { } /** Integrate sources from a downloaded jar file. */ - 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) { 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 + // TODO does it really happen? + 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(entry.getName()); Files.createDirectories(target.getParent()); if (!Files.exists(target)) { Files.copy(jarIn, target); @@ -576,7 +659,13 @@ 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. */ @@ -611,12 +700,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); @@ -646,6 +735,8 @@ public class Repackage { } } + // keys are the bundle directories + Map origins = new HashMap<>(); Files.walkFileTree(zipFs.getRootDirectories().iterator().next(), new SimpleFileVisitor() { @Override @@ -665,7 +756,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; @@ -677,8 +770,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); @@ -689,7 +784,8 @@ public class Repackage { /** Process sources in Eclipse format. */ 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(); @@ -698,24 +794,31 @@ public class Repackage { 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); @@ -726,17 +829,18 @@ 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 { + boolean embed = Boolean.parseBoolean(entries.getOrDefault(ARGEO_ORIGIN_EMBED.toString(), "false").toString()); NameVersion nameVersion; - Path targetBundleDir; + Path bundleDir; + // singleton + boolean isSingleton = false; + Manifest manifest; try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) { Manifest sourceManifest = jarIn.getManifest(); - Manifest manifest = sourceManifest != null ? new Manifest(sourceManifest) : new 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(";"); @@ -766,7 +870,16 @@ public class Repackage { nameVersion.setName(ourSymbolicName); } } - targetBundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); + bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); + + if (sourceManifest != null) {// copy original MANIFEST + Path originalManifest = bundleDir.resolve(A2_ORIGIN).resolve("MANIFEST.MF"); + Files.createDirectories(originalManifest.getParent()); + try (OutputStream out = Files.newOutputStream(originalManifest)) { + sourceManifest.write(out); + } + origin.added.add("original MANIFEST (" + bundleDir.relativize(originalManifest) + ")"); + } // force Java 9 module name entries.put(ManifestConstants.AUTOMATIC_MODULE_NAME.toString(), nameVersion.getName()); @@ -774,127 +887,166 @@ 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(); } - // 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 - continue entries; - Path target = targetBundleDir.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(); - boolean copyDll = false; - Path targetDll = categoryDir.resolve(targetBundleDir.relativize(target)); - if (nameVersion.getName().equals("com.sun.jna")) { - if (arch.equals("x86_64")) - arch = "x86-64"; - if (os.equals("macosx")) - os = "darwin"; - if (target.getParent().getFileName().toString().equals(os + "-" + arch)) { + 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(".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 = 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 = bundleDir.getParent(); + boolean copyDll = false; + Path targetDll = categoryDir.resolve(bundleDir.relativize(target)); + if (nameVersion.getName().equals("com.sun.jna")) { + if (arch.equals("x86_64")) + arch = "x86-64"; + if (os.equals("macosx")) + os = "darwin"; + if (target.getParent().getFileName().toString().equals(os + "-" + arch)) { + copyDll = true; + } + targetDll = categoryDir.resolve(target.getFileName()); + } else { copyDll = true; } - targetDll = categoryDir.resolve(target.getFileName()); - } else { - copyDll = true; - } - if (copyDll) { - Files.createDirectories(targetDll.getParent()); - if (Files.exists(targetDll)) - Files.delete(targetDll); - Files.copy(target, targetDll); + if (copyDll) { + Files.createDirectories(targetDll.getParent()); + if (Files.exists(targetDll)) + Files.delete(targetDll); + Files.copy(target, targetDll); + } + Files.delete(target); + origin.deleted.add(bundleDir.relativize(target).toString()); } - Files.delete(target); + logger.log(TRACE, () -> "Copied " + target); } - 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(ManifestConstants.BUNDLE_CLASSPATH.toString(), file.getFileName().toString()); + } - // 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); - 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) + // 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); + 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; - 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); + 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); - } } - // last checks - String spdxLicenceId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString()); - String bundleLicense = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString()); - if (spdxLicenceId == null) { - logger.log(WARNING, 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(file.getFileName().toString()); + 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); } - try (OutputStream out = Files.newOutputStream(manifestPath)) { - manifest.write(out); + // de-pollute MANIFEST + switch (key) { + case "Archiver-Version": + case "Build-By": + case "Created-By": + case "Originally-Created-By": + case "Tool": + case "Bnd-LastModified": + manifest.getMainAttributes().remove(key); + break; + default: // do nothing } + + // !! 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); + } + } + + // 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()); + } + + origin.modified.add("jar MANIFEST (META-INF/MANIFEST.MF)"); + // write the MANIFEST + try (OutputStream out = Files.newOutputStream(manifestPath)) { + manifest.write(out); } - return targetBundleDir; + return bundleDir; } /* @@ -1004,7 +1156,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"); @@ -1031,52 +1185,55 @@ 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(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); - } + 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; - }); - } - deleteDirectory(sourceDir); } - 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(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); } /** MANIFEST headers. */ @@ -1092,6 +1249,8 @@ public class Repackage { 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"), // @@ -1113,13 +1272,23 @@ 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 * and Export-Package will be kept untouched. */ ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED("Argeo-Origin-ManifestNotModified"), // + /** + * 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.). @@ -1140,6 +1309,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 : 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"); + } + } +} + /** Simple representation of an M2 artifact. */ class M2Artifact extends CategoryNameVersion { private String classifier;