Adds basic config options to the UI for the relaybot plugin.

Fixes issue CLIENT-31

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

src/com/dmdirc/addons/relaybot/RelayBotPlugin.java

@@ -28,15 +28,24 @@ import com.dmdirc.ServerManager;
 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.config.IdentityManager;
+import com.dmdirc.config.prefs.PluginPreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesCategory;
+import com.dmdirc.config.prefs.PreferencesManager;
+import com.dmdirc.config.prefs.PreferencesSetting;
+import com.dmdirc.config.prefs.PreferencesType;
 import com.dmdirc.interfaces.ActionListener;
 import com.dmdirc.interfaces.ConfigChangeListener;
 import com.dmdirc.parser.interfaces.ChannelClientInfo;
 import com.dmdirc.parser.interfaces.Parser;
 import com.dmdirc.parser.irc.IRCParser;
 import com.dmdirc.plugins.Plugin;
+import com.dmdirc.plugins.PluginManager;
+import com.dmdirc.util.ReturnableThread;
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
@@ -65,6 +74,7 @@ public class RelayBotPlugin extends Plugin implements ActionListener, ConfigChan
         ActionManager.addListener(this, CoreActionType.SERVER_CONNECTED);
         ActionManager.addListener(this, CoreActionType.SERVER_DISCONNECTED);
         ActionManager.addListener(this, CoreActionType.CHANNEL_QUIT);
+        IdentityManager.getGlobalConfig().addChangeListener(getDomain(), this);
 
         // Add ourself to all currently known channels that we should be
         // connected with.
@@ -160,7 +170,6 @@ public class RelayBotPlugin extends Plugin implements ActionListener, ConfigChan
     /** {@inheritDoc} */
     @Override
     public void configChanged(final String domain, final String key) {
-        if (!domain.equals(getDomain())) { return; }
         final boolean wasUnset = !(IdentityManager.getGlobalConfig().hasOptionString(domain, key));
 
         for (Server server : ServerManager.getServerManager().getServers()) {
@@ -236,4 +245,63 @@ public class RelayBotPlugin extends Plugin implements ActionListener, ConfigChan
 
         return null;
     }
+
+    /**
+     * Reads the relay bot channel data from the config.
+     *
+     * @return A multi-dimensional array of channel data.
+     */
+    public String[][] getData() {
+        final Map<String, String> settings = IdentityManager.getGlobalConfig()
+                .getOptions(getDomain());
+        int i = 0;
+        for (Map.Entry<String, String> entry : settings.entrySet()) {
+            if (entry.getKey().charAt(0) == '#') {
+                i++;
+            }
+        }
+        final String[][] data = new String[i][2];
+        i = 0;
+        for (Map.Entry<String, String> entry : settings.entrySet()) {
+            if (entry.getKey().charAt(0) == '#') {
+                data[i] = new String[]{entry.getKey(), entry.getValue(), };
+                i++;
+            }
+        }
+        return data;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void showConfig(final PreferencesManager manager) {
+        final PreferencesCategory general = new PluginPreferencesCategory(
+                getPluginInfo(), "Relay Bot",
+                "General configuration for the Relay bot plugin.");
+
+        final PreferencesCategory colours = new PluginPreferencesCategory(
+                getPluginInfo(), "Channels",
+                "Identifies where and who the bot is in channels.",
+                UIUtilities.invokeAndWait(
+                new ReturnableThread<RelayChannelPanel>() {
+
+            /** {@inheritDoc} */
+            @Override
+            public void run() {
+                setObject(new RelayChannelPanel(PluginManager.getPluginManager()
+                        .getPluginInfoByName("ui_swing").getPlugin(),
+                        RelayBotPlugin.this));
+            }
+        }));
+        colours.setInline().setInlineAfter();
+        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
+                getDomain(), "joinOnDiscover", "Join on discover",
+                "Do you want fake clients to join the channel?"));
+        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
+                getDomain(), "colourFullName", "Colour full name",
+                "Do you want to colour the full name?"));
+        manager.getCategory("Plugins").addSubCategory(general);
+        general.addSubCategory(colours);
+    }
+
+
 }

src/com/dmdirc/addons/relaybot/RelayChannelPanel.java

