Support sending TAGMSGs and reactions

CHANGELOG

@@ -3,11 +3,13 @@ vNEXT (in development)
  * Changed USER command to not send the server name, per modern standards
  * Added support for SASL authentication (with PLAIN mechanism)
  * Removed some unused test code
- * Message IDs and replies:
+ * Message extensions:
     * Added support for IRCv3 message tags v3.3
     * Exposed message IDs in MessageReceived and ActionReceived events
     * When sending a message you can now indicate what it is in reply to
+    * Added sendTagMessage() to send message tags without any content
     * The reply() utility automatically marks messages as a reply
+    * Added react() utility to send a reaction client tag
 
 v0.5.0
 

src/main/kotlin/com/dmdirc/ktirc/events/EventUtils.kt

@@ -2,6 +2,8 @@ package com.dmdirc.ktirc.events
 
 import com.dmdirc.ktirc.IrcClient
 import com.dmdirc.ktirc.messages.sendMessage
+import com.dmdirc.ktirc.messages.sendTagMessage
+import com.dmdirc.ktirc.model.MessageTag
 import com.dmdirc.ktirc.model.ServerFeature
 import com.dmdirc.ktirc.model.asUser
 
@@ -25,9 +27,23 @@ internal fun ChannelNamesReceived.toModesAndUsers(client: IrcClient) = sequence
  * the message ID to tell other IRCv3 capable clients what message is being replied to.
  */
 fun IrcClient.reply(message: MessageReceived, response: String, prefixWithNickname: Boolean = false) {
-    if (caseMapping.areEquivalent(message.target, serverState.localNickname)) {
+    if (isToMe(message)) {
         sendMessage(message.user.nickname, response, message.messageId)
     } else {
         sendMessage(message.target, if (prefixWithNickname) "${message.user.nickname}: $response" else response, message.messageId)
     }
-}
+}
+
+/**
+ * "React" in the appropriate place to a message received.
+ */
+fun IrcClient.react(message: MessageReceived, reaction: String) = sendTagMessage(
+        if (isToMe(message)) message.user.nickname else message.target,
+        mapOf(MessageTag.React to reaction),
+        message.messageId)
+
+/**
+ * Utility to determine whether the given message is to our local user or not.
+ */
+internal fun IrcClient.isToMe(message: MessageReceived) =
+        caseMapping.areEquivalent(message.target, serverState.localNickname)

src/main/kotlin/com/dmdirc/ktirc/messages/MessageBuilders.kt

