X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FRepackage.java;h=88b2f37a44fbd81854344baa11b05639c56bb6af;hb=a6ebf62be67d594d8c05eb56036ba4816c43c6e5;hp=7aa26b9756811e027a5c7bc44d23fbfa70d071d1;hpb=c74c069af4612100592e3cb2bd33ea34f7f79449;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Repackage.java b/src/org/argeo/build/Repackage.java index 7aa26b9..88b2f37 100644 --- a/src/org/argeo/build/Repackage.java +++ b/src/org/argeo/build/Repackage.java @@ -1,18 +1,33 @@ package org.argeo.build; import static java.lang.System.Logger.Level.DEBUG; +import static java.lang.System.Logger.Level.ERROR; +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 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; +import static org.argeo.build.Repackage.ManifestConstants.ECLIPSE_SOURCE_BUNDLE; import static org.argeo.build.Repackage.ManifestConstants.EXPORT_PACKAGE; -import static org.argeo.build.Repackage.ManifestConstants.SLC_ORIGIN_M2; -import static org.argeo.build.Repackage.ManifestConstants.SLC_ORIGIN_M2_REPO; +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; import java.io.InputStream; import java.io.OutputStream; import java.lang.System.Logger; -import java.lang.System.Logger.Level; import java.net.MalformedURLException; import java.net.URL; import java.nio.charset.StandardCharsets; @@ -25,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; @@ -34,7 +50,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; @@ -46,11 +64,25 @@ import java.util.zip.Deflater; import aQute.bnd.osgi.Analyzer; import aQute.bnd.osgi.Jar; -/** The central class for A2 packaging. */ +/** + * Simple tool repackaging 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()); - private final static String ENV_BUILD_SOURCE_BUNDLES = "BUILD_SOURCE_BUNDLES"; + /** + * Environment variable on whether sources should be packaged separately or + * integrated in the bundles. + */ + final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES"; + + /** 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) { @@ -65,36 +97,66 @@ public class Repackage { List> toDos = new ArrayList<>(); for (int i = 1; i < args.length; i++) { Path p = Paths.get(args[i]); - toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(p))); + if (parallel) + toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(p))); + else + factory.processCategory(p); } 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"; - private Path originBase; - private Path a2Base; - private Path a2LibBase; - private Path descriptorsBase; - - private Properties uris = new Properties(); - - /** key is URI prefix, value list of base URLs */ - private Map> mirrors = new HashMap>(); - - private final boolean sourceBundles; + // 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); + } + /** 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 */ + final Path originBase; + /** Directory where to download Maven artifacts */ + final Path mavenBase; + + /** A2 repository base for binary bundles */ + final Path a2Base; + /** A2 repository base for source bundles */ + final Path a2SrcBase; + /** A2 base for native components */ + final Path a2LibBase; + /** Location of the descriptors driving the packaging */ + final Path descriptorsBase; + /** URIs of archives to download */ + final Properties uris = new Properties(); + /** Mirrors for archive download. Key is URI prefix, value list of base URLs */ + final Map> mirrors = new HashMap>(); + + /** Whether sources should be packaged separately */ + final boolean sourceBundles; + + /** Constructor initialises the various variables */ public Repackage(Path a2Base, Path descriptorsBase) { - sourceBundles = Boolean.parseBoolean(System.getenv(ENV_BUILD_SOURCE_BUNDLES)); + sourceBundles = Boolean.parseBoolean(System.getenv(ENV_SOURCE_BUNDLES)); if (sourceBundles) - logger.log(Level.INFO, "Sources will be packaged separately"); + logger.log(INFO, "Sources will be packaged separately"); Objects.requireNonNull(a2Base); Objects.requireNonNull(descriptorsBase); this.originBase = Paths.get(System.getProperty("user.home"), ".cache", "argeo/build/origin"); + this.mavenBase = Paths.get(System.getProperty("user.home"), ".m2", "repository"); + // TODO define and use a build base this.a2Base = a2Base; + this.a2SrcBase = a2Base.getParent().resolve(a2Base.getFileName() + ".src"); this.a2LibBase = a2Base.resolve("lib"); this.descriptorsBase = descriptorsBase; if (!Files.exists(this.descriptorsBase)) @@ -125,16 +187,14 @@ public class Repackage { it.remove(); } } - mirrors.put("http://www.eclipse.org/downloads", eclipseMirrors); } /* * 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, @@ -158,9 +218,8 @@ public class Repackage { } /** Process a standalone Maven artifact. */ - public void processSingleM2ArtifactDistributionUnit(Path bndFile) { + void processSingleM2ArtifactDistributionUnit(Path bndFile) { try { -// String category = bndFile.getParent().getFileName().toString(); Path categoryRelativePath = descriptorsBase.relativize(bndFile.getParent()); Path targetCategoryBase = a2Base.resolve(categoryRelativePath); @@ -168,8 +227,8 @@ public class Repackage { try (InputStream in = Files.newInputStream(bndFile)) { fileProps.load(in); } - String repoStr = fileProps.containsKey(SLC_ORIGIN_M2_REPO.toString()) - ? fileProps.getProperty(SLC_ORIGIN_M2_REPO.toString()) + String repoStr = fileProps.containsKey(ARGEO_ORIGIN_M2_REPO.toString()) + ? fileProps.getProperty(ARGEO_ORIGIN_M2_REPO.toString()) : null; if (!fileProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) { @@ -179,49 +238,68 @@ public class Repackage { fileProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName); } - String m2Coordinates = fileProps.getProperty(SLC_ORIGIN_M2.toString()); + String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString()); if (m2Coordinates == null) throw new IllegalArgumentException("No M2 coordinates available for " + bndFile); M2Artifact artifact = new M2Artifact(m2Coordinates); URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact); - Path downloaded = download(url, originBase, artifact); - - Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact); - - downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir); + Path downloaded = downloadMaven(url, artifact); + + // 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. */ - 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. + */ + void processM2BasedDistributionUnit(Path duDir) { try { - // String category = duDir.getParent().getFileName().toString(); Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent()); Path targetCategoryBase = a2Base.resolve(categoryRelativePath); - // merge Path mergeBnd = duDir.resolve(MERGE_BND); - if (Files.exists(mergeBnd)) { + if (Files.exists(mergeBnd)) // merge mergeM2Artifacts(mergeBnd); -// return; - } Path commonBnd = duDir.resolve(COMMON_BND); - if (!Files.exists(commonBnd)) { + if (!Files.exists(commonBnd)) return; - } + Properties commonProps = new Properties(); try (InputStream in = Files.newInputStream(commonBnd)) { commonProps.load(in); } - String m2Version = commonProps.getProperty(SLC_ORIGIN_M2.toString()); + String m2Version = commonProps.getProperty(ARGEO_ORIGIN_M2.toString()); if (m2Version == null) { - logger.log(Level.WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit"); + logger.log(WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit"); return;// ignore, this is probably an Eclipse archive } if (!m2Version.startsWith(":")) { @@ -237,9 +315,8 @@ public class Repackage { try (InputStream in = Files.newInputStream(p)) { fileProps.load(in); } - String m2Coordinates = fileProps.getProperty(SLC_ORIGIN_M2.toString()); + String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString()); M2Artifact artifact = new M2Artifact(m2Coordinates); - artifact.setVersion(m2Version); // prepare manifest entries @@ -247,16 +324,16 @@ public class Repackage { mergeProps.putAll(commonProps); fileEntries: for (Object key : fileProps.keySet()) { - if (ManifestConstants.SLC_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); if (previousValue != null) { - logger.log(Level.WARNING, + logger.log(WARNING, commonBnd + ": " + key + " was " + previousValue + ", overridden with " + value); } } - mergeProps.put(ManifestConstants.SLC_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(); @@ -264,30 +341,26 @@ public class Repackage { mergeProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName); } - String repoStr = mergeProps.containsKey(SLC_ORIGIN_M2_REPO.toString()) - ? mergeProps.getProperty(SLC_ORIGIN_M2_REPO.toString()) + String repoStr = mergeProps.containsKey(ARGEO_ORIGIN_M2_REPO.toString()) + ? mergeProps.getProperty(ARGEO_ORIGIN_M2_REPO.toString()) : null; // download URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact); - Path downloaded = download(url, originBase, artifact); - - Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergeProps, artifact); -// logger.log(Level.DEBUG, () -> "Processed " + downloaded); - - // sources - downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir); + Path downloaded = downloadMaven(url, artifact); - 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); } - } /** 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); @@ -297,28 +370,32 @@ public class Repackage { mergeProps.load(in); } - // Version - String m2Version = mergeProps.getProperty(SLC_ORIGIN_M2.toString()); + String m2Version = mergeProps.getProperty(ARGEO_ORIGIN_M2.toString()); if (m2Version == null) { - logger.log(Level.WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit"); + logger.log(WARNING, "Ignoring " + 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(ARGEO_ORIGIN_M2_MERGE.toString()); + if (artifactsStr == null) + throw new IllegalArgumentException(mergeBnd + ": " + ARGEO_ORIGIN_M2_MERGE + " must be set"); - String artifactsStr = mergeProps.getProperty(ManifestConstants.SLC_ORIGIN_M2_MERGE.toString()); - String repoStr = mergeProps.containsKey(SLC_ORIGIN_M2_REPO.toString()) - ? mergeProps.getProperty(SLC_ORIGIN_M2_REPO.toString()) + 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) { @@ -329,35 +406,61 @@ public class Repackage { if (artifact.getVersion() == null) artifact.setVersion(m2Version); URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact); - Path downloaded = download(url, originBase, artifact); + Path downloaded = downloadMaven(url, artifact); JarEntry entry; try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(downloaded), false)) { 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); @@ -366,40 +469,44 @@ public class Repackage { try (OutputStream out = Files.newOutputStream(target, StandardOpenOption.APPEND)) { out.write("\n".getBytes()); jarIn.transferTo(out); - logger.log(Level.WARNING, artifact.getArtifactId() + " - Appended " + entry.getName()); + 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(Level.WARNING, "Skip " + entry.getName()); + logger.log(TRACE, "Skip " + entry.getName()); continue entries; } else { throw new IllegalStateException("File " + target + " from " + artifact + " already exists"); } } - logger.log(Level.TRACE, () -> "Copied " + target); + 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(Level.WARNING, "Appended " + p); + 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(); @@ -416,15 +523,13 @@ public class Repackage { && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) continue keys;// hack for very old classes entries.put(key.toString(), value.toString()); - // logger.log(DEBUG, () -> key + "=" + value); - } } catch (Exception e) { throw new RuntimeException("Cannot process " + mergeBnd, e); } 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); @@ -434,22 +539,21 @@ public class Repackage { 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) { - + Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact, + A2Origin origin) { try { Map additionalEntries = new TreeMap<>(); - boolean doNotModify = Boolean.parseBoolean(fileProps - .getOrDefault(ManifestConstants.SLC_ORIGIN_MANIFEST_NOT_MODIFIED.toString(), "false").toString()); - - // we always force the symbolic name + boolean doNotModifyManifest = Boolean.parseBoolean( + fileProps.getOrDefault(ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED.toString(), "false").toString()); - if (doNotModify) { + // Note: we always force the symbolic name + if (doNotModifyManifest) { fileEntries: for (Object key : fileProps.keySet()) { - if (ManifestConstants.SLC_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); @@ -486,15 +590,13 @@ public class Repackage { } if ("Require-Capability".equals(key.toString()) && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) - continue keys;// hack for very old classes + continue keys;// !! hack for very old classes additionalEntries.put(key.toString(), value.toString()); - // logger.log(DEBUG, () -> key + "=" + value); - } } } - Path targetBundleDir = processBundleJar(downloaded, targetCategoryBase, additionalEntries); - logger.log(Level.DEBUG, () -> "Processed " + downloaded); + Path targetBundleDir = processBundleJar(downloaded, targetCategoryBase, additionalEntries, origin); + logger.log(DEBUG, () -> "Processed " + downloaded); return targetBundleDir; } catch (Exception e) { throw new RuntimeException("Cannot BND process " + downloaded, e); @@ -503,84 +605,93 @@ 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 { - if (sourceBundles) - return; try { M2Artifact sourcesArtifact = new M2Artifact(artifact.toM2Coordinates(), "sources"); URL sourcesUrl = M2ConventionsUtils.mavenRepoUrl(repoStr, sourcesArtifact); - Path sourcesDownloaded = download(sourcesUrl, originBase, artifact, true); - processM2SourceJar(sourcesDownloaded, targetBundleDir); - logger.log(Level.TRACE, () -> "Processed source " + sourcesDownloaded); + Path sourcesDownloaded = downloadMaven(sourcesUrl, artifact, true); + processM2SourceJar(sourcesDownloaded, targetBundleDir, merging ? artifact : null); + logger.log(TRACE, () -> "Processed source " + sourcesDownloaded); } catch (Exception e) { - logger.log(Level.ERROR, () -> "Cannot download source for " + artifact); + logger.log(ERROR, () -> "Cannot download source for " + artifact); } } /** 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 = targetBundleDir.resolve("OSGI-OPT/src"); - // TODO make it less dangerous? - if (Files.exists(targetSourceDir)) { -// deleteDirectory(targetSourceDir); - } else { - Files.createDirectories(targetSourceDir); - } + String mergingMsg = ""; + if (mergingFrom != null) + mergingMsg = " of " + mergingFrom; - // copy entries + 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); - logger.log(Level.TRACE, () -> "Copied source " + target); + logger.log(TRACE, () -> "Copied source " + target); } else { - logger.log(Level.WARNING, () -> target + " already exists, skipping..."); + 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); + } } /** Download a Maven artifact. */ - protected Path download(URL url, Path dir, M2Artifact artifact) throws IOException { - return download(url, dir, artifact, false); + Path downloadMaven(URL url, M2Artifact artifact) throws IOException { + return downloadMaven(url, artifact, false); } /** Download a Maven artifact. */ - protected Path download(URL url, Path dir, M2Artifact artifact, boolean sources) throws IOException { - return download(url, dir, artifact.getGroupId() + '/' + artifact.getArtifactId() + "-" + artifact.getVersion() - + (sources ? "-sources" : "") + ".jar"); + Path downloadMaven(URL url, M2Artifact artifact, boolean sources) throws IOException { + return download(url, mavenBase, artifact.getGroupId().replace(".", "/") // + + '/' + artifact.getArtifactId() + '/' + artifact.getVersion() // + + '/' + artifact.getArtifactId() + "-" + artifact.getVersion() + (sources ? "-sources" : "") + ".jar"); } /* * ECLIPSE ORIGIN */ - /** Process an archive in Eclipse format. */ - public void processEclipseArchive(Path duDir) { + void processEclipseArchive(Path duDir) { try { Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent()); - // String category = categoryRelativePath.getFileName().toString(); Path targetCategoryBase = a2Base.resolve(categoryRelativePath); Files.createDirectories(targetCategoryBase); // first delete all directories from previous builds - for (Path dir : Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p))) { + for (Path dir : Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p))) deleteDirectory(dir); - } Files.createDirectories(originBase); @@ -589,14 +700,14 @@ public class Repackage { try (InputStream in = Files.newInputStream(commonBnd)) { commonProps.load(in); } - String url = commonProps.getProperty(ManifestConstants.SLC_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.SLC_ORIGIN_URI.toString(), url); + commonProps.put(ARGEO_ORIGIN_URI.toString(), url); } - Path downloaded = tryDownload(url, originBase); + Path downloaded = tryDownloadArchive(url, originBase); FileSystem zipFs = FileSystems.newFileSystem(downloaded, (ClassLoader) null); @@ -624,6 +735,8 @@ public class Repackage { } } + // keys are the bundle directories + Map origins = new HashMap<>(); Files.walkFileTree(zipFs.getRootDirectories().iterator().next(), new SimpleFileVisitor() { @Override @@ -632,22 +745,21 @@ public class Repackage { if (includeMatcher.matches(file)) { for (PathMatcher excludeMatcher : excludeMatchers) { if (excludeMatcher.matches(file)) { - logger.log(Level.TRACE, "Skipping excluded " + file); + logger.log(TRACE, "Skipping excluded " + file); return FileVisitResult.CONTINUE; } } if (file.getFileName().toString().contains(".source_")) { - if (!sourceBundles) { - processEclipseSourceJar(file, targetCategoryBase); - logger.log(Level.DEBUG, () -> "Processed source " + file); - } - + processEclipseSourceJar(file, targetCategoryBase); + logger.log(DEBUG, () -> "Processed source " + file); } else { Map map = new HashMap<>(); for (Object key : commonProps.keySet()) map.put(key.toString(), commonProps.getProperty(key.toString())); - processBundleJar(file, targetCategoryBase, map); - logger.log(Level.DEBUG, () -> "Processed " + file); + A2Origin origin = new A2Origin(); + Path bundleDir = processBundleJar(file, targetCategoryBase, map, origin); + origins.put(bundleDir, origin); + logger.log(DEBUG, () -> "Processed " + file); } break includeMatchers; } @@ -656,10 +768,12 @@ public class Repackage { } }); - DirectoryStream dirs = Files.newDirectoryStream(targetCategoryBase, - (p) -> Files.isDirectory(p) && p.getFileName().toString().indexOf('.') >= 0); - for (Path dir : dirs) { - createJar(dir); + DirectoryStream dirs = Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p) + && p.getFileName().toString().indexOf('.') >= 0 && !p.getFileName().toString().endsWith(".src")); + 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); @@ -668,65 +782,66 @@ 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 = targetBundleDir.resolve("OSGI-OPT/src"); - - // TODO make it less dangerous? - if (Files.exists(targetSourceDir)) { -// deleteDirectory(targetSourceDir); - } else { - Files.createDirectories(targetSourceDir); - } + Path sourceDir = sourceBundles ? bundleDir.getParent().resolve(bundleDir.toString() + ".src") + : bundleDir.resolve("OSGI-OPT/src"); - // copy entries + 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(Level.TRACE, () -> "Copied source " + target); + logger.log(TRACE, () -> "Copied source " + target); } - // copy MANIFEST + // 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); } - } /* * COMMON PROCESSING */ /** Normalise a bundle. */ - protected 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(";"); for (int i = 1; i < arr.length; i++) { @@ -735,7 +850,6 @@ public class Repackage { logger.log(DEBUG, file.getFileName() + " is a singleton"); } } - // remove problematic entries in MANIFEST manifest.getEntries().clear(); @@ -747,7 +861,7 @@ public class Repackage { } else { nameVersion = nameVersionFromManifest(manifest); if (ourVersion != null && !nameVersion.getVersion().equals(ourVersion)) { - logger.log(Level.WARNING, + logger.log(WARNING, "Original version is " + nameVersion.getVersion() + " while new version is " + ourVersion); entries.put(BUNDLE_VERSION.toString(), ourVersion); } @@ -756,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()); @@ -764,106 +887,173 @@ 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(); -// String[] segments = categoryDir.getFileName().toString().split("\\."); -// String arch = segments[segments.length - 1]; -// String os = segments[segments.length - 2]; - 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(Level.TRACE, () -> "Copied " + target); } + } - // copy MANIFEST - Path manifestPath = targetBundleDir.resolve("META-INF/MANIFEST.MF"); - Files.createDirectories(manifestPath.getParent()); + // copy MANIFEST + Path manifestPath = bundleDir.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()); + } - 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) - || ManifestConstants.BUNDLE_LICENSE.toString().equals(key)) - logger.log(Level.TRACE, file.getFileName() + ": " + key + " was modified"); - else - logger.log(Level.WARNING, file.getFileName() + ": " + key + " was " + previousValue - + ", overridden with " + value); + // 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; + + 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 + 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; } /* * 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() { @@ -872,19 +1062,19 @@ public class Repackage { if (e != null) throw e; Files.delete(directory); - return FileVisitResult.CONTINUE; + return CONTINUE; } @Override public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException { Files.delete(file); - return FileVisitResult.CONTINUE; + return CONTINUE; } }); } /** 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()); @@ -898,7 +1088,7 @@ public class Repackage { } /** Try to download from an URI. */ - protected Path tryDownload(String uri, Path dir) throws IOException { + Path tryDownloadArchive(String uri, Path dir) throws IOException { // find mirror List urlBases = null; String uriPrefix = null; @@ -913,7 +1103,7 @@ public class Repackage { } if (urlBases == null) try { - return download(new URL(uri), dir); + return downloadArchive(new URL(uri), dir); } catch (FileNotFoundException e) { throw new FileNotFoundException("Cannot find " + uri); } @@ -923,30 +1113,36 @@ public class Repackage { String relativePath = uri.substring(uriPrefix.length()); URL url = new URL(urlBase + relativePath); try { - return download(url, dir); + return downloadArchive(url, dir); } catch (FileNotFoundException e) { - logger.log(Level.WARNING, "Cannot download " + url + ", trying another mirror"); + logger.log(WARNING, "Cannot download " + url + ", trying another mirror"); } } throw new FileNotFoundException("Cannot find " + uri); } - /** Effectively download. */ - protected Path download(URL url, Path dir) throws IOException { + /** + * Effectively download. Synchronised in order to avoid downloading twice in + * parallel. + */ + 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) { - name = url.getPath().substring(url.getPath().lastIndexOf('/') + 1); + // We use also use parent directory in case the archive itself has a fixed name + String[] segments = url.getPath().split("/"); + name = segments.length > 1 ? segments[segments.length - 2] + '-' + segments[segments.length - 1] + : segments[segments.length - 1]; } dest = dir.resolve(name); if (Files.exists(dest)) { - logger.log(Level.TRACE, () -> "File " + dest + " already exists for " + url + ", not downloading again"); + logger.log(TRACE, () -> "File " + dest + " already exists for " + url + ", not downloading again"); return dest; } else { Files.createDirectories(dest.getParent()); @@ -954,13 +1150,15 @@ public class Repackage { try (InputStream in = url.openStream()) { Files.copy(in, dest); - logger.log(Level.DEBUG, () -> "Downloaded " + dest + " from " + url); + logger.log(DEBUG, () -> "Downloaded " + dest + " from " + url); } return dest; } /** Create a JAR file from a directory. */ - protected 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"); @@ -976,7 +1174,8 @@ public class Repackage { 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(bundleDir.relativize(file).toString()); + JarEntry entry = new JarEntry( + bundleDir.relativize(file).toString().replace(File.separatorChar, '/')); jarOut.putNextEntry(entry); Files.copy(file, jarOut); return super.visitFile(file, attrs); @@ -985,25 +1184,116 @@ public class Repackage { }); } deleteDirectory(bundleDir); + + if (sourceBundles) + createSourceJar(bundleDir, manifest); + return jarPath; } + 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; + + } + + 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. */ enum ManifestConstants { // 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"), // - // JAVA + /** OSGi path to embedded jar. */ + BUNDLE_CLASSPATH("Bundle-Classpath"), // + // Java + /** Java module name. */ AUTOMATIC_MODULE_NAME("Automatic-Module-Name"), // - // SLC - SLC_CATEGORY("SLC-Category"), // - SLC_ORIGIN_M2("SLC-Origin-M2"), // - SLC_ORIGIN_M2_MERGE("SLC-Origin-M2-Merge"), // - SLC_ORIGIN_M2_REPO("SLC-Origin-M2-Repo"), // - SLC_ORIGIN_MANIFEST_NOT_MODIFIED("SLC-Origin-ManifestNotModified"), // - SLC_ORIGIN_URI("SLC-Origin-URI"),// + // 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_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.). + */ + ARGEO_ORIGIN_URI("Argeo-Origin-URI"), // ; final String value; @@ -1016,9 +1306,35 @@ public class Repackage { public String toString() { return value; } - } +} +/** + * 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. */ @@ -1110,6 +1426,7 @@ class M2ConventionsUtils { } } +/** Combination of a category, a name and a version. */ class CategoryNameVersion extends NameVersion { private String category; @@ -1141,6 +1458,7 @@ class CategoryNameVersion extends NameVersion { } +/** Combination of a name and a version. */ class NameVersion implements Comparable { private String name; private String version;