Tidy up core plugin functionality.

Move stuff from ClientModule into a CorePluginHelper, and
move CorePluginExtractor into the plugins package.

Change-Id: I0f0211edba8e8c19857d0a783f23b90aee89e84c
Reviewed-on: http://gerrit.dmdirc.com/3748
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/ClientModule.java

@@ -47,10 +47,11 @@ import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.ErrorManager;
 import com.dmdirc.logger.Logger;
 import com.dmdirc.messages.MessagesModule;
+import com.dmdirc.plugins.CorePluginExtractor;
+import com.dmdirc.plugins.CorePluginHelper;
 import com.dmdirc.plugins.LegacyServiceLocator;
 import com.dmdirc.plugins.PluginInjectorInitialiser;
 import com.dmdirc.plugins.PluginManager;
-import com.dmdirc.plugins.PluginMetaData;
 import com.dmdirc.plugins.ServiceLocator;
 import com.dmdirc.plugins.ServiceManager;
 import com.dmdirc.ui.IconManager;
@@ -58,7 +59,6 @@ import com.dmdirc.ui.WarningDialog;
 import com.dmdirc.ui.messages.ColourManager;
 import com.dmdirc.ui.themes.ThemeManager;
 import com.dmdirc.updater.UpdaterModule;
-import com.dmdirc.updater.Version;
 import com.dmdirc.updater.manager.UpdateManager;
 import com.dmdirc.util.URLBuilder;
 import com.dmdirc.util.io.Downloader;
@@ -219,14 +219,16 @@ public class ClientModule {
             final UpdateManager updateManager,
             final Provider<PluginInjectorInitialiser> initialiserProvider,
             final ObjectGraph objectGraph,
+            final CorePluginHelper pluginHelper,
             @Directory(DirectoryType.PLUGINS) final String directory) {
         final PluginManager manager = new PluginManager(eventBus, identityController,
                 updateManager, initialiserProvider, objectGraph, directory);
         final CorePluginExtractor extractor = new CorePluginExtractor(manager, directory, eventBus);
-        checkBundledPlugins(extractor, manager, identityController.getGlobalConfiguration());
+        pluginHelper.checkBundledPlugins(extractor, manager,
+                identityController.getGlobalConfiguration());
 
         for (String service : new String[]{"ui", "tabcompletion", "parser"}) {
-            ensureExists(extractor, manager, service);
+            pluginHelper.ensureExists(extractor, manager, service);
         }
 
         // The user may have an existing parser plugin (e.g. twitter) which
@@ -351,49 +353,4 @@ public class ClientModule {
         }
     }
 
-    /**
-     * Ensures that there is at least one provider of the specified service type by extracting
-     * matching core plugins. Plugins must be named so that their file name starts with the service
-     * type, and then an underscore.
-     *
-     * @param corePluginExtractor Extractor to use if the service doesn't exist
-     * @param pm                  The plugin manager to use to access services
-     * @param serviceType         The type of service that should exist
-     */
-    public void ensureExists(
-            final CorePluginExtractor corePluginExtractor,
-            final PluginManager pm,
-            final String serviceType) {
-        if (pm.getServicesByType(serviceType).isEmpty()) {
-            corePluginExtractor.extractCorePlugins(serviceType + "_");
-            pm.refreshPlugins();
-        }
-    }
-
-    /**
-     * Checks whether the plugins bundled with this release of DMDirc are newer than the plugins
-     * known by the specified {@link PluginManager}. If the bundled plugins are newer, they are
-     * automatically extracted.
-     *
-     * @param corePluginExtractor Extractor to use if plugins need updating.
-     * @param pm                  The plugin manager to use to check plugins
-     * @param config              The configuration source for bundled versions
-     */
-    private void checkBundledPlugins(
-            final CorePluginExtractor corePluginExtractor,
-            final PluginManager pm,
-            final AggregateConfigProvider config) {
-        for (PluginMetaData plugin : pm.getAllPlugins()) {
-            if (config.hasOptionString("bundledplugins_versions", plugin.getName())) {
-                final Version bundled = new Version(config.getOption("bundledplugins_versions",
-                        plugin.getName()));
-                final Version installed = plugin.getVersion();
-
-                if (installed.compareTo(bundled) < 0) {
-                    corePluginExtractor.extractCorePlugins(plugin.getName());
-                }
-            }
-        }
-    }
-
 }

