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.WARNING;
import java.io.File;
import java.io.IOException;
import java.lang.System.Logger;
import java.lang.System.Logger.Level;
import java.lang.management.ManagementFactory;
+import java.nio.file.DirectoryStream;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
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.attribute.BasicFileAttributes;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
+import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Properties;
import java.util.StringJoiner;
import java.util.StringTokenizer;
+import java.util.TreeMap;
import java.util.concurrent.CompletableFuture;
+import java.util.jar.Attributes;
import java.util.jar.JarEntry;
import java.util.jar.JarOutputStream;
import java.util.jar.Manifest;
private final static Logger logger = System.getLogger(Make.class.getName());
/**
- * Environment properties on whether sources should be packaged separately or
+ * Environment variable on whether sources should be packaged separately or
* integrated in the bundles.
*/
- private final static String ENV_BUILD_SOURCE_BUNDLES = "BUILD_SOURCE_BUNDLES";
+ private final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES";
+
+ /**
+ * Environment variable on whether legal files at the root of the sources should
+ * be included in the generated bundles. Should be set to true when building
+ * third-party software in order no to include the build harness license into
+ * the generated bundles.
+ */
+ private final static String ENV_NO_SDK_LEGAL = "NO_SDK_LEGAL";
+
+ /**
+ * Environment variable to override the default location for the Argeo Build
+ * configuration files. Typically used if Argeo Build has been compiled and
+ * packaged separately.
+ */
+ private final static String ENV_ARGEO_BUILD_CONFIG = "ARGEO_BUILD_CONFIG";
+
+ /** Make file variable (in {@link #SDK_MK}) with a path to the sources base. */
+ private final static String VAR_SDK_SRC_BASE = "SDK_SRC_BASE";
+
+ /**
+ * Make file variable (in {@link #SDK_MK}) with a path to the build output base.
+ */
+ private final static String VAR_SDK_BUILD_BASE = "SDK_BUILD_BASE";
+ /**
+ * Make file variable (in {@link #BRANCH_MK}) with the branch.
+ */
+ private final static String VAR_BRANCH = "BRANCH";
/** Name of the local-specific Makefile (sdk.mk). */
final static String SDK_MK = "sdk.mk";
/** Base of the source code, typically the cloned git repository. */
final Path sdkSrcBase;
/**
- * The base of the builder, typically a submodule pointing to the public
+ * The base of the builder, typically a submodule pointing to the INCLUDEpublic
* argeo-build directory.
*/
final Path argeoBuildBase;
final Path buildBase;
/** The base of the a2 output for all layers. */
final Path a2Output;
+ /** The base of the a2 sources when packaged separately. */
+ final Path a2srcOutput;
- /** Whether sources should be packaged separately */
+ /** Whether sources should be packaged separately. */
final boolean sourceBundles;
+ /** Whether common legal files should be included. */
+ final boolean noSdkLegal;
/** Constructor initialises the base directories. */
public Make() throws IOException {
- 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");
+ noSdkLegal = Boolean.parseBoolean(System.getenv(ENV_NO_SDK_LEGAL));
+ if (noSdkLegal)
+ logger.log(Level.INFO, "SDK legal files will NOT be included");
execDirectory = Paths.get(System.getProperty("user.dir"));
Path sdkMkP = findSdkMk(execDirectory);
Objects.requireNonNull(sdkMkP, "No " + SDK_MK + " found under " + execDirectory);
- Map<String, String> context = readeMakefileVariables(sdkMkP);
- sdkSrcBase = Paths.get(context.computeIfAbsent("SDK_SRC_BASE", (key) -> {
+ Map<String, String> context = readMakefileVariables(sdkMkP);
+ sdkSrcBase = Paths.get(context.computeIfAbsent(VAR_SDK_SRC_BASE, (key) -> {
throw new IllegalStateException(key + " not found");
})).toAbsolutePath();
- argeoBuildBase = sdkSrcBase.resolve("sdk/argeo-build");
- sdkBuildBase = Paths.get(context.computeIfAbsent("SDK_BUILD_BASE", (key) -> {
+ Path argeoBuildBaseT = sdkSrcBase.resolve("sdk/argeo-build");
+ if (!Files.exists(argeoBuildBaseT)) {
+ String fromEnv = System.getenv(ENV_ARGEO_BUILD_CONFIG);
+ if (fromEnv != null)
+ argeoBuildBaseT = Paths.get(fromEnv);
+ if (fromEnv == null || !Files.exists(argeoBuildBaseT)) {
+ throw new IllegalStateException(
+ "Argeo Build not found. Did you initialise the git submodules or set the "
+ + ENV_ARGEO_BUILD_CONFIG + " environment variable?");
+ }
+ }
+ argeoBuildBase = argeoBuildBaseT;
+
+ sdkBuildBase = Paths.get(context.computeIfAbsent(VAR_SDK_BUILD_BASE, (key) -> {
throw new IllegalStateException(key + " not found");
})).toAbsolutePath();
buildBase = sdkBuildBase.resolve(sdkSrcBase.getFileName());
a2Output = sdkBuildBase.resolve("a2");
+ a2srcOutput = sdkBuildBase.resolve("a2.src");
}
/*
}
/** Compile all the bundles which have been passed via the --bundle argument. */
- @SuppressWarnings("restriction")
void compile(Map<String, List<String>> options) throws IOException {
List<String> bundles = options.get("--bundles");
Objects.requireNonNull(bundles, "--bundles argument must be set");
List<String> a2Categories = options.getOrDefault("--dep-categories", new ArrayList<>());
List<String> a2Bases = options.getOrDefault("--a2-bases", new ArrayList<>());
- if (a2Bases.isEmpty()) {
+ if (a2Bases.isEmpty() || !a2Bases.contains(a2Output.toString())) {
a2Bases.add(a2Output.toString());
}
// classpath
if (!a2Categories.isEmpty()) {
- StringJoiner classPath = new StringJoiner(File.pathSeparator);
- StringJoiner modulePath = new StringJoiner(File.pathSeparator);
+ // We will keep only the highest major.minor
+ // and order by bundle name, for predictability
+ Map<String, A2Jar> a2Jars = new TreeMap<>();
+
+// StringJoiner modulePath = new StringJoiner(File.pathSeparator);
for (String a2Base : a2Bases) {
- for (String a2Category : a2Categories) {
+ categories: for (String a2Category : a2Categories) {
Path a2Dir = Paths.get(a2Base).resolve(a2Category);
if (!Files.exists(a2Dir))
- Files.createDirectories(a2Dir);
- modulePath.add(a2Dir.toString());
- for (Path jarP : Files.newDirectoryStream(a2Dir,
- (p) -> p.getFileName().toString().endsWith(".jar"))) {
- classPath.add(jarP.toString());
+ continue categories;
+// modulePath.add(a2Dir.toString());
+ for (Path jarP : Files.newDirectoryStream(a2Dir, (p) -> p.getFileName().toString().endsWith(".jar")
+ && !p.getFileName().toString().endsWith(".src.jar"))) {
+ A2Jar a2Jar = new A2Jar(jarP);
+ if (a2Jars.containsKey(a2Jar.name)) {
+ A2Jar current = a2Jars.get(a2Jar.name);
+ if (a2Jar.major > current.major)
+ a2Jars.put(a2Jar.name, a2Jar);
+ else if (a2Jar.major == current.major //
+ // if minor equals, we take the last one
+ && a2Jar.minor >= current.minor)
+ a2Jars.put(a2Jar.name, a2Jar);
+ } else {
+ a2Jars.put(a2Jar.name, a2Jar);
+ }
}
}
}
+
+ StringJoiner classPath = new StringJoiner(File.pathSeparator);
+ for (Iterator<A2Jar> it = a2Jars.values().iterator(); it.hasNext();)
+ classPath.add(it.next().path.toString());
+
compilerArgs.add("-cp");
compilerArgs.add(classPath.toString());
// compilerArgs.add("--module-path");
for (String bundle : bundles) {
StringBuilder sb = new StringBuilder();
Path bundlePath = execDirectory.resolve(bundle);
- if (!Files.exists(bundlePath))
- throw new IllegalArgumentException("Bundle " + bundle + " not found in " + execDirectory);
+ if (!Files.exists(bundlePath)) {
+ if (bundles.size() == 1) {
+ logger.log(WARNING, "Bundle " + bundle + " not found in " + execDirectory
+ + ", assuming this is this directory, as only one bundle was requested.");
+ bundlePath = execDirectory;
+ } else
+ throw new IllegalArgumentException("Bundle " + bundle + " not found in " + execDirectory);
+ }
sb.append(bundlePath.resolve("src"));
sb.append("[-d");
compilerArgs.add(sb.toString());
if (logger.isLoggable(INFO))
compilerArgs.add("-time");
-// for (String arg : compilerArgs)
-// System.out.println(arg);
+ if (logger.isLoggable(DEBUG)) {
+ logger.log(DEBUG, "Compiler arguments:");
+ for (String arg : compilerArgs)
+ logger.log(DEBUG, arg);
+ }
boolean success = org.eclipse.jdt.core.compiler.batch.BatchCompiler.compile(
compilerArgs.toArray(new String[compilerArgs.size()]), new PrintWriter(System.out),
return;
List<String> categories = options.get("--category");
- Objects.requireNonNull(bundles, "--category argument must be set");
+ Objects.requireNonNull(categories, "--category argument must be set");
if (categories.size() != 1)
throw new IllegalArgumentException("One and only one --category must be specified");
String category = categories.get(0);
+ final String branch;
Path branchMk = sdkSrcBase.resolve(BRANCH_MK);
- if (!Files.exists(branchMk))
- throw new IllegalStateException("No " + branchMk + " file available");
- Map<String, String> branchVariables = readeMakefileVariables(branchMk);
-
- String branch = branchVariables.get("BRANCH");
+ if (Files.exists(branchMk)) {
+ Map<String, String> branchVariables = readMakefileVariables(branchMk);
+ branch = branchVariables.get(VAR_BRANCH);
+ } else {
+ branch = null;
+ }
long begin = System.currentTimeMillis();
// create jars in parallel
logger.log(INFO, "Packaging took " + duration + " ms");
}
- /*
- * UTILITIES
- */
+ /** Install the bundles. */
+ void install(Map<String, List<String>> options, boolean uninstall) throws IOException {
+ // check arguments
+ List<String> bundles = options.get("--bundles");
+ Objects.requireNonNull(bundles, "--bundles argument must be set");
+ if (bundles.isEmpty())
+ return;
+
+ List<String> categories = options.get("--category");
+ Objects.requireNonNull(categories, "--category argument must be set");
+ if (categories.size() != 1)
+ throw new IllegalArgumentException("One and only one --category must be specified");
+ String category = categories.get(0);
+
+ List<String> targetDirs = options.get("--target");
+ Objects.requireNonNull(targetDirs, "--target argument must be set");
+ if (targetDirs.size() != 1)
+ throw new IllegalArgumentException("One and only one --target must be specified");
+ Path targetA2 = Paths.get(targetDirs.get(0));
+ logger.log(INFO, (uninstall ? "Uninstalling from " : "Installing to ") + targetA2);
+
+ final String branch;
+ Path branchMk = sdkSrcBase.resolve(BRANCH_MK);
+ if (Files.exists(branchMk)) {
+ Map<String, String> branchVariables = readMakefileVariables(branchMk);
+ branch = branchVariables.get(VAR_BRANCH);
+ } else {
+ throw new IllegalArgumentException(VAR_BRANCH + " variable must be set.");
+ }
+
+ Properties properties = new Properties();
+ Path branchBnd = sdkSrcBase.resolve("sdk/branches/" + branch + ".bnd");
+ if (Files.exists(branchBnd))
+ try (InputStream in = Files.newInputStream(branchBnd)) {
+ properties.load(in);
+ }
+ String major = properties.getProperty("major");
+ Objects.requireNonNull(major, "'major' must be set");
+ String minor = properties.getProperty("minor");
+ Objects.requireNonNull(minor, "'minor' must be set");
+
+ int count = 0;
+ for (String bundle : bundles) {
+ Path bundlePath = Paths.get(bundle);
+ Path bundleParent = bundlePath.getParent();
+ Path a2JarDirectory = bundleParent != null ? a2Output.resolve(bundleParent).resolve(category)
+ : a2Output.resolve(category);
+ Path jarP = a2JarDirectory.resolve(bundlePath.getFileName() + "." + major + "." + minor + ".jar");
+
+ Path targetJarP = targetA2.resolve(a2Output.relativize(jarP));
+ if (uninstall) { // uninstall
+ if (Files.exists(targetJarP)) {
+ Files.delete(targetJarP);
+ logger.log(DEBUG, "Removed " + targetJarP);
+ count++;
+ }
+ Path targetParent = targetJarP.getParent();
+ deleteEmptyParents(targetA2, targetParent);
+ } else { // install
+ Files.createDirectories(targetJarP.getParent());
+ boolean update = Files.exists(targetJarP);
+ Files.copy(jarP, targetJarP, StandardCopyOption.REPLACE_EXISTING);
+ logger.log(DEBUG, (update ? "Updated " : "Installed ") + targetJarP);
+ count++;
+ }
+ }
+ logger.log(INFO, uninstall ? count + " bundles removed" : count + " bundles installed or updated");
+ }
+
+ /** Delete empty parent directory up to the A2 target (included). */
+ void deleteEmptyParents(Path targetA2, Path targetParent) throws IOException {
+ if (!Files.isDirectory(targetParent))
+ throw new IllegalArgumentException(targetParent + " must be a directory");
+ boolean isA2target = Files.isSameFile(targetA2, targetParent);
+ if (!Files.list(targetParent).iterator().hasNext()) {
+ Files.delete(targetParent);
+ if (isA2target)
+ return;// stop after deleting A2 base
+ deleteEmptyParents(targetA2, targetParent.getParent());
+ }
+ }
+
/** Package a single bundle. */
void createBundle(String branch, String bundle, String category) throws IOException {
- Path source = execDirectory.resolve(bundle);
+ final Path source;
+ if (!Files.exists(execDirectory.resolve(bundle))) {
+ logger.log(WARNING,
+ "Bundle " + bundle + " not found in " + execDirectory + ", assuming this is this directory.");
+ source = execDirectory;
+ } else {
+ source = execDirectory.resolve(bundle);
+ }
+ Path srcP = source.resolve("src");
+
Path compiled = buildBase.resolve(bundle);
String bundleSymbolicName = source.getFileName().toString();
properties.load(in);
}
- Path branchBnd = sdkSrcBase.resolve("sdk/branches/" + branch + ".bnd");
- try (InputStream in = Files.newInputStream(branchBnd)) {
- properties.load(in);
+ if (branch != null) {
+ Path branchBnd = sdkSrcBase.resolve("sdk/branches/" + branch + ".bnd");
+ if (Files.exists(branchBnd))
+ try (InputStream in = Files.newInputStream(branchBnd)) {
+ properties.load(in);
+ }
}
Path bndBnd = source.resolve("bnd.bnd");
- try (InputStream in = Files.newInputStream(bndBnd)) {
- properties.load(in);
- }
+ if (Files.exists(bndBnd))
+ try (InputStream in = Files.newInputStream(bndBnd)) {
+ properties.load(in);
+ }
// Normalise
if (!properties.containsKey("Bundle-SymbolicName"))
Files.walkFileTree(source, new SimpleFileVisitor<Path>() {
@Override
public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) throws IOException {
+ // skip output directory if it happens to be within the sources
+ if (Files.isSameFile(sdkBuildBase, dir))
+ return FileVisitResult.SKIP_SUBTREE;
+
+ // skip excluded patterns
Path relativeP = source.relativize(dir);
for (PathMatcher exclude : excludes)
if (exclude.matches(relativeP))
}
});
- Path srcP = source.resolve("src");
// Add all resources from src/
Files.walkFileTree(srcP, new SimpleFileVisitor<Path>() {
@Override
}
});
+ // add legal notices and licenses
+ for (Path p : listLegalFilesToInclude(source).values()) {
+ jarOut.putNextEntry(new JarEntry(p.getFileName().toString()));
+ Files.copy(p, jarOut);
+ }
+
// add sources
// TODO add effective BND, Eclipse project file, etc., in order to be able to
// repackage
- if (sourceBundles) {
- // TODO package sources separately
- } else {
- Files.walkFileTree(srcP, new SimpleFileVisitor<Path>() {
- @Override
- public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
- jarOut.putNextEntry(new JarEntry("OSGI-OPT/src/" + srcP.relativize(file).toString()));
- if (!Files.isDirectory(file))
- Files.copy(file, jarOut);
- return FileVisitResult.CONTINUE;
- }
- });
+ if (!sourceBundles) {
+ copySourcesToJar(srcP, jarOut, "OSGI-OPT/src/");
+ }
+ }
+
+ if (sourceBundles) {// create separate sources jar
+ Path a2srcJarDirectory = bundleParent != null ? a2srcOutput.resolve(bundleParent).resolve(category)
+ : a2srcOutput.resolve(category);
+ Files.createDirectories(a2srcJarDirectory);
+ Path srcJarP = a2srcJarDirectory.resolve(compiled.getFileName() + "." + major + "." + minor + ".src.jar");
+ Manifest srcManifest = new Manifest();
+ srcManifest.getMainAttributes().put(Attributes.Name.MANIFEST_VERSION, "1.0");
+ srcManifest.getMainAttributes().putValue("Bundle-SymbolicName", bundleSymbolicName + ".src");
+ srcManifest.getMainAttributes().putValue("Bundle-Version",
+ manifest.getMainAttributes().getValue("Bundle-Version").toString());
+ srcManifest.getMainAttributes().putValue("Eclipse-SourceBundle",
+ bundleSymbolicName + ";version=\"" + manifest.getMainAttributes().getValue("Bundle-Version"));
+
+ try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) {
+ copySourcesToJar(srcP, srcJarOut, "");
+ // add legal notices and licenses
+ for (Path p : listLegalFilesToInclude(source).values()) {
+ srcJarOut.putNextEntry(new JarEntry(p.getFileName().toString()));
+ Files.copy(p, srcJarOut);
+ }
}
}
}
+ /** List the relevant legal files to include, from the SDK source base. */
+ Map<String, Path> listLegalFilesToInclude(Path bundleBase) throws IOException {
+ Map<String, Path> toInclude = new HashMap<>();
+ if (!noSdkLegal) {
+ DirectoryStream<Path> sdkSrcLegal = Files.newDirectoryStream(sdkSrcBase, (p) -> {
+ String fileName = p.getFileName().toString();
+ return switch (fileName) {
+ case "NOTICE":
+ case "LICENSE":
+ case "COPYING":
+ case "COPYING.LESSER":
+ yield true;
+ default:
+ yield false;
+ };
+ });
+ for (Path p : sdkSrcLegal)
+ toInclude.put(p.getFileName().toString(), p);
+ }
+ for (Iterator<Map.Entry<String, Path>> entries = toInclude.entrySet().iterator(); entries.hasNext();) {
+ Map.Entry<String, Path> entry = entries.next();
+ Path inBundle = bundleBase.resolve(entry.getValue().getFileName());
+ // remove file if it is also defined at bundle level
+ // since it has already been copied
+ // and has priority
+ if (Files.exists(inBundle))
+ entries.remove();
+ }
+ return toInclude;
+ }
+
+ /*
+ * UTILITIES
+ */
+ /** Add sources to a jar file */
+ void copySourcesToJar(Path srcP, JarOutputStream srcJarOut, String prefix) throws IOException {
+ Files.walkFileTree(srcP, new SimpleFileVisitor<Path>() {
+ @Override
+ public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
+ srcJarOut.putNextEntry(new JarEntry(prefix + srcP.relativize(file).toString()));
+ if (!Files.isDirectory(file))
+ Files.copy(file, srcJarOut);
+ return FileVisitResult.CONTINUE;
+ }
+ });
+ }
+
/**
* Recursively find the base source directory (which contains the
* <code>{@value #SDK_MK}</code> file).
* Reads Makefile variable assignments of the form =, :=, or ?=, ignoring white
* spaces. To be used with very simple included Makefiles only.
*/
- Map<String, String> readeMakefileVariables(Path path) throws IOException {
+ Map<String, String> readMakefileVariables(Path path) throws IOException {
Map<String, String> context = new HashMap<>();
List<String> sdkMkLines = Files.readAllLines(path);
lines: for (String line : sdkMkLines) {
case "compile" -> argeoMake.compile(options);
case "bundle" -> argeoMake.bundle(options);
case "all" -> argeoMake.all(options);
+ case "install" -> argeoMake.install(options, false);
+ case "uninstall" -> argeoMake.install(options, true);
default -> throw new IllegalArgumentException("Unkown action: " + action);
}
}
}
+ /** A jar file in A2 format */
+ static class A2Jar {
+ final Path path;
+ final String name;
+ final int major;
+ final int minor;
+
+ A2Jar(Path path) {
+ try {
+ this.path = path;
+ String fileName = path.getFileName().toString();
+ fileName = fileName.substring(0, fileName.lastIndexOf('.'));
+ minor = Integer.parseInt(fileName.substring(fileName.lastIndexOf('.') + 1));
+ fileName = fileName.substring(0, fileName.lastIndexOf('.'));
+ major = Integer.parseInt(fileName.substring(fileName.lastIndexOf('.') + 1));
+ name = fileName.substring(0, fileName.lastIndexOf('.'));
+ } catch (Exception e) {
+ throw new IllegalArgumentException("Badly formatted A2 jar " + path, e);
+ }
+ }
+ }
+
/**
* An ECJ {@link CompilationProgress} printing a progress bar while compiling.
*/
package org.argeo.build;
import static java.lang.System.Logger.Level.DEBUG;
-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.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 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.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_DO_NOT_MODIFY;
+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_SOURCES_URI;
+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;
+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.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;
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.Map;
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 java.util.jar.Attributes;
import java.util.jar.JarEntry;
import aQute.bnd.osgi.Analyzer;
import aQute.bnd.osgi.Jar;
-/** The central class for A2 packaging. */
+/** Repackages 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());
+
+ /**
+ * Environment variable on whether sources should be packaged separately or
+ * 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";
- private final static String ENV_BUILD_SOURCE_BUNDLES = "BUILD_SOURCE_BUNDLES";
+ /** 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]);
- toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(p)));
+ 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();
+ for (String licenseId : licensesUsed.keySet())
+ for (String name : licensesUsed.get(licenseId))
+ sb.append((licenseId.equals("") ? "Proprietary" : licenseId) + "\t\t" + name + "\n");
+ logger.log(INFO, "# License summary:\n" + sb);
}
- private final static String COMMON_BND = "common.bnd";
- private final static String MERGE_BND = "merge.bnd";
+ /** 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"), //
+ /**
+ * Origin (non-Maven) URI of the source of the component. It may be anything
+ * (jar, archive, code repository, etc.).
+ */
+ ARGEO_ORIGIN_SOURCES_URI("Argeo-Origin-Sources-URI"), //
+ ;
+
+ final String headerName;
- private Path originBase;
- private Path a2Base;
- private Path a2LibBase;
- private Path descriptorsBase;
+ private ManifestHeader(String headerName) {
+ this.headerName = headerName;
+ }
- private Properties uris = new Properties();
+ @Override
+ public String toString() {
+ return headerName;
+ }
- /** key is URI prefix, value list of base URLs */
- private Map<String, List<String>> mirrors = new HashMap<String, List<String>>();
+ /** Get the value from either a {@link Manifest} or a {@link Properties}. */
+ String get(Object map) {
+ if (map instanceof Manifest manifest)
+ return manifest.getMainAttributes().getValue(headerName);
+ else if (map instanceof Properties props)
+ return props.getProperty(headerName);
+ else
+ throw new IllegalArgumentException("Unsupported mapping " + map.getClass());
+ }
- private final boolean sourceBundles;
+ /** Put the value into either a {@link Manifest} or a {@link Properties}. */
+ void put(Object map, String value) {
+ if (map instanceof Manifest manifest)
+ manifest.getMainAttributes().putValue(headerName, value);
+ else if (map instanceof Properties props)
+ props.setProperty(headerName, value);
+ else
+ throw new IllegalArgumentException("Unsupported mapping " + map.getClass());
+ }
+ }
+ /** 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 ARGEO_ORIGIN = "ARGEO-ORIGIN";
+ /** File detailing modifications to the original component. */
+ 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.
+ */
+ 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 */
+ 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<String, List<String>> mirrors = new HashMap<String, List<String>>();
+
+ /** Whether sources should be packaged separately */
+ final boolean separateSources;
+
+ /** Constructor initialises the various variables */
public Repackage(Path a2Base, Path descriptorsBase) {
- sourceBundles = Boolean.parseBoolean(System.getenv(ENV_BUILD_SOURCE_BUNDLES));
- if (sourceBundles)
- logger.log(Level.INFO, "Sources will be packaged separately");
+ separateSources = Boolean.parseBoolean(System.getenv(ENV_SOURCE_BUNDLES));
+ if (separateSources)
+ 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 = separateSources ? a2Base.getParent().resolve(a2Base.getFileName() + ".src") : a2Base;
this.a2LibBase = a2Base.resolve("lib");
this.descriptorsBase = descriptorsBase;
if (!Files.exists(this.descriptorsBase))
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<Path> bnds = Files.newDirectoryStream(targetCategoryBase,
}
/** 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);
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())
- : 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);
}
- 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);
+ Path downloaded = downloadMaven(fileProps, artifact);
- downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir);
+ boolean doNotModify = Boolean
+ .parseBoolean(fileProps.getOrDefault(ARGEO_DO_NOT_MODIFY.toString(), "false").toString());
+ if (doNotModify) {
+ processNotModified(targetCategoryBase, downloaded, fileProps, artifact);
+ return;
+ }
- createJar(targetBundleDir);
+ // regular processing
+ A2Origin origin = new A2Origin();
+ Path bundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact, origin);
+ downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false, 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.
+ *
+ * @see #COMMON_BND
+ * @see #MERGE_BND
+ */
+ 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(":")) {
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);
+ 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();
- mergeProps.putAll(commonProps);
+ Properties mergedProps = new Properties();
+ mergedProps.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);
+ Object previousValue = mergedProps.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());
- if (!mergeProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
+ mergedProps.put(ARGEO_ORIGIN_M2.toString(), artifact.toM2Coordinates());
+ if (!mergedProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
// use file name as symbolic name
String symbolicName = p.getFileName().toString();
symbolicName = symbolicName.substring(0, symbolicName.length() - ".bnd".length());
- mergeProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName);
+ mergedProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName);
}
- String repoStr = mergeProps.containsKey(SLC_ORIGIN_M2_REPO.toString())
- ? mergeProps.getProperty(SLC_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);
+ Path downloaded = downloadMaven(mergedProps, artifact);
- // sources
- downloadAndProcessM2Sources(repoStr, artifact, targetBundleDir);
-
- createJar(targetBundleDir);
+ boolean doNotModify = Boolean
+ .parseBoolean(mergedProps.getOrDefault(ARGEO_DO_NOT_MODIFY.toString(), "false").toString());
+ if (doNotModify) {
+ processNotModified(targetCategoryBase, downloaded, mergedProps, artifact);
+ } else {
+ A2Origin origin = new A2Origin();
+ Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergedProps, artifact, origin);
+ downloadAndProcessM2Sources(mergedProps, artifact, targetBundleDir, false, 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);
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);
}
- // 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 merging in " + 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(ManifestConstants.SLC_ORIGIN_M2_MERGE.toString());
+ String artifactsStr = mergeProps.getProperty(ARGEO_ORIGIN_M2_MERGE.toString());
if (artifactsStr == null)
- throw new IllegalArgumentException(
- mergeBnd + ": " + ManifestConstants.SLC_ORIGIN_M2_MERGE + " must be set");
+ throw new IllegalArgumentException(mergeBnd + ": " + ARGEO_ORIGIN_M2_MERGE + " must be set");
- String repoStr = mergeProps.containsKey(SLC_ORIGIN_M2_REPO.toString())
- ? mergeProps.getProperty(SLC_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());
+
+ 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);
- URL url = M2ConventionsUtils.mavenRepoUrl(repoStr, artifact);
- Path downloaded = download(url, originBase, artifact);
+ originDesc.add(artifact.toString());
+ Path downloaded = downloadMaven(mergeProps, 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/"))
- continue entries;
- else if (entry.getName().equals("module-info.class"))
+ if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".DSA")
+ || entry.getName().endsWith(".SF")) {
+ origin.deleted.add("cryptographic signatures from " + artifact);
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(ARGEO_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(ARGEO_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);
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(mergeProps, artifact, bundleDir, true, false);
}
// 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());
}
}
+ // BND analysis
Map<String, String> 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();
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());
- // 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);
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(targetBundleDir);
+ createJar(bundleDir, origin);
}
- /** Generate MANIFEST using BND. */
- protected Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact) {
-
+ /** 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.SLC_ORIGIN_MANIFEST_NOT_MODIFIED.toString(), "false").toString());
-
- // we always force the symbolic name
+ boolean doNotModifyManifest = Boolean.parseBoolean(
+ fileProps.getOrDefault(ARGEO_ORIGIN_NO_METADATA_GENERATION.toString(), "false").toString());
- if (doNotModify) {
- fileEntries: for (Object key : fileProps.keySet()) {
- if (ManifestConstants.SLC_ORIGIN_M2.toString().equals(key))
- continue fileEntries;
+ // Note: we always force the symbolic name
+ 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))\""))
- continue keys;// hack for very old classes
+ && 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());
- // 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);
}
- /** Download and integrates sources for a single Maven artifact. */
- protected void downloadAndProcessM2Sources(String repoStr, M2Artifact artifact, Path targetBundleDir)
+ /** Process an artifact that should not be modified. */
+ void processNotModified(Path targetCategoryBase, Path downloaded, Properties fileProps, M2Artifact artifact)
throws IOException {
- if (sourceBundles)
- return;
+ // Some proprietary or signed artifacts do not allow any modification
+ // When releasing (with separate sources), we just copy it
+ Path unmodifiedTarget = targetCategoryBase
+ .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch() + ".jar");
+ Files.createDirectories(unmodifiedTarget.getParent());
+ Files.copy(downloaded, unmodifiedTarget, StandardCopyOption.REPLACE_EXISTING);
+ Path bundleDir = targetCategoryBase
+ .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch());
+ downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false, true);
+ Manifest manifest;
+ try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(unmodifiedTarget))) {
+ manifest = jarIn.getManifest();
+ }
+ createSourceJar(bundleDir, manifest, fileProps);
+ }
+
+ /** Download and integrates sources for a single Maven artifact. */
+ void downloadAndProcessM2Sources(Properties props, M2Artifact artifact, Path targetBundleDir, boolean merging,
+ boolean unmodified) throws IOException {
try {
+ String repoStr = props.containsKey(ARGEO_ORIGIN_M2_REPO.toString())
+ ? props.getProperty(ARGEO_ORIGIN_M2_REPO.toString())
+ : null;
+ String alternateUri = props.getProperty(ARGEO_ORIGIN_SOURCES_URI.toString());
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);
+ URL sourcesUrl = alternateUri != null ? new URL(alternateUri)
+ : M2ConventionsUtils.mavenRepoUrl(repoStr, sourcesArtifact);
+ Path sourcesDownloaded = downloadMaven(sourcesUrl, sourcesArtifact);
+ processM2SourceJar(sourcesDownloaded, targetBundleDir, merging ? artifact : null, unmodified);
+ 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, boolean unmodified) throws IOException {
+ A2Origin origin = new A2Origin();
+ Path sourceDir = separateSources || unmodified ? 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) {
+ 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("module-info.java"))// skip META-INF entries
+ if (entry.getName().equals("META-INF/MANIFEST.MF")) {// skip META-INF entries
+ origin.deleted.add("MANIFEST.MF from the sources" + mergingMsg);
continue entries;
- if (entry.getName().startsWith("/")) // absolute paths
- continue entries;
- Path target = targetSourceDir.resolve(entry.getName());
+ }
+ if (!unmodified) {
+ 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
+ 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(relPath);
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 (separateSources || unmodified) {
+ 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(Properties props, M2Artifact artifact) throws IOException {
+ String repoStr = props.containsKey(ARGEO_ORIGIN_M2_REPO.toString())
+ ? props.getProperty(ARGEO_ORIGIN_M2_REPO.toString())
+ : null;
+ String alternateUri = props.getProperty(ARGEO_ORIGIN_URI.toString());
+ URL url = alternateUri != null ? new URL(alternateUri) : M2ConventionsUtils.mavenRepoUrl(repoStr, artifact);
+ return downloadMaven(url, artifact);
}
/** 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) throws IOException {
+ return download(url, mavenBase, M2ConventionsUtils.artifactPath("", artifact));
}
/*
* 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);
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);
}
}
+ // keys are the bundle directories
+ Map<Path, A2Origin> origins = new HashMap<>();
Files.walkFileTree(zipFs.getRootDirectories().iterator().next(), new SimpleFileVisitor<Path>() {
@Override
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<String, String> 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;
}
}
});
- DirectoryStream<Path> dirs = Files.newDirectoryStream(targetCategoryBase,
- (p) -> Files.isDirectory(p) && p.getFileName().toString().indexOf('.') >= 0);
- for (Path dir : dirs) {
- createJar(dir);
+ DirectoryStream<Path> 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);
}
/** 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");
+ Path sourceDir = separateSources ? bundleDir.getParent().resolve(bundleDir.toString() + ".src")
+ : bundleDir.resolve("OSGI-OPT/src");
- // TODO make it less dangerous?
- if (Files.exists(targetSourceDir)) {
-// deleteDirectory(targetSourceDir);
- } else {
- Files.createDirectories(targetSourceDir);
- }
-
- // 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 (separateSources) {
+ 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<String, String> entries) throws IOException {
+ /** 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());
+ boolean doNotModify = Boolean
+ .parseBoolean(entries.getOrDefault(ManifestHeader.ARGEO_DO_NOT_MODIFY.toString(), "false").toString());
NameVersion nameVersion;
- Path targetBundleDir;
+ 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(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++) {
logger.log(DEBUG, file.getFileName() + " is a singleton");
}
}
-
// remove problematic entries in MANIFEST
manifest.getEntries().clear();
} 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);
}
nameVersion.setName(ourSymbolicName);
}
}
- targetBundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch());
+ bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch());
+
+ // 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 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;
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();
}
+// 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(".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
+ if (!doNotModify) {
+ 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 = targetBundleDir.resolve(entry.getName());
+ }
+ Path target = bundleDir.resolve(entry.getName());
Files.createDirectories(target.getParent());
Files.copy(jarIn, target);
// native libraries
if (isNative && (entry.getName().endsWith(".so") || entry.getName().endsWith(".dll")
|| entry.getName().endsWith(".jnilib"))) {
- Path categoryDir = targetBundleDir.getParent();
-// String[] segments = categoryDir.getFileName().toString().split("\\.");
-// String arch = segments[segments.length - 1];
-// String os = segments[segments.length - 2];
+ Path categoryDir = bundleDir.getParent();
boolean copyDll = false;
- Path targetDll = categoryDir.resolve(targetBundleDir.relativize(target));
+ Path targetDll = categoryDir.resolve(bundleDir.relativize(target));
if (nameVersion.getName().equals("com.sun.jna")) {
if (arch.equals("x86_64"))
arch = "x86-64";
Files.copy(target, targetDll);
}
Files.delete(target);
+ origin.deleted.add(bundleDir.relativize(target).toString());
}
- logger.log(Level.TRACE, () -> "Copied " + target);
+ logger.log(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(ManifestHeader.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
+ // 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;
+
+ 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 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);
+ origin.modified.add("MANIFEST header " + key);
}
- 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());
}
}
- return targetBundleDir;
+
+ 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();
+
+ 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);
+ if (!licensesUsed.containsKey(spdxLicenceId))
+ licensesUsed.put(spdxLicenceId, new TreeSet<>());
+ licensesUsed.get(spdxLicenceId).add(bundleDir.getParent().getFileName() + "/" + bundleDir.getFileName());
+ }
}
/*
* 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<Path>() {
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());
+ 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);
}
/** 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<String> urlBases = null;
String uriPrefix = null;
}
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);
}
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());
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 {
- // Create the jar
- Path jarPath = bundleDir.getParent().resolve(bundleDir.getFileName() + ".jar");
+ Path createJar(Path bundleDir, A2Origin origin) throws IOException {
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)) {
jarOut.setLevel(Deflater.DEFAULT_COMPRESSION);
Files.walkFileTree(bundleDir, new SimpleFileVisitor<Path>() {
});
}
deleteDirectory(bundleDir);
+
+ if (separateSources)
+ createSourceJar(bundleDir, manifest, null);
+
return jarPath;
}
- enum ManifestConstants {
- // OSGi
- BUNDLE_SYMBOLICNAME("Bundle-SymbolicName"), //
- BUNDLE_VERSION("Bundle-Version"), //
- BUNDLE_LICENSE("Bundle-License"), //
- EXPORT_PACKAGE("Export-Package"), //
- IMPORT_PACKAGE("Import-Package"), //
- // JAVA
- 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"),//
- ;
+ /** Package sources separately, in the Eclipse-SourceBundle format. */
+ void createSourceJar(Path bundleDir, Manifest manifest, Properties props) throws IOException {
+ boolean unmodified = props != null;
+ Path bundleCategoryDir = bundleDir.getParent();
+ Path sourceDir = bundleCategoryDir.resolve(bundleDir.toString() + ".src");
+ if (!Files.exists(sourceDir)) {
+ logger.log(WARNING, sourceDir + " does not exist, skipping...");
+ return;
+ }
- final String value;
+ 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");
+ BUNDLE_SYMBOLICNAME.put(srcManifest, bundleSymbolicName + ".src");
+ BUNDLE_VERSION.put(srcManifest, BUNDLE_VERSION.get(manifest));
+ ECLIPSE_SOURCE_BUNDLE.put(srcManifest,
+ bundleSymbolicName + ";version=\"" + BUNDLE_VERSION.get(manifest) + "\"");
+
+ // metadata
+ createReadMe(sourceDir, unmodified ? props : manifest);
+ // create jar
+ try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) {
+ // srcJarOut.setLevel(Deflater.BEST_COMPRESSION);
+ Files.walkFileTree(sourceDir, new SimpleFileVisitor<Path>() {
- private ManifestConstants(String value) {
- this.value = value;
- }
+ @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);
+ }
- @Override
- public String toString() {
- return value;
+ });
}
+ deleteDirectory(sourceDir);
+ }
+ /**
+ * Generate a readme clarifying and prominently notifying of the repackaging and
+ * modifications.
+ */
+ void createReadMe(Path jarDir, Object mapping) throws IOException {
+ // write repackaged README
+ try (BufferedWriter writer = Files.newBufferedWriter(jarDir.resolve(README_REPACKAGED))) {
+ boolean merged = ARGEO_ORIGIN_M2_MERGE.get(mapping) != 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");
+
+ // license
+ String spdxLicenseId = SPDX_LICENSE_IDENTIFIER.get(mapping);
+ 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 = BUNDLE_LICENSE.get(mapping);
+ if (url != null) {
+ writer.write("which is available here: " + url + "\n");
+ } else {
+ logger.log(ERROR, "No licence URL for " + jarDir);
+ }
+ }
+
+ // origin
+ String originDesc = ARGEO_ORIGIN_URI.get(mapping);
+ if (originDesc != null)
+ writer.append("\nThe original component comes from " + originDesc + ".\n");
+ else {
+ String m2Repo = ARGEO_ORIGIN_M2_REPO.get(mapping);
+ originDesc = ARGEO_ORIGIN_M2.get(mapping);
+ if (originDesc != null)
+ writer.append("\nThe original component has M2 coordinates:\n" + originDesc.replace(',', '\n')
+ + "\n" + (m2Repo != null ? "\nin M2 repository " + m2Repo + "\n" : ""));
+ else
+ logger.log(ERROR, "Cannot find origin information in " + jarDir);
+ }
+ String originSources = ARGEO_ORIGIN_SOURCES_URI.get(mapping);
+ if (originSources != null)
+ writer.append("\nThe original sources come from " + originSources + ".\n");
+
+ if (Files.exists(jarDir.resolve(CHANGES)))
+ writer.append("\nA detailed list of changes is available under " + CHANGES + ".\n");
+
+ if (!jarDir.getFileName().toString().endsWith(".src")) {// binary archive
+ if (separateSources)
+ 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");
+ }
+ }
}
+ /**
+ * Gathers modifications performed on the original binaries and sources,
+ * especially in order to comply with their license requirements.
+ */
+ class A2Origin {
+ 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 {
+ if (modified.isEmpty() && deleted.isEmpty() && added.isEmpty() && moved.isEmpty())
+ return; // no changes
+ 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");
+ }
+ }
+ }
}
/** Simple representation of an M2 artifact. */
/** Absolute path to the directories where the files will be stored */
static String artifactParentPath(String artifactBasePath, M2Artifact artifact) {
- return artifactBasePath + (artifactBasePath.endsWith("/") ? "" : "/") + artifactParentPath(artifact);
+ return artifactBasePath + (artifactBasePath.endsWith("/") || artifactBasePath.equals("") ? "" : "/")
+ + artifactParentPath(artifact);
}
/** Relative path to the directories where the files will be stored */
}
}
+/** Combination of a category, a name and a version. */
class CategoryNameVersion extends NameVersion {
private String category;
}
+/** Combination of a name and a version. */
class NameVersion implements Comparable<NameVersion> {
private String name;
private String version;
projects / cc0 / argeo-build.git / commitdiff