DI the freedesktop notifications plugin.

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

src/com/dmdirc/addons/freedesktop_notifications/FDManager.java

@@ -0,0 +1,185 @@
+/*
+ * 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.freedesktop_notifications;
+
+import com.dmdirc.ClientModule.GlobalConfig;
+import com.dmdirc.ClientModule.UserConfig;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
+import com.dmdirc.interfaces.config.ConfigChangeListener;
+import com.dmdirc.interfaces.config.ConfigProvider;
+import com.dmdirc.logger.ErrorLevel;
+import com.dmdirc.logger.Logger;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.implementations.PluginFilesHelper;
+import com.dmdirc.ui.messages.Styliser;
+import com.dmdirc.util.io.StreamReader;
+
+import java.io.IOException;
+import java.util.ArrayList;
+
+import javax.inject.Inject;
+
+import org.apache.commons.lang.StringEscapeUtils;
+
+public class FDManager implements ConfigChangeListener {
+
+    /** Global configuration. */
+    private final AggregateConfigProvider config;
+    /** User configuration. */
+    private final ConfigProvider userConfig;
+    /** This plugin's settings domain. */
+    private final String domain;
+    /** Plugin files helper. */
+    private final PluginFilesHelper filesHelper;
+    /** notification timeout. */
+    private int timeout;
+    /** notification icon. */
+    private String icon;
+    /** Escape HTML. */
+    private boolean escapehtml;
+    /** Strict escape. */
+    private boolean strictescape;
+    /** Strip codes. */
+    private boolean stripcodes;
+
+    @Inject
+    public FDManager(@GlobalConfig final AggregateConfigProvider config,
+            @UserConfig ConfigProvider userConfig,
+            @PluginDomain(FreeDesktopNotificationsPlugin.class) final String domain,
+            final PluginFilesHelper filesHelper) {
+        this.domain = domain;
+        this.config = config;
+        this.userConfig = userConfig;
+        this.filesHelper = filesHelper;
+    }
+
+    /**
+     * Used to show a notification using this plugin.
+     *
+     * @param title   Title of dialog if applicable
+     * @param message Message to show
+     *
+     * @return True if the notification was shown.
+     */
+    public boolean showNotification(final String title, final String message) {
+        if (filesHelper.getFilesDir() == null) {
+            return false;
+        }
+
+        final ArrayList<String> args = new ArrayList<>();
+
+        args.add("/usr/bin/env");
+        args.add("python");
+        args.add(filesHelper.getFilesDirString() + "notify.py");
+        args.add("-a");
+        args.add("DMDirc");
+        args.add("-i");
+        args.add(icon);
+        args.add("-t");
+        args.add(Integer.toString(timeout * 1000));
+        args.add("-s");
+
+        if (title != null && !title.isEmpty()) {
+            args.add(prepareString(title));
+        } else {
+            args.add("Notification from DMDirc");
+        }
+        args.add(prepareString(message));
+
+        try {
+            final Process myProcess = Runtime.getRuntime().exec(args.toArray(new String[]{}));
+            final StringBuffer data = new StringBuffer();
+            new StreamReader(myProcess.getErrorStream()).start();
+            new StreamReader(myProcess.getInputStream(), data).start();
+            try {
+                myProcess.waitFor();
+            } catch (InterruptedException e) {
+            }
+            return true;
+        } catch (SecurityException | IOException e) {
+        }
+
+        return false;
+    }
+
+    /**
+     * Prepare the string for sending to dbus.
+     *
+     * @param input Input string
+     *
+     * @return Input string after being processed according to config settings.
+     */
+    public String prepareString(final String input) {
+        String output = input;
+        if (stripcodes) {
+            output = Styliser.stipControlCodes(output);
+        }
+        if (escapehtml) {
+            if (strictescape) {
+                output = StringEscapeUtils.escapeHtml(output);
+            } else {
+                output = output.replace("&", "&amp;");
+                output = output.replace("<", "&lt;");
+                output = output.replace(">", "&gt;");
+            }
+        }
+
+        return output;
+    }
+
+    private void setCachedSettings() {
+        timeout = config.getOptionInt(domain, "general.timeout");
+        icon = config.getOption(domain, "general.icon");
+        escapehtml = config.getOptionBool(domain, "advanced.escapehtml");
+        strictescape = config.getOptionBool(domain, "advanced.strictescape");
+        stripcodes = config.getOptionBool(domain, "advanced.stripcodes");
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void configChanged(final String domain, final String key) {
+        setCachedSettings();
+    }
+
+    public void onLoad() {
+        config.addChangeListener(domain, this);
+        setCachedSettings();
+        // Extract the files needed
+        try {
+            filesHelper.extractResoucesEndingWith(".py");
+            filesHelper.extractResoucesEndingWith(".png");
+        } catch (IOException ex) {
+            Logger.userError(ErrorLevel.MEDIUM,
+                    "Unable to extract files for Free desktop notifications: " + ex.getMessage(), ex);
+        }
+    }
+
+    public void onUnLoad() {
+        config.removeListener(this);
+    }
+
+    void domainUpdated() {
+        userConfig.setOption(domain, "general.icon", filesHelper.getFilesDirString() + "icon.png");
+    }
+
+}

