[core] Rename CommonRoamingMessagesImpl to TimeBasedRoamingMessagesImpl. Extract RoamingMessagesImplFriend

mirai-core/src/commonMain/kotlin/contact/roaming/AbstractRoamingMessages.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019-2022 Mamoe Technologies and contributors.
+ *
+ * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
+ * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
+ *
+ * https://github.com/mamoe/mirai/blob/dev/LICENSE
+ */
+
+package net.mamoe.mirai.internal.contact.roaming
+
+import net.mamoe.mirai.contact.Contact
+import net.mamoe.mirai.contact.roaming.RoamingMessage
+import net.mamoe.mirai.contact.roaming.RoamingMessages
+import net.mamoe.mirai.internal.contact.AbstractContact
+import net.mamoe.mirai.internal.network.protocol.data.proto.MsgComm
+import net.mamoe.mirai.utils.mapToIntArray
+import net.mamoe.mirai.utils.toLongUnsigned
+
+internal abstract class AbstractRoamingMessages : RoamingMessages {
+    abstract val contact: AbstractContact
+
+    protected fun createRoamingMessage(
+        message: MsgComm.Msg,
+        messages: List<MsgComm.Msg>
+    ) = object : RoamingMessage {
+        override val contact: Contact get() = this@AbstractRoamingMessages.contact
+        override val sender: Long get() = message.msgHead.fromUin
+        override val target: Long
+            get() = message.msgHead.groupInfo?.groupCode ?: message.msgHead.toUin
+        override val time: Long get() = message.msgHead.msgTime.toLongUnsigned()
+        override val ids: IntArray by lazy { messages.mapToIntArray { it.msgHead.msgSeq } }
+        override val internalIds: IntArray by lazy {
+            messages.mapToIntArray { it.msgBody.richText.attr?.random ?: 0 } // other client 消息的这个是0
+        }
+    }
+}

mirai-core/src/commonMain/kotlin/contact/roaming/RoamingMessagesImpl.kt

