Server list core merge

Issue 41

Change-Id: Ia3a38a768d0d53974dcca2d44e650e74b553b8dc
Reviewed-on: http://gerrit.dmdirc.com/1234
Automatic-Compile: DMDirc Local Commits <dmdirc@googlemail.com>
Reviewed-by: Gregory Holmes <greg@dmdirc.com>

src/com/dmdirc/config/ConfigManager.java

@@ -40,7 +40,8 @@ import java.util.logging.Level;
  *
  * @author chris
  */
-public class ConfigManager extends ConfigSource implements ConfigChangeListener {
+public class ConfigManager extends ConfigSource implements ConfigChangeListener,
+        IdentityListener {
 
     /** Temporary map for lookup stats. */
     private static final Map<String, Integer> stats = new TreeMap<String, Integer>();
@@ -244,8 +245,8 @@ public class ConfigManager extends ConfigSource implements ConfigChangeListener
         case CHANNEL:
             comp = channel;
             break;
-        case PROFILE:
-            // We don't want profiles
+        case CUSTOM:
+            // We don't want custom identities
             comp = null;
             break;
         default:
@@ -482,4 +483,17 @@ public class ConfigManager extends ConfigSource implements ConfigChangeListener
             listener.configChanged(domain, key);
         }
     }
+
+    /** {@inheritDoc} */
+    @Override
+    public void identityAdded(final Identity identity) {
+        checkIdentity(identity);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void identityRemoved(final Identity identity) {
+        removeIdentity(identity);
+    }
+    
 }

src/com/dmdirc/config/ConfigTarget.java

