feat(gh-101): allow admins to use most commands in DMs

DarkAtra · Apr 7, 2024 · 1ce2e62 · 1ce2e62
1 parent 3e30c0a
commit 1ce2e62
Show file tree

Hide file tree

Showing 12 changed files with 101 additions and 35 deletions.
diff --git a/pom.xml b/pom.xml
@@ -175,6 +175,7 @@
                     </compilerPlugins>
                     <args>
                         <arg>-Xjsr305=strict</arg>
+                        <arg>-Xemit-jvm-type-annotations</arg>
                     </args>
                 </configuration>
                 <dependencies>

diff --git a/src/main/kotlin/de/darkatra/vrising/discord/Bot.kt b/src/main/kotlin/de/darkatra/vrising/discord/Bot.kt
@@ -65,7 +65,7 @@ class Bot(
 
         kord.on<ChatInputCommandInteractionCreateEvent> {
 
-            val command = commands.find { command -> command.isSupported(interaction) }
+            val command = commands.find { command -> command.isSupported(interaction, botProperties.adminUserIds) }
             if (command == null) {
                 interaction.deferEphemeralResponse().respond {
                     content = """This command is not supported here, please refer to the documentation.

diff --git a/src/main/kotlin/de/darkatra/vrising/discord/BotProperties.kt b/src/main/kotlin/de/darkatra/vrising/discord/BotProperties.kt
@@ -41,5 +41,9 @@ class BotProperties {
     @field:NotNull
     var maxCharactersPerError: Int = 200
 
+    @field:NotNull
     var allowLocalAddressRanges: Boolean = true
+
+    @field:NotNull
+    var adminUserIds: Set<@NotBlank String> = emptySet()
 }
diff --git a/src/main/kotlin/de/darkatra/vrising/discord/DatabaseUtils.kt b/src/main/kotlin/de/darkatra/vrising/discord/DatabaseUtils.kt
@@ -3,12 +3,9 @@ package de.darkatra.vrising.discord
 import org.dizitart.kno2.filters.and
 import org.dizitart.no2.objects.ObjectFilter
 
-operator fun ObjectFilter?.plus(other: ObjectFilter?): ObjectFilter? {
-    if (this == null && other == null) {
-        return null
+operator fun ObjectFilter.plus(other: ObjectFilter?): ObjectFilter {
+    if (other == null) {
+        return this
     }
-    if (this != null && other != null) {
-        return this.and(other)
-    }
-    return this ?: other
+    return this.and(other)
 }
diff --git a/src/main/kotlin/de/darkatra/vrising/discord/commands/AddServerCommand.kt b/src/main/kotlin/de/darkatra/vrising/discord/commands/AddServerCommand.kt
@@ -26,6 +26,7 @@ import de.darkatra.vrising.discord.serverstatus.model.ServerStatusMonitorStatus
 import dev.kord.core.Kord
 import dev.kord.core.behavior.interaction.response.respond
 import dev.kord.core.entity.interaction.ChatInputCommandInteraction
+import dev.kord.core.entity.interaction.GlobalChatInputCommandInteraction
 import dev.kord.core.entity.interaction.GuildChatInputCommandInteraction
 import org.springframework.boot.context.properties.EnableConfigurationProperties
 import org.springframework.stereotype.Component
@@ -65,6 +66,13 @@ class AddServerCommand(
         }
     }
 
+    override fun isSupported(interaction: ChatInputCommandInteraction, adminUserIds: Set<String>): Boolean {
+        if (interaction is GlobalChatInputCommandInteraction) {
+            return false
+        }
+        return super.isSupported(interaction, adminUserIds)
+    }
+
     override suspend fun handle(interaction: ChatInputCommandInteraction) {
 
         val hostname = interaction.getServerHostnameParameter()!!

diff --git a/src/main/kotlin/de/darkatra/vrising/discord/commands/Command.kt b/src/main/kotlin/de/darkatra/vrising/discord/commands/Command.kt
@@ -2,6 +2,7 @@ package de.darkatra.vrising.discord.commands
 
 import dev.kord.core.Kord
 import dev.kord.core.entity.interaction.ChatInputCommandInteraction
+import dev.kord.core.entity.interaction.GlobalChatInputCommandInteraction
 import dev.kord.core.entity.interaction.GuildChatInputCommandInteraction
 
 interface Command {
@@ -10,8 +11,16 @@ interface Command {
 
     suspend fun register(kord: Kord)
 
-    fun isSupported(interaction: ChatInputCommandInteraction): Boolean {
-        return interaction.invokedCommandName == getCommandName() && !interaction.user.isBot && interaction is GuildChatInputCommandInteraction
+    fun isSupported(interaction: ChatInputCommandInteraction, adminUserIds: Set<String>): Boolean {
+
+        if (interaction.invokedCommandName != getCommandName() || interaction.user.isBot) {
+            return false
+        }
+
+        return when (interaction) {
+            is GuildChatInputCommandInteraction -> true
+            is GlobalChatInputCommandInteraction -> adminUserIds.contains(interaction.user.id.toString())
+        }
     }
 
     suspend fun handle(interaction: ChatInputCommandInteraction)

diff --git a/src/main/kotlin/de/darkatra/vrising/discord/commands/GetServerDetailsCommand.kt b/src/main/kotlin/de/darkatra/vrising/discord/commands/GetServerDetailsCommand.kt
@@ -7,6 +7,7 @@ import de.darkatra.vrising.discord.serverstatus.ServerStatusMonitorRepository
 import dev.kord.core.Kord
 import dev.kord.core.behavior.interaction.response.respond
 import dev.kord.core.entity.interaction.ChatInputCommandInteraction
+import dev.kord.core.entity.interaction.GlobalChatInputCommandInteraction
 import dev.kord.core.entity.interaction.GuildChatInputCommandInteraction
 import dev.kord.rest.builder.message.modify.embed
 import org.springframework.boot.context.properties.EnableConfigurationProperties
@@ -41,9 +42,12 @@ class GetServerDetailsCommand(
     override suspend fun handle(interaction: ChatInputCommandInteraction) {
 
         val serverStatusMonitorId = interaction.getServerStatusMonitorIdParameter()
-        val discordServerId = (interaction as GuildChatInputCommandInteraction).guildId
 
-        val serverStatusMonitor = serverStatusMonitorRepository.getServerStatusMonitor(serverStatusMonitorId, discordServerId.toString())
+        val serverStatusMonitor = when (interaction) {
+            is GuildChatInputCommandInteraction -> serverStatusMonitorRepository.getServerStatusMonitor(serverStatusMonitorId, interaction.guildId.toString())
+            is GlobalChatInputCommandInteraction -> serverStatusMonitorRepository.getServerStatusMonitor(serverStatusMonitorId)
+        }
+
         if (serverStatusMonitor == null) {
             interaction.deferEphemeralResponse().respond {
                 content = "No server with id '$serverStatusMonitorId' was found."

diff --git a/src/main/kotlin/de/darkatra/vrising/discord/commands/ListServersCommand.kt b/src/main/kotlin/de/darkatra/vrising/discord/commands/ListServersCommand.kt
@@ -1,15 +1,20 @@
 package de.darkatra.vrising.discord.commands
 
+import de.darkatra.vrising.discord.BotProperties
 import de.darkatra.vrising.discord.serverstatus.ServerStatusMonitorRepository
+import de.darkatra.vrising.discord.serverstatus.model.ServerStatusMonitor
 import dev.kord.core.Kord
 import dev.kord.core.behavior.interaction.response.respond
 import dev.kord.core.entity.interaction.ChatInputCommandInteraction
+import dev.kord.core.entity.interaction.GlobalChatInputCommandInteraction
 import dev.kord.core.entity.interaction.GuildChatInputCommandInteraction
+import org.springframework.boot.context.properties.EnableConfigurationProperties
 import org.springframework.stereotype.Component
 
 @Component
+@EnableConfigurationProperties(BotProperties::class)
 class ListServersCommand(
-    private val serverStatusMonitorRepository: ServerStatusMonitorRepository,
+    private val serverStatusMonitorRepository: ServerStatusMonitorRepository
 ) : Command {
 
     private val name: String = "list-servers"
@@ -30,15 +35,16 @@ class ListServersCommand(
 
     override suspend fun handle(interaction: ChatInputCommandInteraction) {
 
-        val discordServerId = (interaction as GuildChatInputCommandInteraction).guildId
-
-        val serverStatusConfigurations = serverStatusMonitorRepository.getServerStatusMonitors(discordServerId.toString())
+        val serverStatusMonitors: List<ServerStatusMonitor> = when (interaction) {
+            is GuildChatInputCommandInteraction -> serverStatusMonitorRepository.getServerStatusMonitors(interaction.guildId.toString())
+            is GlobalChatInputCommandInteraction -> serverStatusMonitorRepository.getServerStatusMonitors()
+        }
 
         interaction.deferEphemeralResponse().respond {
-            content = when (serverStatusConfigurations.isEmpty()) {
+            content = when (serverStatusMonitors.isEmpty()) {
                 true -> "No servers found."
-                false -> serverStatusConfigurations.joinToString(separator = "\n") { serverStatusConfiguration ->
-                    "${serverStatusConfiguration.id} - ${serverStatusConfiguration.hostname}:${serverStatusConfiguration.queryPort} - ${serverStatusConfiguration.status.name}"
+                false -> serverStatusMonitors.joinToString(separator = "\n") { serverStatusMonitor ->
+                    "${serverStatusMonitor.id} - ${serverStatusMonitor.hostname}:${serverStatusMonitor.queryPort} - ${serverStatusMonitor.status.name}"
                 }
             }
         }

diff --git a/src/main/kotlin/de/darkatra/vrising/discord/commands/RemoveServerCommand.kt b/src/main/kotlin/de/darkatra/vrising/discord/commands/RemoveServerCommand.kt
@@ -6,12 +6,13 @@ import de.darkatra.vrising.discord.serverstatus.ServerStatusMonitorRepository
 import dev.kord.core.Kord
 import dev.kord.core.behavior.interaction.response.respond
 import dev.kord.core.entity.interaction.ChatInputCommandInteraction
+import dev.kord.core.entity.interaction.GlobalChatInputCommandInteraction
 import dev.kord.core.entity.interaction.GuildChatInputCommandInteraction
 import org.springframework.stereotype.Component
 
 @Component
 class RemoveServerCommand(
-    private val serverStatusMonitorRepository: ServerStatusMonitorRepository,
+    private val serverStatusMonitorRepository: ServerStatusMonitorRepository
 ) : Command {
 
     private val name: String = "remove-server"
@@ -35,9 +36,15 @@ class RemoveServerCommand(
     override suspend fun handle(interaction: ChatInputCommandInteraction) {
 
         val serverStatusMonitorId = interaction.getServerStatusMonitorIdParameter()
-        val discordServerId = (interaction as GuildChatInputCommandInteraction).guildId
 
-        val wasSuccessful = serverStatusMonitorRepository.removeServerStatusMonitor(serverStatusMonitorId, discordServerId.toString())
+        val wasSuccessful = when (interaction) {
+            is GuildChatInputCommandInteraction -> serverStatusMonitorRepository.removeServerStatusMonitor(
+                serverStatusMonitorId,
+                interaction.guildId.toString()
+            )
+
+            is GlobalChatInputCommandInteraction -> serverStatusMonitorRepository.removeServerStatusMonitor(serverStatusMonitorId)
+        }
 
         interaction.deferEphemeralResponse().respond {
             content = when (wasSuccessful) {

diff --git a/src/main/kotlin/de/darkatra/vrising/discord/commands/UpdateServerCommand.kt b/src/main/kotlin/de/darkatra/vrising/discord/commands/UpdateServerCommand.kt
@@ -27,6 +27,7 @@ import de.darkatra.vrising.discord.serverstatus.ServerStatusMonitorRepository
 import dev.kord.core.Kord
 import dev.kord.core.behavior.interaction.response.respond
 import dev.kord.core.entity.interaction.ChatInputCommandInteraction
+import dev.kord.core.entity.interaction.GlobalChatInputCommandInteraction
 import dev.kord.core.entity.interaction.GuildChatInputCommandInteraction
 import org.springframework.boot.context.properties.EnableConfigurationProperties
 import org.springframework.stereotype.Component
@@ -83,9 +84,11 @@ class UpdateServerCommand(
         val playerActivityFeedChannelId = interaction.getPlayerActivityFeedChannelIdParameter()
         val pvpKillFeedChannelId = interaction.getPvpKillFeedChannelIdParameter()
 
-        val discordServerId = (interaction as GuildChatInputCommandInteraction).guildId
+        val serverStatusMonitor = when (interaction) {
+            is GuildChatInputCommandInteraction -> serverStatusMonitorRepository.getServerStatusMonitor(serverStatusMonitorId, interaction.guildId.toString())
+            is GlobalChatInputCommandInteraction -> serverStatusMonitorRepository.getServerStatusMonitor(serverStatusMonitorId)
+        }
 
-        val serverStatusMonitor = serverStatusMonitorRepository.getServerStatusMonitor(serverStatusMonitorId, discordServerId.toString())
         if (serverStatusMonitor == null) {
             interaction.deferEphemeralResponse().respond {
                 content = "No server with id '$serverStatusMonitorId' was found."

diff --git a/src/main/kotlin/de/darkatra/vrising/discord/serverstatus/ServerStatusMonitorRepository.kt b/src/main/kotlin/de/darkatra/vrising/discord/serverstatus/ServerStatusMonitorRepository.kt
@@ -43,26 +43,39 @@ class ServerStatusMonitorRepository(
         repository.update(updateVersion(serverStatusMonitor))
     }
 
-    fun removeServerStatusMonitor(id: String, discordServerId: String): Boolean {
-        return repository.remove(ObjectFilters.eq("id", id).and(ObjectFilters.eq("discordServerId", discordServerId))).affectedCount > 0
-    }
+    fun removeServerStatusMonitor(id: String, discordServerId: String? = null): Boolean {
+        var objectFilter: ObjectFilter = ObjectFilters.eq("id", id)
 
-    fun getServerStatusMonitor(id: String, discordServerId: String): ServerStatusMonitor? {
-        return repository.find(ObjectFilters.eq("id", id).and(ObjectFilters.eq("discordServerId", discordServerId))).firstOrNull()
+        if (discordServerId != null) {
+            objectFilter += ObjectFilters.eq("discordServerId", discordServerId)
+        }
+
+        return repository.remove(objectFilter).affectedCount > 0
     }
 
-    fun getServerStatusMonitors(discordServerId: String? = null, status: ServerStatusMonitorStatus? = null): List<ServerStatusMonitor> {
+    fun getServerStatusMonitor(id: String, discordServerId: String? = null): ServerStatusMonitor? {
 
-        var objectFilter: ObjectFilter? = null
+        var objectFilter: ObjectFilter = ObjectFilters.eq("id", id)
 
-        // apply filters
         if (discordServerId != null) {
-            objectFilter = ObjectFilters.eq("discordServerId", discordServerId)
+            objectFilter += ObjectFilters.eq("discordServerId", discordServerId)
         }
-        if (status != null) {
-            objectFilter += ObjectFilters.eq("status", status)
+
+        return repository.find(objectFilter).firstOrNull()
+    }
+
+    fun getServerStatusMonitors(discordServerId: String? = null, status: ServerStatusMonitorStatus? = null): List<ServerStatusMonitor> {
+
+        val filters = buildList<ObjectFilter> {
+            if (discordServerId != null) {
+                add(ObjectFilters.eq("discordServerId", discordServerId))
+            }
+            if (status != null) {
+                add(ObjectFilters.eq("status", status))
+            }
         }
 
+        val objectFilter = filters.reduceOrNull { acc: ObjectFilter, objectFilter: ObjectFilter -> acc.and(objectFilter) }
         return when {
             objectFilter != null -> repository.find(objectFilter).toList()
             else -> repository.find().toList()

diff --git a/src/test/kotlin/de/darkatra/vrising/discord/BotPropertiesTest.kt b/src/test/kotlin/de/darkatra/vrising/discord/BotPropertiesTest.kt
@@ -86,6 +86,19 @@ class BotPropertiesTest {
         assertThat(result).hasSize(1)
     }
 
+    @ParameterizedTest
+    @ValueSource(strings = ["", "  ", "\t"])
+    fun `should be invalid if adminUserIds contains blank string`(adminUserId: String) {
+
+        val botProperties = getValidBotProperties().apply {
+            this.adminUserIds = setOf(adminUserId)
+        }
+
+        val result = validator.validate(botProperties)
+
+        assertThat(result).hasSize(1)
+    }
+
     private fun getValidBotProperties(): BotProperties {
         return BotProperties().apply {
             discordBotToken = "discord-token"
@@ -94,6 +107,7 @@ class BotPropertiesTest {
             databasePassword = "password"
             updateDelay = Duration.ofSeconds(30)
             maxFailedAttempts = 5
+            adminUserIds = setOf("test-admin-id")
         }
     }
 }