Add support for "CAP" extension.

(See: http://www.leeh.co.uk/draft-mitchell-irc-capabilities-02.html)

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

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

@@ -194,9 +194,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
     private IRCClientInfo myself = new IRCClientInfo(this, "myself").setFake(true);
     /** Hashtable storing all information gathered from 005. */
     final Map<String, String> h005Info = new HashMap<String, String>();
-    /** Does this server support timestamped IRC? */
-    boolean timestampedIRC = false;
-    /** difference in ms between our time and the servers time. */
+    /** difference in ms between our time and the servers time (used for timestampedIRC). */
     long tsdiff;
     /** Reference to the Processing Manager. */
     private final ProcessingManager myProcessingManager = new ProcessingManager(this);
@@ -923,6 +921,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
      * Send server connection strings (NICK/USER/PASS).
      */
     protected void sendConnectionStrings() {
+        sendString("CAP LS");
         if (getURI().getUserInfo() != null && !getURI().getUserInfo().isEmpty()) {
             sendString("PASS " + getURI().getUserInfo());
         }
@@ -1233,7 +1232,7 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
         callDataIn(line.getLine());
         String[] token = line.getTokens();
         Date lineTS = new Date();
-        if (!token[0].isEmpty() && timestampedIRC && token[0].charAt(0) == '@') {
+        if (!token[0].isEmpty() && token[0].charAt(0) == '@') {
             try {
                 final int tsEnd = token[0].indexOf('@', 1);
                 final long ts = Long.parseLong(token[0].substring(1, tsEnd));
@@ -1265,14 +1264,12 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
                     errorMessage.append(token[i]);
                 }
                 callServerError(errorMessage.toString());
-            } else if (timestampedIRC && token[1].equalsIgnoreCase("TSIRC") && token.length > 3) {
+            } else if (token[1].equalsIgnoreCase("TSIRC") && token.length > 3) {
                 if (token[2].equals("1")) {
                     try {
                         final long ts = Long.parseLong(token[3]);
                         tsdiff = ts - System.currentTimeMillis();
                     } catch (final NumberFormatException nfe) { /* Do nothing. */ }
-                } else {
-                    timestampedIRC = false;
                 }
             } else {
                 if (got001) {
@@ -1345,6 +1342,11 @@ public class IRCParser extends BaseParser implements SecureParser, EncodingParse
                                 break;
                             }
 
+                            // CAP also happens here, so try that.
+                            if (token[1].equalsIgnoreCase("CAP")) {
+                                myProcessingManager.process(lineTS, sParam, token);
+                            }
+
                             // Otherwise, send to Notice Auth
                             try {
                                 myProcessingManager.process(lineTS, "Notice Auth", token);

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

@@ -150,9 +150,11 @@ public class Process004005 extends IRCProcessor {
                     } catch (ProcessorNotFoundException e) {
                     }
                 } else if ("TIMESTAMPEDIRC".equals(key)) {
-                    parser.timestampedIRC = true;
                     // Let the server know we also understand timestamped irc.
                     // See my other proposal: http://shanemcc.co.uk/irc/#timestamping
+                    // This might not be needed if the server advertises it via
+                    // CAP, but send it anyway as we don't currently keep state
+                    // with CAP.
                     parser.sendString("TIMESTAMPEDIRC ON", QueuePriority.HIGH);
                 }
             }

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

@@ -0,0 +1,97 @@
+/*
+ * Copyright (c) 2006-2012 DMDirc Developers
+ *
+ * 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.Date;
+
+/**
+ * Process CAP extension.
+ * There are currently no callbacks related to this, as it is just to tell
+ * the server what we support.
+ *
+ * For all the capabilities we support, we are always able to handle lines#
+ * either with or without the capability enabled, so we don't actually need to
+ * keep much/any state here, which makes this easy.
+ *
+ * See: http://www.leeh.co.uk/draft-mitchell-irc-capabilities-02.html
+ */
+public class ProcessCap extends TimestampedIRCProcessor {
+    /** Have we handled the pre-connect cap request? */
+    private boolean hasCapped = false;
+
+    /**
+     * Create a new instance of the IRCProcessor Object.
+     *
+     * @param parser IRCParser That owns this IRCProcessor
+     * @param manager ProcessingManager that is in charge of this IRCProcessor
+     */
+    protected ProcessCap(final IRCParser parser, final ProcessingManager manager) {
+        super(parser, manager);
+    }
+
+    /**
+     * Process CAP responses.
+     *
+     * @param sParam Type of line to process ("CAP")
+     * @param token IRCTokenised line to process
+     */
+    @Override
+    public void process(final Date date, final String sParam, final String[] token) {
+        // We will only automatically handle the first ever pre-001 CAP LS
+        // response.
+        // After that, the user may be sending stuff themselves so we do
+        // nothing.
+        if (!hasCapped && !parser.got001 && token.length > 4 && token[3].equalsIgnoreCase("LS")) {
+            final String[] caps = token[token.length - 1].split(" ");
+            for (final String cap : caps) {
+                if (cap.equalsIgnoreCase("multi-prefix") || cap.equalsIgnoreCase("tsirc") || cap.equalsIgnoreCase("userhost-in-names")) {
+                    // Send cap requests as individual lines, as some servers
+                    // only appear to accept them one at a time.
+                    parser.sendRawMessage("CAP REQ :" + cap);
+                }
+            }
+
+            // If this is the last of the LS responses, set hasCapped to true
+            // so that we don't try this again, and send "CAP END"
+            // We will accept any of the following to be the end of the list:
+            //     :DFBnc.Server CAP Dataforce LS :some caps
+            //     :DFBnc.Server CAP Dataforce LS
+            // but not:
+            //     :DFBnc.Server CAP Dataforce LS *
+            if (token.length == 4 || (token.length == 5 && !token[4].equals("*"))) {
+                hasCapped = true;
+                parser.sendRawMessage("CAP END");
+            }
+        }
+    }
+
+    /**
+     * What does this IRCProcessor handle.
+     *
+     * @return String[] with the names of the tokens we handle.
+     */
+    @Override
+    public String[] handles() {
+        return new String[]{"CAP"};
+    }
+}

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

@@ -112,6 +112,8 @@ public class ProcessingManager {
         // 322
         // 323
         addProcessor(new ProcessList(parser, this));
+        // CAP
+        addProcessor(new ProcessCap(parser, this));
     }
 
     /**

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

@@ -102,12 +102,15 @@ public class IRCParserTest {
         final TestParser parser = new TestParser(myInfo, new URI("irc://irc.testing.dmdirc:6667/"));
         parser.sendConnectionStrings();
 
-        assertEquals(2, parser.sentLines.size());
+        assertEquals(3, parser.sentLines.size());
+
+        assertTrue("Should send CAP LS line",
+                Arrays.equals(parser.getLine(0), new String[]{"CAP", "LS"}));
 
         assertTrue("Should send nickname line",
-                Arrays.equals(parser.getLine(0), new String[]{"NICK", "Nickname"}));
+                Arrays.equals(parser.getLine(1), new String[]{"NICK", "Nickname"}));
 
-        final String[] userParts = parser.getLine(1);
+        final String[] userParts = parser.getLine(2);
         assertEquals("First token should be USER", "USER", userParts[0]);
         assertEquals("USER should contain username", myInfo.getUsername().toLowerCase(),
                 userParts[1].toLowerCase());
@@ -125,10 +128,10 @@ public class IRCParserTest {
         final TestParser parser = new TestParser(myInfo, new URI("irc://password@irc.testing.dmdirc:6667/"));
         parser.sendConnectionStrings();
 
-        assertEquals(3, parser.sentLines.size());
+        assertEquals(4, parser.sentLines.size());
 
         assertTrue("Should send password line",
-                Arrays.equals(parser.getLine(0), new String[]{"PASS", "password"}));
+                Arrays.equals(parser.getLine(1), new String[]{"PASS", "password"}));
     }
 
     @Test