@@ -1,180 +0,0 @@
-/*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
- *
- * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
- * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
- *
- * https://github.com/mamoe/mirai/blob/dev/LICENSE
- */
-
-@file:Suppress("INVISIBLE_REFERENCE", "INVISIBLE_MEMBER")
-
-package net.mamoe.mirai.internal.contact.roaming
-
-import kotlinx.coroutines.currentCoroutineContext
-import kotlinx.coroutines.flow.Flow
-import kotlinx.coroutines.flow.flow
-import kotlinx.coroutines.isActive
-import net.mamoe.mirai.contact.Contact
-import net.mamoe.mirai.contact.roaming.RoamingMessage
-import net.mamoe.mirai.contact.roaming.RoamingMessageFilter
-import net.mamoe.mirai.contact.roaming.RoamingMessages
-import net.mamoe.mirai.internal.contact.AbstractContact
-import net.mamoe.mirai.internal.contact.CommonGroupImpl
-import net.mamoe.mirai.internal.contact.FriendImpl
-import net.mamoe.mirai.internal.message.toMessageChainOnline
-import net.mamoe.mirai.internal.network.protocol.data.proto.MsgComm
-import net.mamoe.mirai.internal.network.protocol.packet.chat.TroopManagement
-import net.mamoe.mirai.internal.network.protocol.packet.chat.receive.MessageSvcPbGetGroupMsg
-import net.mamoe.mirai.internal.network.protocol.packet.chat.receive.MessageSvcPbGetRoamMsgReq
-import net.mamoe.mirai.internal.utils.indexFirstBE
-import net.mamoe.mirai.message.data.MessageChain
-import net.mamoe.mirai.utils.check
-import net.mamoe.mirai.utils.mapToIntArray
-import net.mamoe.mirai.utils.toLongUnsigned
-
-internal abstract class CommonRoamingMessagesImpl : RoamingMessages {
-    abstract val contact: AbstractContact
-
-    override suspend fun getMessagesIn(
-        timeStart: Long,
-        timeEnd: Long,
-        filter: RoamingMessageFilter?
-    ): Flow<MessageChain> {
-        return flow {
-            var lastMessageTime = timeEnd.coerceAtLeast(timeStart).coerceAtLeast(1)
-            var random = 0L
-            while (currentCoroutineContext().isActive) {
-                val resp = requestRoamMsg(timeStart, lastMessageTime, random)
-                val messages = resp.messages ?: break
-                if (filter == null || filter === RoamingMessageFilter.ANY) {
-                    // fast path
-                    messages.forEach { emit(it.toMessageChainOnline(contact.bot)) }
-                } else {
-                    for (message in messages) {
-                        if (filter.invoke(createRoamingMessage(message, messages))) {
-                            emit(message.toMessageChainOnline(contact.bot))
-                        }
-                    }
-                }
-
-                lastMessageTime = resp.lastMessageTime
-                random = resp.random
-            }
-        }
-    }
-
-    protected fun createRoamingMessage(
-        message: MsgComm.Msg,
-        messages: List<MsgComm.Msg>
-    ) = object : RoamingMessage {
-        override val contact: Contact get() = this@CommonRoamingMessagesImpl.contact
-        override val sender: Long get() = message.msgHead.fromUin
-        override val target: Long
-            get() = message.msgHead.groupInfo?.groupCode ?: message.msgHead.toUin
-        override val time: Long get() = message.msgHead.msgTime.toLongUnsigned()
-        override val ids: IntArray by lazy { messages.mapToIntArray { it.msgHead.msgSeq } }
-        override val internalIds: IntArray by lazy {
-            messages.mapToIntArray { it.msgBody.richText.attr?.random ?: 0 } // other client 消息的这个是0
-        }
-    }
-
-    abstract suspend fun requestRoamMsg(
-        timeStart: Long,
-        lastMessageTime: Long,
-        random: Long
-    ): MessageSvcPbGetRoamMsgReq.Response
-}
-
-
-internal expect sealed class RoamingMessagesImpl() : CommonRoamingMessagesImpl
-
-internal class RoamingMessagesImplFriend(
-    override val contact: FriendImpl
-) : RoamingMessagesImpl() {
-    override suspend fun requestRoamMsg(
-        timeStart: Long,
-        lastMessageTime: Long,
-        random: Long
-    ): MessageSvcPbGetRoamMsgReq.Response {
-        return contact.bot.network.sendAndExpect(
-            MessageSvcPbGetRoamMsgReq.createForFriend(
-                client = contact.bot.client,
-                uin = contact.id,
-                timeStart = timeStart,
-                lastMsgTime = lastMessageTime,
-                random = random,
-                maxCount = 1000,
-                sig = byteArrayOf(),
-                pwd = byteArrayOf()
-            )
-        ).value.check()
-    }
-}
-
-internal class RoamingMessagesImplGroup(
-    override val contact: CommonGroupImpl
-) : RoamingMessagesImpl() {
-    override suspend fun requestRoamMsg(
-        timeStart: Long,
-        lastMessageTime: Long,
-        random: Long // unused field
-    ): MessageSvcPbGetRoamMsgReq.Response {
-        val lastMsgSeq = contact.bot.network.sendAndExpect(
-            TroopManagement.GetGroupLastMsgSeq(
-                client = contact.bot.client,
-                groupUin = contact.uin
-            )
-        )
-        return when(lastMsgSeq) {
-            is TroopManagement.GetGroupLastMsgSeq.Response.Success -> {
-                val results = mutableListOf<MsgComm.Msg>()
-                var currentSeq = lastMsgSeq.seq
-
-                while (true) {
-                    if (currentSeq <= 0) break
-
-                    val resp = contact.bot.network.sendAndExpect(
-                        MessageSvcPbGetGroupMsg(
-                            client = contact.bot.client,
-                            groupUin = contact.uin,
-                            messageSequence = currentSeq,
-                            20 // maximum 20
-                        )
-                    )
-                    if (resp is MessageSvcPbGetGroupMsg.Failed) break
-                    if ((resp as MessageSvcPbGetGroupMsg.Success).msgElem.isEmpty()) break
-
-                    // the message may be sorted increasing by message time,
-                    // if so, additional sortBy will not take cost.
-                    val msgElems = resp.msgElem.sortedBy { it.msgHead.msgTime }
-                    results.addAll(0, msgElems)
-
-                    val firstMsgElem = msgElems.first()
-                    if (firstMsgElem.msgHead.msgTime < timeStart) {
-                        break
-                    } else {
-                        currentSeq = (firstMsgElem.msgHead.msgSeq - 1).toLong()
-                    }
-                }
-
-                // use binary search to find the first message that message time is lager than lastMessageTime
-                var right = results.indexFirstBE(lastMessageTime) { it.msgHead.msgTime.toLong() }
-                // check messages with same time
-                if (results[right].msgHead.msgTime.toLong() == lastMessageTime) {
-                    do { right ++ } while (right <= results.size - 1 && results[right].msgHead.msgTime <= lastMessageTime)
-                }
-                // loops at most 20 times, just traverse
-                val left = results.indexOfFirst { it.msgHead.msgTime >= timeStart }
-
-                MessageSvcPbGetRoamMsgReq.Response(
-                    if (left == right) null else results.subList(left, right),
-                    if (left == right) -1L else results[right - 1].msgHead.msgTime.toLong(), -1L, byteArrayOf()
-                )
-            }
-            is TroopManagement.GetGroupLastMsgSeq.Response.Failed -> {
-                MessageSvcPbGetRoamMsgReq.Response(null, -1L, -1L, byteArrayOf())
-            }
-        }
-    }
-}