src/com/dmdirc/addons/freedesktop_notifications/FDModule.java

@@ -0,0 +1,56 @@
+/*
+ * 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.freedesktop_notifications;
+
+import com.dmdirc.ClientModule;
+import com.dmdirc.plugins.PluginDomain;
+import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.plugins.implementations.PluginFilesHelper;
+
+import javax.inject.Singleton;
+
+import dagger.Module;
+import dagger.Provides;
+
+@Module(injects = {FDNotifyCommand.class, FDManager.class}, addsTo = ClientModule.class)
+public class FDModule {
+
+    private final PluginInfo pluginInfo;
+
+    public FDModule(final PluginInfo pluginInfo) {
+        this.pluginInfo = pluginInfo;
+    }
+
+    @Provides
+    @PluginDomain(FreeDesktopNotificationsPlugin.class)
+    public String getFDSettingsDomain() {
+        return pluginInfo.getDomain();
+    }
+
+    @Provides
+    @Singleton
+    public PluginFilesHelper getPluginFilesHelper() {
+        return new PluginFilesHelper(pluginInfo);
+    }
+
+}

src/com/dmdirc/addons/freedesktop_notifications/FDNotifyCommand.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 FDNotify Command shows a nice popup on using the FreeDesktop VisualNotifications.
  */
