DI systray plugin.

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

src/com/dmdirc/addons/systray/PopupCommand.java

@@ -30,6 +30,8 @@ import com.dmdirc.commandparser.commands.Command;
 import com.dmdirc.commandparser.commands.context.CommandContext;
 import com.dmdirc.interfaces.CommandController;
 
+import javax.inject.Inject;
+
 /**
  * The /popup command allows the user to show a popup message from the system tray icon.
  */
@@ -39,19 +41,20 @@ public class PopupCommand extends Command {
     public static final BaseCommandInfo INFO = new BaseCommandInfo("popup",
             "popup <message> - shows the message as a system tray popup",
             CommandType.TYPE_GLOBAL);
-    /** The SystrayPlugin that we belong to. */
-    private final SystrayPlugin parent;
+    /** Systray manager, used to show notifications. */
+    private final SystrayManager manager;
 
     /**
      * Creates a new instance of PopupCommand.
      *
-     * @param newParent         The plugin that this command belongs to
+     * @param manager           Systray manager, used to show notifications
      * @param commandController The controller to use for command information.
      */
-    public PopupCommand(final SystrayPlugin newParent, final CommandController commandController) {
+    @Inject
+    public PopupCommand(final SystrayManager manager, final CommandController commandController) {
         super(commandController);
 
-        this.parent = newParent;
+        this.manager = manager;
     }
 
     /**
@@ -63,11 +66,10 @@ public class PopupCommand extends Command {
      * @return True if the notification was shown.
      */
     public boolean showPopup(final String title, final String message) {
-        parent.notify(title, message);
+        manager.notify(title, message);
         return true;
     }
 
-    /** {@inheritDoc} */
     @Override
     public void execute(final FrameContainer origin,
             final CommandArguments args, final CommandContext context) {

src/com/dmdirc/addons/systray/SystrayManager.java

@@ -0,0 +1,181 @@
+/*
+ * 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.systray;
+
+import com.dmdirc.ClientModule.GlobalConfig;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.addons.ui_swing.MainFrame;
+import com.dmdirc.interfaces.ActionController;
+import com.dmdirc.interfaces.actions.ActionType;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.ui.IconManager;
+import com.dmdirc.ui.messages.Styliser;
+
+import java.awt.AWTException;
+import java.awt.Frame;
+import java.awt.MenuItem;
+import java.awt.PopupMenu;
+import java.awt.SystemTray;
+import java.awt.TrayIcon;
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.awt.event.MouseEvent;
+import java.awt.event.MouseListener;
+
+import javax.inject.Inject;
+
+public class SystrayManager implements ActionListener, MouseListener,
+        com.dmdirc.interfaces.ActionListener {
+
+    /** Main frame instance. */
+    private final MainFrame mainFrame;
+    /** This plugin's settings domain. */
+    private final String domain;
+    /** The config to read settings from. */
+    private final AggregateConfigProvider globalConfig;
+    /** Icon manager to get images from. */
+    private final IconManager iconManager;
+    /** Action Controller. */
+    private final ActionController actionController;
+    /** The tray icon we're currently using. */
+    private TrayIcon icon;
+
+    @Inject
+    public SystrayManager(@GlobalConfig final AggregateConfigProvider globalConfig,
+            @PluginDomain(SystrayPlugin.class) final String domain,
+            final MainFrame mainFrame, final ActionController actionController,
+            @GlobalConfig final IconManager iconManager) {
+        this.globalConfig = globalConfig;
+        this.domain = domain;
+        this.mainFrame = mainFrame;
+        this.iconManager = iconManager;
+        this.actionController = actionController;
+    }
+
+    public void load() {
+        final MenuItem show = new MenuItem("Show/hide");
+        final MenuItem quit = new MenuItem("Quit");
+
+        final PopupMenu menu = new PopupMenu();
+        menu.add(show);
+        menu.add(quit);
+
+        show.addActionListener(this);
+        quit.addActionListener(this);
+
+        icon = new TrayIcon(iconManager.getImage("logo"), "DMDirc", menu);
+        icon.setImageAutoSize(true);
+        icon.addMouseListener(this);
+
+        try {
+            SystemTray.getSystemTray().add(icon);
+            actionController.registerListener(this, CoreActionType.CLIENT_MINIMISED);
+        } catch (AWTException ex) {
+            throw new IllegalStateException("Unable to load plugin", ex);
+        }
+    }
+
+    public void unload() {
+        SystemTray.getSystemTray().remove(icon);
+        actionController.unregisterListener(this);
+        icon = null;
+    }
+
+    /**
+     * Sends a notification via the system tray icon.
+     *
+     * @param title   The title of the notification
+     * @param message The contents of the notification
+     * @param type    The type of notification
+     */
+    public void notify(final String title, final String message,
+            final TrayIcon.MessageType type) {
+        icon.displayMessage(title, Styliser.stipControlCodes(message), type);
+    }
+
+    /**
+     * Sends a notification via the system tray icon.
+     *
+     * @param title   The title of the notification
+     * @param message The contents of the notification
+     */
+    public void notify(final String title, final String message) {
+        notify(title, message, TrayIcon.MessageType.NONE);
+    }
+
+    @Override
+    public void actionPerformed(final ActionEvent e) {
+        switch (e.getActionCommand()) {
+            case "Show/hide":
+                mainFrame.setVisible(!mainFrame.isVisible());
+                break;
+            case "Quit":
+                mainFrame.quit();
+                break;
+        }
+    }
+
+    @Override
+    public void mouseClicked(final MouseEvent e) {
+        if (e.getButton() == MouseEvent.BUTTON1) {
+            if (mainFrame.isVisible()) {
+                mainFrame.setVisible(false);
+            } else {
+                mainFrame.setVisible(true);
+                mainFrame.setState(Frame.NORMAL);
+                mainFrame.toFront();
+            }
+        }
+    }
+
+    @Override
+    public void processEvent(final ActionType type, final StringBuffer format,
+            final Object... arguments) {
+        if (type == CoreActionType.CLIENT_MINIMISED
+                && globalConfig.getOptionBool(domain, "autominimise")) {
+            mainFrame.setVisible(false);
+        }
+    }
+
+    @Override
+    public void mousePressed(final MouseEvent e) {
+        //Ignore
+    }
+
+    @Override
+    public void mouseReleased(final MouseEvent e) {
+        //Ignore
+    }
+
+    @Override
+    public void mouseEntered(final MouseEvent e) {
+        //Ignore
+    }
+
+    @Override
+    public void mouseExited(final MouseEvent e) {
+        //Ignore
+    }
+
+}

src/com/dmdirc/addons/systray/SystrayModule.java

@@ -0,0 +1,45 @@
+/*
+ * 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.systray;
+
+import com.dmdirc.addons.ui_swing.injection.SwingModule;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+
+import dagger.Module;
+import dagger.Provides;
+
+@Module(injects = {SystrayManager.class, PopupCommand.class}, addsTo = SwingModule.class)
+public class SystrayModule {
+    private final PluginInfo pluginInfo;
+
+    public SystrayModule(final PluginInfo pluginInfo) {
+        this.pluginInfo = pluginInfo;
+    }
+
+    @Provides
+    @PluginDomain(SystrayPlugin.class)
+    public String getSettingsDomain() {
+        return pluginInfo.getDomain();
+    }
+}

src/com/dmdirc/addons/systray/SystrayPlugin.java

@@ -22,115 +22,46 @@
 
 package com.dmdirc.addons.systray;
 
-import com.dmdirc.actions.CoreActionType;
-import com.dmdirc.addons.ui_swing.MainFrame;
-import com.dmdirc.addons.ui_swing.SwingController;
 import com.dmdirc.config.prefs.PluginPreferencesCategory;
 import com.dmdirc.config.prefs.PreferencesCategory;
 import com.dmdirc.config.prefs.PreferencesDialogModel;
 import com.dmdirc.config.prefs.PreferencesSetting;
 import com.dmdirc.config.prefs.PreferencesType;
-import com.dmdirc.interfaces.ActionController;
-import com.dmdirc.interfaces.CommandController;
-import com.dmdirc.interfaces.actions.ActionType;
-import com.dmdirc.interfaces.config.IdentityController;
 import com.dmdirc.plugins.Exported;
 import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BaseCommandPlugin;
-import com.dmdirc.ui.IconManager;
-import com.dmdirc.ui.messages.Styliser;
-import com.dmdirc.util.URLBuilder;
 import com.dmdirc.util.validators.ValidationResponse;
 
-import java.awt.AWTException;
-import java.awt.Frame;
-import java.awt.MenuItem;
-import java.awt.PopupMenu;
 import java.awt.SystemTray;
-import java.awt.TrayIcon;
-import java.awt.event.ActionEvent;
-import java.awt.event.ActionListener;
-import java.awt.event.MouseEvent;
-import java.awt.event.MouseListener;
+
+import dagger.ObjectGraph;
 
 /**
  * The Systray plugin shows DMDirc in the user's system tray, and allows notifications to be
  * disabled.
  */
-public class SystrayPlugin extends BaseCommandPlugin implements
-        ActionListener, MouseListener, com.dmdirc.interfaces.ActionListener {
+public class SystrayPlugin extends BaseCommandPlugin {
 
-    /** The tray icon we're currently using. */
-    private final TrayIcon icon;
-    /** Main frame instance. */
-    private final MainFrame mainFrame;
     /** This plugin's plugin info. */
     private final PluginInfo pluginInfo;
-    /** The action controller to use. */
-    private final ActionController actionController;
-    /** The controller to read/write settings with. */
-    private final IdentityController identityController;
+    /** Systray manager. */
+    private SystrayManager manager;
 
     /**
      * Creates a new system tray plugin.
      *
-     * @param swingController    The controller that owns this plugin.
      * @param pluginInfo         This plugin's plugin info.
-     * @param actionController   The action controller to use.
-     * @param identityController The identity manager to read settings from.
-     * @param commandController  The controller to use for command information.
-     * @param urlBuilder         URL builder to use to resolve icon paths.
      */
-    public SystrayPlugin(
-            final SwingController swingController,
-            final PluginInfo pluginInfo,
-            final ActionController actionController,
-            final IdentityController identityController,
-            final CommandController commandController,
-            final URLBuilder urlBuilder) {
+    public SystrayPlugin(final PluginInfo pluginInfo) {
         this.pluginInfo = pluginInfo;
-        this.actionController = actionController;
-        this.identityController = identityController;
-        this.mainFrame = swingController.getMainFrame();
-
-        final MenuItem show = new MenuItem("Show/hide");
-        final MenuItem quit = new MenuItem("Quit");
-
-        final PopupMenu menu = new PopupMenu();
-        menu.add(show);
-        menu.add(quit);
-
-        show.addActionListener(this);
-        quit.addActionListener(this);
-
-        icon = new TrayIcon(
-                new IconManager(identityController.getGlobalConfiguration(), urlBuilder)
-                .getImage("logo"), "DMDirc", menu);
-        icon.setImageAutoSize(true);
-        icon.addMouseListener(this);
-        registerCommand(new PopupCommand(this, commandController), PopupCommand.INFO);
     }
 
-    /**
-     * Sends a notification via the system tray icon.
-     *
-     * @param title   The title of the notification
-     * @param message The contents of the notification
-     * @param type    The type of notification
-     */
-    public void notify(final String title, final String message,
-            final TrayIcon.MessageType type) {
-        icon.displayMessage(title, Styliser.stipControlCodes(message), type);
-    }
-
-    /**
-     * Sends a notification via the system tray icon.
-     *
-     * @param title   The title of the notification
-     * @param message The contents of the notification
-     */
-    public void notify(final String title, final String message) {
-        notify(title, message, TrayIcon.MessageType.NONE);
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+        setObjectGraph(graph.plus(new SystrayModule(pluginInfo)));
+        registerCommand(PopupCommand.class, PopupCommand.INFO);
+        manager = getObjectGraph().get(SystrayManager.class);
     }
 
     /**
@@ -142,27 +73,9 @@ public class SystrayPlugin extends BaseCommandPlugin implements
      */
     @Exported
     public void showPopup(final String title, final String message) {
-        notify(title, message);
+        manager.notify(title, message);
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Action event
-     */
-    @Override
-    public void actionPerformed(final ActionEvent e) {
-        switch (e.getActionCommand()) {
-            case "Show/hide":
-                mainFrame.setVisible(!mainFrame.isVisible());
-                break;
-            case "Quit":
-                mainFrame.quit();
-                break;
-        }
-    }
-
-    /** {@inheritDoc} */
     @Override
     public ValidationResponse checkPrerequisites() {
         if (SystemTray.isSupported()) {
@@ -173,31 +86,18 @@ public class SystrayPlugin extends BaseCommandPlugin implements
         }
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onLoad() {
-        boolean continueLoading = true;
-        try {
-            SystemTray.getSystemTray().add(icon);
-            actionController.registerListener(this, CoreActionType.CLIENT_MINIMISED);
-        } catch (AWTException ex) {
-            continueLoading = false;
-        }
-        if (!continueLoading || mainFrame == null) {
-            pluginInfo.unloadPlugin();
-        }
+        manager.load();
         super.onLoad();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void onUnload() {
-        SystemTray.getSystemTray().remove(icon);
-        actionController.unregisterListener(this);
+        manager.unload();
         super.onUnload();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void showConfig(final PreferencesDialogModel manager) {
         final PreferencesCategory category = new PluginPreferencesCategory(
@@ -205,7 +105,7 @@ public class SystrayPlugin extends BaseCommandPlugin implements
                 "General configuration settings");
 
         category.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
-                getDomain(), "autominimise", "Auto-hide DMDirc when minimised",
+                pluginInfo.getDomain(), "autominimise", "Auto-hide DMDirc when minimised",
                 "If this option is enabled, the systray plugin will hide DMDirc"
                 + " to the system tray whenever DMDirc is minimised",
                 manager.getConfigManager(), manager.getIdentity()));
@@ -213,73 +113,4 @@ public class SystrayPlugin extends BaseCommandPlugin implements
         manager.getCategory("Plugins").addSubCategory(category);
     }
 
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Mouse event
-     */
-    @Override
-    public void mouseClicked(final MouseEvent e) {
-        if (e.getButton() == MouseEvent.BUTTON1) {
-            if (mainFrame.isVisible()) {
-                mainFrame.setVisible(false);
-            } else {
-                mainFrame.setVisible(true);
-                mainFrame.setState(Frame.NORMAL);
-                mainFrame.toFront();
-            }
-        }
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Mouse event
-     */
-    @Override
-    public void mousePressed(final MouseEvent e) {
-        //Ignore
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Mouse event
-     */
-    @Override
-    public void mouseReleased(final MouseEvent e) {
-        //Ignore
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Mouse event
-     */
-    @Override
-    public void mouseEntered(final MouseEvent e) {
-        //Ignore
-    }
-
-    /**
-     * {@inheritDoc}
-     *
-     * @param e Mouse event
-     */
-    @Override
-    public void mouseExited(final MouseEvent e) {
-        //Ignore
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void processEvent(final ActionType type, final StringBuffer format,
-            final Object... arguments) {
-        if (type == CoreActionType.CLIENT_MINIMISED
-                && identityController.getGlobalConfiguration()
-                .getOptionBool(getDomain(), "autominimise")) {
-            mainFrame.setVisible(false);
-        }
-    }
-
 }