@@ -33,14 +33,39 @@ fun IrcClient.sendAction(target: String, action: String) = sendCtcp(target, "ACT
 
 /** Sends a private message to a user or channel. */
 fun IrcClient.sendMessage(target: String, message: String, inReplyTo: String? = null) =
-        if (inReplyTo == null)
-            send("PRIVMSG $target :$message")
-        else
-            send("@${MessageTag.Reply.name}=$inReplyTo PRIVMSG $target :$message")
-            // TODO ^ Proper tag building/serializing
+        sendWithTags(mapOf(MessageTag.Reply to inReplyTo), "PRIVMSG $target :$message")
+
+/**
+ * Sends a tag-only message.
+ *
+ * If [inReplyTo] is specified then the [MessageTag.Reply] tag will be automatically added.
+ */
+fun IrcClient.sendTagMessage(target: String, tags: Map<MessageTag, String>, inReplyTo: String? = null) {
+    sendWithTags(inReplyTo?.let { tags + (MessageTag.Reply to inReplyTo) } ?: tags, "TAGMSG $target")
+}
 
 /** Sends a message to register a user with the server. */
 internal fun IrcClient.sendUser(userName: String, realName: String) = send("USER $userName 0 * :$realName")
 
 /** Starts an authentication request. */
 internal fun IrcClient.sendAuthenticationMessage(data: String = "+") = send("AUTHENTICATE $data")
+
+/**
+ * Sends a message prefixed with some IRCv3 tags.
+ *
+ * For convenience, if the value of a tag is `null`, the tag will be omitted. If no tags are present the
+ * message is sent directly with no prefix.
+ */
+internal fun IrcClient.sendWithTags(tags: Map<MessageTag, String?>, message: String) = tags
+        .filterValues { it != null }
+        .map { (key, value) -> "${key.name}=${value?.escapeTagValue()}" }
+        .joinToString(";")
+        .let {
+            if (it.isEmpty()) send(message) else send("@$it $message")
+        }
+
+internal fun String.escapeTagValue() = replace("\\", "\\\\")
+        .replace("\n", "\\n")
+        .replace("\r", "\\r")
+        .replace(";", "\\:")
+        .replace(" ", "\\s")

src/main/kotlin/com/dmdirc/ktirc/model/IrcMessage.kt

@@ -38,6 +38,8 @@ sealed class MessageTag(val name: String) {
     object MessageId : MessageTag("draft/msgid")
     /** Used to identify a message ID that was replied to, to enable threaded conversations. */
     object Reply : MessageTag("+draft/reply")
+    /** Used to specify a slack-like reaction to another message. */
+    object React : MessageTag("+draft/react")
 }
 
 internal val messageTags: Map<String, MessageTag> by lazy {

src/test/kotlin/com/dmdirc/ktirc/events/EventUtilsTest.kt

@@ -116,4 +116,22 @@ internal class EventUtilsTest {
         verify(ircClient).send("@+draft/reply=abc123 PRIVMSG #TheGibson :acidBurn: OK")
     }
 
+
+    @Test
+    fun `react sends response to user when message is private`() {
+        serverState.localNickname = "zeroCool"
+        val message = MessageReceived(TestConstants.time, User("acidBurn"), "Zerocool", "Hack the planet!", "msgId")
+
+        ircClient.react(message, ":P")
+        verify(ircClient).send("@+draft/react=:P;+draft/reply=msgId TAGMSG acidBurn")
+    }
+
+    @Test
+    fun `react sends unprefixed response to user when message is in a channel`() {
+        val message = MessageReceived(TestConstants.time, User("acidBurn"), "#TheGibson", "Hack the planet!", "msgId")
+
+        ircClient.react(message, ":P")
+        verify(ircClient).send("@+draft/react=:P;+draft/reply=msgId TAGMSG #TheGibson")
+    }
+
 }

src/test/kotlin/com/dmdirc/ktirc/messages/MessageBuildersTest.kt

@@ -1,8 +1,10 @@
 package com.dmdirc.ktirc.messages
 
 import com.dmdirc.ktirc.IrcClient
+import com.dmdirc.ktirc.model.MessageTag
 import com.nhaarman.mockitokotlin2.mock
 import com.nhaarman.mockitokotlin2.verify
+import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Test
 
 internal class MessageBuildersTest {
@@ -93,4 +95,45 @@ internal class MessageBuildersTest {
         verify(mockClient).send("AUTHENTICATE +")
     }
 
+    @Test
+    fun `sendWithTag sends message without tags`() {
+        mockClient.sendWithTags(emptyMap(), "PING")
+        verify(mockClient).send("PING")
+    }
+
+    @Test
+    fun `sendWithTag sends message with single tag`() {
+        mockClient.sendWithTags(mapOf(MessageTag.MessageId to "abc"), "PING")
+        verify(mockClient).send("@draft/msgid=abc PING")
+    }
+
+    @Test
+    fun `sendWithTag sends message with multiple tag`() {
+        mockClient.sendWithTags(mapOf(MessageTag.MessageId to "abc", MessageTag.AccountName to "foo"), "PING")
+        verify(mockClient).send("@draft/msgid=abc;account=foo PING")
+    }
+
+    @Test
+    fun `sendWithTag ignores tags with null values`() {
+        mockClient.sendWithTags(mapOf(MessageTag.MessageId to null, MessageTag.AccountName to "foo"), "PING")
+        verify(mockClient).send("@account=foo PING")
+    }
+
+    @Test
+    fun `sendTagMessage sends tags`() {
+        mockClient.sendTagMessage("#thegibson", mapOf(MessageTag.MessageId to "id", MessageTag.AccountName to "foo"))
+        verify(mockClient).send("@draft/msgid=id;account=foo TAGMSG #thegibson")
+    }
+
+    @Test
+    fun `sendTagMessage sends tags with reply ID`() {
+        mockClient.sendTagMessage("#thegibson", mapOf(MessageTag.MessageId to "id", MessageTag.AccountName to "foo"), "otherid")
+        verify(mockClient).send("@draft/msgid=id;account=foo;+draft/reply=otherid TAGMSG #thegibson")
+    }
+
+    @Test
+    fun `escapes tag values`() {
+        assertEquals("\\\\hack\\sthe\\r\\nplanet\\:", "\\hack the\r\nplanet;".escapeTagValue())
+    }
+
 }