feat: ピン止めメッセージの読み上げ

src/main/kotlin/com/jaoafa/vcspeaker/events/NewMessageEvent.kt

@@ -6,12 +6,12 @@ import com.jaoafa.vcspeaker.tools.discord.DiscordExtensions.autoJoinEnabled
 import com.jaoafa.vcspeaker.tools.discord.DiscordExtensions.isAfk
 import com.jaoafa.vcspeaker.tools.discord.VoiceExtensions.join
 import com.jaoafa.vcspeaker.tts.narrators.Narrators.narrator
+import dev.kord.core.event.message.MessageCreateEvent
 import dev.kordex.core.checks.anyGuild
 import dev.kordex.core.checks.isNotBot
 import dev.kordex.core.extensions.Extension
 import dev.kordex.core.extensions.event
 import dev.kordex.core.utils.respond
-import dev.kord.core.event.message.MessageCreateEvent
 import io.github.oshai.kotlinlogging.KotlinLogging
 
 class NewMessageEvent : Extension() {
@@ -29,6 +29,8 @@ class NewMessageEvent : Extension() {
                 if (!GuildStore.getTextChannels().contains(event.message.channelId)) return@action
                 if (event.message.content.startsWith(VCSpeaker.prefix)) return@action
 
+                logger.info { "Message Received: ${event.message.type}" }
+
                 val guild = event.getGuildOrNull() ?: return@action
 
                 val narratorActive = guild.narrator() != null

src/main/kotlin/com/jaoafa/vcspeaker/tts/narrators/Narrator.kt

@@ -10,8 +10,6 @@ import com.jaoafa.vcspeaker.tts.TrackType
 import com.jaoafa.vcspeaker.tts.Voice
 import com.jaoafa.vcspeaker.tts.narrators.Narrators.narrator
 import com.jaoafa.vcspeaker.tts.processors.BaseProcessor
-import dev.kordex.core.utils.addReaction
-import dev.kordex.core.utils.deleteOwnReaction
 import com.sedmelluq.discord.lavaplayer.player.AudioPlayer
 import dev.kord.common.annotation.KordVoice
 import dev.kord.common.entity.Snowflake
@@ -20,6 +18,8 @@ import dev.kord.core.entity.Message
 import dev.kord.core.entity.ReactionEmoji
 import dev.kord.core.entity.channel.TextChannel
 import dev.kord.voice.VoiceConnection
+import dev.kordex.core.utils.addReaction
+import dev.kordex.core.utils.deleteOwnReaction
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
@@ -130,6 +130,7 @@ class Narrator @OptIn(KordVoice::class) constructor(
 
         return processors.fold(text to voice) { (processText, processVoice), processor ->
             val (processedText, processedVoice) = processor.process(message, processText, processVoice)
+            println("Processed by ${processor::class.simpleName}: $processedText [isCancelled=${processor.isCancelled()}, isImmediately=${processor.isImmediately()}]")
             if (processor.isCancelled()) return null // キャンセルされた場合は、即座に null を返却。
             if (processor.isImmediately()) return processedText to processedVoice // 即座に返す場合は、このProcessorを最後とし読み上げる
 

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/AttachmentProcessor.kt

@@ -4,18 +4,18 @@ import com.jaoafa.vcspeaker.StringUtils.substringByCodePoints
 import com.jaoafa.vcspeaker.stores.VisionApiCounterStore
 import com.jaoafa.vcspeaker.tools.VisionApi
 import com.jaoafa.vcspeaker.tts.Voice
-import dev.kordex.core.utils.download
 import com.sksamuel.scrimage.ImmutableImage
 import com.sksamuel.scrimage.nio.PngWriter
 import dev.kord.core.behavior.reply
 import dev.kord.core.entity.Message
 import dev.kord.rest.builder.message.EmbedBuilder
 import dev.kord.rest.builder.message.addFile
+import dev.kordex.core.utils.download
 import java.io.File
 import java.nio.file.Path
 
 class AttachmentProcessor : BaseProcessor() {
-    override val priority = 30
+    override val priority = 40
 
     override suspend fun process(message: Message?, content: String, voice: Voice): Pair<String, Voice> {
         val attachments = message?.attachments ?: return content to voice

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/CharLimitProcessor.kt

@@ -6,7 +6,7 @@ import com.jaoafa.vcspeaker.tts.Voice
 import dev.kord.core.entity.Message
 
 class CharLimitProcessor : BaseProcessor() {
-    override val priority = 110
+    override val priority = 120
 
     override suspend fun process(message: Message?, content: String, voice: Voice): Pair<String, Voice> {
         val limit = 180

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/IgnoreAfterReplaceProcessor.kt

@@ -5,7 +5,7 @@ import com.jaoafa.vcspeaker.tts.Voice
 import dev.kord.core.entity.Message
 
 class IgnoreAfterReplaceProcessor : BaseProcessor() {
-    override val priority = 70
+    override val priority = 80
 
     override suspend fun process(message: Message?, content: String, voice: Voice): Pair<String, Voice> {
         val guildId = message?.getGuild()?.id ?: return content to voice

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/IgnoreBeforeReplaceProcessor.kt

@@ -5,7 +5,7 @@ import com.jaoafa.vcspeaker.tts.Voice
 import dev.kord.core.entity.Message
 
 class IgnoreBeforeReplaceProcessor : BaseProcessor() {
-    override val priority = 50
+    override val priority = 60
 
     override suspend fun process(message: Message?, content: String, voice: Voice): Pair<String, Voice> {
         val guildId = message?.getGuild()?.id ?: return content to voice

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/InlineVoiceProcessor.kt

@@ -3,11 +3,11 @@ package com.jaoafa.vcspeaker.tts.processors
 import com.jaoafa.vcspeaker.tts.Voice
 import com.jaoafa.vcspeaker.tts.api.Emotion
 import com.jaoafa.vcspeaker.tts.api.Speaker
-import dev.kordex.core.utils.capitalizeWords
 import dev.kord.core.entity.Message
+import dev.kordex.core.utils.capitalizeWords
 
 class InlineVoiceProcessor : BaseProcessor() {
-    override val priority = 40
+    override val priority = 50
 
     private val syntax = Regex("(speaker|emotion|emotion_level|pitch|speed|volume):\\w+")
 

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/MarkdownFormatProcessor.kt

@@ -7,7 +7,7 @@ import com.jaoafa.vcspeaker.tts.markdown.toMarkdown
 import dev.kord.core.entity.Message
 
 class MarkdownFormatProcessor : BaseProcessor() {
-    override val priority = 80
+    override val priority = 90
 
     override suspend fun process(message: Message?, content: String, voice: Voice): Pair<String, Voice> {
         val markdown = content.toMarkdown()

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/PinMessageProcessor.kt

@@ -0,0 +1,23 @@
+package com.jaoafa.vcspeaker.tts.processors
+
+import com.jaoafa.vcspeaker.tts.Voice
+import dev.kord.common.entity.MessageType
+import dev.kord.core.entity.Message
+import dev.kord.core.entity.effectiveName
+
+class PinMessageProcessor : BaseProcessor() {
+    override val priority = 20
+
+    override suspend fun process(message: Message?, content: String, voice: Voice): Pair<String, Voice> {
+        if (message?.type != MessageType.ChannelPinnedMessage) return content to voice
+
+        val executorUserName = message.author?.effectiveName ?: "だれか"
+
+        val messageReference = message.messageReference ?: return content to voice
+        val pinnedMessageId = messageReference.message?.id ?: return content to voice
+        val pinnedMessage = message.channel.getMessage(pinnedMessageId)
+        val pinnedMessageUserName = pinnedMessage.author?.effectiveName ?: "だれか"
+
+        return "$executorUserName が $pinnedMessageUserName のメッセージをピン止めしました" to voice
+    }
+}

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/ReplacerProcessor.kt

@@ -8,7 +8,7 @@ import com.jaoafa.vcspeaker.tts.replacers.BaseReplacer
 import dev.kord.core.entity.Message
 
 class ReplacerProcessor : BaseProcessor() {
-    override val priority = 60
+    override val priority = 70
 
     val replacers = getClassesIn<BaseReplacer>("com.jaoafa.vcspeaker.tts.replacers")
         .mapNotNull {

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/ReplyProcessor.kt

@@ -1,14 +1,17 @@
 package com.jaoafa.vcspeaker.tts.processors
 
 import com.jaoafa.vcspeaker.tts.Voice
+import dev.kord.common.entity.MessageType
 import dev.kord.core.entity.Message
 import dev.kord.core.entity.effectiveName
 
 class ReplyProcessor : BaseProcessor() {
     override val priority = 10
 
     override suspend fun process(message: Message?, content: String, voice: Voice): Pair<String, Voice> {
-        val referencedMessage = message?.referencedMessage ?: return content to voice
+        if (message?.type != MessageType.Reply) return content to voice
+
+        val referencedMessage = message.referencedMessage ?: return content to voice
         val replyToName = referencedMessage.author?.effectiveName ?: "だれか"
         return "$replyToName への返信、$content" to voice
     }

src/main/kotlin/com/jaoafa/vcspeaker/tts/processors/StickerProcessor.kt

@@ -4,7 +4,7 @@ import com.jaoafa.vcspeaker.tts.Voice
 import dev.kord.core.entity.Message
 
 class StickerProcessor : BaseProcessor() {
-    override val priority = 20
+    override val priority = 30
 
     override suspend fun process(message: Message?, content: String, voice: Voice): Pair<String, Voice> {
         val stickers = message?.stickers ?: return content to voice

src/test/kotlin/processors/PinMessageProcessorTest.kt

@@ -0,0 +1,84 @@
+package processors
+
+import com.jaoafa.vcspeaker.tts.Voice
+import com.jaoafa.vcspeaker.tts.api.Speaker
+import com.jaoafa.vcspeaker.tts.processors.PinMessageProcessor
+import dev.kord.common.entity.MessageType
+import dev.kord.common.entity.Snowflake
+import dev.kord.core.entity.Message
+import dev.kord.core.entity.MessageReference
+import dev.kord.core.entity.effectiveName
+import io.kotest.core.spec.style.FunSpec
+import io.kotest.matchers.shouldBe
+import io.mockk.clearAllMocks
+import io.mockk.coEvery
+import io.mockk.every
+import io.mockk.mockk
+
+/**
+ * PinMessageProcessor のテスト
+ */
+class PinMessageProcessorTest : FunSpec({
+    // テスト後にモックを削除
+    afterTest {
+        clearAllMocks()
+    }
+
+    // メッセージにピン止めするとき、ピン止めした旨を読み上げる
+    test("If the message is a pinned notify message, read that the message is pinned.") {
+        val message = mockk<Message>()
+
+        every { message.type } returns MessageType.ChannelPinnedMessage
+
+        val messageReference = mockk<MessageReference>()
+        every { messageReference.message?.id } returns Snowflake(123)
+
+        every { message.author?.effectiveName } returns "User"
+        every { message.messageReference } returns messageReference
+
+        val pinnedMessage = mockk<Message>()
+        every { pinnedMessage.author?.effectiveName } returns "PinnedUser"
+        coEvery { message.channel.getMessage(Snowflake(123)) } returns pinnedMessage
+
+        val voice = Voice(speaker = Speaker.Hikari)
+
+        val (processedText, processedVoice) = PinMessageProcessor().process(message, "", voice)
+        processedText shouldBe "User が PinnedUser のメッセージをピン止めしました"
+        processedVoice shouldBe voice
+    }
+
+    // 返信メッセージでない場合、そのまま読み上げる
+    test("If the message is not a pinned notify message, read it as is.") {
+        val message = mockk<Message>()
+        every { message.type } returns MessageType.Default
+        every { message.referencedMessage } returns null
+
+        val voice = Voice(speaker = Speaker.Hikari)
+        val (processedText, processedVoice) = PinMessageProcessor().process(message, "", voice)
+        processedText shouldBe ""
+        processedVoice shouldBe voice
+    }
+
+    // 作者のないメッセージをピン止めすると、不明なメッセージをピン止めしたものとして読み上げる
+    test("If the message is a pinned notify message but the author of the pinned message is unknown, read it as a pinned to an unknown author.") {
+        val message = mockk<Message>()
+
+        every { message.type } returns MessageType.ChannelPinnedMessage
+
+        val messageReference = mockk<MessageReference>()
+        every { messageReference.message?.id } returns Snowflake(123)
+
+        every { message.author?.effectiveName } returns "User"
+        every { message.messageReference } returns messageReference
+
+        val pinnedMessage = mockk<Message>()
+        every { pinnedMessage.author } returns null
+        coEvery { message.channel.getMessage(Snowflake(123)) } returns pinnedMessage
+
+        val voice = Voice(speaker = Speaker.Hikari)
+
+        val (processedText, processedVoice) = PinMessageProcessor().process(message, "", voice)
+        processedText shouldBe "User が だれか のメッセージをピン止めしました"
+        processedVoice shouldBe voice
+    }
+})

src/test/kotlin/processors/ReplyProcessorTest.kt

@@ -3,6 +3,7 @@ package processors
 import com.jaoafa.vcspeaker.tts.Voice
 import com.jaoafa.vcspeaker.tts.api.Speaker
 import com.jaoafa.vcspeaker.tts.processors.ReplyProcessor
+import dev.kord.common.entity.MessageType
 import dev.kord.core.entity.Message
 import dev.kord.core.entity.effectiveName
 import io.kotest.core.spec.style.FunSpec
@@ -23,6 +24,7 @@ class ReplyProcessorTest : FunSpec({
     // メッセージに返信するとき、返信先のユーザー名を読み上げる
     test("If the message is a reply, read the author name of the replied message.") {
         val message = mockk<Message>()
+        every { message.type } returns MessageType.Reply
         every { message.referencedMessage } returns mockk {
             every { author?.effectiveName } returns "User"
         }
@@ -37,6 +39,7 @@ class ReplyProcessorTest : FunSpec({
     // 返信メッセージでない場合、そのまま読み上げる
     test("If the message is not a reply, read it as is.") {
         val message = mockk<Message>()
+        every { message.type } returns MessageType.Default
         every { message.referencedMessage } returns null
 
         val voice = Voice(speaker = Speaker.Hikari)
@@ -48,6 +51,7 @@ class ReplyProcessorTest : FunSpec({
     // 作者のないメッセージに返信すると、不明な返信として読み上げる
     test("If the message is a reply but the author of the replied message is unknown, read it as a reply to an unknown author.") {
         val message = mockk<Message>()
+        every { message.type } returns MessageType.Reply
         every { message.referencedMessage } returns mockk {
             every { author?.globalName } returns null
             every { author?.username } returns null