src/com/dmdirc/Main.java

@@ -39,6 +39,7 @@ import com.dmdirc.interfaces.ui.UIController;
 import com.dmdirc.logger.DMDircExceptionHandler;
 import com.dmdirc.logger.ErrorLevel;
 import com.dmdirc.logger.Logger;
+import com.dmdirc.plugins.CorePluginExtractor;
 import com.dmdirc.plugins.PluginManager;
 import com.dmdirc.plugins.Service;
 import com.dmdirc.plugins.ServiceProvider;

src/com/dmdirc/CorePluginExtractor.java → src/com/dmdirc/plugins/CorePluginExtractor.java

@@ -20,14 +20,12 @@
  * SOFTWARE.
  */
 
-package com.dmdirc;
+package com.dmdirc.plugins;
 
 import com.dmdirc.commandline.CommandLineOptionsModule.Directory;
 import com.dmdirc.commandline.CommandLineOptionsModule.DirectoryType;
 import com.dmdirc.events.UserErrorEvent;
 import com.dmdirc.logger.ErrorLevel;
-import com.dmdirc.plugins.PluginInfo;
-import com.dmdirc.plugins.PluginManager;
 import com.dmdirc.util.resourcemanager.ResourceManager;
 
 import com.google.common.eventbus.EventBus;

src/com/dmdirc/plugins/CorePluginHelper.java

@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2006-2014 DMDirc Developers
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+
+package com.dmdirc.plugins;
+
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.updater.Version;
+
+import javax.inject.Inject;
+import javax.inject.Singleton;
+
+/**
+ * Provides helper methods for dealing with plugins.
+ */
+@Singleton
+public class CorePluginHelper {
+
+    @Inject
+    public CorePluginHelper() {
+    }
+
+    /**
+     * Ensures that there is at least one provider of the specified service type by extracting
+     * matching core plugins. Plugins must be named so that their file name starts with the service
+     * type, and then an underscore.
+     *
+     * @param corePluginExtractor Extractor to use if the service doesn't exist
+     * @param pm                  The plugin manager to use to access services
+     * @param serviceType         The type of service that should exist
+     */
+    public void ensureExists(
+            final CorePluginExtractor corePluginExtractor,
+            final PluginManager pm,
+            final String serviceType) {
+        if (pm.getServicesByType(serviceType).isEmpty()) {
+            corePluginExtractor.extractCorePlugins(serviceType + "_");
+            pm.refreshPlugins();
+        }
+    }
+
+    /**
+     * Checks whether the plugins bundled with this release of DMDirc are newer than the plugins
+     * known by the specified {@link PluginManager}. If the bundled plugins are newer, they are
+     * automatically extracted.
+     *
+     * @param corePluginExtractor Extractor to use if plugins need updating.
+     * @param pm                  The plugin manager to use to check plugins
+     * @param config              The configuration source for bundled versions
+     */
+    public void checkBundledPlugins(
+            final CorePluginExtractor corePluginExtractor,
+            final PluginManager pm,
+            final AggregateConfigProvider config) {
+        for (PluginMetaData plugin : pm.getAllPlugins()) {
+            if (config.hasOptionString("bundledplugins_versions", plugin.getName())) {
+                final Version bundled = new Version(config.getOption("bundledplugins_versions",
+                        plugin.getName()));
+                final Version installed = plugin.getVersion();
+
+                if (installed.compareTo(bundled) < 0) {
+                    corePluginExtractor.extractCorePlugins(plugin.getName());
+                }
+            }
+        }
+    }
+
+}

src/com/dmdirc/plugins/PluginInjectorInitialiser.java

@@ -23,7 +23,6 @@
 package com.dmdirc.plugins;
 
 import com.dmdirc.ClientModule.GlobalConfig;
-import com.dmdirc.CorePluginExtractor;
 import com.dmdirc.ServerManager;
 import com.dmdirc.actions.ActionFactory;
 import com.dmdirc.actions.ActionManager;