Fix showConfig for Nick Colour plugin.

This isn't hugely pretty and we should probably investigate a
better way of doing this.

Change-Id: I4644706347084eee101eaeaa494626147b3eae6e
Fixes-Issue: CLIENT-429
Reviewed-on: http://gerrit.dmdirc.com/3154
Automatic-Compile: DMDirc Build Manager
Reviewed-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/addons/nickcolours/NickColourManager.java

@@ -28,13 +28,6 @@ import com.dmdirc.ClientModule.GlobalConfig;
 import com.dmdirc.ClientModule.UserConfig;
 import com.dmdirc.actions.ActionManager;
 import com.dmdirc.actions.CoreActionType;
-import com.dmdirc.addons.ui_swing.MainFrame;
-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.config.prefs.PreferencesSetting;
-import com.dmdirc.config.prefs.PreferencesType;
 import com.dmdirc.interfaces.ActionListener;
 import com.dmdirc.interfaces.actions.ActionType;
 import com.dmdirc.interfaces.config.AggregateConfigProvider;
@@ -43,15 +36,12 @@ import com.dmdirc.interfaces.config.ConfigProvider;
 import com.dmdirc.parser.interfaces.ChannelClientInfo;
 import com.dmdirc.parser.interfaces.ChannelInfo;
 import com.dmdirc.parser.interfaces.ClientInfo;
-import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.ui.Colour;
-import com.dmdirc.ui.IconManager;
 import com.dmdirc.ui.messages.ColourManager;
 
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
-import java.util.concurrent.Callable;
 
 import javax.inject.Inject;
 import javax.inject.Singleton;
