支持获取消息记录 (漫游消息)

binary-compatibility-validator/android/api/binary-compatibility-validator-android.api

@@ -331,7 +331,7 @@ public abstract interface class net/mamoe/mirai/contact/FileSupported : net/mamo
 	public abstract fun getFilesRoot ()Lnet/mamoe/mirai/utils/RemoteFile;
 }
 
-public abstract interface class net/mamoe/mirai/contact/Friend : kotlinx/coroutines/CoroutineScope, net/mamoe/mirai/contact/AudioSupported, net/mamoe/mirai/contact/User {
+public abstract interface class net/mamoe/mirai/contact/Friend : kotlinx/coroutines/CoroutineScope, net/mamoe/mirai/contact/AudioSupported, net/mamoe/mirai/contact/User, net/mamoe/mirai/contact/roaming/RoamingSupported {
 	public fun delete ()V
 	public abstract fun delete (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public fun nudge ()Lnet/mamoe/mirai/message/action/FriendNudge;
@@ -748,6 +748,57 @@ public final class net/mamoe/mirai/contact/announcement/OnlineAnnouncementKt {
 	public static final fun getBot (Lnet/mamoe/mirai/contact/announcement/OnlineAnnouncement;)Lnet/mamoe/mirai/Bot;
 }
 
+public abstract interface class net/mamoe/mirai/contact/roaming/RoamingMessage {
+	public fun getBot ()Lnet/mamoe/mirai/Bot;
+	public abstract fun getContact ()Lnet/mamoe/mirai/contact/Contact;
+	public abstract fun getIds ()[I
+	public abstract fun getInternalIds ()[I
+	public abstract fun getSender ()J
+	public abstract fun getTarget ()J
+	public abstract fun getTime ()J
+}
+
+public abstract interface class net/mamoe/mirai/contact/roaming/RoamingMessageFilter {
+	public static final field ANY Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public static final field Companion Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter$Companion;
+	public static final field RECEIVED Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public static final field SENT Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public fun and (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public abstract fun invoke (Lnet/mamoe/mirai/contact/roaming/RoamingMessage;)Z
+	public fun not ()Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public fun or (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+}
+
+public final class net/mamoe/mirai/contact/roaming/RoamingMessageFilter$Companion {
+}
+
+public abstract interface class net/mamoe/mirai/contact/roaming/RoamingMessages {
+	public fun getAllMessages (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Lkotlinx/coroutines/flow/Flow;
+	public fun getAllMessages (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun getAllMessages$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
+	public static synthetic fun getAllMessages$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public fun getAllMessagesStream ()Ljava/util/stream/Stream;
+	public fun getAllMessagesStream (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun getAllMessagesStream (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Ljava/util/stream/Stream;
+	public fun getAllMessagesStream (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun getAllMessagesStream$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;ILjava/lang/Object;)Ljava/util/stream/Stream;
+	public static synthetic fun getAllMessagesStream$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public fun getMessagesIn (JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Lkotlinx/coroutines/flow/Flow;
+	public abstract fun getMessagesIn (JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun getMessagesIn$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
+	public static synthetic fun getMessagesIn$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public fun getMessagesStream (JJ)Ljava/util/stream/Stream;
+	public fun getMessagesStream (JJLkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun getMessagesStream (JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Ljava/util/stream/Stream;
+	public abstract fun getMessagesStream (JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun getMessagesStream$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;ILjava/lang/Object;)Ljava/util/stream/Stream;
+	public static synthetic fun getMessagesStream$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+}
+
+public abstract interface class net/mamoe/mirai/contact/roaming/RoamingSupported : net/mamoe/mirai/contact/Contact {
+	public abstract fun getRoamingMessages ()Lnet/mamoe/mirai/contact/roaming/RoamingMessages;
+}
+
 public abstract interface class net/mamoe/mirai/data/FriendInfo : net/mamoe/mirai/data/UserInfo {
 	public abstract fun getNick ()Ljava/lang/String;
 	public abstract fun getRemark ()Ljava/lang/String;

binary-compatibility-validator/api/binary-compatibility-validator.api

@@ -331,7 +331,7 @@ public abstract interface class net/mamoe/mirai/contact/FileSupported : net/mamo
 	public abstract fun getFilesRoot ()Lnet/mamoe/mirai/utils/RemoteFile;
 }
 
-public abstract interface class net/mamoe/mirai/contact/Friend : kotlinx/coroutines/CoroutineScope, net/mamoe/mirai/contact/AudioSupported, net/mamoe/mirai/contact/User {
+public abstract interface class net/mamoe/mirai/contact/Friend : kotlinx/coroutines/CoroutineScope, net/mamoe/mirai/contact/AudioSupported, net/mamoe/mirai/contact/User, net/mamoe/mirai/contact/roaming/RoamingSupported {
 	public fun delete ()V
 	public abstract fun delete (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
 	public fun nudge ()Lnet/mamoe/mirai/message/action/FriendNudge;
@@ -748,6 +748,57 @@ public final class net/mamoe/mirai/contact/announcement/OnlineAnnouncementKt {
 	public static final fun getBot (Lnet/mamoe/mirai/contact/announcement/OnlineAnnouncement;)Lnet/mamoe/mirai/Bot;
 }
 
+public abstract interface class net/mamoe/mirai/contact/roaming/RoamingMessage {
+	public fun getBot ()Lnet/mamoe/mirai/Bot;
+	public abstract fun getContact ()Lnet/mamoe/mirai/contact/Contact;
+	public abstract fun getIds ()[I
+	public abstract fun getInternalIds ()[I
+	public abstract fun getSender ()J
+	public abstract fun getTarget ()J
+	public abstract fun getTime ()J
+}
+
+public abstract interface class net/mamoe/mirai/contact/roaming/RoamingMessageFilter {
+	public static final field ANY Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public static final field Companion Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter$Companion;
+	public static final field RECEIVED Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public static final field SENT Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public fun and (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public abstract fun invoke (Lnet/mamoe/mirai/contact/roaming/RoamingMessage;)Z
+	public fun not ()Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+	public fun or (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;
+}
+
+public final class net/mamoe/mirai/contact/roaming/RoamingMessageFilter$Companion {
+}
+
+public abstract interface class net/mamoe/mirai/contact/roaming/RoamingMessages {
+	public fun getAllMessages (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Lkotlinx/coroutines/flow/Flow;
+	public fun getAllMessages (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun getAllMessages$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
+	public static synthetic fun getAllMessages$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public fun getAllMessagesStream ()Ljava/util/stream/Stream;
+	public fun getAllMessagesStream (Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun getAllMessagesStream (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Ljava/util/stream/Stream;
+	public fun getAllMessagesStream (Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun getAllMessagesStream$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;ILjava/lang/Object;)Ljava/util/stream/Stream;
+	public static synthetic fun getAllMessagesStream$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;Lnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public fun getMessagesIn (JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Lkotlinx/coroutines/flow/Flow;
+	public abstract fun getMessagesIn (JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun getMessagesIn$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
+	public static synthetic fun getMessagesIn$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+	public fun getMessagesStream (JJ)Ljava/util/stream/Stream;
+	public fun getMessagesStream (JJLkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun getMessagesStream (JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;)Ljava/util/stream/Stream;
+	public abstract fun getMessagesStream (JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public static synthetic fun getMessagesStream$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;ILjava/lang/Object;)Ljava/util/stream/Stream;
+	public static synthetic fun getMessagesStream$default (Lnet/mamoe/mirai/contact/roaming/RoamingMessages;JJLnet/mamoe/mirai/contact/roaming/RoamingMessageFilter;Lkotlin/coroutines/Continuation;ILjava/lang/Object;)Ljava/lang/Object;
+}
+
+public abstract interface class net/mamoe/mirai/contact/roaming/RoamingSupported : net/mamoe/mirai/contact/Contact {
+	public abstract fun getRoamingMessages ()Lnet/mamoe/mirai/contact/roaming/RoamingMessages;
+}
+
 public abstract interface class net/mamoe/mirai/data/FriendInfo : net/mamoe/mirai/data/UserInfo {
 	public abstract fun getNick ()Ljava/lang/String;
 	public abstract fun getRemark ()Ljava/lang/String;

mirai-core-api/src/commonMain/kotlin/contact/Friend.kt

@@ -15,6 +15,7 @@ package net.mamoe.mirai.contact
 import kotlinx.coroutines.CoroutineScope
 import net.mamoe.kjbb.JvmBlockingBridge
 import net.mamoe.mirai.Bot
+import net.mamoe.mirai.contact.roaming.RoamingSupported
 import net.mamoe.mirai.event.events.*
 import net.mamoe.mirai.message.MessageReceipt
 import net.mamoe.mirai.message.action.FriendNudge
@@ -34,7 +35,7 @@ import net.mamoe.mirai.utils.NotStableForInheritance
  * @see FriendMessageEvent
  */
 @NotStableForInheritance
-public interface Friend : User, CoroutineScope, AudioSupported {
+public interface Friend : User, CoroutineScope, AudioSupported, RoamingSupported {
     /**
      * 向这个对象发送消息.
      *

mirai-core-api/src/commonMain/kotlin/contact/roaming/RoamingMessageFilter.kt

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2019-2021 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.contact.roaming
+
+import net.mamoe.mirai.Bot
+import net.mamoe.mirai.contact.Contact
+import net.mamoe.mirai.message.data.MessageSource
+
+/**
+ * @since 2.8
+ */
+public fun interface RoamingMessageFilter {
+    public operator fun invoke(roamingMessage: RoamingMessage): Boolean
+
+
+    public infix fun and(other: RoamingMessageFilter): RoamingMessageFilter {
+        return RoamingMessageFilter { this.invoke(it) && other.invoke(it) }
+    }
+
+    public infix fun or(other: RoamingMessageFilter): RoamingMessageFilter {
+        return RoamingMessageFilter { this.invoke(it) || other.invoke(it) }
+    }
+
+    public fun not(): RoamingMessageFilter {
+        return RoamingMessageFilter { !this.invoke(it) }
+    }
+
+
+    public companion object {
+        /**
+         * 筛选任何消息 (相当于不筛选)
+         */
+        @JvmField
+        public val ANY: RoamingMessageFilter = RoamingMessageFilter { true }
+
+        /**
+         * 筛选 bot 接收的消息
+         */
+        @JvmField
+        public val RECEIVED: RoamingMessageFilter = RoamingMessageFilter { it.sender != it.bot.id }
+
+        /**
+         * 筛选 bot 发送的消息
+         */
+        @JvmField
+        public val SENT: RoamingMessageFilter = RoamingMessageFilter { it.sender == it.bot.id }
+    }
+}
+
+/**
+ * 还未解析的漫游消息.
+ *
+ * @since 2.8
+ */
+public interface RoamingMessage {
+    public val contact: Contact
+    public val bot: Bot get() = contact.bot
+
+    /**
+     * 发送人 id
+     */
+    public val sender: Long
+
+    /**
+     * 收信人或群的 id
+     */
+    public val target: Long
+
+    /**
+     * 时间戳, 单位为秒, 服务器时间.
+     */
+    public val time: Long
+
+    /**
+     * @see MessageSource.ids
+     */
+    public val ids: IntArray
+
+    /**
+     * @see MessageSource.internalIds
+     */
+    public val internalIds: IntArray
+}

mirai-core-api/src/commonMain/kotlin/contact/roaming/RoamingMessages.kt

@@ -0,0 +1,101 @@
+/*
+ * Copyright 2019-2021 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:JvmBlockingBridge
+
+package net.mamoe.mirai.contact.roaming
+
+import kotlinx.coroutines.flow.Flow
+import net.mamoe.kjbb.JvmBlockingBridge
+import net.mamoe.mirai.message.data.MessageChain
+import net.mamoe.mirai.message.data.MessageSource
+import net.mamoe.mirai.utils.JavaFriendlyAPI
+import java.util.stream.Stream
+
+/**
+ * 漫游消息记录管理器.
+ *
+ * @since 2.8
+ * @see RoamingSupported
+ */
+public interface RoamingMessages {
+    ///////////////////////////////////////////////////////////////////////////
+    // Get list
+    ///////////////////////////////////////////////////////////////////////////
+
+    /**
+     * 查询指定时间段内的漫游消息记录.
+     *
+     * 返回查询到的漫游消息记录, 顺序为由新到旧. 这些 [MessageChain] 与从事件中收到的消息链相似, 属于在线消息.
+     * 可从 [MessageChain] 获取 [MessageSource] 来确定发送人等相关信息, 也可以进行引用回复或撤回.
+     *
+     * 性能提示: 请在 [filter] 执行筛选, 若 [filter] 返回 `false` 则不会解析消息链, 这对本函数的处理速度有决定性影响.
+     *
+     * @param timeStart 起始时间, UTC+8 时间戳, 单位为秒. 可以为 `0`, 即表示从可以获取的最早的消息起. 负数将会被看是 `0`.
+     * @param timeEnd 结束时间, UTC+8 时间戳, 单位为秒. 可以为 [Long.MAX_VALUE], 即表示到可以获取的最晚的消息为止. 低于 [timeStart] 的值将会被看作是 [timeStart] 的值.
+     * @param filter 过滤器.
+     */
+    public suspend fun getMessagesIn(
+        timeStart: Long,
+        timeEnd: Long,
+        filter: RoamingMessageFilter? = null
+    ): Flow<MessageChain>
+
+    /**
+     * 查询所有漫游消息记录.
+     *
+     * 返回查询到的漫游消息记录, 顺序为由新到旧. 这些 [MessageChain] 与从事件中收到的消息链相似, 属于在线消息.
+     * 可从 [MessageChain] 获取 [MessageSource] 来确定发送人等相关信息, 也可以进行引用回复或撤回.
+     *
+     * 性能提示: 请在 [filter] 执行筛选, 若 [filter] 返回 `false` 则不会解析消息链, 这对本函数的处理速度有决定性影响.
+     *
+     * @param filter 过滤器.
+     */
+    public suspend fun getAllMessages(
+        filter: RoamingMessageFilter? = null
+    ): Flow<MessageChain> = getMessagesIn(0, Long.MAX_VALUE, filter)
+
+    /**
+     * 查询指定时间段内的漫游消息记录.
+     *
+     * 返回查询到的漫游消息记录, 顺序为由新到旧. 这些 [MessageChain] 与从事件中收到的消息链相似, 属于在线消息.
+     * 可从 [MessageChain] 获取 [MessageSource] 来确定发送人等相关信息, 也可以进行引用回复或撤回.
+     *
+     * 性能提示: 请在 [filter] 执行筛选, 若 [filter] 返回 `false` 则不会解析消息链, 这对本函数的处理速度有决定性影响.
+     *
+     * @param timeStart 起始时间, UTC+8 时间戳, 单位为秒. 可以为 `0`, 即表示从可以获取的最早的消息起. 负数将会被看是 `0`.
+     * @param timeEnd 结束时间, UTC+8 时间戳, 单位为秒. 可以为 [Long.MAX_VALUE], 即表示到可以获取的最晚的消息为止. 低于 [timeStart] 的值将会被看作是 [timeStart] 的值.
+     * @param filter 过滤器.
+     */
+    @Suppress("OVERLOADS_INTERFACE")
+    @JvmOverloads
+    @JavaFriendlyAPI
+    public suspend fun getMessagesStream(
+        timeStart: Long,
+        timeEnd: Long,
+        filter: RoamingMessageFilter? = null
+    ): Stream<MessageChain>
+
+    /**
+     * 查询所有漫游消息记录.
+     *
+     * 返回查询到的漫游消息记录, 顺序为由新到旧. 这些 [MessageChain] 与从事件中收到的消息链相似, 属于在线消息.
+     * 可从 [MessageChain] 获取 [MessageSource] 来确定发送人等相关信息, 也可以进行引用回复或撤回.
+     *
+     * 性能提示: 请在 [filter] 执行筛选, 若 [filter] 返回 `false` 则不会解析消息链, 这对本函数的处理速度有决定性影响.
+     *
+     * @param filter 过滤器.
+     */
+    @Suppress("OVERLOADS_INTERFACE")
+    @JvmOverloads
+    @JavaFriendlyAPI
+    public suspend fun getAllMessagesStream(
+        filter: RoamingMessageFilter? = null
+    ): Stream<MessageChain> = getMessagesStream(0, Long.MAX_VALUE, filter)
+}