@@ -39,19 +41,19 @@ public final class FDNotifyCommand extends Command {
     public static final BaseCommandInfo INFO = new BaseCommandInfo("fdnotify",
             "fdnotify <message> - Show a nice popup where available",
             CommandType.TYPE_GLOBAL);
-    /** Plugin that owns this command. */
-    final FreeDesktopNotificationsPlugin myPlugin;
+    /** Manager to show notifications. */
+    private final FDManager manager;
 
     /**
      * Creates a new instance of FDNotifyCommand.
      *
      * @param controller The controller to use for command information.
-     * @param myPlugin   the plugin creating this command.
+     * @param manager   Manager to show notifications
      */
-    public FDNotifyCommand(final CommandController controller,
-            final FreeDesktopNotificationsPlugin myPlugin) {
+    @Inject
+    public FDNotifyCommand(final CommandController controller, final FDManager manager) {
         super(controller);
-        this.myPlugin = myPlugin;
+        this.manager = manager;
     }
 
     /** {@inheritDoc} */
@@ -62,7 +64,7 @@ public final class FDNotifyCommand extends Command {
             /** {@inheritDoc} */
             @Override
             public void run() {
-                myPlugin.showNotification("", args.getArgumentsAsString());
+                manager.showNotification("", args.getArgumentsAsString());
             }
         }.start();
     }

src/com/dmdirc/addons/freedesktop_notifications/FreeDesktopNotificationsPlugin.java

@@ -27,66 +27,32 @@ 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.CommandController;
-import com.dmdirc.interfaces.config.AggregateConfigProvider;
-import com.dmdirc.interfaces.config.ConfigChangeListener;
-import com.dmdirc.interfaces.config.ConfigProvider;
-import com.dmdirc.interfaces.config.IdentityController;
-import com.dmdirc.logger.ErrorLevel;
-import com.dmdirc.logger.Logger;
 import com.dmdirc.plugins.Exported;
 import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BaseCommandPlugin;
-import com.dmdirc.plugins.implementations.PluginFilesHelper;
-import com.dmdirc.ui.messages.Styliser;
-import com.dmdirc.util.io.StreamReader;
 
-import java.io.IOException;
-import java.util.ArrayList;
-
-import org.apache.commons.lang.StringEscapeUtils;
+import dagger.ObjectGraph;
 
 /**
  * This plugin adds freedesktop Style Notifications to dmdirc.
  */
-public class FreeDesktopNotificationsPlugin extends BaseCommandPlugin implements
-        ConfigChangeListener {
+public class FreeDesktopNotificationsPlugin extends BaseCommandPlugin {
 
-    /** notification timeout. */
-    private int timeout;
-    /** notification icon. */
-    private String icon;
-    /** Escape HTML. */
-    private boolean escapehtml;
-    /** Strict escape. */
-    private boolean strictescape;
-    /** Strip codes. */
-    private boolean stripcodes;
     /** This plugin's plugin info. */
     private final PluginInfo pluginInfo;
-    /** Global config. */
-    private final AggregateConfigProvider config;
-    /** Addon identity. */
-    private final ConfigProvider identity;
-    /** Plugin files helper. */
-    private final PluginFilesHelper filesHelper;
+    /** Manager to show notifications. */
+    private FDManager manager;
 
-    /**
-     * Creates a new instance of this plugin.
-     *
-     * @param pluginInfo         This plugin's plugin info
-     * @param identityController Identity Manager instance
-     * @param commandController  Command controller to register commands
-     */
-    public FreeDesktopNotificationsPlugin(final PluginInfo pluginInfo,
-            final IdentityController identityController,
-            final CommandController commandController) {
-        super(commandController);
+    public FreeDesktopNotificationsPlugin(final PluginInfo pluginInfo) {
         this.pluginInfo = pluginInfo;
-        this.filesHelper = new PluginFilesHelper(pluginInfo);
-        config = identityController.getGlobalConfiguration();
-        identity = identityController.getAddonSettings();
-        registerCommand(new FDNotifyCommand(commandController, this), FDNotifyCommand.INFO);
+    }
+
+    @Override
+    public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
+        super.load(pluginInfo, graph);
+        setObjectGraph(graph.plus(new FDModule(pluginInfo)));
+        registerCommand(FDNotifyCommand.class, FDNotifyCommand.INFO);
+        manager = getObjectGraph().get(FDManager.class);
     }
 
     /**
@@ -99,69 +65,7 @@ public class FreeDesktopNotificationsPlugin extends BaseCommandPlugin implements
      */
     @Exported
     public boolean showNotification(final String title, final String message) {
-        if (filesHelper.getFilesDir() == null) {
-            return false;
-        }
-
-        final ArrayList<String> args = new ArrayList<>();
-
-        args.add("/usr/bin/env");
-        args.add("python");
-        args.add(filesHelper.getFilesDirString() + "notify.py");
-        args.add("-a");
-        args.add("DMDirc");
-        args.add("-i");
-        args.add(icon);
-        args.add("-t");
-        args.add(Integer.toString(timeout * 1000));
-        args.add("-s");
-
-        if (title != null && !title.isEmpty()) {
-            args.add(prepareString(title));
-        } else {
-            args.add("Notification from DMDirc");
-        }
-        args.add(prepareString(message));
-
-        try {
-            final Process myProcess = Runtime.getRuntime().exec(args.toArray(new String[]{}));
-            final StringBuffer data = new StringBuffer();
-            new StreamReader(myProcess.getErrorStream()).start();
-            new StreamReader(myProcess.getInputStream(), data).start();
-            try {
-                myProcess.waitFor();
-            } catch (InterruptedException e) {
-            }
-            return true;
-        } catch (SecurityException | IOException e) {
-        }
-
-        return false;
-    }
-
-    /**
-     * Prepare the string for sending to dbus.
-     *
-     * @param input Input string
-     *
-     * @return Input string after being processed according to config settings.
-     */
-    public String prepareString(final String input) {
-        String output = input;
-        if (stripcodes) {
-            output = Styliser.stipControlCodes(output);
-        }
-        if (escapehtml) {
-            if (strictescape) {
-                output = StringEscapeUtils.escapeHtml(output);
-            } else {
-                output = output.replace("&", "&amp;");
-                output = output.replace("<", "&lt;");
-                output = output.replace(">", "&gt;");
-            }
-        }
-
-        return output;
+        return manager.showNotification(title, message);
     }
 
     /**
@@ -169,16 +73,7 @@ public class FreeDesktopNotificationsPlugin extends BaseCommandPlugin implements
      */
     @Override
     public void onLoad() {
-        config.addChangeListener(pluginInfo.getDomain(), this);
-        setCachedSettings();
-        // Extract the files needed
-        try {
-            filesHelper.extractResoucesEndingWith(".py");
-            filesHelper.extractResoucesEndingWith(".png");
-        } catch (IOException ex) {
-            Logger.userError(ErrorLevel.MEDIUM,
-                    "Unable to extract files for Free desktop notifications: " + ex.getMessage(), ex);
-        }
+        manager.onLoad();
         super.onLoad();
     }
 
@@ -187,18 +82,16 @@ public class FreeDesktopNotificationsPlugin extends BaseCommandPlugin implements
      */
     @Override
     public synchronized void onUnload() {
-        config.removeListener(this);
+        manager.onUnLoad();
         super.onUnload();
     }
 
-    /** {@inheritDoc} */
     @Override
+    @Deprecated
     public void domainUpdated() {
-        identity.setOption(pluginInfo.getDomain(), "general.icon",
-                filesHelper.getFilesDirString() + "icon.png");
+        manager.domainUpdated();
     }
 
-    /** {@inheritDoc} */
     @Override
     public void showConfig(final PreferencesDialogModel manager) {
         final PreferencesCategory general = new PluginPreferencesCategory(
@@ -229,18 +122,4 @@ public class FreeDesktopNotificationsPlugin extends BaseCommandPlugin implements
         manager.getCategory("Plugins").addSubCategory(general);
     }
 
-    private void setCachedSettings() {
-        timeout = config.getOptionInt(pluginInfo.getDomain(), "general.timeout");
-        icon = config.getOption(pluginInfo.getDomain(), "general.icon");
-        escapehtml = config.getOptionBool(pluginInfo.getDomain(), "advanced.escapehtml");
-        strictescape = config.getOptionBool(pluginInfo.getDomain(), "advanced.strictescape");
-        stripcodes = config.getOptionBool(pluginInfo.getDomain(), "advanced.stripcodes");
-    }
-
-    /** {@inheritDoc} */
-    @Override
-    public void configChanged(final String domain, final String key) {
-        setCachedSettings();
-    }
-
 }