Add ServerTypeGroup to allow grouping of servers with common behaviour. (Fixes issue 3491).

Switch everything that does something on a per-ircd basis to use ServerTypes not Strings.
Deprecate getIRCD() in favour of getServerSoftware() and getServerSoftwareType().

Change-Id: I324eaadeb39a9999f7dd9d7b8e6bd583dce7abca
Reviewed-on: http://gerrit.dmdirc.com/431
Reviewed-by: Chris Smith <chris@dmdirc.com>
Tested-by: Chris Smith <chris@dmdirc.com>

src/com/dmdirc/parser/irc/IRCChannelInfo.java

@@ -496,7 +496,7 @@ public class IRCChannelInfo implements ChannelInfo {
         // Hyperion sucks.
         if (cMode == 'b' || cMode == 'q') {
             final ServerType serverType = myParser.getServerType();
-            if ((serverType == ServerType.DANCER || serverType == ServerType.HYPERION)) {
+            if (ServerTypeGroup.FREENODE.isMember(serverType)) {
                 if (cMode == 'b' && givenItem.getItem().charAt(0) == '%') {
                     cMode = 'q';
                 } else if (cMode == 'q' && givenItem.getItem().charAt(0) != '%') {

src/com/dmdirc/parser/irc/IRCParser.java

@@ -1198,9 +1198,9 @@ public class IRCParser implements SecureParser, Runnable {
         String[] bits = null;
         String modeStr;
         if (h005Info.containsKey("USERCHANMODES")) {
-            if (getIRCD(true).equalsIgnoreCase("dancer")) {
+            if (getServerType() == ServerType.DANCER) {
                 sDefaultModes.insert(0, "dqeI");
-            } else if (getIRCD(true).equalsIgnoreCase("austirc")) {
+            } else if (getServerType() == ServerType.AUSTIRC) {
                 sDefaultModes.insert(0, "e");
             }
             modeStr = h005Info.get("USERCHANMODES");
@@ -1630,7 +1630,7 @@ public class IRCParser implements SecureParser, Runnable {
             try {
                 result = Integer.parseInt(h005Info.get("MAXBANS"));
             } catch (NumberFormatException nfe) { result = -1; }
-        } else if (result == -2 && getIRCD(true).equalsIgnoreCase("weircd")) {
+        } else if (result == -2 && getServerType() == ServerType.WEIRCD) {
             // -_-
             result = 50;
         } else if (result == -2) {
@@ -1779,26 +1779,29 @@ public class IRCParser implements SecureParser, Runnable {
      *
      * @param getType if this is false the string from 004 is returned. Else a guess of the type (ircu, hybrid, ircnet)
      * @return IRCD Version or Type
+     * @deprecated Use getServerSoftware() or getServerSoftwareType() instead.
      */
+    @Deprecated
     public String getIRCD(final boolean getType) {
         if (getType) {
-            return getServerType().getType();
+            return getServerSoftwareType();
         } else {
-            final String version = h005Info.get("004IRCD");
-            return (version == null) ? "" : version;
+            return getServerSoftware();
         }
     }
 
+
     /** {@inheritDoc} */
     @Override
     public String getServerSoftware() {
-        return getIRCD(false);
+        final String version = h005Info.get("004IRCD");
+        return (version == null) ? "" : version;
     }
 
     /** {@inheritDoc} */
     @Override
     public String getServerSoftwareType() {
-        return getIRCD(true);
+        return getServerType().getType();
     }
 
     /**

src/com/dmdirc/parser/irc/Process004005.java

@@ -143,8 +143,8 @@ public class Process004005 extends IRCProcessor {
      */
     protected boolean callGotNetwork() {
         final String networkName = myParser.networkName;
-        final String ircdVersion = myParser.getIRCD(false);
-        final String ircdType = myParser.getIRCD(true);
+        final String ircdVersion = myParser.getServerSoftware();
+        final String ircdType = myParser.getServerSoftwareType();
         
         return getCallbackManager().getCallbackType(NetworkDetectedListener.class).call(networkName, ircdVersion, ircdType);
     }

src/com/dmdirc/parser/irc/ProcessListModes.java

@@ -82,11 +82,11 @@ public class ProcessListModes extends IRCProcessor {
                 mode = 'R';
             }
             isItem = sParam.equals("344");
-        } else if ((serverType == ServerType.SWIFTIRC || serverType == ServerType.AUSTHEX8) && (sParam.equals("386") || sParam.equals("387"))) {
+        } else if (ServerTypeGroup.OWNER_386.isMember(serverType) && (sParam.equals("386") || sParam.equals("387"))) {
             // Channel Owner list
             mode = 'q';
             isItem = sParam.equals("387");
-        } else if ((serverType == ServerType.SWIFTIRC || serverType == ServerType.AUSTHEX8) && (sParam.equals("388") || sParam.equals("389"))) {
+        } else if (ServerTypeGroup.PROTECTED_388.isMember(serverType) && (sParam.equals("388") || sParam.equals("389"))) {
             // Protected User list
             mode = 'a';
             isItem = sParam.equals("389");
@@ -118,7 +118,7 @@ public class ProcessListModes extends IRCProcessor {
                     //
                     // Only raise an LMQ error if the lmqmode isn't one of bdq if the
                     // guess is one of bdq
-                    if ((serverType == ServerType.DANCER || serverType == ServerType.HYPERION) && (mode == 'b' || mode == 'q' || mode == 'd')) {
+                    if (ServerTypeGroup.FREENODE.isMember(serverType) && (mode == 'b' || mode == 'q' || mode == 'd')) {
                         LinkedList<Character> lmq = (LinkedList<Character>)listModeQueue;
                         if (mode == 'b') {
                             error = !(oldMode == 'q' || oldMode == 'd');
@@ -131,7 +131,7 @@ public class ProcessListModes extends IRCProcessor {
                         } else if (mode == 'd') {
                             error = !(oldMode == 'b' || oldMode == 'q');
                         }
-                    } else if ((serverType == ServerType.IRCD_SEVEN || serverType == ServerType.CHARYBDIS) && (mode == 'b' || mode == 'q')) {
+                    } else if (ServerTypeGroup.CHARYBDIS.isMember(serverType) && (mode == 'b' || mode == 'q')) {
                         // Finally freenode appear to have an ircd which isn't completely annoying.
                         // Only error if the LMQ thinks the mode should be
                         // something thats not the other one of these 2 modes.
@@ -154,7 +154,7 @@ public class ProcessListModes extends IRCProcessor {
         }
         
         if (isItem) {
-            if ((!isCleverMode) && listModeQueue == null && (serverType == ServerType.DANCER || serverType == ServerType.HYPERION) && token.length > 4 && mode == 'b') {
+            if ((!isCleverMode) && listModeQueue == null && ServerTypeGroup.FREENODE.isMember(serverType) && token.length > 4 && mode == 'b') {
                 // Assume mode is a 'd' mode
                 mode = 'd';
                 // Now work out if its not (or attempt to.)
@@ -174,7 +174,7 @@ public class ProcessListModes extends IRCProcessor {
                     myParser.callErrorInfo(new ParserError(ParserError.ERROR_WARNING, "Got list mode: '"+mode+"' - but channel object doesn't agree.", myParser.getLastLine()));
                 } else {
                     list.clear();
-                    if ((serverType == ServerType.DANCER || serverType == ServerType.HYPERION) && (mode == 'b' || mode == 'q')) {
+                    if (ServerTypeGroup.FREENODE.isMember(serverType) && (mode == 'b' || mode == 'q')) {
                         // Also clear the other list if b or q.
                         final Character otherMode = (mode == 'b') ? 'q' : 'b';
                         

src/com/dmdirc/parser/irc/ServerType.java

@@ -1,16 +1,16 @@
 /*
  *  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

src/com/dmdirc/parser/irc/ServerTypeGroup.java

@@ -0,0 +1,95 @@
+/*
+ *  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.parser.irc;
+
+import java.util.Arrays;
+import java.util.List;
+
+/**
+ * Groups of servers do things the same way as each other.
+ */
+public enum ServerTypeGroup {
+    /**
+     * Freenode Group.
+     */
+    FREENODE("Freenode IRCDs", new ServerType[]{ServerType.HYPERION, ServerType.DANCER}),
+    /**
+     * Charybdis Group.
+     */
+    CHARYBDIS("Charybdis-esque IRCDs", new ServerType[]{ServerType.IRCD_SEVEN, ServerType.CHARYBDIS}),
+    /**
+     * Group for ircds that put the channel owners in a list under raw 386
+     * rather than as a channel user mode.
+     */
+    OWNER_386("Owner List", new ServerType[]{ServerType.SWIFTIRC, ServerType.AUSTHEX8}),
+    /**
+     * Group for ircds that put the protected users in a list under raw 388
+     * rather than as a channel user mode.
+     */
+    PROTECTED_388("Protected List", new ServerType[]{ServerType.SWIFTIRC, ServerType.AUSTHEX8});
+
+    /** Name of the group. */
+    final String name;
+
+    /** Group Members. */
+    final List<ServerType> members;
+
+    /**
+     * Create a new ServerTypeGroup.
+     *
+     * @param name Name of this group.
+     * @param members Members of this group.
+     */
+    ServerTypeGroup(final String name, final ServerType[] members) {
+        this.name = name;
+        this.members = Arrays.asList(members);
+    }
+
+    /**
+     * Get the members of this group.
+     *
+     * @return The members of this group.
+     */
+    public List<ServerType> getMembers() {
+        return members;
+    }
+
+    /**
+     * Get the name of this group.
+     *
+     * @return The name of this group.
+     */
+    public String getName() {
+        return name;
+    }
+
+    /**
+     * Check if the given ServerType is a member of this group.
+     *
+     * @param type The type to check.
+     * @return True of the given ServerType is a member of this group.
+     */
+    public boolean isMember(final ServerType type) {
+        return members.contains(type);
+    }
+}