mirai-core/src/commonMain/kotlin/contact/roaming/RoamingMessagesImplFriend.kt

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2019-2022 Mamoe Technologies and contributors.
+ *
+ * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
+ * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
+ *
+ * https://github.com/mamoe/mirai/blob/dev/LICENSE
+ */
+
+package net.mamoe.mirai.internal.contact.roaming
+
+import net.mamoe.mirai.internal.contact.FriendImpl
+import net.mamoe.mirai.internal.network.protocol.packet.chat.receive.MessageSvcPbGetRoamMsgReq
+import net.mamoe.mirai.utils.check
+
+internal class RoamingMessagesImplFriend(
+    override val contact: FriendImpl
+) : TimeBasedRoamingMessagesImpl() {
+    override suspend fun requestRoamMsg(
+        timeStart: Long,
+        lastMessageTime: Long,
+        random: Long
+    ): MessageSvcPbGetRoamMsgReq.Response {
+        return contact.bot.network.sendAndExpect(
+            MessageSvcPbGetRoamMsgReq.createForFriend(
+                client = contact.bot.client,
+                uin = contact.id,
+                timeStart = timeStart,
+                lastMsgTime = lastMessageTime,
+                random = random,
+                maxCount = 1000,
+                sig = byteArrayOf(),
+                pwd = byteArrayOf()
+            )
+        ).value.check()
+    }
+}

