Support for nick change errors

CHANGELOG

@@ -1,5 +1,6 @@
 vNEXT (in development)
 
+* Added NickChangeFailed event for when nicknames are in use, banned, etc
  * (Internal) Moved message processors into their own package
 
 v0.10.0

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

@@ -194,3 +194,23 @@ class BatchFinished(metadata: EventMetadata, val referenceId: String) : IrcEvent
 
 /** A batch of events that should be handled together. */
 class BatchReceived(metadata: EventMetadata, val type: String, val params: Array<String>, val events: List<IrcEvent>) : IrcEvent(metadata)
+
+/**
+ * Raised when attempting to set or change our nickname fails.
+ *
+ * If this happens before {ServerReady], the nickname must be changed for registration to continue.
+ */
+class NicknameChangeFailed(metadata: EventMetadata, val cause: NicknameChangeError): IrcEvent(metadata) {
+    /** Reasons a nick change may fail. */
+    enum class NicknameChangeError {
+        /** The nickname is not allowed by the server. */
+        ErroneousNickname,
+        /** The nickname is already in use. */
+        AlreadyInUse,
+        /** The nickname has collided with another somehow. */
+        Collision,
+        /** No nickname was provided. */
+        NoNicknameGiven
+    }
+}
+

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

@@ -16,6 +16,10 @@ internal const val RPL_MOTDSTART = "375"
 internal const val RPL_ENDOFMOTD = "376"
 
 internal const val ERR_NOMOTD = "422"
+internal const val ERR_NONICKNAMEGIVEN = "431"
+internal const val ERR_ERRONEUSNICKNAME = "432"
+internal const val ERR_NICKNAMEINUSE = "433"
+internal const val ERR_NICKCOLLISION = "436"
 
 internal const val RPL_SASLSUCCESS = "903"
 internal const val ERR_SASLFAIL = "904"

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

@@ -29,6 +29,7 @@ internal val messageProcessors = listOf(
         ModeProcessor(),
         MotdProcessor(),
         NamesProcessor(),
+        NickChangeErrorProcessor(),
         NickProcessor(),
         NoticeProcessor(),
         PartProcessor(),

src/main/kotlin/com/dmdirc/ktirc/messages/processors/NickChangeErrorProcessor.kt

@@ -0,0 +1,24 @@
+package com.dmdirc.ktirc.messages.processors
+
+import com.dmdirc.ktirc.events.NicknameChangeFailed
+import com.dmdirc.ktirc.messages.ERR_ERRONEUSNICKNAME
+import com.dmdirc.ktirc.messages.ERR_NICKCOLLISION
+import com.dmdirc.ktirc.messages.ERR_NICKNAMEINUSE
+import com.dmdirc.ktirc.messages.ERR_NONICKNAMEGIVEN
+import com.dmdirc.ktirc.model.IrcMessage
+
+internal class NickChangeErrorProcessor : MessageProcessor {
+
+    override val commands = arrayOf(ERR_ERRONEUSNICKNAME, ERR_NICKCOLLISION, ERR_NICKNAMEINUSE, ERR_NONICKNAMEGIVEN)
+
+    override fun process(message: IrcMessage) = listOf(NicknameChangeFailed(message.metadata, message.command.toNicknameChangeError()))
+
+    private fun String.toNicknameChangeError(): NicknameChangeFailed.NicknameChangeError = when(this) {
+        ERR_ERRONEUSNICKNAME -> NicknameChangeFailed.NicknameChangeError.ErroneousNickname
+        ERR_NICKCOLLISION -> NicknameChangeFailed.NicknameChangeError.Collision
+        ERR_NICKNAMEINUSE -> NicknameChangeFailed.NicknameChangeError.AlreadyInUse
+        ERR_NONICKNAMEGIVEN -> NicknameChangeFailed.NicknameChangeError.NoNicknameGiven
+        else -> throw IllegalArgumentException("Unknown nick change error")
+    }
+
+}

src/test/kotlin/com/dmdirc/ktirc/messages/processors/NickChangeErrorProcessorTest.kt

@@ -0,0 +1,67 @@
+package com.dmdirc.ktirc.messages.processors
+
+import com.dmdirc.ktirc.TestConstants
+import com.dmdirc.ktirc.events.NicknameChangeFailed
+import com.dmdirc.ktirc.messages.tagMap
+import com.dmdirc.ktirc.model.IrcMessage
+import com.dmdirc.ktirc.model.MessageTag
+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
+import org.junit.jupiter.api.assertThrows
+
+internal class NickChangeErrorProcessorTest {
+
+    private val processor = NickChangeErrorProcessor()
+
+    @BeforeEach
+    fun setup() {
+        currentTimeProvider = { TestConstants.time }
+    }
+
+    @Test
+    fun `raises error event when nick in use`() {
+        val events = processor.process(IrcMessage(tagMap(), null, "433", params("Nickname already in use")))
+        assertEquals(1, events.size)
+        assertEquals(NicknameChangeFailed.NicknameChangeError.AlreadyInUse, events[0].cause)
+    }
+
+    @Test
+    fun `raises error event when nick is erroneous`() {
+        val events = processor.process(IrcMessage(tagMap(), null, "432", params("Nickname not allowed")))
+        assertEquals(1, events.size)
+        assertEquals(NicknameChangeFailed.NicknameChangeError.ErroneousNickname, events[0].cause)
+    }
+
+    @Test
+    fun `raises error event when nick collides`() {
+        val events = processor.process(IrcMessage(tagMap(), null, "436", params("Nick collision")))
+        assertEquals(1, events.size)
+        assertEquals(NicknameChangeFailed.NicknameChangeError.Collision, events[0].cause)
+    }
+
+    @Test
+    fun `raises error event when nick not provided`() {
+        val events = processor.process(IrcMessage(tagMap(), null, "431", params("No nickname given")))
+        assertEquals(1, events.size)
+        assertEquals(NicknameChangeFailed.NicknameChangeError.NoNicknameGiven, events[0].cause)
+    }
+
+    @Test
+    fun `throws if invoked with other numeric`() {
+        assertThrows<IllegalArgumentException> {
+            processor.process(IrcMessage(tagMap(), null, "123", params("Hack the planet!")))
+        }
+    }
+
+    @Test
+    fun `raises error event with correct metadata`() {
+        val events = processor.process(IrcMessage(tagMap(MessageTag.Label to "abc"), null, "433", params("Nickname already in use")))
+        assertEquals(1, events.size)
+        assertEquals(TestConstants.time, events[0].metadata.time)
+        assertEquals("abc", events[0].metadata.label)
+    }
+
+}