@@ -41,8 +41,6 @@ public class ConfigTarget implements Comparable<ConfigTarget>, Serializable {
         GLOBAL,
         /** Settings for a theme. */
         THEME,
-        /** Settings for a profile. */
-        PROFILE,
         /** Settings for an IRCd. */
         IRCD,
         /** Settings for a network. */
@@ -53,6 +51,8 @@ public class ConfigTarget implements Comparable<ConfigTarget>, Serializable {
         CHANNEL,
         /** Settings for a protocol (parser). */
         PROTOCOL,
+        /** A custom identity, which doesn't contain settings to be loaded. */
+        CUSTOM,
     }
 
     /**
@@ -112,10 +112,26 @@ public class ConfigTarget implements Comparable<ConfigTarget>, Serializable {
         data = "";
     }
 
-    /** Sets this target to be a profile source. */
-    public void setProfile() {
-        type = TYPE.PROFILE;
-        data = "";
+    /**
+     * Sets this target to be a custom identity.
+     * 
+     * @param customType The type of custom identity
+     * @since 0.6.4
+     */
+    public void setCustom(final String customType) {
+        type = TYPE.CUSTOM;
+        data = customType;
+    }
+
+    /**
+     * Determines if this target is the specified custom type.
+     *
+     * @param customType The type of custom identity
+     * @return True if this target is a CUSTOM type with the specified type.
+     * @since 0.6.4
+     */
+    public boolean isCustom(final String customType) {
+        return type == TYPE.CUSTOM && customType.equals(data);
     }
 
     /**
@@ -238,8 +254,8 @@ public class ConfigTarget implements Comparable<ConfigTarget>, Serializable {
             return "Global defaults";
         case THEME:
             return "Theme";
-        case PROFILE:
-            return "Profile";
+        case CUSTOM:
+            return "Custom: " + data;
         case IRCD:
             return "Ircd specific: " + data;
         case NETWORK:

src/com/dmdirc/config/Identity.java

@@ -100,7 +100,7 @@ public class Identity extends ConfigSource implements Comparable<Identity> {
         initFile(forceDefault);
         myTarget = getTarget(forceDefault);
 
-        if (myTarget.getType() == ConfigTarget.TYPE.PROFILE) {
+        if (myTarget.isCustom(PROFILE_DOMAIN)) {
             migrateProfile();
         }
     }
@@ -123,7 +123,7 @@ public class Identity extends ConfigSource implements Comparable<Identity> {
         initFile(forceDefault);
         myTarget = getTarget(forceDefault);
 
-        if (myTarget.getType() == ConfigTarget.TYPE.PROFILE) {
+        if (myTarget.isCustom(PROFILE_DOMAIN)) {
             migrateProfile();
         }
     }
@@ -141,7 +141,7 @@ public class Identity extends ConfigSource implements Comparable<Identity> {
         this.file.setAutomake(true);
         this.myTarget = target;
 
-        if (myTarget.getType() == ConfigTarget.TYPE.PROFILE) {
+        if (myTarget.isCustom(PROFILE_DOMAIN)) {
             migrateProfile();
         }
     }
@@ -172,7 +172,9 @@ public class Identity extends ConfigSource implements Comparable<Identity> {
         } else if (hasOption(DOMAIN, "global") || (forceDefault && !isProfile())) {
             target.setGlobal();
         } else if (isProfile()) {
-            target.setProfile();
+            target.setCustom(PROFILE_DOMAIN);
+        } else if (hasOption(DOMAIN, "type")) {
+            target.setCustom(getOption(DOMAIN, "type"));
         } else {
             throw new InvalidIdentityFileException("No target and no profile");
         }
@@ -566,6 +568,17 @@ public class Identity extends ConfigSource implements Comparable<Identity> {
         return file;
     }
 
+    /**
+     * Determines if this identity is loaded from the specified File.
+     *
+     * @param target The file to be checked
+     * @return True if this identity comes from the target file, false otherwise
+     * @since 0.6.4
+     */
+    public boolean isFile(final File target) {
+        return file != null && file.getFile() != null && file.getFile().equals(target);
+    }
+
     /**
      * Adds a new config change listener for this identity.
      *

src/com/dmdirc/config/IdentityListener.java

@@ -0,0 +1,50 @@
+/*
+ * 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.config;
+
+/**
+ * An interface of objects which are interested in identities being added
+ * and removed from the {@link IdentityManager}.
+ *
+ * @since 0.6.4
+ * @author chris
+ */
+public interface IdentityListener {
+
+    /**
+     * Called whenever a relevant new identity is added to the
+     * {@link IdentityManager}.
+     *
+     * @param identity The identity which has been added
+     */
+    void identityAdded(final Identity identity);
+
+    /**
+     * Called whenever a relevant identity is removed from the
+     * {@link IdentityManager}.
+     *
+     * @param identity The identity which has been removed
+     */
+    void identityRemoved(final Identity identity);
+
+}

src/com/dmdirc/config/IdentityManager.java

@@ -29,7 +29,8 @@ import com.dmdirc.logger.Logger;
 import com.dmdirc.updater.Version;
 import com.dmdirc.util.ConfigFile;
 import com.dmdirc.util.InvalidConfigFileException;
-import com.dmdirc.util.WeakList;
+import com.dmdirc.util.MapList;
+import com.dmdirc.util.WeakMapList;
 import com.dmdirc.util.resourcemanager.ResourceManager;
 
 import java.io.File;
@@ -37,8 +38,10 @@ import java.io.IOException;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.HashMap;
+import java.util.LinkedHashSet;
 import java.util.List;
 import java.util.Map;
+import java.util.Set;
     
 /**
  * The identity manager manages all known identities, providing easy methods
@@ -48,11 +51,23 @@ import java.util.Map;
  */
 public final class IdentityManager {
     
-    /** The identities that have been loaded into this manager. */
-    private final static List<Identity> identities = new ArrayList<Identity>();
+    /**
+     * The identities that have been loaded into this manager.
+     * 
+     * Standard identities are inserted with a <code>null</code> key, custom
+     * identities use their custom type as the key.
+     */
+    private static final MapList<String, Identity> identities
+            = new MapList<String, Identity>();
     
-    /** The config managers that have registered with this manager. */
-    private final static List<ConfigManager> managers = new WeakList<ConfigManager>();
+    /**
+     * The {@link IdentityListener}s that have registered with this manager.
+     * 
+     * Listeners for standard identities are inserted with a <code>null</code>
+     * key, listeners for a specific custom type use their type as the key.
+     */
+    private static final MapList<String, IdentityListener> listeners
+            = new WeakMapList<String, IdentityListener>();
 
     /** A logger for this class. */
     private static final java.util.logging.Logger LOGGER = java.util.logging
@@ -82,12 +97,7 @@ public final class IdentityManager {
      */
     public static void load() throws InvalidIdentityFileException {
         identities.clear();
-        managers.clear();
-        
-        if (globalconfig != null) {
-            // May have been created earlier
-            managers.add(globalconfig);
-        }
+        identities.clear();
 
         loadVersion();
         loadDefaults();
@@ -258,11 +268,10 @@ public final class IdentityManager {
      * 
      * @param file The file to load the identity from.
      */
-    @SuppressWarnings("deprecation")
     private static void loadIdentity(final File file) {
         synchronized (identities) {
-            for (Identity identity : identities) {
-                if (file.equals(identity.getFile().getFile())) {
+            for (Identity identity : getAllIdentities()) {
+                if (identity.isFile(file)) {
                     try {
                         identity.reload();
                     } catch (IOException ex) {
@@ -291,6 +300,36 @@ public final class IdentityManager {
         }
     }
 
+    /**
+     * Retrieves all known identities.
+     *
+     * @return A set of all known identities
+     * @since 0.6.4
+     */
+    private static Set<Identity> getAllIdentities() {
+        final Set<Identity> res = new LinkedHashSet<Identity>();
+
+        for (Map.Entry<String, List<Identity>> entry : identities.entrySet()) {
+            res.addAll(entry.getValue());
+        }
+
+        return res;
+    }
+
+    /**
+     * Returns the "group" to which the specified identity belongs. For custom
+     * identities this is the custom identity type, otherwise this is
+     * <code>null</code>.
+     *
+     * @param identity The identity whose group is being retrieved
+     * @return The group of the specified identity
+     * @since 0.6.4
+     */
+    private static String getGroup(final Identity identity) {
+        return identity.getTarget().getType() == ConfigTarget.TYPE.CUSTOM
+                ? identity.getTarget().getData() : null;
+    }
+
     /** Loads the version information. */
     public static void loadVersion() {
         try {
@@ -307,7 +346,7 @@ public final class IdentityManager {
      * Loads the config identity.
      * 
      * @throws InvalidIdentityFileException if there is a problem with the
-     *                                      config file.
+     * config file.
      */
     private static void loadConfig() throws InvalidIdentityFileException {
         try {
@@ -360,7 +399,7 @@ public final class IdentityManager {
      */
     public static void save() {
         synchronized (identities) {
-            for (Identity identity : identities) {
+            for (Identity identity : getAllIdentities()) {
                 identity.save();
             }
         }
@@ -373,20 +412,22 @@ public final class IdentityManager {
     @Precondition("The specified Identity is not null")
     public static void addIdentity(final Identity identity) {
         Logger.assertTrue(identity != null);
-        
-        if (identities.contains(identity)) {
+
+        final String target = getGroup(identity);
+
+        if (identities.containsValue(target, identity)) {
             removeIdentity(identity);
         }
-        
+
         synchronized (identities) {
-            identities.add(identity);
+            identities.add(target, identity);
         }
 
-        LOGGER.finer("Adding identity: " + identity);
-        
-        synchronized (managers) {
-            for (ConfigManager manager : managers) {
-                manager.checkIdentity(identity);
+        LOGGER.finer("Adding identity: " + identity + " (group: " + target + ")");
+
+        synchronized (listeners) {
+            for (IdentityListener listener : listeners.safeGet(target)) {
+                listener.identityAdded(identity);
             }
         }
     }
@@ -401,48 +442,84 @@ public final class IdentityManager {
     })
     public static void removeIdentity(final Identity identity) {
         Logger.assertTrue(identity != null);
-        Logger.assertTrue(identities.contains(identity));
+
+        final String group = getGroup(identity);
+
+        Logger.assertTrue(identities.containsValue(group, identity));
         
         synchronized (identities) {
-            identities.remove(identity);
+            identities.remove(group, identity);
         }
         
-        synchronized (managers) {
-            for (ConfigManager manager : managers) {
-                manager.removeIdentity(identity);
+        synchronized (listeners) {
+            for (IdentityListener listener : listeners.safeGet(group)) {
+                listener.identityRemoved(identity);
             }
         }
     }
     
     /**
      * Adds a config manager to this manager.
+     *
      * @param manager The ConfigManager to add
+     * @deprecated Use {@link #addIdentityListener(com.dmdirc.config.IdentityListener)}
      */
+    @Deprecated
     @Precondition("The specified ConfigManager is not null")
     public static void addConfigManager(final ConfigManager manager) {
-        Logger.assertTrue(manager != null);
+        addIdentityListener(manager);
+    }
+
+    /**
+     * Adds a new identity listener which will be informed of all settings
+     * identities which are added to this manager.
+     *
+     * @param listener The listener to be added
+     * @since 0.6.4
+     */
+    @Precondition("The specified listener is not null")
+    public static void addIdentityListener(final IdentityListener listener) {
+        addIdentityListener(null, listener);
+    }
+
+    /**
+     * Adds a new identity listener which will be informed of all identities
+     * of the specified custom type which are added to this manager.
+     *
+     * @param type The type of identities to listen for
+     * @param listener The listener to be added
+     * @since 0.6.4
+     */
+    @Precondition("The specified listener is not null")
+    public static void addIdentityListener(final String type, final IdentityListener listener) {
+        Logger.assertTrue(listener != null);
         
-        synchronized (managers) {
-            managers.add(manager);
+        synchronized (listeners) {
+            listeners.add(type, listener);
         }
     }
     
     /**
      * Retrieves a list of identities that serve as profiles.
+     *
      * @return A list of profiles
+     * @deprecated Use {@link #getCustomIdentities(java.lang.String)} with
+     * an argument of <code>profile</code> to retrieve profiles.
      */
+    @Deprecated
     public static List<Identity> getProfiles() {
-        final List<Identity> profiles = new ArrayList<Identity>();
-        
-        synchronized (identities) {
-            for (Identity identity : identities) {
-                if (identity.isProfile()) {
-                    profiles.add(identity);
-                }
-            }
-        }
-        
-        return profiles;
+        return getCustomIdentities("profile");
+    }
+
+    /**
+     * Retrieves a list of identities that belong to the specified custom type.
+     *
+     * @param type The type of identity to search for
+     * @return A list of matching identities
+     * @since 0.6.4
+     */
+    public static List<Identity> getCustomIdentities(final String type) {
+        return Collections.unmodifiableList(identities.safeGet(type));
     }
     
     /**
@@ -457,7 +534,7 @@ public final class IdentityManager {
         final List<Identity> sources = new ArrayList<Identity>();
         
         synchronized (identities) {
-            for (Identity identity : identities) {
+            for (Identity identity : identities.safeGet(null)) {
                 if (manager.identityApplies(identity)) {
                     sources.add(identity);
                 }
@@ -508,7 +585,7 @@ public final class IdentityManager {
         final String myTarget = (channel + "@" + network).toLowerCase();
         
         synchronized (identities) {
-            for (Identity identity : identities) {
+            for (Identity identity : identities.safeGet(null)) {
                 if (identity.getTarget().getType() == ConfigTarget.TYPE.CHANNEL
                         && identity.getTarget().getData().equalsIgnoreCase(myTarget)) {
                     return identity;
@@ -545,7 +622,7 @@ public final class IdentityManager {
         final String myTarget = network.toLowerCase();
         
         synchronized (identities) {
-            for (Identity identity : identities) {
+            for (Identity identity : identities.safeGet(null)) {
                 if (identity.getTarget().getType() == ConfigTarget.TYPE.NETWORK
                         && identity.getTarget().getData().equalsIgnoreCase(myTarget)) {
                     return identity;
@@ -582,7 +659,7 @@ public final class IdentityManager {
         final String myTarget = server.toLowerCase();
         
         synchronized (identities) {
-            for (Identity identity : identities) {
+            for (Identity identity : identities.safeGet(null)) {
                 if (identity.getTarget().getType() == ConfigTarget.TYPE.SERVER
                         && identity.getTarget().getData().equalsIgnoreCase(myTarget)) {
                     return identity;

src/com/dmdirc/serverlists/ServerEntry.java

@@ -0,0 +1,113 @@
+/*
+ * 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.serverlists;
+
+import com.dmdirc.Server;
+import com.dmdirc.config.Identity;
+import com.dmdirc.config.IdentityManager;
+import java.net.URI;
+
+/**
+ * Describes an entry for a server within a {@link ServerGroup}.
+ *
+ * @since 0.6.4
+ * @author chris
+ */
+public class ServerEntry implements ServerGroupItem {
+
+    /** The address of the server in question. */
+    private URI address;
+    /** The user-friendly name of the server. */
+    private String name;
+    /** The name of the profile to use. */
+    private String profile;
+
+    /**
+     * Creates a new server entry.
+     *
+     * @param name The name of this server
+     * @param address The address of this server
+     * @param profile The name of the profile to be used by this server
+     */
+    public ServerEntry(final String name, final URI address, final String profile) {
+        this.name = name;
+        this.address = address;
+        this.profile = profile;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Retrieves the address used by this server.
+     *
+     * @return This server's address
+     */
+    @Override
+    public URI getAddress() {
+        return address;
+    }
+
+    /**
+     * Retrieves the name of the profile which should be used when connecting
+     * to this server.
+     *
+     * @return The profile name used by this entry
+     */
+    public String getProfile() {
+        return profile;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void connect() {
+        final Server server = new Server(address, getProfileIdentity());
+        server.connect();
+    }
+
+    /**
+     * Returns the {@link Identity} which corresponds to this server's desired
+     * profile.
+     *
+     * @return This server's profile identity
+     */
+    protected Identity getProfileIdentity() {
+        for (Identity identity : IdentityManager.getProfiles()) {
+            if (profile.equals(identity.getName())) {
+                return identity;
+            }
+        }
+
+        return IdentityManager.getProfiles().get(0);
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String toString() {
+        return "[" + getName() + ": address: " + getAddress() + "]";
+    }
+
+}

src/com/dmdirc/serverlists/ServerGroup.java

@@ -0,0 +1,186 @@
+/*
+ * 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.serverlists;
+
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * A server group contains an ordered collection of server entries or other
+ * server groups.
+ *
+ * @since 0.6.4
+ * @author chris
+ */
+public class ServerGroup implements ServerGroupItem {
+
+    /** The name of the group. */
+    private String name;
+
+    /** A description of this group. */
+    private String description = "";
+
+    /** A set of links relevant to this group (e.g. homepages). */
+    private Map<String, URI> links = new HashMap<String, URI>();
+    
+    /** The items contained within the group. */
+    private final List<ServerGroupItem> entries = new ArrayList<ServerGroupItem>();
+
+    /**
+     * Creates a new server group with the specified name.
+     *
+     * @param name The name to be used for this group
+     */
+    public ServerGroup(final String name) {
+        this.name = name;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Sets the name of this group.
+     *
+     * @param name The new name for the group
+     */
+    public void setName(final String name) {
+        this.name = name;
+    }
+
+    /**
+     * Adds a new item to this server group.
+     *
+     * @param item The item to be added
+     */
+    public void addItem(final ServerGroupItem item) {
+        entries.add(item);
+    }
+
+    /**
+     * Retrieves a list of items belonging to this group.
+     *
+     * @return An immutable list of items contained within this group
+     */
+    public List<ServerGroupItem> getItems() {
+        return Collections.unmodifiableList(entries);
+    }
+
+    /**
+     * Retrieves a ServerGroupItem with the specified name, if one exists. This
+     * method ignores the case of item's name when comparing.
+     *
+     * @param name The name of the item to be retrieved
+     * @return A correspondingly named item, or null if none exists
+     */
+    public ServerGroupItem getItemByName(final String name) {
+        for (ServerGroupItem item : getItems()) {
+            if (item.getName().equalsIgnoreCase(name)) {
+                return item;
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * Retrieves the description of this group.
+     * 
+     * @return This group's description
+     */
+    public String getDescription() {
+        return description;
+    }
+
+    /**
+     * Sets the description of this group.
+     *
+     * @param description The new description for this group.
+     */
+    public void setDescription(final String description) {
+        this.description = description;
+    }
+
+    /**
+     * Retrieves a map of link titles to {@link URI}s which are associated
+     * with this server group. Links will typically include network homepages,
+     * forums, or support channels.
+     * 
+     * @return An immutable map of links
+     */
+    public Map<String, URI> getLinks() {
+        return Collections.unmodifiableMap(links);
+    }
+
+    /**
+     * Adds a new link with the specified title and address. If a link with the
+     * same title existed previously, it will be replaced.
+     *
+     * @param title The title of the new link
+     * @param address The address of the link
+     */
+    public void addLink(final String title, final URI address) {
+        links.put(title, address);
+    }
+
+    /**
+     * {@inheritDoc}
+     *
+     * Current implementation just selects the first item in this group and
+     * asks for its URI.
+     */
+    @Override
+    public URI getAddress() {
+        if (!entries.isEmpty()) {
+            return entries.get(0).getAddress();
+        }
+
+        return null;
+    }
+
+    /**
+     * {@inheritDoc}
+     * 
+     * Current implementation just selects the first item in this group and
+     * asks it to connect.
+     */
+    @Override
+    public void connect() {
+        if (!entries.isEmpty()) {
+            entries.get(0).connect();
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String toString() {
+        return "[" + getName() + ": links: " + getLinks() + "; desc: "
+                + getDescription() + "; content: " + getItems() + "]";
+    }
+}

src/com/dmdirc/serverlists/ServerGroupItem.java

@@ -0,0 +1,55 @@
+/*
+ * 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.serverlists;
+
+import java.net.URI;
+
+/**
+ * An item which is included in a server group.
+ *
+ * @author chris
+ * @since 0.6.4
+ */
+public interface ServerGroupItem {
+
+    /**
+     * Retrieves the name of this item.
+     *
+     * @return A string containing this item's name
+     */
+    String getName();
+
+    /**
+     * Initiates a connection attempt for this item.
+     */
+    void connect();
+
+    /**
+     * Retrieves a URI for this item.
+     *
+     * @return A URI that represents this item or one of its children, or null
+     * if the item has no URIs associated with it.
+     */
+    URI getAddress();
+
+}

src/com/dmdirc/serverlists/ServerList.java

@@ -0,0 +1,107 @@
+/*
+ * 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.serverlists;
+
+import com.dmdirc.serverlists.io.ServerGroupReader;
+import com.dmdirc.config.Identity;
+import com.dmdirc.config.IdentityListener;
+import com.dmdirc.config.IdentityManager;
+import com.dmdirc.serverlists.service.ServerListServiceProvider;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.List;
+
+/**
+ * Maintains a list of top level {@link ServerGroup}s and handles reading and
+ * writing of the lists to disk.
+ * 
+ * @since 0.6.4
+ * @author chris
+ */
+public class ServerList implements IdentityListener {
+
+    /** A list of all known groups. */
+    private final List<ServerGroup> groups = new ArrayList<ServerGroup>();
+
+    /**
+     * Creates a new ServerList and loads groups and servers.
+     */
+    public ServerList() {
+        IdentityManager.addIdentityListener("servergroup", this);
+
+        for (Identity identity : IdentityManager.getCustomIdentities("servergroup")) {
+            identityAdded(identity);
+        }
+
+        new ServerListServiceProvider(this).register();
+    }
+
+    /**
+     * Adds a server group to the master server list.
+     *
+     * @param group The group to be added
+     */
+    public void addServerGroup(final ServerGroup group) {
+        groups.add(group);
+    }
+
+    /**
+     * Retrieves a list of all known server groups.
+     *
+     * @return An immutable list of server groups.
+     */
+    public List<ServerGroup> getServerGroups() {
+        return Collections.unmodifiableList(groups);
+    }
+
+    /**
+     * Retrieves a ServerGroup with the specified name, if one exists. This
+     * method ignores the case of group's name when comparing.
+     *
+     * @param name The name of the group to be retrieved
+     * @return A correspondingly named server group, or null if none exists
+     */
+    public ServerGroup getGroupByName(final String name) {
+        for (ServerGroup group : getServerGroups()) {
+            if (group.getName().equalsIgnoreCase(name)) {
+                return group;
+            }
+        }
+
+        return null;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void identityAdded(final Identity identity) {
+        addServerGroup(new ServerGroupReader(identity).read());
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void identityRemoved(final Identity identity) {
+        // TODO: Remove server group
+    }
+
+}

src/com/dmdirc/serverlists/io/ServerEntryReader.java

@@ -0,0 +1,75 @@
+/*
+ * 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.serverlists.io;
+
+import com.dmdirc.config.Identity;
+import com.dmdirc.serverlists.ServerEntry;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+
+/**
+ * Facilitates loading of a {@link ServerEntry} from a DMDirc {@link Identity}.
+ *
+ * @since 0.6.4
+ * @author chris
+ */
+public class ServerEntryReader {
+
+    /** The identity to read entries from. */
+    private final Identity identity;
+
+    /**
+     * Creates a new Server Entry Reader which will read from the specified
+     * identity.
+     *
+     * @param identity The identity which defines our server entries
+     */
+    public ServerEntryReader(final Identity identity) {
+        this.identity = identity;
+    }
+
+    /**
+     * Attempts to read the details of the specified server from this reader's
+     * identity.
+     *
+     * @param name The name of the server to be read
+     * @return A corresponding ServerGroup
+     * @throws URISyntaxException If the server doesn't specify a valid URI
+     * @throws IllegalArgumentException If the server doesn't define a name or address
+     */
+    public ServerEntry read(final String name) throws URISyntaxException,
+            IllegalArgumentException {
+        if (!identity.hasOptionString(name, "name")
+                || !identity.hasOptionString(name, "address")) {
+            throw new IllegalArgumentException("Server does not specify name or address: "
+                    + name);
+        }
+
+        final String serverName = identity.getOption(name, "name");
+        final URI serverURI = new URI(identity.getOption(name, "address"));
+
+        return new ServerEntry(serverName, serverURI, null);
+    }
+
+}

src/com/dmdirc/serverlists/io/ServerGroupReader.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.serverlists.io;
+
+import com.dmdirc.config.Identity;
+import com.dmdirc.serverlists.ServerGroup;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.Map;
+
+/**
+ * Facilitates loading of a {@link ServerGroup} from a DMDirc {@link Identity}.
+ *
+ * @since 0.6.4
+ * @author chris
+ */
+public class ServerGroupReader {
+
+    /** The identity this reader should read from. */
+    private final Identity identity;
+
+    /** The reader we'll use for individual servers. */
+    private final ServerEntryReader entryReader;
+
+    /**
+     * Creates a new ServerGroupReader that will read from the specified
+     * identity.
+     *
+     * @param identity The identity describing the server group
+     */
+    public ServerGroupReader(final Identity identity) {
+        this.identity = identity;
+        this.entryReader = new ServerEntryReader(identity);
+    }
+
+    /**
+     * Reads the default server group from this reader's identity.
+     *
+     * @see #read(java.lang.String)
+     * @return A ServerGroup corresponding to the identity's default group
+     * @throws IllegalArgumentException If the identity doesn't define a group
+     */
+    public ServerGroup read() {
+        if (identity.hasOptionString("identity", "name")) {
+            return read(identity.getOption("identity", "name"));
+        }
+
+        throw new IllegalArgumentException("Identity has no name");
+    }
+
+    /**
+     * Reads a named server group from this reader's identity.
+     *
+     * @param name The name of the server group to read
+     * @return A corresponding ServerGroup
+     * @throws IllegalArgumentException If the server group doesn't define a name
+     */
+    public ServerGroup read(final String name) throws IllegalArgumentException {
+        if (!identity.hasOptionString(name, "name")) {
+            throw new IllegalArgumentException("ServerGroup '" + name + "' not defined");
+        }
+
+        final ServerGroup group = new ServerGroup(identity.getOption(name, "name"));
+
+        if (identity.hasOptionString(name, "description")) {
+            group.setDescription(identity.getOption(name, "description"));
+        }
+
+        if (identity.hasOptionString(name, "links")) {
+            readLinks(group, identity.getOption(name, "links"));
+        }
+
+        for (String item : identity.getOptionList(name, "contents", true)) {
+            if (item.endsWith(" servergroup")) {
+                try {
+                    group.addItem(read(item));
+                } catch (IllegalArgumentException ex) {
+                    // TODO: Raise an error about malformed group
+                }
+            } else if (item.endsWith(" server")) {
+                try {
+                    group.addItem(entryReader.read(item));
+                } catch (URISyntaxException ex) {
+                    // TODO: Raise an error about malformed server
+                } catch (IllegalArgumentException ex) {
+                    // TODO: Raise an error about malformed server
+                }
+            }
+
+            // TODO: Raise an error about unknown content?
+        }
+
+        return group;
+    }
+
+    /**
+     * Reads a set of links from the named domain and adds them to the specified
+     * group.
+     *
+     * @param group The group to add links to
+     * @param domain The domain in the identity containing links
+     */
+    private void readLinks(final ServerGroup group, final String domain) {
+        for (Map.Entry<String, String> entry : identity.getOptions(domain).entrySet()) {
+            try {
+                group.addLink(entry.getKey(), new URI(entry.getValue()));
+            } catch (URISyntaxException ex) {
+                // TODO: Raise an error about illegal URI?
+            }
+        }
+    }
+
+}

src/com/dmdirc/serverlists/service/ServerListServiceProvider.java

@@ -0,0 +1,152 @@
+/*
+ * 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.serverlists.service;
+
+import com.dmdirc.ParserFactory;
+import com.dmdirc.parser.common.MyInfo;
+import com.dmdirc.parser.interfaces.Parser;
+import com.dmdirc.plugins.ExportedService;
+import com.dmdirc.plugins.PluginManager;
+import com.dmdirc.plugins.Service;
+import com.dmdirc.plugins.ServiceProvider;
+
+import com.dmdirc.serverlists.ServerGroup;
+import com.dmdirc.serverlists.ServerGroupItem;
+import com.dmdirc.serverlists.ServerList;
+import java.net.URI;
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * Provides a fake parser service which handles <code>serverlist://</code> URIs,
+ * and returns a suitable parser for the corresponding server list.
+ *
+ * @author chris
+ * @since 0.6.4
+ */
+public class ServerListServiceProvider implements ServiceProvider {
+
+    /** The server list that we're providing for. */
+    private final ServerList serverList;
+
+    /** The services that this provider providers. */
+    private final List<Service> services;
+
+    /**
+     * Creates a new server list service provider.
+     *
+     * @param serverList The {@link ServerList} to retrieve items from
+     */
+    public ServerListServiceProvider(final ServerList serverList) {
+        this.serverList = serverList;
+        this.services = Arrays.asList(new Service[] {
+           PluginManager.getPluginManager().getService("parser", "serverlist", true)
+        });
+    }
+
+    /**
+     * Registers this service provider.
+     */
+    public void register() {
+        for (Service service : services) {
+            service.addProvider(this);
+        }
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public boolean isActive() {
+        return true;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public void activateServices() {
+        // Do nothing
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public List<Service> getServices() {
+        return services;
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public String getProviderName() {
+        return "Serverlist service provider";
+    }
+
+    /** {@inheritDoc} */
+    @Override
+    public ExportedService getExportedService(final String name) {
+        if ("getParser".equals(name)) {
+            return new ExportedService(ServerListServiceProvider.class, "getParser", this);
+        } else {
+            return new ExportedService(null, null);
+        }
+    }
+
+    /**
+     * Retrieves a parser for the specified details.
+     *
+     * @param myInfo The user-supplied client identification information
+     * @param address The address to connect to (a serverlist:// URI)
+     * @return A corresponding Parser instance, or null if none applicable
+     */
+    public Parser getParser(final MyInfo myInfo, final URI address) {
+        ServerGroup group = serverList.getGroupByName(address.getHost());
+
+        if (address.getPath() != null && !address.getPath().isEmpty()) {
+            for (String part : address.getPath().split("/")) {
+                if (part.isEmpty()) {
+                    continue;
+                }
+
+                final ServerGroupItem item = group.getItemByName(part);
+
+                if (item == null) {
+                    return null;
+                } else if (item instanceof ServerGroup) {
+                    group = (ServerGroup) item;
+                } else {
+                    return getParserForItem(myInfo, item);
+                }
+            }
+        }
+
+        return getParserForItem(myInfo, group);
+    }
+
+    /**
+     * Retrieves a parser for the specified item.
+     *
+     * @param myInfo The user-supplied client identification information
+     * @param item The item to retrieve a URI from
+     * @return A corresponding parser instance
+     */
+    protected Parser getParserForItem(final MyInfo myInfo, final ServerGroupItem item) {
+        return new ParserFactory().getParser(myInfo, item.getAddress());
+    }
+
+}