mirai-core/src/commonMain/kotlin/contact/roaming/RoamingMessagesImplGroup.kt

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2019-2022 Mamoe Technologies and contributors.
+ *
+ * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
+ * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
+ *
+ * https://github.com/mamoe/mirai/blob/dev/LICENSE
+ */
+
+package net.mamoe.mirai.internal.contact.roaming
+
+import net.mamoe.mirai.internal.contact.CommonGroupImpl
+import net.mamoe.mirai.internal.network.protocol.data.proto.MsgComm
+import net.mamoe.mirai.internal.network.protocol.packet.chat.TroopManagement
+import net.mamoe.mirai.internal.network.protocol.packet.chat.receive.MessageSvcPbGetGroupMsg
+import net.mamoe.mirai.internal.network.protocol.packet.chat.receive.MessageSvcPbGetRoamMsgReq
+import net.mamoe.mirai.internal.utils.indexFirstBE
+
+internal class RoamingMessagesImplGroup(
+    override val contact: CommonGroupImpl
+) : TimeBasedRoamingMessagesImpl() {
+    override suspend fun requestRoamMsg(
+        timeStart: Long,
+        lastMessageTime: Long,
+        random: Long // unused field
+    ): MessageSvcPbGetRoamMsgReq.Response {
+        val lastMsgSeq = contact.bot.network.sendAndExpect(
+            TroopManagement.GetGroupLastMsgSeq(
+                client = contact.bot.client,
+                groupUin = contact.uin
+            )
+        )
+        return when (lastMsgSeq) {
+            is TroopManagement.GetGroupLastMsgSeq.Response.Success -> {
+                val results = mutableListOf<MsgComm.Msg>()
+                var currentSeq = lastMsgSeq.seq
+
+                while (true) {
+                    if (currentSeq <= 0) break
+
+                    val resp = contact.bot.network.sendAndExpect(
+                        MessageSvcPbGetGroupMsg(
+                            client = contact.bot.client,
+                            groupUin = contact.uin,
+                            messageSequence = currentSeq,
+                            20 // maximum 20
+                        )
+                    )
+                    if (resp is MessageSvcPbGetGroupMsg.Failed) break
+                    if ((resp as MessageSvcPbGetGroupMsg.Success).msgElem.isEmpty()) break
+
+                    // the message may be sorted increasing by message time,
+                    // if so, additional sortBy will not take cost.
+                    val msgElems = resp.msgElem.sortedBy { it.msgHead.msgTime }
+                    results.addAll(0, msgElems)
+
+                    val firstMsgElem = msgElems.first()
+                    if (firstMsgElem.msgHead.msgTime < timeStart) {
+                        break
+                    } else {
+                        currentSeq = (firstMsgElem.msgHead.msgSeq - 1).toLong()
+                    }
+                }
+
+                // use binary search to find the first message that message time is lager than lastMessageTime
+                var right = results.indexFirstBE(lastMessageTime) { it.msgHead.msgTime.toLong() }
+                // check messages with same time
+                if (results[right].msgHead.msgTime.toLong() == lastMessageTime) {
+                    do {
+                        right++
+                    } while (right <= results.size - 1 && results[right].msgHead.msgTime <= lastMessageTime)
+                }
+                // loops at most 20 times, just traverse
+                val left = results.indexOfFirst { it.msgHead.msgTime >= timeStart }
+
+                MessageSvcPbGetRoamMsgReq.Response(
+                    if (left == right) null else results.subList(left, right),
+                    if (left == right) -1L else results[right - 1].msgHead.msgTime.toLong(), -1L, byteArrayOf()
+                )
+            }
+
+            is TroopManagement.GetGroupLastMsgSeq.Response.Failed -> {
+                MessageSvcPbGetRoamMsgReq.Response(null, -1L, -1L, byteArrayOf())
+            }
+        }
+    }
+}

mirai-core/src/commonMain/kotlin/contact/roaming/SeqBasedRoamingMessageImpl.kt

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2019-2022 Mamoe Technologies and contributors.
+ *
+ * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
+ * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
+ *
+ * https://github.com/mamoe/mirai/blob/dev/LICENSE
+ */
+
+package net.mamoe.mirai.internal.contact.roaming
+
+import kotlinx.coroutines.currentCoroutineContext
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flow
+import kotlinx.coroutines.isActive
+import net.mamoe.mirai.contact.roaming.RoamingMessageFilter
+import net.mamoe.mirai.internal.message.toMessageChainOnline
+import net.mamoe.mirai.internal.network.protocol.data.proto.MsgComm
+import net.mamoe.mirai.message.data.MessageChain
+
+private typealias Seq = Long
+
+internal sealed class SeqBasedRoamingMessageImpl : AbstractRoamingMessages() {
+    final override suspend fun getMessagesIn(
+        timeStart: Long,
+        timeEnd: Long,
+        filter: RoamingMessageFilter?
+    ): Flow<MessageChain> {
+        val (seqStart, seqEnd) = getSeqForTime(timeStart, timeEnd)
+        return getMessageImpl(seqStart, seqEnd, filter)
+    }
+
+    protected abstract suspend fun getSeqForTime(timeStart: Long, timeEnd: Long): Pair<Seq, Seq>
+
+    @Suppress("DuplicatedCode") // Generalizing this code would even complicate logic
+    private suspend fun getMessageImpl(
+        seqStart: Seq,
+        seqEnd: Seq,
+        filter: RoamingMessageFilter?,
+    ): Flow<MessageChain> {
+        return flow {
+            var currentSeqStart = seqEnd.coerceAtMost(seqStart)
+            while (currentCoroutineContext().isActive) {
+                val resp = requestRoamMsg(currentSeqStart, seqEnd)
+                val messages = resp.messages ?: break
+                if (filter == null || filter === RoamingMessageFilter.ANY) {
+                    // fast path
+                    messages.forEach { emit(it.toMessageChainOnline(contact.bot)) }
+                } else {
+                    for (message in messages) {
+                        if (filter.invoke(createRoamingMessage(message, messages))) {
+                            emit(message.toMessageChainOnline(contact.bot))
+                        }
+                    }
+                }
+                currentSeqStart = resp.nextSeqStart
+            }
+        }
+
+    }
+
+    abstract suspend fun requestRoamMsg(
+        seqStart: Seq,
+        seqEnd: Seq,
+    ): SeqBasedRoamingMessageChunk
+}
+
+internal interface SeqBasedRoamingMessageChunk {
+    val messages: List<MsgComm.Msg>?
+    val nextSeqStart: Seq
+}

