Changeset 12646 for trunk/gli/src/org/greenstone/gatherer/greenstone/Plugins.java

Timestamp:

2006-09-01T13:51:34+12:00 (18 years ago)

Author:

mdewsnip

Message:

Support for collection-specific plugins and classifiers with the new code.

File:

• trunk/gli/src/org/greenstone/gatherer/greenstone/Plugins.java (modified) (6 diffs)

trunk/gli/src/org/greenstone/gatherer/greenstone/Plugins.java

@@ -50 +50 @@
     // A list of all the plugins in the core Greenstone "perllib/plugins" folder (arguments may not be loaded)
     static private ArrayList core_greenstone_plugins_list = null;
+    // The name of the loaded collection
+    static private String collection_name = null;
+    // A list of all the plugins in the loaded collection's "perllib/plugins" folder (arguments may not be loaded)
+    static private ArrayList collection_specific_plugins_list = null;
 
 
     static public Plugin getPlugin(String plugin_name, boolean arguments_required)
     {
+    Plugin plugin = null;
+    boolean collection_specific = false;
+
+    // Check the collection-specific plugins first
+    for (int i = 0; i < collection_specific_plugins_list.size(); i++) {
+        Plugin collection_specific_plugin = (Plugin) collection_specific_plugins_list.get(i);
+        if (collection_specific_plugin.getName().equals(plugin_name)) {
+        plugin = collection_specific_plugin;
+        collection_specific = true;
+        break;
+        }
+    }
+
+    // Try the core Greenstone plugins if necessary
+    if (plugin == null) {
+        for (int i = 0; i < core_greenstone_plugins_list.size(); i++) {
+        Plugin core_greenstone_plugin = (Plugin) core_greenstone_plugins_list.get(i);
+        if (core_greenstone_plugin.getName().equals(plugin_name)) {
+            plugin = core_greenstone_plugin;
+            break;
+        }
+        }
+    }
+
+    // If we've found the plugin, load its arguments now, if required
+    if (plugin != null && arguments_required) {
+        if (plugin.getArguments().size() == 0) {
+        loadPluginInfo(plugin, collection_specific);
+        }
+        else {
+        DebugStream.println("Already loaded arguments for " + plugin_name + "!");
+        }
+    }
+
+    return plugin;
+    }
+
+
+    /** Returns a new list from merging the collection-specific and the core Greenstone plugins. */
+    static public ArrayList getPluginsList()
+    {
+    ArrayList plugins_list = new ArrayList();
+    plugins_list.addAll(collection_specific_plugins_list);
+
+    // Add in the core Greenstone plugins, taking care not to overwrite any collection-specific ones
     for (int i = 0; i < core_greenstone_plugins_list.size(); i++) {
-        Plugin plugin = (Plugin) core_greenstone_plugins_list.get(i);
-        if (plugin.getName().equals(plugin_name)) {
-        if (arguments_required) {
-            if (plugin.getArguments().size() == 0) {
-            loadPluginInfo(plugin);
-            }
-            else {
-            DebugStream.println("Already loaded arguments for " + plugin_name + "!");
-            }
-        }
-        return plugin;
-        }
-    }
-
-    return null;
-    }
-
-
-    static public ArrayList getPluginsList()
-    {
-    return core_greenstone_plugins_list;
-    }
-
-
-    static private void loadPluginInfo(Plugin plugin)
+        Plugin core_greenstone_plugin = (Plugin) core_greenstone_plugins_list.get(i);
+
+        boolean found = false;
+        for (int j = 0; j < collection_specific_plugins_list.size(); j++) {
+        Plugin collection_specific_plugin = (Plugin) collection_specific_plugins_list.get(j);
+        if (core_greenstone_plugin.getName().equals(collection_specific_plugin.getName())) {
+            found = true;
+            break;
+        }
+        }
+
+        if (!found) {
+        plugins_list.add(core_greenstone_plugin);
+        }
+    }
+
+    return plugins_list;
+    }
+
+
+    static private void loadPluginInfo(Plugin plugin, boolean collection_specific)
     {
     DebugStream.println("Loading arguments for " + plugin.getName() + "...");
@@ -97 +142 @@
         }
         args.add(LocalGreenstone.getBinScriptDirectoryPath() + "pluginfo.pl");
+        if (collection_specific) {
+            args.add("-collection");
+            args.add(collection_name);
+        }
         args.add("-xml");
         args.add("-language");
@@ -109 +158 @@
         }
 
-        if (xml.length() > 0) {
-        parsePluginInfoXML(plugin, xml.toString());
-        }
-        else {
+        // Check the XML output was obtained successfully
+        if (xml == null || xml.length() == 0) {
         JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CDM.PlugInManager.PlugIn_XML_Parse_Failed", plugin.getName()), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
-        }
+        return;
+        }
+
+        parsePluginInfoXML(plugin, xml.toString());
     }
     catch (Exception exception) {
@@ -122 +172 @@
 
 
-    static public void loadPluginsList()
+    static public void loadPluginsList(String collection_name_arg)
     {
     DebugStream.println("In loadPluginsList()...");
+
+    // If we're getting the collection-specific plugins, clear the old list no matter what
+    if (collection_name_arg != null) {
+        collection_name = collection_name_arg;
+        collection_specific_plugins_list = new ArrayList();
+    }
 
     // Run pluginfo.pl to get the list of plugins
@@ -140 +196 @@
         }
         args.add(LocalGreenstone.getBinScriptDirectoryPath() + "pluginfo.pl");
+        if (collection_name != null) {
+            args.add("-collection");
+            args.add(collection_name);
+        }
         args.add("-listall");
         args.add("-xml");
@@ -150 +210 @@
         }
 
-        if (xml.length() > 0) {
+        // Check the XML output was obtained successfully
+        if (xml == null || xml.length() == 0) {
+        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CDM.PluginManager.Plugin_List_XML_Parse_Failed"), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
+        return;
+        }
+
+        if (collection_name != null) {
+        collection_specific_plugins_list = parsePluginsListXML(xml.toString());
+        }
+        else {
         core_greenstone_plugins_list = parsePluginsListXML(xml.toString());
         }
-        else {
-        JOptionPane.showMessageDialog(Gatherer.g_man, Dictionary.get("CDM.PluginManager.Plugin_List_XML_Parse_Failed"), Dictionary.get("General.Error"), JOptionPane.ERROR_MESSAGE);
-        }
     }
     catch (Exception exception) {
-        DebugStream.println("Failed when trying to list plugins.");
         DebugStream.printStackTrace(exception);
     }