Repackage.java

   1 package org.argeo.build;
   2
   3 import static java.lang.System.Logger.Level.DEBUG;
   4 import static java.lang.System.Logger.Level.ERROR;
   5 import static java.lang.System.Logger.Level.INFO;
   6 import static java.lang.System.Logger.Level.TRACE;
   7 import static java.lang.System.Logger.Level.WARNING;
   8 import static java.nio.file.FileVisitResult.CONTINUE;
   9 import static java.nio.file.StandardOpenOption.APPEND;
  10 import static java.nio.file.StandardOpenOption.CREATE;
  11 import static java.util.jar.Attributes.Name.MANIFEST_VERSION;
  12 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_DO_NOT_MODIFY;
  13 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2;
  14 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_MERGE;
  15 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_M2_REPO;
  16 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_NO_METADATA_GENERATION;
  17 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_SOURCES_URI;
  18 import static org.argeo.build.Repackage.ManifestHeader.ARGEO_ORIGIN_URI;
  19 import static org.argeo.build.Repackage.ManifestHeader.AUTOMATIC_MODULE_NAME;
  20 import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_LICENSE;
  21 import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_SYMBOLICNAME;
  22 import static org.argeo.build.Repackage.ManifestHeader.BUNDLE_VERSION;
  23 import static org.argeo.build.Repackage.ManifestHeader.ECLIPSE_SOURCE_BUNDLE;
  24 import static org.argeo.build.Repackage.ManifestHeader.EXPORT_PACKAGE;
  25 import static org.argeo.build.Repackage.ManifestHeader.IMPORT_PACKAGE;
  26 import static org.argeo.build.Repackage.ManifestHeader.SPDX_LICENSE_IDENTIFIER;
  27
  28 import java.io.BufferedWriter;
  29 import java.io.File;
  30 import java.io.FileNotFoundException;
  31 import java.io.IOException;
  32 import java.io.InputStream;
  33 import java.io.OutputStream;
  34 import java.lang.System.Logger;
  35 import java.net.MalformedURLException;
  36 import java.net.URL;
  37 import java.nio.charset.StandardCharsets;
  38 import java.nio.file.DirectoryStream;
  39 import java.nio.file.FileSystem;
  40 import java.nio.file.FileSystems;
  41 import java.nio.file.FileVisitResult;
  42 import java.nio.file.Files;
  43 import java.nio.file.Path;
  44 import java.nio.file.PathMatcher;
  45 import java.nio.file.Paths;
  46 import java.nio.file.SimpleFileVisitor;
  47 import java.nio.file.StandardCopyOption;
  48 import java.nio.file.StandardOpenOption;
  49 import java.nio.file.attribute.BasicFileAttributes;
  50 import java.util.ArrayList;
  51 import java.util.HashMap;
  52 import java.util.Iterator;
  53 import java.util.List;
  54 import java.util.Map;
  55 import java.util.Objects;
  56 import java.util.Properties;
  57 import java.util.Set;
  58 import java.util.StringJoiner;
  59 import java.util.TreeMap;
  60 import java.util.TreeSet;
  61 import java.util.concurrent.CompletableFuture;
  62 import java.util.jar.Attributes;
  63 import java.util.jar.JarEntry;
  64 import java.util.jar.JarInputStream;
  65 import java.util.jar.JarOutputStream;
  66 import java.util.jar.Manifest;
  67 import java.util.zip.Deflater;
  68
  69 import aQute.bnd.osgi.Analyzer;
  70 import aQute.bnd.osgi.Jar;
  71
  72 /** Repackages existing jar files into OSGi bundles in an A2 repository. */
  73 public class Repackage {
  74         final static Logger logger = System.getLogger(Repackage.class.getName());
  75
  76         /**
  77          * Environment variable on whether sources should be packaged separately or
  78          * integrated in the bundles.
  79          */
  80         final static String ENV_SOURCE_BUNDLES = "SOURCE_BUNDLES";
  81         /** Environment variable on whether operations should be parallelised. */
  82         final static String ENV_ARGEO_BUILD_SEQUENTIAL = "ARGEO_BUILD_SEQUENTIAL";
  83
  84         /** Whether repackaging should run in parallel (default) or sequentially. */
  85         final static boolean sequential = Boolean.parseBoolean(System.getenv(ENV_ARGEO_BUILD_SEQUENTIAL));
  86
  87         /** Main entry point. */
  88         public static void main(String[] args) {
  89                 if (sequential)
  90                         logger.log(INFO, "Build will be sequential");
  91                 if (args.length < 2) {
  92                         System.err.println("Usage: <path to a2 output dir> <category1> <category2> ...");
  93                         System.exit(1);
  94                 }
  95                 Path a2Base = Paths.get(args[0]).toAbsolutePath().normalize();
  96                 Path descriptorsBase = Paths.get(".").toAbsolutePath().normalize();
  97                 Repackage factory = new Repackage(a2Base, descriptorsBase);
  98
  99                 List<CompletableFuture<Void>> toDos = new ArrayList<>();
 100                 for (int i = 1; i < args.length; i++) {
 101                         Path categoryPath = Paths.get(args[i]);
 102                         factory.cleanPreviousFailedBuild(categoryPath);
 103                         if (sequential) // sequential processing happens here
 104                                 factory.processCategory(categoryPath);
 105                         else
 106                                 toDos.add(CompletableFuture.runAsync(() -> factory.processCategory(categoryPath)));
 107                 }
 108                 if (!sequential)// parallel processing
 109                         CompletableFuture.allOf(toDos.toArray(new CompletableFuture[toDos.size()])).join();
 110
 111                 // Summary
 112                 StringBuilder sb = new StringBuilder();
 113                 for (String licenseId : licensesUsed.keySet())
 114                         for (String name : licensesUsed.get(licenseId))
 115                                 sb.append((licenseId.equals("") ? "Proprietary" : licenseId) + "\t\t" + name + "\n");
 116                 logger.log(INFO, "# License summary:\n" + sb);
 117         }
 118
 119         /** Deletes remaining sub directories. */
 120         void cleanPreviousFailedBuild(Path categoryPath) {
 121                 Path outputCategoryPath = a2Base.resolve(categoryPath);
 122                 if (!Files.exists(outputCategoryPath))
 123                         return;
 124                 // clean previous failed build
 125                 try {
 126                         for (Path subDir : Files.newDirectoryStream(outputCategoryPath, (d) -> Files.isDirectory(d))) {
 127                                 if (Files.exists(subDir)) {
 128                                         logger.log(WARNING, "Bundle dir " + subDir
 129                                                         + " already exists, probably from a previous failed build, deleting it...");
 130                                         deleteDirectory(subDir);
 131                                 }
 132                         }
 133                 } catch (IOException e) {
 134                         logger.log(ERROR, "Cannot clean previous build", e);
 135                 }
 136         }
 137
 138         /** MANIFEST headers. */
 139         enum ManifestHeader {
 140                 // OSGi
 141                 /** OSGi bundle symbolic name. */
 142                 BUNDLE_SYMBOLICNAME("Bundle-SymbolicName"), //
 143                 /** OSGi bundle version. */
 144                 BUNDLE_VERSION("Bundle-Version"), //
 145                 /** OSGi bundle license. */
 146                 BUNDLE_LICENSE("Bundle-License"), //
 147                 /** OSGi exported packages list. */
 148                 EXPORT_PACKAGE("Export-Package"), //
 149                 /** OSGi imported packages list. */
 150                 IMPORT_PACKAGE("Import-Package"), //
 151                 /** OSGi path to embedded jar. */
 152                 BUNDLE_CLASSPATH("Bundle-Classpath"), //
 153                 // Java
 154                 /** Java module name. */
 155                 AUTOMATIC_MODULE_NAME("Automatic-Module-Name"), //
 156                 // Eclipse
 157                 /** Eclipse source bundle. */
 158                 ECLIPSE_SOURCE_BUNDLE("Eclipse-SourceBundle"), //
 159                 // SPDX
 160                 /**
 161                  * SPDX license identifier.
 162                  *
 163                  * @see https://spdx.org/licenses/
 164                  */
 165                 SPDX_LICENSE_IDENTIFIER("SPDX-License-Identifier"), //
 166                 // Argeo Origin
 167                 /**
 168                  * Maven coordinates of the origin, possibly partial when using common.bnd or
 169                  * merge.bnd.
 170                  */
 171                 ARGEO_ORIGIN_M2("Argeo-Origin-M2"), //
 172                 /** List of Maven coordinates to merge. */
 173                 ARGEO_ORIGIN_M2_MERGE("Argeo-Origin-M2-Merge"), //
 174                 /** Maven repository, if not the default one. */
 175                 ARGEO_ORIGIN_M2_REPO("Argeo-Origin-M2-Repo"), //
 176                 /**
 177                  * Do not perform BND analysis of the origin component. Typically Import_package
 178                  * and Export-Package will be kept untouched.
 179                  */
 180                 ARGEO_ORIGIN_NO_METADATA_GENERATION("Argeo-Origin-NoMetadataGeneration"), //
 181 //              /**
 182 //               * Embed the original jar without modifying it (may be required by some
 183 //               * proprietary licenses, such as JCR Day License).
 184 //               */
 185 //              ARGEO_ORIGIN_EMBED("Argeo-Origin-Embed"), //
 186                 /**
 187                  * Do not modify original jar (may be required by some proprietary licenses,
 188                  * such as JCR Day License).
 189                  */
 190                 ARGEO_DO_NOT_MODIFY("Argeo-Origin-Do-Not-Modify"), //
 191                 /**
 192                  * Origin (non-Maven) URI of the component. It may be anything (jar, archive,
 193                  * etc.).
 194                  */
 195                 ARGEO_ORIGIN_URI("Argeo-Origin-URI"), //
 196                 /**
 197                  * Origin (non-Maven) URI of the source of the component. It may be anything
 198                  * (jar, archive, code repository, etc.).
 199                  */
 200                 ARGEO_ORIGIN_SOURCES_URI("Argeo-Origin-Sources-URI"), //
 201                 ;
 202
 203                 final String headerName;
 204
 205                 private ManifestHeader(String headerName) {
 206                         this.headerName = headerName;
 207                 }
 208
 209                 @Override
 210                 public String toString() {
 211                         return headerName;
 212                 }
 213
 214                 /** Get the value from either a {@link Manifest} or a {@link Properties}. */
 215                 String get(Object map) {
 216                         if (map instanceof Manifest manifest)
 217                                 return manifest.getMainAttributes().getValue(headerName);
 218                         else if (map instanceof Properties props)
 219                                 return props.getProperty(headerName);
 220                         else
 221                                 throw new IllegalArgumentException("Unsupported mapping " + map.getClass());
 222                 }
 223
 224                 /** Put the value into either a {@link Manifest} or a {@link Properties}. */
 225                 void put(Object map, String value) {
 226                         if (map instanceof Manifest manifest)
 227                                 manifest.getMainAttributes().putValue(headerName, value);
 228                         else if (map instanceof Properties props)
 229                                 props.setProperty(headerName, value);
 230                         else
 231                                 throw new IllegalArgumentException("Unsupported mapping " + map.getClass());
 232                 }
 233         }
 234
 235         /** Name of the file centralising information for multiple M2 artifacts. */
 236         final static String COMMON_BND = "common.bnd";
 237         /** Name of the file centralising information for mergin M2 artifacts. */
 238         final static String MERGE_BND = "merge.bnd";
 239         /**
 240          * Subdirectory of the jar file where origin informations (changes, legal
 241          * notices etc. are stored)
 242          */
 243         final static String ARGEO_ORIGIN = "ARGEO-ORIGIN";
 244         /** File detailing modifications to the original component. */
 245         final static String CHANGES = ARGEO_ORIGIN + "/changes";
 246         /**
 247          * Name of the file at the root of the repackaged jar, which prominently
 248          * notifies that the component has be repackaged.
 249          */
 250         final static String README_REPACKAGED = "README.repackaged";
 251
 252         // cache
 253         /** Summary of all license seen during the repackaging. */
 254         final static Map<String, Set<String>> licensesUsed = new TreeMap<>();
 255
 256         /** Directory where to download archives */
 257         final Path originBase;
 258         /** Directory where to download Maven artifacts */
 259         final Path mavenBase;
 260
 261         /** A2 repository base for binary bundles */
 262         final Path a2Base;
 263         /** A2 repository base for source bundles */
 264         final Path a2SrcBase;
 265         /** A2 base for native components */
 266         final Path a2LibBase;
 267         /** Location of the descriptors driving the packaging */
 268         final Path descriptorsBase;
 269         /** URIs of archives to download */
 270         final Properties uris = new Properties();
 271         /** Mirrors for archive download. Key is URI prefix, value list of base URLs */
 272         final Map<String, List<String>> mirrors = new HashMap<String, List<String>>();
 273
 274         /** Whether sources should be packaged separately */
 275         final boolean separateSources;
 276
 277         /** Constructor initialises the various variables */
 278         public Repackage(Path a2Base, Path descriptorsBase) {
 279                 separateSources = Boolean.parseBoolean(System.getenv(ENV_SOURCE_BUNDLES));
 280                 if (separateSources)
 281                         logger.log(INFO, "Sources will be packaged separately");
 282
 283                 Objects.requireNonNull(a2Base);
 284                 Objects.requireNonNull(descriptorsBase);
 285                 this.originBase = Paths.get(System.getProperty("user.home"), ".cache", "argeo/build/origin");
 286                 this.mavenBase = Paths.get(System.getProperty("user.home"), ".m2", "repository");
 287
 288                 // TODO define and use a build base
 289                 this.a2Base = a2Base;
 290                 this.a2SrcBase = separateSources ? a2Base.getParent().resolve(a2Base.getFileName() + ".src") : a2Base;
 291                 this.a2LibBase = a2Base.resolve("lib");
 292                 this.descriptorsBase = descriptorsBase;
 293                 if (!Files.exists(this.descriptorsBase))
 294                         throw new IllegalArgumentException(this.descriptorsBase + " does not exist");
 295
 296                 // URIs mapping
 297                 Path urisPath = this.descriptorsBase.resolve("uris.properties");
 298                 if (Files.exists(urisPath)) {
 299                         try (InputStream in = Files.newInputStream(urisPath)) {
 300                                 uris.load(in);
 301                         } catch (IOException e) {
 302                                 throw new IllegalStateException("Cannot load " + urisPath, e);
 303                         }
 304                 }
 305
 306                 // Eclipse mirrors
 307                 Path eclipseMirrorsPath = this.descriptorsBase.resolve("eclipse.mirrors.txt");
 308                 List<String> eclipseMirrors = new ArrayList<>();
 309                 if (Files.exists(eclipseMirrorsPath)) {
 310                         try {
 311                                 eclipseMirrors = Files.readAllLines(eclipseMirrorsPath, StandardCharsets.UTF_8);
 312                         } catch (IOException e) {
 313                                 throw new IllegalStateException("Cannot load " + eclipseMirrorsPath, e);
 314                         }
 315                         for (Iterator<String> it = eclipseMirrors.iterator(); it.hasNext();) {
 316                                 String value = it.next();
 317                                 if (value.strip().equals(""))
 318                                         it.remove();
 319                         }
 320                 }
 321                 mirrors.put("http://www.eclipse.org/downloads", eclipseMirrors);
 322         }
 323
 324         /*
 325          * MAVEN ORIGIN
 326          */
 327         /** Process a whole category/group id. */
 328         void processCategory(Path categoryRelativePath) {
 329                 try {
 330                         Path targetCategoryBase = descriptorsBase.resolve(categoryRelativePath);
 331                         DirectoryStream<Path> bnds = Files.newDirectoryStream(targetCategoryBase,
 332                                         (p) -> p.getFileName().toString().endsWith(".bnd") && !p.getFileName().toString().equals(COMMON_BND)
 333                                                         && !p.getFileName().toString().equals(MERGE_BND));
 334                         for (Path p : bnds) {
 335                                 processSingleM2ArtifactDistributionUnit(p);
 336                         }
 337
 338                         DirectoryStream<Path> dus = Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p));
 339                         for (Path duDir : dus) {
 340                                 if (duDir.getFileName().toString().startsWith("eclipse-")) {
 341                                         processEclipseArchive(duDir);
 342                                 } else {
 343                                         processM2BasedDistributionUnit(duDir);
 344                                 }
 345                         }
 346                 } catch (IOException e) {
 347                         throw new RuntimeException("Cannot process category " + categoryRelativePath, e);
 348                 }
 349         }
 350
 351         /** Process a standalone Maven artifact. */
 352         void processSingleM2ArtifactDistributionUnit(Path bndFile) {
 353                 try {
 354                         Path categoryRelativePath = descriptorsBase.relativize(bndFile.getParent());
 355                         Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
 356
 357                         Properties fileProps = new Properties();
 358                         try (InputStream in = Files.newInputStream(bndFile)) {
 359                                 fileProps.load(in);
 360                         }
 361                         // use file name as symbolic name
 362                         if (!fileProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
 363                                 String symbolicName = bndFile.getFileName().toString();
 364                                 symbolicName = symbolicName.substring(0, symbolicName.length() - ".bnd".length());
 365                                 fileProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName);
 366                         }
 367
 368                         String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString());
 369                         if (m2Coordinates == null)
 370                                 throw new IllegalArgumentException("No M2 coordinates available for " + bndFile);
 371                         M2Artifact artifact = new M2Artifact(m2Coordinates);
 372
 373                         Path downloaded = downloadMaven(fileProps, artifact);
 374
 375                         boolean doNotModify = Boolean
 376                                         .parseBoolean(fileProps.getOrDefault(ARGEO_DO_NOT_MODIFY.toString(), "false").toString());
 377                         if (doNotModify) {
 378                                 processNotModified(targetCategoryBase, downloaded, fileProps, artifact);
 379                                 return;
 380                         }
 381
 382                         // regular processing
 383                         A2Origin origin = new A2Origin();
 384                         Path bundleDir = processBndJar(downloaded, targetCategoryBase, fileProps, artifact, origin);
 385                         downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false, false);
 386                         createJar(bundleDir, origin);
 387                 } catch (Exception e) {
 388                         throw new RuntimeException("Cannot process " + bndFile, e);
 389                 }
 390         }
 391
 392         /**
 393          * Process multiple Maven artifacts coming from a same project and therefore
 394          * with information in common (typically the version), generating single bundles
 395          * or merging them if necessary.
 396          *
 397          * @see #COMMON_BND
 398          * @see #MERGE_BND
 399          */
 400         void processM2BasedDistributionUnit(Path duDir) {
 401                 try {
 402                         Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent());
 403                         Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
 404
 405                         Path mergeBnd = duDir.resolve(MERGE_BND);
 406                         if (Files.exists(mergeBnd)) // merge
 407                                 mergeM2Artifacts(mergeBnd);
 408
 409                         Path commonBnd = duDir.resolve(COMMON_BND);
 410                         if (!Files.exists(commonBnd))
 411                                 return;
 412
 413                         Properties commonProps = new Properties();
 414                         try (InputStream in = Files.newInputStream(commonBnd)) {
 415                                 commonProps.load(in);
 416                         }
 417
 418                         String m2Version = commonProps.getProperty(ARGEO_ORIGIN_M2.toString());
 419                         if (m2Version == null) {
 420                                 logger.log(WARNING, "Ignoring " + duDir + " as it is not an M2-based distribution unit");
 421                                 return;// ignore, this is probably an Eclipse archive
 422                         }
 423                         if (!m2Version.startsWith(":")) {
 424                                 throw new IllegalStateException("Only the M2 version can be specified: " + m2Version);
 425                         }
 426                         m2Version = m2Version.substring(1);
 427
 428                         DirectoryStream<Path> ds = Files.newDirectoryStream(duDir,
 429                                         (p) -> p.getFileName().toString().endsWith(".bnd") && !p.getFileName().toString().equals(COMMON_BND)
 430                                                         && !p.getFileName().toString().equals(MERGE_BND));
 431                         for (Path p : ds) {
 432                                 Properties fileProps = new Properties();
 433                                 try (InputStream in = Files.newInputStream(p)) {
 434                                         fileProps.load(in);
 435                                 }
 436                                 String m2Coordinates = fileProps.getProperty(ARGEO_ORIGIN_M2.toString());
 437                                 M2Artifact artifact = new M2Artifact(m2Coordinates);
 438                                 if (artifact.getVersion() == null) {
 439                                         artifact.setVersion(m2Version);
 440                                 } else {
 441                                         logger.log(WARNING, p.getFileName() + " : Using version " + artifact.getVersion()
 442                                                         + " specified in descriptor rather than " + m2Version + " specified in " + COMMON_BND);
 443                                 }
 444
 445                                 // prepare manifest entries
 446                                 Properties mergedProps = new Properties();
 447                                 mergedProps.putAll(commonProps);
 448
 449                                 fileEntries: for (Object key : fileProps.keySet()) {
 450                                         if (ARGEO_ORIGIN_M2.toString().equals(key))
 451                                                 continue fileEntries;
 452                                         String value = fileProps.getProperty(key.toString());
 453                                         Object previousValue = mergedProps.put(key.toString(), value);
 454                                         if (previousValue != null) {
 455                                                 logger.log(WARNING,
 456                                                                 commonBnd + ": " + key + " was " + previousValue + ", overridden with " + value);
 457                                         }
 458                                 }
 459                                 mergedProps.put(ARGEO_ORIGIN_M2.toString(), artifact.toM2Coordinates());
 460                                 if (!mergedProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
 461                                         // use file name as symbolic name
 462                                         String symbolicName = p.getFileName().toString();
 463                                         symbolicName = symbolicName.substring(0, symbolicName.length() - ".bnd".length());
 464                                         mergedProps.put(BUNDLE_SYMBOLICNAME.toString(), symbolicName);
 465                                 }
 466
 467                                 // download
 468                                 Path downloaded = downloadMaven(mergedProps, artifact);
 469
 470                                 boolean doNotModify = Boolean
 471                                                 .parseBoolean(mergedProps.getOrDefault(ARGEO_DO_NOT_MODIFY.toString(), "false").toString());
 472                                 if (doNotModify) {
 473                                         processNotModified(targetCategoryBase, downloaded, mergedProps, artifact);
 474                                 } else {
 475                                         A2Origin origin = new A2Origin();
 476                                         Path targetBundleDir = processBndJar(downloaded, targetCategoryBase, mergedProps, artifact, origin);
 477                                         downloadAndProcessM2Sources(mergedProps, artifact, targetBundleDir, false, false);
 478                                         createJar(targetBundleDir, origin);
 479                                 }
 480                         }
 481                 } catch (IOException e) {
 482                         throw new RuntimeException("Cannot process " + duDir, e);
 483                 }
 484         }
 485
 486         /** Merge multiple Maven artifacts. */
 487         void mergeM2Artifacts(Path mergeBnd) throws IOException {
 488                 Path duDir = mergeBnd.getParent();
 489                 String category = duDir.getParent().getFileName().toString();
 490                 Path targetCategoryBase = a2Base.resolve(category);
 491
 492                 Properties mergeProps = new Properties();
 493                 // first, load common properties
 494                 Path commonBnd = duDir.resolve(COMMON_BND);
 495                 if (Files.exists(commonBnd))
 496                         try (InputStream in = Files.newInputStream(commonBnd)) {
 497                                 mergeProps.load(in);
 498                         }
 499                 // then, the merge properties themselves
 500                 try (InputStream in = Files.newInputStream(mergeBnd)) {
 501                         mergeProps.load(in);
 502                 }
 503
 504                 String m2Version = mergeProps.getProperty(ARGEO_ORIGIN_M2.toString());
 505                 if (m2Version == null) {
 506                         logger.log(WARNING, "Ignoring merging in " + duDir + " as it is not an M2-based distribution unit");
 507                         return;// ignore, this is probably an Eclipse archive
 508                 }
 509                 if (!m2Version.startsWith(":")) {
 510                         throw new IllegalStateException("Only the M2 version can be specified: " + m2Version);
 511                 }
 512                 m2Version = m2Version.substring(1);
 513                 mergeProps.put(BUNDLE_VERSION.toString(), m2Version);
 514
 515                 String artifactsStr = mergeProps.getProperty(ARGEO_ORIGIN_M2_MERGE.toString());
 516                 if (artifactsStr == null)
 517                         throw new IllegalArgumentException(mergeBnd + ": " + ARGEO_ORIGIN_M2_MERGE + " must be set");
 518
 519                 String bundleSymbolicName = mergeProps.getProperty(BUNDLE_SYMBOLICNAME.toString());
 520                 if (bundleSymbolicName == null)
 521                         throw new IllegalArgumentException("Bundle-SymbolicName must be set in " + mergeBnd);
 522                 CategoryNameVersion nameVersion = new M2Artifact(category + ":" + bundleSymbolicName + ":" + m2Version);
 523
 524                 A2Origin origin = new A2Origin();
 525                 Path bundleDir = targetCategoryBase.resolve(bundleSymbolicName + "." + nameVersion.getBranch());
 526
 527                 StringJoiner originDesc = new StringJoiner(",");
 528                 String[] artifacts = artifactsStr.split(",");
 529                 artifacts: for (String str : artifacts) {
 530                         String m2Coordinates = str.trim();
 531                         if ("".equals(m2Coordinates))
 532                                 continue artifacts;
 533                         M2Artifact artifact = new M2Artifact(m2Coordinates.trim());
 534                         if (artifact.getVersion() == null)
 535                                 artifact.setVersion(m2Version);
 536                         originDesc.add(artifact.toString());
 537                         Path downloaded = downloadMaven(mergeProps, artifact);
 538                         JarEntry entry;
 539                         try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(downloaded), false)) {
 540                                 entries: while ((entry = jarIn.getNextJarEntry()) != null) {
 541                                         if (entry.isDirectory())
 542                                                 continue entries;
 543                                         if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".DSA")
 544                                                         || entry.getName().endsWith(".SF")) {
 545                                                 origin.deleted.add("cryptographic signatures from " + artifact);
 546                                                 continue entries;
 547                                         }
 548                                         if (entry.getName().endsWith("module-info.class")) { // skip Java 9 module info
 549                                                 origin.deleted.add("Java module information (module-info.class) from " + artifact);
 550                                                 continue entries;
 551                                         }
 552                                         if (entry.getName().startsWith("META-INF/versions/")) { // skip multi-version
 553                                                 origin.deleted.add("additional Java versions (META-INF/versions) from " + artifact);
 554                                                 continue entries;
 555                                         }
 556                                         if (entry.getName().startsWith("META-INF/maven/")) {
 557                                                 origin.deleted.add("Maven information (META-INF/maven) from " + artifact);
 558                                                 continue entries;
 559                                         }
 560                                         if (entry.getName().startsWith(".cache/")) { // Apache SSHD
 561                                                 origin.deleted.add("cache directory (.cache) from " + artifact);
 562                                                 continue entries;
 563                                         }
 564                                         if (entry.getName().equals("META-INF/DEPENDENCIES")) {
 565                                                 origin.deleted.add("Dependencies (META-INF/DEPENDENCIES) from " + artifact);
 566                                                 continue entries;
 567                                         }
 568                                         if (entry.getName().equals("META-INF/MANIFEST.MF")) {
 569                                                 Path originalManifest = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId())
 570                                                                 .resolve(artifact.getArtifactId()).resolve("MANIFEST.MF");
 571                                                 Files.createDirectories(originalManifest.getParent());
 572                                                 try (OutputStream out = Files.newOutputStream(originalManifest)) {
 573                                                         Files.copy(jarIn, originalManifest);
 574                                                 }
 575                                                 origin.added.add(
 576                                                                 "original MANIFEST (" + bundleDir.relativize(originalManifest) + ") from " + artifact);
 577                                                 continue entries;
 578                                         }
 579
 580                                         if (entry.getName().endsWith("NOTICE") || entry.getName().endsWith("NOTICE.txt")
 581                                                         || entry.getName().endsWith("NOTICE.md") || entry.getName().endsWith("LICENSE")
 582                                                         || entry.getName().endsWith("LICENSE.md") || entry.getName().endsWith("LICENSE-notice.md")
 583                                                         || entry.getName().endsWith("COPYING") || entry.getName().endsWith("COPYING.LESSER")) {
 584                                                 Path artifactOriginDir = bundleDir.resolve(ARGEO_ORIGIN).resolve(artifact.getGroupId())
 585                                                                 .resolve(artifact.getArtifactId());
 586                                                 Path target = artifactOriginDir.resolve(entry.getName());
 587                                                 Files.createDirectories(target.getParent());
 588                                                 Files.copy(jarIn, target);
 589                                                 origin.moved.add(entry.getName() + " in " + artifact + " to " + bundleDir.relativize(target));
 590                                                 continue entries;
 591                                         }
 592                                         Path target = bundleDir.resolve(entry.getName());
 593                                         Files.createDirectories(target.getParent());
 594                                         if (!Files.exists(target)) {
 595                                                 Files.copy(jarIn, target);
 596                                         } else {
 597                                                 if (entry.getName().startsWith("META-INF/services/")) {
 598                                                         try (OutputStream out = Files.newOutputStream(target, StandardOpenOption.APPEND)) {
 599                                                                 out.write("\n".getBytes());
 600                                                                 jarIn.transferTo(out);
 601                                                                 logger.log(DEBUG, artifact.getArtifactId() + " - Appended " + entry.getName());
 602                                                         }
 603                                                         origin.modified.add(entry.getName() + ", merging from " + artifact);
 604                                                 } else if (entry.getName().startsWith("org/apache/batik/")) {
 605                                                         logger.log(TRACE, "Skip " + entry.getName());
 606                                                         continue entries;
 607                                                 } else if (entry.getName().startsWith("META-INF/NOTICE")) {
 608                                                         logger.log(WARNING, "Skip " + entry.getName() + " from " + artifact);
 609                                                         // TODO merge them?
 610                                                         continue entries;
 611                                                 } else {
 612                                                         throw new IllegalStateException("File " + target + " from " + artifact + " already exists");
 613                                                 }
 614                                         }
 615                                         logger.log(TRACE, () -> "Copied " + target);
 616                                 }
 617                         }
 618                         origin.added.add("binary content of " + artifact);
 619
 620                         // process sources
 621                         downloadAndProcessM2Sources(mergeProps, artifact, bundleDir, true, false);
 622                 }
 623
 624                 // additional service files
 625                 Path servicesDir = duDir.resolve("services");
 626                 if (Files.exists(servicesDir)) {
 627                         for (Path p : Files.newDirectoryStream(servicesDir)) {
 628                                 Path target = bundleDir.resolve("META-INF/services/").resolve(p.getFileName());
 629                                 try (InputStream in = Files.newInputStream(p);
 630                                                 OutputStream out = Files.newOutputStream(target, StandardOpenOption.APPEND);) {
 631                                         out.write("\n".getBytes());
 632                                         in.transferTo(out);
 633                                         logger.log(DEBUG, "Appended " + p);
 634                                 }
 635                                 origin.added.add(bundleDir.relativize(target).toString());
 636                         }
 637                 }
 638
 639                 // BND analysis
 640                 Map<String, String> entries = new TreeMap<>();
 641                 try (Analyzer bndAnalyzer = new Analyzer()) {
 642                         bndAnalyzer.setProperties(mergeProps);
 643                         Jar jar = new Jar(bundleDir.toFile());
 644                         bndAnalyzer.setJar(jar);
 645                         Manifest manifest = bndAnalyzer.calcManifest();
 646
 647                         keys: for (Object key : manifest.getMainAttributes().keySet()) {
 648                                 Object value = manifest.getMainAttributes().get(key);
 649
 650                                 switch (key.toString()) {
 651                                 case "Tool":
 652                                 case "Bnd-LastModified":
 653                                 case "Created-By":
 654                                         continue keys;
 655                                 }
 656                                 if ("Require-Capability".equals(key.toString())
 657                                                 && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) {
 658                                         origin.deleted.add("MANIFEST header " + key);
 659                                         continue keys;// hack for very old classes
 660                                 }
 661                                 entries.put(key.toString(), value.toString());
 662                         }
 663                 } catch (Exception e) {
 664                         throw new RuntimeException("Cannot process " + mergeBnd, e);
 665                 }
 666
 667                 Manifest manifest = new Manifest();
 668                 Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF");
 669                 Files.createDirectories(manifestPath.getParent());
 670                 for (String key : entries.keySet()) {
 671                         String value = entries.get(key);
 672                         manifest.getMainAttributes().putValue(key, value);
 673                 }
 674                 manifest.getMainAttributes().putValue(ARGEO_ORIGIN_M2.toString(), originDesc.toString());
 675
 676                 processLicense(bundleDir, manifest);
 677
 678                 // write MANIFEST
 679                 try (OutputStream out = Files.newOutputStream(manifestPath)) {
 680                         manifest.write(out);
 681                 }
 682                 createJar(bundleDir, origin);
 683         }
 684
 685         /** Generates MANIFEST using BND. */
 686         Path processBndJar(Path downloaded, Path targetCategoryBase, Properties fileProps, M2Artifact artifact,
 687                         A2Origin origin) {
 688                 try {
 689                         Map<String, String> additionalEntries = new TreeMap<>();
 690                         boolean doNotModifyManifest = Boolean.parseBoolean(
 691                                         fileProps.getOrDefault(ARGEO_ORIGIN_NO_METADATA_GENERATION.toString(), "false").toString());
 692
 693                         // Note: we always force the symbolic name
 694                         if (doNotModifyManifest) {
 695                                 for (Object key : fileProps.keySet()) {
 696                                         String value = fileProps.getProperty(key.toString());
 697                                         additionalEntries.put(key.toString(), value);
 698                                 }
 699                         } else {
 700                                 if (artifact != null) {
 701                                         if (!fileProps.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
 702                                                 fileProps.put(BUNDLE_SYMBOLICNAME.toString(), artifact.getName());
 703                                         }
 704                                         if (!fileProps.containsKey(BUNDLE_VERSION.toString())) {
 705                                                 fileProps.put(BUNDLE_VERSION.toString(), artifact.getVersion());
 706                                         }
 707                                 }
 708
 709                                 if (!fileProps.containsKey(EXPORT_PACKAGE.toString())) {
 710                                         fileProps.put(EXPORT_PACKAGE.toString(),
 711                                                         "*;version=\"" + fileProps.getProperty(BUNDLE_VERSION.toString()) + "\"");
 712                                 }
 713
 714                                 // BND analysis
 715                                 try (Analyzer bndAnalyzer = new Analyzer()) {
 716                                         bndAnalyzer.setProperties(fileProps);
 717                                         Jar jar = new Jar(downloaded.toFile());
 718                                         bndAnalyzer.setJar(jar);
 719                                         Manifest manifest = bndAnalyzer.calcManifest();
 720
 721                                         keys: for (Object key : manifest.getMainAttributes().keySet()) {
 722                                                 Object value = manifest.getMainAttributes().get(key);
 723
 724                                                 switch (key.toString()) {
 725                                                 case "Tool":
 726                                                 case "Bnd-LastModified":
 727                                                 case "Created-By":
 728                                                         continue keys;
 729                                                 }
 730                                                 if ("Require-Capability".equals(key.toString())
 731                                                                 && value.toString().equals("osgi.ee;filter:=\"(&(osgi.ee=JavaSE)(version=1.1))\"")) {
 732                                                         origin.deleted.add("MANIFEST header " + key);
 733                                                         continue keys;// !! hack for very old classes
 734                                                 }
 735                                                 additionalEntries.put(key.toString(), value.toString());
 736                                         }
 737                                 }
 738                         }
 739                         Path targetBundleDir = processBundleJar(downloaded, targetCategoryBase, additionalEntries, origin);
 740                         logger.log(DEBUG, () -> "Processed " + downloaded);
 741                         return targetBundleDir;
 742                 } catch (Exception e) {
 743                         throw new RuntimeException("Cannot BND process " + downloaded, e);
 744                 }
 745
 746         }
 747
 748         /** Process an artifact that should not be modified. */
 749         void processNotModified(Path targetCategoryBase, Path downloaded, Properties fileProps, M2Artifact artifact)
 750                         throws IOException {
 751                 // Some proprietary or signed artifacts do not allow any modification
 752                 // When releasing (with separate sources), we just copy it
 753                 Path unmodifiedTarget = targetCategoryBase
 754                                 .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch() + ".jar");
 755                 Files.createDirectories(unmodifiedTarget.getParent());
 756                 Files.copy(downloaded, unmodifiedTarget, StandardCopyOption.REPLACE_EXISTING);
 757                 Path bundleDir = targetCategoryBase
 758                                 .resolve(fileProps.getProperty(BUNDLE_SYMBOLICNAME.toString()) + "." + artifact.getBranch());
 759                 downloadAndProcessM2Sources(fileProps, artifact, bundleDir, false, true);
 760                 Manifest manifest;
 761                 try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(unmodifiedTarget))) {
 762                         manifest = jarIn.getManifest();
 763                 }
 764                 createSourceJar(bundleDir, manifest, fileProps);
 765         }
 766
 767         /** Download and integrates sources for a single Maven artifact. */
 768         void downloadAndProcessM2Sources(Properties props, M2Artifact artifact, Path targetBundleDir, boolean merging,
 769                         boolean unmodified) throws IOException {
 770                 try {
 771                         String repoStr = props.containsKey(ARGEO_ORIGIN_M2_REPO.toString())
 772                                         ? props.getProperty(ARGEO_ORIGIN_M2_REPO.toString())
 773                                         : null;
 774                         String alternateUri = props.getProperty(ARGEO_ORIGIN_SOURCES_URI.toString());
 775                         M2Artifact sourcesArtifact = new M2Artifact(artifact.toM2Coordinates(), "sources");
 776                         URL sourcesUrl = alternateUri != null ? new URL(alternateUri)
 777                                         : M2ConventionsUtils.mavenRepoUrl(repoStr, sourcesArtifact);
 778                         Path sourcesDownloaded = downloadMaven(sourcesUrl, sourcesArtifact);
 779                         processM2SourceJar(sourcesDownloaded, targetBundleDir, merging ? artifact : null, unmodified);
 780                         logger.log(TRACE, () -> "Processed source " + sourcesDownloaded);
 781                 } catch (Exception e) {
 782                         logger.log(ERROR, () -> "Cannot download source for  " + artifact);
 783                 }
 784
 785         }
 786
 787         /** Integrate sources from a downloaded jar file. */
 788         void processM2SourceJar(Path file, Path bundleDir, M2Artifact mergingFrom, boolean unmodified) throws IOException {
 789                 A2Origin origin = new A2Origin();
 790                 Path sourceDir = separateSources || unmodified ? bundleDir.getParent().resolve(bundleDir.toString() + ".src")
 791                                 : bundleDir.resolve("OSGI-OPT/src");
 792                 try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) {
 793
 794                         String mergingMsg = "";
 795                         if (mergingFrom != null)
 796                                 mergingMsg = " of " + mergingFrom;
 797
 798                         Files.createDirectories(sourceDir);
 799                         JarEntry entry;
 800                         entries: while ((entry = jarIn.getNextJarEntry()) != null) {
 801                                 String relPath = entry.getName();
 802                                 if (entry.isDirectory())
 803                                         continue entries;
 804                                 if (entry.getName().equals("META-INF/MANIFEST.MF")) {// skip META-INF entries
 805                                         origin.deleted.add("MANIFEST.MF from the sources" + mergingMsg);
 806                                         continue entries;
 807                                 }
 808                                 if (!unmodified) {
 809                                         if (entry.getName().startsWith("module-info.java")) {// skip Java module information
 810                                                 origin.deleted.add("Java module information from the sources (module-info.java)" + mergingMsg);
 811                                                 continue entries;
 812                                         }
 813                                         if (entry.getName().startsWith("/")) { // absolute paths
 814                                                 int metaInfIndex = entry.getName().indexOf("META-INF");
 815                                                 if (metaInfIndex >= 0) {
 816                                                         relPath = entry.getName().substring(metaInfIndex);
 817                                                         origin.moved.add(" to " + relPath + " entry with absolute path " + entry.getName());
 818                                                 } else {
 819                                                         logger.log(WARNING, entry.getName() + " has an absolute path");
 820                                                         origin.deleted.add(entry.getName() + " from the sources" + mergingMsg);
 821                                                 }
 822                                                 continue entries;
 823                                         }
 824                                 }
 825                                 Path target = sourceDir.resolve(relPath);
 826                                 Files.createDirectories(target.getParent());
 827                                 if (!Files.exists(target)) {
 828                                         Files.copy(jarIn, target);
 829                                         logger.log(TRACE, () -> "Copied source " + target);
 830                                 } else {
 831                                         logger.log(TRACE, () -> target + " already exists, skipping...");
 832                                 }
 833                         }
 834                 }
 835                 // write the changes
 836                 if (separateSources || unmodified) {
 837                         origin.appendChanges(sourceDir);
 838                 } else {
 839                         origin.added.add("source code under OSGI-OPT/src");
 840                         origin.appendChanges(bundleDir);
 841                 }
 842         }
 843
 844         /** Download a Maven artifact. */
 845         Path downloadMaven(Properties props, M2Artifact artifact) throws IOException {
 846                 String repoStr = props.containsKey(ARGEO_ORIGIN_M2_REPO.toString())
 847                                 ? props.getProperty(ARGEO_ORIGIN_M2_REPO.toString())
 848                                 : null;
 849                 String alternateUri = props.getProperty(ARGEO_ORIGIN_URI.toString());
 850                 URL url = alternateUri != null ? new URL(alternateUri) : M2ConventionsUtils.mavenRepoUrl(repoStr, artifact);
 851                 return downloadMaven(url, artifact);
 852         }
 853
 854         /** Download a Maven artifact. */
 855         Path downloadMaven(URL url, M2Artifact artifact) throws IOException {
 856                 return download(url, mavenBase, M2ConventionsUtils.artifactPath("", artifact));
 857         }
 858
 859         /*
 860          * ECLIPSE ORIGIN
 861          */
 862         /** Process an archive in Eclipse format. */
 863         void processEclipseArchive(Path duDir) {
 864                 try {
 865                         Path categoryRelativePath = descriptorsBase.relativize(duDir.getParent());
 866                         Path targetCategoryBase = a2Base.resolve(categoryRelativePath);
 867                         Files.createDirectories(targetCategoryBase);
 868                         // first delete all directories from previous builds
 869                         for (Path dir : Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p)))
 870                                 deleteDirectory(dir);
 871
 872                         Files.createDirectories(originBase);
 873
 874                         Path commonBnd = duDir.resolve(COMMON_BND);
 875                         Properties commonProps = new Properties();
 876                         try (InputStream in = Files.newInputStream(commonBnd)) {
 877                                 commonProps.load(in);
 878                         }
 879                         String url = commonProps.getProperty(ARGEO_ORIGIN_URI.toString());
 880                         if (url == null) {
 881                                 url = uris.getProperty(duDir.getFileName().toString());
 882                                 if (url == null)
 883                                         throw new IllegalStateException("No url available for " + duDir);
 884                                 commonProps.put(ARGEO_ORIGIN_URI.toString(), url);
 885                         }
 886                         Path downloaded = tryDownloadArchive(url, originBase);
 887
 888                         FileSystem zipFs = FileSystems.newFileSystem(downloaded, (ClassLoader) null);
 889
 890                         // filters
 891                         List<PathMatcher> includeMatchers = new ArrayList<>();
 892                         Properties includes = new Properties();
 893                         try (InputStream in = Files.newInputStream(duDir.resolve("includes.properties"))) {
 894                                 includes.load(in);
 895                         }
 896                         for (Object pattern : includes.keySet()) {
 897                                 PathMatcher pathMatcher = zipFs.getPathMatcher("glob:/" + pattern);
 898                                 includeMatchers.add(pathMatcher);
 899                         }
 900
 901                         List<PathMatcher> excludeMatchers = new ArrayList<>();
 902                         Path excludeFile = duDir.resolve("excludes.properties");
 903                         if (Files.exists(excludeFile)) {
 904                                 Properties excludes = new Properties();
 905                                 try (InputStream in = Files.newInputStream(excludeFile)) {
 906                                         excludes.load(in);
 907                                 }
 908                                 for (Object pattern : excludes.keySet()) {
 909                                         PathMatcher pathMatcher = zipFs.getPathMatcher("glob:/" + pattern);
 910                                         excludeMatchers.add(pathMatcher);
 911                                 }
 912                         }
 913
 914                         // keys are the bundle directories
 915                         Map<Path, A2Origin> origins = new HashMap<>();
 916                         Files.walkFileTree(zipFs.getRootDirectories().iterator().next(), new SimpleFileVisitor<Path>() {
 917
 918                                 @Override
 919                                 public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
 920                                         includeMatchers: for (PathMatcher includeMatcher : includeMatchers) {
 921                                                 if (includeMatcher.matches(file)) {
 922                                                         for (PathMatcher excludeMatcher : excludeMatchers) {
 923                                                                 if (excludeMatcher.matches(file)) {
 924                                                                         logger.log(TRACE, "Skipping excluded " + file);
 925                                                                         return FileVisitResult.CONTINUE;
 926                                                                 }
 927                                                         }
 928                                                         if (file.getFileName().toString().contains(".source_")) {
 929                                                                 processEclipseSourceJar(file, targetCategoryBase);
 930                                                                 logger.log(DEBUG, () -> "Processed source " + file);
 931                                                         } else {
 932                                                                 Map<String, String> map = new HashMap<>();
 933                                                                 for (Object key : commonProps.keySet())
 934                                                                         map.put(key.toString(), commonProps.getProperty(key.toString()));
 935                                                                 A2Origin origin = new A2Origin();
 936                                                                 Path bundleDir = processBundleJar(file, targetCategoryBase, map, origin);
 937                                                                 if (bundleDir == null) {
 938                                                                         logger.log(WARNING, "No bundle dir created for " + file + ", skipping...");
 939                                                                         return FileVisitResult.CONTINUE;
 940                                                                 }
 941                                                                 origins.put(bundleDir, origin);
 942                                                                 logger.log(DEBUG, () -> "Processed " + file);
 943                                                         }
 944                                                         break includeMatchers;
 945                                                 }
 946                                         }
 947                                         return FileVisitResult.CONTINUE;
 948                                 }
 949                         });
 950
 951                         DirectoryStream<Path> dirs = Files.newDirectoryStream(targetCategoryBase, (p) -> Files.isDirectory(p)
 952                                         && p.getFileName().toString().indexOf('.') >= 0 && !p.getFileName().toString().endsWith(".src"));
 953                         for (Path bundleDir : dirs) {
 954                                 A2Origin origin = origins.get(bundleDir);
 955                                 Objects.requireNonNull(origin, "No A2 origin found for " + bundleDir);
 956                                 createJar(bundleDir, origin);
 957                         }
 958                 } catch (IOException e) {
 959                         throw new RuntimeException("Cannot process " + duDir, e);
 960                 }
 961
 962         }
 963
 964         /** Process sources in Eclipse format. */
 965         void processEclipseSourceJar(Path file, Path targetBase) throws IOException {
 966                 try {
 967                         A2Origin origin = new A2Origin();
 968                         Path bundleDir;
 969                         try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) {
 970                                 Manifest manifest = jarIn.getManifest();
 971
 972                                 String[] relatedBundle = manifest.getMainAttributes().getValue(ECLIPSE_SOURCE_BUNDLE.toString())
 973                                                 .split(";");
 974                                 String version = relatedBundle[1].substring("version=\"".length());
 975                                 version = version.substring(0, version.length() - 1);
 976                                 NameVersion nameVersion = new NameVersion(relatedBundle[0], version);
 977                                 bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch());
 978
 979                                 Path sourceDir = separateSources ? bundleDir.getParent().resolve(bundleDir.toString() + ".src")
 980                                                 : bundleDir.resolve("OSGI-OPT/src");
 981
 982                                 Files.createDirectories(sourceDir);
 983                                 JarEntry entry;
 984                                 entries: while ((entry = jarIn.getNextJarEntry()) != null) {
 985                                         if (entry.isDirectory())
 986                                                 continue entries;
 987                                         if (entry.getName().startsWith("META-INF"))// skip META-INF entries
 988                                                 continue entries;
 989                                         Path target = sourceDir.resolve(entry.getName());
 990                                         Files.createDirectories(target.getParent());
 991                                         Files.copy(jarIn, target);
 992                                         logger.log(TRACE, () -> "Copied source " + target);
 993                                 }
 994
 995                                 // write the changes
 996                                 if (separateSources) {
 997                                         origin.appendChanges(sourceDir);
 998                                 } else {
 999                                         origin.added.add("source code under OSGI-OPT/src");
1000                                         origin.appendChanges(bundleDir);
1001                                 }
1002                         }
1003                 } catch (IOException e) {
1004                         throw new IllegalStateException("Cannot process " + file, e);
1005                 }
1006         }
1007
1008         /*
1009          * COMMON PROCESSING
1010          */
1011         /** Normalise a single (that is, non-merged) bundle. */
1012         Path processBundleJar(Path file, Path targetBase, Map<String, String> entries, A2Origin origin) throws IOException {
1013 //              boolean embed = Boolean.parseBoolean(entries.getOrDefault(ARGEO_ORIGIN_EMBED.toString(), "false").toString());
1014                 boolean doNotModify = Boolean
1015                                 .parseBoolean(entries.getOrDefault(ManifestHeader.ARGEO_DO_NOT_MODIFY.toString(), "false").toString());
1016                 NameVersion nameVersion;
1017                 Path bundleDir;
1018                 // singleton
1019                 boolean isSingleton = false;
1020                 Manifest manifest;
1021                 Manifest sourceManifest;
1022                 try (JarInputStream jarIn = new JarInputStream(Files.newInputStream(file), false)) {
1023                         sourceManifest = jarIn.getManifest();
1024                         if (sourceManifest == null)
1025                                 logger.log(WARNING, file + " has no manifest");
1026                         manifest = sourceManifest != null ? new Manifest(sourceManifest) : new Manifest();
1027
1028                         String rawSourceSymbolicName = manifest.getMainAttributes().getValue(BUNDLE_SYMBOLICNAME.toString());
1029                         if (rawSourceSymbolicName != null) {
1030                                 // make sure there is no directive
1031                                 String[] arr = rawSourceSymbolicName.split(";");
1032                                 for (int i = 1; i < arr.length; i++) {
1033                                         if (arr[i].trim().equals("singleton:=true"))
1034                                                 isSingleton = true;
1035                                         logger.log(DEBUG, file.getFileName() + " is a singleton");
1036                                 }
1037                         }
1038                         // remove problematic entries in MANIFEST
1039                         manifest.getEntries().clear();
1040
1041                         String ourSymbolicName = entries.get(BUNDLE_SYMBOLICNAME.toString());
1042                         String ourVersion = entries.get(BUNDLE_VERSION.toString());
1043
1044                         if (ourSymbolicName != null && ourVersion != null) {
1045                                 nameVersion = new NameVersion(ourSymbolicName, ourVersion);
1046                         } else {
1047                                 nameVersion = nameVersionFromManifest(manifest);
1048                                 if (nameVersion == null)
1049                                         throw new IllegalStateException("Could not compute name/version from Manifest");
1050                                 if (ourVersion != null && !nameVersion.getVersion().equals(ourVersion)) {
1051                                         logger.log(WARNING,
1052                                                         "Original version is " + nameVersion.getVersion() + " while new version is " + ourVersion);
1053                                         entries.put(BUNDLE_VERSION.toString(), ourVersion);
1054                                 }
1055                                 if (ourSymbolicName != null) {
1056                                         // we always force our symbolic name
1057                                         nameVersion.setName(ourSymbolicName);
1058                                 }
1059                         }
1060
1061                         bundleDir = targetBase.resolve(nameVersion.getName() + "." + nameVersion.getBranch());
1062
1063                         // copy original MANIFEST
1064                         if (sourceManifest != null) {
1065                                 Path originalManifest = bundleDir.resolve(ARGEO_ORIGIN).resolve("MANIFEST.MF");
1066                                 Files.createDirectories(originalManifest.getParent());
1067                                 try (OutputStream out = Files.newOutputStream(originalManifest)) {
1068                                         sourceManifest.write(out);
1069                                 }
1070                                 origin.moved.add("original MANIFEST to " + bundleDir.relativize(originalManifest));
1071                         }
1072
1073                         // force Java 9 module name
1074                         entries.put(ManifestHeader.AUTOMATIC_MODULE_NAME.toString(), nameVersion.getName());
1075
1076                         boolean isNative = false;
1077                         String os = null;
1078                         String arch = null;
1079                         if (bundleDir.startsWith(a2LibBase)) {
1080                                 isNative = true;
1081                                 Path libRelativePath = a2LibBase.relativize(bundleDir);
1082                                 os = libRelativePath.getName(0).toString();
1083                                 arch = libRelativePath.getName(1).toString();
1084                         }
1085
1086                         // copy entries
1087                         JarEntry entry;
1088                         entries: while ((entry = jarIn.getNextJarEntry()) != null) {
1089                                 if (entry.isDirectory())
1090                                         continue entries;
1091                                 if (!doNotModify) {
1092                                         if (entry.getName().endsWith(".RSA") || entry.getName().endsWith(".DSA")
1093                                                         || entry.getName().endsWith(".SF")) {
1094                                                 origin.deleted.add("cryptographic signatures");
1095                                                 continue entries;
1096                                         }
1097                                         if (entry.getName().endsWith("module-info.class")) { // skip Java 9 module info
1098                                                 origin.deleted.add("Java module information (module-info.class)");
1099                                                 continue entries;
1100                                         }
1101                                         if (entry.getName().startsWith("META-INF/versions/")) { // skip multi-version
1102                                                 origin.deleted.add("additional Java versions (META-INF/versions)");
1103                                                 continue entries;
1104                                         }
1105                                         if (entry.getName().startsWith("META-INF/maven/")) {
1106                                                 origin.deleted.add("Maven information (META-INF/maven)");
1107                                                 continue entries;
1108                                         }
1109                                         // skip file system providers as they cause issues with native image
1110                                         if (entry.getName().startsWith("META-INF/services/java.nio.file.spi.FileSystemProvider")) {
1111                                                 origin.deleted
1112                                                                 .add("file system providers (META-INF/services/java.nio.file.spi.FileSystemProvider)");
1113                                                 continue entries;
1114                                         }
1115                                 }
1116                                 if (entry.getName().startsWith("OSGI-OPT/src/")) { // skip embedded sources
1117                                         origin.deleted.add("embedded sources");
1118                                         continue entries;
1119                                 }
1120                                 Path target = bundleDir.resolve(entry.getName());
1121                                 Files.createDirectories(target.getParent());
1122                                 Files.copy(jarIn, target);
1123
1124                                 // native libraries
1125                                 if (isNative && (entry.getName().endsWith(".so") || entry.getName().endsWith(".dll")
1126                                                 || entry.getName().endsWith(".jnilib"))) {
1127                                         Path categoryDir = bundleDir.getParent();
1128                                         boolean copyDll = false;
1129                                         Path targetDll = categoryDir.resolve(bundleDir.relativize(target));
1130                                         if (nameVersion.getName().equals("com.sun.jna")) {
1131                                                 if (arch.equals("x86_64"))
1132                                                         arch = "x86-64";
1133                                                 if (os.equals("macosx"))
1134                                                         os = "darwin";
1135                                                 if (target.getParent().getFileName().toString().equals(os + "-" + arch)) {
1136                                                         copyDll = true;
1137                                                 }
1138                                                 targetDll = categoryDir.resolve(target.getFileName());
1139                                         } else {
1140                                                 copyDll = true;
1141                                         }
1142                                         if (copyDll) {
1143                                                 Files.createDirectories(targetDll.getParent());
1144                                                 if (Files.exists(targetDll))
1145                                                         Files.delete(targetDll);
1146                                                 Files.copy(target, targetDll);
1147                                         }
1148                                         Files.delete(target);
1149                                         origin.deleted.add(bundleDir.relativize(target).toString());
1150                                 }
1151                                 logger.log(TRACE, () -> "Copied " + target);
1152                         }
1153                 }
1154
1155                 // copy MANIFEST
1156                 Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF");
1157                 Files.createDirectories(manifestPath.getParent());
1158
1159                 if (isSingleton && entries.containsKey(BUNDLE_SYMBOLICNAME.toString())) {
1160                         entries.put(BUNDLE_SYMBOLICNAME.toString(),
1161                                         entries.get(BUNDLE_SYMBOLICNAME.toString()) + ";singleton:=true");
1162                 }
1163
1164                 // Final MANIFEST decisions
1165                 // We also check the original OSGi metadata and compare with our changes
1166                 for (String key : entries.keySet()) {
1167                         String value = entries.get(key);
1168                         String previousValue = manifest.getMainAttributes().getValue(key);
1169                         boolean wasDifferent = previousValue != null && !previousValue.equals(value);
1170                         boolean keepPrevious = false;
1171                         if (wasDifferent) {
1172                                 if (SPDX_LICENSE_IDENTIFIER.toString().equals(key) && previousValue != null)
1173                                         keepPrevious = true;
1174                                 else if (BUNDLE_VERSION.toString().equals(key) && wasDifferent)
1175                                         if (previousValue.equals(value + ".0")) // typically a Maven first release
1176                                                 keepPrevious = true;
1177
1178                                 if (keepPrevious) {
1179                                         if (logger.isLoggable(DEBUG))
1180                                                 logger.log(DEBUG, file.getFileName() + ": " + key + " was NOT modified, value kept is "
1181                                                                 + previousValue + ", not overriden with " + value);
1182                                         value = previousValue;
1183                                 }
1184                         }
1185
1186                         manifest.getMainAttributes().putValue(key, value);
1187                         if (wasDifferent && !keepPrevious) {
1188                                 if (IMPORT_PACKAGE.toString().equals(key) || EXPORT_PACKAGE.toString().equals(key))
1189                                         logger.log(TRACE, () -> file.getFileName() + ": " + key + " was modified");
1190                                 else if (BUNDLE_SYMBOLICNAME.toString().equals(key) || AUTOMATIC_MODULE_NAME.toString().equals(key))
1191                                         logger.log(DEBUG,
1192                                                         file.getFileName() + ": " + key + " was " + previousValue + ", overridden with " + value);
1193                                 else
1194                                         logger.log(WARNING,
1195                                                         file.getFileName() + ": " + key + " was " + previousValue + ", overridden with " + value);
1196                                 origin.modified.add("MANIFEST header " + key);
1197                         }
1198
1199                         // !! hack to remove unresolvable
1200                         if (key.equals("Provide-Capability") || key.equals("Require-Capability"))
1201                                 if (nameVersion.getName().equals("osgi.core") || nameVersion.getName().equals("osgi.cmpn")) {
1202                                         manifest.getMainAttributes().remove(key);
1203                                         origin.deleted.add("MANIFEST header " + key);
1204                                 }
1205                 }
1206
1207                 // de-pollute MANIFEST
1208                 for (Iterator<Map.Entry<Object, Object>> manifestEntries = manifest.getMainAttributes().entrySet()
1209                                 .iterator(); manifestEntries.hasNext();) {
1210                         Map.Entry<Object, Object> manifestEntry = manifestEntries.next();
1211                         switch (manifestEntry.getKey().toString()) {
1212                         case "Archiver-Version":
1213                         case "Build-By":
1214                         case "Created-By":
1215                         case "Originally-Created-By":
1216                         case "Tool":
1217                         case "Bnd-LastModified":
1218                                 manifestEntries.remove();
1219                                 origin.deleted.add("MANIFEST header " + manifestEntry.getKey());
1220                                 break;
1221                         default:
1222                                 if (sourceManifest != null && !sourceManifest.getMainAttributes().containsKey(manifestEntry.getKey()))
1223                                         origin.added.add("MANIFEST header " + manifestEntry.getKey());
1224                         }
1225                 }
1226
1227                 processLicense(bundleDir, manifest);
1228
1229                 origin.modified.add("MANIFEST (META-INF/MANIFEST.MF)");
1230                 // write the MANIFEST
1231                 try (OutputStream out = Files.newOutputStream(manifestPath)) {
1232                         manifest.write(out);
1233                 }
1234                 return bundleDir;
1235         }
1236
1237         /** Process SPDX license identifier. */
1238         void processLicense(Path bundleDir, Manifest manifest) {
1239                 String spdxLicenceId = manifest.getMainAttributes().getValue(SPDX_LICENSE_IDENTIFIER.toString());
1240                 String bundleLicense = manifest.getMainAttributes().getValue(BUNDLE_LICENSE.toString());
1241                 if (spdxLicenceId == null) {
1242                         logger.log(ERROR, bundleDir.getFileName() + ": " + SPDX_LICENSE_IDENTIFIER + " not available, "
1243                                         + BUNDLE_LICENSE + " is " + bundleLicense);
1244                 } else {
1245                         // only use the first licensing option
1246                         int orIndex = spdxLicenceId.indexOf(" OR ");
1247                         if (orIndex >= 0)
1248                                 spdxLicenceId = spdxLicenceId.substring(0, orIndex).trim();
1249
1250                         String bundleDirName = bundleDir.getFileName().toString();
1251                         // force licenses of some well-known components
1252                         // even if we say otherwise (typically because from an Eclipse archive)
1253                         if (bundleDirName.startsWith("org.apache."))
1254                                 spdxLicenceId = "Apache-2.0";
1255                         if (bundleDirName.startsWith("com.sun.jna."))
1256                                 spdxLicenceId = "Apache-2.0";
1257                         if (bundleDirName.startsWith("com.ibm.icu."))
1258                                 spdxLicenceId = "ICU";
1259                         if (bundleDirName.startsWith("javax.annotation."))
1260                                 spdxLicenceId = "GPL-2.0-only WITH Classpath-exception-2.0";
1261                         if (bundleDirName.startsWith("javax.inject."))
1262                                 spdxLicenceId = "Apache-2.0";
1263                         if (bundleDirName.startsWith("org.osgi."))
1264                                 spdxLicenceId = "Apache-2.0";
1265
1266                         manifest.getMainAttributes().putValue(SPDX_LICENSE_IDENTIFIER.toString(), spdxLicenceId);
1267                         if (!licensesUsed.containsKey(spdxLicenceId))
1268                                 licensesUsed.put(spdxLicenceId, new TreeSet<>());
1269                         licensesUsed.get(spdxLicenceId).add(bundleDir.getParent().getFileName() + "/" + bundleDir.getFileName());
1270                 }
1271         }
1272
1273         /*
1274          * UTILITIES
1275          */
1276         /** Recursively deletes a directory. */
1277         static void deleteDirectory(Path path) throws IOException {
1278                 if (!Files.exists(path))
1279                         return;
1280                 Files.walkFileTree(path, new SimpleFileVisitor<Path>() {
1281                         @Override
1282                         public FileVisitResult postVisitDirectory(Path directory, IOException e) throws IOException {
1283                                 if (e != null)
1284                                         throw e;
1285                                 Files.delete(directory);
1286                                 return CONTINUE;
1287                         }
1288
1289                         @Override
1290                         public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
1291                                 Files.delete(file);
1292                                 return CONTINUE;
1293                         }
1294                 });
1295         }
1296
1297         /** Extract name/version from a MANIFEST. */
1298         NameVersion nameVersionFromManifest(Manifest manifest) {
1299                 Attributes attrs = manifest.getMainAttributes();
1300                 // symbolic name
1301                 String symbolicName = attrs.getValue(ManifestHeader.BUNDLE_SYMBOLICNAME.toString());
1302                 if (symbolicName == null)
1303                         return null;
1304                 // make sure there is no directive
1305                 symbolicName = symbolicName.split(";")[0];
1306
1307                 String version = attrs.getValue(ManifestHeader.BUNDLE_VERSION.toString());
1308                 return new NameVersion(symbolicName, version);
1309         }
1310
1311         /** Try to download from an URI. */
1312         Path tryDownloadArchive(String uri, Path dir) throws IOException {
1313                 // find mirror
1314                 List<String> urlBases = null;
1315                 String uriPrefix = null;
1316                 uriPrefixes: for (String uriPref : mirrors.keySet()) {
1317                         if (uri.startsWith(uriPref)) {
1318                                 if (mirrors.get(uriPref).size() > 0) {
1319                                         urlBases = mirrors.get(uriPref);
1320                                         uriPrefix = uriPref;
1321                                         break uriPrefixes;
1322                                 }
1323                         }
1324                 }
1325                 if (urlBases == null)
1326                         try {
1327                                 return downloadArchive(new URL(uri), dir);
1328                         } catch (FileNotFoundException e) {
1329                                 throw new FileNotFoundException("Cannot find " + uri);
1330                         }
1331
1332                 // try to download
1333                 for (String urlBase : urlBases) {
1334                         String relativePath = uri.substring(uriPrefix.length());
1335                         URL url = new URL(urlBase + relativePath);
1336                         try {
1337                                 return downloadArchive(url, dir);
1338                         } catch (FileNotFoundException e) {
1339                                 logger.log(WARNING, "Cannot download " + url + ", trying another mirror");
1340                         }
1341                 }
1342                 throw new FileNotFoundException("Cannot find " + uri);
1343         }
1344
1345         /**
1346          * Effectively download an archive.
1347          */
1348         Path downloadArchive(URL url, Path dir) throws IOException {
1349                 return download(url, dir, (String) null);
1350         }
1351
1352         /**
1353          * Effectively download. Synchronised in order to avoid downloading twice in
1354          * parallel.
1355          */
1356         synchronized Path download(URL url, Path dir, String name) throws IOException {
1357
1358                 Path dest;
1359                 if (name == null) {
1360                         // We use also use parent directory in case the archive itself has a fixed name
1361                         String[] segments = url.getPath().split("/");
1362                         name = segments.length > 1 ? segments[segments.length - 2] + '-' + segments[segments.length - 1]
1363                                         : segments[segments.length - 1];
1364                 }
1365
1366                 dest = dir.resolve(name);
1367                 if (Files.exists(dest)) {
1368                         logger.log(TRACE, () -> "File " + dest + " already exists for " + url + ", not downloading again");
1369                         return dest;
1370                 } else {
1371                         Files.createDirectories(dest.getParent());
1372                 }
1373
1374                 try (InputStream in = url.openStream()) {
1375                         Files.copy(in, dest);
1376                         logger.log(DEBUG, () -> "Downloaded " + dest + " from " + url);
1377                 }
1378                 return dest;
1379         }
1380
1381         /** Create a JAR file from a directory. */
1382         Path createJar(Path bundleDir, A2Origin origin) throws IOException {
1383                 Path manifestPath = bundleDir.resolve("META-INF/MANIFEST.MF");
1384                 Manifest manifest;
1385                 try (InputStream in = Files.newInputStream(manifestPath)) {
1386                         manifest = new Manifest(in);
1387                 }
1388                 // legal requirements
1389                 origin.appendChanges(bundleDir);
1390                 createReadMe(bundleDir, manifest);
1391
1392                 // create the jar
1393                 Path jarPath = bundleDir.getParent().resolve(bundleDir.getFileName() + ".jar");
1394                 try (JarOutputStream jarOut = new JarOutputStream(Files.newOutputStream(jarPath), manifest)) {
1395                         jarOut.setLevel(Deflater.DEFAULT_COMPRESSION);
1396                         Files.walkFileTree(bundleDir, new SimpleFileVisitor<Path>() {
1397
1398                                 @Override
1399                                 public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
1400                                         if (file.getFileName().toString().equals("MANIFEST.MF"))
1401                                                 return super.visitFile(file, attrs);
1402                                         JarEntry entry = new JarEntry(
1403                                                         bundleDir.relativize(file).toString().replace(File.separatorChar, '/'));
1404                                         jarOut.putNextEntry(entry);
1405                                         Files.copy(file, jarOut);
1406                                         return super.visitFile(file, attrs);
1407                                 }
1408
1409                         });
1410                 }
1411                 deleteDirectory(bundleDir);
1412
1413                 if (separateSources)
1414                         createSourceJar(bundleDir, manifest, null);
1415
1416                 return jarPath;
1417         }
1418
1419         /** Package sources separately, in the Eclipse-SourceBundle format. */
1420         void createSourceJar(Path bundleDir, Manifest manifest, Properties props) throws IOException {
1421                 boolean unmodified = props != null;
1422                 Path bundleCategoryDir = bundleDir.getParent();
1423                 Path sourceDir = bundleCategoryDir.resolve(bundleDir.toString() + ".src");
1424                 if (!Files.exists(sourceDir)) {
1425                         logger.log(WARNING, sourceDir + " does not exist, skipping...");
1426                         return;
1427                 }
1428
1429                 Path relPath = a2Base.relativize(bundleCategoryDir);
1430                 Path srcCategoryDir = a2SrcBase.resolve(relPath);
1431                 Path srcJarP = srcCategoryDir.resolve(sourceDir.getFileName() + ".jar");
1432                 Files.createDirectories(srcJarP.getParent());
1433
1434                 String bundleSymbolicName = manifest.getMainAttributes().getValue("Bundle-SymbolicName").toString();
1435                 // in case there are additional directives
1436                 bundleSymbolicName = bundleSymbolicName.split(";")[0];
1437                 Manifest srcManifest = new Manifest();
1438                 srcManifest.getMainAttributes().put(MANIFEST_VERSION, "1.0");
1439                 BUNDLE_SYMBOLICNAME.put(srcManifest, bundleSymbolicName + ".src");
1440                 BUNDLE_VERSION.put(srcManifest, BUNDLE_VERSION.get(manifest));
1441                 ECLIPSE_SOURCE_BUNDLE.put(srcManifest,
1442                                 bundleSymbolicName + ";version=\"" + BUNDLE_VERSION.get(manifest) + "\"");
1443
1444                 // metadata
1445                 createReadMe(sourceDir, unmodified ? props : manifest);
1446                 // create jar
1447                 try (JarOutputStream srcJarOut = new JarOutputStream(Files.newOutputStream(srcJarP), srcManifest)) {
1448                         // srcJarOut.setLevel(Deflater.BEST_COMPRESSION);
1449                         Files.walkFileTree(sourceDir, new SimpleFileVisitor<Path>() {
1450
1451                                 @Override
1452                                 public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
1453                                         if (file.getFileName().toString().equals("MANIFEST.MF"))
1454                                                 return super.visitFile(file, attrs);
1455                                         JarEntry entry = new JarEntry(
1456                                                         sourceDir.relativize(file).toString().replace(File.separatorChar, '/'));
1457                                         srcJarOut.putNextEntry(entry);
1458                                         Files.copy(file, srcJarOut);
1459                                         return super.visitFile(file, attrs);
1460                                 }
1461
1462                         });
1463                 }
1464                 deleteDirectory(sourceDir);
1465         }
1466
1467         /**
1468          * Generate a readme clarifying and prominently notifying of the repackaging and
1469          * modifications.
1470          */
1471         void createReadMe(Path jarDir, Object mapping) throws IOException {
1472                 // write repackaged README
1473                 try (BufferedWriter writer = Files.newBufferedWriter(jarDir.resolve(README_REPACKAGED))) {
1474                         boolean merged = ARGEO_ORIGIN_M2_MERGE.get(mapping) != null;
1475                         if (merged)
1476                                 writer.append("This component is a merging of third party components"
1477                                                 + " in order to comply with A2 packaging standards.\n");
1478                         else
1479                                 writer.append("This component is a repackaging of a third party component"
1480                                                 + " in order to comply with A2 packaging standards.\n");
1481
1482                         // license
1483                         String spdxLicenseId = SPDX_LICENSE_IDENTIFIER.get(mapping);
1484                         if (spdxLicenseId == null)
1485                                 throw new IllegalStateException("An SPDX license id must have beend defined at this stage.");
1486                         writer.append("\nIt is redistributed under the following license:\n\n");
1487                         writer.append("SPDX-Identifier: " + spdxLicenseId + "\n\n");
1488
1489                         if (!spdxLicenseId.startsWith("LicenseRef")) {// standard
1490                                 int withIndex = spdxLicenseId.indexOf(" WITH ");
1491                                 if (withIndex >= 0) {
1492                                         String simpleId = spdxLicenseId.substring(0, withIndex).trim();
1493                                         String exception = spdxLicenseId.substring(withIndex + " WITH ".length());
1494                                         writer.append("which are available here: https://spdx.org/licenses/" + simpleId
1495                                                         + "\nand here: https://spdx.org/licenses/" + exception + "\n");
1496                                 } else {
1497                                         writer.append("which is available here: https://spdx.org/licenses/" + spdxLicenseId + "\n");
1498                                 }
1499                         } else {
1500                                 String url = BUNDLE_LICENSE.get(mapping);
1501                                 if (url != null) {
1502                                         writer.write("which is available here: " + url + "\n");
1503                                 } else {
1504                                         logger.log(ERROR, "No licence URL for " + jarDir);
1505                                 }
1506                         }
1507
1508                         // origin
1509                         String originDesc = ARGEO_ORIGIN_URI.get(mapping);
1510                         if (originDesc != null)
1511                                 writer.append("\nThe original component comes from " + originDesc + ".\n");
1512                         else {
1513                                 String m2Repo = ARGEO_ORIGIN_M2_REPO.get(mapping);
1514                                 originDesc = ARGEO_ORIGIN_M2.get(mapping);
1515                                 if (originDesc != null)
1516                                         writer.append("\nThe original component has M2 coordinates:\n" + originDesc.replace(',', '\n')
1517                                                         + "\n" + (m2Repo != null ? "\nin M2 repository " + m2Repo + "\n" : ""));
1518                                 else
1519                                         logger.log(ERROR, "Cannot find origin information in " + jarDir);
1520                         }
1521                         String originSources = ARGEO_ORIGIN_SOURCES_URI.get(mapping);
1522                         if (originSources != null)
1523                                 writer.append("\nThe original sources come from " + originSources + ".\n");
1524
1525                         if (Files.exists(jarDir.resolve(CHANGES)))
1526                                 writer.append("\nA detailed list of changes is available under " + CHANGES + ".\n");
1527
1528                         if (!jarDir.getFileName().toString().endsWith(".src")) {// binary archive
1529                                 if (separateSources)
1530                                         writer.append("Corresponding sources are available in the related archive named "
1531                                                         + jarDir.toString() + ".src.jar.\n");
1532                                 else
1533                                         writer.append("Corresponding sources are available under OSGI-OPT/src.\n");
1534                         }
1535                 }
1536         }
1537
1538         /**
1539          * Gathers modifications performed on the original binaries and sources,
1540          * especially in order to comply with their license requirements.
1541          */
1542         class A2Origin {
1543                 A2Origin() {
1544
1545                 }
1546
1547                 Set<String> modified = new TreeSet<>();
1548                 Set<String> deleted = new TreeSet<>();
1549                 Set<String> added = new TreeSet<>();
1550                 Set<String> moved = new TreeSet<>();
1551
1552                 /** Append changes to the A2-ORIGIN/changes file. */
1553                 void appendChanges(Path baseDirectory) throws IOException {
1554                         if (modified.isEmpty() && deleted.isEmpty() && added.isEmpty() && moved.isEmpty())
1555                                 return; // no changes
1556                         Path changesFile = baseDirectory.resolve(CHANGES);
1557                         Files.createDirectories(changesFile.getParent());
1558                         try (BufferedWriter writer = Files.newBufferedWriter(changesFile, APPEND, CREATE)) {
1559                                 for (String msg : added)
1560                                         writer.write("- Added " + msg + ".\n");
1561                                 for (String msg : modified)
1562                                         writer.write("- Modified " + msg + ".\n");
1563                                 for (String msg : moved)
1564                                         writer.write("- Moved " + msg + ".\n");
1565                                 for (String msg : deleted)
1566                                         writer.write("- Deleted " + msg + ".\n");
1567                         }
1568                 }
1569         }
1570 }
1571
1572 /** Simple representation of an M2 artifact. */
1573 class M2Artifact extends CategoryNameVersion {
1574         private String classifier;
1575
1576         M2Artifact(String m2coordinates) {
1577                 this(m2coordinates, null);
1578         }
1579
1580         M2Artifact(String m2coordinates, String classifier) {
1581                 String[] parts = m2coordinates.split(":");
1582                 setCategory(parts[0]);
1583                 setName(parts[1]);
1584                 if (parts.length > 2) {
1585                         setVersion(parts[2]);
1586                 }
1587                 this.classifier = classifier;
1588         }
1589
1590         String getGroupId() {
1591                 return super.getCategory();
1592         }
1593
1594         String getArtifactId() {
1595                 return super.getName();
1596         }
1597
1598         String toM2Coordinates() {
1599                 return getCategory() + ":" + getName() + (getVersion() != null ? ":" + getVersion() : "");
1600         }
1601
1602         String getClassifier() {
1603                 return classifier != null ? classifier : "";
1604         }
1605
1606         String getExtension() {
1607                 return "jar";
1608         }
1609 }
1610
1611 /** Utilities around Maven (conventions based). */
1612 class M2ConventionsUtils {
1613         final static String MAVEN_CENTRAL_BASE_URL = "https://repo1.maven.org/maven2/";
1614
1615         /** The file name of this artifact when stored */
1616         static String artifactFileName(M2Artifact artifact) {
1617                 return artifact.getArtifactId() + '-' + artifact.getVersion()
1618                                 + (artifact.getClassifier().equals("") ? "" : '-' + artifact.getClassifier()) + '.'
1619                                 + artifact.getExtension();
1620         }
1621
1622         /** Absolute path to the file */
1623         static String artifactPath(String artifactBasePath, M2Artifact artifact) {
1624                 return artifactParentPath(artifactBasePath, artifact) + '/' + artifactFileName(artifact);
1625         }
1626
1627         /** Absolute path to the file */
1628         static String artifactUrl(String repoUrl, M2Artifact artifact) {
1629                 if (repoUrl.endsWith("/"))
1630                         return repoUrl + artifactPath("/", artifact).substring(1);
1631                 else
1632                         return repoUrl + artifactPath("/", artifact);
1633         }
1634
1635         /** Absolute path to the file */
1636         static URL mavenRepoUrl(String repoBase, M2Artifact artifact) {
1637                 String url = artifactUrl(repoBase == null ? MAVEN_CENTRAL_BASE_URL : repoBase, artifact);
1638                 try {
1639                         return new URL(url);
1640                 } catch (MalformedURLException e) {
1641                         // it should not happen
1642                         throw new IllegalStateException(e);
1643                 }
1644         }
1645
1646         /** Absolute path to the directories where the files will be stored */
1647         static String artifactParentPath(String artifactBasePath, M2Artifact artifact) {
1648                 return artifactBasePath + (artifactBasePath.endsWith("/") || artifactBasePath.equals("") ? "" : "/")
1649                                 + artifactParentPath(artifact);
1650         }
1651
1652         /** Relative path to the directories where the files will be stored */
1653         static String artifactParentPath(M2Artifact artifact) {
1654                 return artifact.getGroupId().replace('.', '/') + '/' + artifact.getArtifactId() + '/' + artifact.getVersion();
1655         }
1656
1657         /** Singleton */
1658         private M2ConventionsUtils() {
1659         }
1660 }
1661
1662 /** Combination of a category, a name and a version. */
1663 class CategoryNameVersion extends NameVersion {
1664         private String category;
1665
1666         CategoryNameVersion() {
1667         }
1668
1669         CategoryNameVersion(String category, String name, String version) {
1670                 super(name, version);
1671                 this.category = category;
1672         }
1673
1674         CategoryNameVersion(String category, NameVersion nameVersion) {
1675                 super(nameVersion);
1676                 this.category = category;
1677         }
1678
1679         String getCategory() {
1680                 return category;
1681         }
1682
1683         void setCategory(String category) {
1684                 this.category = category;
1685         }
1686
1687         @Override
1688         public String toString() {
1689                 return category + ":" + super.toString();
1690         }
1691
1692 }
1693
1694 /** Combination of a name and a version. */
1695 class NameVersion implements Comparable<NameVersion> {
1696         private String name;
1697         private String version;
1698
1699         NameVersion() {
1700         }
1701
1702         /** Interprets string in OSGi-like format my.module.name;version=0.0.0 */
1703         NameVersion(String nameVersion) {
1704                 int index = nameVersion.indexOf(";version=");
1705                 if (index < 0) {
1706                         setName(nameVersion);
1707                         setVersion(null);
1708                 } else {
1709                         setName(nameVersion.substring(0, index));
1710                         setVersion(nameVersion.substring(index + ";version=".length()));
1711                 }
1712         }
1713
1714         NameVersion(String name, String version) {
1715                 this.name = name;
1716                 this.version = version;
1717         }
1718
1719         NameVersion(NameVersion nameVersion) {
1720                 this.name = nameVersion.getName();
1721                 this.version = nameVersion.getVersion();
1722         }
1723
1724         String getName() {
1725                 return name;
1726         }
1727
1728         void setName(String name) {
1729                 this.name = name;
1730         }
1731
1732         String getVersion() {
1733                 return version;
1734         }
1735
1736         void setVersion(String version) {
1737                 this.version = version;
1738         }
1739
1740         String getBranch() {
1741                 String[] parts = getVersion().split("\\.");
1742                 if (parts.length < 2)
1743                         throw new IllegalStateException("Version " + getVersion() + " cannot be interpreted as branch.");
1744                 return parts[0] + "." + parts[1];
1745         }
1746
1747         @Override
1748         public boolean equals(Object obj) {
1749                 if (obj instanceof NameVersion) {
1750                         NameVersion nameVersion = (NameVersion) obj;
1751                         return name.equals(nameVersion.getName()) && version.equals(nameVersion.getVersion());
1752                 } else
1753                         return false;
1754         }
1755
1756         @Override
1757         public int hashCode() {
1758                 return name.hashCode();
1759         }
1760
1761         @Override
1762         public String toString() {
1763                 return name + ":" + version;
1764         }
1765
1766         public int compareTo(NameVersion o) {
1767                 if (o.getName().equals(name))
1768                         return version.compareTo(o.getVersion());
1769                 else
1770                         return name.compareTo(o.getName());
1771         }
1772 }