Add notifications plugin

Fixes issue CLIENT-70

Depends-on: I75eedbd9966d08d1f600b78f63ece76ad0b27126
Change-Id: I155eede0f29c9dcf2155542c6cc7817ccea096b0
Reviewed-on: http://gerrit.dmdirc.com/1543
Automatic-Compile: Greg Holmes <greg@dmdirc.com>
Reviewed-by: Chris Smith <chris@dmdirc.com>

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

@@ -0,0 +1,163 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.FrameContainer;
+import com.dmdirc.commandparser.CommandArguments;
+import com.dmdirc.commandparser.CommandInfo;
+import com.dmdirc.commandparser.CommandType;
+import com.dmdirc.commandparser.commands.Command;
+import com.dmdirc.commandparser.commands.IntelligentCommand;
+import com.dmdirc.commandparser.commands.context.CommandContext;
+import com.dmdirc.plugins.ExportedService;
+import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.ui.input.AdditionalTabTargets;
+import com.dmdirc.ui.input.TabCompleter;
+
+import java.util.List;
+
+/**
+ * Notification command, delegating notification to one of the registered
+ * notification commands as preferred by the end user.
+ */
+public class NotificationCommand extends Command implements
+        IntelligentCommand, CommandInfo {
+
+    /** The plugin that's using this command. */
+    private final NotificationsPlugin parent;
+
+    /**
+     * Creates a new instance of this notification command.
+     *
+     * @param parent The plugin that's instansiating this command
+     */
+    public NotificationCommand(final NotificationsPlugin parent) {
+        super();
+
+        this.parent = parent;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void execute(final FrameContainer<?> origin,
+            final CommandArguments args, final CommandContext context) {
+        if (args.getArguments().length > 0 && args.getArguments()[0]
+                .equalsIgnoreCase("--methods")) {
+            doMethodList(origin, args.isSilent());
+        } else if (args.getArguments().length > 0 && args.getArguments()[0]
+                .equalsIgnoreCase("--method")) {
+            if (args.getArguments().length > 1) {
+                final String sourceName = args.getArguments()[1];
+                final ExportedService source = parent.getMethod(sourceName)
+                        .getExportedService("showNotification");
+
+                if (source == null) {
+                    sendLine(origin, args.isSilent(), FORMAT_ERROR,
+                            "Method not found.");
+                } else {
+                    source.execute("DMDirc", args.getArgumentsAsString(2));
+                }
+            } else {
+                sendLine(origin, args.isSilent(), FORMAT_ERROR,
+                        "You must specify a method when using --method.");
+            }
+        } else if (parent.hasActiveMethod()) {
+            parent.getPreferredMethod().getExportedService("showNotification")
+                    .execute("DMDirc", args.getArgumentsAsString(0));
+        } else {
+            sendLine(origin, args.isSilent(), FORMAT_ERROR,
+                    "No active notification methods available.");
+        }
+    }
+
+    /**
+     * Outputs a list of methods for the notifcation command.
+     *
+     * @param origin The input window where the command was entered
+     * @param isSilent Whether this command is being silenced
+     */
+    private void doMethodList(final FrameContainer<?> origin,
+            final boolean isSilent) {
+        final List<PluginInfo> methods = parent.getMethods();
+
+        if (methods.isEmpty()) {
+            sendLine(origin, isSilent, FORMAT_ERROR, "No notification "
+                    + "methods available.");
+        } else {
+            final String[] headers = {"Method"};
+            final String[][] data = new String[methods.size()][1];
+            int i = 0;
+            for (PluginInfo method : methods) {
+                data[i][0] = method.getName();
+                i++;
+            }
+
+            sendLine(origin, isSilent, FORMAT_OUTPUT, doTable(headers, data));
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public AdditionalTabTargets getSuggestions(final int arg,
+            final IntelligentCommandContext context) {
+        final AdditionalTabTargets res = new AdditionalTabTargets();
+        res.excludeAll();
+        if (arg == 0) {
+            res.add("--methods");
+            res.add("--method");
+            return res;
+        } else if (arg == 1 && context.getPreviousArgs().get(0)
+                .equalsIgnoreCase("--method")) {
+            for (PluginInfo source : parent.getMethods()) {
+                res.add(source.getName());
+            }
+            return res;
+        }
+        return res;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getName() {
+        return "notification";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean showInHelp() {
+        return true;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getHelp() {
+        return "notification [--methods|--method <method>] text - "
+                + "Notifies you of the text";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public CommandType getType() {
+        return CommandType.TYPE_GLOBAL;
+    }
+}

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

@@ -0,0 +1,134 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.addons.ui_swing.components.reorderablelist.ListReorderButtonPanel;
+import com.dmdirc.addons.ui_swing.components.reorderablelist.ReorderableJList;
+import com.dmdirc.config.prefs.PreferencesInterface;
+
+import java.util.Enumeration;
+import java.util.LinkedList;
+import java.util.List;
+
+import javax.swing.BorderFactory;
+import javax.swing.JLabel;
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.UIManager;
+
+import net.miginfocom.swing.MigLayout;
+
+/**
+ * Notification method configuration panel.
+ */
+public class NotificationConfig extends JPanel implements PreferencesInterface {
+
+    /**
+     * A version number for this class. It should be changed whenever the class
+     * structure is changed (or anything else that would prevent serialized
+     * objects being unserialized with the new class).
+     */
+    private static final long serialVersionUID = 1;
+    /** Notification method order list. */
+    private ReorderableJList list;
+    /** Notification methods. */
+    private final List<String> methods;
+    /** The plugin that owns this panel. */
+    private final NotificationsPlugin plugin;
+
+    /**
+     * Creates a new instance of NotificationConfig panel.
+     *
+     * @param plugin The plugin that owns this panel
+     * @param methods A list of methods to be used in the panel
+     */
+    public NotificationConfig(final NotificationsPlugin plugin,
+            final List<String> methods) {
+        super();
+
+        if (methods == null) {
+            this.methods = new LinkedList<String>();
+        } else {
+            this.methods = new LinkedList<String>(methods);
+        }
+        this.plugin = plugin;
+
+        initComponents();
+    }
+
+    /**
+     * Initialises the components.
+     */
+    private void initComponents() {
+        list = new ReorderableJList();
+
+        for (String method : methods) {
+            list.getModel().addElement(method);
+        }
+
+        setLayout(new MigLayout("fillx, ins 0"));
+
+        JPanel panel = new JPanel();
+
+        panel.setBorder(BorderFactory.createTitledBorder(UIManager.getBorder(
+                "TitledBorder.border"), "Source order"));
+        panel.setLayout(new MigLayout("fillx, ins 5"));
+
+        panel.add(new JLabel("Drag and drop items to reorder"), "wrap");
+        panel.add(new JScrollPane(list), "growx, pushx");
+        panel.add(new ListReorderButtonPanel(list), "");
+
+        add(panel, "growx, wrap");
+
+        panel = new JPanel();
+
+        panel.setBorder(BorderFactory.createTitledBorder(UIManager.getBorder(
+                "TitledBorder.border"), "Output format"));
+        panel.setLayout(new MigLayout("fillx, ins 5"));
+
+        add(panel, "growx, wrap");
+    }
+
+    /**
+     * Retrieves the (new) notification method order from this config panel.
+     *
+     * @return An ordered list of methods
+     */
+    public List<String> getMethods() {
+        final List<String> newMethods = new LinkedList<String>();
+
+        final Enumeration<?> values = list.getModel().elements();
+
+        while (values.hasMoreElements()) {
+            newMethods.add((String) values.nextElement());
+        }
+
+        return newMethods;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void save() {
+        plugin.saveSettings(getMethods());
+    }
+}

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

@@ -0,0 +1,225 @@
+/*
+ * Copyright (c) 2006-2010 Chris Smith, Shane Mc Cormack, Gregory Holmes
+ *
+ * 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.actions.ActionManager;
+import com.dmdirc.actions.CoreActionType;
+import com.dmdirc.actions.interfaces.ActionType;
+import com.dmdirc.addons.ui_swing.UIUtilities;
+import com.dmdirc.commandparser.CommandManager;
+import com.dmdirc.config.IdentityManager;
+import com.dmdirc.config.prefs.PluginPreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesManager;
+import com.dmdirc.interfaces.ActionListener;
+import com.dmdirc.plugins.Plugin;
+import com.dmdirc.plugins.PluginInfo;
+import com.dmdirc.plugins.PluginManager;
+import com.dmdirc.util.ReturnableThread;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * Notification Manager plugin, aggregates notification sources exposing them
+ * via a single command.
+ */
+public class NotificationsPlugin extends Plugin implements ActionListener {
+
+    /** The notification methods that we know of. */
+    private final List<String> methods = new ArrayList<String>();
+    /** The command we're registering. */
+    private NotificationCommand command;
+    /** The user's preferred order for method usage. */
+    private List<String> order;
+
+    /**
+     * Creates a new notifications plugin.
+     */
+    public NotificationsPlugin() {
+        super();
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onLoad() {
+        methods.clear();
+        loadSettings();
+        ActionManager.addListener(this, CoreActionType.PLUGIN_LOADED,
+                CoreActionType.PLUGIN_UNLOADED);
+        for (PluginInfo target : PluginManager.getPluginManager()
+                .getPluginInfos()) {
+            if (target.isLoaded()) {
+                addPlugin(target);
+            }
+        }
+        command = new NotificationCommand(this);
+        CommandManager.registerCommand(command);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void onUnload() {
+        methods.clear();
+        ActionManager.removeListener(this);
+        CommandManager.unregisterCommand(command);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void showConfig(final PreferencesManager manager) {
+        final NotificationConfig configPanel = UIUtilities.invokeAndWait(
+                new ReturnableThread<NotificationConfig>() {
+
+            /** {@inheritDoc} */
+            @Override
+            public void run() {
+                setObject(new NotificationConfig(NotificationsPlugin.this,
+                        order));
+            }
+        });
+
+        final PreferencesCategory category = new PluginPreferencesCategory(
+                getPluginInfo(), "Notifications", "", "category-notifications",
+                configPanel);
+        manager.getCategory("Plugins").addSubCategory(category);
+    }
+
+    /** Loads the plugins settings. */
+    private void loadSettings() {
+        if (IdentityManager.getGlobalConfig().hasOptionString(getDomain(),
+                "methodOrder")) {
+            order = IdentityManager.getGlobalConfig().getOptionList(
+                    getDomain(), "methodOrder");
+        } else {
+            order = new ArrayList<String>();
+        }
+    }
+
+    /** {@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.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.getName())) {
+            order.add(source.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.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.getPluginManager().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<PluginInfo>();
+        for (String method : methods) {
+            plugins.add(PluginManager.getPluginManager()
+                    .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.getPluginManager().getPluginInfoByName(
+                    method);
+            }
+        }
+        return null;
+    }
+
+    /**
+     * Saves the plugins settings.
+     *
+     * @param newOrder The new order for methods
+     */
+    protected void saveSettings(final List<String> newOrder) {
+        order = newOrder;
+        IdentityManager.getConfigIdentity().setOption(getDomain(),
+                "methodOrder", order);
+    }
+}

src/com/dmdirc/addons/notifications/plugin.config

@@ -0,0 +1,30 @@
+# This is a DMDirc configuration file.
+
+# This section indicates which sections below take key/value
+# pairs, rather than a simple list. It should be placed above
+# any sections that take key/values.
+keysections:
+  metadata
+  version
+  requires
+  defaults
+
+metadata:
+  author=Greg <greg@dmdirc.com>
+  mainclass=com.dmdirc.addons.notifications.NotificationsPlugin
+  description=Provides a notification command exposing notifications plugins centrally.
+  name=notifications
+  nicename=Notification Manager
+
+version:
+  friendly=0.1
+
+requires:
+  parent=ui_swing
+
+required-services:
+  swing ui
+
+provides:
+  notification command
+  notification manager

src/com/dmdirc/addons/osd/OsdPlugin.java

@@ -195,4 +195,15 @@ public final class OsdPlugin extends Plugin implements CategoryChangeListener,
         }
     }
 
+    /**
+     * Shows an OSD with the specified message, title is ignored, exported
+     * method used for showNotification.
+     *
+     * @param title Ignored
+     * @param message Message to show
+     */
+    public void showOSD(final String title, final String message) {
+        osdManager.showWindow(message);
+    }
+
 }

src/com/dmdirc/addons/osd/plugin.config

@@ -45,7 +45,7 @@ defaults:
   maxWindows=false:5
 
 exports:
-  showOSD in com.dmdirc.addons.osd.OsdCommand as showNotification
+  showOSD in com.dmdirc.addons.osd.OsdPlugin as showNotification
 
 icons:
   category-osd=plugin://osd:com/dmdirc/addons/osd/icon.png

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

@@ -103,6 +103,17 @@ public final class SystrayPlugin extends Plugin implements ActionListener,
         notify(title, message, TrayIcon.MessageType.NONE);
     }
 
+    /**
+     * Proxy method for notify, this method is used for the exported command to
+     * avoid ambiguity when performing reflection.
+     *
+     * @param title Title for the notification
+     * @param message Text for the notification
+     */
+    public void showPopup(final String title, final String message) {
+        notify(title, message);
+    }
+
     /**
      * {@inheritDoc}
      *

src/com/dmdirc/addons/systray/plugin.config

@@ -36,4 +36,4 @@ defaults:
   autominimise=false
 
 exports:
-  showPopup in com.dmdirc.addons.systray.SystrayPlugin.PopupCommand as showNotification
+  showPopup in com.dmdirc.addons.systray.SystrayPlugin as showNotification