mirai-core/src/commonMain/kotlin/contact/roaming/TimeBasedRoamingMessagesImpl.kt

@@ -0,0 +1,61 @@
+/*
+ * Copyright 2019-2022 Mamoe Technologies and contributors.
+ *
+ * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
+ * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
+ *
+ * https://github.com/mamoe/mirai/blob/dev/LICENSE
+ */
+
+@file:Suppress("INVISIBLE_REFERENCE", "INVISIBLE_MEMBER")
+
+package net.mamoe.mirai.internal.contact.roaming
+
+import kotlinx.coroutines.currentCoroutineContext
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.flow
+import kotlinx.coroutines.isActive
+import net.mamoe.mirai.contact.roaming.RoamingMessageFilter
+import net.mamoe.mirai.internal.message.toMessageChainOnline
+import net.mamoe.mirai.internal.network.protocol.packet.chat.receive.MessageSvcPbGetRoamMsgReq
+import net.mamoe.mirai.message.data.MessageChain
+
+// Can't make sealed, used by actuals 
+internal abstract class CommonTimeBasedRoamingMessagesImpl : AbstractRoamingMessages() {
+    override suspend fun getMessagesIn(
+        timeStart: Long,
+        timeEnd: Long,
+        filter: RoamingMessageFilter?
+    ): Flow<MessageChain> {
+        return flow {
+            var lastMessageTime = timeEnd.coerceAtLeast(timeStart).coerceAtLeast(1)
+            var random = 0L
+            while (currentCoroutineContext().isActive) {
+                val resp = requestRoamMsg(timeStart, lastMessageTime, random)
+                val messages = resp.messages ?: break
+                if (filter == null || filter === RoamingMessageFilter.ANY) {
+                    // fast path
+                    messages.forEach { emit(it.toMessageChainOnline(contact.bot)) }
+                } else {
+                    for (message in messages) {
+                        if (filter.invoke(createRoamingMessage(message, messages))) {
+                            emit(message.toMessageChainOnline(contact.bot))
+                        }
+                    }
+                }
+
+                lastMessageTime = resp.lastMessageTime
+                random = resp.random
+            }
+        }
+    }
+
+    abstract suspend fun requestRoamMsg(
+        timeStart: Long,
+        lastMessageTime: Long,
+        random: Long
+    ): MessageSvcPbGetRoamMsgReq.Response
+}
+
+
+internal expect sealed class TimeBasedRoamingMessagesImpl() : CommonTimeBasedRoamingMessagesImpl

mirai-core/src/jvmBaseMain/kotlin/contact/roaming/TimeBasedRoamingMessagesImpl.kt

@@ -17,7 +17,7 @@ import net.mamoe.mirai.utils.JavaFriendlyAPI
 import net.mamoe.mirai.utils.stream
 import java.util.stream.Stream
 
-internal actual sealed class RoamingMessagesImpl : CommonRoamingMessagesImpl() {
+internal actual sealed class TimeBasedRoamingMessagesImpl : CommonTimeBasedRoamingMessagesImpl() {
     @JavaFriendlyAPI
     override suspend fun getMessagesStream(
         timeStart: Long,

mirai-core/src/nativeMain/kotlin/contact/roaming/TimeBasedRoamingMessagesImpl.kt

@@ -9,5 +9,5 @@
 
 package net.mamoe.mirai.internal.contact.roaming
 
-internal actual sealed class RoamingMessagesImpl actual constructor() :
-    CommonRoamingMessagesImpl()
+internal actual sealed class TimeBasedRoamingMessagesImpl actual constructor() :
+    CommonTimeBasedRoamingMessagesImpl()