X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=org.argeo.osgi.boot%2Fsrc%2Forg%2Fargeo%2Fosgi%2Fboot%2FOsgiBoot.java;h=38da0479f6d5579742f9d00c655c35fd2c254416;hb=79e0a2a5d751c7c077e52f9ee54469656dc96a44;hp=bd49d99d47dcd8f465bb8f4f4d70268da7e5a289;hpb=ebd927da42511bb5959000c50a39974c6cfa5f49;p=lgpl%2Fargeo-commons.git diff --git a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBoot.java b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBoot.java index bd49d99d4..38da0479f 100644 --- a/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBoot.java +++ b/org.argeo.osgi.boot/src/org/argeo/osgi/boot/OsgiBoot.java @@ -19,7 +19,8 @@ import static org.argeo.osgi.boot.OsgiBootUtils.debug; import static org.argeo.osgi.boot.OsgiBootUtils.warn; import java.io.File; -import java.io.IOException; +import java.nio.file.Path; +import java.nio.file.Paths; import java.util.ArrayList; import java.util.HashMap; import java.util.Iterator; @@ -31,6 +32,8 @@ import java.util.SortedMap; import java.util.StringTokenizer; import java.util.TreeMap; +import org.argeo.osgi.a2.A2Source; +import org.argeo.osgi.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; @@ -38,8 +41,10 @@ import org.osgi.framework.Bundle; import org.osgi.framework.BundleContext; import org.osgi.framework.BundleException; import org.osgi.framework.FrameworkEvent; +import org.osgi.framework.Version; import org.osgi.framework.startlevel.BundleStartLevel; import org.osgi.framework.startlevel.FrameworkStartLevel; +import org.osgi.framework.wiring.FrameworkWiring; /** * Basic provisioning of an OSGi runtime via file path patterns and system @@ -47,46 +52,50 @@ import org.osgi.framework.startlevel.FrameworkStartLevel; * methods, configured via properties. */ public class OsgiBoot implements OsgiBootConstants { - // public final static String PROP_ARGEO_OSGI_DATA_DIR = - // "argeo.osgi.data.dir"; 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"; public final static String PROP_ARGEO_OSGI_DISTRIBUTION_URL = "argeo.osgi.distributionUrl"; // booleans public final static String PROP_ARGEO_OSGI_BOOT_DEBUG = "argeo.osgi.boot.debug"; - public final static String PROP_ARGEO_OSGI_BOOT_EXCLUDE_SVN = "argeo.osgi.boot.excludeSvn"; + // public final static String PROP_ARGEO_OSGI_BOOT_EXCLUDE_SVN = + // "argeo.osgi.boot.excludeSvn"; - // public final static String PROP_ARGEO_OSGI_BOOT_DEFAULT_TIMEOUT = - // "argeo.osgi.boot.defaultTimeout"; public final static String PROP_ARGEO_OSGI_BOOT_SYSTEM_PROPERTIES_FILE = "argeo.osgi.boot.systemPropertiesFile"; public final static String PROP_ARGEO_OSGI_BOOT_APPCLASS = "argeo.osgi.boot.appclass"; public final static String PROP_ARGEO_OSGI_BOOT_APPARGS = "argeo.osgi.boot.appargs"; public final static String DEFAULT_BASE_URL = "reference:file:"; - public final static String EXCLUDES_SVN_PATTERN = "**/.svn/**"; + // 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"; - // public final static String INSTANCE_AREA_DEFAULT_PROP = - // "osgi.instance.area.default"; + 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"; public final static String SYMBOLIC_NAME_EQUINOX = "org.eclipse.osgi"; - private boolean debug = Boolean.valueOf(System.getProperty(PROP_ARGEO_OSGI_BOOT_DEBUG, "false")).booleanValue(); /** Exclude svn metadata implicitely(a bit costly) */ - private boolean excludeSvn = Boolean.valueOf(System.getProperty(PROP_ARGEO_OSGI_BOOT_EXCLUDE_SVN, "false")) - .booleanValue(); + // private boolean excludeSvn = + // Boolean.valueOf(System.getProperty(PROP_ARGEO_OSGI_BOOT_EXCLUDE_SVN, + // "false")) + // .booleanValue(); /** Default is 10s */ + @Deprecated private long defaultTimeout = 10000l; private final BundleContext bundleContext; + private final String localCache; + + private final ProvisioningManager provisioningManager; /* * INITIALIZATION @@ -94,37 +103,31 @@ public class OsgiBoot implements OsgiBootConstants { /** Constructor */ public OsgiBoot(BundleContext bundleContext) { this.bundleContext = bundleContext; - // defaultTimeout = - // Long.parseLong(OsgiBootUtils.getProperty(PROP_ARGEO_OSGI_BOOT_DEFAULT_TIMEOUT, - // "10000")); - // initSystemProperties(); + 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); + } + } + } } - // /** - // * Set additional system properties, especially ${argeo.osgi.data.dir} as - // an - // * OS file path (and not a file:// URL) - // */ - // private void initSystemProperties() { - // String osgiInstanceArea = System.getProperty(INSTANCE_AREA_PROP); - // String osgiInstanceAreaDefault = - // System.getProperty(INSTANCE_AREA_DEFAULT_PROP); - // String tempDir = System.getProperty("java.io.tmpdir"); - // - // File dataDir = null; - // if (osgiInstanceArea != null) { - // // within OSGi with -data specified - // osgiInstanceArea = removeFilePrefix(osgiInstanceArea); - // dataDir = new File(osgiInstanceArea); - // } else if (osgiInstanceAreaDefault != null) { - // // within OSGi without -data specified - // osgiInstanceAreaDefault = removeFilePrefix(osgiInstanceAreaDefault); - // dataDir = new File(osgiInstanceAreaDefault); - // } else {// outside OSGi - // dataDir = new File(tempDir + File.separator + "argeoOsgiData"); - // } - // System.setProperty(PROP_ARGEO_OSGI_DATA_DIR, dataDir.getAbsolutePath()); - // } + ProvisioningManager getProvisioningManager() { + return provisioningManager; + } /* * HIGH-LEVEL METHODS @@ -137,11 +140,9 @@ public class OsgiBoot implements OsgiBootConstants { String osgiInstancePath = bundleContext.getProperty(INSTANCE_AREA_PROP); OsgiBootUtils .info("OSGi bootstrap starting" + (osgiInstancePath != null ? " (" + osgiInstancePath + ")" : "")); - // OsgiBootUtils.info("Writable data directory : " + - // System.getProperty(PROP_ARGEO_OSGI_DATA_DIR) - // + " (set as system property " + PROP_ARGEO_OSGI_DATA_DIR + ")"); 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 (" @@ -152,7 +153,7 @@ public class OsgiBoot implements OsgiBootConstants { } // diagnostics - if (debug) { + if (OsgiBootUtils.debug) { OsgiBootDiagnostics diagnostics = new OsgiBootDiagnostics(bundleContext); diagnostics.checkUnresolved(); Map> duplicatePackages = diagnostics.findPackagesExportedTwice(); @@ -172,6 +173,10 @@ public class OsgiBoot implements OsgiBootConstants { System.out.println(); } + public void update() { + provisioningManager.update(); + } + /* * INSTALLATION */ @@ -190,6 +195,7 @@ public class OsgiBoot implements OsgiBootConstants { String url = (String) urls.get(i); installUrl(url, installedBundles); } + refreshFramework(); } /** Actually install the provided URL */ @@ -197,11 +203,11 @@ public class OsgiBoot implements OsgiBootConstants { try { if (installedBundles.containsKey(url)) { Bundle bundle = (Bundle) installedBundles.get(url); - if (debug) + if (OsgiBootUtils.debug) debug("Bundle " + bundle.getSymbolicName() + " already installed from " + url); } else if (url.contains("/" + SYMBOLIC_NAME_EQUINOX + "/") || url.contains("/" + SYMBOLIC_NAME_OSGI_BOOT + "/")) { - if (debug) + if (OsgiBootUtils.debug) warn("Skip " + url); return; } else { @@ -209,21 +215,56 @@ public class OsgiBoot implements OsgiBootConstants { if (url.startsWith("http")) OsgiBootUtils .info("Installed " + bundle.getSymbolicName() + "-" + bundle.getVersion() + " from " + url); - else if (debug) + else if (OsgiBootUtils.debug) OsgiBootUtils.debug( "Installed " + bundle.getSymbolicName() + "-" + bundle.getVersion() + " from " + url); + assert bundle.getSymbolicName() != null; + // uninstall previous versions + bundles: for (Bundle b : bundleContext.getBundles()) { + if (b.getSymbolicName() == null) + continue bundles; + if (bundle.getSymbolicName().equals(b.getSymbolicName())) { + Version bundleV = bundle.getVersion(); + Version bV = b.getVersion(); + if (bV == null) + continue bundles; + if (bundleV.getMajor() == bV.getMajor() && bundleV.getMinor() == bV.getMinor()) { + if (bundleV.getMicro() > bV.getMicro()) { + // uninstall older bundles + b.uninstall(); + OsgiBootUtils.debug("Uninstalled " + b); + } else if (bundleV.getMicro() < bV.getMicro()) { + // uninstall just installed bundle if newer + bundle.uninstall(); + OsgiBootUtils.debug("Uninstalled " + bundle); + break bundles; + } else { + // uninstall any other with same major/minor + if (!bundleV.getQualifier().equals(bV.getQualifier())) { + b.uninstall(); + OsgiBootUtils.debug("Uninstalled " + b); + } + } + } + } + } } } 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 (debug) + if (OsgiBootUtils.debug && !message.contains(ALREADY_INSTALLED)) e.printStackTrace(); } } @@ -275,20 +316,9 @@ public class OsgiBoot implements OsgiBootConstants { int startLevel = frameworkStartLevel.getStartLevel(); OsgiBootUtils.debug("Framework start level: " + startLevel + " (initial: " + initialStartLevel + ")"); }); - - // Iterator levels = startLevels.keySet().iterator(); - // while (levels.hasNext()) { - // Integer level = (Integer) levels.next(); - // boolean allStarted = startBundles(startLevels.get(level)); - // if (!allStarted) - // OsgiBootUtils.warn("Not all bundles started for level " + level); - // if (level.equals(activeStartLevel)) - // break;// active start level reached - // } - } - public static void computeStartLevels(SortedMap> startLevels, Properties properties, + private static void computeStartLevels(SortedMap> startLevels, Properties properties, Integer defaultStartLevel) { // default (and previously, only behaviour) @@ -360,7 +390,7 @@ public class OsgiBoot implements OsgiBootConstants { try { try { bundle.start(); - if (debug) + if (OsgiBootUtils.debug) debug("Bundle " + symbolicName + " started"); } catch (Exception e) { OsgiBootUtils.warn("Start of bundle " + symbolicName + " failed because of " + e @@ -372,7 +402,7 @@ public class OsgiBoot implements OsgiBootConstants { notFoundBundles.remove(symbolicName); } catch (Exception e) { OsgiBootUtils.warn("Bundle " + symbolicName + " cannot be started: " + e.getMessage()); - if (debug) + if (OsgiBootUtils.debug) e.printStackTrace(); // was found even if start failed notFoundBundles.remove(symbolicName); @@ -380,7 +410,7 @@ public class OsgiBoot implements OsgiBootConstants { } for (int i = 0; i < notFoundBundles.size(); i++) - OsgiBootUtils.warn("Bundle '" + notFoundBundles.get(i) + "' not started because it was not found."); + OsgiBootUtils.warn("Bundle '" + notFoundBundles.get(i) + "' not started because it was not found."); // monitors that all bundles are started long beginMonitor = System.currentTimeMillis(); @@ -413,6 +443,7 @@ public class OsgiBoot implements OsgiBootConstants { } /** Waits for a bundle to become active or resolved */ + @Deprecated private void waitForBundleResolvedOrActive(long startBegin, Bundle bundle) throws Exception { int originalState = bundle.getState(); if ((originalState == Bundle.RESOLVED) || (originalState == Bundle.ACTIVE)) @@ -441,12 +472,11 @@ public class OsgiBoot implements OsgiBootConstants { * BUNDLE PATTERNS INSTALLATION */ /** - * Computes a list of URLs based on Ant-like include/exclude patterns - * defined by ${argeo.osgi.bundles} with the following format:
+ * Computes a list of URLs based on Ant-like include/exclude patterns defined by + * ${argeo.osgi.bundles} with the following format:
* /base/directory;in=*.jar;in=**;ex=org.eclipse.osgi_*;jar
* WARNING: /base/directory;in=*.jar,\ 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 getBundlesUrls() { String bundlePatterns = getProperty(PROP_ARGEO_OSGI_BUNDLES); @@ -454,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 getBundlesUrls(String bundlePatterns) { @@ -463,14 +493,14 @@ public class OsgiBoot implements OsgiBootConstants { } /** Implements the path matching logic */ - List getBundlesUrls(String baseUrl, String bundlePatterns) { + public List getBundlesUrls(String baseUrl, String bundlePatterns) { List urls = new ArrayList(); if (bundlePatterns == null) return urls; bundlePatterns = SystemPropertyUtils.resolvePlaceholders(bundlePatterns); - if (debug) - debug(PROP_ARGEO_OSGI_BUNDLES + "=" + bundlePatterns + " (excludeSvn=" + excludeSvn + ")"); + if (OsgiBootUtils.debug) + debug(PROP_ARGEO_OSGI_BUNDLES + "=" + bundlePatterns); StringTokenizer st = new StringTokenizer(bundlePatterns, ","); List bundlesSets = new ArrayList(); @@ -529,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); - } 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(); } @@ -553,7 +612,7 @@ public class OsgiBoot implements OsgiBootConstants { File[] files = baseDir.listFiles(); if (files == null) { - if (debug) + if (OsgiBootUtils.debug) OsgiBootUtils.warn("Base dir " + baseDir + " has no children, exists=" + baseDir.exists() + ", isDirectory=" + baseDir.isDirectory()); return; @@ -585,13 +644,13 @@ public class OsgiBoot implements OsgiBootConstants { // recurse only if start matches match(matcher, matched, base, newCurrentPath, pattern); } else { - if (debug) + if (OsgiBootUtils.debug) debug(newCurrentPath + " does not start match with " + pattern); } } else { boolean nonDirectoryOk = matcher.match(pattern, newCurrentPath); - if (debug) + if (OsgiBootUtils.debug) debug(currentPath + " " + (ok ? "" : " not ") + " matched with " + pattern); if (nonDirectoryOk) matched.add(relativeToFullPath(base, newCurrentPath)); @@ -645,14 +704,11 @@ public class OsgiBoot implements OsgiBootConstants { return (basePath + '/' + relativePath).replace('/', File.separatorChar); } - // private String removeFilePrefix(String url) { - // if (url.startsWith("file:")) - // return url.substring("file:".length()); - // else if (url.startsWith("reference:file:")) - // return url.substring("reference:file:".length()); - // else - // return url; - // } + private void refreshFramework() { + Bundle systemBundle = bundleContext.getBundle(0); + FrameworkWiring frameworkWiring = systemBundle.adapt(FrameworkWiring.class); + frameworkWiring.refreshBundles(null); + } /** * Gets a property value @@ -661,20 +717,10 @@ public class OsgiBoot implements OsgiBootConstants { */ public String getProperty(String name, String defaultValue) { String value = bundleContext.getProperty(name); - if (value == null) + if (value == null) return defaultValue; // may be null else return value; - -// if (defaultValue != null) -// value = System.getProperty(name, defaultValue); -// else -// value = System.getProperty(name); -// -// if (value == null || value.equals("")) -// return null; -// else -// return value; } public String getProperty(String name) { @@ -686,94 +732,35 @@ public class OsgiBoot implements OsgiBootConstants { */ public boolean getDebug() { - return debug; + return OsgiBootUtils.debug; } - public void setDebug(boolean debug) { - this.debug = debug; - } + // public void setDebug(boolean debug) { + // this.debug = debug; + // } public BundleContext getBundleContext() { return bundleContext; } + public String getLocalCache() { + return localCache; + } + // public void setDefaultTimeout(long defaultTimeout) { // this.defaultTimeout = defaultTimeout; // } - public boolean isExcludeSvn() { - return excludeSvn; - } - - public void setExcludeSvn(boolean excludeSvn) { - this.excludeSvn = excludeSvn; - } + // public boolean isExcludeSvn() { + // return excludeSvn; + // } + // + // public void setExcludeSvn(boolean excludeSvn) { + // this.excludeSvn = excludeSvn; + // } /* * INTERNAL CLASSES */ - /** Intermediary structure used by path matching */ - protected class BundlesSet { - private String baseUrl = "reference:file";// not used yet - private final String dir; - private List includes = new ArrayList(); - private List excludes = new ArrayList(); - - public BundlesSet(String def) { - StringTokenizer st = new StringTokenizer(def, ";"); - - if (!st.hasMoreTokens()) - throw new RuntimeException("Base dir not defined."); - try { - String dirPath = st.nextToken(); - - if (dirPath.startsWith("file:")) - dirPath = dirPath.substring("file:".length()); - - dir = new File(dirPath.replace('/', File.separatorChar)).getCanonicalPath(); - if (debug) - debug("Base dir: " + dir); - } catch (IOException e) { - throw new RuntimeException("Cannot convert to absolute path", e); - } - - while (st.hasMoreTokens()) { - String tk = st.nextToken(); - StringTokenizer stEq = new StringTokenizer(tk, "="); - String type = stEq.nextToken(); - String pattern = stEq.nextToken(); - if ("in".equals(type) || "include".equals(type)) { - includes.add(pattern); - } else if ("ex".equals(type) || "exclude".equals(type)) { - excludes.add(pattern); - } else if ("baseUrl".equals(type)) { - baseUrl = pattern; - } else { - System.err.println("Unkown bundles pattern type " + type); - } - } - - if (excludeSvn && !excludes.contains(EXCLUDES_SVN_PATTERN)) { - excludes.add(EXCLUDES_SVN_PATTERN); - } - } - - public String getDir() { - return dir; - } - - public List getIncludes() { - return includes; - } - - public List getExcludes() { - return excludes; - } - - public String getBaseUrl() { - return baseUrl; - } - - } }