Changeset 243 in josm for src/org/openstreetmap/josm/plugins

Timestamp:

2007-05-22T21:58:09+02:00 (17 years ago)

Author:

imi

Message:

• added josm.plugins - Java property to load plugins regardless of preferences
• fixed posibility to load Plugins from bootstrap classloader (with full manifest support)
• added System wide plugin and ressource directories

File:

• src/org/openstreetmap/josm/plugins/PluginInformation.java (modified) (8 diffs)

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

@@ -4 +4 @@
 import java.io.FileInputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.net.URL;
 import java.net.URLClassLoader;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.List;
 import java.util.Map;
@@ -13 +15 @@
 import java.util.jar.JarInputStream;
 import java.util.jar.Manifest;
+
+import org.openstreetmap.josm.Main;
 
 /**
@@ -21 +25 @@
  */
 public class PluginInformation {
-        
-        /**
-         * Whether to use the standard classloader to load the plugins or
-         * an seperate class loader. Note that in case of the standard classloader,
-         * all plugin files has to be included in the main josm.jar classpath
-         * 
-         * Set via command line parameter to true.
-         * 
-         * This switch is intended for debugging JOSM (or prepackaging plugins
-         * together with JOSM).
-         */
-        public static boolean useJosmClassloader = false;
         
         public final File file;
@@ -49 +41 @@
          */
         public PluginInformation(File file) {
+                this(file, file.getName().substring(0, file.getName().length()-4), null);
+        }
+        
+        public PluginInformation(File file, String name, InputStream manifestStream) {
+                this.name = name;
                 this.file = file;
-                name = file.getName().substring(0, file.getName().length()-4);
                 try {
-                        JarInputStream jar = new JarInputStream(new FileInputStream(file));
-                        Manifest manifest = jar.getManifest();
-                        if (manifest == null)
-                                throw new IOException(file+" contains no manifest.");
+                        Manifest manifest;
+                        JarInputStream jar = null;
+                        if (file != null) {
+                                jar = new JarInputStream(new FileInputStream(file));
+                                manifest = jar.getManifest();
+                                if (manifest == null)
+                                        throw new IOException(file+" contains no manifest.");
+                        } else {
+                                manifest = new Manifest();
+                        manifest.read(manifestStream);
+                        }
                         Attributes attr = manifest.getMainAttributes();
                         className = attr.getValue("Plugin-Class");
@@ -63 +66 @@
                         stage = stageStr == null ? 50 : Integer.parseInt(stageStr);
                         author = attr.getValue("Author");
-                        libraries.add(new URL(getURLString(file.getAbsolutePath())));
+                        if (file != null)
+                                libraries.add(new URL(getURLString(file.getAbsolutePath())));
                         String classPath = attr.getValue("Class-Path");
                         if (classPath != null) {
@@ -85 +89 @@
                         for (Object o : attr.keySet())
                                 this.attr.put(o.toString(), attr.getValue(o.toString()));
-                        jar.close();
+                        if (jar != null)
+                                jar.close();
                 } catch (IOException e) {
                         throw new PluginException(null, name, e);
@@ -107 +112 @@
         public Class<?> loadClass() {
                 try {
-                        if (useJosmClassloader)
-                                return Class.forName(className);
-
                         URL[] urls = new URL[libraries.size()];
                         urls = libraries.toArray(urls);
@@ -125 +127 @@
                 return "file://"+fileName;
         }
+        
+        /**
+         * Try to find a plugin after some criterias. Extract the plugin-information
+         * from the plugin and return it. The plugin is searched in the following way:
+         * 
+         *<li>first look after an MANIFEST.MF in the package org.openstreetmap.josm.plugins.<plugin name>
+         *    (After removing all fancy characters from the plugin name).
+         *    If found, the plugin is loaded using the bootstrap classloader.
+         *<li>If not found, look for a jar file in the user specific plugin directory
+         *    (~/.josm/plugins/<plugin name>.jar)
+         *<li>If not found and the environment variable JOSM_RESSOURCES + "/plugins/" exist, look there.
+         *<li>Try for the java property josm.ressources + "/plugins/" (set via java -Djosm.plugins.path=...)
+         *<li>If the environment variable ALLUSERSPROFILE and APPDATA exist, look in 
+         *    ALLUSERSPROFILE/<the last stuff from APPDATA>/JOSM/plugins. 
+         *    (*sic* There is no easy way under Windows to get the All User's application 
+         *    directory)
+         *<li>Finally, look in some typical unix paths:<ul> 
+         *    <li>/usr/local/share/josm/plugins/
+         *    <li>/usr/local/lib/josm/plugins/
+         *    <li>/usr/share/josm/plugins/
+         *    <li>/usr/lib/josm/plugins/
+         * 
+         * If a plugin class or jar file is found earlier in the list but seem not to
+         * be working, an PluginException is thrown rather than continuing the search.
+         * This is so JOSM can detect broken user-provided plugins and do not go silently
+         * ignore them. 
+         * 
+         * The plugin is not initialized. If the plugin is a .jar file, it is not loaded
+         * (only the manifest is extracted). In the classloader-case, the class is 
+         * bootstraped (e.g. static {} - declarations will run. However, nothing else is done.
+         *
+         * @param pluginName The name of the plugin (in all lowercase). E.g. "lang-de"
+         * @return Information about the plugin or <code>null</code>, if the plugin
+         *             was nowhere to be found.
+         * @throws PluginException In case of broken plugins.
+         */
+        public static PluginInformation findPlugin(String pluginName) throws PluginException {
+        String name = pluginName;
+        name = name.replaceAll("[-. ]", "");
+        InputStream manifestStream = PluginInformation.class.getResourceAsStream("/org/openstreetmap/josm/plugins/"+name+"/MANIFEST.MF");
+        if (manifestStream != null)
+                return new PluginInformation(null, pluginName, manifestStream);
+
+        Collection<String> locations = getPluginLocations();
+
+        for (String s : locations) {
+                File pluginFile = new File(s+"/"+pluginName+".jar");
+                if (pluginFile.exists()) {
+                                PluginInformation info = new PluginInformation(pluginFile);
+                                return info;
+                }
+        }
+        return null;
+        }
+
+        public static Collection<String> getPluginLocations() {
+            Collection<String> locations = Main.pref.getAllPossiblePreferenceDirs();
+            Collection<String> all = new ArrayList<String>(locations.size());
+            for (String s : locations)
+                all.add(s+"plugins");
+            return all;
+    }
 }