Changeset 12322 in josm for trunk/src/org/openstreetmap/josm

Timestamp:

2017-06-06T13:43:28+02:00 (7 years ago)

Author:

bastiK

Message:

fixed #14901 - restrict plugin classpath

Separate class loader for each plugin instead of unified class loader.

Location:

trunk/src/org/openstreetmap/josm/plugins

Files:

• PluginClassLoader.java (added)
• PluginHandler.java (modified) (6 diffs)
• PluginInformation.java (modified) (1 diff)
• PluginProxy.java (modified) (2 diffs)

trunk/src/org/openstreetmap/josm/plugins/PluginHandler.java

@@ -290 +290 @@
 
     /**
-     * Global plugin ClassLoader.
-     */
-    private static DynamicURLClassLoader pluginClassLoader;
+     * Class loader to locate resources from plugins.
+     * @see #getJoinedPluginResourceCL()
+     */
+    private static DynamicURLClassLoader joinedPluginResourceCL;
 
     /**
@@ -709 +710 @@
 
     /**
-     * Get the class loader for loading plugin code.
+     * Method to get the (now obsolete) class loader for loading plugin code.
      *
      * @return the class loader
-     */
+     * @deprecated There is no longer a unified plugin class loader. Use {@link PluginProxy#classLoader}
+     * to get the class loader for each plugin. Or <code>PluginClass.class.getClassLoader()</code>
+     * to access the class loader from within the plugin.
+     */
+    @Deprecated
     public static synchronized DynamicURLClassLoader getPluginClassLoader() {
-        if (pluginClassLoader == null) {
-            pluginClassLoader = AccessController.doPrivileged((PrivilegedAction<DynamicURLClassLoader>)
+        return getJoinedPluginResourceCL();
+    }
+
+    /**
+     * Get class loader to locate resources from plugins.
+     *
+     * It joins URLs of all plugins, to find images, etc.
+     * (Not for loading Java classes - each plugin has a separate {@link PluginClassLoader}
+     * for that purpose.)
+     * @return class loader to locate resources from plugins
+     */
+    private static synchronized DynamicURLClassLoader getJoinedPluginResourceCL() {
+        if (joinedPluginResourceCL == null) {
+            joinedPluginResourceCL = AccessController.doPrivileged((PrivilegedAction<DynamicURLClassLoader>)
                     () -> new DynamicURLClassLoader(new URL[0], Main.class.getClassLoader()));
-            sources.add(0, pluginClassLoader);
-        }
-        return pluginClassLoader;
-    }
-
-    /**
-     * Add more plugins to the plugin class loader.
-     *
-     * @param plugins the plugins that should be handled by the plugin class loader
-     */
-    public static void extendPluginClassLoader(Collection<PluginInformation> plugins) {
+            sources.add(0, joinedPluginResourceCL);
+        }
+        return joinedPluginResourceCL;
+    }
+
+    /**
+     * Add more plugins to the joined plugin resource class loader.
+     *
+     * @param plugins the plugins to add
+     */
+    private static void extendJoinedPluginResourceCL(Collection<PluginInformation> plugins) {
         // iterate all plugins and collect all libraries of all plugins:
         File pluginDir = Main.pref.getPluginsDirectory();
-        DynamicURLClassLoader cl = getPluginClassLoader();
+        DynamicURLClassLoader cl = getJoinedPluginResourceCL();
 
         for (PluginInformation info : plugins) {
@@ -754 +771 @@
      * @param pluginClassLoader the plugin class loader
      */
-    public static void loadPlugin(Component parent, PluginInformation plugin, ClassLoader pluginClassLoader) {
+    private static void loadPlugin(Component parent, PluginInformation plugin, PluginClassLoader pluginClassLoader) {
         String msg = tr("Could not load plugin {0}. Delete from preferences?", plugin.name);
         try {
@@ -760 +777 @@
             if (klass != null) {
                 Main.info(tr("loading plugin ''{0}'' (version {1})", plugin.name, plugin.localversion));
-                PluginProxy pluginProxy = plugin.load(klass);
+                PluginProxy pluginProxy = plugin.load(klass, pluginClassLoader);
                 pluginList.add(pluginProxy);
                 Main.addAndFireMapFrameListener(pluginProxy);
@@ -808 +825 @@
                 return;
 
-            extendPluginClassLoader(toLoad);
+            Map<PluginInformation, PluginClassLoader> classLoaders = new HashMap<>();
+            for (PluginInformation info : toLoad) {
+                classLoaders.put(info, new PluginClassLoader(
+                        info.libraries.toArray(new URL[0]),
+                        Main.class.getClassLoader(),
+                        null));
+            }
+
+            // resolve dependencies
+            for (PluginInformation info : toLoad) {
+                PluginClassLoader cl = classLoaders.get(info);
+                DEPENDENCIES:
+                for (String depName : info.getRequiredPlugins()) {
+                    for (PluginInformation depInfo : toLoad) {
+                        if (depInfo.getName().equals(depName)) {
+                            cl.addDependency(classLoaders.get(depInfo));
+                            continue DEPENDENCIES;
+                        }
+                    }
+                    for (PluginProxy proxy : pluginList) {
+                        if (proxy.getPluginInformation().getName().equals(depName)) {
+                            cl.addDependency(proxy.getClassLoader());
+                            continue DEPENDENCIES;
+                        }
+                    }
+                    throw new AssertionError("unable to find dependency " + depName + " for plugin " + info.getName());
+                }
+            }
+
+            extendJoinedPluginResourceCL(toLoad);
             monitor.setTicksCount(toLoad.size());
             for (PluginInformation info : toLoad) {
                 monitor.setExtraText(tr("Loading plugin ''{0}''...", info.name));
-                loadPlugin(parent, info, getPluginClassLoader());
+                loadPlugin(parent, info, classLoaders.get(info));
                 monitor.worked(1);
             }
@@ -1162 +1208 @@
         for (PluginProxy plugin : pluginList) {
             if (plugin.getPluginInformation().name.equals(name))
-                return plugin.plugin;
+                return plugin.getPlugin();
         }
         return null;

trunk/src/org/openstreetmap/josm/plugins/PluginInformation.java

@@ -316 +316 @@
      *
      * @param klass the plugin class
+     * @param classLoader the class loader for the plugin
      * @return the instantiated and initialized plugin
      * @throws PluginException if the plugin cannot be loaded or instanciated
-     */
-    public PluginProxy load(Class<?> klass) throws PluginException {
+     * @since 12322
+     */
+    public PluginProxy load(Class<?> klass, PluginClassLoader classLoader) throws PluginException {
         try {
             Constructor<?> c = klass.getConstructor(PluginInformation.class);
             Object plugin = c.newInstance(this);
-            return new PluginProxy(plugin, this);
+            return new PluginProxy(plugin, this, classLoader);
         } catch (ReflectiveOperationException e) {
             throw new PluginException(name, e);

trunk/src/org/openstreetmap/josm/plugins/PluginProxy.java

@@ -22 +22 @@
      * The plugin.
      */
-    public final Object plugin;
+    private final Object plugin;
+    private final PluginClassLoader classLoader;
 
     /**
@@ -28 +29 @@
      * @param plugin the plugin
      * @param info the associated plugin info
+     * @param classLoader the class loader for the plugin
+     * @since 12322
      */
-    public PluginProxy(Object plugin, PluginInformation info) {
+    public PluginProxy(Object plugin, PluginInformation info, PluginClassLoader classLoader) {
         super(info);
         this.plugin = plugin;
+        this.classLoader = classLoader;
+    }
+
+    /**
+     * Get the plugin object.
+     * @return the plugin object
+     * @since 12322
+     */
+    public Object getPlugin() {
+        return plugin;
+    }
+
+    /**
+     * Get the class loader for the plugin.
+     * @return the plugin class loader
+     * @since 12322
+     */
+    public PluginClassLoader getClassLoader() {
+        return classLoader;
     }