Remove external usages of prefix mode bitmaps.

Prefix modes are now stored as a string, with the most important
mode at the start (e.g. "ohv").

Change-Id: Ie51e6bf8bf7a46e80295ed5cf000ffb4b0195e0b
Reviewed-on: http://gerrit.dmdirc.com/3954
Reviewed-by: Greg Holmes <greg@dmdirc.com>
Automatic-Compile: DMDirc Build Manager

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

@@ -37,11 +37,13 @@ public class IRCChannelClientInfo implements ChannelClientInfo {
 
     /** Reference to ClientInfo object this represents. */
     private final IRCClientInfo cClient;
-    /** Integer representation of the channel modes assocated with this user. */
-    private long nModes;
-    /** Reference to the parser object that owns this channelclient, Used for modes. */
-    private final IRCParser myParser;
-    /** Reference to the channel object that owns this channelclient. */
+    /** The channel modes associated with this user. */
+    private String modes = "";
+    /** Manager to use when dealing with prefix modes. */
+    private final PrefixModeManager modeManager;
+    /** The parser to use to kick people. */
+    private final IRCParser parser;
+    /** Reference to the channel object that owns this channel client. */
     private final ChannelInfo myChannel;
     /** A Map to allow applications to attach misc data to this object. */
     private Map<Object, Object> myMap;
@@ -55,7 +57,8 @@ public class IRCChannelClientInfo implements ChannelClientInfo {
      */
     public IRCChannelClientInfo(final IRCParser tParser, final IRCClientInfo client, final ChannelInfo channel) {
         myMap = new HashMap<>();
-        myParser = tParser;
+        modeManager = tParser.prefixModes;
+        parser = tParser;
         cClient = client;
         myChannel = channel;
         cClient.addChannelClientInfo(this);
@@ -98,109 +101,45 @@ public class IRCChannelClientInfo implements ChannelClientInfo {
     /**
      * Set the modes this client has (Prefix modes).
      *
-     * @param nNewMode integer representing the modes this client has.
+     * @param modes The new modes this client has, sorted most-to-least important.
      */
-    public void setChanMode(final long nNewMode) {
-        nModes = nNewMode;
-    }
-
-    /**
-     * Get the modes this client has (Prefix modes).
-     *
-     * @return integer representing the modes this client has.
-     */
-    public long getChanMode() {
-        return nModes;
-    }
-
-    /**
-     * Get the modes this client has (Prefix modes) as a string.
-     * Returns all known modes that the client has.
-     * getChanModeStr(false).charAt(0) can be used to get the highest mode (o)
-     * getChanModeStr(true).charAt(0) can be used to get the highest prefix (@)
-     *
-     * @param bPrefix if this is true, prefixes will be returned (@+) not modes (ov)
-     * @return String representing the modes this client has.
-     */
-    public String getChanModeStr(final boolean bPrefix) {
-        final StringBuilder sModes = new StringBuilder();
-        final long nCurrentModes = this.getChanMode();
-
-        for (long i = myParser.prefixModes.getNextValue(); i > 0; i /= 2) {
-            if ((nCurrentModes & i) == i) {
-                for (char cTemp : myParser.prefixModes.getModes()) {
-                    final long nTemp = myParser.prefixModes.getValueOf(cTemp);
-                    if (nTemp == i) {
-                        if (bPrefix) {
-                            sModes.append(myParser.prefixModes.getPrefixFor(cTemp));
-                        } else {
-                            sModes.append(cTemp);
-                        }
-                        break;
-                    }
-                }
-            }
-        }
-
-        return sModes.toString();
+    public void setChanMode(final String modes) {
+        this.modes = modes;
     }
 
     @Override
     public String getAllModes() {
-        return getChanModeStr(false);
+        return modes;
     }
 
     @Override
     public String getAllModesPrefix() {
-        return getChanModeStr(true);
-    }
-
-    /**
-     * Get the value of the most important mode this client has (Prefix modes).
-     * A higher value, is a more important mode, 0 = no modes.
-     *
-     * @return integer representing the value of the most important mode.
-     */
-    public long getImportantModeValue() {
-        for (long i = myParser.prefixModes.getNextValue(); i > 0; i /= 2) {
-            if ((nModes & i) == i) {
-                return i;
-            }
-        }
-        return 0;
+        return modeManager.getPrefixesFor(modes);
     }
 
     @Override
     public String getImportantMode() {
-        String sModes = this.getChanModeStr(false);
-        if (!sModes.isEmpty()) {
-            sModes = Character.toString(sModes.charAt(0));
-        }
-        return sModes;
+        return modes.isEmpty() ? "" : modes.substring(0, 1);
     }
 
     @Override
     public String getImportantModePrefix() {
-        String sModes = this.getChanModeStr(true);
-        if (!sModes.isEmpty()) {
-            sModes = Character.toString(sModes.charAt(0));
-        }
-        return sModes;
+        return modes.isEmpty() ? "" : getAllModesPrefix().substring(0, 1);
     }
 
     /**
-     * Get the String Value of ChannelClientInfo (ie @Nickname).
+     * Get the String Value of ChannelClientInfo (e.g. @Nickname).
      *
-     * @return String Value of user (inc prefix) (ie @Nickname)
+     * @return String Value of user (inc prefix) (e.g. @Nickname)
      */
     @Override
     public String toString() {
-        return this.getImportantModePrefix() + this.getNickname();
+        return getImportantModePrefix() + getNickname();
     }
 
     @Override
     public void kick(final String message) {
-        myParser.sendString("KICK " + myChannel + " " + this.getNickname(), message);
+        parser.sendString("KICK " + myChannel + ' ' + getNickname(), message);
     }
 
     /**
@@ -209,16 +148,38 @@ public class IRCChannelClientInfo implements ChannelClientInfo {
      * @return String Value of user (inc prefix) (ie @+Nickname)
      */
     public String toFullString() {
-        return this.getChanModeStr(true) + this.getNickname();
+        return getAllModesPrefix() + getNickname();
     }
 
     @Override
     public int compareTo(final ChannelClientInfo arg0) {
-        if (arg0 instanceof IRCChannelClientInfo) {
-            final IRCChannelClientInfo other = (IRCChannelClientInfo) arg0;
-            return (int) (getImportantModeValue() - other.getImportantModeValue());
-        }
+        return modeManager.compareImportantModes(getAllModes(), arg0.getAllModes());
+    }
+
+    /**
+     * Determines if this client is opped or not.
+     *
+     * @return True if the client is opped, false otherwise.
+     */
+    public boolean isOpped() {
+        return modeManager.isOpped(getAllModes());
+    }
+
+    /**
+     * Adds the specified mode to this client model.
+     *
+     * @param mode The mode to be added.
+     */
+    public void addMode(final char mode) {
+        modes = modeManager.insertMode(modes, mode);
+    }
 
-        return 0;
+    /**
+     * Removes the specified mode from this client model.
+     *
+     * @param mode The mode to be removed.
+     */
+    public void removeMode(final char mode) {
+        modes = modes.replace(Character.toString(mode), "");
     }
 }

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

@@ -112,7 +112,7 @@ public class IRCChannelInfo implements ChannelInfo {
         final long now = System.currentTimeMillis();
         // Incase of breakage, if getListModeQueue() was last called greater than
         // 60 seconds ago, we reset the list.
-        if (now - (30 * 1000) > listModeQueueTime) {
+        if (now - 30 * 1000 > listModeQueueTime) {
             result = new LinkedList<>();
             parser.callDebugInfo(IRCParser.DEBUG_LMQ, "Resetting LMQ");
         }
@@ -136,12 +136,7 @@ public class IRCChannelInfo implements ChannelInfo {
 
         final ServerType serverType = parser.getServerType();
 
-        // We are considered opped if we have a mode higher than voice (or if we have any modes if voice doesn't exist)
-        long voiceValue = 0;
-        if (parser.prefixModes.isPrefixMode('v')) {
-            voiceValue = parser.prefixModes.getValueOf('v');
-        }
-        final boolean isOpped = me.getImportantModeValue() > voiceValue;
+        final boolean isOpped = me.isOpped();
 
         int modecount = 1;
 

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

@@ -80,6 +80,21 @@ public class PrefixModeManager {
         return prefixMap.get(mode);
     }
 
+    /**
+     * Converts a string containing prefix modes into a string containing the corresponding
+     * prefixes (e.g. 'ov' becomes '@+').
+     *
+     * @param modes The modes to retrieve prefixes for.
+     * @return The prefixes corresponding to the modes.
+     */
+    public String getPrefixesFor(final String modes) {
+        final StringBuilder builder = new StringBuilder(modes.length());
+        for (char mode : modes.toCharArray()) {
+            builder.append(getPrefixFor(mode));
+        }
+        return builder.toString();
+    }
+
     /**
      * Returns the mode corresponding to the specified prefix (e.g. 'o' given '@').
      *
@@ -121,19 +136,68 @@ public class PrefixModeManager {
      * @deprecated These values are an implementation detail, and shouldn't be exposed.
      */
     @Deprecated
-    public long getValueOf(final char mode) {
+    private long getValueOf(final char mode) {
         return prefixModes.get(mode);
     }
 
     /**
-     * Gets the numerical value that will be assigned to the next mode.
+     * Compares the most important mode of the given mode lists.
      *
-     * @return The next numerical value.
-     * @deprecated These values are an implementation detail, and shouldn't be exposed.
+     * @param modes1 The first set of modes to compare. Must be ordered by importance.
+     * @param modes2 The second set of modes to compare. Must be ordered by importance.
+     * @return A negative number of modes2 is more important than modes1; a positive number if
+     * modes1 is more important than modes2; zero if the two are equivalent.
      */
-    @Deprecated
-    public long getNextValue() {
-        return nextKeyPrefix;
+    public int compareImportantModes(final String modes1, final String modes2) {
+        final char mode1 = modes1.isEmpty() ? ' ' : modes1.charAt(0);
+        final char mode2 = modes2.isEmpty() ? ' ' : modes2.charAt(0);
+        final long modeValue1 = isPrefixMode(mode1) ? getValueOf(mode1) : 0;
+        final long modeValue2 = isPrefixMode(mode2) ? getValueOf(mode2) : 0;
+        return (int) (modeValue1 - modeValue2);
+    }
+
+    /**
+     * Determines if the specified mode string indicates a user is opped. An opped user is
+     * considered one who has any mode greater than 'v' (voice), or if voice doesn't exist then
+     * any mode at all.
+     *
+     * @param modes The modes to test
+     * @return True if the modes indicate the client is "opped", false otherwise.
+     */
+    public boolean isOpped(final String modes) {
+        if (modes.isEmpty()) {
+            return false;
+        }
+
+        final long voiceValue = isPrefixMode('v') ? prefixModes.get('v') : 0;
+        return getValueOf(modes.charAt(0)) > voiceValue;
     }
 
+    /**
+     * Inserts the specified mode into the correct place in the mode string, maintaining importance
+     * order.
+     *
+     * @param modes The existing modes to add the new one to.
+     * @param mode The new mode to be added.
+     * @return A mode string containing all the modes.
+     */
+    public String insertMode(final String modes, final char mode) {
+        if (modes.indexOf(mode) > -1) {
+            // Don't duplicate an existing mode
+            return modes;
+        }
+
+        final StringBuilder result = new StringBuilder(modes.length() + 1);
+        boolean found = false;
+        final long value = getValueOf(mode);
+        for (char existingMode : modes.toCharArray()) {
+            if (getValueOf(existingMode) < value && !found) {
+                // Our new mode is more important, insert it first.
+                result.append(mode);
+                found = true;
+            }
+            result.append(existingMode);
+        }
+        return result.toString();
+    }
 }

src/com/dmdirc/parser/irc/processors/ProcessMode.java

@@ -173,8 +173,8 @@ public class ProcessMode extends IRCProcessor {
                         return;
                     }
                     sModeParam = sModestr[nParam++];
-                    nValue = parser.prefixModes.getValueOf(cMode);
-                    callDebugInfo(IRCParser.DEBUG_INFO, "User Mode: %c / %d [%s] {Positive: %b}", cMode, nValue, sModeParam, bPositive);
+                    callDebugInfo(IRCParser.DEBUG_INFO, "User Mode: %c / %s {Positive: %b}",
+                            cMode, sModeParam, bPositive);
                     iChannelClientInfo = iChannel.getChannelClient(sModeParam);
                     if (iChannelClientInfo == null) {
                         // Client not known?
@@ -182,13 +182,13 @@ public class ProcessMode extends IRCProcessor {
                                 " Ignoring (%s)", sModeParam);
                         continue;
                     }
-                    callDebugInfo(IRCParser.DEBUG_INFO, "\tOld Mode Value: %d", iChannelClientInfo.getChanMode());
+                    callDebugInfo(IRCParser.DEBUG_INFO, "\tOld Mode Value: %s",
+                            iChannelClientInfo.getAllModes());
                     if (bPositive) {
-                        iChannelClientInfo.setChanMode(iChannelClientInfo.getChanMode() | nValue);
+                        iChannelClientInfo.addMode(cMode);
                         sTemp = "+";
                     } else {
-                        iChannelClientInfo.setChanMode(iChannelClientInfo.getChanMode() ^
-                                iChannelClientInfo.getChanMode() & nValue);
+                        iChannelClientInfo.removeMode(cMode);
                         sTemp = "-";
                     }
                     sTemp += cMode;

src/com/dmdirc/parser/irc/processors/ProcessNames.java

@@ -76,9 +76,6 @@ public class ProcessNames extends IRCProcessor {
         } else {
             // Names
 
-            IRCClientInfo iClient;
-            IRCChannelClientInfo iChannelClient;
-
             iChannel = getChannel(token[4]);
 
             if (iChannel == null) {
@@ -92,45 +89,37 @@ public class ProcessNames extends IRCProcessor {
             iChannel.setAddingNames(true);
 
             final String[] sNames = token[token.length - 1].split(" ");
-            String sNameBit, sName = "";
+            String sName = "";
             StringBuilder sModes = new StringBuilder();
-            long nPrefix = 0;
             for (String sName1 : sNames) {
-                sNameBit = sName1;
                 // If name is empty (ie there was an extra space) ignore it.
-                if (sNameBit.isEmpty()) {
+                if (sName1.isEmpty()) {
                     continue;
                 }
                 // This next bit of code allows for any ircd which decides to use @+Foo in names
-                for (int i = 0; i < sNameBit.length(); ++i) {
-                    final Character cMode = sNameBit.charAt(i);
-                    // hPrefixMap contains @, o, +, v this caused issue 107
-                    // hPrefixModes only contains o, v so if the mode is in hPrefixMap
-                    // and not in hPrefixModes, its ok to use.
+                for (int i = 0; i < sName1.length(); i++) {
+                    final char cMode = sName1.charAt(i);
                     if (parser.prefixModes.isPrefix(cMode)) {
-                        sModes.append(cMode);
-                        nPrefix +=
-                                parser.prefixModes.getValueOf(parser.prefixModes.getModeFor(cMode));
+                        sModes.append(parser.prefixModes.getModeFor(cMode));
                     } else {
-                        sName = sNameBit.substring(i);
+                        sName = sName1.substring(i);
                         break;
                     }
                 }
-                callDebugInfo(IRCParser.DEBUG_INFO, "Name: %s Modes: \"%s\" [%d]", sName,
-                        sModes.toString(), nPrefix);
+                callDebugInfo(IRCParser.DEBUG_INFO, "Name: %s Modes: \"%s\"", sName,
+                        sModes.toString());
 
-                iClient = getClientInfo(sName);
+                IRCClientInfo iClient = getClientInfo(sName);
                 if (iClient == null) {
                     iClient = new IRCClientInfo(parser, sName);
                     parser.addClient(iClient);
                 }
                 iClient.setUserBits(sName, false); // Will do nothing if this isn't UHNAMES
-                iChannelClient = iChannel.addClient(iClient);
-                iChannelClient.setChanMode(nPrefix);
+                final IRCChannelClientInfo iChannelClient = iChannel.addClient(iClient);
+                iChannelClient.setChanMode(sModes.toString());
 
                 sName = "";
                 sModes = new StringBuilder();
-                nPrefix = 0;
             }
         }
     }
@@ -138,7 +127,7 @@ public class ProcessNames extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelTopic Callback.
      *
-     * @see com.dmdirc.parser.interfaces.callbacks.ChannelTopicListener
+     * @see ChannelTopicListener
      * @param cChannel Channel that topic was set on
      * @param bIsJoinTopic True when getting topic on join, false if set by user/server
      * @return true if a method was called, false otherwise
@@ -151,7 +140,7 @@ public class ProcessNames extends IRCProcessor {
     /**
      * Callback to all objects implementing the ChannelGotNames Callback.
      *
-     * @see com.dmdirc.parser.interfaces.callbacks.ChannelNamesListener
+     * @see ChannelNamesListener
      * @param cChannel Channel which the names reply is for
      * @return true if a method was called, false otherwise
      */

test/com/dmdirc/parser/irc/ChannelClientInfoTest.java

@@ -46,21 +46,18 @@ public class ChannelClientInfoTest {
         assertEquals("+", cci.getImportantModePrefix());
         assertEquals("+luser", cci.toString());
         assertEquals("+luser", cci.toFullString());
-        final long value = cci.getImportantModeValue();
 
         parser.injectLine(":server MODE #DMDirc_testing +o luser");
         assertEquals("o", cci.getImportantMode());
         assertEquals("@", cci.getImportantModePrefix());
         assertEquals("@luser", cci.toString());
         assertEquals("@+luser", cci.toFullString());
-        assertTrue(cci.getImportantModeValue() > value);
 
         parser.injectLine(":server MODE #DMDirc_testing -ov luser luser");
         assertEquals("", cci.getImportantMode());
         assertEquals("", cci.getImportantModePrefix());
         assertEquals("luser", cci.toString());
         assertEquals("luser", cci.toFullString());
-        assertEquals(0L, cci.getImportantModeValue());
     }
     
     @Test

test/com/dmdirc/parser/irc/ProcessModeTest.java

@@ -69,18 +69,19 @@ public class ProcessModeTest {
         final IRCChannelClientInfo cci = parser.getClient("luser").getChannelClients().get(0);
 
         parser.injectLine(":server MODE #DMDirc_testing +v luser");
-        assertEquals("+", cci.getChanModeStr(true));
+        assertEquals("v", cci.getAllModes());
+        assertEquals("+", cci.getAllModesPrefix());
 
         parser.injectLine(":server MODE #DMDirc_testing +o luser");
-        assertEquals("ov", cci.getChanModeStr(false));
-        assertEquals("@+", cci.getChanModeStr(true));
+        assertEquals("ov", cci.getAllModes());
+        assertEquals("@+", cci.getAllModesPrefix());
 
         parser.injectLine(":server MODE #DMDirc_testing +bov moo luser luser");
-        assertEquals("ov", cci.getChanModeStr(false));
+        assertEquals("ov", cci.getAllModes());
 
         parser.injectLine(":server MODE #DMDirc_testing -bov moo luser luser");
-        assertEquals("", cci.getChanModeStr(false));
-        assertEquals("", cci.getChanModeStr(true));
+        assertEquals("", cci.getAllModes());
+        assertEquals("", cci.getAllModesPrefix());
     }
     
     @Test

test/com/dmdirc/parser/irc/ProcessNamesTest.java

@@ -64,15 +64,15 @@ public class ProcessNamesTest {
 
         IRCChannelClientInfo cci = parser.getClient("luser").getChannelClients().get(0);
         assertEquals(parser.getChannel("#DMDirc_testing"), cci.getChannel());
-        assertEquals("+", cci.getChanModeStr(true));
+        assertEquals("+", cci.getAllModesPrefix());
         
         cci = parser.getChannel("#DMDirc_testing").getChannelClient("nick2");
         assertNotNull(cci);
-        assertEquals("@+", cci.getChanModeStr(true));
+        assertEquals("@+", cci.getAllModesPrefix());
 
         cci = parser.getChannel("#DMDirc_testing").getChannelClient("nick3");
         assertNotNull(cci);
-        assertEquals("", cci.getChanModeStr(true));
+        assertEquals("", cci.getAllModesPrefix());
     }
 
 }

test/com/dmdirc/parser/irc/ProcessNickTest.java

@@ -55,7 +55,7 @@ public class ProcessNickTest {
 
         final IRCChannelClientInfo cci = parser.getClient("LUSER").getChannelClients().get(0);
         assertEquals(parser.getChannel("#DMDirc_testing"), cci.getChannel());
-        assertEquals("+", cci.getChanModeStr(true));
+        assertEquals("+", cci.getAllModesPrefix());
 
         verify(tinc).onNickChanged(same(parser), (Date) anyObject(),
                 same(parser.getClient("LUSER")), eq("luser"));
@@ -77,7 +77,7 @@ public class ProcessNickTest {
 
         final IRCChannelClientInfo cci = parser.getClient("foobar").getChannelClients().get(0);
         assertEquals(parser.getChannel("#DMDirc_testing"), cci.getChannel());
-        assertEquals("+", cci.getChanModeStr(true));
+        assertEquals("+", cci.getAllModesPrefix());
     }    
     
     @Test