feat(command): update sub command system

shiron-dev · shiron-dev · commit a616e1b74d02 · 2023-12-30T20:59:09.000+09:00
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/controller/CommandController.kt b/src/main/kotlin/dev/shiron/kotodiscord/controller/CommandController.kt
@@ -2,74 +2,91 @@ package dev.shiron.kotodiscord.controller
 
 import dev.shiron.kotodiscord.util.BotSlashCommandData
 import dev.shiron.kotodiscord.util.RunnableCommandServiceClass
-import dev.shiron.kotodiscord.util.SubCommandsControllerClass
+import dev.shiron.kotodiscord.util.SingleCommandServiceClass
+import dev.shiron.kotodiscord.util.SubCommandServiceClass
+import dev.shiron.kotodiscord.util.meta.SubCommandGroupEnum
 import net.dv8tion.jda.api.events.interaction.command.CommandAutoCompleteInteractionEvent
 import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent
 import net.dv8tion.jda.api.hooks.ListenerAdapter
+import net.dv8tion.jda.api.interactions.commands.build.Commands
 import net.dv8tion.jda.api.interactions.commands.build.SlashCommandData
+import net.dv8tion.jda.api.interactions.commands.build.SubcommandData
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.context.MessageSource
 import org.springframework.stereotype.Controller
 import java.util.*
 
 @Controller
 class CommandController @Autowired constructor(
-    runnableCommandServices: List<RunnableCommandServiceClass>,
-    private val subCommandsControllers: List<SubCommandsControllerClass>,
+    private val singleCommandServices: List<SingleCommandServiceClass>,
+    private val subCommandServices: List<SubCommandServiceClass>,
     private val messages: MessageSource
 ) : ListenerAdapter() {
 
-    private val commandServices: List<RunnableCommandServiceClass> by lazy {
-        val commandServices = runnableCommandServices.toMutableList()
-        for (commandService in runnableCommandServices) {
-            if (subCommandsControllers.find { it.subcommands.contains(commandService) } !== null) {
-                commandServices.remove(commandService)
-            }
+    override fun onSlashCommandInteraction(event: SlashCommandInteractionEvent) {
+        val command = getCommand(event.name, event.subcommandName)
+
+        if (command != null) {
+            event
+                .deferReply()
+                .setEphemeral((event.getOption("shared")?.asBoolean?.not()) ?: command.sharedDefault.not())
+                .queue()
+            command.onSlashCommand(
+                BotSlashCommandData(
+                    event = event
+                )
+            )
+        } else {
+            event.reply(messages.getMessage("command.error.notfound", arrayOf(event.name), Locale.JAPAN)).queue()
         }
-        commandServices
     }
 
-    override fun onSlashCommandInteraction(event: SlashCommandInteractionEvent) {
-        if (event.subcommandName !== null) {
+    override fun onCommandAutoCompleteInteraction(event: CommandAutoCompleteInteractionEvent) {
+        val command = getCommand(event.name, event.subcommandName)
+        command?.onAutoComplete(event)
+    }
+
+    fun getCommand(name: String, subcommandName: String?): RunnableCommandServiceClass? {
+        if (subcommandName !== null) {
             // Subcommand
-            for (subCommandsController in subCommandsControllers) {
-                if (subCommandsController.meta.name == event.name) {
-                    subCommandsController.onSlashCommand(
-                        BotSlashCommandData(
-                            event = event
-                        )
-                    )
-                    return
+            for (command in subCommandServices) {
+                if (command.commandMeta.metadata.commandName == subcommandName && command.commandMeta.group.metadata.commandName == name) {
+                    return command
                 }
             }
         } else {
-            for (command in commandServices) {
-                if (command.meta.name == event.name) {
-                    event
-                        .deferReply()
-                        .setEphemeral((event.getOption("shared")?.asBoolean?.not()) ?: command.sharedDefault.not())
-                        .queue()
-                    command.onSlashCommand(
-                        BotSlashCommandData(
-                            event = event
-                        )
-                    )
-                    return
+            // Single command
+            for (command in singleCommandServices) {
+                if (command.commandMeta.metadata.commandName == name) {
+                    return command
                 }
             }
         }
-        event.reply(messages.getMessage("command.error.notfound", arrayOf(event.name), Locale.JAPAN)).queue()
+        return null
     }
 
-    override fun onCommandAutoCompleteInteraction(event: CommandAutoCompleteInteractionEvent) {
-        for (command in commandServices) {
-            if (command.meta.name == event.name) {
-                command.onAutoComplete(event)
+    fun getCommandsData(): List<SlashCommandData> {
+        val subcommands = mutableMapOf<SubCommandGroupEnum, MutableList<SubCommandServiceClass>>()
+        for (command in subCommandServices) {
+            if (!subcommands.containsKey(command.commandMeta.group)) {
+                subcommands[command.commandMeta.group] = mutableListOf()
             }
+            subcommands[command.commandMeta.group]?.add(command)
+        }
+        val subCommandsData = subcommands.map {
+            Commands.slash(
+                it.key.metadata.commandName,
+                messages.getMessage(
+                    "command.description.${it.key.metadata.commandName}",
+                    arrayOf(),
+                    Locale.JAPAN
+                )
+            ).addSubcommands(it.value.map { toSubcommandData(it.slashCommandData) })
         }
+        return singleCommandServices.map { it.slashCommandData } + subCommandsData
     }
+}
 
-    fun getCommandsData(): List<SlashCommandData> {
-        return commandServices.map { it.slashCommandData } + subCommandsControllers.map { it.slashCommandData }
-    }
+private fun toSubcommandData(slashCommandData: SlashCommandData): SubcommandData {
+    return SubcommandData(slashCommandData.name, slashCommandData.description)
 }
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/controller/VCController.kt b/src/main/kotlin/dev/shiron/kotodiscord/controller/VCController.kt
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/service/command/HelloService.kt b/src/main/kotlin/dev/shiron/kotodiscord/service/command/HelloService.kt
@@ -1,16 +1,16 @@
 package dev.shiron.kotodiscord.service.command
 
 import dev.shiron.kotodiscord.util.BotSlashCommandData
-import dev.shiron.kotodiscord.util.RunnableCommandServiceClass
-import dev.shiron.kotodiscord.util.meta.RunnableCommandEnum
+import dev.shiron.kotodiscord.util.SingleCommandServiceClass
+import dev.shiron.kotodiscord.util.meta.SingleCommandEnum
 import org.springframework.beans.factory.annotation.Autowired
 import org.springframework.context.MessageSource
 import org.springframework.stereotype.Service
 import java.util.*
 
 @Service
-class HelloService @Autowired constructor(private val messages: MessageSource) : RunnableCommandServiceClass(
-    RunnableCommandEnum.HELLO.meta,
+class HelloService @Autowired constructor(private val messages: MessageSource) : SingleCommandServiceClass(
+    SingleCommandEnum.HELLO,
     messages
 ) {
     override fun onSlashCommand(cmd: BotSlashCommandData) {
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/service/command/HelpService.kt b/src/main/kotlin/dev/shiron/kotodiscord/service/command/HelpService.kt
@@ -1,8 +1,8 @@
 package dev.shiron.kotodiscord.service.command
 
 import dev.shiron.kotodiscord.util.BotSlashCommandData
-import dev.shiron.kotodiscord.util.RunnableCommandServiceClass
-import dev.shiron.kotodiscord.util.meta.RunnableCommandEnum
+import dev.shiron.kotodiscord.util.SingleCommandServiceClass
+import dev.shiron.kotodiscord.util.meta.SingleCommandEnum
 import net.dv8tion.jda.api.events.interaction.command.CommandAutoCompleteInteractionEvent
 import net.dv8tion.jda.api.interactions.commands.OptionType
 import net.dv8tion.jda.api.interactions.commands.build.OptionData
@@ -14,8 +14,8 @@ import java.util.*
 @Service
 class HelpService @Autowired constructor(
     private val messages: MessageSource
-) : RunnableCommandServiceClass(
-    RunnableCommandEnum.HELP.meta,
+) : SingleCommandServiceClass(
+    SingleCommandEnum.HELP,
     messages
 ) {
 
@@ -31,7 +31,7 @@ class HelpService @Autowired constructor(
     override fun onAutoComplete(event: CommandAutoCompleteInteractionEvent) {
         when (event.focusedOption.name) {
             "command" -> {
-                val commands = RunnableCommandEnum.values().map { it.meta.name }
+                val commands = SingleCommandEnum.values().map { it.metadata.commandName }
                 event.replyChoiceStrings(
                     commands.filter {
                         it.startsWith(event.focusedOption.value.lowercase())
@@ -43,7 +43,7 @@ class HelpService @Autowired constructor(
 
     override fun onSlashCommand(cmd: BotSlashCommandData) {
         val command = cmd.event.getOption("command")?.asString?.lowercase()
-        val commands = RunnableCommandEnum.values().map { it.meta.name }
+        val commands = SingleCommandEnum.values().map { it.metadata.commandName }
         if (command != null) {
             if (commands.contains(command)) {
                 cmd.reply("### $command\n${getHelp(command)}")
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/BotServiceClass.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/BotServiceClass.kt
@@ -3,5 +3,5 @@ package dev.shiron.kotodiscord.util
 import dev.shiron.kotodiscord.util.meta.BotServiceMeta
 
 abstract class BotServiceClass(
-    val meta: BotServiceMeta
+    val serviceMeta: BotServiceMeta
 )
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/RunnableCommandServiceClass.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/RunnableCommandServiceClass.kt
@@ -9,7 +9,7 @@ import net.dv8tion.jda.api.interactions.commands.build.SlashCommandData
 import org.springframework.context.MessageSource
 import java.util.*
 
-abstract class RunnableCommandServiceClass(meta: RunnableCommandMeta, private val messages: MessageSource, val sharedDefault: Boolean = false) : BotServiceClass(meta) {
+abstract class RunnableCommandServiceClass(val runMeta: RunnableCommandMeta, private val messages: MessageSource, val sharedDefault: Boolean = false) : BotServiceClass(runMeta) {
 
     open val commandOptions: List<OptionData> = listOf()
 
@@ -22,7 +22,7 @@ abstract class RunnableCommandServiceClass(meta: RunnableCommandMeta, private va
     }
 
     open val slashCommandData: SlashCommandData
-        get() = Commands.slash(meta.name, messages.getMessage("command.description.${meta.name}", arrayOf(), Locale.JAPAN)).addOptions(commandOptions)
+        get() = Commands.slash(runMeta.commandName, messages.getMessage("command.description.${runMeta.commandName}", arrayOf(), Locale.JAPAN)).addOptions(commandOptions)
             .addOptions(sharedOptionData)
 
     abstract fun onSlashCommand(cmd: BotSlashCommandData)
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/SingleCommandServiceClass.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/SingleCommandServiceClass.kt
@@ -0,0 +1,6 @@
+package dev.shiron.kotodiscord.util
+
+import dev.shiron.kotodiscord.util.meta.SingleCommandEnum
+import org.springframework.context.MessageSource
+
+abstract class SingleCommandServiceClass(val commandMeta: SingleCommandEnum, messages: MessageSource) : RunnableCommandServiceClass(commandMeta.metadata, messages)
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/SubCommandServiceClass.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/SubCommandServiceClass.kt
@@ -7,12 +7,11 @@ import org.springframework.context.MessageSource
 import java.util.*
 
 abstract class SubCommandServiceClass(
-    meta: SubCommandEnum,
+    val commandMeta: SubCommandEnum,
     private val messages: MessageSource
-) : RunnableCommandServiceClass(meta.meta, messages) {
+) : RunnableCommandServiceClass(commandMeta.metadata, messages) {
 
     override val slashCommandData: SlashCommandData
-        // TODO: group.name
-        get() = Commands.slash(meta.name, messages.getMessage("command.description.${meta.name}", arrayOf(), Locale.JAPAN)).addOptions(commandOptions)
+        get() = Commands.slash(commandMeta.metadata.commandName, messages.getMessage("command.description.${commandMeta.group.metadata.commandName}.${commandMeta.metadata.commandName}", arrayOf(), Locale.JAPAN)).addOptions(commandOptions)
             .addOptions(sharedOptionData)
 }
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/SubCommandsControllerClass.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/SubCommandsControllerClass.kt
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/meta/BotServiceMeta.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/meta/BotServiceMeta.kt
@@ -1,5 +1,5 @@
 package dev.shiron.kotodiscord.util.meta
 
 interface BotServiceMeta {
-    val name: String
+    val commandName: String
 }
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/meta/BotSubCommandGroupMeta.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/meta/BotSubCommandGroupMeta.kt
@@ -1,3 +1,3 @@
 package dev.shiron.kotodiscord.util.meta
 
-data class BotSubCommandGroupMeta(override val name: String) : BotServiceMeta
+data class BotSubCommandGroupMeta(override val commandName: String) : BotServiceMeta
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/meta/RunnableCommandMeta.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/meta/RunnableCommandMeta.kt
@@ -1,3 +1,3 @@
 package dev.shiron.kotodiscord.util.meta
 
-data class RunnableCommandMeta(override val name: String) : BotServiceMeta
+data class RunnableCommandMeta(override val commandName: String) : BotServiceMeta
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/meta/SingleCommandEnum.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/meta/SingleCommandEnum.kt
@@ -1,6 +1,6 @@
 package dev.shiron.kotodiscord.util.meta
 
-enum class RunnableCommandEnum(val meta: RunnableCommandMeta) {
+enum class SingleCommandEnum(val metadata: RunnableCommandMeta) {
     HELLO(RunnableCommandMeta("hello")),
     HELP(RunnableCommandMeta("help"))
 }
diff --git a/src/main/kotlin/dev/shiron/kotodiscord/util/meta/SubCommandGroupEnum.kt b/src/main/kotlin/dev/shiron/kotodiscord/util/meta/SubCommandGroupEnum.kt
@@ -1,11 +1,11 @@
 package dev.shiron.kotodiscord.util.meta
 
-enum class SubCommandGroupEnum(val meta: BotSubCommandGroupMeta) {
+enum class SubCommandGroupEnum(val metadata: BotSubCommandGroupMeta) {
     VC_NOTIFICATION(BotSubCommandGroupMeta("vc_notification"))
 }
 
-enum class SubCommandEnum(val meta: RunnableCommandMeta) {
-    VC_NOTIFICATION_SET(RunnableCommandMeta("set")),
-    VC_NOTIFICATION_REMOVE(RunnableCommandMeta("remove")),
-    VC_NOTIFICATION_LIST(RunnableCommandMeta("list"))
+enum class SubCommandEnum(val metadata: RunnableCommandMeta, val group: SubCommandGroupEnum) {
+    VC_NOTIFICATION_SET(RunnableCommandMeta("set"), SubCommandGroupEnum.VC_NOTIFICATION),
+    VC_NOTIFICATION_REMOVE(RunnableCommandMeta("remove"), SubCommandGroupEnum.VC_NOTIFICATION),
+    VC_NOTIFICATION_LIST(RunnableCommandMeta("list"), SubCommandGroupEnum.VC_NOTIFICATION)
 }
diff --git a/src/main/resources/messages.properties b/src/main/resources/messages.properties
@@ -10,9 +10,9 @@ command.option.command = コマンド名。省略でコマンド一覧を表示
 command.description.hello = ことが挨拶を返します
 command.description.help = ボットのヘルプを表示します
 command.description.vc_notification = ボイスチャンネルの入退室を通知します
-command.description.set = ボイスチャンネルの入退室を通知するかどうかを設定します
-command.description.list = ボイスチャンネルの入退室を通知するの設定を表示します
-command.description.remove = ボイスチャンネルの入退室を通知を解除します
+command.description.vc_notification.set = ボイスチャンネルの入退室を通知するかどうかを設定します
+command.description.vc_notification.list = ボイスチャンネルの入退室を通知するの設定を表示します
+command.description.vc_notification.remove = ボイスチャンネルの入退室を通知を解除します
 
 command.error.notfound = {0}が見つかりませんでした。\n\
   内部のエラーかもしれません...ごめんね><

Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,5 @@ package dev.shiron.kotodiscord.util`
`3`	`3`	`import dev.shiron.kotodiscord.util.meta.BotServiceMeta`
`4`	`4`
`5`	`5`	`abstract class BotServiceClass(`
`6`		`- val meta: BotServiceMeta`
	`6`	`+ val serviceMeta: BotServiceMeta`
`7`	`7`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`package dev.shiron.kotodiscord.util.meta`
`2`	`2`
`3`	`3`	`interface BotServiceMeta {`
`4`		`- val name: String`
	`4`	`+ val commandName: String`
`5`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`package dev.shiron.kotodiscord.util.meta`
`2`	`2`
`3`		`-data class BotSubCommandGroupMeta(override val name: String) : BotServiceMeta`
	`3`	`+data class BotSubCommandGroupMeta(override val commandName: String) : BotServiceMeta`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`package dev.shiron.kotodiscord.util.meta`
`2`	`2`
`3`		`-data class RunnableCommandMeta(override val name: String) : BotServiceMeta`
	`3`	`+data class RunnableCommandMeta(override val commandName: String) : BotServiceMeta`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`package dev.shiron.kotodiscord.util.meta`
`2`	`2`
`3`		`-enum class RunnableCommandEnum(val meta: RunnableCommandMeta) {`
	`3`	`+enum class SingleCommandEnum(val metadata: RunnableCommandMeta) {`
`4`	`4`	`HELLO(RunnableCommandMeta("hello")),`
`5`	`5`	`HELP(RunnableCommandMeta("help"))`
`6`	`6`	`}`