Redo the Identity/ConfigManager get options so they use maps where appropriate, rather than stupid string building

Remove all deprecated Identity/ConfigManager methods
Fixes issue 1335

git-svn-id: http://svn.dmdirc.com/trunk@4200 00569f92-eb28-0410-84fd-f71c24880f

src/com/dmdirc/actions/ActionSubstitutor.java

@@ -30,8 +30,8 @@ import com.dmdirc.ServerState;
 import com.dmdirc.config.IdentityManager;
 
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
+import java.util.Set;
 
 /**
  * Handles the substitution of variables into action targets and responses.
@@ -58,8 +58,8 @@ public class ActionSubstitutor {
      *
      * @return A list of global variable names that will be substituted
      */
-    public List<String> getConfigSubstitutions() {
-        return IdentityManager.getGlobalConfig().getOptions("actions");
+    public Set<String> getConfigSubstitutions() {
+        return IdentityManager.getGlobalConfig().getOptions("actions").keySet();
     }
     
     /**
@@ -68,9 +68,9 @@ public class ActionSubstitutor {
      * @param target The StringBuilder to modify
      */
     private void doConfigSubstitutions(final StringBuilder target) {
-        for (String option : IdentityManager.getGlobalConfig().getOptions("actions")) {
-            doReplacement(target, "$" + option,
-                    IdentityManager.getGlobalConfig().getOption("actions", option));
+        for (Map.Entry<String, String> option 
+                : IdentityManager.getGlobalConfig().getOptions("actions").entrySet()) {
+            doReplacement(target, "$" + option.getKey(), option.getValue());
         }
     }
     

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

@@ -139,11 +139,13 @@ public final class NickColourPlugin extends Plugin implements ActionListener {
      */
     @SuppressWarnings("unchecked")
     private void putColour(final Map map, final Color textColour, final Color nickColour) {
-        if (IdentityManager.getGlobalConfig().getOptionBool(DOMAIN, "settext", false) && textColour != null) {
+        if (IdentityManager.getGlobalConfig().getOptionBool(DOMAIN, "settext", false) 
+                && textColour != null) {
             map.put(ChannelClientProperty.TEXT_FOREGROUND, textColour);
         }
         
-        if (IdentityManager.getGlobalConfig().getOptionBool(DOMAIN, "setnicklist", false) && nickColour != null) {
+        if (IdentityManager.getGlobalConfig().getOptionBool(DOMAIN, "setnicklist", false) 
+                && nickColour != null) {
             map.put(ChannelClientProperty.NICKLIST_FOREGROUND, nickColour);
         }
     }
@@ -174,7 +176,7 @@ public final class NickColourPlugin extends Plugin implements ActionListener {
     public Object[][] getData() {
         final List<Object[]> data = new ArrayList<Object[]>();
         
-        for (String key : IdentityManager.getGlobalConfig().getOptions(DOMAIN)) {
+        for (String key : IdentityManager.getGlobalConfig().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));

src/com/dmdirc/addons/userlevel/UserLevelPlugin.java

@@ -72,6 +72,7 @@ public class UserLevelPlugin extends Plugin implements ActionListener,
     }
 
     /** {@inheritDoc} */
+    @Override
     public void processEvent(final ActionType type, final StringBuffer format,
                              final Object... arguments) {
         switch ((CoreActionType) type) {
@@ -127,8 +128,13 @@ public class UserLevelPlugin extends Plugin implements ActionListener,
     private void loadLevels() {
         LEVELS.clear();
         
-        for (String key : IdentityManager.getGlobalConfig().getOptions(DOMAIN)) {
-            LEVELS.put(key, IdentityManager.getGlobalConfig().getOptionInt(DOMAIN, key, 0));
+        for (Map.Entry<String, String> item 
+                : IdentityManager.getGlobalConfig().getOptions(DOMAIN).entrySet()) {
+            try {
+                LEVELS.put(item.getKey(), Integer.parseInt(item.getValue()));
+            } catch (NumberFormatException ex) {
+                LEVELS.put(item.getKey(), 0);
+            }
         }
     }
 

src/com/dmdirc/commandparser/commands/global/Set.java

@@ -129,7 +129,7 @@ public final class Set extends GlobalCommand implements IntelligentCommand {
         
         boolean found = false;
         
-        for (String option : manager.getOptions(domain)) {
+        for (String option : manager.getOptions(domain).keySet()) {
             output.append(option);
             output.append(", ");
             found = true;
@@ -254,13 +254,13 @@ public final class Set extends GlobalCommand implements IntelligentCommand {
                     || previousArgs.get(0).equalsIgnoreCase("--server")) {
                 res.addAll(IdentityManager.getGlobalConfig().getDomains());
             } else {
-                res.addAll(IdentityManager.getGlobalConfig().getOptions(previousArgs.get(0)));
+                res.addAll(IdentityManager.getGlobalConfig().getOptions(previousArgs.get(0)).keySet());
             }
             res.excludeAll();
         } else if (arg == 2 && (previousArgs.get(0).equalsIgnoreCase("--unset")
                 || previousArgs.get(0).equalsIgnoreCase("--append")
                 || previousArgs.get(0).equalsIgnoreCase("--server"))) {
-            res.addAll(IdentityManager.getGlobalConfig().getOptions(previousArgs.get(1)));
+            res.addAll(IdentityManager.getGlobalConfig().getOptions(previousArgs.get(1)).keySet());
             res.excludeAll();
         }
         

src/com/dmdirc/config/ConfigManager.java

@@ -28,6 +28,7 @@ import com.dmdirc.util.MapList;
 import java.io.Serializable;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.HashMap;
 import java.util.HashSet;
 import java.util.List;
 import java.util.Map;
@@ -137,25 +138,6 @@ public class ConfigManager extends ConfigSource implements Serializable,
         return false;
     }
 
-    /**
-     * Returns the name of all known options.
-     *
-     * @return A list of options
-     */
-    public Set<String> getOptions() {
-        final HashSet<String> res = new HashSet<String>();
-
-        synchronized (sources) {
-            for (Identity source : sources) {
-                for (String key : source.getOptions()) {
-                    res.add(key);
-                }
-            }
-        }
-
-        return res;
-    }
-
     /**
      * Returns the name of all the options in the specified domain. If the
      * domain doesn't exist, an empty list is returned.
@@ -163,12 +145,12 @@ public class ConfigManager extends ConfigSource implements Serializable,
      * @param domain The domain to search
      * @return A list of options in the specified domain
      */
-    public List<String> getOptions(final String domain) {
-        final ArrayList<String> res = new ArrayList<String>();
+    public Map<String, String> getOptions(final String domain) {
+        final Map<String, String> res = new HashMap<String, String>();
 
-        for (String key : getOptions()) {
-            if (key.startsWith(domain + ".")) {
-                res.add(key.substring(domain.length() + 1));
+        synchronized (sources) {
+            for (Identity source : sources) {
+                res.putAll(source.getOptions(domain));
             }
         }
 
@@ -297,17 +279,15 @@ public class ConfigManager extends ConfigSource implements Serializable,
      *
      * @return A list of domains known to this manager
      */
-    public List<String> getDomains() {
-        final ArrayList<String> res = new ArrayList<String>();
-        String domain;
-
-        for (String key : getOptions()) {
-            domain = key.substring(0, key.indexOf('.'));
-            if (!res.contains(domain)) {
-                res.add(domain);
+    public Set<String> getDomains() {
+        final Set<String> res = new HashSet<String>();
+
+        synchronized (sources) {
+            for (Identity source : sources) {
+                res.addAll(source.getDomains());
             }
         }
-
+        
         return res;
     }
 

src/com/dmdirc/config/Identity.java

@@ -35,12 +35,14 @@ import java.io.FileInputStream;
 import java.io.FileWriter;
 import java.io.IOException;
 import java.io.InputStream;
+import java.io.Reader;
 import java.io.Serializable;
 import java.net.MalformedURLException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
 import java.util.Properties;
+import java.util.Set;
 
 /**
  * An identity is a group of settings that are applied to a connection, server,
@@ -211,7 +213,9 @@ public class Identity extends ConfigSource implements Serializable,
             this.file.read();
         } catch (InvalidConfigFileException ex) {            
             final Properties properties = new Properties();
-            properties.load(new LineReader(this.file.getLines()));            
+            final Reader reader = new LineReader(this.file.getLines());
+            properties.load(reader);
+            reader.close();
             migrateProperties(properties);
         }
 
@@ -276,26 +280,6 @@ public class Identity extends ConfigSource implements Serializable,
         }
     }
 
-    /**
-     * Returns the properties object belonging to this identity.
-     *
-     * @return This identity's property object
-     * @deprecated Get a map
-     */
-    @Deprecated
-    public Properties getProperties() {
-        final Properties properties = new Properties();
-
-        for (Map.Entry<String, Map<String, String>> entry : file.getKeyDomains().entrySet()) {
-            for (Map.Entry<String, String> subentry : entry.getValue().entrySet()) {
-                properties.setProperty(entry.getKey() + "." + subentry.getKey(),
-                        subentry.getValue());
-            }
-        }
-
-        return properties;
-    }
-
     /**
      * Returns the name of this identity.
      *
@@ -431,24 +415,27 @@ public class Identity extends ConfigSource implements Serializable,
             listener.configChanged(domain, option);
         }
     }
-
+    
     /**
-     * Returns a list of options avaiable in this identity.
-     *
-     * @return Option list
-     * @deprecated Get a map
+     * Returns the set of domains available in this identity.
+     * 
+     * @since 0.6
+     * @return The set of domains used by this identity
      */
-    @Deprecated
-    public List<String> getOptions() {
-        final List<String> res = new ArrayList<String>();
-
-        for (Map.Entry<String, Map<String, String>> entry : file.getKeyDomains().entrySet()) {
-            for (String key : entry.getValue().keySet()) {
-                res.add(entry.getKey() + "." + key);
-            }
-        }
-
-        return res;
+    public Set<String> getDomains() {
+        return file.getKeyDomains().keySet();
+    }
+    
+    /**
+     * Retrieves a map of all options within the specified domain in this
+     * identity.
+     * 
+     * @param domain The domain to retrieve
+     * @since 0.6
+     * @return A map of option names to values
+     */
+    public Map<String, String> getOptions(final String domain) {
+        return file.getKeyDomain(domain);
     }
 
     /**

src/com/dmdirc/ui/swing/dialogs/actioneditor/ActionResponsePanel.java

@@ -24,7 +24,7 @@ package com.dmdirc.ui.swing.dialogs.actioneditor;
 
 import com.dmdirc.config.IdentityManager;
 
-import java.util.List;
+import java.util.Set;
 
 import javax.swing.BorderFactory;
 import javax.swing.DefaultComboBoxModel;
@@ -69,7 +69,8 @@ public class ActionResponsePanel extends JPanel {
         ((DefaultComboBoxModel) formatter.getModel()).addElement("No change");
         ((DefaultComboBoxModel) formatter.getModel()).addElement("No response");
         
-        final List<String> formatters = IdentityManager.getGlobalConfig().getOptions("formatter");
+        final Set<String> formatters
+                = IdentityManager.getGlobalConfig().getOptions("formatter").keySet();
         
         for (String format : formatters) {
             ((DefaultComboBoxModel) formatter.getModel()).addElement(format);

src/com/dmdirc/ui/swing/dialogs/actionseditor/ResponseTabPanel.java

@@ -32,7 +32,7 @@ import java.awt.Dimension;
 import java.awt.GridBagConstraints;
 import java.awt.GridBagLayout;
 import java.awt.Insets;
-import java.util.List;
+import java.util.Set;
 
 import javax.swing.BorderFactory;
 import javax.swing.DefaultComboBoxModel;
@@ -103,7 +103,8 @@ public final class ResponseTabPanel extends JPanel implements
         ((DefaultComboBoxModel) formatter.getModel()).addElement("No change");
         ((DefaultComboBoxModel) formatter.getModel()).addElement("No response");
         
-        final List<String> formatters = IdentityManager.getGlobalConfig().getOptions("formatter");
+        final Set<String> formatters
+                = IdentityManager.getGlobalConfig().getOptions("formatter").keySet();
         
         for (String format : formatters) {
             ((DefaultComboBoxModel) formatter.getModel()).addElement(format);

src/com/dmdirc/ui/swing/dialogs/prefs/URLConfigPanel.java

@@ -36,20 +36,20 @@ import com.dmdirc.ui.swing.components.URLProtocolPanel;
 import java.awt.event.ActionEvent;
 import java.awt.event.ActionListener;
 import java.net.URI;
-
 import java.net.URISyntaxException;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
+import java.util.Set;
+
 import javax.swing.JButton;
 import javax.swing.JPanel;
 import javax.swing.JScrollPane;
 import javax.swing.ListSelectionModel;
 import javax.swing.event.ListSelectionEvent;
 import javax.swing.event.ListSelectionListener;
-
 import javax.swing.table.TableCellRenderer;
+
 import net.miginfocom.swing.MigLayout;
 
 /**
@@ -139,8 +139,8 @@ public class URLConfigPanel extends JPanel implements ListSelectionListener,
 
         tableScrollPane.setViewportView(table);
 
-        final List<String> options = IdentityManager.getGlobalConfig().
-                getOptions("protocol");
+        final Set<String> options = IdentityManager.getGlobalConfig().
+                getOptions("protocol").keySet();
 
         for (String option : options) {
             try {
@@ -180,8 +180,8 @@ public class URLConfigPanel extends JPanel implements ListSelectionListener,
     public void save() {
         valueChanged(null);
         final Map<URI, String> handlers = model.getURLHandlers();
-        final List<String> protocols = IdentityManager.getGlobalConfig().
-                getOptions("protocol");
+        final Set<String> protocols = IdentityManager.getGlobalConfig().
+                getOptions("protocol").keySet();
         for (String protocol : protocols) {
             URI uri;
             try {

test/com/dmdirc/config/IdentityTest.java

@@ -23,10 +23,9 @@
 package com.dmdirc.config;
 
 import com.dmdirc.harness.TestConfigListener;
-import com.dmdirc.interfaces.ConfigChangeListener;
 
 import java.io.IOException;
-import java.util.Properties;
+import java.util.Map;
 
 import org.junit.After;
 import org.junit.Before;
@@ -51,21 +50,11 @@ public class IdentityTest {
         myIdent = null;
     }    
     
-    @Test
-    public void testGetProperties() {
-        myIdent.setOption("domain", "option", "value");
-        final Properties props = myIdent.getProperties();
-        
-        assertEquals(props.getProperty("domain.option"), "value");
-        
-        myIdent.unsetOption("domain", "option");
-    }
-
     @Test
     public void testGetName() {
-        final Properties props = myIdent.getProperties();
+        final Map<String, String> props = myIdent.getOptions("identity");
         
-        assertEquals(props.getProperty("identity.name"), myIdent.getName());
+        assertEquals(props.get("name"), myIdent.getName());
     }
     
     @Test
@@ -100,20 +89,20 @@ public class IdentityTest {
     @Test
     public void testGetOption() {
         myIdent.setOption("domain", "option", "value");
-        final Properties props = myIdent.getProperties();
+        final Map<String, String> props = myIdent.getOptions("domain");
         
-        assertEquals(props.getProperty("domain.option"), myIdent.getOption("domain", "option"));
+        assertEquals(props.get("option"), myIdent.getOption("domain", "option"));
         
         myIdent.unsetOption("domain", "option");
     }
 
     @Test
     public void testSetOption() {
-        final int count = myIdent.getProperties().size();
+        final int count = myIdent.getOptions("foo").size();
         
         myIdent.setOption("foo", "bar", "baz");
         
-        assertEquals(count + 1, myIdent.getProperties().size());
+        assertEquals(count + 1, myIdent.getOptions("foo").size());
         
         myIdent.unsetOption("foo", "bar");
     }
@@ -134,13 +123,16 @@ public class IdentityTest {
 
     @Test
     public void testRemoveOption() {
-        final Properties props = myIdent.getProperties();
+        final Map<String, String> props = myIdent.getOptions("foo");
         final int count = props.size();
         
         myIdent.setOption("foo", "bar", "baz");
+        
+        assertEquals(count + 1, myIdent.getOptions("foo").size());
+        
         myIdent.unsetOption("foo", "bar");
         
-        assertEquals(count, props.size());
+        assertEquals(count, myIdent.getOptions("foo").size());
     }
 
     @Test