DI the notifications plugin.

Change-Id: I7a6ea92a1bb845ac330c610e829184bffc26606f
Reviewed-on: http://gerrit.dmdirc.com/3201
Reviewed-by: Chris Smith <chris@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

src/com/dmdirc/addons/notifications/NotificationCommand.java

@@ -49,19 +49,20 @@ public class NotificationCommand extends Command implements
             "notification [--methods|--method <method>] text - "
             + "Notifies you of the text",
             CommandType.TYPE_GLOBAL);
-    /** The plugin that's using this command. */
-    private final NotificationsPlugin parent;
+    /** The notifications manager to get notification plugins from. */
+    private final NotificationsManager manager;
 
     /**
      * Creates a new instance of this notification command.
      *
      * @param controller The controller to use for command information.
-     * @param parent     The plugin that's instantiating this command
+     * @param manager     The notifications manager to get notification plugins from
      */
-    public NotificationCommand(final CommandController controller, final NotificationsPlugin parent) {
+    public NotificationCommand(final CommandController controller,
+            final NotificationsManager manager) {
         super(controller);
 
-        this.parent = parent;
+        this.manager = manager;
     }
 
     /** {@inheritDoc} */
@@ -75,7 +76,7 @@ public class NotificationCommand extends Command implements
                 .equalsIgnoreCase("--method")) {
             if (args.getArguments().length > 1) {
                 final String sourceName = args.getArguments()[1];
-                final ExportedService source = parent.getMethod(sourceName)
+                final ExportedService source = manager.getMethod(sourceName)
                         .getExportedService("showNotification");
 
                 if (source == null) {
@@ -88,8 +89,8 @@ public class NotificationCommand extends Command implements
                 sendLine(origin, args.isSilent(), FORMAT_ERROR,
                         "You must specify a method when using --method.");
             }
-        } else if (parent.hasActiveMethod()) {
-            parent.getPreferredMethod().getExportedService("showNotification")
+        } else if (manager.hasActiveMethod()) {
+            manager.getPreferredMethod().getExportedService("showNotification")
                     .execute("DMDirc", args.getArgumentsAsString(0));
         } else {
             sendLine(origin, args.isSilent(), FORMAT_ERROR,
@@ -105,7 +106,7 @@ public class NotificationCommand extends Command implements
      */
     private void doMethodList(final FrameContainer origin,
             final boolean isSilent) {
-        final List<PluginInfo> methods = parent.getMethods();
+        final List<PluginInfo> methods = manager.getMethods();
 
         if (methods.isEmpty()) {
             sendLine(origin, isSilent, FORMAT_ERROR, "No notification "
@@ -135,7 +136,7 @@ public class NotificationCommand extends Command implements
             return res;
         } else if (arg == 1 && context.getPreviousArgs().get(0)
                 .equalsIgnoreCase("--method")) {
-            for (PluginInfo source : parent.getMethods()) {
+            for (PluginInfo source : manager.getMethods()) {
                 res.add(source.getMetaData().getName());
             }
             return res;

src/com/dmdirc/addons/notifications/NotificationConfig.java

@@ -25,6 +25,7 @@ package com.dmdirc.addons.notifications;
 import com.dmdirc.addons.ui_swing.components.reorderablelist.ListReorderButtonPanel;
 import com.dmdirc.addons.ui_swing.components.reorderablelist.ReorderableJList;
 import com.dmdirc.config.prefs.PreferencesInterface;
+import com.dmdirc.interfaces.config.ConfigProvider;
 
 import java.util.Enumeration;
 import java.util.LinkedList;
@@ -49,16 +50,21 @@ public class NotificationConfig extends JPanel implements PreferencesInterface {
     private ReorderableJList<String> list;
     /** Notification methods. */
     private final List<String> methods;
-    /** The plugin that owns this panel. */
-    private final NotificationsPlugin plugin;
+    /** User settings config to save to. */
+    private final ConfigProvider userSettings;
+    /** This plugin's settings domain. */
+    private final String domain;
 
     /**
      * Creates a new instance of NotificationConfig panel.
      *
-     * @param plugin  The plugin that owns this panel
+     * @param userSettings Config to save settings to
+     * @param domain This plugin's settings domain
      * @param methods A list of methods to be used in the panel
      */
-    public NotificationConfig(final NotificationsPlugin plugin,
+    public NotificationConfig(
+            final ConfigProvider userSettings,
+            final String domain,
             final List<String> methods) {
         super();
 
@@ -67,7 +73,8 @@ public class NotificationConfig extends JPanel implements PreferencesInterface {
         } else {
             this.methods = new LinkedList<>(methods);
         }
-        this.plugin = plugin;
+        this.userSettings = userSettings;
+        this.domain = domain;
 
         initComponents();
     }
@@ -122,10 +129,9 @@ public class NotificationConfig extends JPanel implements PreferencesInterface {
         return newMethods;
     }
 
-    /** {@inheritDoc} */
     @Override
     public void save() {
-        plugin.saveSettings(getMethods());
+        userSettings.setOption(domain, "methodOrder", getMethods());
     }
 
 }

src/com/dmdirc/addons/notifications/NotificationsManager.java

@@ -0,0 +1,188 @@
+/*
+ * 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.addons.notifications;
+
+import com.dmdirc.ClientModule.GlobalConfig;
+import com.dmdirc.ClientModule.UserConfig;
+import com.dmdirc.actions.ActionManager;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.interfaces.actions.ActionType;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.interfaces.config.ConfigProvider;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.plugins.PluginManager;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.inject.Inject;
+
+public class NotificationsManager implements ActionListener {
+
+    /** The notification methods that we know of. */
+    private final List<String> methods = new ArrayList<>();
+    /** The user's preferred order for method usage. */
+    private List<String> order;
+    /** This plugin's settings domain. */
+    private final String domain;
+    /** Global config to read settings from. */
+    private final AggregateConfigProvider globalConfig;
+    /** Plugin manager. */
+    private final PluginManager pluginManager;
+
+    @Inject
+    public NotificationsManager(
+            @PluginDomain(NotificationsPlugin.class) final String domain,
+            @GlobalConfig final AggregateConfigProvider globalConfig,
+            @UserConfig final ConfigProvider userSettings,
+            final PluginManager pluginManager) {
+        this.domain = domain;
+        this.globalConfig = globalConfig;
+        this.pluginManager = pluginManager;
+    }
+
+    public void onLoad() {
+        methods.clear();
+        loadSettings();
+        ActionManager.getActionManager().registerListener(this,
+                CoreActionType.PLUGIN_LOADED, CoreActionType.PLUGIN_UNLOADED);
+        for (PluginInfo target : pluginManager.getPluginInfos()) {
+            if (target.isLoaded()) {
+                addPlugin(target);
+            }
+        }
+    }
+
+    public void onUnload() {
+        methods.clear();
+        ActionManager.getActionManager().unregisterListener(this);
+    }
+
+    /** Loads the plugins settings. */
+    private void loadSettings() {
+        if (globalConfig.hasOptionString(domain, "methodOrder")) {
+            order = globalConfig.getOptionList(domain, "methodOrder");
+        } else {
+            order = new ArrayList<>();
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void processEvent(final ActionType type, final StringBuffer format,
+            final Object... arguments) {
+        if (type == CoreActionType.PLUGIN_LOADED) {
+            addPlugin((PluginInfo) arguments[0]);
+        } else if (type == CoreActionType.PLUGIN_UNLOADED) {
+            removePlugin((PluginInfo) arguments[0]);
+        }
+    }
+
+    /**
+     * Checks to see if a plugin implements the notification method interface and if it does, adds
+     * the method to our list.
+     *
+     * @param target The plugin to be tested
+     */
+    private void addPlugin(final PluginInfo target) {
+        if (target.hasExportedService("showNotification")) {
+            methods.add(target.getMetaData().getName());
+            addMethodToOrder(target);
+        }
+    }
+
+    /**
+     * Checks to see if the specified notification method needs to be added to our order list, and
+     * adds it if neccessary.
+     *
+     * @param source The notification method to be tested
+     */
+    private void addMethodToOrder(final PluginInfo source) {
+        if (!order.contains(source.getMetaData().getName())) {
+            order.add(source.getMetaData().getName());
+        }
+    }
+
+    /**
+     * Checks to see if a plugin implements the notification method interface and if it does,
+     * removes the method from our list.
+     *
+     * @param target The plugin to be tested
+     */
+    private void removePlugin(final PluginInfo target) {
+        methods.remove(target.getMetaData().getName());
+    }
+
+    /**
+     * Retrieves a method based on its name.
+     *
+     * @param name The name to search for
+     *
+     * @return The method with the specified name or null if none were found.
+     */
+    public PluginInfo getMethod(final String name) {
+        return pluginManager.getPluginInfoByName(name);
+    }
+
+    /**
+     * Retrieves all the methods registered with this plugin.
+     *
+     * @return All known notification sources
+     */
+    public List<PluginInfo> getMethods() {
+        final List<PluginInfo> plugins = new ArrayList<>();
+        for (String method : methods) {
+            plugins.add(pluginManager.getPluginInfoByName(method));
+        }
+        return plugins;
+    }
+
+    /**
+     * Does this plugin have any active notification methods?
+     *
+     * @return true iif active notification methods are registered
+     */
+    public boolean hasActiveMethod() {
+        return !methods.isEmpty();
+    }
+
+    /**
+     * Returns the user's preferred method if loaded, or null if none loaded.
+     *
+     * @return Preferred notification method
+     */
+    public PluginInfo getPreferredMethod() {
+        if (methods.isEmpty()) {
+            return null;
+        }
+        for (String method : order) {
+            if (methods.contains(method)) {
+                return pluginManager.getPluginInfoByName(method);
+            }
+        }
+        return null;
+    }
+
+}

src/com/dmdirc/addons/notifications/NotificationsModule.java

@@ -0,0 +1,48 @@
+/*
+ * 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.addons.notifications;
+
+import com.dmdirc.ClientModule;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+
+import dagger.Module;
+import dagger.Provides;
+
+@Module(injects = {NotificationCommand.class, NotificationsManager.class},
+        addsTo = ClientModule.class)
+public class NotificationsModule {
+
+    private final PluginInfo pluginInfo;
+
+    public NotificationsModule(final PluginInfo pluginInfo) {
+        this.pluginInfo = pluginInfo;
+    }
+
+    @Provides
+    @PluginDomain(NotificationsPlugin.class)
+    public String getSettingsDomain() {
+        return pluginInfo.getDomain();
+    }
+
+}

src/com/dmdirc/addons/notifications/NotificationsPlugin.java

@@ -22,91 +22,69 @@
 
 package com.dmdirc.addons.notifications;
 
-import com.dmdirc.actions.ActionManager;
-import com.dmdirc.actions.CoreActionType;
 import com.dmdirc.addons.ui_swing.UIUtilities;
 import com.dmdirc.config.prefs.PluginPreferencesCategory;
 import com.dmdirc.config.prefs.PreferencesCategory;
 import com.dmdirc.config.prefs.PreferencesDialogModel;
-import com.dmdirc.interfaces.ActionListener;
-import com.dmdirc.interfaces.CommandController;
-import com.dmdirc.interfaces.actions.ActionType;
-import com.dmdirc.interfaces.config.IdentityController;
 import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BaseCommandPlugin;
 
-import java.util.ArrayList;
-import java.util.List;
 import java.util.concurrent.Callable;
 
+import dagger.ObjectGraph;
+
 /**
  * Notification Manager plugin, aggregates notification sources exposing them via a single command.
  */
-public class NotificationsPlugin extends BaseCommandPlugin implements ActionListener {
+public class NotificationsPlugin extends BaseCommandPlugin {
 
-    /** The notification methods that we know of. */
-    private final List<String> methods = new ArrayList<>();
-    /** The user's preferred order for method usage. */
-    private List<String> order;
     /** This plugin's plugin info. */
     private final PluginInfo pluginInfo;
-    /** The controller to read and write settings with. */
-    private final IdentityController identityController;
+    /** Notifications manager. */
+    private NotificationsManager manager;
 
     /**
      * Creates a new instance of this plugin.
      *
-     * @param pluginInfo         This plugin's plugin info
-     * @param commandController  Command controller to register commands
-     * @param identityController The controller to read and write settings with.
+     * @param pluginInfo This plugin's plugin info
      */
-    public NotificationsPlugin(
-            final PluginInfo pluginInfo,
-            final CommandController commandController,
-            final IdentityController identityController) {
-        super(commandController);
+    public NotificationsPlugin(final PluginInfo pluginInfo) {
         this.pluginInfo = pluginInfo;
-        this.identityController = identityController;
-        registerCommand(new NotificationCommand(commandController, this),
-                NotificationCommand.INFO);
+
+    }
+
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+        setObjectGraph(graph.plus(new NotificationsModule(pluginInfo)));
+        registerCommand(NotificationCommand.class, NotificationCommand.INFO);
+        manager = getObjectGraph().get(NotificationsManager.class);
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onLoad() {
-        methods.clear();
-        loadSettings();
-        ActionManager.getActionManager().registerListener(this,
-                CoreActionType.PLUGIN_LOADED, CoreActionType.PLUGIN_UNLOADED);
-        for (PluginInfo target : pluginInfo.getMetaData().getManager()
-                .getPluginInfos()) {
-            if (target.isLoaded()) {
-                addPlugin(target);
-            }
-        }
+        manager.onLoad();
         super.onLoad();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onUnload() {
-        methods.clear();
-        ActionManager.getActionManager().unregisterListener(this);
+        manager.onUnload();
         super.onUnload();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void showConfig(final PreferencesDialogModel manager) {
         final NotificationConfig configPanel = UIUtilities.invokeAndWait(
                 new Callable<NotificationConfig>() {
-            /** {@inheritDoc} */
-            @Override
-            public NotificationConfig call() {
-                return new NotificationConfig(NotificationsPlugin.this,
-                        order);
-            }
-        });
+                    /** {@inheritDoc} */
+                    @Override
+                    public NotificationConfig call() {
+                        return new NotificationConfig(manager.getIdentity(), pluginInfo.getDomain(),
+                                manager.getConfigManager().getOptionList(pluginInfo.getDomain(),
+                                        "methodOrder"));
+                    }
+                });
 
         final PreferencesCategory category = new PluginPreferencesCategory(
                 pluginInfo, "Notifications", "", "category-notifications",
@@ -114,124 +92,4 @@ public class NotificationsPlugin extends BaseCommandPlugin implements ActionList
         manager.getCategory("Plugins").addSubCategory(category);
     }
 
-    /** Loads the plugins settings. */
-    private void loadSettings() {
-        if (identityController.getGlobalConfiguration()
-                .hasOptionString(pluginInfo.getDomain(), "methodOrder")) {
-            order = identityController.getGlobalConfiguration().
-                    getOptionList(pluginInfo.getDomain(), "methodOrder");
-        } else {
-            order = new ArrayList<>();
-        }
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void processEvent(final ActionType type, final StringBuffer format,
-            final Object... arguments) {
-        if (type == CoreActionType.PLUGIN_LOADED) {
-            addPlugin((PluginInfo) arguments[0]);
-        } else if (type == CoreActionType.PLUGIN_UNLOADED) {
-            removePlugin((PluginInfo) arguments[0]);
-        }
-    }
-
-    /**
-     * Checks to see if a plugin implements the notification method interface and if it does, adds
-     * the method to our list.
-     *
-     * @param target The plugin to be tested
-     */
-    private void addPlugin(final PluginInfo target) {
-        if (target.hasExportedService("showNotification")) {
-            methods.add(target.getMetaData().getName());
-            addMethodToOrder(target);
-        }
-    }
-
-    /**
-     * Checks to see if the specified notification method needs to be added to our order list, and
-     * adds it if neccessary.
-     *
-     * @param source The notification method to be tested
-     */
-    private void addMethodToOrder(final PluginInfo source) {
-        if (!order.contains(source.getMetaData().getName())) {
-            order.add(source.getMetaData().getName());
-        }
-    }
-
-    /**
-     * Checks to see if a plugin implements the notification method interface and if it does,
-     * removes the method from our list.
-     *
-     * @param target The plugin to be tested
-     */
-    private void removePlugin(final PluginInfo target) {
-        methods.remove(target.getMetaData().getName());
-    }
-
-    /**
-     * Retrieves a method based on its name.
-     *
-     * @param name The name to search for
-     *
-     * @return The method with the specified name or null if none were found.
-     */
-    public PluginInfo getMethod(final String name) {
-        return pluginInfo.getMetaData().getManager().getPluginInfoByName(name);
-    }
-
-    /**
-     * Retrieves all the methods registered with this plugin.
-     *
-     * @return All known notification sources
-     */
-    public List<PluginInfo> getMethods() {
-        final List<PluginInfo> plugins = new ArrayList<>();
-        for (String method : methods) {
-            plugins.add(pluginInfo.getMetaData().getManager()
-                    .getPluginInfoByName(method));
-        }
-        return plugins;
-    }
-
-    /**
-     * Does this plugin have any active notification methods?
-     *
-     * @return true iif active notification methods are registered
-     */
-    public boolean hasActiveMethod() {
-        return !methods.isEmpty();
-    }
-
-    /**
-     * Returns the user's preferred method if loaded, or null if none loaded.
-     *
-     * @return Preferred notification method
-     */
-    public PluginInfo getPreferredMethod() {
-        if (methods.isEmpty()) {
-            return null;
-        }
-        for (String method : order) {
-            if (methods.contains(method)) {
-                return pluginInfo.getMetaData().getManager().getPluginInfoByName(
-                        method);
-            }
-        }
-        return null;
-    }
-
-    /**
-     * Saves the plugins settings.
-     *
-     * @param newOrder The new order for methods
-     */
-    protected void saveSettings(final List<String> newOrder) {
-        order = newOrder;
-        identityController.getUserSettings()
-                .setOption(pluginInfo.getDomain(), "methodOrder", order);
-    }
-
 }