Track user away state

CHANGELOG

@@ -3,6 +3,7 @@ vNEXT (in development)
  * Away support:
    * Added sendAway() method
    * Added UserAway event and fanned-out ChannelAway
+   * away message is now updated in the UserState
  * (Internal) improved the way byte buffers are used to
    reduce array copying and clean up code
 

docs/index.adoc

@@ -1189,9 +1189,9 @@ See <<UserAccountChanged>>
 Accounts are automatically added to `User` properties in events
 
 | https://ircv3.net/specs/extensions/away-notify-3.1.html[away-notify] v3.1
-| {set:cellbgcolor:#eeeeaa} Partial support
+| {set:cellbgcolor:#a7eeaa} Supported
 | {set:cellbgcolor!}
-See <<UserAway>>. State not yet tracked.
+See <<UserAway>>.
 
 | https://ircv3.net/specs/extensions/batch-3.2.html[batch] v3.2
 | {set:cellbgcolor:#a7eeaa} Supported

src/main/kotlin/com/dmdirc/ktirc/events/handlers/UserStateHandler.kt

@@ -16,6 +16,7 @@ internal class UserStateHandler : EventHandler {
             is UserNickChanged -> handleNickChanged(client, event)
             is UserHostChanged -> handleHostChanged(client, event)
             is UserQuit -> handleQuit(client.userState, event)
+            is UserAway -> handleAway(client.userState, event)
         }
     }
 
@@ -83,4 +84,14 @@ internal class UserStateHandler : EventHandler {
         state -= event.user
     }
 
+    private fun handleAway(state: UserState, event: UserAway) {
+        state[event.user]?.details?.let {
+            when (event.message) {
+                null -> it.awayMessage = null
+                "" -> if (it.awayMessage == null) it.awayMessage = ""
+                else -> it.awayMessage = event.message
+            }
+        }
+    }
+
 }

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

@@ -94,7 +94,7 @@ sealed class Capability(vararg val names:  String) {
     object AccountChangeMessages : Capability("account-notify")
 
     /** Receive a notification when a user's away state changes. */
-    object AwayStateMessages : Capability("away-notify") // TODO: Add processor
+    object AwayStateMessages : Capability("away-notify")
 
     /** Receive a notification when a user's host changes, instead of a quit/join. */
     object HostChangeMessages : Capability("chghost")

src/test/kotlin/com/dmdirc/ktirc/events/handlers/UserStateHandlerTest.kt

@@ -239,4 +239,34 @@ internal class UserStateHandlerTest {
         assertEquals("root.gibson", fakeUserState["acidBurn"]?.details?.hostname)
     }
 
+    @Test
+    fun `updates details for user back events`() {
+        val user = User("acidBurn", "libby", "root.localhost")
+        fakeUserState += User("AcidBurn", awayMessage = "Hacking the planet")
+
+        handler.processEvent(ircClient, UserAway(EventMetadata(TestConstants.time), user, null))
+
+        assertNull(fakeUserState["acidBurn"]?.details?.awayMessage)
+    }
+
+    @Test
+    fun `does not update away details for less detailed events`() {
+        val user = User("acidBurn", "libby", "root.localhost")
+        fakeUserState += User("AcidBurn", awayMessage = "Hacking the planet")
+
+        handler.processEvent(ircClient, UserAway(EventMetadata(TestConstants.time), user, ""))
+
+        assertEquals("Hacking the planet", fakeUserState["acidBurn"]?.details?.awayMessage)
+    }
+
+    @Test
+    fun `updates away details for away message`() {
+        val user = User("acidBurn", "libby", "root.localhost")
+        fakeUserState += User("AcidBurn")
+
+        handler.processEvent(ircClient, UserAway(EventMetadata(TestConstants.time), user, "Hacking the planet"))
+
+        assertEquals("Hacking the planet", fakeUserState["acidBurn"]?.details?.awayMessage)
+    }
+
 }