@@ -70,34 +60,20 @@ public class NickColourManager implements ActionListener, ConfigChangeListener {
     private boolean userandomcolour;
     private boolean settext;
     private boolean setnicklist;
-    /** This plugin's plugin info. */
-    private final PluginInfo pluginInfo;
     /** Manager to parse colours with. */
     private final ColourManager colourManager;
-    /** Main frame to parent dialogs on. */
-    private final MainFrame mainFrame;
-    /** Icon manager to retrieve icons from. */
-    private final IconManager iconManager;
     /** Config to read settings from. */
     private final AggregateConfigProvider globalConfig;
-    /** Config to write settings to. */
-    private final ConfigProvider userConfig;
     /** Plugin's setting domain. */
     private final String domain;
 
     @Inject
-    public NickColourManager(final PluginInfo pluginInfo,
+    public NickColourManager(final ColourManager colourManager,
             @NickColourModule.NickColourSettingsDomain final String domain,
-            final ColourManager colourManager, final MainFrame mainFrame,
-            @GlobalConfig final IconManager iconManager,
             @GlobalConfig final AggregateConfigProvider globalConfig,
             @UserConfig final ConfigProvider userConfig) {
-        this.mainFrame = mainFrame;
         this.domain = domain;
-        this.iconManager = iconManager;
-        this.pluginInfo = pluginInfo;
         this.globalConfig = globalConfig;
-        this.userConfig = userConfig;
         this.colourManager = colourManager;
     }
 
@@ -147,9 +123,9 @@ public class NickColourManager implements ActionListener, ConfigChangeListener {
         String[] parts = null;
 
         if (globalConfig.hasOptionString(domain, nickOption1)) {
-            parts = getParts(nickOption1);
+            parts = getParts(globalConfig, domain, nickOption1);
         } else if (globalConfig.hasOptionString(domain, nickOption2)) {
-            parts = getParts(nickOption2);
+            parts = getParts(globalConfig, domain, nickOption2);
         }
 
         if (parts != null) {
@@ -207,16 +183,19 @@ public class NickColourManager implements ActionListener, ConfigChangeListener {
     /**
      * Reads the nick colour data from the config.
      *
+     * @param config Config to read settings from
+     * @param domain Config domain
+     *
      * @return A multi-dimensional array of nick colour info.
      */
-    public Object[][] getData() {
+    public static Object[][] getData(final AggregateConfigProvider config, final String domain) {
         final List<Object[]> data = new ArrayList<>();
 
-        for (String key : globalConfig.getOptions(domain).keySet()) {
+        for (String key : config.getOptions(domain).keySet()) {
             if (key.startsWith("color:")) {
                 final String network = key.substring(6, key.indexOf(':', 6));
                 final String user = key.substring(1 + key.indexOf(':', 6));
-                final String[] parts = getParts(key);
+                final String[] parts = getParts(config, domain, key);
 
                 data.add(new Object[]{network, user, parts[0], parts[1]});
             }
@@ -238,12 +217,15 @@ public class NickColourManager implements ActionListener, ConfigChangeListener {
      * Retrieves the config option with the specified key, and returns an array of the colours that
      * should be used for it.
      *
-     * @param key The config key to look up
+     * @param config Config to read settings from
+     * @param domain Config domain
+     * @param key    The config key to look up
      *
      * @return The colours specified by the given key
      */
-    private String[] getParts(final String key) {
-        String[] parts = globalConfig.getOption(domain, key).split(":");
+    private static String[] getParts(final AggregateConfigProvider config, final String domain,
+            final String key) {
+        String[] parts = config.getOption(domain, key).split(":");
 
         if (parts.length == 0) {
             parts = new String[]{null, null};
@@ -270,60 +252,6 @@ public class NickColourManager implements ActionListener, ConfigChangeListener {
         ActionManager.getActionManager().unregisterListener(this);
     }
 
-    /**
-     * Shows the prefs configuration page for this plugin.
-     *
-     * @param manager Prefs manager to add settings to
-     */
-    public void showConfig(final PreferencesDialogModel manager) {
-        final PreferencesCategory general = new PluginPreferencesCategory(
-                pluginInfo, "Nick Colours",
-                "General configuration for NickColour plugin.");
-        final PreferencesCategory colours = new PluginPreferencesCategory(
-                pluginInfo, "Colours",
-                "Set colours for specific nicknames.", UIUtilities.invokeAndWait(
-                new Callable<NickColourPanel>() {
-            /** {@inheritDoc} */
-            @Override
-            public NickColourPanel call() {
-                return new NickColourPanel(mainFrame, iconManager,
-                        NickColourManager.this, colourManager, userConfig);
-            }
-        }));
-
-        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
-                "ui", "shownickcoloursintext", "Show colours in text area",
-                "Colour nicknames in main text area?",
-                manager.getConfigManager(), manager.getIdentity()));
-        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
-                "ui", "shownickcoloursinnicklist", "Show colours in"
-                + " nick list", "Colour nicknames in channel nick lists?",
-                manager.getConfigManager(), manager.getIdentity()));
-        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
-                domain, "settext", "Set colours in textarea",
-                "Should the plugin set the textarea colour of nicks?",
-                manager.getConfigManager(), manager.getIdentity()));
-        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
-                domain, "setnicklist", "Set colours in nick list",
-                "Should the plugin set the nick list colour of nicks?",
-                manager.getConfigManager(), manager.getIdentity()));
-        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
-                domain, "userandomcolour", "Use random colour",
-                "Use a pseudo-random colour for each person?",
-                manager.getConfigManager(), manager.getIdentity()));
-        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
-                domain, "useowncolour", "Use colour for own nick",
-                "Always use the same colour for our own nickname?",
-                manager.getConfigManager(), manager.getIdentity()));
-        general.addSetting(new PreferencesSetting(PreferencesType.COLOUR, domain,
-                "owncolour", "Colour to use for own nick",
-                "Colour used for our own nickname, if above setting is "
-                + "enabled.", manager.getConfigManager(), manager.getIdentity()));
-
-        general.addSubCategory(colours);
-        manager.getCategory("Plugins").addSubCategory(general);
-    }
-
     /**
      * Updates cached settings.
      */

src/com/dmdirc/addons/nickcolours/NickColourModule.java

@@ -23,7 +23,6 @@
 package com.dmdirc.addons.nickcolours;
 
 import com.dmdirc.addons.ui_swing.injection.SwingModule;
-import com.dmdirc.plugins.PluginInfo;
 
 import javax.inject.Qualifier;
 
@@ -38,15 +37,12 @@ public class NickColourModule {
 
     /** The domain for plugin settings. */
     private final String domain;
-    /** The plugin's plugin info. */
-    private final PluginInfo pluginInfo;
 
     @Qualifier
     public static @interface NickColourSettingsDomain {
     }
 
-    public NickColourModule(final PluginInfo pluginInfo, final String domain) {
-        this.pluginInfo = pluginInfo;
+    public NickColourModule(final String domain) {
         this.domain = domain;
     }
 
@@ -61,9 +57,4 @@ public class NickColourModule {
         return domain;
     }
 
-    @Provides
-    public PluginInfo getPluginInfo() {
-        return pluginInfo;
-    }
-
 }

src/com/dmdirc/addons/nickcolours/NickColourPanel.java

@@ -24,6 +24,7 @@ package com.dmdirc.addons.nickcolours;
 
 import com.dmdirc.addons.ui_swing.MainFrame;
 import com.dmdirc.config.prefs.PreferencesInterface;
+import com.dmdirc.interfaces.config.AggregateConfigProvider;
 import com.dmdirc.interfaces.config.ConfigProvider;
 import com.dmdirc.ui.IconManager;
 import com.dmdirc.ui.messages.ColourManager;
@@ -54,11 +55,10 @@ public class NickColourPanel extends JPanel implements ActionListener,
     /** A version number for this class. */
     private static final long serialVersionUID = 1;
     /** The table headings. */
-    private static final String[] HEADERS = {"Network", "Nickname", "Text colour", "Nicklist colour"};
+    private static final String[] HEADERS
+            = {"Network", "Nickname", "Text colour", "Nicklist colour"};
     /** The table used for displaying the options. */
     private final JTable table;
-    /** The plugin we're associated with. */
-    private final transient NickColourManager plugin;
     /** The identity to write settings to. */
     private final ConfigProvider configIdentity;
     /** Edit button. */
@@ -71,26 +71,33 @@ public class NickColourPanel extends JPanel implements ActionListener,
     private final IconManager iconManager;
     /** Colour manage to use to parse colours. */
     private final ColourManager colourManager;
+    /** Config provider to read settings from. */
+    private final AggregateConfigProvider config;
+    /** The plugin's config domain. */
+    private final String domain;
 
     /**
      * Creates a new instance of NickColourPanel.
      *
      * @param mainFrame     Main frame to parent dialogs on
      * @param iconManager   Icon manager to load icons from
-     * @param plugin        The plugin that owns this panel
      * @param colourManager The colour manager to use to parse colours.
      * @param userSettings  The provider to write user settings to.
+     * @param config        The config provider to read settings from.
+     * @param domain        The plugin's config domain
      */
     public NickColourPanel(
-            final MainFrame mainFrame, final IconManager iconManager, final NickColourManager plugin,
-            final ColourManager colourManager, final ConfigProvider userSettings) {
+            final MainFrame mainFrame, final IconManager iconManager,
+            final ColourManager colourManager, final ConfigProvider userSettings,
+            final AggregateConfigProvider config, final String domain) {
         this.mainFrame = mainFrame;
         this.iconManager = iconManager;
         this.colourManager = colourManager;
-        this.plugin = plugin;
         this.configIdentity = userSettings;
+        this.config = config;
+        this.domain = domain;
 
-        final Object[][] data = plugin.getData();
+        final Object[][] data = NickColourManager.getData(config, domain);
 
         table = new JTable(new DefaultTableModel(data, HEADERS)) {
             /** A version number for this class. */
@@ -141,15 +148,6 @@ public class NickColourPanel extends JPanel implements ActionListener,
         deleteButton.setEnabled(false);
     }
 
-    /**
-     * Get an instance of the plugin that owns us.
-     *
-     * @return Our plugin.
-     */
-    public NickColourManager getPlugin() {
-        return plugin;
-    }
-
     /**
      * {@inheritDoc}
      *
@@ -217,10 +215,10 @@ public class NickColourPanel extends JPanel implements ActionListener,
         final List<Object[]> res = new ArrayList<>();
         final DefaultTableModel model = ((DefaultTableModel) table.getModel());
 
+        @SuppressWarnings("unchecked")
         final List<List<?>> rows = (List<List<?>>) model.getDataVector();
         for (List<?> row : rows) {
-            res.add(new Object[]{row.get(0), row.get(1), row.get(2),
-                row.get(3)});
+            res.add(new Object[]{row.get(0), row.get(1), row.get(2), row.get(3)});
         }
 
         return res;
@@ -230,15 +228,14 @@ public class NickColourPanel extends JPanel implements ActionListener,
     @Override
     public void save() {
         // Remove all old config entries
-        for (Object[] parts : plugin.getData()) {
-            configIdentity.unsetOption(plugin.getDomain(),
-                    "color:" + parts[0] + ":" + parts[1]);
+        for (Object[] parts : NickColourManager.getData(config, domain)) {
+            configIdentity.unsetOption(domain, "color:" + parts[0] + ":" + parts[1]);
         }
 
         // And write the new ones
         for (Object[] row : getData()) {
-            configIdentity.setOption(plugin.getDomain(),
-                    "color:" + row[0] + ":" + row[1], row[2] + ":" + row[3]);
+            configIdentity.
+                    setOption(domain, "color:" + row[0] + ":" + row[1], row[2] + ":" + row[3]);
         }
     }
 

src/com/dmdirc/addons/nickcolours/NickColourPlugin.java

@@ -22,9 +22,20 @@
 
 package com.dmdirc.addons.nickcolours;
 
+import com.dmdirc.addons.ui_swing.MainFrame;
+import com.dmdirc.addons.ui_swing.SwingController;
+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.config.prefs.PreferencesSetting;
+import com.dmdirc.config.prefs.PreferencesType;
 import com.dmdirc.plugins.PluginInfo;
 import com.dmdirc.plugins.implementations.BasePlugin;
+import com.dmdirc.ui.IconManager;
+import com.dmdirc.ui.messages.ColourManager;
+
+import java.util.concurrent.Callable;
 
 import dagger.ObjectGraph;
 
@@ -33,17 +44,30 @@ import dagger.ObjectGraph;
  */
 public class NickColourPlugin extends BasePlugin {
 
+    /** Plugin info. */
+    private final PluginInfo pluginInfo;
+    /** Main frame. */
+    private final MainFrame mainFrame;
+    /** Icon manager. */
+    private final IconManager iconManager;
+    /** Colour manager. */
+    private final ColourManager colourManager;
     /** Nick colour manager. */
     private NickColourManager nickColourManager;
 
-    public NickColourPlugin() {
+    public NickColourPlugin(final PluginInfo pluginInfo, final SwingController controller,
+            final IconManager iconManager, final ColourManager colourManager) {
+        this.pluginInfo = pluginInfo;
+        this.mainFrame = controller.getMainFrame();
+        this.iconManager = iconManager;
+        this.colourManager = colourManager;
     }
 
     @Override
     public void load(final PluginInfo pluginInfo, final ObjectGraph graph) {
         super.load(pluginInfo, graph);
 
-        setObjectGraph(graph.plus(new NickColourModule(pluginInfo, getDomain())));
+        setObjectGraph(graph.plus(new NickColourModule(pluginInfo.getDomain())));
         nickColourManager = getObjectGraph().get(NickColourManager.class);
     }
 
@@ -61,7 +85,53 @@ public class NickColourPlugin extends BasePlugin {
 
     @Override
     public void showConfig(final PreferencesDialogModel manager) {
-        nickColourManager.showConfig(manager);
+        final PreferencesCategory general = new PluginPreferencesCategory(
+                pluginInfo, "Nick Colours",
+                "General configuration for NickColour plugin.");
+        final PreferencesCategory colours = new PluginPreferencesCategory(
+                pluginInfo, "Colours",
+                "Set colours for specific nicknames.", UIUtilities.invokeAndWait(
+                        new Callable<NickColourPanel>() {
+                            /** {@inheritDoc} */
+                            @Override
+                            public NickColourPanel call() {
+                                return new NickColourPanel(mainFrame, iconManager, colourManager,
+                                        manager.getIdentity(), manager.getConfigManager(),
+                                        pluginInfo.getDomain());
+                            }
+                        }));
+
+        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
+                "ui", "shownickcoloursintext", "Show colours in text area",
+                "Colour nicknames in main text area?",
+                manager.getConfigManager(), manager.getIdentity()));
+        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
+                "ui", "shownickcoloursinnicklist", "Show colours in"
+                + " nick list", "Colour nicknames in channel nick lists?",
+                manager.getConfigManager(), manager.getIdentity()));
+        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN, pluginInfo.getDomain(),
+                "settext", "Set colours in textarea",
+                "Should the plugin set the textarea colour of nicks?",
+                manager.getConfigManager(), manager.getIdentity()));
+        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN, pluginInfo.getDomain(),
+                "setnicklist", "Set colours in nick list",
+                "Should the plugin set the nick list colour of nicks?",
+                manager.getConfigManager(), manager.getIdentity()));
+        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
+                pluginInfo.getDomain(), "userandomcolour", "Use random colour",
+                "Use a pseudo-random colour for each person?",
+                manager.getConfigManager(), manager.getIdentity()));
+        general.addSetting(new PreferencesSetting(PreferencesType.BOOLEAN,
+                pluginInfo.getDomain(), "useowncolour", "Use colour for own nick",
+                "Always use the same colour for our own nickname?",
+                manager.getConfigManager(), manager.getIdentity()));
+        general.addSetting(new PreferencesSetting(PreferencesType.COLOUR, pluginInfo.getDomain(),
+                "owncolour", "Colour to use for own nick",
+                "Colour used for our own nickname, if above setting is "
+                + "enabled.", manager.getConfigManager(), manager.getIdentity()));
+
+        general.addSubCategory(colours);
+        manager.getCategory("Plugins").addSubCategory(general);
     }
 
 }