Add isChannel method

CHANGELOG

@@ -3,6 +3,7 @@ vNEXT (in development)
  * Added support for SCRAM-SHA-1 and SCRAM-SHA-256 SASL mechanisms
  * Added MotdLineReceived event
  * Added topic events and state
+ * Add utility method IrcClient.isChannel(String) to identify if a target is a channel or not
  * (Internal) Move event handlers into their own package
 
 v0.7.0

src/main/kotlin/com/dmdirc/ktirc/IrcClient.kt

@@ -71,15 +71,23 @@ interface IrcClient {
     fun onEvent(handler: (IrcEvent) -> Unit)
 
     /**
-     * Utility method to determine if the given user is the one we are connected to IRC as.
+     * Utility method to determine if the given user is the one we are connected to IRC as. Should only be used after a
+     * [com.dmdirc.ktirc.events.ServerReady] event has been received.
      */
     fun isLocalUser(user: User) = isLocalUser(user.nickname)
 
     /**
-     * Utility method to determine if the given user is the one we are connected to IRC as.
+     * Utility method to determine if the given user is the one we are connected to IRC as. Should only be used after a
+     * [com.dmdirc.ktirc.events.ServerReady] event has been received.
      */
     fun isLocalUser(nickname: String) = caseMapping.areEquivalent(nickname, serverState.localNickname)
 
+    /**
+     * Determines if the given [target] appears to be a channel or not. Should only be used after a
+     * [com.dmdirc.ktirc.events.ServerReady] event has been received.
+     */
+    fun isChannel(target: String) = target.isNotEmpty() && serverState.channelTypes.contains(target[0])
+
 }
 
 /**

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

@@ -57,6 +57,12 @@ class ServerState internal constructor(
     val channelModePrefixes
         get() = features[ServerFeature.ModePrefixes] ?: throw IllegalStateException("lost mode prefixes")
 
+    /**
+     * Convenience accessor for the [ServerFeature.ChannelTypes] feature, which will always have a value.
+     */
+    val channelTypes
+        get() = features[ServerFeature.ChannelTypes] ?: throw IllegalStateException("lost channel types")
+
     /**
      * Determines if the given mode is one applied to a user of a channel, such as 'o' for operator.
      */
@@ -148,6 +154,8 @@ sealed class ServerFeature<T : Any>(val name: String, val type: KClass<T>, val d
     object MaximumChannels : ServerFeature<Int>("MAXCHANNELS", Int::class) // TODO: CHANLIMIT also exists
     /** The modes supported in channels. */
     object ChannelModes : ServerFeature<Array<String>>("CHANMODES", Array<String>::class)
+    /** The types of channels supported. */
+    object ChannelTypes : ServerFeature<String>("CHANTYPES", String::class, "#&")
     /** The maximum length of a channel name, defaulting to 200. */
     object MaximumChannelNameLength : ServerFeature<Int>("CHANNELLEN", Int::class, 200)
     /** Whether or not the server supports extended who. */

src/test/kotlin/com/dmdirc/ktirc/IrcClientImplTest.kt

@@ -300,6 +300,19 @@ internal class IrcClientImplTest {
         }
     }
 
+    @Test
+    fun `identifies channels that have a prefix in the chantypes feature`() {
+        with(IrcClientImpl(normalConfig)) {
+            serverState.features[ServerFeature.ChannelTypes] = "&~"
+            assertTrue(isChannel("&dumpsterdiving"))
+            assertTrue(isChannel("~hacktheplanet"))
+            assertFalse(isChannel("#root"))
+            assertFalse(isChannel("acidBurn"))
+            assertFalse(isChannel(""))
+            assertFalse(isChannel("acidBurn#~"))
+        }
+    }
+
     private suspend inline fun <reified T : IrcEvent> IrcClient.waitForEvent(): T {
         val mutex = Mutex(true)
         val value = AtomicReference<T>()