@@ -0,0 +1,210 @@
+/*
+ * 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.relaybot;
+
+import com.dmdirc.addons.ui_swing.SwingController;
+import com.dmdirc.addons.ui_swing.dialogs.StandardInputDialog;
+import com.dmdirc.config.IdentityManager;
+import com.dmdirc.config.prefs.PreferencesInterface;
+import com.dmdirc.plugins.Plugin;
+import com.dmdirc.plugins.PluginManager;
+import java.awt.Dialog.ModalityType;
+
+import java.awt.event.ActionEvent;
+import java.awt.event.ActionListener;
+import java.lang.reflect.InvocationTargetException;
+import java.lang.reflect.Method;
+import java.util.ArrayList;
+import java.util.List;
+
+import javax.swing.JButton;
+import javax.swing.JPanel;
+import javax.swing.JScrollPane;
+import javax.swing.JTable;
+import javax.swing.event.ListSelectionEvent;
+import javax.swing.event.ListSelectionListener;
+import javax.swing.table.DefaultTableModel;
+
+import net.miginfocom.swing.MigLayout;
+
+/**
+ * Panel used for the relay bot channel and nickname settings in the plugin's
+ * config dialog.
+ */
+public class RelayChannelPanel extends JPanel implements ActionListener,
+        PreferencesInterface, ListSelectionListener {
+
+    /**
+     * 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;
+    /** The table used for displaying the options. */
+    private final JTable table;
+    /** The plugin we're associated with. */
+    private final transient RelayBotPlugin plugin;
+    /** The table headings. */
+    private static final String[] HEADERS = {"Channel", "Nickname", };
+
+    /** Delete button. */
+    private final JButton deleteButton;
+
+    /**
+     * Creates a new instance of NickColourPanel.
+     *
+     * @param controller The UI controller that owns this panel
+     * @param plugin The plugin that owns this panel
+     */
+    public RelayChannelPanel(final Plugin controller,
+            final RelayBotPlugin plugin) {
+        super();
+
+        this.plugin = plugin;
+
+        final Object[][] data = plugin.getData();
+
+        table = new JTable(new DefaultTableModel(data, HEADERS));
+
+        final JScrollPane scrollPane = new JScrollPane(table);
+
+        table.getSelectionModel().addListSelectionListener(this);
+        table.setFillsViewportHeight(true);
+        int height = 100;
+        try {
+            final Method getPrefsDialog = controller.getClass()
+                    .getDeclaredMethod("getPrefsDialog", (Class<?>) null);
+            final Object prefsDialog = getPrefsDialog.invoke(controller,
+                    (Class<?>) null);
+            final Method getPanelHeight = prefsDialog.getClass()
+                    .getDeclaredMethod("getPanelHeight", (Class<?>) null);
+            final Object panelHeight = getPanelHeight.invoke(prefsDialog,
+                    (Class<?>) null);
+            height = (Integer) panelHeight;
+        } catch (IllegalAccessException ex) {
+            height = 100;
+        } catch (IllegalArgumentException ex) {
+            height = 100;
+        } catch (InvocationTargetException ex) {
+            height = 100;
+        } catch (NoSuchMethodException ex) {
+            height = 100;
+        } catch (SecurityException ex) {
+            height = 100;
+        }
+        setLayout(new MigLayout("ins 0, fillx, hmax " + height));
+        add(scrollPane, "grow, push, wrap, spanx");
+
+        final JButton addButton = new JButton("Add");
+        addButton.addActionListener(this);
+        add(addButton, "sg button, growx, pushx");
+
+        deleteButton = new JButton("Delete");
+        deleteButton.addActionListener(this);
+        add(deleteButton, "sg button, growx, pushx");
+
+        deleteButton.setEnabled(false);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * @param e Action event
+     */
+    @Override
+    public void actionPerformed(final ActionEvent e) {
+        final DefaultTableModel model = ((DefaultTableModel) table.getModel());
+
+        if (e.getActionCommand().equals("Add")) {
+            addRow("#changeme", "changeme");
+        } else if (e.getActionCommand().equals("Delete")) {
+            final int row = table.getSelectedRow();
+            if (table.isEditing()) {
+                table.getCellEditor().stopCellEditing();
+            }
+            if (row > -1) {
+                model.removeRow(row);
+            }
+        }
+    }
+
+    /**
+     * Removes a row from the table.
+     *
+     * @param row The row to be removed
+     */
+    public void removeRow(final int row) {
+        ((DefaultTableModel) table.getModel()).removeRow(row);
+    }
+
+    /**
+     * Adds a row to the table.
+     *
+     * @param channel The channel setting
+     * @param nickname The nickname setting
+     */
+    public void addRow(final String channel, final String nickname) {
+        final DefaultTableModel model = ((DefaultTableModel) table.getModel());
+        model.addRow(new Object[]{channel, nickname, });
+    }
+
+    /**
+     * Retrieves the current data in use by this panel.
+     *
+     * @return This panel's current data.
+     */
+    public List<String[]> getData() {
+        final List<String[]> res = new ArrayList<String[]>();
+        final DefaultTableModel model = ((DefaultTableModel) table.getModel());
+
+        for (int i = 0; i < model.getRowCount(); i++) {
+            res.add(new String[]{(String) model.getValueAt(i, 0),
+            (String) model.getValueAt(i, 1), });
+        }
+
+        return res;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void save() {
+        // Remove all old config entries
+        for (String[] parts : plugin.getData()) {
+           IdentityManager.getConfigIdentity().unsetOption(plugin.getDomain(),
+                   parts[0]);
+        }
+
+        // And write the new ones
+        for (String[] row : getData()) {
+            IdentityManager.getConfigIdentity().setOption(plugin.getDomain(),
+                    row[0], row[1]);
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void valueChanged(final ListSelectionEvent e) {
+        deleteButton.setEnabled(table.getSelectedRow() > -1
+                && table.getModel().getRowCount() > 0);
+    }
+}

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

@@ -23,6 +23,9 @@ updates:
 requires:
   parent=irc
 
+required-services:
+  swing ui
+
 defaults:
   colourFullName=true
   joinOnDiscover=false