Improve A2 provisioning framework.
[lgpl/argeo-commons.git] / org.argeo.osgi.boot / src / org / argeo / osgi / boot / OsgiBoot.java
index 34457e669f1bf6387fc0cb5dbf8c4f4bf7404fe3..6824ecaf549c9c2c3a335c011cdfb1d6940838a5 100644 (file)
@@ -19,6 +19,8 @@ import static org.argeo.osgi.boot.OsgiBootUtils.debug;
 import static org.argeo.osgi.boot.OsgiBootUtils.warn;
 
 import java.io.File;
+import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
@@ -30,6 +32,8 @@ import java.util.SortedMap;
 import java.util.StringTokenizer;
 import java.util.TreeMap;
 
+import org.argeo.osgi.boot.a2.A2Source;
+import org.argeo.osgi.boot.a2.ProvisioningManager;
 import org.argeo.osgi.boot.internal.springutil.AntPathMatcher;
 import org.argeo.osgi.boot.internal.springutil.PathMatcher;
 import org.argeo.osgi.boot.internal.springutil.SystemPropertyUtils;
@@ -49,6 +53,8 @@ import org.osgi.framework.wiring.FrameworkWiring;
  */
 public class OsgiBoot implements OsgiBootConstants {
        public final static String PROP_ARGEO_OSGI_START = "argeo.osgi.start";
+       public final static String PROP_ARGEO_OSGI_SOURCES = "argeo.osgi.sources";
+
        public final static String PROP_ARGEO_OSGI_BUNDLES = "argeo.osgi.bundles";
        public final static String PROP_ARGEO_OSGI_BASE_URL = "argeo.osgi.baseUrl";
        public final static String PROP_ARGEO_OSGI_LOCAL_CACHE = "argeo.osgi.localCache";
@@ -67,9 +73,10 @@ public class OsgiBoot implements OsgiBootConstants {
        // public final static String EXCLUDES_SVN_PATTERN = "**/.svn/**";
 
        // OSGi system properties
-       public final static String PROP_OSGI_BUNDLES_DEFAULTSTARTLEVEL = "osgi.bundles.defaultStartLevel";
-       public final static String PROP_OSGI_STARTLEVEL = "osgi.startLevel";
-       public final static String INSTANCE_AREA_PROP = "osgi.instance.area";
+       final static String PROP_OSGI_BUNDLES_DEFAULTSTARTLEVEL = "osgi.bundles.defaultStartLevel";
+       final static String PROP_OSGI_STARTLEVEL = "osgi.startLevel";
+       final static String INSTANCE_AREA_PROP = "osgi.instance.area";
+       final static String CONFIGURATION_AREA_PROP = "osgi.configuration.area";
 
        // Symbolic names
        public final static String SYMBOLIC_NAME_OSGI_BOOT = "org.argeo.osgi.boot";
@@ -82,19 +89,44 @@ public class OsgiBoot implements OsgiBootConstants {
        // .booleanValue();
 
        /** Default is 10s */
-       // private long defaultTimeout = 10000l;
+       @Deprecated
+       private long defaultTimeout = 10000l;
 
        private final BundleContext bundleContext;
        private final String localCache;
 
+       private final ProvisioningManager provisioningManager;
+
        /*
         * INITIALIZATION
         */
        /** Constructor */
        public OsgiBoot(BundleContext bundleContext) {
                this.bundleContext = bundleContext;
-               localCache = getProperty(PROP_ARGEO_OSGI_LOCAL_CACHE,
-                               "file://" + System.getProperty("user.home") + "/.m2/repository/");
+               Path homePath = Paths.get(System.getProperty("user.home")).toAbsolutePath();
+               String homeUri = homePath.toUri().toString();
+               localCache = getProperty(PROP_ARGEO_OSGI_LOCAL_CACHE, homeUri + ".m2/repository/");
+
+               provisioningManager = new ProvisioningManager(bundleContext);
+               String sources = getProperty(PROP_ARGEO_OSGI_SOURCES);
+               if (sources == null) {
+                       provisioningManager.registerDefaultSource();
+               } else {
+                       for (String source : sources.split(",")) {
+                               if (source.trim().equals(A2Source.DEFAULT_A2_URI)) {
+                                       provisioningManager
+                                                       .registerSource(A2Source.SCHEME_A2 + "://" + homePath.toString() + "/.local/share/osgi");
+                                       provisioningManager.registerSource(A2Source.SCHEME_A2 + ":///usr/local/share/osgi");
+                                       provisioningManager.registerSource(A2Source.SCHEME_A2 + ":///usr/share/osgi");
+                               } else {
+                                       provisioningManager.registerSource(source);
+                               }
+                       }
+               }
+       }
+
+       ProvisioningManager getProvisioningManager() {
+               return provisioningManager;
        }
 
        /*
@@ -110,6 +142,7 @@ public class OsgiBoot implements OsgiBootConstants {
                                        .info("OSGi bootstrap starting" + (osgiInstancePath != null ? " (" + osgiInstancePath + ")" : ""));
                        installUrls(getBundlesUrls());
                        installUrls(getDistributionUrls());
+                       provisioningManager.install(null);
                        startBundles();
                        long duration = System.currentTimeMillis() - begin;
                        OsgiBootUtils.info("OSGi bootstrap completed in " + Math.round(((double) duration) / 1000) + "s ("
@@ -140,6 +173,10 @@ public class OsgiBoot implements OsgiBootConstants {
                System.out.println();
        }
 
+       public void update() {
+               provisioningManager.update();
+       }
+
        /*
         * INSTALLATION
         */
@@ -213,16 +250,21 @@ public class OsgiBoot implements OsgiBootConstants {
                                }
                        }
                } catch (BundleException e) {
+                       final String ALREADY_INSTALLED = "is already installed";
                        String message = e.getMessage();
                        if ((message.contains("Bundle \"" + SYMBOLIC_NAME_OSGI_BOOT + "\"")
                                        || message.contains("Bundle \"" + SYMBOLIC_NAME_EQUINOX + "\""))
-                                       && message.contains("is already installed")) {
+                                       && message.contains(ALREADY_INSTALLED)) {
                                // silent, in order to avoid warnings: we know that both
                                // have already been installed...
                        } else {
-                               OsgiBootUtils.warn("Could not install bundle from " + url + ": " + message);
+                               if (message.contains(ALREADY_INSTALLED)) {
+                                       if (OsgiBootUtils.isDebug())
+                                               OsgiBootUtils.warn("Duplicate install from " + url + ": " + message);
+                               } else
+                                       OsgiBootUtils.warn("Could not install bundle from " + url + ": " + message);
                        }
-                       if (OsgiBootUtils.debug && !message.contains("is already installed"))
+                       if (OsgiBootUtils.debug && !message.contains(ALREADY_INSTALLED))
                                e.printStackTrace();
                }
        }
