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.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.ManifestConstants.ARGEO_ORIGIN_M2;
-import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_M2_MERGE;
-import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_M2_REPO;
-import static org.argeo.build.Repackage.ManifestConstants.ARGEO_ORIGIN_URI;
-import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_LICENSE;
-import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_SYMBOLICNAME;
-import static org.argeo.build.Repackage.ManifestConstants.BUNDLE_VERSION;
-import static org.argeo.build.Repackage.ManifestConstants.ECLIPSE_SOURCE_BUNDLE;
-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 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_NO_METADATA_GENERATION;
+import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_URI;
+import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_LICENSE;
+import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_SYMBOLICNAME;
+import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_VERSION;
+import static org.argeo.build.Repackage.ManifestHeader.ECLIPSE_SOURCE_BUNDLE;
+import static org.argeo.build.Repackage.ManifestHeader.EXPORT_PACKAGE;
+import static org.argeo.build.Repackage.ManifestHeader.IMPORT_PACKAGE;
+import static org.argeo.build.Repackage.ManifestHeader.SPDX_LICENSE_IDENTIFIER;
import java.io.BufferedWriter;
import java.io.File;
import java.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;
import java.util.Objects;
import java.util.Properties;
import java.util.Set;
+import java.util.StringJoiner;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.concurrent.CompletableFuture;
import aQute.bnd.osgi.Analyzer;
import aQute.bnd.osgi.Jar;
-/**
- * Simple tool repackaging existing jar files into OSGi bundles in an A2
- * repository.
- */
+/** Repackages existing jar files into OSGi bundles in an A2 repository. */
public class Repackage {
final static Logger logger = System.getLogger(Repackage.class.getName());
* integrated in the bundles.
*/
final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES";
+ /** Environment variable on whether operations should be parallelised. */
+ final static String ENV_ARGEO_BUILD_SEQUENTIAL = "ARGEO_BUILD_SEQUENTIAL";
- /** 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<String, Set<String>> licensesUsed = new TreeMap<>();
+ /** Whether repackaging should run in parallel (default) or sequentially. */
+ final static boolean sequential = Boolean.parseBoolean(System.getenv(ENV_ARGEO_BUILD_SEQUENTIAL));
/** Main entry point. */
public static void main(String[] args) {
+ if (sequential)
+ logger.log(INFO, "Build will be sequential");
if (args.length < 2) {
System.err.println("Usage: <path to a2 output dir> <category1> <category2> ...");
System.exit(1);
List<CompletableFuture<Void>> toDos = new ArrayList<>();
for (int i = 1; i < args.length; i++) {
Path p = Paths.get(args[i]);
- if (parallel)
- toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(p)));
- else
+ if (sequential)
factory.processCategory(p);
+ else
+ toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(p)));
}
- CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join();
+ if (!sequential)
+ CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join();
// Summary
StringBuilder sb = new StringBuilder();
logger.log(INFO, "# License summary:\n" + sb);
}
+ /** MANIFEST headers. */
+ enum ManifestHeader {
+ // OSGi
+ /** OSGi bundle symbolic name. */
+ BUNDLE_SYMBOLICNAME("Bundle-SymbolicName"), //
+ /** OSGi bundle version. */
+ BUNDLE_VERSION("Bundle-Version"), //
+ /** OSGi bundle license. */
+ BUNDLE_LICENSE("Bundle-License"), //
+ /** OSGi exported packages list. */
+ EXPORT_PACKAGE("Export-Package"), //
+ /** OSGi imported packages list. */
+ IMPORT_PACKAGE("Import-Package"), //
+ /** OSGi path to embedded jar. */
+ BUNDLE_CLASSPATH("Bundle-Classpath"), //
+ // Java
+ /** Java module name. */
+ AUTOMATIC_MODULE_NAME("Automatic-Module-Name"), //
+ // Eclipse
+ /** Eclipse source bundle. */
+ ECLIPSE_SOURCE_BUNDLE("Eclipse-SourceBundle"), //
+ // SPDX
+ /**
+ * SPDX license identifier.
+ *
+ * @see https://spdx.org/licenses/
+ */
+ SPDX_LICENSE_IDENTIFIER("SPDX-License-Identifier"), //
+ // Argeo Origin
+ /**
+ * Maven coordinates of the origin, possibly partial when using common.bnd or
+ * merge.bnd.
+ */
+ ARGEO_ORIGIN_M2("Argeo-Origin-M2"), //
+ /** List of Maven coordinates to merge. */
+ ARGEO_ORIGIN_M2_MERGE("Argeo-Origin-M2-Merge"), //
+ /** Maven repository, if not the default one. */
+ ARGEO_ORIGIN_M2_REPO("Argeo-Origin-M2-Repo"), //
+ /**
+ * Do not perform BND analysis of the origin component. Typically Import_package
+ * and Export-Package will be kept untouched.
+ */
+ ARGEO_ORIGIN_NO_METADATA_GENERATION("Argeo-Origin-NoMetadataGeneration"), //
+ /**
+ * Embed the original jar without modifying it (may be required by some
+ * proprietary licenses, such as JCR Day License).
+ */
+ ARGEO_ORIGIN_EMBED("Argeo-Origin-Embed"), //
+ /**
+ * Do not modify original jar (may be required by some proprietary licenses,
+ * such as JCR Day License).
+ */
+ ARGEO_DO_NOT_MODIFY("Argeo-Origin-Do-Not-Modify"), //
+ /**
+ * Origin (non-Maven) URI of the component. It may be anything (jar, archive,
+ * etc.).
+ */
+ ARGEO_ORIGIN_URI("Argeo-Origin-URI"), //
+ ;
+
+ final String value;
+
+ private ManifestHeader(String value) {
+ this.value = value;
+ }
+
+ @Override
+ public String toString() {
+ return value;
+ }
+ }
+
/** 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. */
* notices etc. are stored)
*/
final static String A2_ORIGIN = "A2-ORIGIN";
+ /** File detailing modifications to the original component. */
+ final static String CHANGES = A2_ORIGIN + "/changes";
+ /**
+ * Name of the file at the root of the repackaged jar, which prominently
+ * notifies that the component has be repackaged.
+ */
+ final static String README_REPACKAGED = "README.repackaged";
+
+ // cache
+ /** Summary of all license seen during the repackaging. */
+ final static Map<String, Set<String>> licensesUsed = new TreeMap<>();
/** 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<String, List<String>> mirrors = new HashMap<String, List<String>>();
+ final Map<String, List<String>> mirrors = new HashMap<String, List<String>>();
/** Whether sources should be packaged separately */
final boolean sourceBundles;
? fileProps.getProperty(ARGEO_ORIGIN_M2_REPO.toString())
: null;
+ // use file name as symbolic name
if (!fileProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
- // use file name as symbolic name
String symbolicName = bndFile.getFileName().toString();
symbolicName = symbolicName.substring(0, symbolicName.length() - ".bnd".length());
fileProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName);
URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact);
Path downloaded = downloadMaven(url, artifact);
- A2Origin origin = new A2Origin();
- Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact, origin);
-
- downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir, false);
+ // some proprietary artifacts do not allow any modification
+ // when releasing (with separate sources) we just copy it
+ boolean doNotModify = Boolean.parseBoolean(
+ fileProps.getOrDefault(ManifestHeader.ARGEO_DO_NOT_MODIFY.toString(), "false").toString());
+ if (doNotModify && sourceBundles) {
+ Path unmodifiedTarget = targetCategoryBase.resolve(
+ fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch() + ".jar");
+ Files.copy(downloaded, unmodifiedTarget, StandardCopyOption.REPLACE_EXISTING);
+ Path bundleDir = targetCategoryBase
+ .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch());
+ downloadAndProcessM2Sources(repoStr, artifact, bundleDir, false);
+ Manifest manifest;
+ try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(unmodifiedTarget))) {
+ manifest = jarIn.getManifest();
+ }
+ createSourceJar(bundleDir, manifest);
+ return;
+ }
- createJar(targetBundleDir, origin);
+ // 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 coming from a same project and therefore
* with information in common (typically the version), generating single bundles
* or merging them if necessary.
+ *
+ * @see #COMMON_BND
+ * @see #MERGE_BND
*/
void processM2BasedDistributionUnit(Path duDir) {
try {
A2Origin origin = new A2Origin();
Path bundleDir = targetCategoryBase.resolve(bundleSymbolicName + "." + nameVersion.getBranch());
+ StringJoiner originDesc = new StringJoiner(",");
String[] artifacts = artifactsStr.split(",");
artifacts: for (String str : artifacts) {
String m2Coordinates = str.trim();
M2Artifact artifact = new M2Artifact(m2Coordinates.trim());
if (artifact.getVersion() == null)
artifact.setVersion(m2Version);
+ originDesc.add(artifact.toString());
URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact);
Path downloaded = downloadMaven(url, artifact);
JarEntry entry;
entries: while ((entry = jarIn.getNextJarEntry()) != null) {
if (entry.isDirectory())
continue entries;
- if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".SF")) {
+ if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".DSA")
+ || entry.getName().endsWith(".SF")) {
origin.deleted.add("cryptographic signatures from " + artifact);
continue entries;
}
origin.deleted.add("additional Java versions (META-INF/versions) from " + artifact);
continue entries;
}
- if (entry.getName().equals("META-INF/DEPENDENCIES")) {
- origin.deleted.add("dependency list (META-INF/DEPENDENCIES) from " + artifact);
- continue entries;
- }
if (entry.getName().startsWith("META-INF/maven/")) {
origin.deleted.add("Maven information (META-INF/maven) from " + artifact);
continue entries;
origin.deleted.add("cache directory (.cache) from " + artifact);
continue entries;
}
+ if (entry.getName().equals("META-INF/DEPENDENCIES")) {
+ origin.deleted.add("Dependencies (META-INF/DEPENDENCIES) from " + artifact);
+ continue entries;
+ }
+ 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().endsWith("NOTICE") || entry.getName().endsWith("NOTICE.txt")
|| entry.getName().endsWith("LICENSE") || entry.getName().endsWith("LICENSE.md")
}
}
+ // BND analysis
Map<String, String> entries = new TreeMap<>();
try (Analyzer bndAnalyzer = new Analyzer()) {
bndAnalyzer.setProperties(mergeProps);
String value = entries.get(key);
manifest.getMainAttributes().putValue(key, value);
}
+ manifest.getMainAttributes().putValue(ARGEO_ORIGIN_M2.toString(), originDesc.toString());
+
+ processLicense(bundleDir, manifest);
+ // write MANIFEST
try (OutputStream out = Files.newOutputStream(manifestPath)) {
manifest.write(out);
}
createJar(bundleDir, origin);
}
- /** Generate MANIFEST using BND. */
+ /** Generates MANIFEST using BND. */
Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact,
A2Origin origin) {
-
try {
Map<String, String> 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_NO_METADATA_GENERATION.toString(), "false").toString());
// Note: we always force the symbolic name
- if (doNotModify) {
- fileEntries: for (Object key : fileProps.keySet()) {
- if (ManifestConstants.ARGEO_ORIGIN_M2.toString().equals(key))
- continue fileEntries;
+ if (doNotModifyManifest) {
+ for (Object key : fileProps.keySet()) {
String value = fileProps.getProperty(key.toString());
additionalEntries.put(key.toString(), value);
}
"*;version=\"" + fileProps.getProperty(BUNDLE_VERSION.toString()) + "\"");
}
+ // BND analysis
try (Analyzer bndAnalyzer = new Analyzer()) {
bndAnalyzer.setProperties(fileProps);
Jar jar = new Jar(downloaded.toFile());
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
+ }
additionalEntries.put(key.toString(), value.toString());
}
}
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
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);
/*
* COMMON PROCESSING
*/
- /** Normalise a bundle. */
+ /** Normalise a single (that is, non-merged) bundle. */
Path processBundleJar(Path file, Path targetBase, Map<String, String> entries, A2Origin origin) throws IOException {
+ boolean embed = Boolean.parseBoolean(entries.getOrDefault(ARGEO_ORIGIN_EMBED.toString(), "false").toString());
NameVersion nameVersion;
Path bundleDir;
+ // singleton
+ boolean isSingleton = false;
+ Manifest manifest;
+ Manifest sourceManifest;
try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) {
- Manifest sourceManifest = jarIn.getManifest();
- Manifest manifest = sourceManifest != null ? new Manifest(sourceManifest) : new Manifest();
+ sourceManifest = jarIn.getManifest();
+ manifest = sourceManifest != null ? new Manifest(sourceManifest) : new Manifest();
- // singleton
- boolean isSingleton = false;
String rawSourceSymbolicName = manifest.getMainAttributes().getValue(BUNDLE_SYMBOLICNAME.toString());
if (rawSourceSymbolicName != null) {
// make sure there is no directive
}
bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch());
+ // copy original MANIFEST
+ if (sourceManifest != null) {
+ Path originalManifest = bundleDir.resolve(A2_ORIGIN).resolve("MANIFEST.MF");
+ Files.createDirectories(originalManifest.getParent());
+ try (OutputStream out = Files.newOutputStream(originalManifest)) {
+ sourceManifest.write(out);
+ }
+ origin.moved.add("original MANIFEST to " + bundleDir.relativize(originalManifest));
+ }
+
// force Java 9 module name
- entries.put(ManifestConstants.AUTOMATIC_MODULE_NAME.toString(), nameVersion.getName());
+ entries.put(ManifestHeader.AUTOMATIC_MODULE_NAME.toString(), nameVersion.getName());
boolean isNative = false;
String os = null;
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")) {
- 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;
- }
- // 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)) {
+ 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 = 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(ManifestHeader.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
+ // We also check the original OSGi metadata and compare with our changes
+ for (String key : entries.keySet()) {
+ String value = entries.get(key);
+ String previousValue = manifest.getMainAttributes().getValue(key);
+ boolean wasDifferent = previousValue != null && !previousValue.equals(value);
+ boolean keepPrevious = false;
+ if (wasDifferent) {
+ if (SPDX_LICENSE_IDENTIFIER.toString().equals(key) && previousValue != null)
+ keepPrevious = true;
+ else if (BUNDLE_VERSION.toString().equals(key) && wasDifferent)
+ if (previousValue.equals(value + ".0")) // typically a Maven first release
keepPrevious = true;
- 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;
- }
- }
- 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);
- }
}
- // 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());
+ 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);
+ origin.modified.add("MANIFEST header " + key);
}
- origin.modified.add("jar MANIFEST (META-INF/MANIFEST.MF)");
- // write the MANIFEST
- try (OutputStream out = Files.newOutputStream(manifestPath)) {
- manifest.write(out);
+ // !! hack to remove unresolvable
+ if (key.equals("Provide-Capability") || key.equals("Require-Capability"))
+ if (nameVersion.getName().equals("osgi.core") || nameVersion.getName().equals("osgi.cmpn")) {
+ manifest.getMainAttributes().remove(key);
+ origin.deleted.add("MANIFEST header " + key);
+ }
+ }
+
+ // de-pollute MANIFEST
+ for (Iterator<Map.Entry<Object, Object>> manifestEntries = manifest.getMainAttributes().entrySet()
+ .iterator(); manifestEntries.hasNext();) {
+ Map.Entry<Object, Object> manifestEntry = manifestEntries.next();
+ switch (manifestEntry.getKey().toString()) {
+ case "Archiver-Version":
+ case "Build-By":
+ case "Created-By":
+ case "Originally-Created-By":
+ case "Tool":
+ case "Bnd-LastModified":
+ manifestEntries.remove();
+ origin.deleted.add("MANIFEST header " + manifestEntry.getKey());
+ break;
+ default:
+ if (sourceManifest != null && !sourceManifest.getMainAttributes().containsKey(manifestEntry.getKey()))
+ origin.added.add("MANIFEST header " + manifestEntry.getKey());
}
}
+
+ processLicense(bundleDir, manifest);
+
+ origin.modified.add("MANIFEST (META-INF/MANIFEST.MF)");
+ // write the MANIFEST
+ try (OutputStream out = Files.newOutputStream(manifestPath)) {
+ manifest.write(out);
+ }
return bundleDir;
}
+ /** Process SPDX license identifier. */
+ void processLicense(Path bundleDir, Manifest manifest) {
+ String spdxLicenceId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString());
+ String bundleLicense = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString());
+ if (spdxLicenceId == null) {
+ logger.log(ERROR, bundleDir.getFileName() + ": " + SPDX_LICENSE_IDENTIFIER + " not available, "
+ + BUNDLE_LICENSE + " is " + bundleLicense);
+ } else {
+ // only use the first licensing option
+ int orIndex = spdxLicenceId.indexOf(" OR ");
+ if (orIndex >= 0)
+ spdxLicenceId = spdxLicenceId.substring(0, orIndex).trim();
+
+ // 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."))
+ spdxLicenceId = "Apache-2.0";
+
+ manifest.getMainAttributes().putValue(SPDX_LICENSE_IDENTIFIER.toString(), spdxLicenceId);
+ if (!licensesUsed.containsKey(spdxLicenceId))
+ licensesUsed.put(spdxLicenceId, new TreeSet<>());
+ licensesUsed.get(spdxLicenceId).add(bundleDir.getParent().getFileName() + "/" + bundleDir.getFileName());
+ }
+ }
+
/*
* UTILITIES
*/
NameVersion nameVersionFromManifest(Manifest manifest) {
Attributes attrs = manifest.getMainAttributes();
// symbolic name
- String symbolicName = attrs.getValue(ManifestConstants.BUNDLE_SYMBOLICNAME.toString());
+ String symbolicName = attrs.getValue(ManifestHeader.BUNDLE_SYMBOLICNAME.toString());
if (symbolicName == null)
return null;
// make sure there is no directive
symbolicName = symbolicName.split(";")[0];
- String version = attrs.getValue(ManifestConstants.BUNDLE_VERSION.toString());
+ String version = attrs.getValue(ManifestHeader.BUNDLE_VERSION.toString());
return new NameVersion(symbolicName, version);
}
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");
Manifest manifest;
try (InputStream in = Files.newInputStream(manifestPath)) {
manifest = new Manifest(in);
}
+ createReadMe(bundleDir, manifest);
+ // create the jar
+ Path jarPath = bundleDir.getParent().resolve(bundleDir.getFileName() + ".jar");
try (JarOutputStream jarOut = new JarOutputStream(Files.newOutputStream(jarPath), manifest)) {
jarOut.setLevel(Deflater.DEFAULT_COMPRESSION);
Files.walkFileTree(bundleDir, new SimpleFileVisitor<Path>() {
}
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<Path>() {
-
- @Override
- public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
- if (file.getFileName().toString().equals("MANIFEST.MF"))
- return super.visitFile(file, attrs);
- JarEntry entry = new JarEntry(
- sourceDir.relativize(file).toString().replace(File.separatorChar, '/'));
- srcJarOut.putNextEntry(entry);
- Files.copy(file, srcJarOut);
+ /** Package sources separately, in the Eclipse-SourceBundle format. */
+ void createSourceJar(Path bundleDir, Manifest manifest) throws IOException {
+ Path bundleCategoryDir = bundleDir.getParent();
+ Path sourceDir = bundleCategoryDir.resolve(bundleDir.toString() + ".src");
+ if (!Files.exists(sourceDir)) {
+ logger.log(WARNING, sourceDir + " does not exist, skipping...");
+ return;
+ }
+ createReadMe(sourceDir, manifest);
+
+ Path relPath = a2Base.relativize(bundleCategoryDir);
+ Path srcCategoryDir = a2SrcBase.resolve(relPath);
+ Path srcJarP = srcCategoryDir.resolve(sourceDir.getFileName() + ".jar");
+ Files.createDirectories(srcJarP.getParent());
+
+ String bundleSymbolicName = manifest.getMainAttributes().getValue("Bundle-SymbolicName").toString();
+ // in case there are additional directives
+ bundleSymbolicName = bundleSymbolicName.split(";")[0];
+ Manifest srcManifest = new Manifest();
+ srcManifest.getMainAttributes().put(MANIFEST_VERSION, "1.0");
+ srcManifest.getMainAttributes().putValue(BUNDLE_SYMBOLICNAME.toString(), bundleSymbolicName + ".src");
+ srcManifest.getMainAttributes().putValue(BUNDLE_VERSION.toString(),
+ manifest.getMainAttributes().getValue(BUNDLE_VERSION.toString()).toString());
+ srcManifest.getMainAttributes().putValue(ECLIPSE_SOURCE_BUNDLE.toString(), bundleSymbolicName + ";version=\""
+ + manifest.getMainAttributes().getValue(BUNDLE_VERSION.toString()) + "\"");
+
+ try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) {
+ srcJarOut.setLevel(Deflater.BEST_COMPRESSION);
+ Files.walkFileTree(sourceDir, new SimpleFileVisitor<Path>() {
+
+ @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);
+ });
}
-
- return jarPath;
+ 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
- /** Java module name. */
- AUTOMATIC_MODULE_NAME("Automatic-Module-Name"), //
- // Eclipse
- /** Eclipse source bundle. */
- ECLIPSE_SOURCE_BUNDLE("Eclipse-SourceBundle"), //
- // SPDX
- /**
- * SPDX license identifier.
- *
- * @see https://spdx.org/licenses/
- */
- SPDX_LICENSE_IDENTIFIER("SPDX-License-Identifier"), //
- // Argeo Origin
- /**
- * Maven coordinates of the origin, possibly partial when using common.bnd or
- * merge.bnd.
- */
- ARGEO_ORIGIN_M2("Argeo-Origin-M2"), //
- /** List of Maven coordinates to merge. */
- ARGEO_ORIGIN_M2_MERGE("Argeo-Origin-M2-Merge"), //
- /** Maven repository, if not the default one. */
- ARGEO_ORIGIN_M2_REPO("Argeo-Origin-M2-Repo"), //
- /**
- * Do not perform BND analysis of the origin component. Typically IMport_package
- * and Export-Package will be kept untouched.
- */
- ARGEO_ORIGIN_MANIFEST_NOT_MODIFIED("Argeo-Origin-ManifestNotModified"), //
- /**
- * Origin (non-Maven) URI of the component. It may be anything (jar, archive,
- * etc.).
- */
- ARGEO_ORIGIN_URI("Argeo-Origin-URI"), //
- ;
+ void createReadMe(Path jarDir, Manifest manifest) throws IOException {
+ // write repackaged README
+ try (BufferedWriter writer = Files.newBufferedWriter(jarDir.resolve(README_REPACKAGED))) {
+ boolean merged = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_M2_MERGE.toString()) != null;
+ if (merged)
+ writer.append("This component is a merging of third party components"
+ + " in order to comply with A2 packaging standards.\n");
+ else
+ writer.append("This component is a repackaging of a third party component"
+ + " in order to comply with A2 packaging standards.\n");
+
+ 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
+ originDesc = manifest.getMainAttributes().getValue(ARGEO_ORIGIN_URI.toString());
+ if (originDesc != null)
+ writer.append("The original component comes from " + originDesc + ".\n");
+ else
+ logger.log(ERROR, "Cannot find origin information in " + jarDir);
+
+ writer.append("A detailed list of changes is available under " + CHANGES + ".\n");
+ if (!jarDir.getFileName().endsWith(".src")) {// binary archive
+ if (sourceBundles)
+ writer.append("Corresponding sources are available in the related archive named "
+ + jarDir.toString() + ".src.jar.\n");
+ else
+ writer.append("Corresponding sources are available under OSGI-OPT/src.\n");
+ }
+ }
- final String value;
+ }
- private ManifestConstants(String value) {
- this.value = value;
- }
+ /**
+ * Gathers modifications performed on the original binaries and sources,
+ * especially in order to comply with their license requirements.
+ */
+ class A2Origin {
+ A2Origin() {
- @Override
- 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<String> modified = new TreeSet<>();
- Set<String> deleted = new TreeSet<>();
- Set<String> added = new TreeSet<>();
- Set<String> 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");
- writer.flush();
+ Set<String> modified = new TreeSet<>();
+ Set<String> deleted = new TreeSet<>();
+ Set<String> added = new TreeSet<>();
+ Set<String> moved = new TreeSet<>();
+
+ /** Append changes to the A2-ORIGIN/changes file. */
+ void appendChanges(Path baseDirectory) throws IOException {
+ Path changesFile = baseDirectory.resolve(CHANGES);
+ Files.createDirectories(changesFile.getParent());
+ try (BufferedWriter writer = Files.newBufferedWriter(changesFile, APPEND, CREATE)) {
+ for (String msg : added)
+ writer.write("- Added " + msg + ".\n");
+ for (String msg : modified)
+ writer.write("- Modified " + msg + ".\n");
+ for (String msg : moved)
+ writer.write("- Moved " + msg + ".\n");
+ for (String msg : deleted)
+ writer.write("- Deleted " + msg + ".\n");
+ }
}
}
}
projects / cc0 / argeo-build.git / blobdiff