X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=src%2Forg%2Fargeo%2Fbuild%2FRepackage.java;h=ee15af42f324362d6c7e02d5b6d9c1016b1bfdd4;hb=7adb1db5c7613a3ba1b49cb642b33068b30720dc;hp=e9f8a3370f26890521d01c5ad4ec84d0833390ae;hpb=ab9cf16f6754c2081eabc55abfbbc1b49740647e;p=cc0%2Fargeo-build.git diff --git a/src/org/argeo/build/Repackage.java b/src/org/argeo/build/Repackage.java index e9f8a33..ee15af4 100644 --- a/src/org/argeo/build/Repackage.java +++ b/src/org/argeo/build/Repackage.java @@ -9,12 +9,12 @@ import static java.nio.file.FileVisitResult.CONTINUE; import static java.nio.file.StandardOpenOption.APPEND; import static java.nio.file.StandardOpenOption.CREATE; import static java.util.jar.Attributes.Name.MANIFEST_VERSION; -import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_EMBED; import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2; import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_MERGE; import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_REPO; -import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED; +import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_NO_METADATA_GENERATION; import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_URI; +import static org.argeo.build.Repackage.ManifestHeader.AUTOMATIC_MODULE_NAME; import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_LICENSE; import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_SYMBOLICNAME; import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_VERSION; @@ -152,15 +152,15 @@ public class Repackage { /** 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 + * 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"), // + ARGEO_ORIGIN_NO_METADATA_GENERATION("Argeo-Origin-NoMetadataGeneration"), // +// /** +// * Embed the original jar without modifying it (may be required by some +// * proprietary licenses, such as JCR Day License). +// */ +// ARGEO_ORIGIN_EMBED("Argeo-Origin-Embed"), // /** * Do not modify original jar (may be required by some proprietary licenses, * such as JCR Day License). @@ -193,9 +193,9 @@ public class Repackage { * Subdirectory of the jar file where origin informations (changes, legal * notices etc. are stored) */ - final static String A2_ORIGIN = "A2-ORIGIN"; + final static String ARGEO_ORIGIN = "ARGEO-ORIGIN"; /** File detailing modifications to the original component. */ - final static String CHANGES = A2_ORIGIN + "/changes"; + final static String CHANGES = ARGEO_ORIGIN + "/changes"; /** * Name of the file at the root of the repackaged jar, which prominently * notifies that the component has be repackaged. @@ -404,7 +404,12 @@ public class Repackage { } String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString()); M2Artifact artifact = new M2Artifact(m2Coordinates); - artifact.setVersion(m2Version); + if (artifact.getVersion() == null) { + artifact.setVersion(m2Version); + } else { + logger.log(WARNING, p.getFileName() + " : Using version " + artifact.getVersion() + + " specified in descriptor rather than " + m2Version + " specified in " + COMMON_BND); + } // prepare manifest entries Properties mergeProps = new Properties(); @@ -453,13 +458,20 @@ public class Repackage { Path targetCategoryBase = a2Base.resolve(category); Properties mergeProps = new Properties(); + // first, load common properties + Path commonBnd = duDir.resolve(COMMON_BND); + if (Files.exists(commonBnd)) + try (InputStream in = Files.newInputStream(commonBnd)) { + mergeProps.load(in); + } + // then, the merge properties themselves try (InputStream in = Files.newInputStream(mergeBnd)) { mergeProps.load(in); } String m2Version = mergeProps.getProperty(ARGEO_ORIGIN_M2.toString()); if (m2Version == null) { - logger.log(WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit"); + logger.log(WARNING, "Ignoring merging in " + duDir + " as it is not an M2-based distribution unit"); return;// ignore, this is probably an Eclipse archive } if (!m2Version.startsWith(":")) { @@ -527,7 +539,7 @@ public class Repackage { continue entries; } if (entry.getName().equals("META-INF/MANIFEST.MF")) { - Path originalManifest = bundleDir.resolve(A2_ORIGIN).resolve(artifact.getGroupId()) + Path originalManifest = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId()) .resolve(artifact.getArtifactId()).resolve("MANIFEST.MF"); Files.createDirectories(originalManifest.getParent()); try (OutputStream out = Files.newOutputStream(originalManifest)) { @@ -542,7 +554,7 @@ public class Repackage { || 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()) + Path artifactOriginDir = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId()) .resolve(artifact.getArtifactId()); Path target = artifactOriginDir.resolve(entry.getName()); Files.createDirectories(target.getParent()); @@ -611,8 +623,10 @@ public class Repackage { continue keys; } if ("Require-Capability".equals(key.toString()) - && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) + && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) { + origin.deleted.add("MANIFEST header " + key); continue keys;// hack for very old classes + } entries.put(key.toString(), value.toString()); } } catch (Exception e) { @@ -643,13 +657,11 @@ public class Repackage { try { Map additionalEntries = new TreeMap<>(); boolean doNotModifyManifest = Boolean.parseBoolean( - fileProps.getOrDefault(ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED.toString(), "false").toString()); + fileProps.getOrDefault(ARGEO_ORIGIN_NO_METADATA_GENERATION.toString(), "false").toString()); // Note: we always force the symbolic name if (doNotModifyManifest) { - fileEntries: for (Object key : fileProps.keySet()) { - if (ARGEO_ORIGIN_M2.toString().equals(key)) - continue fileEntries; + for (Object key : fileProps.keySet()) { String value = fileProps.getProperty(key.toString()); additionalEntries.put(key.toString(), value); } @@ -731,6 +743,7 @@ public class Repackage { Files.createDirectories(sourceDir); JarEntry entry; entries: while ((entry = jarIn.getNextJarEntry()) != null) { + String relPath = entry.getName(); if (entry.isDirectory()) continue entries; if (entry.getName().startsWith("META-INF")) {// skip META-INF entries @@ -742,12 +755,17 @@ public class Repackage { continue entries; } 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); + int metaInfIndex = entry.getName().indexOf("META-INF"); + if (metaInfIndex >= 0) { + relPath = entry.getName().substring(metaInfIndex); + origin.moved.add(" to " + relPath + " entry with absolute path " + entry.getName()); + } else { + logger.log(WARNING, entry.getName() + " has an absolute path"); + origin.deleted.add(entry.getName() + " from the sources" + mergingMsg); + } continue entries; } - Path target = sourceDir.resolve(entry.getName()); + Path target = sourceDir.resolve(relPath); Files.createDirectories(target.getParent()); if (!Files.exists(target)) { Files.copy(jarIn, target); @@ -928,7 +946,9 @@ public class Repackage { */ /** Normalise a single (that is, non-merged) bundle. */ Path processBundleJar(Path file, Path targetBase, Map entries, A2Origin origin) throws IOException { - boolean embed = Boolean.parseBoolean(entries.getOrDefault(ARGEO_ORIGIN_EMBED.toString(), "false").toString()); +// boolean embed = Boolean.parseBoolean(entries.getOrDefault(ARGEO_ORIGIN_EMBED.toString(), "false").toString()); + boolean doNotModify = Boolean + .parseBoolean(entries.getOrDefault(ManifestHeader.ARGEO_DO_NOT_MODIFY.toString(), "false").toString()); NameVersion nameVersion; Path bundleDir; // singleton @@ -971,13 +991,14 @@ public class Repackage { } bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch()); - if (sourceManifest != null) {// copy original MANIFEST - Path originalManifest = bundleDir.resolve(A2_ORIGIN).resolve("MANIFEST.MF"); + // copy original MANIFEST + if (sourceManifest != null) { + Path originalManifest = bundleDir.resolve(ARGEO_ORIGIN).resolve("MANIFEST.MF"); Files.createDirectories(originalManifest.getParent()); try (OutputStream out = Files.newOutputStream(originalManifest)) { sourceManifest.write(out); } - origin.moved.add("original MANIFEST (" + bundleDir.relativize(originalManifest) + ")"); + origin.moved.add("original MANIFEST to " + bundleDir.relativize(originalManifest)); } // force Java 9 module name @@ -993,12 +1014,13 @@ public class Repackage { arch = libRelativePath.getName(1).toString(); } - if (!embed) { - // copy entries - JarEntry entry; - entries: while ((entry = jarIn.getNextJarEntry()) != null) { - if (entry.isDirectory()) - continue entries; +// if (!embed) { + // copy entries + JarEntry entry; + entries: while ((entry = jarIn.getNextJarEntry()) != null) { + if (entry.isDirectory()) + continue entries; + if (!doNotModify) { if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".DSA") || entry.getName().endsWith(".SF")) { origin.deleted.add("cryptographic signatures"); @@ -1022,43 +1044,44 @@ public class Repackage { .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 { + } + 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; } - 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()); + targetDll = categoryDir.resolve(target.getFileName()); + } else { + copyDll = true; } - logger.log(TRACE, () -> "Copied " + target); + 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()); } + logger.log(TRACE, () -> "Copied " + target); +// } } } @@ -1071,10 +1094,10 @@ public class Repackage { entries.get(BUNDLE_SYMBOLICNAME.toString()) + ";singleton:=true"); } - if (embed) {// copy embedded jar - Files.copy(file, bundleDir.resolve(file.getFileName())); - entries.put(ManifestHeader.BUNDLE_CLASSPATH.toString(), file.getFileName().toString()); - } +// if (embed) {// copy embedded jar +// Files.copy(file, bundleDir.resolve(file.getFileName())); +// entries.put(ManifestHeader.BUNDLE_CLASSPATH.toString(), file.getFileName().toString()); +// } // Final MANIFEST decisions // We also check the original OSGi metadata and compare with our changes @@ -1102,6 +1125,9 @@ public class Repackage { if (wasDifferent && !keepPrevious) { if (IMPORT_PACKAGE.toString().equals(key) || EXPORT_PACKAGE.toString().equals(key)) logger.log(TRACE, () -> file.getFileName() + ": " + key + " was modified"); + else if (BUNDLE_SYMBOLICNAME.toString().equals(key) || AUTOMATIC_MODULE_NAME.toString().equals(key)) + logger.log(DEBUG, + file.getFileName() + ": " + key + " was " + previousValue + ", overridden with " + value); else logger.log(WARNING, file.getFileName() + ": " + key + " was " + previousValue + ", overridden with " + value); @@ -1138,7 +1164,7 @@ public class Repackage { processLicense(bundleDir, manifest); - origin.modified.add("jar MANIFEST (META-INF/MANIFEST.MF)"); + origin.modified.add("MANIFEST (META-INF/MANIFEST.MF)"); // write the MANIFEST try (OutputStream out = Files.newOutputStream(manifestPath)) { manifest.write(out); @@ -1159,9 +1185,20 @@ public class Repackage { if (orIndex >= 0) spdxLicenceId = spdxLicenceId.substring(0, orIndex).trim(); - // bundles starting with org.apache MUST be licensed with Apache-2.0 - // even if we say otherwise (typically because coming from an Eclipse archive) - if (bundleDir.getFileName().startsWith("org.apache.")) + String bundleDirName = bundleDir.getFileName().toString(); + // force licenses of some well-known components + // even if we say otherwise (typically because from an Eclipse archive) + if (bundleDirName.startsWith("org.apache.")) + spdxLicenceId = "Apache-2.0"; + if (bundleDirName.startsWith("com.sun.jna.")) + spdxLicenceId = "Apache-2.0"; + if (bundleDirName.startsWith("com.ibm.icu.")) + spdxLicenceId = "ICU"; + if (bundleDirName.startsWith("javax.annotation.")) + spdxLicenceId = "GPL-2.0-only WITH Classpath-exception-2.0"; + if (bundleDirName.startsWith("javax.inject.")) + spdxLicenceId = "Apache-2.0"; + if (bundleDirName.startsWith("org.osgi.")) spdxLicenceId = "Apache-2.0"; manifest.getMainAttributes().putValue(SPDX_LICENSE_IDENTIFIER.toString(), spdxLicenceId); @@ -1279,15 +1316,15 @@ public class Repackage { /** Create a JAR file from a directory. */ Path createJar(Path bundleDir, A2Origin origin) throws IOException { - // write changes - origin.appendChanges(bundleDir); - Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF"); Manifest manifest; try (InputStream in = Files.newInputStream(manifestPath)) { manifest = new Manifest(in); } + // legal requirements + origin.appendChanges(bundleDir); createReadMe(bundleDir, manifest); + // create the jar Path jarPath = bundleDir.getParent().resolve(bundleDir.getFileName() + ".jar"); try (JarOutputStream jarOut = new JarOutputStream(Files.newOutputStream(jarPath), manifest)) { @@ -1361,6 +1398,10 @@ public class Repackage { deleteDirectory(sourceDir); } + /** + * Generate a readme clarifying and prominently notifying of the repackaging and + * modifications. + */ void createReadMe(Path jarDir, Manifest manifest) throws IOException { // write repackaged README try (BufferedWriter writer = Files.newBufferedWriter(jarDir.resolve(README_REPACKAGED))) { @@ -1372,19 +1413,48 @@ public class Repackage { writer.append("This component is a repackaging of a third party component" + " in order to comply with A2 packaging standards.\n"); + // license + String spdxLicenseId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString()); + if (spdxLicenseId == null) + throw new IllegalStateException("An SPDX license id must have beend defined at this stage."); + writer.append("\nIt is redistributed under the following license:\n\n"); + writer.append("SPDX-Identifier: " + spdxLicenseId + "\n\n"); + + if (!spdxLicenseId.startsWith("LicenseRef")) {// standard + int withIndex = spdxLicenseId.indexOf(" WITH "); + if (withIndex >= 0) { + String simpleId = spdxLicenseId.substring(0, withIndex).trim(); + String exception = spdxLicenseId.substring(withIndex + " WITH ".length()); + writer.append("which are available here: https://spdx.org/licenses/" + simpleId + + "\nand here: https://spdx.org/licenses/" + exception + "\n"); + } else { + writer.append("which is available here: https://spdx.org/licenses/" + spdxLicenseId + "\n"); + } + } else { + String url = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString()); + if (url != null) { + writer.write("which is available here: " + url + "\n"); + } else { + logger.log(ERROR, "No licne URL for " + jarDir); + } + } + writer.write("\n"); + + // origin String m2Repo = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2_REPO.toString()); String originDesc = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2.toString()); if (originDesc != null) - writer.append("The original component has Maven coordinates " + originDesc - + (m2Repo != null ? " in M2 repository" + m2Repo : "") + ".\n"); - else + writer.append("The original component has M2 coordinates:\n" + originDesc.replace(',', '\n') + "\n" + + (m2Repo != null ? "\nin M2 repository " + m2Repo + "\n" : "")); + else { originDesc = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_URI.toString()); - if (originDesc != null) - writer.append("The original component comes from " + originDesc + ".\n"); - else - logger.log(ERROR, "Cannot find origin information in " + jarDir); + if (originDesc != null) + writer.append("The original component comes from " + originDesc + ".\n"); + else + logger.log(ERROR, "Cannot find origin information in " + jarDir); + } - writer.append("A detailed list of changes is available under " + CHANGES + "\n"); + writer.append("\nA detailed list of changes is available under " + CHANGES + ".\n"); if (!jarDir.getFileName().endsWith(".src")) {// binary archive if (sourceBundles) writer.append("Corresponding sources are available in the related archive named "