[core] Raise deprecation level for RemoteFile to ERROR (for v2.14)

2025-02-04 13:19:15 +08:00 · 2022-12-27 14:32:36 +00:00 · 2022-12-27 14:32:36 +00:00 · 76a70f596f
commit 76a70f596f
parent c2611dda94
9 changed files with 46 additions and 23 deletions
--- a/mirai-core-api/src/jvmBaseMain/kotlin/contact/FileSupported.kt
+++ b/mirai-core-api/src/jvmBaseMain/kotlin/contact/FileSupported.kt
@ -28,11 +28,17 @@ public actual interface FileSupported : Contact {
    /**
     * 文件根目录. 可通过 [net.mamoe.mirai.utils.RemoteFile.listFiles] 获取目录下文件列表.
     *
+     * **注意:** 已弃用, 请使用 [files].
+     *
     * @since 2.5
     */
-    @Suppress("DEPRECATION")
-    @Deprecated("Please use files instead.", replaceWith = ReplaceWith("files.root")) // deprecated since 2.8.0-RC
-    @DeprecatedSinceMirai(warningSince = "2.8")
+    @Suppress("DEPRECATION", "DEPRECATION_ERROR")
+    @Deprecated(
+        "Please use files instead.",
+        replaceWith = ReplaceWith("files.root"),
+        level = DeprecationLevel.ERROR
+    ) // deprecated since 2.8.0-RC
+    @DeprecatedSinceMirai(warningSince = "2.8", errorSince = "2.14")
    public val filesRoot: net.mamoe.mirai.utils.RemoteFile

    /**
--- a/mirai-core-api/src/jvmBaseMain/kotlin/message/data/FileMessage.kt
+++ b/mirai-core-api/src/jvmBaseMain/kotlin/message/data/FileMessage.kt
@ -75,9 +75,13 @@ public actual interface FileMessage : MessageContent, ConstrainSingle, CodableMe
    /**
     * 获取一个对应的 [RemoteFile]. 当目标群或好友不存在这个文件时返回 `null`.
     */
-    @Suppress("DEPRECATION")
-    @Deprecated("Please use toAbsoluteFile", ReplaceWith("this.toAbsoluteFile(contact)")) // deprecated since 2.8.0-RC
-    @DeprecatedSinceMirai(warningSince = "2.8")
+    @Suppress("DEPRECATION", "DEPRECATION_ERROR")
+    @Deprecated(
+        "Please use toAbsoluteFile",
+        ReplaceWith("this.toAbsoluteFile(contact)"),
+        level = DeprecationLevel.ERROR
+    ) // deprecated since 2.8.0-RC
+    @DeprecatedSinceMirai(warningSince = "2.8", errorSince = "2.14")
    public suspend fun toRemoteFile(contact: FileSupported): RemoteFile? {
        @Suppress("DEPRECATION")
        return contact.filesRoot.resolveById(id)
--- a/mirai-core-api/src/jvmBaseMain/kotlin/utils/ExternalResource.kt
+++ b/mirai-core-api/src/jvmBaseMain/kotlin/utils/ExternalResource.kt
@ -558,12 +558,13 @@ public actual interface ExternalResource : Closeable {
        @Suppress("DEPRECATION_ERROR", "DEPRECATION")
        @Deprecated(
            "Deprecated. Please use AbsoluteFolder.uploadNewFile",
-            ReplaceWith("contact.files.uploadNewFile(path, this, callback)")
+            ReplaceWith("contact.files.uploadNewFile(path, this, callback)"),
+            level = DeprecationLevel.ERROR,
        ) // deprecated since 2.8.0-RC
        @JvmStatic
        @JvmBlockingBridge
        @JvmOverloads
-        @DeprecatedSinceMirai(warningSince = "2.8")
+        @DeprecatedSinceMirai(warningSince = "2.8", errorSince = "2.14")
        public suspend fun <C : FileSupported> File.sendTo(
            contact: C,
            path: String,
@ -585,13 +586,14 @@ public actual interface ExternalResource : Closeable {
        @Suppress("DEPRECATION", "DEPRECATION_ERROR")
        @Deprecated(
            "Deprecated. Please use AbsoluteFolder.uploadNewFile",
-            ReplaceWith("contact.files.uploadNewFile(path, this, callback)")
+            ReplaceWith("contact.files.uploadNewFile(path, this, callback)"),
+            level = DeprecationLevel.ERROR
        ) // deprecated since 2.8.0-RC
        @JvmStatic
        @JvmBlockingBridge
        @JvmName("sendAsFile")
        @JvmOverloads
-        @DeprecatedSinceMirai(warningSince = "2.8")
+        @DeprecatedSinceMirai(warningSince = "2.8", errorSince = "2.14")
        public suspend fun <C : FileSupported> ExternalResource.sendAsFileTo(
            contact: C,
            path: String,
--- a/mirai-core-api/src/jvmBaseMain/kotlin/utils/RemoteFile.kt
+++ b/mirai-core-api/src/jvmBaseMain/kotlin/utils/RemoteFile.kt
@ -7,7 +7,7 @@
 * https://github.com/mamoe/mirai/blob/dev/LICENSE
 */

-@file:Suppress("unused", "DEPRECATION")
+@file:Suppress("unused", "DEPRECATION", "DEPRECATION_ERROR")
@file:JvmBlockingBridge

 package net.mamoe.mirai.utils
@ -20,6 +20,7 @@ import me.him188.kotlin.jvm.blocking.bridge.JvmBlockingBridge
 import net.mamoe.mirai.contact.Contact
 import net.mamoe.mirai.contact.FileSupported
 import net.mamoe.mirai.contact.Group
+import net.mamoe.mirai.contact.file.AbsoluteFile
 import net.mamoe.mirai.message.MessageReceipt
 import net.mamoe.mirai.message.data.FileMessage
 import net.mamoe.mirai.message.data.sendTo
@ -31,6 +32,8 @@ import java.io.File
 /**
 * 表示一个远程文件或目录.
 *
+ * # 注意: 此 API 已弃用, 请使用 [AbsoluteFile] 代替.
+ *
 * [RemoteFile] 仅保存 [id], [name], [path], [parent], [contact] 这五个属性, 除获取这些属性外的所有的操作都是在*远程*完成的.
 * 意味着操作的结果会因文件或目录在服务器中的状态变化而变化.
 *
@ -99,9 +102,9 @@ import java.io.File
 */
@Deprecated(
    "Please use RemoteFiles and AbsoluteFileFolder form fileSupported.files",
-    level = DeprecationLevel.WARNING
+    level = DeprecationLevel.ERROR
 ) // deprecated since 2.8.0-RC
-@DeprecatedSinceMirai(warningSince = "2.8")
+@DeprecatedSinceMirai(warningSince = "2.8", errorSince = "2.14")
@NotStableForInheritance
 public interface RemoteFile {
    /**
@ -146,6 +149,8 @@ public interface RemoteFile {
     */
    public suspend fun length(): Long

+    @Deprecated("RemoteFile is deprecated. Use RemoteFiles instead.", level = DeprecationLevel.ERROR)
+    @DeprecatedSinceMirai(errorSince = "2.14") // 在弃用 RemoteFile 的时候忘了弃用这个类, 所以它没有 warningSince
    public class FileInfo @MiraiInternalApi constructor(
        /**
         * 文件或目录名.
@ -358,9 +363,9 @@ public interface RemoteFile {
    @Deprecated(
        "Deprecated without replacement. Please use AbsoluteFolder.uploadNewFile",
        ReplaceWith("contact.files.uploadNewFile(path, this, callback)"),
-        level = DeprecationLevel.WARNING
+        level = DeprecationLevel.ERROR
    ) // deprecated since 2.8.0-RC
-    @DeprecatedSinceMirai(warningSince = "2.8")
+    @DeprecatedSinceMirai(warningSince = "2.8", errorSince = "2.14")
    public interface ProgressionCallback {
        /**
         * 当上传开始时调用
@ -384,6 +389,8 @@ public interface RemoteFile {
         */
        public fun onFailure(file: RemoteFile, resource: ExternalResource, exception: Throwable) {}

+        @Deprecated("RemoteFile is deprecated. Use RemoteFiles instead.", level = DeprecationLevel.ERROR)
+        @DeprecatedSinceMirai(errorSince = "2.14") // 在弃用 RemoteFile 的时候忘了弃用这个类, 所以它没有 warningSince
        public companion object {
            /**
             * 将一个 [SendChannel] 作为 [ProgressionCallback] 使用.
@ -537,6 +544,8 @@ public interface RemoteFile {
     */
    public suspend fun getDownloadInfo(): DownloadInfo?

+    @Deprecated("RemoteFile is deprecated. Use RemoteFiles instead.", level = DeprecationLevel.ERROR)
+    @DeprecatedSinceMirai(errorSince = "2.14") // 在弃用 RemoteFile 的时候忘了弃用这个类, 所以它没有 warningSince
    public class DownloadInfo @MiraiInternalApi constructor(
        /**
         * @see RemoteFile.name
@ -564,6 +573,8 @@ public interface RemoteFile {
        }
    }

+    @Deprecated("RemoteFile is deprecated. Use RemoteFiles instead.", level = DeprecationLevel.ERROR)
+    @DeprecatedSinceMirai(errorSince = "2.14") // 在弃用 RemoteFile 的时候忘了弃用这个类, 所以它没有 warningSince
    public companion object {
        /**
         * 根目录路径
@ -591,7 +602,7 @@ public interface RemoteFile {
            ),
            level = DeprecationLevel.ERROR
        ) // deprecated since 2.7-M1
-        @DeprecatedSinceMirai(warningSince = "2.7", errorSince = "2.10") // left ERROR intentionally
+        @DeprecatedSinceMirai(warningSince = "2.7", errorSince = "2.10")
        @Suppress("_FUNCTION_WITH_DEFAULT_ARGUMENTS")
        public suspend fun FileSupported.uploadFile(
            path: String,
--- a/mirai-core-mock/src/internal/contact/MockGroupImpl.kt
+++ b/mirai-core-mock/src/internal/contact/MockGroupImpl.kt
@ -338,7 +338,7 @@ internal class MockGroupImpl(
    }

    @Deprecated("Please use files instead.", replaceWith = ReplaceWith("files.root"))
-    @Suppress("OverridingDeprecatedMember", "DEPRECATION")
+    @Suppress("OverridingDeprecatedMember", "DEPRECATION", "DEPRECATION_ERROR")
    override val filesRoot: RemoteFile by lazy {
        net.mamoe.mirai.mock.internal.remotefile.remotefile.RootRemoteFile(txFileSystem, this)
    }
--- a/mirai-core-mock/src/internal/remotefile/remotefile/MockRemoteFile.kt
+++ b/mirai-core-mock/src/internal/remotefile/remotefile/MockRemoteFile.kt
@ -7,7 +7,7 @@
 * https://github.com/mamoe/mirai/blob/dev/LICENSE
 */

-@file:Suppress("DEPRECATION", "INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
+@file:Suppress("DEPRECATION", "DEPRECATION_ERROR", "INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")

 package net.mamoe.mirai.mock.internal.remotefile.remotefile

--- a/mirai-core-mock/test/mock/MockGroupTest.kt
+++ b/mirai-core-mock/test/mock/MockGroupTest.kt
@ -145,7 +145,7 @@ internal class MockGroupTest : MockBotTestBase() {
        }
    }

-    @Suppress("DEPRECATION")
+    @Suppress("DEPRECATION", "DEPRECATION_ERROR")
    @Test
    internal fun testGroupFileV1() = runTest {
        val fsroot = bot.addGroup(5417, "58aw").filesRoot
--- a/mirai-core/src/jvmBaseMain/kotlin/contact/GroupImpl.kt
+++ b/mirai-core/src/jvmBaseMain/kotlin/contact/GroupImpl.kt
@ -26,8 +26,8 @@ internal actual class GroupImpl actual constructor(
 ) : Group, CommonGroupImpl(bot, parentCoroutineContext, id, groupInfo, members) {
    actual companion object;

-    @Suppress("DEPRECATION")
-    @Deprecated("Please use files instead.", replaceWith = ReplaceWith("files.root"), level = DeprecationLevel.WARNING)
-    @DeprecatedSinceMirai(warningSince = "2.8")
+    @Suppress("DEPRECATION_ERROR")
+    @Deprecated("Please use files instead.", replaceWith = ReplaceWith("files.root"), level = DeprecationLevel.ERROR)
+    @DeprecatedSinceMirai(warningSince = "2.8", errorSince = "2.14")
    override val filesRoot: net.mamoe.mirai.utils.RemoteFile by lazy { RemoteFileImpl(this, "/") }
 }
--- a/mirai-core/src/jvmBaseMain/kotlin/utils/RemoteFileImpl.kt
+++ b/mirai-core/src/jvmBaseMain/kotlin/utils/RemoteFileImpl.kt
@ -7,7 +7,7 @@
 * https://github.com/mamoe/mirai/blob/dev/LICENSE
 */

-@file:Suppress("DEPRECATION")
+@file:Suppress("DEPRECATION", "DEPRECATION_ERROR")

 package net.mamoe.mirai.internal.utils