Support for notices and CTCPRs

Auth notices will be from a server or "*".

Closes #3

CHANGELOG

@@ -13,6 +13,8 @@ vNEXT (in development)
     * Added MotdFinished event
     * Added UserAccountChanged event
     * Added ChannelUserKicked event
+    * Added NoticeReceived event
+    * Added CtcpReplyReceived event
  * Improved some documentation
 
 v0.4.0

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

@@ -50,12 +50,22 @@ class ChannelNamesFinished(time: LocalDateTime, val channel: String) : IrcEvent(
 /** Raised when a message is received. */
 class MessageReceived(time: LocalDateTime, val user: User, val target: String, val message: String) : IrcEvent(time)
 
+/**
+ * Raised when a notice is received.
+ *
+ * The [user] may in fact be a server, or have a nickname of `*` while connecting.
+ */
+class NoticeReceived(time: LocalDateTime, val user: User, val target: String, val message: String) : IrcEvent(time)
+
 /** Raised when an action is received. */
 class ActionReceived(time: LocalDateTime, val user: User, val target: String, val action: String) : IrcEvent(time)
 
 /** Raised when a CTCP is received. */
 class CtcpReceived(time: LocalDateTime, val user: User, val target: String, val type: String, val content: String) : IrcEvent(time)
 
+/** Raised when a CTCP reply is received. */
+class CtcpReplyReceived(time: LocalDateTime, val user: User, val target: String, val type: String, val content: String) : IrcEvent(time)
+
 /** Raised when a user quits. */
 class UserQuit(time: LocalDateTime, val user: User, val reason: String = "") : IrcEvent(time)
 

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

@@ -26,6 +26,7 @@ internal val messageProcessors = setOf(
         ModeProcessor(),
         MotdProcessor(),
         NamesProcessor(),
+        NoticeProcessor(),
         PartProcessor(),
         PingProcessor(),
         PrivmsgProcessor(),

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

@@ -0,0 +1,28 @@
+package com.dmdirc.ktirc.messages
+
+import com.dmdirc.ktirc.events.CtcpReplyReceived
+import com.dmdirc.ktirc.events.IrcEvent
+import com.dmdirc.ktirc.events.NoticeReceived
+import com.dmdirc.ktirc.model.IrcMessage
+import com.dmdirc.ktirc.model.User
+
+internal class NoticeProcessor : MessageProcessor {
+
+    override val commands = arrayOf("NOTICE")
+
+    override fun process(message: IrcMessage) = when {
+            message.isCtcp() -> handleCtcp(message,  message.sourceUser)
+            else -> listOf(NoticeReceived(message.time,  message.sourceUser ?: User("*"), String(message.params[0]), String(message.params[1])))
+        }
+
+    private fun handleCtcp(message: IrcMessage, user: User?): List<IrcEvent> {
+        user ?: return emptyList()
+        val content = String(message.params[1]).substring(1 until message.params[1].size - 1)
+        val parts = content.split(' ', limit=2)
+        val body = if (parts.size == 2) parts[1] else ""
+        return listOf(CtcpReplyReceived(message.time, user, String(message.params[0]), parts[0], body))
+    }
+
+    private fun IrcMessage.isCtcp() = params[1].size > 2 && params[1][0] == CTCP_BYTE && params[1][params[1].size - 1] == CTCP_BYTE
+
+}

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

@@ -1,5 +1,7 @@
 package com.dmdirc.ktirc.messages
 
+internal const val CTCP_BYTE : Byte = 1
+
 internal const val RPL_WELCOME = "001"
 internal const val RPL_ISUPPORT = "005"
 

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

@@ -7,8 +7,6 @@ import com.dmdirc.ktirc.events.MessageReceived
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.model.User
 
-private const val CTCP_BYTE : Byte = 1
-
 internal class PrivmsgProcessor : MessageProcessor {
 
     override val commands = arrayOf("PRIVMSG")

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

@@ -0,0 +1,81 @@
+package com.dmdirc.ktirc.messages
+
+import com.dmdirc.ktirc.TestConstants
+import com.dmdirc.ktirc.events.CtcpReplyReceived
+import com.dmdirc.ktirc.events.NoticeReceived
+import com.dmdirc.ktirc.model.IrcMessage
+import com.dmdirc.ktirc.model.User
+import com.dmdirc.ktirc.params
+import com.dmdirc.ktirc.util.currentTimeProvider
+import org.junit.jupiter.api.Assertions.assertEquals
+import org.junit.jupiter.api.BeforeEach
+import org.junit.jupiter.api.Test
+
+internal class NoticeProcessorTest {
+
+    @BeforeEach
+    fun setUp() {
+        currentTimeProvider = { TestConstants.time }
+    }
+
+    @Test
+    fun `raises notice received event`() {
+        val events = NoticeProcessor().process(
+                IrcMessage(emptyMap(), "acidburn!libby@root.localhost".toByteArray(), "NOTICE", params("#crashandburn", "hack the planet!")))
+        assertEquals(1, events.size)
+
+        val event = events[0] as NoticeReceived
+        assertEquals(TestConstants.time, event.time)
+        assertEquals(User("acidburn", "libby", "root.localhost"), event.user)
+        assertEquals("#crashandburn", event.target)
+        assertEquals("hack the planet!", event.message)
+    }
+
+    @Test
+    fun `raises notice received event with no prefix`() {
+        val events = NoticeProcessor().process(
+                IrcMessage(emptyMap(), null, "NOTICE", params("#crashandburn", "hack the planet!")))
+        assertEquals(1, events.size)
+
+        val event = events[0] as NoticeReceived
+        assertEquals(TestConstants.time, event.time)
+        assertEquals(User("*"), event.user)
+        assertEquals("#crashandburn", event.target)
+        assertEquals("hack the planet!", event.message)
+    }
+
+    @Test
+    fun `raises CTCP reply received event with content`() {
+        val events = NoticeProcessor().process(
+                IrcMessage(emptyMap(), "acidburn!libby@root.localhost".toByteArray(), "NOTICE", params("#crashandburn", "\u0001PING 12345\u0001")))
+        assertEquals(1, events.size)
+
+        val event = events[0] as CtcpReplyReceived
+        assertEquals(TestConstants.time, event.time)
+        assertEquals(User("acidburn", "libby", "root.localhost"), event.user)
+        assertEquals("#crashandburn", event.target)
+        assertEquals("PING", event.type)
+        assertEquals("12345", event.content)
+    }
+
+    @Test
+    fun `raises CTCP reply received event without content`() {
+        val events = NoticeProcessor().process(
+                IrcMessage(emptyMap(), "acidburn!libby@root.localhost".toByteArray(), "NOTICE", params("#crashandburn", "\u0001PING\u0001")))
+        assertEquals(1, events.size)
+
+        val event = events[0] as CtcpReplyReceived
+        assertEquals(TestConstants.time, event.time)
+        assertEquals(User("acidburn", "libby", "root.localhost"), event.user)
+        assertEquals("#crashandburn", event.target)
+        assertEquals("PING", event.type)
+        assertEquals("", event.content)
+    }
+
+    @Test
+    fun `does nothing if prefix missing for CTCP replies`() {
+        val events = NoticeProcessor().process(
+                IrcMessage(emptyMap(), null, "NOTICE", params("#crashandburn", "\u0001BORK\u0001")))
+        assertEquals(0, events.size)
+    }
+}