Support for receiving MOTD lines

CHANGELOG

@@ -1,6 +1,7 @@
 vNEXT (in development)
 
  * Added support for SCRAM-SHA-1 and SCRAM-SHA-256 SASL mechanisms
+ * Added MotdLineReceived event
 
 v0.7.0
 

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

@@ -95,6 +95,9 @@ class ServerCapabilitiesAcknowledged(time: LocalDateTime, val capabilities: Map<
 /** Raised when the server has finished sending us capabilities. */
 class ServerCapabilitiesFinished(time: LocalDateTime) : IrcEvent(time)
 
+/** Raised when a line of the Message Of the Day has been received. */
+class MotdLineReceived(time: LocalDateTime, val line: String, val first: Boolean = false) : IrcEvent(time)
+
 /** Raised when a Message Of the Day has completed. */
 class MotdFinished(time: LocalDateTime, val missing: Boolean = false) : IrcEvent(time)
 

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

@@ -1,14 +1,17 @@
 package com.dmdirc.ktirc.messages
 
 import com.dmdirc.ktirc.events.MotdFinished
+import com.dmdirc.ktirc.events.MotdLineReceived
 import com.dmdirc.ktirc.model.IrcMessage
 
 internal class MotdProcessor : MessageProcessor {
 
-    override val commands = arrayOf(ERR_NOMOTD, RPL_ENDOFMOTD)
+    override val commands = arrayOf(ERR_NOMOTD, RPL_MOTDSTART, RPL_MOTD, RPL_ENDOFMOTD)
 
     override fun process(message: IrcMessage) = sequence {
         when (message.command) {
+            RPL_MOTDSTART -> yield(MotdLineReceived(message.time, String(message.params[1]), true))
+            RPL_MOTD -> yield(MotdLineReceived(message.time, String(message.params[1])))
             ERR_NOMOTD -> yield(MotdFinished(message.time, missing = true))
             RPL_ENDOFMOTD -> yield(MotdFinished(message.time))
         }

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

@@ -8,6 +8,8 @@ internal const val RPL_ISUPPORT = "005"
 internal const val RPL_UMODEIS = "221"
 
 internal const val RPL_CHANNELMODEIS = "324"
+internal const val RPL_MOTD = "372"
+internal const val RPL_MOTDSTART = "375"
 internal const val RPL_ENDOFMOTD = "376"
 
 internal const val ERR_NOMOTD = "422"

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

@@ -2,6 +2,7 @@ package com.dmdirc.ktirc.messages
 
 import com.dmdirc.ktirc.TestConstants
 import com.dmdirc.ktirc.events.MotdFinished
+import com.dmdirc.ktirc.events.MotdLineReceived
 import com.dmdirc.ktirc.model.IrcMessage
 import com.dmdirc.ktirc.params
 import com.dmdirc.ktirc.util.currentTimeProvider
@@ -17,7 +18,7 @@ internal class MotdProcessorTest {
     }
 
     @Test
-    fun `MotdProcessor raises motdFinished when not found numeric received`() {
+    fun `raises MotdFinished when not found numeric received`() {
         val events = MotdProcessor().process(
                 IrcMessage(emptyMap(), "the.gibson".toByteArray(), "422", params("MOTD missing")))
         assertEquals(1, events.size)
@@ -28,7 +29,7 @@ internal class MotdProcessorTest {
     }
 
     @Test
-    fun `MotdProcessor raises motdFinished when MOTD finishes normally`() {
+    fun `raises MotdFinished when MOTD finishes normally`() {
         val events = MotdProcessor().process(
                 IrcMessage(emptyMap(), "the.gibson".toByteArray(), "376", params("acidBurn", "End of /MOTD command.")))
         assertEquals(1, events.size)
@@ -38,4 +39,35 @@ internal class MotdProcessorTest {
         assertFalse(event.missing)
     }
 
-}
+    @Test
+    fun `raises MotdLineReceived when start of MOTD received`() {
+        val events = MotdProcessor().process(
+                IrcMessage(emptyMap(), "the.gibson".toByteArray(), "375", params("acidBurn", "- the.gibson MOTD -")))
+        assertEquals(1, events.size)
+
+        val event = events[0] as MotdLineReceived
+        assertEquals(TestConstants.time, event.time)
+        assertEquals("- the.gibson MOTD -", event.line)
+        assertTrue(event.first)
+    }
+
+    @Test
+    fun `raises MotdLineReceived when line of MOTD received`() {
+        val events = MotdProcessor().process(
+                IrcMessage(emptyMap(), "the.gibson".toByteArray(), "372", params("acidBurn", "Hack the planet!")))
+        assertEquals(1, events.size)
+
+        val event = events[0] as MotdLineReceived
+        assertEquals(TestConstants.time, event.time)
+        assertEquals("Hack the planet!", event.line)
+        assertFalse(event.first)
+    }
+
+    @Test
+    fun `raises nothing for unsupported events`() {
+        val events = MotdProcessor().process(
+                IrcMessage(emptyMap(), "the.gibson".toByteArray(), "NOTICE", params("acidBurn", "Hi")))
+        assertEquals(0, events.size)
+    }
+
+}