@@ -276,7 +318,7 @@ public class OsgiBoot implements OsgiBootConstants {
                });
        }
 
-       public static void computeStartLevels(SortedMap<Integer, List<String>> startLevels, Properties properties,
+       private static void computeStartLevels(SortedMap<Integer, List<String>> startLevels, Properties properties,
                        Integer defaultStartLevel) {
 
                // default (and previously, only behaviour)
@@ -329,122 +371,112 @@ public class OsgiBoot implements OsgiBootConstants {
         * @return whether all bundles are now in active state
         * @deprecated
         */
-       // @Deprecated
-       // public boolean startBundles(List<String> bundlesToStart) {
-       // if (bundlesToStart.size() == 0)
-       // return true;
-       //
-       // // used to monitor ACTIVE states
-       // List<Bundle> startedBundles = new ArrayList<Bundle>();
-       // // used to log the bundles not found
-       // List<String> notFoundBundles = new ArrayList<String>(bundlesToStart);
-       //
-       // Bundle[] bundles = bundleContext.getBundles();
-       // long startBegin = System.currentTimeMillis();
-       // for (int i = 0; i < bundles.length; i++) {
-       // Bundle bundle = bundles[i];
-       // String symbolicName = bundle.getSymbolicName();
-       // if (bundlesToStart.contains(symbolicName))
-       // try {
-       // try {
-       // bundle.start();
-       // if (OsgiBootUtils.debug)
-       // debug("Bundle " + symbolicName + " started");
-       // } catch (Exception e) {
-       // OsgiBootUtils.warn("Start of bundle " + symbolicName + " failed because
-       // of " + e
-       // + ", maybe bundle is not yet resolved," + " waiting and trying again.");
-       // waitForBundleResolvedOrActive(startBegin, bundle);
-       // bundle.start();
-       // startedBundles.add(bundle);
-       // }
-       // notFoundBundles.remove(symbolicName);
-       // } catch (Exception e) {
-       // OsgiBootUtils.warn("Bundle " + symbolicName + " cannot be started: " +
-       // e.getMessage());
-       // if (OsgiBootUtils.debug)
-       // e.printStackTrace();
-       // // was found even if start failed
-       // notFoundBundles.remove(symbolicName);
-       // }
-       // }
-       //
-       // for (int i = 0; i < notFoundBundles.size(); i++)
-       // OsgiBootUtils.warn("Bundle '" + notFoundBundles.get(i) + "' not started
-       // because it was not found.");
-       //
-       // // monitors that all bundles are started
-       // long beginMonitor = System.currentTimeMillis();
-       // boolean allStarted = !(startedBundles.size() > 0);
-       // List<String> notStarted = new ArrayList<String>();
-       // while (!allStarted && (System.currentTimeMillis() - beginMonitor) <
-       // defaultTimeout) {
-       // notStarted = new ArrayList<String>();
-       // allStarted = true;
-       // for (int i = 0; i < startedBundles.size(); i++) {
-       // Bundle bundle = (Bundle) startedBundles.get(i);
-       // // TODO check behaviour of lazs bundles
-       // if (bundle.getState() != Bundle.ACTIVE) {
-       // allStarted = false;
-       // notStarted.add(bundle.getSymbolicName());
-       // }
-       // }
-       // try {
-       // Thread.sleep(100);
-       // } catch (InterruptedException e) {
-       // // silent
-       // }
-       // }
-       // long duration = System.currentTimeMillis() - beginMonitor;
-       //
-       // if (!allStarted)
-       // for (int i = 0; i < notStarted.size(); i++)
-       // OsgiBootUtils.warn("Bundle '" + notStarted.get(i) + "' not ACTIVE after "
-       // + (duration / 1000) + "s");
-       //
-       // return allStarted;
-       // }
+       @Deprecated
+       public boolean startBundles(List<String> bundlesToStart) {
+               if (bundlesToStart.size() == 0)
+                       return true;
+
+               // used to monitor ACTIVE states
+               List<Bundle> startedBundles = new ArrayList<Bundle>();
+               // used to log the bundles not found
+               List<String> notFoundBundles = new ArrayList<String>(bundlesToStart);
+
+               Bundle[] bundles = bundleContext.getBundles();
+               long startBegin = System.currentTimeMillis();
+               for (int i = 0; i < bundles.length; i++) {
+                       Bundle bundle = bundles[i];
+                       String symbolicName = bundle.getSymbolicName();
+                       if (bundlesToStart.contains(symbolicName))
+                               try {
+                                       try {
+                                               bundle.start();
+                                               if (OsgiBootUtils.debug)
+                                                       debug("Bundle " + symbolicName + " started");
+                                       } catch (Exception e) {
+                                               OsgiBootUtils.warn("Start of bundle " + symbolicName + " failed because of " + e
+                                                               + ", maybe bundle is not yet resolved," + " waiting and trying again.");
+                                               waitForBundleResolvedOrActive(startBegin, bundle);
+                                               bundle.start();
+                                               startedBundles.add(bundle);
+                                       }
+                                       notFoundBundles.remove(symbolicName);
+                               } catch (Exception e) {
+                                       OsgiBootUtils.warn("Bundle " + symbolicName + " cannot be started: " + e.getMessage());
+                                       if (OsgiBootUtils.debug)
+                                               e.printStackTrace();
+                                       // was found even if start failed
+                                       notFoundBundles.remove(symbolicName);
+                               }
+               }
+
+               for (int i = 0; i < notFoundBundles.size(); i++)
+                       OsgiBootUtils.warn("Bundle '" + notFoundBundles.get(i) + "' not started because it was not found.");
+
+               // monitors that all bundles are started
+               long beginMonitor = System.currentTimeMillis();
+               boolean allStarted = !(startedBundles.size() > 0);
+               List<String> notStarted = new ArrayList<String>();
+               while (!allStarted && (System.currentTimeMillis() - beginMonitor) < defaultTimeout) {
+                       notStarted = new ArrayList<String>();
+                       allStarted = true;
+                       for (int i = 0; i < startedBundles.size(); i++) {
+                               Bundle bundle = (Bundle) startedBundles.get(i);
+                               // TODO check behaviour of lazs bundles
+                               if (bundle.getState() != Bundle.ACTIVE) {
+                                       allStarted = false;
+                                       notStarted.add(bundle.getSymbolicName());
+                               }
+                       }
+                       try {
+                               Thread.sleep(100);
+                       } catch (InterruptedException e) {
+                               // silent
+                       }
+               }
+               long duration = System.currentTimeMillis() - beginMonitor;
+
+               if (!allStarted)
+                       for (int i = 0; i < notStarted.size(); i++)
+                               OsgiBootUtils.warn("Bundle '" + notStarted.get(i) + "' not ACTIVE after " + (duration / 1000) + "s");
+
+               return allStarted;
+       }
 
        /** Waits for a bundle to become active or resolved */
-       // private void waitForBundleResolvedOrActive(long startBegin, Bundle
-       // bundle) throws Exception {
-       // int originalState = bundle.getState();
-       // if ((originalState == Bundle.RESOLVED) || (originalState ==
-       // Bundle.ACTIVE))
-       // return;
-       //
-       // String originalStateStr = OsgiBootUtils.stateAsString(originalState);
-       //
-       // int currentState = bundle.getState();
-       // while (!(currentState == Bundle.RESOLVED || currentState ==
-       // Bundle.ACTIVE)) {
-       // long now = System.currentTimeMillis();
-       // if ((now - startBegin) > defaultTimeout * 10)
-       // throw new Exception("Bundle " + bundle.getSymbolicName() + " was not
-       // RESOLVED or ACTIVE after "
-       // + (now - startBegin) + "ms (originalState=" + originalStateStr + ",
-       // currentState="
-       // + OsgiBootUtils.stateAsString(currentState) + ")");
-       //
-       // try {
-       // Thread.sleep(100l);
-       // } catch (InterruptedException e) {
-       // // silent
-       // }
-       // currentState = bundle.getState();
-       // }
-       // }
+       @Deprecated
+       private void waitForBundleResolvedOrActive(long startBegin, Bundle bundle) throws Exception {
+               int originalState = bundle.getState();
+               if ((originalState == Bundle.RESOLVED) || (originalState == Bundle.ACTIVE))
+                       return;
+
+               String originalStateStr = OsgiBootUtils.stateAsString(originalState);
+
+               int currentState = bundle.getState();
+               while (!(currentState == Bundle.RESOLVED || currentState == Bundle.ACTIVE)) {
+                       long now = System.currentTimeMillis();
+                       if ((now - startBegin) > defaultTimeout * 10)
+                               throw new Exception("Bundle " + bundle.getSymbolicName() + " was not RESOLVED or ACTIVE after "
+                                               + (now - startBegin) + "ms (originalState=" + originalStateStr + ", currentState="
+                                               + OsgiBootUtils.stateAsString(currentState) + ")");
+
+                       try {
+                               Thread.sleep(100l);
+                       } catch (InterruptedException e) {
+                               // silent
+                       }
+                       currentState = bundle.getState();
+               }
+       }
 
        /*
         * BUNDLE PATTERNS INSTALLATION
         */
        /**
-        * Computes a list of URLs based on Ant-like include/exclude patterns
-        * defined by ${argeo.osgi.bundles} with the following format:<br>
+        * Computes a list of URLs based on Ant-like include/exclude patterns defined by
+        * ${argeo.osgi.bundles} with the following format:<br>
         * <code>/base/directory;in=*.jar;in=**;ex=org.eclipse.osgi_*;jar</code><br>
         * WARNING: <code>/base/directory;in=*.jar,\</code> at the end of a file,
-        * without a new line causes a '.' to be appended with unexpected side
-        * effects.
+        * without a new line causes a '.' to be appended with unexpected side effects.
         */
        public List<String> getBundlesUrls() {
                String bundlePatterns = getProperty(PROP_ARGEO_OSGI_BUNDLES);
@@ -452,7 +484,7 @@ public class OsgiBoot implements OsgiBootConstants {
        }
 
        /**
-        * Compute alist of URLs to install based on the provided patterns, with
+        * Compute a list of URLs to install based on the provided patterns, with
         * default base url
         */
        public List<String> getBundlesUrls(String bundlePatterns) {
@@ -461,7 +493,7 @@ public class OsgiBoot implements OsgiBootConstants {
        }
 
        /** Implements the path matching logic */
-       List<String> getBundlesUrls(String baseUrl, String bundlePatterns) {
+       public List<String> getBundlesUrls(String baseUrl, String bundlePatterns) {
                List<String> urls = new ArrayList<String>();
                if (bundlePatterns == null)
                        return urls;
@@ -527,15 +559,44 @@ public class OsgiBoot implements OsgiBootConstants {
                        return urls;
 
                DistributionBundle distributionBundle;
-               if (baseUrl != null && !(distributionUrl.startsWith("http") || distributionUrl.startsWith("file"))) {
-                       // relative url
-                       distributionBundle = new DistributionBundle(baseUrl, distributionUrl, localCache);
-               } else {
+               if (distributionUrl.startsWith("http") || distributionUrl.startsWith("file")) {
                        distributionBundle = new DistributionBundle(distributionUrl);
                        if (baseUrl != null)
                                distributionBundle.setBaseUrl(baseUrl);
+               } else {
+                       // relative url
+                       if (baseUrl == null) {
+                               baseUrl = localCache;
+                       }
+
+                       if (distributionUrl.contains(":")) {
+                               // TODO make it safer
+                               String[] parts = distributionUrl.trim().split(":");
+                               String[] categoryParts = parts[0].split("\\.");
+                               String artifactId = parts[1];
+                               String version = parts[2];
+                               StringBuilder sb = new StringBuilder();
+                               for (String categoryPart : categoryParts) {
+                                       sb.append(categoryPart).append('/');
+                               }
+                               sb.append(artifactId).append('/');
+                               sb.append(version).append('/');
+                               sb.append(artifactId).append('-').append(version).append(".jar");
+                               distributionUrl = sb.toString();
+                       }
 
+                       distributionBundle = new DistributionBundle(baseUrl, distributionUrl, localCache);
                }
+               // if (baseUrl != null && !(distributionUrl.startsWith("http") ||
+               // distributionUrl.startsWith("file"))) {
+               // // relative url
+               // distributionBundle = new DistributionBundle(baseUrl, distributionUrl,
+               // localCache);
+               // } else {
+               // distributionBundle = new DistributionBundle(distributionUrl);
+               // if (baseUrl != null)
+               // distributionBundle.setBaseUrl(baseUrl);
+               // }
                distributionBundle.processUrl();
                return distributionBundle.listUrls();
        }
@@ -682,6 +743,10 @@ public class OsgiBoot implements OsgiBootConstants {
                return bundleContext;
        }
 
+       public String getLocalCache() {
+               return localCache;
+       }
+
        // public void setDefaultTimeout(long defaultTimeout) {
        // this.defaultTimeout = defaultTimeout;
        // }