Merge remote-tracking branch 'origin/dev' into update_docs

# Conflicts:
#	docs/Preparations.md

.github/workflows/check-publishing.yml

@@ -84,17 +84,6 @@ jobs:
       - if: ${{ env.isUnix == 'true' }}
         run: chmod -R 777 *
 
-      # Prepare environment for linking on macOS
-      - if: ${{ env.isMac == 'true' }}
-        name: Install OpenSSL on Mac OS
-        run: >
-          git clone https://github.com/openssl/openssl.git --recursive &&
-          cd openssl &&
-          git checkout tags/openssl-3.0.3 &&
-          ./Configure --prefix=/opt/openssl --openssldir=/usr/local/ssl &&
-          make &&
-          sudo make install
-
       # Prepare environment for linking on Ubuntu
       - if: ${{ env.isUbuntu == 'true' }}
         name: Install OpenSSL on Ubuntu

.github/workflows/release.yml

@@ -74,6 +74,18 @@ jobs:
           GPG_PRIVATE: ${{ secrets.GPG_PRIVATE_KEY }}
           GPG_PUBLIC_: ${{ secrets.GPG_PUBLIC_KEY }}
 
+      - name: Setup Android SDK Ubuntu
+        if: ${{ env.isUbuntu == 'true' }}
+        run: 'touch local.properties && echo sdk.dir=/usr/local/lib/android/sdk >> local.properties'
+
+      - name: Setup Android SDK macOS
+        if: ${{ env.isMac == 'true' }}
+        run: 'touch local.properties && echo sdk.dir=/Users/runner/Library/Android/sdk >> local.properties'
+
+      - name: Setup Android SDK Windows
+        if: ${{ env.isWindows == 'true' }}
+        run: 'echo sdk.dir=C:\Android\android-sdk >> local.properties'
+
       - name: Setup Gradle
         uses: gradle/gradle-build-action@v2
 

.run/Publish deps test artifacts.run.xml

@@ -0,0 +1,39 @@
+<!--
+  ~ Copyright 2019-2023 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
+  -->
+
+<component name="ProjectRunConfigurationManager">
+    <configuration default="false" name="Publish deps test artifacts" type="GradleRunConfiguration" factoryName="Gradle"
+                   folderName="Publishing Tests">
+        <ExternalSystemSettings>
+            <option name="env">
+                <map>
+                    <entry key="mirai.build.project.version" value="2.99.0-deps-test"/>
+                </map>
+            </option>
+            <option name="executionName"/>
+            <option name="externalProjectPath" value="$PROJECT_DIR$"/>
+            <option name="externalSystemIdString" value="GRADLE"/>
+            <option name="scriptParameters" value="--stacktrace"/>
+            <option name="taskDescriptions">
+                <list/>
+            </option>
+            <option name="taskNames">
+                <list>
+                    <option value=":mirai-deps-test:publishMiraiArtifactsToMavenLocal"/>
+                </list>
+            </option>
+            <option name="vmOptions"/>
+        </ExternalSystemSettings>
+        <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
+        <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
+        <DebugAllEnabled>false</DebugAllEnabled>
+        <ForceTestExec>false</ForceTestExec>
+        <method v="2"/>
+    </configuration>
+</component>

.run/Publish local artifacts.run.xml

@@ -1,3 +1,12 @@
+<!--
+  ~ Copyright 2019-2023 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
+  -->
+
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Publish local artifacts" type="GradleRunConfiguration" factoryName="Gradle" folderName="Build">
     <ExternalSystemSettings>
@@ -9,7 +18,7 @@
       <option name="executionName" />
       <option name="externalProjectPath" value="$PROJECT_DIR$" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="" />
+      <option name="scriptParameters" value="--stacktrace"/>
       <option name="taskDescriptions">
         <list />
       </option>
@@ -23,6 +32,7 @@
     <ExternalSystemDebugServerProcess>true</ExternalSystemDebugServerProcess>
     <ExternalSystemReattachDebugProcess>true</ExternalSystemReattachDebugProcess>
     <DebugAllEnabled>false</DebugAllEnabled>
+      <ForceTestExec>false</ForceTestExec>
     <method v="2" />
   </configuration>
 </component>

build.gradle.kts

@@ -11,6 +11,7 @@
 
 import org.jetbrains.dokka.base.DokkaBase
 import org.jetbrains.dokka.base.DokkaBaseConfiguration
+import shadow.configureMppShadow
 import java.time.LocalDateTime
 
 buildscript {
@@ -39,8 +40,10 @@ plugins {
     id("me.him188.kotlin-jvm-blocking-bridge") version Versions.blockingBridge
     id("me.him188.kotlin-dynamic-delegation") version Versions.dynamicDelegation apply false
     id("me.him188.maven-central-publish") version Versions.mavenCentralPublish apply false
-    id("com.gradle.plugin-publish") version "1.0.0-rc-3" apply false
+    id("com.gradle.plugin-publish") version "1.1.0" apply false
     id("org.jetbrains.kotlinx.binary-compatibility-validator") version Versions.binaryValidator apply false
+    id("com.android.library") apply false
+    id("de.mannodermaus.android-junit5") version "1.8.2.1" apply false
 }
 
 osDetector = osdetector
@@ -69,9 +72,7 @@ allprojects {
         configureMppShadow()
         configureEncoding()
         configureKotlinTestSettings()
-        configureKotlinExperimentalUsages()
-
-        //  useIr()
+        configureKotlinOptIns()
 
         if (isKotlinJvmProject) {
             configureFlattenSourceSets()
@@ -80,9 +81,6 @@ allprojects {
         substituteDependenciesUsingExpectedVersion()
     }
 }
-afterEvaluate {
-    configureShadowDependenciesForPublishing()
-}
 
 subprojects {
     afterEvaluate {
@@ -110,12 +108,6 @@ extensions.findByName("buildScan")?.withGroovyBuilder {
     setProperty("termsOfServiceAgree", "yes")
 }
 
-fun Project.useIr() {
-    kotlinCompilations?.forEach { kotlinCompilation ->
-        kotlinCompilation.kotlinOptions.freeCompilerArgs += "-Xuse-ir"
-    }
-}
-
 fun Project.configureDokka() {
     val isRoot = this@configureDokka == rootProject
     if (!isRoot) {

buildSrc/build.gradle.kts

@@ -70,6 +70,10 @@ dependencies {
         exclude("org.jetbrains.kotlin", "kotlin-stdlib-common")
     }
 
+    // https://mvnrepository.com/artifact/com.android.library/com.android.library.gradle.plugin
+    api("com.android.library:com.android.library.gradle.plugin:${version("androidGradlePlugin")}")
+    api("com.google.code.gson:gson:2.10.1")
+
     api("gradle.plugin.com.google.gradle:osdetector-gradle-plugin:1.7.0")
 
     api(gradleApi())

buildSrc/src/main/kotlin/Android.kt

@@ -0,0 +1,287 @@
+/*
+ * Copyright 2019-2023 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("UNUSED_VARIABLE")
+
+import com.android.build.api.dsl.LibraryExtension
+import org.gradle.api.JavaVersion
+import org.gradle.api.Project
+import org.gradle.api.tasks.testing.Test
+import org.gradle.kotlin.dsl.*
+import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
+import java.util.*
+
+const val PROP_MIRAI_ENABLE_ANDROID_INSTRUMENTED_TESTS = "mirai.enable.android.instrumented.tests"
+
+/**
+ * Use [usingAndroidInstrumentedTests] instead.
+ */
+val ENABLE_ANDROID_INSTRUMENTED_TESTS by projectLazy {
+    val name = PROP_MIRAI_ENABLE_ANDROID_INSTRUMENTED_TESTS
+    (System.getProperty(name)
+        ?: System.getenv(name)
+        ?: rootProject.getLocalProperty(name)
+        ?: "true").toBooleanStrict()
+}
+
+val Project.usingAndroidInstrumentedTests
+    get() = ENABLE_ANDROID_INSTRUMENTED_TESTS && isAndroidSdkAvailable
+
+fun Project.configureAndroidTarget(androidNamespace: String) {
+    if (ENABLE_ANDROID_INSTRUMENTED_TESTS && !isAndroidSdkAvailable) {
+        if (!ProjectAndroidSdkAvailability.tryFixAndroidSdk(this)) {
+            printAndroidNotInstalled()
+        }
+    }
+
+    extensions.getByType(KotlinMultiplatformExtension::class.java).apply {
+        if (project.usingAndroidInstrumentedTests) {
+            configureAndroidTargetWithSdk(androidNamespace)
+        } else {
+            configureAndroidTargetWithJvm()
+        }
+    }
+}
+
+private fun Project.configureAndroidTargetWithJvm() {
+    extensions.getByType(KotlinMultiplatformExtension::class.java).apply {
+        jvm("android") {
+            attributes.attribute(KotlinPlatformType.attribute, KotlinPlatformType.androidJvm)
+
+            if (IDEA_ACTIVE) {
+                attributes.attribute(MIRAI_PLATFORM_ATTRIBUTE, "android") // workaround for IDE bug
+            }
+        }
+
+        sourceSets.getByName("androidTest").configureJvmTest("configureAndroidTargetWithJvm")
+        sourceSets.getByName("androidTest").kotlin.srcDir(projectDir.resolve("src/androidUnitTest/kotlin"))
+
+        sourceSets.getByName("androidMain").apply {
+            dependencies {
+                compileOnly(`android-runtime`)
+            }
+        }
+
+        tasks.all {
+            if (this.name == "androidTest") {
+                this as Test
+                this.environment(PROP_MIRAI_ANDROID_SDK_KIND, "jdk")
+            }
+        }
+    }
+}
+
+private const val PROP_MIRAI_ANDROID_SDK_KIND = "mirai.android.sdk.kind"
+
+@Suppress("UnstableApiUsage")
+private fun Project.configureAndroidTargetWithSdk(androidNamespace: String) {
+    apply(plugin = "com.android.library")
+    apply(plugin = "de.mannodermaus.android-junit5")
+    extensions.getByType(LibraryExtension::class).apply {
+        namespace = androidNamespace
+    }
+    extensions.getByType(KotlinMultiplatformExtension::class.java).apply {
+        android {
+            publishLibraryVariants("release", "debug")
+        }
+
+        val jvmBaseMain = sourceSets.maybeCreate("jvmBaseMain")
+        val jvmBaseTest = sourceSets.maybeCreate("jvmBaseTest")
+
+        val androidMain by sourceSets.getting
+        androidMain.dependsOn(jvmBaseMain)
+
+        // don't use androidTest, deprecated by Kotlin
+
+        // this can cause problems on sync
+//                for (s in arrayOf("androidDebug", "androidRelease")) {
+//                    sourceSets.all { if (name in s) dependsOn(androidMain) }
+//                }
+
+//                 we should have added a "androidBaseTest" (or "androidTest") for "androidUnitTest" and "androidInstrumentedTest",
+//                 but this currently cause bugs in IntelliJ (2023.2)
+//                val androidBaseTest = sourceSets.maybeCreate("androidBaseTest").apply {
+//                    dependsOn(jvmBaseTest)
+//                }
+        val androidUnitTest by sourceSets.getting {
+            dependsOn(jvmBaseTest)
+        }
+//                for (s in arrayOf("androidUnitTestDebug", "androidUnitTestRelease")) {
+//                    sourceSets.all { if (name in s) dependsOn(androidUnitTest) }
+//                }
+        val androidInstrumentedTest by sourceSets.getting {
+            dependsOn(jvmBaseTest)
+        }
+//                for (s in arrayOf("androidInstrumentedTestDebug")) {
+//                    sourceSets.all { if (name in s) dependsOn(androidInstrumentedTest) }
+//                }
+
+//                afterEvaluate {
+////                    > androidDebug dependsOn commonMain
+////                    androidInstrumentedTest dependsOn jvmBaseTest
+////                    androidInstrumentedTestDebug dependsOn
+////                    androidMain dependsOn commonMain, jvmBaseMain
+////                    androidRelease dependsOn commonMain
+////                    androidUnitTest dependsOn commonTest, jvmBaseTest
+////                    androidUnitTestDebug dependsOn commonTest
+////                    androidUnitTestRelease dependsOn commonTest
+//                    error(this@apply.sourceSets.joinToString("\n") {
+//                        it.name + " dependsOn " + it.dependsOn.joinToString { it.name }
+//                    })
+//                }
+
+        configure(
+            listOf(
+                sourceSets.getByName("androidInstrumentedTest"),
+                sourceSets.getByName("androidUnitTest"),
+            )
+        ) {
+            dependencies { implementation(kotlin("test-annotations-common"))?.because("configureAndroidTargetWithSdk") }
+        }
+
+        tasks.all {
+            if (this.name == "testDebugUnitTest" || this.name == "testReleaseUnitTest") {
+                this as Test
+                this.environment(PROP_MIRAI_ANDROID_SDK_KIND, "adk")
+            }
+        }
+    }
+
+    // trick for compiler bug
+    this.sourceSets.apply {
+        removeIf { it.name == "androidAndroidTestRelease" }
+        removeIf { it.name == "androidTestFixtures" }
+        removeIf { it.name == "androidTestFixturesDebug" }
+        removeIf { it.name == "androidTestFixturesRelease" }
+    }
+
+    extensions.getByType(LibraryExtension::class.java).apply {
+        compileSdk = 33
+        sourceSets["main"].manifest.srcFile("src/androidMain/AndroidManifest.xml")
+        defaultConfig {
+            minSdk = rootProject.extra["mirai.android.target.api.level"]!!.toString().toInt()
+            targetSdk = 33
+        }
+        compileOptions {
+            sourceCompatibility = JavaVersion.VERSION_1_8
+            targetCompatibility = JavaVersion.VERSION_1_8
+        }
+        buildTypes.getByName("release") {
+            isMinifyEnabled = true
+            isShrinkResources = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+            )
+        }
+    }
+
+    extensions.getByType(LibraryExtension::class.java).apply {
+        defaultConfig {
+            // 1) Make sure to use the AndroidJUnitRunner, or a subclass of it. This requires a dependency on androidx.test:runner, too!
+            testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+            // 2) Connect JUnit 5 to the runner
+            testInstrumentationRunnerArguments["runnerBuilder"] = "de.mannodermaus.junit5.AndroidJUnit5Builder"
+        }
+    }
+
+//        val sourceSets = arrayOf("androidInstrumentedTest", "androidUnitTest")
+//            .map { kotlin.sourceSets.getByName(it) }
+
+//        for (sourceSet in sourceSets) {
+//            sourceSet.dependencies {
+//                implementation("androidx.test:runner:1.5.2")
+//                implementation("org.junit.jupiter:junit-jupiter-api:5.9.2")
+//                runtimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.2")
+//
+//                implementation("de.mannodermaus.junit5:android-test-core:1.3.0")
+//                implementation("de.mannodermaus.junit5:android-test-runner:1.3.0")
+//            }
+//        }
+
+    dependencies {
+        // 4) Jupiter API & Test Runner, if you don't have it already
+        "androidTestImplementation"("androidx.test:runner:1.5.2")
+        "androidTestImplementation"("org.junit.jupiter:junit-jupiter-api:${Versions.junit}")
+        "androidTestRuntimeOnly"("org.junit.jupiter:junit-jupiter-engine:${Versions.junit}")
+
+        // 5) The instrumentation test companion libraries
+        "androidTestImplementation"("de.mannodermaus.junit5:android-test-core:1.3.0")
+        "androidTestRuntimeOnly"("de.mannodermaus.junit5:android-test-runner:1.3.0")
+    }
+}
+
+private fun Project.printAndroidNotInstalled() {
+    logger.warn(
+        """
+            你设置了启用 Android Instrumented Test, 但是未配置 Android SDK. $name 的 Android 目标将会使用桌面 JVM 编译和测试. 
+            Android Instrumented Test 将不会进行. 这不会影响 Android 以外的平台的编译和测试. 
+            
+            如果你要给 mirai PR 并且你修改了 Android 部分, 建议解决此警告. 
+            如果你没有修改 Android 部分, 则可以忽略, 或者在项目根目录 local.properties (如果不存在就创建一个) 添加 `$PROP_MIRAI_ENABLE_ANDROID_INSTRUMENTED_TESTS=false`.
+            
+            在安装 Android SDK 后, 请在项目根目录 local.properties 中添加 `sdk.dir=/path/to/Android/sdk` 指向本机 Android SDK 安装路径.
+            
+            若要关闭 Android Instrumented Test, 在项目根目录 local.properties 添加 `$PROP_MIRAI_ENABLE_ANDROID_INSTRUMENTED_TESTS=false`.
+            -------
+            """.trimIndent()
+    )
+//    logger.warn(
+//        """Android SDK might not be installed. Android target of $name will not be compiled. It does no influence on the compilation of other platforms.
+//            """.trimIndent()
+//    )
+}
+
+
+private object ProjectAndroidSdkAvailability {
+    val map: MutableMap<String, Boolean> by projectLazy { mutableMapOf() }
+
+    @Synchronized
+    operator fun get(project: Project): Boolean {
+        if (map[project.path] != null) return map[project.path]!!
+
+        val projectAvailable = project.runCatching {
+            val keyProps = Properties().apply {
+                file("local.properties").takeIf { it.exists() }?.inputStream()?.use { load(it) }
+            }
+            keyProps.getProperty("sdk.dir", "").isNotEmpty()
+        }.getOrElse { false }
+
+
+        fun impl(): Boolean {
+            if (project === project.rootProject) return projectAvailable
+            return projectAvailable || get(project.rootProject)
+        }
+        map[project.path] = impl()
+        return map[project.path]!!
+    }
+
+    fun tryFixAndroidSdk(project: Project): Boolean {
+        val androidHome = System.getenv("ANDROID_HOME") ?: kotlin.run {
+            project.logger.info("tryFixAndroidSdk: environment `ANDROID_HOME` does not exist")
+            return false
+        }
+
+        val escaped = androidHome
+            .replace(""":""", """\:""")
+            .replace("""\""", """\\""")
+            .trim()
+
+        project.rootDir.resolve("local.properties")
+            .apply { if (!exists()) createNewFile() }
+            .appendText("sdk.dir=$escaped")
+
+        project.logger.info("tryFixAndroidSdk: fixed sdk.dir in local.properties: $escaped")
+
+        map.clear()
+        return get(project)
+    }
+}
+
+private val Project.isAndroidSdkAvailable: Boolean get() = ProjectAndroidSdkAvailability[this]

buildSrc/src/main/kotlin/BinaryCompatibilityConfigurator.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -52,7 +52,8 @@ object BinaryCompatibilityConfigurator {
         }
     }
 
-    private fun Project.getValidatorDir(dir: File) = ":validator" + project.path + ":${dir.name}"
+    // Also change: settings.gradle.kts:116
+    private fun Project.getValidatorDir(dir: File) = ":validator" + project.path + "-validator:${dir.name}"
 
     private fun File.writeTextIfNeeded(text: String) {
         if (!this.exists()) return this.writeText(text)
@@ -67,7 +68,10 @@ object BinaryCompatibilityConfigurator {
         dir.resolve("build.gradle.kts").writeTextIfNeeded(
             applyTemplate(
                 project.path,
-                if (targetName == null) "classes/kotlin/main" else "classes/kotlin/$targetName/main"
+                listOfNotNull(
+                    if (targetName == null) "classes/kotlin/main" else "classes/kotlin/$targetName/main",
+                    if (targetName?.contains("android") == true) "tmp/kotlin-classes/debug" else ""
+                )
             )
         )
         dir.resolve(".gitignore").writeTextIfNeeded(
@@ -79,21 +83,32 @@ object BinaryCompatibilityConfigurator {
             findProject(getValidatorDir(dir))
                 ?.afterEvaluate {
                     if (targetName == null) {
-                        tasks.findByName("apiBuild")?.dependsOn(project.tasks.getByName("jar"))
+                        tasks.findByName("apiBuild")?.dependsOn(
+                            *listOfNotNull(
+                                project.tasks.getByName("jar"),
+                                project.tasks.findByName("compileDebugKotlinAndroid")
+                            ).toTypedArray()
+                        )
                     } else {
-                        tasks.findByName("apiBuild")?.dependsOn(project.tasks.getByName("${targetName}Jar"))
+                        tasks.findByName("apiBuild")?.dependsOn(
+                            if (targetName.contains("android")) {
+                                project.tasks.getByName("bundleDebugAar")
+                            } else {
+                                project.tasks.getByName("${targetName}Jar")
+                            }
+                        )
                     }
                 }
         }
     }
 
-    fun applyTemplate(projectPath: String, buildDir: String): String {
+    fun applyTemplate(projectPath: String, buildDirs: List<String>): String {
         return this::class.java.classLoader
             .getResourceAsStream("binary-compatibility-validator-build.txt")!!
             .useToRun { readBytes() }
             .decodeToString()
             .replace("$\$PROJECT_PATH$$", projectPath)
-            .replace("$\$BUILD_DIR$$", buildDir)
+            .replace("$\$BUILD_DIR$$", buildDirs.joinToString("\n"))
             .replace("$\$PLUGIN_VERSION$$", Versions.binaryValidator)
     }
 }

buildSrc/src/main/kotlin/DependencyDumper.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -70,7 +70,6 @@ object DependencyDumper {
             val outFile = temporaryDir.resolve(out)
             outputs.file(outFile)
             val conf = project.configurations.getByName(confName)
-            dependsOn(conf)
 
             doLast {
                 outFile.parentFile.mkdirs()

buildSrc/src/main/kotlin/HmppConfigure.kt

@@ -12,6 +12,7 @@ import org.gradle.api.Project
 import org.gradle.api.attributes.Attribute
 import org.gradle.kotlin.dsl.get
 import org.gradle.kotlin.dsl.getting
+import org.gradle.kotlin.dsl.provideDelegate
 import org.gradle.kotlin.dsl.withType
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
 import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation.Companion.MAIN_COMPILATION_NAME
@@ -23,21 +24,22 @@ import org.jetbrains.kotlin.gradle.plugin.KotlinTargetPreset
 import org.jetbrains.kotlin.gradle.plugin.mpp.*
 import org.jetbrains.kotlin.gradle.tasks.KotlinNativeLink
 import java.io.File
+import java.util.*
 
-val MIRAI_PLATFORM_ATTRIBUTE = Attribute.of(
+val MIRAI_PLATFORM_ATTRIBUTE: Attribute<String> = Attribute.of(
     "net.mamoe.mirai.platform", String::class.java
 )
 
 /**
  * Flags a target as an HMPP intermediate target
  */
-val MIRAI_PLATFORM_INTERMEDIATE = Attribute.of(
+val MIRAI_PLATFORM_INTERMEDIATE: Attribute<Boolean> = Attribute.of(
     "net.mamoe.mirai.platform.intermediate", Boolean::class.javaObjectType
 )
 
 val IDEA_ACTIVE = System.getProperty("idea.active") == "true" && System.getProperty("publication.test") != "true"
 
-val OS_NAME = System.getProperty("os.name").toLowerCase()
+val OS_NAME = System.getProperty("os.name").lowercase()
 
 lateinit var osDetector: OsDetector
 
@@ -152,22 +154,39 @@ val NATIVE_TARGETS by projectLazy { UNIX_LIKE_TARGETS + WIN_TARGETS }
 
 private val POSSIBLE_NATIVE_TARGETS by lazy { setOf("mingwX64", "macosX64", "macosArm64", "linuxX64") }
 
-fun Project.configureJvmTargetsHierarchical() {
+const val JVM_TOOLCHAIN_VERSION = 8
+
+/**
+ * ## Android Test 结构
+ *
+ * 如果[启用 Android Instrumented Test][ENABLE_ANDROID_INSTRUMENTED_TESTS], 将会配置使用 Android SDK 配置真 Android target,
+ * `androidMain` 将能访问 Android SDK, 也能获得针对 Android 的 IDE 错误检查.
+ *
+ * @see configureNativeTargetsHierarchical
+ */
+fun Project.configureJvmTargetsHierarchical(androidNamespace: String) {
     extensions.getByType(KotlinMultiplatformExtension::class.java).apply {
+        jvmToolchain(JVM_TOOLCHAIN_VERSION)
+       
         val commonMain by sourceSets.getting
         val commonTest by sourceSets.getting
 
         if (IDEA_ACTIVE) {
             jvm("jvmBase") { // dummy target for resolution, not published
                 compilations.all {
-                    this.compileTaskProvider.configure { // IDE complain
+                    // magic to help IDEA
+                    this.compileTaskProvider.configure {
                         enabled = false
-                    } 
+                    }
                 }
                 attributes.attribute(KotlinPlatformType.attribute, KotlinPlatformType.common) // magic
-                attributes.attribute(MIRAI_PLATFORM_ATTRIBUTE, "jvmBase") // avoid resolution
-                attributes.attribute(MIRAI_PLATFORM_INTERMEDIATE, true)
+
+                // avoid resolution when other modules dependsOn this project
+                attributes.attribute(MIRAI_PLATFORM_ATTRIBUTE, "jvmBase")
+                attributes.attribute(MIRAI_PLATFORM_INTERMEDIATE, true) // no shadow
             }
+        } else {
+            // if not in IDEA, no need to create intermediate targets.
         }
 
         val jvmBaseMain by lazy {
@@ -182,26 +201,11 @@ fun Project.configureJvmTargetsHierarchical() {
         }
 
         if (isTargetEnabled("android")) {
-            if (isAndroidSDKAvailable) {
-                jvm("android") {
-                    attributes.attribute(KotlinPlatformType.attribute, KotlinPlatformType.androidJvm)
-                    if (IDEA_ACTIVE) {
-                        attributes.attribute(MIRAI_PLATFORM_ATTRIBUTE, "android") // avoid resolution
-                    }
-                }
-                val androidMain by sourceSets.getting
-                val androidTest by sourceSets.getting
-                androidMain.dependsOn(jvmBaseMain)
-                androidTest.dependsOn(jvmBaseTest)
-            } else {
-                printAndroidNotInstalled()
-            }
+            configureAndroidTarget(androidNamespace)
         }
 
         if (isTargetEnabled("jvm")) {
-            jvm("jvm") {
-
-            }
+            jvm("jvm")
             val jvmMain by sourceSets.getting
             val jvmTest by sourceSets.getting
             jvmMain.dependsOn(jvmBaseMain)
@@ -210,7 +214,9 @@ fun Project.configureJvmTargetsHierarchical() {
     }
 }
 
+
 /**
+ * Target 结构:
  * ```
  *                      common
  *                        |
@@ -226,7 +232,9 @@ fun Project.configureJvmTargetsHierarchical() {
  *                        <darwin targets>
  * ```
  *
- * `<darwin targets>`: macosX64, macosArm64, tvosX64, iosArm64, iosArm32...
+ * `<darwin targets>`: macosX64, macosArm64
+ *
+ * @see configureJvmTargetsHierarchical
  */
 fun KotlinMultiplatformExtension.configureNativeTargetsHierarchical(
     project: Project
@@ -235,13 +243,14 @@ fun KotlinMultiplatformExtension.configureNativeTargetsHierarchical(
 
     val nativeMainSets = mutableListOf<KotlinSourceSet>()
     val nativeTestSets = mutableListOf<KotlinSourceSet>()
-    val nativeTargets = mutableListOf<KotlinTarget>() // actually KotlinNativeTarget, but KotlinNativeTarget is an internal API (complained by IDEA)
+    val nativeTargets =
+        mutableListOf<KotlinTarget>() // actually KotlinNativeTarget, but KotlinNativeTarget is an internal API (complained by IDEA)
 
 
     fun KotlinMultiplatformExtension.addNativeTarget(
         preset: KotlinTargetPreset<*>,
     ): KotlinTarget {
-        val target = targetFromPreset(preset, preset.name) 
+        val target = targetFromPreset(preset, preset.name)
         nativeMainSets.add(target.compilations[MAIN_COMPILATION_NAME].kotlinSourceSets.first())
         nativeTestSets.add(target.compilations[TEST_COMPILATION_NAME].kotlinSourceSets.first())
         nativeTargets.add(target)
@@ -387,10 +396,10 @@ fun KotlinMultiplatformExtension.configureNativeTargetBinaries(project: Project)
         val target = targets.getByName(targetName) as KotlinNativeTarget
         target.binaries {
             sharedLib(listOf(NativeBuildType.DEBUG, NativeBuildType.RELEASE)) {
-                baseName = project.name.toLowerCase().replace("-", "")
+                baseName = project.name.lowercase(Locale.ROOT).replace("-", "")
             }
             staticLib(listOf(NativeBuildType.DEBUG, NativeBuildType.RELEASE)) {
-                baseName = project.name.toLowerCase().replace("-", "")
+                baseName = project.name.lowercase(Locale.ROOT).replace("-", "")
             }
         }
     }

buildSrc/src/main/kotlin/JvmPublishing.kt

@@ -70,7 +70,7 @@ fun Project.configureRemoteRepos() {
                     }
                 }
             } else {
-                println("SonaType is not available")
+                logger.info("Sonatype is not available, Maven Central repository is not configured")
             }
         }
     }

buildSrc/src/main/kotlin/KotlinMetadataPatcher.kt

@@ -0,0 +1,169 @@
+/*
+ * Copyright 2019-2023 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
+ */
+
+import com.google.gson.Gson
+import com.google.gson.GsonBuilder
+import com.google.gson.JsonElement
+import com.google.gson.JsonPrimitive
+import org.gradle.api.GradleException
+import org.gradle.api.Project
+import org.gradle.api.Task
+import org.gradle.api.publish.maven.MavenPublication
+import org.gradle.api.publish.tasks.GenerateModuleMetadata
+import shadow.relocationFilters
+import java.io.File
+import java.io.InputStream
+import java.io.OutputStream
+import java.security.MessageDigest
+
+fun Project.configurePatchKotlinModuleMetadataTask(
+    relocatedPublicationName: String,
+    relocateDependencies: Task,
+    originalPublicationName: String
+) {
+    // We will modify Kotlin metadata, so do generate metadata before relocation
+    val generateMetadataTask =
+        tasks.getByName("generateMetadataFileFor${originalPublicationName.titlecase()}Publication") as GenerateModuleMetadata
+
+    publications.getByName(relocatedPublicationName) {
+        this as MavenPublication
+        this.artifact(generateMetadataTask.outputFile) {
+            classifier = null
+            extension = "module"
+        }
+    }
+
+    generateMetadataTask.dependsOn(relocateDependencies)
+    val patchMetadataTask =
+        tasks.create("patchMetadataFileFor${relocatedPublicationName.capitalize()}RelocatedPublication") {
+            group = "mirai"
+            generateMetadataTask.finalizedBy(this)
+            dependsOn(generateMetadataTask)
+            dependsOn(relocateDependencies)
+
+            // remove dependencies in Kotlin module metadata
+            doLast {
+                // mirai-core-jvm-2.13.0.module
+                val file = generateMetadataTask.outputFile.asFile.get()
+                val metadata = Gson().fromJson(
+                    file.readText(),
+                    JsonElement::class.java
+                ).asJsonObject
+
+                val metadataVersion = metadata["formatVersion"]?.asString
+                check(metadataVersion == "1.1") {
+                    "Unsupported Kotlin metadata version. version=$metadataVersion, file=${file.absolutePath}"
+                }
+                for (variant in metadata["variants"]!!.asJsonArray) {
+                    patchKotlinMetadataVariant(variant, relocateDependencies.outputs.files.singleFile)
+                }
+
+
+                file.writeText(GsonBuilder().setPrettyPrinting().create().toJson(metadata))
+            }
+        }
+
+    // Set "publishKotlinMultiplatformPublicationTo*" and "publish${targetName.capitalize()}PublicationTo*" dependsOn patchMetadataTask
+    if (project.kotlinMpp != null) {
+        tasks.filter { it.name.startsWith("publishKotlinMultiplatformPublicationTo") }.let { publishTasks ->
+            if (publishTasks.isEmpty()) {
+                throw GradleException("[Shadow Relocation] Cannot find publishKotlinMultiplatformPublicationTo for project '${project.path}'.")
+            }
+            publishTasks.forEach { it.dependsOn(patchMetadataTask) }
+        }
+
+        tasks.filter { it.name.startsWith("publish${relocatedPublicationName.capitalize()}PublicationTo") }
+            .let { publishTasks ->
+                if (publishTasks.isEmpty()) {
+                    throw GradleException("[Shadow Relocation] Cannot find publish${relocatedPublicationName.capitalize()}PublicationTo for project '${project.path}'.")
+                }
+                publishTasks.forEach { it.dependsOn(patchMetadataTask) }
+            }
+    }
+}
+
+private fun Project.patchKotlinMetadataVariant(variant: JsonElement, relocatedJar: File) {
+    val dependencies = variant.asJsonObject["dependencies"]!!.asJsonArray
+    dependencies.removeAll { dependency ->
+        val dep = dependency.asJsonObject
+
+        val groupId = dep["group"]!!.asString
+        val artifactId = dep["module"]!!.asString
+        relocationFilters.any { filter ->
+            filter.matchesDependency(
+                groupId = groupId,
+                artifactId = artifactId
+            )
+        }.also {
+            println("[Shadow Relocation] Filtering out $groupId:$artifactId from Kotlin module")
+        }
+    }
+
+
+    /*
+    "files": [
+    {
+      "name": "mirai-core-jvm-2.99.0-local.jar",
+      "url": "mirai-core-jvm-2.99.0-local.jar",
+      "size": 14742378,
+      "sha512": "7ab4afc88384a58687467ba13c6aefeda20fa53fd7759dc2bc78b2d46a6285f94ba6ccae426d192e7745f773401b3cb42a853e5445dc23bdcb1b5295e78ff71c",
+      "sha256": "772f593bfb85a80794693d4d9dfe2f77c222cfe9ca7e0d571abaa320e7aa82d3",
+      "sha1": "cb7937269d29b574725d6f28668847fd672de7cf",
+      "md5": "3fca635ba5e55b7dd56c552e4ca01f7e"
+    }
+  ]
+     */
+
+    val files = variant.asJsonObject["files"].asJsonArray
+    val filesList = files.toList()
+    files.removeAll { true }
+    for (publishedFile0 in filesList) {
+        val publishedFile = publishedFile0.asJsonObject
+
+        val name = publishedFile["name"].asJsonPrimitive.asString
+        if (name.endsWith(".jar")) {
+            logPublishing { "Patching Kotlin Metadata: file $name" }
+            for (algorithm in ALGORITHMS) {
+                publishedFile.add(algorithm, JsonPrimitive(relocatedJar.digest(algorithm)))
+            }
+            publishedFile.add("size", JsonPrimitive(relocatedJar.length()))
+        } else {
+            error("Unexpected file '$name' while patching Kotlin metadata")
+        }
+
+        files.add(publishedFile)
+    }
+}
+
+private val ALGORITHMS = listOf("md5", "sha1", "sha256", "sha512")
+
+fun File.digest(algorithm: String): String {
+    val arr = inputStream().buffered().use { it.digest(algorithm) }
+    return arr.toUHexString("").lowercase()
+}
+
+fun InputStream.digest(algorithm: String): ByteArray {
+    val digest = MessageDigest.getInstance(algorithm)
+    digest.reset()
+    use { input ->
+        object : OutputStream() {
+            override fun write(b: Int) {
+                digest.update(b.toByte())
+            }
+
+            override fun write(b: ByteArray, off: Int, len: Int) {
+                digest.update(b, off, len)
+            }
+        }.use { output ->
+            input.copyTo(output)
+        }
+    }
+    return digest.digest()
+}
+

buildSrc/src/main/kotlin/Mpp.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -16,35 +16,6 @@ import org.gradle.api.artifacts.component.ComponentSelector
 import org.gradle.api.plugins.ExtensionAware
 import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
 import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
-import java.util.*
-
-private object ProjectAndroidSdkAvailability {
-    val map: MutableMap<String, Boolean> = mutableMapOf()
-
-    @Suppress("UNUSED_PARAMETER", "UNREACHABLE_CODE")
-    @Synchronized
-    operator fun get(project: Project): Boolean {
-        return true
-        if (map[project.path] != null) return map[project.path]!!
-
-        val projectAvailable = project.runCatching {
-            val keyProps = Properties().apply {
-                file("local.properties").takeIf { it.exists() }?.inputStream()?.use { load(it) }
-            }
-            keyProps.getProperty("sdk.dir", "").isNotEmpty()
-        }.getOrElse { false }
-
-
-        fun impl(): Boolean {
-            if (project === project.rootProject) return projectAvailable
-            return projectAvailable || get(project.rootProject)
-        }
-        map[project.path] = impl()
-        return map[project.path]!!
-    }
-}
-
-val Project.isAndroidSDKAvailable: Boolean get() = ProjectAndroidSdkAvailability[this]
 
 val <T> NamedDomainObjectCollection<T>.androidMain: NamedDomainObjectProvider<T>
     get() = named("androidMain")
@@ -61,16 +32,6 @@ val <T> NamedDomainObjectCollection<T>.jvmTest: NamedDomainObjectProvider<T>
 val <T> NamedDomainObjectCollection<T>.commonMain: NamedDomainObjectProvider<T>
     get() = named("commonMain")
 
-fun Project.printAndroidNotInstalled() {
-    println(
-        """Android SDK 可能未安装. $name 的 Android 目标编译将不会进行. 这不会影响 Android 以外的平台的编译.
-            """.trimIndent()
-    )
-    println(
-        """Android SDK might not be installed. Android target of $name will not be compiled. It does no influence on the compilation of other platforms.
-            """.trimIndent()
-    )
-}
 
 inline fun forMppModules(action: (suffix: String) -> Unit) {
     arrayOf(

buildSrc/src/main/kotlin/MppPublishing.kt

@@ -15,9 +15,11 @@ import org.gradle.api.tasks.TaskProvider
 import org.gradle.jvm.tasks.Jar
 import org.gradle.kotlin.dsl.get
 import org.gradle.kotlin.dsl.register
+import shadow.RelocationConfig
+import shadow.relocationFilters
 
-inline fun logPublishing(@Suppress("UNUSED_PARAMETER") message: () -> String) {
-//    println("[Publishing] Configuring $message")
+inline fun Project.logPublishing(message: () -> String) {
+    logger.debug("[Publishing] Configuring {}", message())
 }
 
 fun Project.configureMppPublishing() {
@@ -45,7 +47,9 @@ fun Project.configureMppPublishing() {
             logPublishing { "Publications: ${publications.joinToString { it.name }}" }
 
             val (nonJvmPublications, jvmPublications) = publications.filterIsInstance<MavenPublication>()
-                .partition { publication -> tasks.findByName("relocate${publication.name.titlecase()}Dependencies") == null }
+                .partition { publication ->
+                    tasks.findByName(RelocationConfig.taskNameForRelocateDependencies(publication.name)) == null
+                }
 
             for (publication in nonJvmPublications) {
                 configureMultiplatformPublication(publication, stubJavadoc, publication.name)
@@ -76,7 +80,7 @@ fun Project.configureMppPublishing() {
                 configureMultiplatformPublication(publication, stubJavadoc, publication.name)
                 publication.apply {
                     artifacts.filter { it.classifier.isNullOrEmpty() && it.extension == "jar" }.forEach {
-                        it.builtBy(tasks.findByName("relocate${publication.name.titlecase()}Dependencies"))
+                        it.builtBy(tasks.findByName(RelocationConfig.taskNameForRelocateDependencies(publication.name)))
                     }
                 }
             }
@@ -108,6 +112,12 @@ private fun Project.configureMultiplatformPublication(
             publication.artifactId = "${project.name}-metadata"
         }
 
+        "jvm" -> {
+            publication.artifactId = "${project.name}-$moduleName"
+
+            useRelocatedPublication(publication, moduleName)
+        }
+
         else -> {
             // "jvm", "native", "js", "common"
             publication.artifactId = "${project.name}-$moduleName"
@@ -115,6 +125,133 @@ private fun Project.configureMultiplatformPublication(
     }
 }
 
+/**
+ * Creates a new publication and disables [publication].
+ */
+private fun Project.useRelocatedPublication(
+    publication: MavenPublication,
+    moduleName: String
+) {
+    val relocatedPublicationName = RelocationConfig.relocatedPublicationName(publication.name)
+    registerRelocatedPublication(relocatedPublicationName, publication, moduleName)
+
+    logPublishing { "Registered relocated publication `$relocatedPublicationName` for module $moduleName, for project ${project.path}" }
+
+    // Add task dependencies
+    addTaskDependenciesForRelocatedPublication(moduleName, relocatedPublicationName)
+
+    val relocateDependencies = tasks.getByName(RelocationConfig.taskNameForRelocateDependencies(moduleName))
+
+    configurePatchKotlinModuleMetadataTask(relocatedPublicationName, relocateDependencies, publication.name)
+}
+
+private fun Project.registerRelocatedPublication(
+    relocatedPublicationName: String,
+    publication: MavenPublication,
+    moduleName: String
+) {
+    // copy POM XML, since POM contains transitive dependencies
+
+    var patched = false
+
+    lateinit var oldXmlProvider: XmlProvider
+    publication.pom.withXml { oldXmlProvider = this }
+
+    publications.register(relocatedPublicationName, MavenPublication::class.java) {
+        this.artifactId = publication.artifactId
+        this.groupId = publication.groupId
+        this.version = publication.version
+        this.artifacts.addAll(publication.artifacts.filterNot { it.classifier == null && it.extension == "jar" })
+
+        project.tasks.findByName(RelocationConfig.taskNameForRelocateDependencies(moduleName))
+            ?.let { relocateDependencies ->
+                this.artifact(relocateDependencies) {
+                    this.classifier = null
+                    this.extension = "jar"
+                }
+            }
+
+        pom.withXml {
+            val newXml = this
+            for (newChild in newXml.asNode().childrenNodes()) {
+                newXml.asNode().remove(newChild)
+            }
+            // Note: `withXml` is lazy, it is evaluated only when `generatePomFileFor...`
+            for (oldChild in oldXmlProvider.asNode().childrenNodes()) {
+                newXml.asNode().append(oldChild)
+            }
+            removeDependenciesInMavenPom(this)
+            patched = true
+        }
+    }
+
+    tasks.matching { it.name.startsWith("publish${relocatedPublicationName.titlecase()}PublicationTo") }.all {
+        dependsOn("generatePomFileFor${relocatedPublicationName.titlecase()}Publication")
+    }
+
+
+    tasks.matching { it.name == "generatePomFileFor${relocatedPublicationName.titlecase()}Publication" }.all {
+        dependsOn(tasks.getByName("generatePomFileFor${publication.name.titlecase()}Publication"))
+        doLast {
+            check(patched) { "POM is not patched" }
+        }
+    }
+}
+
+private fun Project.addTaskDependenciesForRelocatedPublication(moduleName: String, relocatedPublicationName: String) {
+    val originalTaskNamePrefix = "publish${moduleName.titlecase()}PublicationTo"
+    val relocatedTaskName = "publish${relocatedPublicationName.titlecase()}PublicationTo"
+    tasks.configureEach {
+        if (!name.startsWith(originalTaskNamePrefix)) return@configureEach
+        val originalTask = this
+
+        this.enabled = false
+        this.description = "${this.description} ([mirai] disabled in favor of $relocatedTaskName)"
+
+        val relocatedTasks = project.tasks.filter { it.name.startsWith(relocatedTaskName) }.toTypedArray()
+        check(relocatedTasks.isNotEmpty()) { "relocatedTasks is empty" }
+        relocatedTasks.forEach { publishRelocatedPublication ->
+            publishRelocatedPublication.dependsOn(*this.dependsOn.toTypedArray())
+            logger.info(
+                "[Publishing] $publishRelocatedPublication now dependsOn tasks: " +
+                        this.dependsOn.joinToString()
+            )
+        }
+
+        project.tasks.filter { it.dependsOn.contains(originalTask) }
+            .forEach { it.dependsOn(*relocatedTasks) }
+    }
+}
+
+// Remove relocated dependencies in Maven pom
+private fun Project.removeDependenciesInMavenPom(xmlProvider: XmlProvider) {
+    xmlProvider.run {
+        val node = asNode().getSingleChild("dependencies")
+        val dependencies = node.childrenNodes()
+        logger.info("[Shadow Relocation] deps: {}", dependencies)
+        logger.info(
+            "[Shadow Relocation] All filter notations: {}",
+            relocationFilters.flatMap { it.notations.notations() }.joinToString("\n")
+        )
+
+        dependencies.forEach { dep ->
+            val groupId = dep.getSingleChild("groupId").value().toString().removeSurrounding("[", "]")
+            val artifactId = dep.getSingleChild("artifactId").value().toString().removeSurrounding("[", "]")
+            logger.info("[Shadow Relocation] Checking $groupId:$artifactId")
+
+            if (
+                relocationFilters.any { filter ->
+                    filter.matchesDependency(groupId = groupId, artifactId = artifactId)
+                }
+            ) {
+                logger.info("[Shadow Relocation] Filtering out '$groupId:$artifactId' from pom for project '${project.path}'")
+                check(node.remove(dep)) { "Failed to remove dependency node" }
+            }
+        }
+
+    }
+}
+
 val publishPlatformArtifactsInRootModule: Project.(MavenPublication) -> Unit = { platformPublication ->
     lateinit var platformPomBuilder: XmlProvider
     platformPublication.pom.withXml { platformPomBuilder = this }

buildSrc/src/main/kotlin/ProjectConfigure.kt

@@ -7,32 +7,23 @@
  * https://github.com/mamoe/mirai/blob/dev/LICENSE
  */
 
-@file:Suppress("NULLABILITY_MISMATCH_BASED_ON_JAVA_ANNOTATIONS")
-
 import org.gradle.api.JavaVersion
+import org.gradle.api.NamedDomainObjectCollection
+import org.gradle.api.NamedDomainObjectList
 import org.gradle.api.Project
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.tasks.bundling.Jar
 import org.gradle.api.tasks.compile.JavaCompile
 import org.gradle.api.tasks.testing.Test
 import org.gradle.kotlin.dsl.*
-import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
-import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
-import org.jetbrains.kotlin.gradle.dsl.KotlinProjectExtension
-import org.jetbrains.kotlin.gradle.dsl.KotlinSingleTargetExtension
+import org.jetbrains.kotlin.gradle.dsl.*
+import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation
 import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
 import org.jetbrains.kotlin.gradle.plugin.KotlinSourceSet
 import org.jetbrains.kotlin.gradle.plugin.KotlinTarget
 import org.jetbrains.kotlin.gradle.targets.jvm.KotlinJvmTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinJvmCompile
 
-
-fun Project.useIr() {
-    kotlinCompilations?.forEach { kotlinCompilation ->
-        kotlinCompilation.kotlinOptions.freeCompilerArgs += "-Xuse-ir"
-    }
-}
-
 private fun Project.jvmVersion(): JavaVersion {
     return if (project.path.endsWith("mirai-console-intellij")) {
         JavaVersion.VERSION_17
@@ -55,6 +46,22 @@ fun Project.enableLanguageFeatureForAllSourceSets(qualifiedClassname: String) {
     }
 }
 
+fun Project.enableLanguageFeatureForTestSourceSets(name: String) {
+    allTestSourceSets {
+        languageSettings {
+            this.enableLanguageFeature(name)
+        }
+    }
+}
+
+fun Project.allTestSourceSets(action: KotlinSourceSet.() -> Unit) {
+    kotlinSourceSets!!.all {
+        if (this.name.contains("test", ignoreCase = true)) {
+            action()
+        }
+    }
+}
+
 fun Project.preConfigureJvmTarget() {
     val defaultVer = jvmVersion()
 
@@ -78,34 +85,14 @@ fun Project.preConfigureJvmTarget() {
 fun Project.configureJvmTarget() {
     val defaultVer = jvmVersion()
 
-    configure(kotlinSourceSets.orEmpty()) {
-        languageSettings {
-            optIn("net.mamoe.mirai.utils.TestOnly")
-            optIn("kotlinx.coroutines.ExperimentalCoroutinesApi")
-        }
-    }
-
     extensions.findByType(JavaPluginExtension::class.java)?.run {
         sourceCompatibility = defaultVer
         targetCompatibility = defaultVer
     }
 
-    kotlinTargets.orEmpty().filterIsInstance<KotlinJvmTarget>().forEach { target ->
-        when (target.attributes.getAttribute(KotlinPlatformType.attribute)) { // mirai does magic, don't use target.platformType
-            KotlinPlatformType.androidJvm -> {
-                target.compilations.all {
-                    /*
-                     * Kotlin JVM compiler generates Long.hashCode witch is available since API 26 when targeting JVM 1.8 while IR prefer member function hashCode always.
-                     */
-                    // kotlinOptions.useIR = true
-
-                    // IR cannot compile mirai. We'll wait for Kotlin 1.5 for stable IR release.
-                }
-            }
-            else -> {
-            }
-        }
-        target.testRuns["test"].executionTask.configure { useJUnitPlatform() }
+    allKotlinTargets().all {
+        if (this !is KotlinJvmTarget) return@all
+        this.testRuns["test"].executionTask.configure { useJUnitPlatform() }
     }
 }
 
@@ -129,34 +116,27 @@ fun Project.configureKotlinTestSettings() {
                 "testRuntimeOnly"(`junit-jupiter-engine`)?.because(b)
             }
         }
+
         isKotlinMpp -> {
-            kotlinSourceSets?.forEach { sourceSet ->
-                fun configureJvmTest(sourceSet: KotlinSourceSet) {
-                    sourceSet.dependencies {
-                        implementation(kotlin("test-junit5"))?.because(b)
+            kotlinSourceSets?.all {
+                val sourceSet = this
 
-                        implementation(`junit-jupiter-api`)?.because(b)
-                        runtimeOnly(`junit-jupiter-engine`)?.because(b)
-                    }
-                }
-
-                val target = kotlinTargets.orEmpty()
+                val target = allKotlinTargets()
                     .find { it.name == sourceSet.name.substringBeforeLast("Main").substringBeforeLast("Test") }
 
-                when {
-                    sourceSet.name == "commonTest" -> {
-                        if (isJvmLikePlatform(target)) {
-                            configureJvmTest(sourceSet)
-                        } else {
+                if (sourceSet.name.contains("test", ignoreCase = true)) {
+                    if (isJvmFinalTarget(target)) {
+                        // For android, this should be done differently. See Android.kt
+                        sourceSet.configureJvmTest(b)
+                    } else {
+                        if (sourceSet.name == "commonTest") {
                             sourceSet.dependencies {
                                 implementation(kotlin("test"))?.because(b)
                                 implementation(kotlin("test-annotations-common"))?.because(b)
                             }
-                        }
-                    }
-                    sourceSet.name.contains("test", ignoreCase = true) -> {
-                        if (isJvmLikePlatform(target)) {
-                            configureJvmTest(sourceSet)
+                        } else {
+                            // can be an Android sourceSet
+                            // Do not even add "kotlin-test" for Android sourceSets. IDEA can't resolve them on sync
                         }
                     }
                 }
@@ -165,6 +145,19 @@ fun Project.configureKotlinTestSettings() {
     }
 }
 
+private fun isJvmFinalTarget(target: KotlinTarget?) =
+    target?.platformType == KotlinPlatformType.jvm &&
+            target.attributes.getAttribute(MIRAI_PLATFORM_INTERMEDIATE) != true // jvmBase is intermediate
+
+fun KotlinSourceSet.configureJvmTest(because: String) {
+    dependencies {
+        implementation(kotlin("test-junit5"))?.because(because)
+
+        implementation(`junit-jupiter-api`)?.because(because)
+        runtimeOnly(`junit-jupiter-engine`)?.because(because)
+    }
+}
+
 private fun isJvmLikePlatform(target: KotlinTarget?) =
     target?.platformType == KotlinPlatformType.jvm || target?.platformType == KotlinPlatformType.androidJvm
 
@@ -172,7 +165,9 @@ val testExperimentalAnnotations = arrayOf(
     "kotlin.ExperimentalUnsignedTypes",
     "kotlin.time.ExperimentalTime",
     "io.ktor.util.KtorExperimentalAPI",
-    "kotlin.io.path.ExperimentalPathApi"
+    "kotlin.io.path.ExperimentalPathApi",
+    "kotlinx.coroutines.ExperimentalCoroutinesApi",
+    "net.mamoe.mirai.utils.TestOnly",
 )
 
 val experimentalAnnotations = arrayOf(
@@ -194,15 +189,26 @@ val experimentalAnnotations = arrayOf(
     "io.ktor.utils.io.core.internal.DangerousInternalIoApi"
 )
 
-fun Project.configureKotlinExperimentalUsages() {
-    val sourceSets = kotlinSourceSets ?: return
+val testLanguageFeatures = listOf(
+    "ContextReceivers"
+)
 
-    for (target in sourceSets) {
-        target.configureKotlinExperimentalUsages()
+fun Project.configureKotlinOptIns() {
+    val sourceSets = kotlinSourceSets ?: return
+    sourceSets.all {
+        configureKotlinOptIns()
+    }
+
+    for (name in testLanguageFeatures) {
+        enableLanguageFeatureForTestSourceSets(name)
+    }
+
+    allTestSourceSets {
+        languageSettings.languageVersion = Versions.kotlinLanguageVersionForTests
     }
 }
 
-fun KotlinSourceSet.configureKotlinExperimentalUsages() {
+fun KotlinSourceSet.configureKotlinOptIns() {
     languageSettings.progressiveMode = true
     experimentalAnnotations.forEach { a ->
         languageSettings.optIn(a)
@@ -247,13 +253,22 @@ inline fun <reified T> Any?.safeAs(): T? {
 
 val Project.kotlinSourceSets get() = extensions.findByName("kotlin").safeAs<KotlinProjectExtension>()?.sourceSets
 
-val Project.kotlinTargets
-    get() =
-        extensions.findByName("kotlin").safeAs<KotlinSingleTargetExtension<*>>()?.target?.let { listOf(it) }
-            ?: extensions.findByName("kotlin").safeAs<KotlinMultiplatformExtension>()?.targets
+fun Project.allKotlinTargets(): NamedDomainObjectCollection<KotlinTarget> {
+    return extensions.findByName("kotlin")?.safeAs<KotlinSingleTargetExtension<*>>()
+        ?.target?.let { namedDomainObjectListOf(it) }
+        ?: extensions.findByName("kotlin")?.safeAs<KotlinMultiplatformExtension>()?.targets
+        ?: namedDomainObjectListOf()
+}
+
+private inline fun <reified T> Project.namedDomainObjectListOf(vararg values: T): NamedDomainObjectList<T> {
+    return objects.namedDomainObjectList(T::class.java).apply { addAll(values) }
+}
 
 val Project.isKotlinJvmProject: Boolean get() = extensions.findByName("kotlin") is KotlinJvmProjectExtension
 val Project.isKotlinMpp: Boolean get() = extensions.findByName("kotlin") is KotlinMultiplatformExtension
 
-val Project.kotlinCompilations
-    get() = kotlinTargets?.flatMap { it.compilations }
+fun Project.allKotlinCompilations(action: (KotlinCompilation<KotlinCommonOptions>) -> Unit) {
+    allKotlinTargets().all {
+        compilations.all(action)
+    }
+}

buildSrc/src/main/kotlin/Shadow.kt

@@ -1,288 +0,0 @@
-/*
- * Copyright 2019-2023 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
- */
-
-import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
-import com.google.gson.Gson
-import com.google.gson.GsonBuilder
-import org.gradle.api.GradleException
-import org.gradle.api.Project
-import org.gradle.api.Task
-import org.gradle.api.artifacts.Configuration
-import org.gradle.api.execution.TaskExecutionGraph
-import org.gradle.api.publish.tasks.GenerateModuleMetadata
-import org.gradle.api.tasks.bundling.Jar
-import org.gradle.kotlin.dsl.DependencyHandlerScope
-import org.gradle.kotlin.dsl.create
-import org.gradle.kotlin.dsl.get
-import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
-import org.jetbrains.kotlin.gradle.plugin.KotlinTarget
-
-/**
- * @see RelocationNotes
- */
-fun Project.configureMppShadow() {
-    val kotlin = kotlinMpp ?: return
-
-    configure(kotlin.targets.filter {
-        it.platformType == org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType.jvm
-                && (it.attributes.getAttribute(MIRAI_PLATFORM_INTERMEDIATE) != true)
-    }) {
-        configureRelocationForMppTarget(project)
-
-        registerRegularShadowTask(this, mapTaskNameForMultipleTargets = true)
-    }
-}
-
-/**
- * 配置 `publish` 和 `shadow` 相关依赖. 对于在本次构建的请求的任务及其直接或间接依赖, 以以下顺序执行:
- *
- * 1. 执行全部 `jar` 任务
- * 2. 执行全部 `relocate` 任务
- * 3. 执行全部 `publish` 任务
- *
- * 这是必要的因为 relocate 任务会覆盖 jar 任务的输出, 而在多模块并行编译时, Kotlin 编译器会依赖 jar 任务的输出. 如果在编译同时修改 JAR 文件, 就会导致 `ZipException`.
- *
- * 这也会让 publish 集中执行, Maven Central 不容易出问题.
- */
-fun Project.configureShadowDependenciesForPublishing() {
-    check(this.rootProject === this) {
-        "configureShadowDependenciesForPublishing can only be used on root project."
-    }
-
-    gradle.projectsEvaluated {
-        // Tasks requested to run in this build
-        val allTasks = rootProject.allprojects.asSequence().flatMap { it.tasks }
-
-        val publishTasks = allTasks.filter { it.name.contains("publish", ignoreCase = true) }
-        val relocateTasks = allTasks.filter { it.name.contains("relocate", ignoreCase = true) }
-        val jarTasks = allTasks.filter { it.name.contains("jar", ignoreCase = true) }
-        val compileKotlinTasks = allTasks.filter { it.name.contains("compileKotlin", ignoreCase = true) }
-        val compileTestKotlinTasks = allTasks.filter { it.name.contains("compileTestKotlin", ignoreCase = true) }
-
-        relocateTasks.dependsOn(compileKotlinTasks.toList())
-        relocateTasks.dependsOn(compileTestKotlinTasks.toList())
-        relocateTasks.dependsOn(jarTasks.toList())
-        publishTasks.dependsOn(relocateTasks.toList())
-    }
-}
-
-val TaskExecutionGraph.hierarchicalTasks: Sequence<Task>
-    get() = sequence {
-        suspend fun SequenceScope<Task>.addTask(task: Task) {
-            yield(task)
-            for (dependency in getDependencies(task)) {
-                addTask(dependency)
-            }
-        }
-
-        for (task in allTasks) {
-            addTask(task)
-        }
-    }
-
-/**
- * Relocate some dependencies for `.jar`
- * @see RelocationNotes
- */
-private fun KotlinTarget.configureRelocationForMppTarget(project: Project) = project.run {
-    val configuration = project.configurations.findByName(SHADOW_RELOCATION_CONFIGURATION_NAME)
-
-    // e.g. relocateJvmDependencies
-    // do not change task name. see `configureShadowDependenciesForPublishing`
-    val relocateDependencies = tasks.create("relocate${targetName.titlecase()}Dependencies", ShadowJar::class) {
-        group = "mirai"
-        description = "Relocate dependencies to internal package"
-        destinationDirectory.set(buildDir.resolve("libs")) // build/libs
-        archiveBaseName.set("${project.name}-${targetName.toLowerCase()}") // e.g. "mirai-core-api-jvm"
-
-        dependsOn(compilations["main"].compileTaskProvider) // e.g. compileKotlinJvm
-
-        from(compilations["main"].output) // Add compilation result of mirai sourcecode, not including dependencies
-        configuration?.let {
-            from(it) // Include runtime dependencies
-        }
-
-        // Relocate packages
-        afterEvaluate {
-            val relocationFilters = project.relocationFilters
-            relocationFilters.forEach { relocation ->
-                relocation.packages.forEach { aPackage ->
-                    relocate(aPackage, "$RELOCATION_ROOT_PACKAGE.$aPackage")
-                }
-            }
-        }
-    }
-
-    // We will modify Kotlin metadata, so do generate metadata before relocation
-    val generateMetadataTask =
-        tasks.getByName("generateMetadataFileFor${targetName.capitalize()}Publication") as GenerateModuleMetadata
-
-    val patchMetadataTask = tasks.create("patchMetadataFileFor${targetName.capitalize()}RelocatedPublication") {
-        dependsOn(generateMetadataTask)
-        dependsOn(relocateDependencies)
-
-        // remove dependencies in Kotlin module metadata
-        doLast {
-            // mirai-core-jvm-2.13.0.module
-            val file = generateMetadataTask.outputFile.asFile.get()
-            val metadata = Gson().fromJson(
-                file.readText(),
-                com.google.gson.JsonElement::class.java
-            ).asJsonObject
-
-            val metadataVersion = metadata["formatVersion"]?.asString
-            check(metadataVersion == "1.1") {
-                "Unsupported Kotlin metadata version. version=$metadataVersion, file=${file.absolutePath}"
-            }
-            for (variant in metadata["variants"]!!.asJsonArray) {
-                val dependencies = variant.asJsonObject["dependencies"]!!.asJsonArray
-                dependencies.removeAll { dependency ->
-                    val dep = dependency.asJsonObject
-
-                    val groupId = dep["group"]!!.asString
-                    val artifactId = dep["module"]!!.asString
-                    relocationFilters.any { filter ->
-                        filter.matchesDependency(
-                            groupId = groupId,
-                            artifactId = artifactId
-                        )
-                    }.also {
-                        println("[Shadow Relocation] Filtering out $groupId:$artifactId from Kotlin module")
-                    }
-                }
-            }
-
-
-            file.writeText(GsonBuilder().setPrettyPrinting().create().toJson(metadata))
-        }
-    }
-
-    // Set "publishKotlinMultiplatformPublicationTo*" and "publish${targetName.capitalize()}PublicationTo*" dependsOn patchMetadataTask
-    if (project.kotlinMpp != null) {
-        tasks.filter { it.name.startsWith("publishKotlinMultiplatformPublicationTo") }.let { publishTasks ->
-            if (publishTasks.isEmpty()) {
-                throw GradleException("[Shadow Relocation] Cannot find publishKotlinMultiplatformPublicationTo for project '${project.path}'.")
-            }
-            publishTasks.forEach { it.dependsOn(patchMetadataTask) }
-        }
-
-        tasks.filter { it.name.startsWith("publish${targetName.capitalize()}PublicationTo") }.let { publishTasks ->
-            if (publishTasks.isEmpty()) {
-                throw GradleException("[Shadow Relocation] Cannot find publish${targetName.capitalize()}PublicationTo for project '${project.path}'.")
-            }
-            publishTasks.forEach { it.dependsOn(patchMetadataTask) }
-        }
-    }
-
-    afterEvaluate {
-        // Remove relocated dependencies in Maven pom
-        mavenPublication {
-            pom.withXml {
-                val node = this.asNode().getSingleChild("dependencies")
-                val dependencies = node.childrenNodes()
-                logger.trace("[Shadow Relocation] deps: $dependencies")
-                dependencies.forEach { dep ->
-                    val groupId = dep.getSingleChild("groupId").value().toString()
-                    val artifactId = dep.getSingleChild("artifactId").value().toString()
-                    logger.trace("[Shadow Relocation] Checking $groupId:$artifactId")
-
-                    if (
-                        relocationFilters.any { filter ->
-                            filter.matchesDependency(groupId = groupId, artifactId = artifactId)
-                        }
-                    ) {
-                        logger.info("[Shadow Relocation] Filtering out '$groupId:$artifactId' from pom for project '${project.path}'")
-                        check(node.remove(dep)) { "Failed to remove dependency node" }
-                    }
-                }
-            }
-        }
-    }
-}
-
-private fun Sequence<Task>.dependsOn(
-    task: Task,
-) {
-    return forEach { it.dependsOn(task) }
-}
-
-private fun Sequence<Task>.dependsOn(
-    tasks: Iterable<Task>,
-) {
-    return forEach { it.dependsOn(tasks) }
-}
-
-/**
- * 添加 `implementation` 和 `shadow`
- */
-fun DependencyHandlerScope.shadowImplementation(dependencyNotation: Any) {
-    "implementation"(dependencyNotation)
-    "shadow"(dependencyNotation)
-}
-
-fun Project.registerRegularShadowTaskForJvmProject(
-    configurations: List<Configuration> = listOfNotNull(
-        project.configurations.findByName("runtimeClasspath"),
-        project.configurations.findByName("${kotlinJvm!!.target.name}RuntimeClasspath"),
-        project.configurations.findByName("runtime")
-    )
-): ShadowJar {
-    return project.registerRegularShadowTask(kotlinJvm!!.target, mapTaskNameForMultipleTargets = false, configurations)
-}
-
-fun Project.registerRegularShadowTask(
-    target: KotlinTarget,
-    mapTaskNameForMultipleTargets: Boolean,
-    configurations: List<Configuration> = listOfNotNull(
-        project.configurations.findByName("runtimeClasspath"),
-        project.configurations.findByName("${target.targetName}RuntimeClasspath"),
-        project.configurations.findByName("runtime")
-    ),
-): ShadowJar {
-    return tasks.create(
-        if (mapTaskNameForMultipleTargets) "shadow${target.targetName.capitalize()}Jar" else "shadowJar",
-        ShadowJar::class
-    ) {
-        group = "mirai"
-        archiveClassifier.set("all")
-
-        (tasks.findByName("jar") as? Jar)?.let {
-            manifest.inheritFrom(it.manifest)
-        }
-
-        val compilation = target.compilations["main"]
-        dependsOn(compilation.compileTaskProvider)
-        from(compilation.output)
-
-//        components.findByName("java")?.let { from(it) }
-        project.sourceSets.findByName("main")?.output?.let { from(it) } // for JVM projects
-        this.configurations = configurations
-
-        // Relocate packages
-        afterEvaluate {
-            val relocationFilters = project.relocationFilters
-            relocationFilters.forEach { relocation ->
-                relocation.packages.forEach { aPackage ->
-                    relocate(aPackage, "$RELOCATION_ROOT_PACKAGE.$aPackage")
-                }
-            }
-        }
-
-        exclude { file ->
-            file.name.endsWith(".sf", ignoreCase = true)
-        }
-        exclude("META-INF/INDEX.LIST", "META-INF/*.SF", "META-INF/*.DSA", "META-INF/*.RSA", "module-info.class")
-    }
-}
-
-fun Project.configureRelocatedShadowJarForJvmProject(kotlin: KotlinJvmProjectExtension): ShadowJar {
-    return registerRegularShadowTask(kotlin.target, mapTaskNameForMultipleTargets = false)
-}
-
-const val RELOCATION_ROOT_PACKAGE = "net.mamoe.mirai.internal.deps"

buildSrc/src/main/kotlin/Stdlib.kt

@@ -0,0 +1,10 @@
+/*
+ * Copyright 2019-2023 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
+ */
+
+fun String.capitalize(): String = this.replaceFirstChar { it.uppercaseChar() }

buildSrc/src/main/kotlin/Versions.kt

@@ -33,6 +33,8 @@ object Versions {
 
     const val kotlinCompiler = "1.8.10"
     const val kotlinStdlib = kotlinCompiler
+    const val kotlinLanguageVersionForTests = "1.9" // be curious!
+
     const val dokka = "1.8.10"
 
     const val kotlinCompilerForIdeaPlugin = "1.8.20-RC" // 231 bundles 1.8.20
@@ -54,8 +56,9 @@ object Versions {
     const val dynamicDelegation = "0.4.0-180.1"
     const val mavenCentralPublish = "1.0.0"
 
-    const val androidGradlePlugin = "4.1.1"
+    const val androidGradlePlugin = "7.3.1"
     const val android = "4.1.1.4"
+    const val androidxAnnotation = "1.6.0"
 
     const val shadow = "8.1.0"
 
@@ -118,6 +121,13 @@ class RelocatedDependency(
      * Kotlin packages. e.g. `io.ktor`
      */
     vararg val packages: String,
+    /**
+     * Exclude them, so no transitive dependencies exposed to Maven and Kotlin JVM consumers
+     */
+    val notationsToExcludeInPom: RelocatableDependency = MultiplatformDependency.jvm(
+        notation.substringBefore(":"),
+        notation.substringAfter(":").substringBeforeLast(":")
+    ),
     /**
      * Additional exclusions apart from everything from `org.jetbrains.kotlin` and `org.jetbrains.kotlinx`.
      */
@@ -140,14 +150,49 @@ fun KotlinDependencyHandler.implementationKotlinxIo(module: String) {
     }
 }
 
+
+class DependencyNotation(
+    val groupId: String,
+    val artifactId: String,
+) {
+    fun toMap(): Map<String, String> {
+        return mapOf("group" to groupId, "module" to artifactId)
+    }
+
+    override fun toString(): String {
+        return "$groupId:$artifactId"
+    }
+}
+
+sealed interface RelocatableDependency {
+    fun notations(): Sequence<DependencyNotation>
+}
+
+class SinglePlatformDependency(
+    val groupId: String,
+    val artifactId: String
+) : RelocatableDependency {
+    override fun notations(): Sequence<DependencyNotation> {
+        return sequenceOf(DependencyNotation(groupId, artifactId))
+    }
+}
+
+class CompositeDependency(
+    private val dependencies: List<RelocatableDependency>
+) : RelocatableDependency {
+    constructor(vararg dependencies: RelocatableDependency) : this(dependencies.toList())
+
+    override fun notations(): Sequence<DependencyNotation> = dependencies.asSequence().flatMap { it.notations() }
+}
+
 class MultiplatformDependency private constructor(
     private val groupId: String,
     private val baseArtifactId: String,
     vararg val targets: String,
-) {
-    fun notations(): Sequence<Map<String, String>> {
-        return sequenceOf(mapOf("group" to groupId, "module" to baseArtifactId))
-            .plus(targets.asSequence().map { mapOf("group" to groupId, "module" to "$baseArtifactId.$it") })
+) : RelocatableDependency {
+    override fun notations(): Sequence<DependencyNotation> {
+        return sequenceOf(DependencyNotation(groupId, baseArtifactId))
+            .plus(targets.asSequence().map { DependencyNotation(groupId, "$baseArtifactId-$it") })
     }
 
     companion object {
@@ -159,7 +204,7 @@ class MultiplatformDependency private constructor(
 
 fun ModuleDependency.exclude(multiplatformDependency: MultiplatformDependency) {
     multiplatformDependency.notations().forEach {
-        exclude(it)
+        exclude(it.toMap())
     }
 }
 
@@ -170,6 +215,7 @@ object ExcludeProperties {
     val `kotlinx-coroutines` = multiplatformJvm(groupId = "org.jetbrains.kotlinx", "kotlinx-coroutines")
     val `ktor-io` = multiplatformJvm(groupId = "io.ktor", "ktor-io")
     val `everything from slf4j` = exclude(groupId = "org.slf4j", null)
+    val `slf4j-api` = exclude(groupId = "org.slf4j", "slf4j-api")
 
     /**
      * @see org.gradle.kotlin.dsl.exclude
@@ -188,8 +234,12 @@ object ExcludeProperties {
 }
 
 val `ktor-io` = ktor("io", Versions.ktor)
-val `ktor-io_relocated` = RelocatedDependency(`ktor-io`, "io.ktor.utils.io") {
+val `ktor-io_relocated` = RelocatedDependency(
+    `ktor-io`, "io.ktor.utils.io",
+    notationsToExcludeInPom = MultiplatformDependency.jvm("io.ktor", "ktor-io")
+) {
     exclude(ExcludeProperties.`everything from slf4j`)
+    exclude(ExcludeProperties.`slf4j-api`)
 }
 
 val `ktor-http` = ktor("http", Versions.ktor)
@@ -198,7 +248,16 @@ val `ktor-serialization` = ktor("serialization", Versions.ktor)
 val `ktor-websocket-serialization` = ktor("websocket-serialization", Versions.ktor)
 
 val `ktor-client-core` = ktor("client-core", Versions.ktor)
-val `ktor-client-core_relocated` = RelocatedDependency(`ktor-client-core`, "io.ktor") {
+val `ktor-client-core_relocated` = RelocatedDependency(
+    `ktor-client-core`, "io.ktor",
+    notationsToExcludeInPom = CompositeDependency(
+        MultiplatformDependency.jvm("io.ktor", "ktor-io"),
+        MultiplatformDependency.jvm("io.ktor", "ktor-client-core"),
+        MultiplatformDependency.jvm("io.ktor", "ktor-client-okhttp"),
+        MultiplatformDependency.jvm("io.ktor", "ktor-http"),
+        MultiplatformDependency.jvm("io.ktor", "ktor-utils"),
+    )
+) {
     exclude(ExcludeProperties.`ktor-io`)
     exclude(ExcludeProperties.`everything from slf4j`)
 }
@@ -209,7 +268,21 @@ val `ktor-client-curl` = ktor("client-curl", Versions.ktor)
 val `ktor-client-darwin` = ktor("client-darwin", Versions.ktor)
 val `ktor-client-okhttp` = ktor("client-okhttp", Versions.ktor)
 val `ktor-client-okhttp_relocated` =
-    RelocatedDependency(ktor("client-okhttp", Versions.ktor), "io.ktor", "okhttp", "okio") {
+    RelocatedDependency(
+        ktor("client-okhttp", Versions.ktor), "io.ktor", "okhttp", "okio",
+        notationsToExcludeInPom = CompositeDependency(
+            MultiplatformDependency.jvm("io.ktor", "ktor-io"),
+            MultiplatformDependency.jvm("io.ktor", "ktor-client-core"),
+            MultiplatformDependency.jvm("io.ktor", "ktor-client-okhttp"),
+            MultiplatformDependency.jvm("io.ktor", "ktor-http"),
+            MultiplatformDependency.jvm("io.ktor", "ktor-serialization"),
+            MultiplatformDependency.jvm("io.ktor", "ktor-utils"),
+            MultiplatformDependency.jvm("io.ktor", "ktor-websockets"),
+            MultiplatformDependency.jvm("io.ktor", "ktor-websockets-serialization"),
+            MultiplatformDependency.jvm("com.squareup.okhttp3", "okhttp3"),
+            MultiplatformDependency.jvm("com.squareup.okio", "okio"),
+        )
+    ) {
         exclude(ExcludeProperties.`ktor-io`)
         exclude(ExcludeProperties.`everything from slf4j`)
     }
@@ -262,6 +335,7 @@ const val `jetbrains-annotations` = "org.jetbrains:annotations:19.0.0"
 
 const val `caller-finder` = "io.github.karlatemp:caller:1.1.1"
 
+const val `androidx-annotation` = "androidx.annotation:annotation:${Versions.androidxAnnotation}"
 const val `android-runtime` = "com.google.android:android:${Versions.android}"
 const val `netty-all` = "io.netty:netty-all:${Versions.netty}"
 const val `netty-handler` = "io.netty:netty-handler:${Versions.netty}"

buildSrc/src/main/kotlin/explicit-api.gradle.kts

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2019-2023 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
+ */
+
+import org.jetbrains.kotlin.gradle.dsl.KotlinCompile
+
+/*
+ * Copyright 2019-2023 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
+ */
+
+private val EXPLICIT_API = "-Xexplicit-api=strict"
+
+// Workaround for explicit API in androidMain
+// https://youtrack.jetbrains.com/issue/KT-37652/Support-explicit-mode-for-Android-projects
+// https://youtrack.jetbrains.com/issue/KT-37652/Support-explicit-mode-for-Android-projects#focus=Comments-27-4501224.0-0
+
+project.tasks
+    .matching { it is KotlinCompile<*> && !it.name.contains("test", ignoreCase = true) }
+    .configureEach {
+        if (!project.hasProperty("kotlin.optOutExplicitApi")) {
+            val kotlinCompile = this as KotlinCompile<*>
+            if (EXPLICIT_API !in kotlinCompile.kotlinOptions.freeCompilerArgs) {
+                kotlinCompile.kotlinOptions.freeCompilerArgs += EXPLICIT_API
+            }
+        }
+    }

buildSrc/src/main/kotlin/shadow/Relocation.kt

@@ -7,6 +7,11 @@
  * https://github.com/mamoe/mirai/blob/dev/LICENSE
  */
 
+package shadow
+
+import ExcludeProperties
+import RelocatableDependency
+import RelocatedDependency
 import org.gradle.api.Action
 import org.gradle.api.DomainObjectCollection
 import org.gradle.api.Project
@@ -66,7 +71,7 @@ import org.jetbrains.kotlin.gradle.plugin.KotlinDependencyHandler
  *
  * 如果你都使用 [relocateImplementation], 就会导致在 Android 平台发生 'Duplicated Class' 问题. 如果你都使用 [relocateCompileOnly] 则会在 clinit 阶段遇到 [NoClassDefFoundError]
  *
- * ## relocation 发生的时机晚于编译
+ * ## relocation 发生的时机晚于编译 (Jar)
  *
  * mirai-core-utils relocate 了 ktor-io, 然后 mirai-core 在 `build.gradle.kts` 使用了 `implementation(project(":mirai-core-utils"))`.
  * 在 mirai-core 编译时, 编译器仍然会使用 relocate 之前的 `io.ktor`. 为了在 mirai-core 将对 `io.ktor` 的调用转为对 `net.mamoe.mirai.internal.deps.io.ktor` 的调用, 需要配置 relocation.
@@ -74,6 +79,13 @@ import org.jetbrains.kotlin.gradle.plugin.KotlinDependencyHandler
  *
  * 所以你需要为所有依赖了 mirai-core-utils 的模块都分别配置 [relocateCompileOnly].
  *
+ * ## relocation 仅在发布 (e.g. `publishToMavenLocal`) 时自动使用
+ *
+ * 其他任何时候, 比如在 mirai-console 编译时, mirai-console 依赖的是未 relocate 的 JAR. 使用 `jar` 任务打包的也是未 relocate 的.
+ *
+ * 若需要 relocated 的 JAR, 使用 `relocateJvmDependencies`. 其中 `Jvm` 可换为其他启动了 relocate 的 Kotlin target 名.
+ * 可在 IDEA Gradle 视图中找到 mirai 文件夹, 查看可用的 task 列表.
+ *
  * ### "在运行时包含" 是如何实现的?
  *
  * 被 relocate 的类会被直接当做是当前模块的类打包进 JAR.
@@ -89,7 +101,7 @@ object RelocationNotes
 /**
  * 添加一个通常的 [compileOnly][KotlinDependencyHandler.compileOnly] 依赖, 并按 [relocatedDependency] 定义的配置 relocate.
  *
- * 在发布版本时, 全部对 [RelocatedDependency.packages] 中的 API 的调用**都不会**被 relocate 到 [RELOCATION_ROOT_PACKAGE].
+ * 在发布版本时, 全部对 [RelocatedDependency.packages] 中的 API 的调用**都不会**被 relocate 到 [RelocationConfig.RELOCATION_ROOT_PACKAGE].
  * 运行时 (runtime) **不会**包含被 relocate 的依赖及其所有间接依赖.
  *
  * @see RelocationNotes
@@ -98,10 +110,13 @@ fun KotlinDependencyHandler.relocateCompileOnly(
     relocatedDependency: RelocatedDependency,
 ): ExternalModuleDependency {
     val dependency = compileOnly(relocatedDependency.notation) {
+        relocatedDependency.exclusionAction(this)
     }
     project.relocationFilters.add(
         RelocationFilter(
-            dependency.groupNotNull, dependency.name, relocatedDependency.packages.toList(), includeInRuntime = false,
+            relocatedDependency.notationsToExcludeInPom,
+            relocatedDependency.packages.toList(),
+            includeInRuntime = false,
         )
     )
     // Don't add to runtime
@@ -111,7 +126,7 @@ fun KotlinDependencyHandler.relocateCompileOnly(
 /**
  * 添加一个通常的 [compileOnly][KotlinDependencyHandler.compileOnly] 依赖, 并按 [relocatedDependency] 定义的配置 relocate.
  *
- * 在发布版本时, 全部对 [RelocatedDependency.packages] 中的 API 的调用**都不会**被 relocate 到 [RELOCATION_ROOT_PACKAGE].
+ * 在发布版本时, 全部对 [RelocatedDependency.packages] 中的 API 的调用**都不会**被 relocate 到 [RelocationConfig.RELOCATION_ROOT_PACKAGE].
  * 运行时 (runtime) **不会**包含被 relocate 的依赖及其所有间接依赖.
  *
  * @see RelocationNotes
@@ -122,10 +137,13 @@ fun DependencyHandler.relocateCompileOnly(
 ): Dependency {
     val dependency =
         addDependencyTo(this, "compileOnly", relocatedDependency.notation, Action<ExternalModuleDependency> {
+            relocatedDependency.exclusionAction(this)
         })
     project.relocationFilters.add(
         RelocationFilter(
-            dependency.groupNotNull, dependency.name, relocatedDependency.packages.toList(), includeInRuntime = false,
+            relocatedDependency.notationsToExcludeInPom,
+            relocatedDependency.packages.toList(),
+            includeInRuntime = false,
         )
     )
     // Don't add to runtime
@@ -135,7 +153,7 @@ fun DependencyHandler.relocateCompileOnly(
 /**
  * 添加一个通常的 [implementation][KotlinDependencyHandler.implementation] 依赖, 并按 [relocatedDependency] 定义的配置 relocate.
  *
- * 在发布版本时, 全部对 [RelocatedDependency.packages] 中的 API 的调用**都会**被 relocate 到 [RELOCATION_ROOT_PACKAGE].
+ * 在发布版本时, 全部对 [RelocatedDependency.packages] 中的 API 的调用**都会**被 relocate 到 [RelocationConfig.RELOCATION_ROOT_PACKAGE].
  * 运行时 (runtime) 将**会**包含被 relocate 的依赖及其所有间接依赖.
  *
  * @see RelocationNotes
@@ -145,17 +163,18 @@ fun KotlinDependencyHandler.relocateImplementation(
     action: ExternalModuleDependency.() -> Unit = {}
 ): ExternalModuleDependency {
     val dependency = implementation(relocatedDependency.notation) {
-
+        relocatedDependency.exclusionAction(this)
     }
     project.relocationFilters.add(
         RelocationFilter(
-            dependency.groupNotNull, dependency.name, relocatedDependency.packages.toList(), includeInRuntime = true,
+            relocatedDependency.notationsToExcludeInPom, relocatedDependency.packages.toList(), includeInRuntime = true,
         )
     )
-    project.configurations.maybeCreate(SHADOW_RELOCATION_CONFIGURATION_NAME)
+    val configurationName = RelocationConfig.SHADOW_RELOCATION_CONFIGURATION_NAME
+    project.configurations.maybeCreate(configurationName)
     addDependencyTo(
         project.dependencies,
-        SHADOW_RELOCATION_CONFIGURATION_NAME,
+        configurationName,
         relocatedDependency.notation,
         Action<ExternalModuleDependency> {
             relocatedDependency.exclusionAction(this)
@@ -169,7 +188,7 @@ fun KotlinDependencyHandler.relocateImplementation(
 /**
  * 添加一个通常的 [implementation][KotlinDependencyHandler.implementation] 依赖, 并按 [relocatedDependency] 定义的配置 relocate.
  *
- * 在发布版本时, 全部对 [RelocatedDependency.packages] 中的 API 的调用都会被 relocate 到 [RELOCATION_ROOT_PACKAGE].
+ * 在发布版本时, 全部对 [RelocatedDependency.packages] 中的 API 的调用都会被 relocate 到 [RelocationConfig.RELOCATION_ROOT_PACKAGE].
  * 运行时 (runtime) 将会包含被 relocate 的依赖及其所有间接依赖.
  *
  * @see RelocationNotes
@@ -181,16 +200,18 @@ fun DependencyHandler.relocateImplementation(
 ): ExternalModuleDependency {
     val dependency =
         addDependencyTo(this, "implementation", relocatedDependency.notation, Action<ExternalModuleDependency> {
+            relocatedDependency.exclusionAction(this)
         })
     project.relocationFilters.add(
         RelocationFilter(
-            dependency.groupNotNull, dependency.name, relocatedDependency.packages.toList(), includeInRuntime = true,
+            relocatedDependency.notationsToExcludeInPom, relocatedDependency.packages.toList(), includeInRuntime = true,
         )
     )
-    project.configurations.maybeCreate(SHADOW_RELOCATION_CONFIGURATION_NAME)
+    val configurationName = RelocationConfig.SHADOW_RELOCATION_CONFIGURATION_NAME
+    project.configurations.maybeCreate(configurationName)
     addDependencyTo(
         project.dependencies,
-        SHADOW_RELOCATION_CONFIGURATION_NAME,
+        configurationName,
         relocatedDependency.notation,
         Action<ExternalModuleDependency> {
             relocatedDependency.exclusionAction(this)
@@ -201,8 +222,7 @@ fun DependencyHandler.relocateImplementation(
     return dependency
 }
 
-@Suppress("UNNECESSARY_NOT_NULL_ASSERTION") // compiler bug
-private val ExternalModuleDependency.groupNotNull get() = group!!
+private val ExternalModuleDependency.groupNotNull: String get() = group.toString()
 
 private fun ExternalModuleDependency.intrinsicExclusions() {
     exclude(ExcludeProperties.`everything from kotlin`)
@@ -210,14 +230,10 @@ private fun ExternalModuleDependency.intrinsicExclusions() {
 }
 
 
-const val SHADOW_RELOCATION_CONFIGURATION_NAME = "shadowRelocation"
-
-
 data class RelocationFilter(
-    val groupId: String,
-    val artifactId: String? = null,
-    val packages: List<String> = listOf(groupId),
-    val filesFilter: String = groupId.replace(".", "/"),
+    val notations: RelocatableDependency,
+    val packages: List<String>,
+//    val filesFilter: String = groupId.replace(".", "/"),
     /**
      * Pack relocated dependency into the fat jar. If set to `false`, dependencies will be removed.
      * This is to avoid duplicated classes. See #2291.
@@ -226,10 +242,9 @@ data class RelocationFilter(
 ) {
 
     fun matchesDependency(groupId: String?, artifactId: String?): Boolean {
-        if (this.groupId == groupId) return true
-        if (this.artifactId != null && this.artifactId == artifactId) return true
-
-        return false
+        return notations.notations().any {
+            it.groupId == groupId && it.artifactId == artifactId
+        }
     }
 }
 

buildSrc/src/main/kotlin/shadow/RelocationConfig.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2019-2023 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 shadow
+
+import titlecase
+
+object RelocationConfig {
+    const val RELOCATION_ROOT_PACKAGE = "net.mamoe.mirai.internal.deps"
+
+    const val SHADOW_RELOCATION_CONFIGURATION_NAME = "shadowRelocation"
+
+    fun taskNameForRelocateDependencies(
+        targetName: String
+    ) = "relocate${targetName.titlecase()}Dependencies"
+
+    fun relocatedPublicationName(originalPublicationName: String): String = originalPublicationName + "Relocated"
+}

buildSrc/src/main/kotlin/shadow/Shadow.kt

@@ -0,0 +1,145 @@
+/*
+ * Copyright 2019-2023 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 shadow
+
+import MIRAI_PLATFORM_INTERMEDIATE
+import capitalize
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+import kotlinJvm
+import kotlinMpp
+import org.gradle.api.Project
+import org.gradle.api.artifacts.Configuration
+import org.gradle.api.tasks.bundling.Jar
+import org.gradle.kotlin.dsl.DependencyHandlerScope
+import org.gradle.kotlin.dsl.create
+import org.gradle.kotlin.dsl.get
+import org.jetbrains.kotlin.gradle.dsl.KotlinJvmProjectExtension
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
+import org.jetbrains.kotlin.gradle.plugin.KotlinTarget
+import sourceSets
+
+/**
+ * @see RelocationNotes
+ */
+fun Project.configureMppShadow() {
+    val kotlin = kotlinMpp ?: return
+
+    configure(kotlin.targets.filter {
+        it.platformType == KotlinPlatformType.jvm
+                && (it.attributes.getAttribute(MIRAI_PLATFORM_INTERMEDIATE) != true)
+    }) {
+        configureRelocationForMppTarget(project)
+
+        registerRegularShadowTask(this, mapTaskNameForMultipleTargets = true)
+    }
+}
+
+/**
+ * Relocate some dependencies for `.jar`
+ * @see RelocationNotes
+ */
+private fun KotlinTarget.configureRelocationForMppTarget(project: Project) = project.run {
+    val configuration = project.configurations.findByName(RelocationConfig.SHADOW_RELOCATION_CONFIGURATION_NAME)
+
+    // e.g. relocateJvmDependencies
+    // do not change task name. see `configureShadowDependenciesForPublishing`
+    val relocateDependenciesName = RelocationConfig.taskNameForRelocateDependencies(targetName)
+    tasks.create(relocateDependenciesName, ShadowJar::class) {
+        group = "mirai"
+        description = "Relocate dependencies to internal package"
+        destinationDirectory.set(buildDir.resolve("libs")) // build/libs
+        archiveBaseName.set("${project.name}-${targetName.lowercase()}-relocated") // e.g. "mirai-core-api-jvm"
+
+        dependsOn(compilations["main"].compileTaskProvider) // e.g. compileKotlinJvm
+
+        from(compilations["main"].output) // Add the compilation result of mirai sourcecode, not including dependencies
+        configuration?.let {
+            from(it) // Include runtime dependencies
+        }
+
+        // Relocate packages
+        afterEvaluate {
+            val relocationFilters = project.relocationFilters
+            relocationFilters.forEach { relocation ->
+                relocation.packages.forEach { aPackage ->
+                    relocate(aPackage, "${RelocationConfig.RELOCATION_ROOT_PACKAGE}.$aPackage")
+                }
+            }
+        }
+    }
+}
+
+/**
+ * 添加 `implementation` 和 `shadow`
+ */
+fun DependencyHandlerScope.shadowImplementation(dependencyNotation: Any) {
+    "implementation"(dependencyNotation)
+    "shadow"(dependencyNotation)
+}
+
+fun Project.registerRegularShadowTaskForJvmProject(
+    configurations: List<Configuration> = listOfNotNull(
+        project.configurations.findByName("runtimeClasspath"),
+        project.configurations.findByName("${kotlinJvm!!.target.name}RuntimeClasspath"),
+        project.configurations.findByName("runtime")
+    )
+): ShadowJar {
+    return project.registerRegularShadowTask(kotlinJvm!!.target, mapTaskNameForMultipleTargets = false, configurations)
+}
+
+fun Project.registerRegularShadowTask(
+    target: KotlinTarget,
+    mapTaskNameForMultipleTargets: Boolean,
+    configurations: List<Configuration> = listOfNotNull(
+        project.configurations.findByName("runtimeClasspath"),
+        project.configurations.findByName("${target.targetName}RuntimeClasspath"),
+        project.configurations.findByName("runtime")
+    ),
+): ShadowJar {
+    return tasks.create(
+        if (mapTaskNameForMultipleTargets) "shadow${target.targetName.capitalize()}Jar" else "shadowJar",
+        ShadowJar::class
+    ) {
+        group = "mirai"
+        archiveClassifier.set("all")
+
+        (tasks.findByName("jar") as? Jar)?.let {
+            manifest.inheritFrom(it.manifest)
+        }
+
+        val compilation = target.compilations["main"]
+        dependsOn(compilation.compileTaskProvider)
+        from(compilation.output)
+
+//        components.findByName("java")?.let { from(it) }
+        project.sourceSets.findByName("main")?.output?.let { from(it) } // for JVM projects
+        this.configurations = configurations
+
+        // Relocate packages
+        afterEvaluate {
+            val relocationFilters = project.relocationFilters
+            relocationFilters.forEach { relocation ->
+                relocation.packages.forEach { aPackage ->
+                    relocate(aPackage, "${RelocationConfig.RELOCATION_ROOT_PACKAGE}.$aPackage")
+                }
+            }
+        }
+
+        exclude { file ->
+            file.name.endsWith(".sf", ignoreCase = true)
+        }
+        exclude("META-INF/INDEX.LIST", "META-INF/*.SF", "META-INF/*.DSA", "META-INF/*.RSA", "module-info.class")
+    }
+}
+
+fun Project.configureRelocatedShadowJarForJvmProject(kotlin: KotlinJvmProjectExtension): ShadowJar {
+    return registerRegularShadowTask(kotlin.target, mapTaskNameForMultipleTargets = false)
+}
+

buildSrc/src/main/kotlin/utils.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -34,7 +34,7 @@ fun ByteArray.toUHexString(
     return buildString(length * 2) {
         this@toUHexString.forEachIndexed { index, it ->
             if (index in offset until lastIndex) {
-                var ret = it.toUByte().toString(16).toUpperCase()
+                var ret = it.toUByte().toString(16).uppercase()
                 if (ret.length == 1) ret = "0$ret"
                 append(ret)
                 if (index < lastIndex - 1) append(separator)

buildSrc/src/main/resources/binary-compatibility-validator-build.txt

@@ -15,8 +15,12 @@ plugins {
 description = "Binary compatibility validator for project $$PROJECT_PATH$$"
 
 tasks.withType(kotlinx.validation.KotlinApiBuildTask::class) {
+    val paths = """
+        $$BUILD_DIR$$
+        """
+        .lines().filter { it.isNotBlank() }.map { project("$$PROJECT_PATH$$").buildDir.resolve(it.trim()) }
     inputClassesDirs =
-        files(inputClassesDirs.files, project("$$PROJECT_PATH$$").buildDir.resolve("$$BUILD_DIR$$"))
+        files(inputClassesDirs.files, *paths.toTypedArray())
 }
 
 apiValidation {

ci-release-helper/build.gradle.kts

@@ -69,7 +69,7 @@ nexusStaging {
 dependencies {
     implementation(`ktor-client-okhttp`)
     implementation(`kotlinx-serialization-json`)
-    implementation("org.jetbrains.kotlinx", "kotlinx-datetime", "0.4.0")
+    implementation("org.jetbrains.kotlinx", "kotlinx-datetime-jvm", "0.4.0")
 }
 
 tasks.register("updateSnapshotVersion") {

docs/Preparations.md

@@ -5,7 +5,9 @@
 ## JVM 环境要求
 
 - 桌面 JVM：最低 Java 8，但推荐 Java 17（要使用一键启动器，需要 11 及以上）
-- Android：Android SDK 26+ （Android 8.0，Oreo)
+- Android：
+    - mirai 2.15.0 起: API 等级 21 （Android 5.0，LOLLIPOP)
+    - mirai 2.15.0 前: API 等级 26 （Android 8.0，O)
 
 目前主要使用的自动启动器，[Mirai Console Loader](https://github.com/iTXTech/mirai-console-loader)
 ，（MCL） 默认安装 JRE 17。
@@ -35,8 +37,8 @@
 或 [Android Studio](https://developer.android.com/studio)。Mirai 提供 IDE
 插件来提升开发体验。
 
-|          插件名           |                         描述                         |               一键安装                |         JetBrains 插件仓库          |
-|:------------------------:|:---------------------------------------------------:|:-----------------------------------:|:----------------------------------:|
+|           插件名            |                     描述                     |               一键安装                |          JetBrains 插件仓库          |
+|:------------------------:|:------------------------------------------:|:---------------------------------:|:--------------------------------:|
 | [Mirai Console IntelliJ] | 提供 mirai-core 的错误检查和 mirai-console 的插件开发辅助 | [一键安装][Mirai Console IntelliJ-OK] | [说明页][Mirai Console IntelliJ-JB] |
 
 <!--| [Kotlin Jvm Blocking Bridge] |         帮助 Java 用户调用 Kotlin suspend 函数         | [Kotlin Jvm Blocking Bridge-OK] | [Kotlin Jvm Blocking Bridge-JB] |-->

docs/contributing/Building.md

@@ -1,41 +0,0 @@
-# 构建
-
-本文介绍如何构建 mirai 的各模块。
-
-## 构建 JVM 目标项目
-
-要构建只有 JVM 目标的项目（如 `mirai-console`，只需在项目根目录使用如下命令执行
-Gradle 任务：
-
-```shell
-$ ./gradlew :mirai-console:assemble # 编译
-$ ./gradlew :mirai-console:check # 测试
-$ ./gradlew :mirai-console:build # 编译和测试
-```
-
-其中 `:mirai-console` 是目标项目的路径（path）。
-
-你也可以在 IDEA 等有 Gradle 支持的 IDE
-中在通过侧边栏等方式选择项目的 `assemble` 等任务：
-
-![](images/run-gradle-tasks-in-idea.png)
-
-### 获得 mirai-console JAR
-
-在项目根目录执行如下命令可以获得包含依赖的 mirai-console JAR。对于其他模块类似。
-
-```shell
-$ ./gradlew :mirai-console:shadowJar
-```
-
-## 构建多平台项目
-
-core 是多平台项目。请参考 [构建 Core](BuildingCore.md)。
-
-## 构建 IntelliJ 插件
-
-可通过如下命令构建 IntelliJ 平台 IDE 的插件。构建成功的插件将可以在 `mirai-console/tools/intellij-plugin/build/distribution` 中找到。
-
-```shell
-$ ./graldew :mirai-console-intellij:buidlPlugin
-```

docs/contributing/README.md

@@ -30,7 +30,7 @@
 
 [mirai-core-all]: ../../mirai-core-all
 
-[mirai-logging]: ../../logging/
+[mirai-logging]: ../../logging
 
 [mirai-logging-log4j2]: ../../logging/mirai-logging-log4j2
 
@@ -88,6 +88,10 @@ mirai 等。
 
 若在其他环境下无法正常编译, 请尝试选择上述一个环境配置。
 
+## 我不熟悉 Gradle 或 Kotlin / 我赶时间
+
+在 [SimpleInstructions](SimpleInstructions.md) 查看你可能想做的事情的简单命令。
+
 ## `mirai-core` 术语
 
 根据语境，mirai-core 有时候可能指 `mirai-core`
@@ -102,9 +106,9 @@ core'
 [HMPP]: https://kotlinlang.org/docs/multiplatform-discover-project.html
 
 core 三个模块都使用 Kotlin [HMPP] 功能，同时支持 JVM 和 Native
-两种平台。你可以在 [Kotlin 官方英文文档][HMPP] 了解 HMPP 模式。
+两种平台。你可以在 [Kotlin 官方文档][HMPP] 了解 HMPP 模式。
 
-core 的源集结构如图所示：
+core 的编译目标层级结构如图所示：
 
 ```
                      common
@@ -144,16 +148,16 @@ core 的源集结构如图所示：
 
 ### 关闭部分项目以提升速度
 
-你可以在项目根目录创建 `local.properties`，中按照如下配置，关闭部分项目来提升开发速度。
+你可以在项目根目录创建 `local.properties`，中按照如下配置，关闭部分项目来提升开发速度。在关闭后，请终止所有 Gradle 后台进程，以保证更改正确应用。
 
 ```properties
-# 关闭 IntelliJ IDEA 插件模块
+# 关闭 IntelliJ IDEA 插件模块，这可以避免下载 1~2GB 的依赖
 projects.mirai-console-intellij.enabled=false
 # 关闭 Gradle 插件模块
 projects.mirai-console-gradle.enabled=false
 # 关闭 mirai 依赖测试模块
 projects.mirai-deps-test.enabled=false
-# 用其他模块的路径替换 module-path，可关闭该模块
+# 也可以用其他模块的路径替换 module-path，可关闭该模块
 projects.module-path.enabled=false
 # 特殊配置，关闭 mirai-console 后端，这同时也会关闭全部 console 相关的项目
 projects.mirai-console.enabled=false
@@ -169,7 +173,7 @@ projects.mirai-logging.enabled=false
 
 所有目标默认都启用。
 
-**注意**，在关闭一个目标后，将无法编辑该目标的相关源集的源码。关闭 native 目标后也可能会影响 native 目标平台原生接口的数据类型。
+**注意**，在关闭一个目标后，将无法编辑该目标的相关源集的源码。关闭部分 native 目标后也可能会影响 native 目标平台原生接口的数据类型。
 因此若非主机性能太差或在 CI 机器运行，**不建议**关闭 native 目标。
 
 [//]: # (备注: 如果要发版, 必须开启全部目标, 否则会导致 metadata 中的平台不全)
@@ -183,25 +187,60 @@ projects.mirai-logging.enabled=false
 
 其中 xxx 表示构建目标名称。可用的目标名称有（区分大小写）：`jvm`、`android`、`macosX64`、`macosArm64`、`mingwX64`、`linuxX64`
 
-示例（前两条目前等价）：
+```
+# 禁用所有 native 目标，启用其他目标（启用 jvm 和 android）
+projects.mirai-core.targets=!native;others
 
-- `!native;others` 指定禁用所有 native 目标，启用其他目标
-- `jvm;android;!others` 指定启用 `jvm` 和 `android` 目标，禁用其他所有目标
-- `jvm;macosX64;!others` 指定启用 `jvm` 和 `macosX64` 目标，禁用其他所有目标
+# 启用 `jvm` 和 `android` 目标，禁用其他所有目标（禁用所有 native 目标）
+projects.mirai-core.targets=jvm;android;!others
 
+# 只启用 `jvm` 目标，禁用其他所有目标
+projects.mirai-core.targets=jvm;!others
+
+# 指定启用 `jvm` 和 `macosX64` 目标，禁用其他所有目标
+projects.mirai-core.targets=jvm;macosX64;!others
+```
 
 ### 直接启动 mirai-core 本地测试
 
-一般情况下, 只要 JVM 平台测试通过其他平台也能测试通过
+一般情况下, 只要 JVM 平台测试通过其他平台也能测试通过。
 
 在 JVM 平台直接启动 mirai-core, 见 [mirai-core/jvmTest](/mirai-core/src/jvmTest/README.md)
 
 在 native 平台直接启动 mirai-core, 见 [mirai-core/nativeTest](/mirai-core/src/nativeTest/kotlin/local/README.md)
 
+## 构建 mirai 项目 JAR 以及动态链接库
 
-## 构建
+查看 [Building](building/README.md)
 
-查看 [Building](Building.md)
+## 部署 mirai 到本地仓库
+
+[bignum]: https://github.com/ionspin/kotlin-multiplatform-bignum
+
+要部署 mirai 项目到本地 Maven 仓库（Maven Local），只需使用如下命令，其中 `2.99.0-local` 可为任意想在本地仓库发布的版本号。
+
+```shell
+./gradlew publishMiraiArtifactsToMavenLocal "-Dmirai.build.project.version=2.99.0-local"
+```
+
+注意，因为构建默认启用多线程，此操作可能会占用约 32GB 内存。如果主机条件不足，或希望减少内存占用，可以如下方式禁用多线程加速：
+
+```shell
+./gradlew publishMiraiArtifactsToMavenLocal "-Dmirai.build.project.version=2.99.0-local" "-Porg.gradle.parallel=false"
+```
+
+随后可通过 `implementation("net.mamoe:mirai-core:2.99.0-local")` 引入项目。
+
+由于 mirai 项目结构复杂，构建可能由于各种原因失败，mirai 提供依赖可用性测试。
+部署一份版本为 `2.99.0-deps-test` 的 mirai 到本地仓库，执行 `./gradlew :mirai-deps-test:test` 即可运行相关测试。若测试通过，则代表部署的项目可通过各种方式正常引入到其他项目。
+
+## 通过 Gradle Composite Build 引入 mirai
+
+若在 Gradle 通过 Composite Build 引入 mirai，则在编译时可能遇到依赖冲突问题。
+mirai 使用特定版本的 Ktor 2、[kt-bignum][bignum] 等库，会将它们的包名增加前缀 `net.mamoe.mirai.internal.deps.` 来避免产生冲突。
+但这个操作仅对部署的版本有效，在 Gradle 中构建时，仍然可能会有依赖冲突。但若在测试中没遇到问题，一般不用担心。
+
+要详细了解这个过程以及实现原理，请查看 [源码](../../buildSrc/src/main/kotlin/shadow/Relocation.kt)（含注释）。
 
 ## 寻找待解决的问题
 

docs/contributing/SimpleInstructions.md

@@ -0,0 +1,33 @@
+# 简单命令
+
+以下为你可能想做的事情的示例命令：
+
+1. clone 项目
+2. 在项目根目录创建 local.properties，并加入如下内容：
+   ```properties
+   projects.mirai-console-intellij.enabled=false
+   projects.mirai-deps-test.enabled=false
+   ```
+3. 执行以下命令：
+
+- 我只是 JDK/Java/Kotlin JVM 用户（或者我不知道这什么什么意思）：
+    - 编译并打包 mirai-core-all JAR，成品将存放在 `mirai-core-all/build/libs/`：
+      ```shell
+      ./gradlew :mirai-core-all:shadowJar "-Dprojects.mirai-core.targets=jvm;!others"
+      ```
+    - 编译并打包 mirai-console JAR，成品将存放在 `mirai-console/build/libs/`:
+      ```shell
+      ./gradlew :mirai-console:shadowJar "-Dprojects.mirai-core.targets=jvm;!others"
+      ```
+    - 将 mirai 发布到 mavenLocal 以便本地引入，发布后的版本为 `2.99.0-local`：
+      ```shell
+      ./gradlew publishMiraiArtifactsToMavenLocal "-Dprojects.mirai-core.targets=jvm;!others" "-Dmirai.build.project.version=2.99.0-local"
+      ```
+- 我是 Android 用户：
+    - 将 mirai 发布到 mavenLocal 以便本地引入，发布后的版本为 `2.99.0-local`：
+      ```shell
+      ./gradlew publishMiraiArtifactsToMavenLocal "-Dprojects.mirai-core.targets=jvm;android;!others"
+      ```
+      若上述命令不工作，尝试在 Android Studio 中打开项目并在 Studio 的终端中执行命令。
+- 我是 mirai native 用户，我需要 `.dll/.so/.dylib`：
+  你不能简单地构建这些动态链接库，因为它们需要依赖。阅读 [BuildingCoreNative](building/BuildingCoreNative.md)。

docs/contributing/building/BuildingCoreAndroid.md

@@ -0,0 +1,27 @@
+# 构建 mirai-core Android 目标
+
+mirai 项目支持两种方式构建 Android 目标。
+
+若主机在 `local.properties` 中配置了 `sdk.dir` 为 Android SDK 路径（就像普通 Android 项目一样），
+并且 mirai 的 Android 目标为启用状态（见 [关闭部分项目以提升速度](../README.md#关闭部分项目以提升速度)），则会使用 Android SDK 方式构建 android 目标，否则使用 JDK 方式。
+
+## Android 源集结构
+
+以 "ADK" 指代 "Android SDK"，下表展示 mirai core 项目中与 Android 相关的 Kotlin 源集、其依赖的源集列表、以及可用性。
+
+| sourceSet               | dependsOn   | 可用性       |
+|-------------------------|-------------|-----------|
+| androidMain             | jvmBaseMain | ADK 和 JDK |
+| androidInstrumentedTest | jvmBaseTest | ADK       |
+| androidUnitTest         | jvmBaseTest | ADK 和 JDK |
+
+## Android SDK 构建方式
+
+就像一个普通的 Android 库一样，mirai 可使用 Android SDK 编译，并拥有在 JVM 的单元测试和在 Dalvik 上运行的 instrumented tests。
+这是最推荐的构建方式，能保证 mirai 在真实 Android 环境通过测试，且能获得针对 Android 的 IDEA 代码检查。
+
+注意，`androidInstrumentedTest` 将会使用 Android 模拟器运行。
+
+## JDK 构建方式
+
+若 `sdk.dir` 未配置，则不会配置使用 Android SDK，而会使用桌面 JDK。`androidInstrumentedTest` 将会被禁用。

docs/contributing/building/BuildingCoreNative.md

@@ -1,15 +1,3 @@
-# 构建 Core
-
-本文介绍如何构建 core 的 JVM 和 Native 目标。
-
-## 构建 core 的 JVM 目标
-
-方法与[构建 JVM 目标项目](README.md#构建-jvm-目标项目)
-类似，但需要使用 `:mirai-core:compileKotlinJvm` 和 `:mirai-core:jvmTest`
-分别用于编译和测试。提示：直接执行测试时也会自动先完成编译。
-
-## 构建 core 的 Native 目标
-
 [OpenSSL.def]: ../../mirai-core/src/nativeMain/cinterop/OpenSSL.def
 
 Kotlin 会自动配置 Native 编译器，要构建 Mirai 的 Native 目标还需要准备相关依赖。
@@ -175,6 +163,8 @@ cURL，在其他平台使用 [Ktor CIO](https://ktor.io/docs/http-client-engines
 
 注意，只有 mirai-core 可以构建可用的动态链接库。所有动态链接库和静态链接库的构建都是默认关闭的，需要使用 `-Dmirai.native.binaries=true` 才能启用。
 
+## 构建 core 的 Native 目标
+
 在提供 `-Dmirai.native.binaries=true` 参数的情况下，执行 `:mirai-core:linkDebugSharedHost`
 或 `:mirai-core:linkReleaseSharedHost`。Debug 版本会保留调试符号，能显示完整错误堆栈；而
 Release 拥有更小体积（比 Debug 减小 50%）。

docs/contributing/building/README.md

@@ -0,0 +1,52 @@
+# 构建
+
+本文介绍如何构建 mirai 的各模块。
+
+## 构建 JVM 目标
+
+要构建只有 JVM 目标的项目（如 `mirai-console`，只需在项目根目录使用如下命令执行
+Gradle 任务：
+
+```shell
+./gradlew :mirai-console:assemble # 编译
+./gradlew :mirai-console:check # 测试
+./gradlew :mirai-console:build # 编译和测试
+```
+
+其中 `:mirai-console` 是目标项目的路径（path）。
+
+你也可以在 IDEA 等有 Gradle 支持的 IDE 中在通过侧边栏等方式选择项目的 `assemble` 等任务：
+
+![](images/run-gradle-tasks-in-idea.png)
+
+类似，但需要使用 `:mirai-core:compileKotlinJvm` 和 `:mirai-core:jvmTest`
+分别用于编译和测试。提示：直接执行测试时也会自动先完成编译。
+
+在 IDEA 开发中无需特殊考虑，一般直接通过点击单元测试行号处的运行按钮即可选择 JVM 平台运行。
+要批量运行测试，可使用 `./gradlew :mirai-core:check` 运行 mirai-core 模块的所有目标的所有测试。
+
+不建议在日常使用 `./gradlew check` 运行所有项目的测试，因为这可能会消耗时间和主机运行资源。但也值得在即将提交 PR 或喝咖啡休息时这么做。
+
+### 构建 core 的 Android 目标
+
+查看 [BuildingCoreAndroid](BuildingCoreAndroid.md)。
+
+### 构建 core 的 Native 目标
+
+查看 [BuildingCoreNative](BuildingCoreNative.md)。
+
+## 构建 IntelliJ 插件
+
+可通过如下命令构建 IntelliJ 平台 IDE 的插件。构建成功的插件将可以在 `mirai-console/tools/intellij-plugin/build/distribution` 中找到。
+
+```shell
+./graldew :mirai-console-intellij:buidlPlugin
+```
+
+## 获得 mirai-console JAR
+
+在项目根目录执行如下命令可以获得包含依赖的 mirai-console JAR。其他模块也类似。
+
+```shell
+./gradlew :mirai-console:shadowJar
+```

gradle.properties

@@ -1,5 +1,5 @@
 #
-# Copyright 2019-2022 Mamoe Technologies and contributors.
+# Copyright 2019-2023 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.
@@ -16,11 +16,13 @@ kotlin.native.binary.memoryModel=experimental
 #kotlin.mpp.enableCompatibilityMetadataVariant=true
 systemProp.org.gradle.internal.publish.checksums.insecure=true
 gnsp.disableApplyOnlyOnRootProjectEnforcement=true
-# We may target 15 with Kotlin 1.5 IR
-mirai.android.target.api.level=24
+mirai.android.target.api.level=21
 # Enable if you want to use mavenLocal for both Gradle plugin and project dependencies resolutions.
 systemProp.use.maven.local=false
 org.gradle.caching=true
 kotlin.native.ignoreIncorrectDependencies=true
 kotlin.mpp.enableCInteropCommonization=true
-kotlin.mpp.stability.nowarn=true
+kotlin.mpp.stability.nowarn=true
+kotlin.mpp.androidSourceSetLayoutVersion=2
+android.disableAutomaticComponentCreation=true
+android.useAndroidX=true

gradle/wrapper/gradle-wrapper.properties

@@ -1,13 +1,14 @@
 #
-# Copyright 2019-2021 Mamoe Technologies and contributors.
+# Copyright 2019-2023 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.
+# 此源代码的使用受 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/master/LICENSE
+# https://github.com/mamoe/mirai/blob/dev/LICENSE
 #
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.1-all.zip
+
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-zipStorePath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.0-all.zip
 zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -1,87 +1,122 @@
-#!/usr/bin/env sh
+#!/bin/sh
 
 #
-# Copyright 2019-2020 Mamoe Technologies and contributors.
+# Copyright 2019-2023 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.
+# 此源代码的使用受 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/master/LICENSE
+# https://github.com/mamoe/mirai/blob/dev/LICENSE
 #
 
 ##############################################################################
-##
-##  Gradle start up script for UN*X
-##
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
 ##############################################################################
 
 # Attempt to set APP_HOME
+
 # Resolve links: $0 may be a link
-PRG="$0"
-# Need this for relative symlinks.
-while [ -h "$PRG" ] ; do
-    ls=`ls -ld "$PRG"`
-    link=`expr "$ls" : '.*-> \(.*\)$'`
-    if expr "$link" : '/.*' > /dev/null; then
-        PRG="$link"
-    else
-        PRG=`dirname "$PRG"`"/$link"
-    fi
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
 done
-SAVED="`pwd`"
-cd "`dirname \"$PRG\"`/" >/dev/null
-APP_HOME="`pwd -P`"
-cd "$SAVED" >/dev/null
+
+APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
 
 APP_NAME="Gradle"
-APP_BASE_NAME=`basename "$0"`
+APP_BASE_NAME=${0##*/}
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
-MAX_FD="maximum"
+MAX_FD=maximum
 
 warn () {
     echo "$*"
-}
+} >&2
 
 die () {
     echo
     echo "$*"
     echo
     exit 1
-}
+} >&2
 
 # OS specific support (must be 'true' or 'false').
 cygwin=false
 msys=false
 darwin=false
 nonstop=false
-case "`uname`" in
-  CYGWIN* )
-    cygwin=true
-    ;;
-  Darwin* )
-    darwin=true
-    ;;
-  MINGW* )
-    msys=true
-    ;;
-  NONSTOP* )
-    nonstop=true
-    ;;
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
 esac
 
 CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
 
+
 # Determine the Java command to use to start the JVM.
 if [ -n "$JAVA_HOME" ] ; then
     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
         # IBM's JDK on AIX uses strange locations for the executables
-        JAVACMD="$JAVA_HOME/jre/sh/java"
+        JAVACMD=$JAVA_HOME/jre/sh/java
     else
-        JAVACMD="$JAVA_HOME/bin/java"
+        JAVACMD=$JAVA_HOME/bin/java
     fi
     if [ ! -x "$JAVACMD" ] ; then
         die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
@@ -90,7 +125,7 @@ Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
     fi
 else
-    JAVACMD="java"
+    JAVACMD=java
     which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
@@ -98,79 +133,95 @@ location of your Java installation."
 fi
 
 # Increase the maximum file descriptors if we can.
-if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
-    MAX_FD_LIMIT=`ulimit -H -n`
-    if [ $? -eq 0 ] ; then
-        if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
-            MAX_FD="$MAX_FD_LIMIT"
-        fi
-        ulimit -n $MAX_FD
-        if [ $? -ne 0 ] ; then
-            warn "Could not set maximum file descriptor limit: $MAX_FD"
-        fi
-    else
-        warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
-    fi
-fi
-
-# For Darwin, add options to specify how the application appears in the dock
-if $darwin; then
-    GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
-fi
-
-# For Cygwin or MSYS, switch paths to Windows format before running java
-if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
-    APP_HOME=`cygpath --path --mixed "$APP_HOME"`
-    CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
-    JAVACMD=`cygpath --unix "$JAVACMD"`
-
-    # We build the pattern for arguments to be converted via cygpath
-    ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
-    SEP=""
-    for dir in $ROOTDIRSRAW ; do
-        ROOTDIRS="$ROOTDIRS$SEP$dir"
-        SEP="|"
-    done
-    OURCYGPATTERN="(^($ROOTDIRS))"
-    # Add a user-defined pattern to the cygpath arguments
-    if [ "$GRADLE_CYGPATTERN" != "" ] ; then
-        OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
-    fi
-    # Now convert the arguments - kludge to limit ourselves to /bin/sh
-    i=0
-    for arg in "$@" ; do
-        CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
-        CHECK2=`echo "$arg"|egrep -c "^-"`                                 ### Determine if an option
-
-        if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then                    ### Added a condition
-            eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
-        else
-            eval `echo args$i`="\"$arg\""
-        fi
-        i=`expr $i + 1`
-    done
-    case $i in
-        0) set -- ;;
-        1) set -- "$args0" ;;
-        2) set -- "$args0" "$args1" ;;
-        3) set -- "$args0" "$args1" "$args2" ;;
-        4) set -- "$args0" "$args1" "$args2" "$args3" ;;
-        5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
-        6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
-        7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
-        8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
-        9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
 fi
 
-# Escape application args
-save () {
-    for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
-    echo " "
-}
-APP_ARGS=`save "$@"`
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
 
-# Collect all arguments for the java command, following the shell quoting and substitution rules
-eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+# Collect all arguments for the java command;
+#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
+#     shell script including quotes and variable substitutions, so put them in
+#     double quotes to make sure that they get re-expanded; and
+#   * put everything else in single quotes, so that it's not re-expanded.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        org.gradle.wrapper.GradleWrapperMain \
+        "$@"
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
 
 exec "$JAVACMD" "$@"

gradlew.bat

@@ -29,6 +29,9 @@ if "%DIRNAME%" == "" set DIRNAME=.
 set APP_BASE_NAME=%~n0
 set APP_HOME=%DIRNAME%
 
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
 @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
 
@@ -37,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
 
 set JAVA_EXE=java.exe
 %JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto init
+if "%ERRORLEVEL%" == "0" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@@ -51,7 +54,7 @@ goto fail
 set JAVA_HOME=%JAVA_HOME:"=%
 set JAVA_EXE=%JAVA_HOME%/bin/java.exe
 
-if exist "%JAVA_EXE%" goto init
+if exist "%JAVA_EXE%" goto execute
 
 echo.
 echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
@@ -61,28 +64,14 @@ echo location of your Java installation.
 
 goto fail
 
-:init
-@rem Get command-line arguments, handling Windows variants
-
-if not "%OS%" == "Windows_NT" goto win9xME_args
-
-:win9xME_args
-@rem Slurp the command line arguments.
-set CMD_LINE_ARGS=
-set _SKIP=2
-
-:win9xME_args_slurp
-if "x%~1" == "x" goto execute
-
-set CMD_LINE_ARGS=%*
-
 :execute
 @rem Setup the command line
 
 set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
 
+
 @rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
 
 :end
 @rem End local scope for the variables with windows NT shell

mirai-console/backend/mirai-console/build.gradle.kts

@@ -10,6 +10,7 @@
 @file:Suppress("UnusedImport")
 
 import BinaryCompatibilityConfigurator.configureBinaryValidator
+import org.jetbrains.kotlin.gradle.plugin.KotlinPlatformType
 import java.time.Instant
 import java.time.ZoneId
 import java.time.format.DateTimeFormatter
@@ -33,9 +34,11 @@ kotlin {
 
 // 搜索 mirai-console (包括 core) 直接使用并对外公开的类 (api)
 configurations.create("consoleRuntimeClasspath").attributes {
-    attribute(Usage.USAGE_ATTRIBUTE,
+    attribute(
+        Usage.USAGE_ATTRIBUTE,
         project.objects.named(Usage::class.java, Usage.JAVA_API)
     )
+    attribute(KotlinPlatformType.attribute, KotlinPlatformType.jvm)
 }.also { consoleRuntimeClasspath ->
     consoleRuntimeClasspath.exclude(group = "io.ktor")
 }

mirai-console/frontend/mirai-console-terminal/build.gradle.kts

@@ -7,6 +7,9 @@
  * https://github.com/mamoe/mirai/blob/dev/LICENSE
  */
 
+import shadow.registerRegularShadowTaskForJvmProject
+import shadow.shadowImplementation
+
 plugins {
     kotlin("jvm")
     kotlin("plugin.serialization")

mirai-console/tools/compiler-annotations/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -19,9 +19,10 @@ description = "Mirai Console compiler annotations"
 
 kotlin {
     explicitApi()
+    apply(plugin = "explicit-api")
 
-    configureJvmTargetsHierarchical()
+    configureJvmTargetsHierarchical("net.mamoe.mirai.compiler.annotations")
     configureNativeTargetsHierarchical(project)
 }
 
-configureMppPublishing()
+configureMppPublishing()

mirai-console/tools/compiler-annotations/src/androidMain/AndroidManifest.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ Copyright 2019-2023 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
+  -->
+
+<manifest package="net.mamoe.mirai.console.compiler.common">
+</manifest>

mirai-console/tools/gradle-plugin/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -69,20 +69,18 @@ kotlin {
     explicitApi()
 }
 
-pluginBundle {
-    website = "https://github.com/mamoe/mirai"
-    vcsUrl = "https://github.com/mamoe/mirai"
-    tags = listOf("framework", "kotlin", "mirai")
-}
-
+@Suppress("UnstableApiUsage")
 gradlePlugin {
     testSourceSets(integTest)
+    website.set("https://github.com/mamoe/mirai")
+    vcsUrl.set("https://github.com/mamoe/mirai")
     plugins {
         create("miraiConsole") {
             id = "net.mamoe.mirai-console"
             displayName = "Mirai Console"
             description = project.description
             implementationClass = "net.mamoe.mirai.console.gradle.MiraiConsoleGradlePlugin"
+            tags.set(listOf("framework", "kotlin", "mirai"))
         }
     }
 }

mirai-console/tools/gradle-plugin/src/main/kotlin/MiraiConsoleGradlePlugin.kt

@@ -153,6 +153,7 @@ public class MiraiConsoleGradlePlugin : Plugin<Project> {
                 val compilations = target.compilations.filter { it.name == MAIN_COMPILATION_NAME }
 
                 compilations.forEach {
+                    @Suppress("DEPRECATION") // We need to support older Kotlin versions
                     dependsOn(it.compileKotlinTask)
                     from(it.output.allOutputs)
                 }

mirai-console/tools/gradle-plugin/src/main/kotlin/publishing.kt

@@ -130,7 +130,7 @@ private fun Project.registerMavenPublications(target: KotlinTarget, isSingleTarg
 
     @Suppress("DEPRECATION")
     val sourcesJar by tasks.registering(Jar::class) {
-        classifier = "sources"
+        archiveClassifier.set("sources")
         from(sourceSets["main"].allSource)
     }
 

mirai-console/tools/intellij-plugin/resources/fileTemplates/code/Plugin build.gradle.ft

@@ -9,8 +9,9 @@ group = '$GROUP_ID'
 version = '$VERSION'
 
 repositories {
-    #if($USE_PROXY_REPO)maven { url 'https://maven.aliyun.com/repository/public' }#end
-
+#if($USE_PROXY_REPO)
+    maven { url 'https://maven.aliyun.com/repository/public' }
+#end
     mavenCentral()
 }
 

mirai-console/tools/intellij-plugin/resources/fileTemplates/code/Plugin build.gradle.kts.ft

@@ -10,8 +10,9 @@ group = "$GROUP_ID"
 version = "$VERSION"
 
 repositories {
-    #if($USE_PROXY_REPO)maven("https://maven.aliyun.com/repository/public")#end
-
+#if($USE_PROXY_REPO)
+    maven("https://maven.aliyun.com/repository/public")
+#end
     mavenCentral()
 }
 

mirai-console/tools/intellij-plugin/resources/fileTemplates/code/Plugin settings.gradle.ft

@@ -0,0 +1,9 @@
+pluginManagement {
+    repositories {
+#if($USE_PROXY_REPO)
+        maven { url "https://maven.aliyun.com/repository/gradle-plugin" }
+#end
+        gradlePluginPortal()
+    }
+}
+rootProject.name = "$ARTIFACT_ID"

mirai-console/tools/intellij-plugin/resources/fileTemplates/code/Plugin settings.gradle.html

@@ -0,0 +1,14 @@
+<!--
+  ~ Copyright 2019-2023 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
+  -->
+
+<html>
+<body>
+<p>This is a built-in file template used to create a new settings.gradle for Mirai Console Plugin projects.</p>
+</body>
+</html>

mirai-console/tools/intellij-plugin/resources/fileTemplates/code/Plugin settings.gradle.kts.ft

@@ -1 +1,9 @@
+pluginManagement {
+    repositories {
+#if($USE_PROXY_REPO)
+        maven("https://maven.aliyun.com/repository/gradle-plugin")
+#end
+        gradlePluginPortal()
+    }
+}
 rootProject.name = "$ARTIFACT_ID"

mirai-console/tools/intellij-plugin/resources/messages/MiraiProjectWizardBundle.properties

@@ -1,5 +1,5 @@
 #
-# Copyright 2019-2022 Mamoe Technologies and contributors.
+# Copyright 2019-2023 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.
@@ -37,3 +37,4 @@ validation.plugin.name.forbidden.character="{0}" is forbidden in plugin name
 validation.illegal.plugin.id=Invalid plugin id "{0}"
 validation.illegal.version=Invalid version.\n{0}
 no.error.message=No error message
+text.use.proxy.repo=Use Aliyun Maven repository

mirai-console/tools/intellij-plugin/resources/messages/MiraiProjectWizardBundle_zh.properties

@@ -1,5 +1,5 @@
 #
-# Copyright 2019-2022 Mamoe Technologies and contributors.
+# Copyright 2019-2023 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.
@@ -37,3 +37,4 @@ validation.plugin.name.forbidden.character=插件名称中不允许存在 "{0}"
 validation.illegal.plugin.id=插件 ID 无效: "{0}"
 validation.illegal.version=插件版本无效\n{0}
 no.error.message=无错误信息
+text.use.proxy.repo=使用阿里云 Maven 镜像

mirai-console/tools/intellij-plugin/src/wizard/MiraiModuleBuilder.kt

@@ -82,7 +82,7 @@ class MiraiModuleBuilder : StarterModuleBuilder() {
                 "GROUP_ID" to projectCoordinates.groupId,
                 "VERSION" to projectCoordinates.version,
                 "PROJECT_NAME" to starterContext,
-                "USE_PROXY_REPO" to "true",
+                "USE_PROXY_REPO" to useProxyRepo,
                 "ARTIFACT_ID" to projectCoordinates.artifactId,
                 "MODULE_NAME" to projectCoordinates.moduleName,
 

mirai-console/tools/intellij-plugin/src/wizard/MiraiProjectModel.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -38,7 +38,7 @@ class MiraiProjectModel(
 
     val buildSystemType: BuildSystemType,
     val languageType: LanguageType,
-
+    val useProxyRepo: Boolean,
 
     val mainClassSimpleName: String = pluginCoordinates.run {
         name.adjustToClassName() ?: id.substringAfterLast('.').adjustToClassName()

mirai-console/tools/intellij-plugin/src/wizard/MiraiProjectWizardInitialStep.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -39,6 +39,7 @@ class MiraiProjectWizardInitialStep(contextProvider: StarterContextProvider) : S
     private val pluginInfoProperty = propertyGraph.lazyProperty { "" }
     private val miraiVersionKindProperty = propertyGraph.property(MiraiVersionKind.Stable)
     private val miraiVersionProperty = propertyGraph.property("0.1.0")
+    private val useProxyRepoProperty = propertyGraph.property(true)
 
     var pluginVersion by pluginVersionProperty.trim()
     var pluginName by pluginNameProperty.trim()
@@ -54,6 +55,8 @@ class MiraiProjectWizardInitialStep(contextProvider: StarterContextProvider) : S
 
     private lateinit var miraiVersionCell: Cell<ComboBox<String>>
 
+    var useProxyRepo by useProxyRepoProperty
+
     override fun addFieldsAfter(layout: Panel) {
         layout.group(message("title.plugin.description")) {
             row(message("label.plugin.id")) {
@@ -141,6 +144,9 @@ class MiraiProjectWizardInitialStep(contextProvider: StarterContextProvider) : S
                 updateVersionItems(miraiVersionKindCell, miraiVersionCell)
                 rowComment(message("comment.mirai.version"))
             }
+            row {
+                checkBox(message("text.use.proxy.repo")).enabled(true).bindSelected(useProxyRepoProperty)
+            }
         }
 
         // Update default values
@@ -181,7 +187,8 @@ class MiraiProjectWizardInitialStep(contextProvider: StarterContextProvider) : S
                     KOTLIN_STARTER_LANGUAGE -> LanguageType.Kotlin
                     JAVA_STARTER_LANGUAGE -> LanguageType.Java
                     else -> error("Unsupported language type: $language")
-                }
+                },
+                useProxyRepo = useProxyRepo
             )
         )
     }

mirai-core-all/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -9,6 +9,9 @@
 
 @file:Suppress("UnusedImport")
 
+import shadow.configureRelocatedShadowJarForJvmProject
+import shadow.relocateImplementation
+
 plugins {
     kotlin("jvm")
     kotlin("plugin.serialization")
@@ -34,7 +37,7 @@ dependencies {
 val shadow = configureRelocatedShadowJarForJvmProject(kotlin)
 
 if (System.getenv("MIRAI_IS_SNAPSHOTS_PUBLISHING")?.toBoolean() != true) {
-    // Do not publish -all jars to snapshot server since they are too large.
+    // Do not publish `-all` jars to snapshot server since they are too large.
 
     configurePublishing("mirai-core-all", addShadowJar = false)
 

mirai-core-api/build.gradle.kts

@@ -9,12 +9,13 @@
 @file:Suppress("UNUSED_VARIABLE")
 
 import BinaryCompatibilityConfigurator.configureBinaryValidators
+import shadow.relocateCompileOnly
 
 plugins {
     kotlin("multiplatform")
     kotlin("plugin.serialization")
 
-    //id("kotlinx-atomicfu")
+    id("kotlinx-atomicfu")
     id("signing")
     id("me.him188.kotlin-jvm-blocking-bridge")
     id("me.him188.kotlin-dynamic-delegation")
@@ -27,11 +28,12 @@ description = "Mirai API module"
 
 kotlin {
     explicitApi()
-    configureJvmTargetsHierarchical()
+    apply(plugin = "explicit-api")
+
+    configureJvmTargetsHierarchical("net.mamoe.mirai")
 
     configureNativeTargetsHierarchical(project)
 
-
     sourceSets {
         val commonMain by getting {
             dependencies {
@@ -44,7 +46,10 @@ kotlin {
                 implementation(project(":mirai-console-compiler-annotations"))
                 implementation(`kotlinx-serialization-protobuf`)
                 implementation(`kotlinx-atomicfu`)
-                relocateCompileOnly(`ktor-io_relocated`) // runtime from mirai-core-utils
+
+                // runtime from mirai-core-utils
+                relocateCompileOnly(`ktor-io_relocated`)
+
                 implementation(`kotlin-jvm-blocking-bridge`)
                 implementation(`kotlin-dynamic-delegation`)
             }
@@ -65,9 +70,11 @@ kotlin {
             }
         }
 
-        findByName("androidMain")?.apply {
-            dependencies {
-                compileOnly(`android-runtime`)
+        afterEvaluate {
+            findByName("androidUnitTest")?.apply {
+                dependencies {
+                    runtimeOnly(`slf4j-api`)
+                }
             }
         }
 
@@ -88,6 +95,10 @@ kotlin {
     }
 }
 
+atomicfu {
+    transformJvm = false
+}
+
 if (tasks.findByName("androidMainClasses") != null) {
     tasks.register("checkAndroidApiLevel") {
         doFirst {
@@ -100,7 +111,7 @@ if (tasks.findByName("androidMainClasses") != null) {
         group = "verification"
         this.mustRunAfter("androidMainClasses")
     }
-    tasks.getByName("androidTest").dependsOn("checkAndroidApiLevel")
+    tasks.getByName("androidBaseTest").dependsOn("checkAndroidApiLevel")
 }
 
 configureMppPublishing()
@@ -112,4 +123,4 @@ configureBinaryValidators(setOf("jvm", "android").filterTargets())
 //    developer("Mamoe Technologies", email = "support@mamoe.net", url = "https://github.com/mamoe")
 //    licenseFromGitHubProject("AGPLv3", "dev")
 //    publishPlatformArtifactsInRootModule = "jvm"
-//}
+//}

mirai-core-api/compatibility-validation/android/api/android.api

@@ -5370,6 +5370,10 @@ public final class net/mamoe/mirai/message/data/XmlMessageBuilder$ItemBuilder {
 public final class net/mamoe/mirai/message/data/visitor/MessageVisitorKt {
 }
 
+public final class net/mamoe/mirai/network/BotAuthorizationException : net/mamoe/mirai/network/LoginFailedException {
+	public final fun getAuthorization ()Lnet/mamoe/mirai/auth/BotAuthorization;
+}
+
 public abstract class net/mamoe/mirai/network/CustomLoginFailedException : net/mamoe/mirai/network/LoginFailedException {
 	public fun <init> (Z)V
 	public fun <init> (ZLjava/lang/String;)V

mirai-core-api/compatibility-validation/jvm/api/jvm.api

@@ -5370,6 +5370,10 @@ public final class net/mamoe/mirai/message/data/XmlMessageBuilder$ItemBuilder {
 public final class net/mamoe/mirai/message/data/visitor/MessageVisitorKt {
 }
 
+public final class net/mamoe/mirai/network/BotAuthorizationException : net/mamoe/mirai/network/LoginFailedException {
+	public final fun getAuthorization ()Lnet/mamoe/mirai/auth/BotAuthorization;
+}
+
 public abstract class net/mamoe/mirai/network/CustomLoginFailedException : net/mamoe/mirai/network/LoginFailedException {
 	public fun <init> (Z)V
 	public fun <init> (ZLjava/lang/String;)V

mirai-core-api/src/androidMain/AndroidManifest.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ Copyright 2019-2023 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
+  -->
+
+<manifest package="net.mamoe.mirai" xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

mirai-core-api/src/androidMain/kotlin/utils/PlatformLogger.android.kt

@@ -1,14 +1,12 @@
 /*
- * Copyright 2019-2021 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
+ * 此源代码的使用受 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/master/LICENSE
+ * https://github.com/mamoe/mirai/blob/dev/LICENSE
  */
 
-@file:Suppress("MemberVisibilityCanBePrivate")
-
 package net.mamoe.mirai.utils
 
 import android.util.Log
@@ -26,7 +24,7 @@ public actual open class PlatformLogger actual constructor(
 ) : MiraiLoggerPlatformBase() {
 
     public override fun verbose0(message: String?) {
-        Log.v(identity, message)
+        Log.v(identity, message.toString())
     }
 
     public override fun verbose0(message: String?, e: Throwable?) {
@@ -35,7 +33,7 @@ public actual open class PlatformLogger actual constructor(
 
 
     public override fun info0(message: String?) {
-        Log.i(identity, message)
+        Log.i(identity, message.toString())
     }
 
     public override fun info0(message: String?, e: Throwable?) {
@@ -44,7 +42,7 @@ public actual open class PlatformLogger actual constructor(
 
 
     public override fun warning0(message: String?) {
-        Log.w(identity, message)
+        Log.w(identity, message.toString())
     }
 
     public override fun warning0(message: String?, e: Throwable?) {
@@ -53,7 +51,7 @@ public actual open class PlatformLogger actual constructor(
 
 
     public override fun error0(message: String?) {
-        Log.e(identity, message)
+        Log.e(identity, message.toString())
     }
 
     public override fun error0(message: String?, e: Throwable?) {
@@ -62,7 +60,7 @@ public actual open class PlatformLogger actual constructor(
 
 
     public override fun debug0(message: String?) {
-        Log.d(identity, message)
+        Log.d(identity, message.toString())
     }
 
     public override fun debug0(message: String?, e: Throwable?) {

mirai-core-api/src/androidTest/kotlin/android/util/Log.kt

@@ -1,125 +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
- */
-
-package android.util
-
-import net.mamoe.mirai.internal.utils.StdoutLogger
-
-// Dummy implementation for tests, since we don't have a SDK
-
-@Suppress("UNUSED_PARAMETER", "unused")
-object Log {
-    const val VERBOSE = 2
-    const val DEBUG = 3
-    const val INFO = 4
-    const val WARN = 5
-    const val ERROR = 6
-    const val ASSERT = 7
-
-    private val stdout = StdoutLogger("AndroidLog")
-
-    @JvmStatic
-    fun v(tag: String?, msg: String?): Int {
-        stdout.verbose(msg)
-        return 0
-    }
-
-    @JvmStatic
-    fun v(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.verbose(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun d(tag: String?, msg: String?): Int {
-        stdout.debug(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun d(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.debug(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun i(tag: String?, msg: String?): Int {
-        stdout.info(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun i(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.info(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun w(tag: String?, msg: String?): Int {
-        stdout.warning(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun w(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.warning(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun w(tag: String?, tr: Throwable?): Int {
-        stdout.warning(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun e(tag: String?, msg: String?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun e(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun wtf(tag: String?, msg: String?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun wtf(tag: String?, tr: Throwable?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun wtf(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun getStackTraceString(tr: Throwable): String {
-        return tr.stackTraceToString()
-    }
-
-    @JvmStatic
-    fun println(priority: Int, tag: String?, msg: String?): Int {
-        stdout.info(msg, tr)
-        return 0
-    }
-
-
-    private inline val tr get() = null
-    private inline val msg get() = null
-}

mirai-core-api/src/commonMain/kotlin/network/LoginFailedException.kt

@@ -12,6 +12,7 @@
 package net.mamoe.mirai.network
 
 import net.mamoe.mirai.Bot
+import net.mamoe.mirai.auth.BotAuthorization
 import net.mamoe.mirai.utils.LoginSolver
 import net.mamoe.mirai.utils.MiraiInternalApi
 
@@ -75,6 +76,19 @@ public class NoStandardInputForCaptchaException @MiraiInternalApi constructor(
     public override val cause: Throwable? = null
 ) : LoginFailedException(true, "no standard input for captcha")
 
+/**
+ * 表示在登录过程中, [BotAuthorization] 抛出的异常.
+ * @since 2.15
+ */
+public class BotAuthorizationException @MiraiInternalApi constructor(
+    public val authorization: BotAuthorization,
+    cause: Throwable?,
+) : LoginFailedException(
+    killBot = true,
+    "BotAuthorization(${authorization}) threw an exception during authorization process. See cause below.",
+    cause
+)
+
 /**
  * 当前 [LoginSolver] 不支持此验证方式
  *

mirai-core-api/src/commonMain/kotlin/utils/MiraiUtilsLogger.kt

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2019-2023 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.utils
+
+internal fun MiraiLogger.asUtilsLogger(): UtilsLogger = MiraiUtilsLogger(this)
+
+internal class MiraiUtilsLogger(
+    private val miraiLogger: MiraiLogger,
+) : UtilsLogger {
+    override val isVerboseEnabled: Boolean
+        get() = miraiLogger.isVerboseEnabled
+    override val isDebugEnabled: Boolean
+        get() = miraiLogger.isDebugEnabled
+    override val isInfoEnabled: Boolean
+        get() = miraiLogger.isInfoEnabled
+    override val isWarningEnabled: Boolean
+        get() = miraiLogger.isWarningEnabled
+    override val isErrorEnabled: Boolean
+        get() = miraiLogger.isErrorEnabled
+
+    override fun verbose(message: String?, e: Throwable?) {
+        miraiLogger.verbose(message, e)
+    }
+
+    override fun debug(message: String?, e: Throwable?) {
+        miraiLogger.debug(message, e)
+    }
+
+    override fun info(message: String?, e: Throwable?) {
+        miraiLogger.info(message, e)
+    }
+
+    override fun warning(message: String?, e: Throwable?) {
+        miraiLogger.warning(message, e)
+    }
+
+    override fun error(message: String?, e: Throwable?) {
+        miraiLogger.error(message, e)
+    }
+}

mirai-core-api/src/jvmBaseTest/kotlin/utils/JvmDeviceInfoTest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -38,14 +38,4 @@ class JvmDeviceInfoTest {
         file.writeText(Json.encodeToString(DeviceInfo.serializer(), device))
         assertEquals(device, file.loadAsDeviceInfo())
     }
-
-
-    // TODO: 2022/10/19 move this to common test when Kotlin supports loading resources in commonMain
-    @Test
-    fun `can deserialize legacy versions before 2_9_0`() {
-        DeviceInfoManager.deserialize(
-            this::class.java.classLoader.getResourceAsStream("device/legacy-device-info-1.json")!!
-                .use { it.readBytes().decodeToString() })
-    }
-
 }

mirai-core-api/src/jvmTest/kotlin/utils/JvmDeviceInfoTestJvm.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019-2023 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.utils
+
+import kotlin.test.Test
+
+class JvmDeviceInfoTestJvm {
+    @Test
+    fun `can deserialize legacy versions before 2_9_0`() {
+        // resources not available on android
+
+        DeviceInfoManager.deserialize(
+            this::class.java.classLoader.getResourceAsStream("device/legacy-device-info-1.json")!!
+                .use { it.readBytes().decodeToString() })
+    }
+}

mirai-core-api/src/main/AndroidManifest.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!--
-  ~ Copyright 2019-2020 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/master/LICENSE
-  -->
-
-<manifest package="net.mamoe.mirai" xmlns:android="http://schemas.android.com/apk/res/android">
-    <uses-permission android:name="android.permission.READ_PHONE_STATE"/>
-    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
-</manifest>

mirai-core-utils/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -9,6 +9,8 @@
 
 @file:Suppress("UNUSED_VARIABLE")
 
+import shadow.relocateImplementation
+
 plugins {
     kotlin("multiplatform")
     kotlin("plugin.serialization")
@@ -23,8 +25,9 @@ description = "mirai-core utilities"
 
 kotlin {
     explicitApi()
+    apply(plugin = "explicit-api")
 
-    configureJvmTargetsHierarchical()
+    configureJvmTargetsHierarchical("net.mamoe.mirai.utils")
     configureNativeTargetsHierarchical(project)
 
     sourceSets {
@@ -35,11 +38,19 @@ kotlin {
                 api(`kotlinx-serialization-json`)
                 api(`kotlinx-coroutines-core`)
 
-                implementation(`kotlinx-atomicfu`)
                 implementation(`kotlinx-serialization-protobuf`)
                 relocateImplementation(`ktor-io_relocated`)
             }
         }
+        configure(NATIVE_TARGETS.map { getByName(it + "Main") }
+                + NATIVE_TARGETS.map { getByName(it + "Test") }) {
+            dependencies {
+                // no relocation in native
+                implementation(`ktor-io`) {
+                    exclude(ExcludeProperties.`slf4j-api`)
+                }
+            }
+        }
 
         val commonTest by getting {
             dependencies {
@@ -56,8 +67,7 @@ kotlin {
 
         findByName("androidMain")?.apply {
             dependencies {
-                compileOnly(`android-runtime`)
-//                    api1(`ktor-client-android`)
+                implementation(`androidx-annotation`)
             }
         }
 
@@ -67,6 +77,7 @@ kotlin {
 
         findByName("jvmTest")?.apply {
             dependencies {
+                implementation(`kotlinx-coroutines-debug`)
                 runtimeOnly(files("build/classes/kotlin/jvm/test")) // classpath is not properly set by IDE
             }
         }
@@ -91,7 +102,7 @@ if (tasks.findByName("androidMainClasses") != null) {
         group = "verification"
         this.mustRunAfter("androidMainClasses")
     }
-    tasks.getByName("androidTest").dependsOn("checkAndroidApiLevel")
+    tasks.getByName("androidBaseTest").dependsOn("checkAndroidApiLevel")
 }
 
 configureMppPublishing()

mirai-core-utils/src/androidInstrumentedTest/kotlin/AndroidUnwrapTest.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2021 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.

mirai-core-utils/src/androidMain/AndroidManifest.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ Copyright 2019-2023 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
+  -->
+
+<manifest package="net.mamoe.mirai" xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

mirai-core-utils/src/androidMain/kotlin/Actuals.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -8,11 +8,12 @@
  */
 
 @file:JvmMultifileClass
-@file:Suppress("NOTHING_TO_INLINE")
 
 package net.mamoe.mirai.utils
 
+import android.os.Build
 import android.util.Base64
+import androidx.annotation.RequiresApi
 
 
 public actual fun ByteArray.encodeBase64(): String {
@@ -23,6 +24,7 @@ public actual fun String.decodeBase64(): ByteArray {
     return Base64.decode(this, Base64.DEFAULT)
 }
 
+@RequiresApi(Build.VERSION_CODES.N)
 @PublishedApi
 internal class StacktraceException(override val message: String?, private val stacktrace: Array<StackTraceElement>) :
     Exception(message, null, true, false) {
@@ -30,10 +32,23 @@ internal class StacktraceException(override val message: String?, private val st
     override fun getStackTrace(): Array<StackTraceElement> = stacktrace
 }
 
+@PublishedApi
+internal class StacktraceExceptionBeforeN(
+    override val message: String?,
+    private val stacktrace: Array<StackTraceElement>
+) : Exception(message, null) {
+    override fun fillInStackTrace(): Throwable = this
+    override fun getStackTrace(): Array<StackTraceElement> = stacktrace
+}
+
 public actual inline fun <reified E> Throwable.unwrap(addSuppressed: Boolean): Throwable {
     if (this !is E) return this
     return if (addSuppressed) {
-        val e = StacktraceException("Unwrapped exception: $this", this.stackTrace)
+        val e = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
+            StacktraceException("Unwrapped exception: $this", this.stackTrace)
+        } else {
+            StacktraceExceptionBeforeN("Unwrapped exception: $this", this.stackTrace)
+        }
         for (throwable in this.suppressed) {
             e.addSuppressed(throwable)
         }

mirai-core-utils/src/commonMain/kotlin/Services.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -36,7 +36,7 @@ public object Services {
         }
     }
 
-    internal fun registerAsOverride(baseClass: String, implementationClass: String, implementation: () -> Any) {
+    public fun registerAsOverride(baseClass: String, implementationClass: String, implementation: () -> Any) {
         lock.withLock {
             overrided[baseClass] = Implementation(implementationClass, lazy(implementation))
         }
@@ -72,7 +72,8 @@ public object Services {
         }
     }
 
-    internal fun implementationsDirectly(baseClass: String) = lock.withLock { registered[baseClass]?.toList().orEmpty() }
+    internal fun implementationsDirectly(baseClass: String) =
+        lock.withLock { registered[baseClass]?.toList().orEmpty() }
 
     public fun print(): String {
         lock.withLock {

mirai-core-utils/src/commonMain/kotlin/UtilsLogger.kt

@@ -0,0 +1,184 @@
+/*
+ * Copyright 2019-2023 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.utils
+
+/**
+ * Mirror of `MiraiLogger`, to be used in utils module.
+ */
+public interface UtilsLogger {
+    /**
+     * 当 VERBOSE 级别的日志启用时返回 `true`.
+     */
+    public val isVerboseEnabled: Boolean
+
+    /**
+     * 当 DEBUG 级别的日志启用时返回 `true`
+     */
+    public val isDebugEnabled: Boolean
+
+    /**
+     * 当 INFO 级别的日志启用时返回 `true`
+     */
+    public val isInfoEnabled: Boolean
+
+    /**
+     * 当 WARNING 级别的日志启用时返回 `true`
+     */
+    public val isWarningEnabled: Boolean
+
+    /**
+     * 当 ERROR 级别的日志启用时返回 `true`
+     */
+    public val isErrorEnabled: Boolean
+
+
+    /**
+     * 记录一个 `verbose` 级别的日志.
+     * 无关紧要的, 经常大量输出的日志应使用它.
+     */
+    public fun verbose(message: String?, e: Throwable? = null)
+
+    /**
+     * 记录一个 _调试_ 级别的日志.
+     */
+    public fun debug(message: String?, e: Throwable? = null)
+
+    /**
+     * 记录一个 _信息_ 级别的日志.
+     */
+    public fun info(message: String?, e: Throwable? = null)
+
+    /**
+     * 记录一个 _警告_ 级别的日志.
+     */
+    public fun warning(message: String?, e: Throwable? = null)
+
+    /**
+     * 记录一个 _错误_ 级别的日志.
+     */
+    public fun error(message: String?, e: Throwable? = null)
+
+    public companion object {
+        @OptIn(TestOnly::class)
+        private val noop: UtilsLogger by lazy {
+            SimpleUtilsLogger().apply {
+                isDebugEnabled = false
+                isErrorEnabled = false
+                isInfoEnabled = false
+                isWarningEnabled = false
+                isVerboseEnabled = false
+            }
+        }
+
+        public fun noop(): UtilsLogger = noop
+    }
+}
+
+public fun UtilsLogger.info(e: Throwable?) {
+    info(null, e)
+}
+
+public fun UtilsLogger.error(e: Throwable?) {
+    error(null, e)
+}
+
+public fun UtilsLogger.warning(e: Throwable?) {
+    warning(null, e)
+}
+
+public fun UtilsLogger.debug(e: Throwable?) {
+    debug(null, e)
+}
+
+public fun UtilsLogger.verbose(e: Throwable?) {
+    verbose(null, e)
+}
+
+
+public inline fun UtilsLogger.verbose(message: () -> String) {
+    if (isVerboseEnabled) verbose(message())
+}
+
+public inline fun UtilsLogger.verbose(message: () -> String, e: Throwable?) {
+    if (isVerboseEnabled) verbose(message(), e)
+}
+
+public inline fun UtilsLogger.debug(message: () -> String?) {
+    if (isDebugEnabled) debug(message())
+}
+
+public inline fun UtilsLogger.debug(message: () -> String?, e: Throwable?) {
+    if (isDebugEnabled) debug(message(), e)
+}
+
+public inline fun UtilsLogger.info(message: () -> String?) {
+    if (isInfoEnabled) info(message())
+}
+
+public inline fun UtilsLogger.info(message: () -> String?, e: Throwable?) {
+    if (isInfoEnabled) info(message(), e)
+}
+
+public inline fun UtilsLogger.warning(message: () -> String?) {
+    if (isWarningEnabled) warning(message())
+}
+
+public inline fun UtilsLogger.warning(message: () -> String?, e: Throwable?) {
+    if (isWarningEnabled) warning(message(), e)
+}
+
+public inline fun UtilsLogger.error(message: () -> String?) {
+    if (isErrorEnabled) error(message())
+}
+
+public inline fun UtilsLogger.error(message: () -> String?, e: Throwable?) {
+    if (isErrorEnabled) error(message(), e)
+}
+
+@TestOnly
+public open class SimpleUtilsLogger
+@TestOnly
+public constructor() : UtilsLogger {
+    override var isVerboseEnabled: Boolean = true
+    override var isDebugEnabled: Boolean = true
+    override var isInfoEnabled: Boolean = true
+    override var isWarningEnabled: Boolean = true
+    override var isErrorEnabled: Boolean = true
+
+    override fun verbose(message: String?, e: Throwable?) {
+        if (!isVerboseEnabled) return
+        println("[V] $message")
+        e?.printStackTrace()
+    }
+
+    override fun debug(message: String?, e: Throwable?) {
+        if (!isDebugEnabled) return
+        println("[D] $message")
+        e?.printStackTrace()
+    }
+
+    override fun info(message: String?, e: Throwable?) {
+        if (!isInfoEnabled) return
+        println("[I] $message")
+        e?.printStackTrace()
+    }
+
+    override fun warning(message: String?, e: Throwable?) {
+        if (!isWarningEnabled) return
+        println("[W] $message")
+        e?.printStackTrace()
+    }
+
+    override fun error(message: String?, e: Throwable?) {
+        if (!isErrorEnabled) return
+        println("[E] $message")
+        e?.printStackTrace()
+    }
+}

mirai-core-utils/src/commonMain/kotlin/channels/ChannelState.kt

@@ -7,16 +7,18 @@
  * https://github.com/mamoe/mirai/blob/dev/LICENSE
  */
 
-package net.mamoe.mirai.internal.network.auth
+package net.mamoe.mirai.utils.channels
 
 import kotlinx.coroutines.CompletableDeferred
 import kotlinx.coroutines.Deferred
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.Job
 import kotlin.coroutines.CoroutineContext
 
 /**
  * Producer states.
  */
-internal sealed interface ProducerState<T, V> {
+internal sealed interface ChannelState<T, V> {
     /*
      * 可变更状态的函数: [emit], [receiveOrNull], [expectMore], [finish], [finishExceptionally]
      * 
@@ -31,11 +33,6 @@ internal sealed interface ProducerState<T, V> {
      *                                         |
      *                                         | 调用 [expectMore]
      *                                         |
-     *                                         V 
-     *                                  CreatingProducer 
-     *                                         |
-     *                                         | 
-     *                                         |                                                     
      *                                         V                                                      
      *                                   ProducerReady (从此用户协程作为 producer 在后台运行)             
      *                                         |                                                      
@@ -96,63 +93,65 @@ internal sealed interface ProducerState<T, V> {
      */
     abstract override fun toString(): String
 
-    class JustInitialized<T, V> : ProducerState<T, V> {
+    class JustInitialized<T, V> : ChannelState<T, V> {
         override fun toString(): String = "JustInitialized"
     }
 
-    sealed interface HasProducer<T, V> : ProducerState<T, V> {
-        val producer: OnDemandProducerScope<T, V>
-    }
-
-    // This is need — to ensure [launchProducer] is called exactly once.
-    class CreatingProducer<T, V>(
-        launchProducer: () -> OnDemandProducerScope<T, V>
-    ) : HasProducer<T, V> {
-        override val producer: OnDemandProducerScope<T, V> by lazy(launchProducer)
-        override fun toString(): String = "CreatingProducer"
+    sealed interface HasProducer<T, V> : ChannelState<T, V> {
+        val producer: OnDemandSendChannel<T, V>
     }
 
+    // Producer is not running until `expectMore`. `emit` and `receiveOrNull` not allowed.
     class ProducerReady<T, V>(
-        override val producer: OnDemandProducerScope<T, V>,
+        launchProducer: () -> OnDemandSendChannel<T, V>,
     ) : HasProducer<T, V> {
+        // Lazily start the producer job since it's on-demand
+        override val producer: OnDemandSendChannel<T, V> by lazy(launchProducer) // `lazy` is synchronized
+
         override fun toString(): String = "ProducerReady"
     }
 
+    // Producer is running. `emit` and `receiveOrNull` both allowed.
     class Producing<T, V>(
-        override val producer: OnDemandProducerScope<T, V>,
-        val deferred: CompletableDeferred<V>,
+        override val producer: OnDemandSendChannel<T, V>,
+        parentJob: Job,
     ) : HasProducer<T, V> {
+        val deferred: CompletableDeferred<V> by lazy { CompletableDeferred<V>(parentJob) }
+
         override fun toString(): String = "Producing(deferred.completed=${deferred.isCompleted})"
     }
 
+    // Producer is suspended because it called `emit`. Expecting `receiveOrNull`.
     class Consuming<T, V>(
-        override val producer: OnDemandProducerScope<T, V>,
+        override val producer: OnDemandSendChannel<T, V>,
         val value: Deferred<V>,
         parentCoroutineContext: CoroutineContext,
     ) : HasProducer<T, V> {
-        val producerLatch = Latch<T>(parentCoroutineContext)
+        val producerLatch: CompletableDeferred<T> = CompletableDeferred(parentCoroutineContext[Job])
 
         override fun toString(): String {
+            @OptIn(ExperimentalCoroutinesApi::class)
             val completed =
                 value.runCatching { getCompleted().toString() }.getOrNull() // getCompleted() is experimental
             return "Consuming(value=$completed)"
         }
     }
 
+    // Producer is suspended. `expectMore` will resume producer with a ticket.
     class Consumed<T, V>(
-        override val producer: OnDemandProducerScope<T, V>,
-        val producerLatch: Latch<T>
+        override val producer: OnDemandSendChannel<T, V>,
+        val producerLatch: CompletableDeferred<T>
     ) : HasProducer<T, V> {
         override fun toString(): String = "Consumed($producerLatch)"
     }
 
     class Finished<T, V>(
-        val previousState: ProducerState<T, V>,
+        private val previousState: ChannelState<T, V>,
         val exception: Throwable?,
-    ) : ProducerState<T, V> {
-        val isSuccess get() = exception == null
+    ) : ChannelState<T, V> {
+        val isSuccess: Boolean get() = exception == null
 
-        fun createAlreadyFinishedException(cause: Throwable?): IllegalProducerStateException {
+        fun createAlreadyFinishedException(cause: Throwable?): IllegalChannelStateException {
             val exception = exception
             val causeMessage = if (cause == null) {
                 ""
@@ -160,13 +159,13 @@ internal sealed interface ProducerState<T, V> {
                 ", but attempting to finish with the cause $cause"
             }
             return if (exception == null) {
-                IllegalProducerStateException(
+                IllegalChannelStateException(
                     this,
                     "Producer has already finished normally$causeMessage. Previous state was: $previousState",
                     cause = cause
                 )
             } else {
-                IllegalProducerStateException(
+                IllegalChannelStateException(
                     this,
                     "Producer has already finished with the suppressed exception$causeMessage. Previous state was: $previousState",
                     cause = cause

mirai-core-utils/src/commonMain/kotlin/channels/IllegalChannelStateException.kt

@@ -0,0 +1,19 @@
+/*
+ * Copyright 2019-2023 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.utils.channels
+
+// An internal error exception
+public class IllegalChannelStateException internal constructor(
+    private val state: ChannelState<*, *>,
+    message: String? = state.toString(),
+    cause: Throwable? = null,
+) : IllegalStateException(message, cause) {
+    public val lastStateWasSucceed: Boolean get() = (state is ChannelState.Finished) && state.isSuccess
+}

mirai-core-utils/src/commonMain/kotlin/channels/OnDemandChannelImpl.kt

@@ -0,0 +1,235 @@
+/*
+ * Copyright 2019-2023 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.utils.channels
+
+import kotlinx.atomicfu.AtomicRef
+import kotlinx.atomicfu.atomic
+import kotlinx.atomicfu.loop
+import kotlinx.coroutines.*
+import net.mamoe.mirai.utils.TestOnly
+import net.mamoe.mirai.utils.UtilsLogger
+import net.mamoe.mirai.utils.childScope
+import net.mamoe.mirai.utils.debug
+import kotlin.coroutines.CoroutineContext
+
+
+internal class CoroutineOnDemandReceiveChannel<T, V>(
+    parentCoroutineContext: CoroutineContext,
+    private val logger: UtilsLogger,
+    private val producerCoroutine: suspend OnDemandSendChannel<T, V>.(initialTicket: T) -> Unit,
+) : OnDemandReceiveChannel<T, V> {
+    private val coroutineScope = parentCoroutineContext.childScope("CoroutineOnDemandReceiveChannel")
+
+    @TestOnly
+    internal fun getScope() = coroutineScope
+
+    private val state: AtomicRef<ChannelState<T, V>> = atomic(ChannelState.JustInitialized())
+
+    @TestOnly
+    internal fun getState() = state.value
+
+
+    inner class Producer(
+        private val initialTicket: T,
+    ) : OnDemandSendChannel<T, V> {
+        init {
+            // `UNDISPATCHED` with `yield()`: start the coroutine immediately in current thread,
+            // attaching Job to the coroutineScope, then `yield` the thread back, to complete `launch`.
+            coroutineScope.launch(start = CoroutineStart.UNDISPATCHED) {
+                yield()
+
+                try {
+                    producerCoroutine(initialTicket)
+                } catch (e: Throwable) {
+                    // close exceptionally
+                    val r = emitImpl(Result.failure(e))
+                    check(r == null) // assertion
+                    return@launch
+                }
+
+                close()
+            }
+        }
+
+        override suspend fun emit(value: V): T = emitImpl(Result.success(value))!!
+
+        private suspend inline fun emitImpl(value: Result<V>): T? {
+            state.loop { state ->
+                when (state) {
+                    is ChannelState.Finished -> {
+                        if (value.isFailure) {
+                            return null
+                        } else {
+                            throw state.createAlreadyFinishedException(null)
+                        }
+                    }
+
+                    is ChannelState.Producing -> {
+                        val deferred = state.deferred
+                        val consumingState = ChannelState.Consuming(
+                            state.producer,
+                            state.deferred,
+                            coroutineScope.coroutineContext
+                        )
+                        if (compareAndSetState(state, consumingState)) {
+                            deferred.completeWith(value) // produce a value
+                            return consumingState.producerLatch.await() // wait for producer to consume the previous value.
+                        }
+                        // failed race, try again
+                    }
+
+                    is ChannelState.ProducerReady -> {
+                        // This implies another coroutine is running `expectMore`,
+                        // and we are a bit faster than it!
+                        setStateProducing(state)
+                    }
+
+                    else -> throw IllegalChannelStateException(
+                        state,
+                        if (value.isFailure)
+                            "Producer threw an exception (see cause), so completing with the exception, but current state is not Producing"
+                        else "Producer is emitting an value, but current state is not Producing",
+                        value.exceptionOrNull()
+                    )
+
+                }
+            }
+        }
+    }
+
+    private fun setStateProducing(state: ChannelState.ProducerReady<T, V>): Boolean {
+        return compareAndSetState(state, ChannelState.Producing(state.producer, coroutineScope.coroutineContext.job))
+    }
+
+    private fun setStateFinished(
+        currState: ChannelState<T, V>,
+        message: String,
+        exception: ProducerFailureException?
+    ): Boolean {
+        if (compareAndSetState(currState, ChannelState.Finished(currState, exception))) {
+            val cancellationException = CancellationException(message, exception)
+            coroutineScope.cancel(cancellationException)
+            return true
+        }
+        return false
+    }
+
+    private fun compareAndSetState(state: ChannelState<T, V>, newState: ChannelState<T, V>): Boolean {
+        return this.state.compareAndSet(state, newState).also {
+            logger.debug { "CAS: $state -> $newState: $it" }
+        }
+    }
+
+    override val isClosed: Boolean
+        get() = state.value is ChannelState.Finished
+
+    override suspend fun receiveOrNull(): V? {
+        // don't use atomicfu `.loop`:
+        // java.lang.VerifyError: Bad type on operand stack	
+        //     net/mamoe/mirai/utils/channels/CoroutineOnDemandReceiveChannel.receiveOrNull(Lkotlin/coroutines/Continuation;)Ljava/lang/Object; @103: getfield	
+
+        while (true) {
+            when (val state = state.value) {
+                is ChannelState.Consuming -> {
+                    // value is ready, now we try to consume the value
+
+                    if (compareAndSetState(state, ChannelState.Consumed(state.producer, state.producerLatch))) {
+                        // value is now reserved for us, no contention is possible, safe to retrieve
+
+                        // This actually won't suspend (there are tests ensuring this point), 
+                        // since the value is already completed.
+                        // Just to be error-tolerating and re-throwing exceptions. 
+                        // (Also because `Deferred.getCompleted()` is not stable yet (coroutines 1.6))
+                        return awaitValueSafe(state.value)
+                    }
+                }
+
+                // note: actually, this case should be the first case (for code consistency) in `when`, 
+                // but atomicfu 1.8.10 fails on this.
+                is ChannelState.Producing<T, V> -> {
+                    // still producing value
+
+                    // Wait for value and throw exception caused by the producer if there is one.
+                    awaitValueSafe(state.deferred) // this may or may not suspend.
+
+                    // Now deferred is complete, and we will be in the Consuming state, but we can't use the value here.
+                    // We must ensure only one thread gets the value, and state should then be Consumed
+
+                    // So we loop again and do this in the Consuming state.
+                }
+
+                is ChannelState.Finished -> {
+                    // see public API docs for behavior
+                    return null
+                }
+
+                else ->
+                    // internal error 
+                    throw IllegalChannelStateException(state)
+            }
+        }
+    }
+
+    private suspend inline fun awaitValueSafe(deferred: Deferred<V>) = try {
+        deferred.await()
+    } catch (e: Throwable) {
+        // Producer failed to produce the previous value with exception
+        val producerFailureException = ProducerFailureException(cause = e)
+        setStateFinished(
+            this.state.value,
+            "OnDemandChannel is closed because producer failed to produce value, see cause",
+            producerFailureException
+        )
+        throw producerFailureException
+    }
+
+    override fun expectMore(ticket: T): Boolean {
+        state.loop { state ->
+            when (state) {
+                is ChannelState.JustInitialized -> {
+                    // start producer atomically
+                    val ready = ChannelState.ProducerReady { Producer(ticket) }
+                    compareAndSetState(state, ready)
+                    // loop again
+                }
+
+                is ChannelState.ProducerReady -> {
+                    if (setStateProducing(state)) {
+                        return true
+                    }
+                    // lost race, try again
+                }
+
+                is ChannelState.Producing,
+                is ChannelState.Consuming -> throw IllegalChannelStateException(state) // a value is already ready
+
+                is ChannelState.Consumed -> {
+                    if (compareAndSetState(state, ChannelState.ProducerReady { state.producer })) {
+                        // wake up producer async.
+                        state.producerLatch.complete(ticket)
+                        // loop again to switch state atomically to Producing. 
+                        // Do not do switch state directly here — async producer may race with you! 
+                    }
+                }
+
+                is ChannelState.Finished -> return false
+            }
+        }
+    }
+
+    override fun close() {
+        state.loop { state ->
+            when (state) {
+                is ChannelState.Finished -> return
+                else -> if (setStateFinished(state, "OnDemandChannel is closed normally", null)) return
+            }
+        }
+    }
+}

mirai-core-utils/src/commonMain/kotlin/channels/OnDemandSendChannel.kt

@@ -0,0 +1,111 @@
+/*
+ * Copyright 2019-2023 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.utils.channels
+
+import kotlinx.coroutines.Deferred
+import kotlinx.coroutines.Job
+import kotlinx.coroutines.channels.ReceiveChannel
+import kotlinx.coroutines.channels.SendChannel
+import net.mamoe.mirai.utils.UtilsLogger
+import kotlin.coroutines.Continuation
+import kotlin.coroutines.CoroutineContext
+import kotlin.coroutines.EmptyCoroutineContext
+import kotlin.coroutines.cancellation.CancellationException
+
+/**
+ * 按需供给的 [SendChannel].
+ *
+ * @param T 令牌类型.
+ * @param V 值类型.
+ */
+public interface OnDemandSendChannel<T, V> {
+    /**
+     * 挂起协程, 直到 [OnDemandReceiveChannel] [期望接收][OnDemandReceiveChannel.receiveOrNull]一个 [V],
+     * 届时将 [value] 传递给 [OnDemandReceiveChannel.receiveOrNull], 成为其返回值.
+     *
+     * 若在调用 [emit] 时已经有 [OnDemandReceiveChannel.receiveOrNull] 正在等待, 则该协程会立即[恢复][Continuation.resumeWith], [emit] 不会挂起.
+     *
+     * 若 [OnDemandReceiveChannel] 已经[完结][OnDemandReceiveChannel.close], [OnDemandSendChannel.emit] 会抛出 [IllegalChannelStateException].
+     *
+     * @see OnDemandReceiveChannel.receiveOrNull
+     *
+     * @param value 需要传递给 [OnDemandReceiveChannel.receiveOrNull] 的值
+     * @return 下一个 ticket [T].
+     *
+     * @throws CancellationException 当此协程被取消时抛出
+     */
+    public suspend fun emit(value: V): T
+}
+
+
+/**
+ * 线程安全的按需接收通道.
+ *
+ * 与 [ReceiveChannel] 不同, [OnDemandReceiveChannel] 只有在调用 [expectMore] 后才会让[生产者][OnDemandSendChannel] 开始生产下一个 [V].
+ */
+public interface OnDemandReceiveChannel<T, V> {
+    /**
+     * 当此 [OnDemandReceiveChannel] 已经关闭, 即不再期望更多值时返回 `true`,
+     * 无论是调用了 [close] (主动关闭) 还是 [OnDemandSendChannel] 没有更多值了 (被动关闭).
+     */
+    public val isClosed: Boolean
+
+    /**
+     * 尝试从 [OnDemandSendChannel] [接收][OnDemandSendChannel.emit]一个 [V].
+     * 当且仅当在 [OnDemandSendChannel] 已经正常结束时返回 `null`.
+     *
+     * 若目前已有 [V], 此函数立即返回该 [V], 不会挂起.
+     * 否则, 此函数将会挂起直到 [OnDemandSendChannel.emit].
+     *
+     * 当此函数被多个协程 (线程) 同时调用时, 只有一个协程会获得 [V], 其他协程将会挂起.
+     *
+     * 若在等待过程中 [OnDemandSendChannel] 异常结束,
+     * 本函数会立即恢复并抛出 [ProducerFailureException], 其 `cause` 为令 [OnDemandSendChannel] 的异常.
+     *
+     * 此挂起函数可被取消.
+     * 如果在此函数挂起时当前协程的 [Job] 被取消或完结, 此函数会立即恢复并抛出 [CancellationException]. 此行为与 [Deferred.await] 相同.
+     *
+     * @throws ProducerFailureException 当 [OnDemandSendChannel] 产生了一个异常时抛出.
+     * @throws CancellationException 当协程被取消时抛出
+     * @throws IllegalChannelStateException 当状态异常, 如未调用 [expectMore] 时抛出
+     */
+    @Throws(ProducerFailureException::class, CancellationException::class)
+    public suspend fun receiveOrNull(): V?
+
+    /**
+     * 期待 [OnDemandSendChannel] 再生产一个 [V].
+     * 期望生产后必须在之后调用 [receiveOrNull] 或 [close] 来消耗生产的 [V].
+     * 不可连续重复调用 [expectMore].
+     *
+     * 在成功发起期待后返回 `true`; 在 [OnDemandSendChannel] 已经[完结][OnDemandSendChannel.finish] 时返回 `false`.
+     *
+     * @throws IllegalChannelStateException 当 [expectMore] 被调用后, 没有调用 [receiveOrNull] 就又调用了 [expectMore] 时抛出
+     */
+    public fun expectMore(ticket: T): Boolean
+
+    /**
+     * 标记此 [OnDemandSendChannel] 已经不再需要更多的值.
+     *
+     * 如果 [OnDemandSendChannel] 仍在运行 (无论是挂起中还是正在计算下一个值), 都会正常地[取消][Job.cancel] [OnDemandSendChannel].
+     *
+     * 若此 [OnDemandSendChannel] 已经被关闭, 则此函数不会进行任何操作.
+     *
+     * 在 [close] 之后若尝试调用 [OnDemandSendChannel.emit], [OnDemandReceiveChannel.receiveOrNull] 或 [OnDemandReceiveChannel.expectMore] 都会导致 [IllegalStateException].
+     */
+    public fun close()
+}
+
+@Suppress("FunctionName")
+public fun <T, V> OnDemandChannel(
+    parentCoroutineContext: CoroutineContext = EmptyCoroutineContext,
+    logger: UtilsLogger = UtilsLogger.noop(),
+    producerCoroutine: suspend OnDemandSendChannel<T, V>.(initialTicket: T) -> Unit,
+): OnDemandReceiveChannel<T, V> = CoroutineOnDemandReceiveChannel(parentCoroutineContext, logger, producerCoroutine)
+

mirai-core-utils/src/commonMain/kotlin/channels/ProducerFailureException.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019-2023 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.utils.channels
+
+public class ProducerFailureException(
+    override val message: String? = "Producer failed to produce a value, see cause",
+    override var cause: Throwable?
+) : Exception() {
+    private val unwrapped: Throwable by lazy {
+        val cause = cause ?: return@lazy this
+        this.cause = null
+        cause.also { addSuppressed(this) }
+    }
+
+    public fun unwrap(): Throwable = unwrapped
+}

mirai-core-utils/src/commonTest/kotlin/net/mamoe/mirai/utils/channels/OnDemandChannelTest.kt

@@ -0,0 +1,334 @@
+/*
+ * Copyright 2019-2023 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.utils.channels
+
+import kotlinx.coroutines.*
+import kotlinx.coroutines.test.runTest
+import net.mamoe.mirai.utils.AtomicBoolean
+import net.mamoe.mirai.utils.testFramework.assertCoroutineSuspends
+import net.mamoe.mirai.utils.testFramework.assertNoCoroutineSuspension
+import kotlin.test.*
+
+
+class OnDemandChannelTest {
+    ///////////////////////////////////////////////////////////////////////////
+    // CoroutineScope lifecycle
+    ///////////////////////////////////////////////////////////////////////////
+
+    @Test
+    fun attachScopeJob() {
+        val job = SupervisorJob()
+        val channel = OnDemandChannel<Int, Int>(job) {
+            fail()
+        }
+        assertEquals(1, job.children.toList().size)
+        channel.close()
+    }
+
+    @Test
+    fun finishAfterInstantiation() {
+        val supervisor = SupervisorJob()
+        val channel = OnDemandChannel<Int, Int>(supervisor) {
+            fail("ran")
+        }
+        assertEquals(1, supervisor.children.toList().size)
+        val job = supervisor.children.single()
+        assertEquals(true, job.isActive)
+
+        channel.close()
+
+        assertEquals(0, supervisor.children.toList().size)
+        assertEquals(false, job.isActive)
+    }
+
+    @Test
+    fun `cancel producer job on finish`() = runTest {
+        // Actually, this case won't happen, because producer coroutine will be cancelled on [finish]
+
+        lateinit var job: Job
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            job = currentCoroutineContext()[Job]!!
+            emit(1)
+            emit(1)
+            emit(1)
+            emit(1)
+            fail()
+        }
+
+        channel.expectMore(1)
+        channel.receiveOrNull()
+        assertTrue { job.isActive }
+        channel.close()
+        assertFalse { job.isActive }
+        yield()
+    }
+
+    ///////////////////////////////////////////////////////////////////////////
+    // Producer Coroutine — Tickets
+    ///////////////////////////////////////////////////////////////////////////
+
+    @Test
+    fun `producer receives initial ticket`() = runTest {
+        val channel = OnDemandChannel(currentCoroutineContext()) { initialTicket ->
+            assertEquals(1, initialTicket)
+            emit(2)
+        }
+
+        channel.expectMore(1)
+        channel.receiveOrNull()
+
+        channel.close()
+    }
+
+    @Test
+    fun `producer receives second ticket`() = runTest {
+        val channel = OnDemandChannel(currentCoroutineContext()) { initialTicket ->
+            assertEquals(1, initialTicket)
+            assertEquals(2, emit(3))
+        }
+
+        channel.expectMore(1)
+        channel.receiveOrNull()
+        channel.expectMore(2)
+
+        channel.close()
+    }
+
+    @Test
+    fun `producer receives third ticket`() = runTest {
+        val channel = OnDemandChannel(currentCoroutineContext()) { initialTicket ->
+            assertEquals(1, initialTicket)
+            assertEquals(2, emit(4))
+            assertEquals(3, emit(5))
+        }
+
+        channel.expectMore(1)
+        channel.receiveOrNull()
+        channel.expectMore(2)
+        channel.receiveOrNull()
+        channel.expectMore(3)
+
+        channel.close()
+    }
+
+    ///////////////////////////////////////////////////////////////////////////
+    // Consumer — Receive Correct Values
+    ///////////////////////////////////////////////////////////////////////////
+
+    @Test
+    fun `receives correct first value`() = runTest {
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            emit(3)
+        }
+
+        channel.expectMore(1)
+        assertEquals(3, channel.receiveOrNull())
+        channel.close()
+    }
+
+    @Test
+    fun `receives correct second value`() = runTest {
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            emit(3)
+            emit(4)
+        }
+
+        channel.expectMore(1)
+        assertEquals(3, channel.receiveOrNull())
+        channel.expectMore(2)
+        assertEquals(4, channel.receiveOrNull())
+        channel.close()
+    }
+
+    ///////////////////////////////////////////////////////////////////////////
+    // expectMore/emit/receiveOrNull
+    ///////////////////////////////////////////////////////////////////////////
+
+    @Test
+    fun `producer coroutine won't start until expectMore`() {
+        val channel = OnDemandChannel<Int, Int> {
+            fail()
+        }
+        channel.close()
+    }
+
+    @Test
+    fun `producer coroutine starts iff expectMore`() = runTest {
+        var started = false
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            // (1)
+            assertEquals(false, started)
+            started = true
+            yield() // goto (2)
+            fail()
+        }
+        assertFalse { started }
+        assertTrue { channel.expectMore(1) } // launches the job, but it won't execute due to single parallelism
+        yield() // goto (1)
+        // (2)
+        assertTrue { started }
+        channel.close()
+    }
+
+    @Test
+    fun `receiveOrNull does not suspend if value is ready`() = runTest {
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            emit(1)
+        }
+
+        assertTrue { channel.expectMore(1) }
+        yield() // run `emit`
+        // now value is ready
+        assertNoCoroutineSuspension { channel.receiveOrNull() }
+        channel.close()
+    }
+
+    @Test
+    fun `receiveOrNull does suspend if value is not ready`() = runTest {
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            yield()
+            emit(1)
+        }
+
+        assertTrue { channel.expectMore(1) }
+        assertCoroutineSuspends { channel.receiveOrNull() }
+        channel.close()
+    }
+
+    @Test
+    fun `emit won't resume unless another expectMore`() = runTest {
+        val canResume = AtomicBoolean(false)
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            emit(1)
+
+            if (!canResume.value) fail("Emit should not resume")
+
+            canResume.value = false
+        }
+
+        channel.expectMore(1)
+        channel.receiveOrNull()
+        canResume.value = true
+        channel.expectMore(2)
+        yield() // run producer
+        assertEquals(false, canResume.value)
+        channel.close()
+    }
+
+    ///////////////////////////////////////////////////////////////////////////
+    // Operation while already finished
+    ///////////////////////////////////////////////////////////////////////////
+
+    @Test
+    fun `expectMore and receiveOrNull while already finished just after instantiation`() = runTest {
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            fail("Producer should not run")
+        }
+        channel.close()
+
+        assertFalse { channel.expectMore(1) }
+        assertNull(channel.receiveOrNull())
+        assertFalse { channel.expectMore(1) }
+        assertFalse { channel.expectMore(1) }
+        assertNull(channel.receiveOrNull())
+        assertNull(channel.receiveOrNull())
+    }
+
+    @Test
+    fun `expectMore and receiveOrNull while already finished`() = runTest {
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            emit(1)
+        }
+
+        assertTrue { channel.expectMore(1) }
+        assertNotNull(channel.receiveOrNull())
+        assertFalse { channel.isClosed }
+
+        assertTrue { channel.expectMore(1) } // `expectMore` don't know if more values are available
+        yield() // go to producer
+        // now we must know producer has no more value
+        assertTrue { channel.isClosed }
+        assertNull(channel.receiveOrNull())
+        assertFalse { channel.expectMore(1) }
+        assertNull(channel.receiveOrNull())
+        assertFalse { (channel as CoroutineOnDemandReceiveChannel).getScope().isActive }
+    }
+
+    @Test
+    fun `emit while already finished`() {
+        // Actually, this case won't happen, because producer coroutine will be cancelled on [finish]
+
+        `cancel producer job on finish`()
+    }
+
+
+    @Test
+    fun `producer exception closes channel then receiveOrNull throws`() = runTest {
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            throw NoSuchElementException("Oops")
+        }
+
+        assertTrue { channel.expectMore(1) }
+        assertFalse { channel.isClosed }
+        assertIs<ChannelState.Producing<*, *>>(channel.state)
+        assertFailsWith<ProducerFailureException> {
+            println(channel.receiveOrNull())
+        }.also {
+            assertIs<NoSuchElementException>(it.cause)
+        }
+        assertTrue { channel.isClosed }
+
+        // The exception looks like this. 
+        // The first cause is stacktrace-recovered by coroutines, and the second is the original one. 
+
+        //net.mamoe.mirai.utils.channels.ProducerFailureException: Producer failed to produce a value, see cause
+        //	at net.mamoe.mirai.utils.channels.CoroutineOnDemandReceiveChannel.receiveOrNull(OnDemandChannelImpl.kt:164)
+        //	at net.mamoe.mirai.utils.channels.CoroutineOnDemandReceiveChannel$receiveOrNull$1.invokeSuspend(OnDemandChannelImpl.kt)
+        //	at kotlin.coroutines.jvm.internal.BaseContinuationImpl.resumeWith(ContinuationImpl.kt:33)
+        //	at kotlinx.coroutines.test.TestBuildersKt.runTest$default(Unknown Source)
+        //	at net.mamoe.mirai.utils.channels.OnDemandChannelTest.producer exception(OnDemandChannelTest.kt:273)
+        //	at worker.org.gradle.process.internal.worker.GradleWorkerMain.main(GradleWorkerMain.java:74)
+        //Caused by: java.util.NoSuchElementException: Oops
+        //	at net.mamoe.mirai.utils.channels.OnDemandChannelTest$producer exception$1$channel$1.invokeSuspend(OnDemandChannelTest.kt:275)
+        //	at net.mamoe.mirai.utils.channels.OnDemandChannelTest$producer exception$1$channel$1.invoke(OnDemandChannelTest.kt)
+        //	at net.mamoe.mirai.utils.channels.OnDemandChannelTest$producer exception$1$channel$1.invoke(OnDemandChannelTest.kt)
+        //	at net.mamoe.mirai.utils.channels.CoroutineOnDemandReceiveChannel$Producer$1.invokeSuspend(OnDemandChannelImpl.kt:46)
+        //	(Coroutine boundary)
+        //	at net.mamoe.mirai.utils.channels.CoroutineOnDemandReceiveChannel.receiveOrNull(OnDemandChannelImpl.kt:162)
+        //	at net.mamoe.mirai.utils.channels.OnDemandChannelTest$producer exception$1.invokeSuspend(OnDemandChannelTest.kt:280)
+        //	at kotlinx.coroutines.test.TestBuildersKt__TestBuildersKt$runTestCoroutine$2.invokeSuspend(TestBuilders.kt:212)
+        //Caused by: java.util.NoSuchElementException: Oops
+        //  ...
+    }
+
+
+    @Test
+    fun `producer exception closes channel then receiveOrNull throws in Producing state`() = runTest {
+        val channel = OnDemandChannel<Int, Int>(currentCoroutineContext()) {
+            throw NoSuchElementException("Oops")
+        }
+
+        assertTrue { channel.expectMore(1) }
+        yield() // fail the channel first
+        assertIs<ChannelState.Consuming<*, *>>(channel.state)
+        assertFalse { channel.isClosed } // channel won't close until receiveOrNull
+
+        assertFailsWith<ProducerFailureException> {
+            println(channel.receiveOrNull())
+        }.also {
+            assertIs<NoSuchElementException>(it.cause)
+        }
+        assertTrue { channel.isClosed }
+    }
+}
+
+
+private val <T, V> OnDemandReceiveChannel<T, V>.state
+    get() = (this as CoroutineOnDemandReceiveChannel<T, V>).getState() 

mirai-core-utils/src/commonTest/kotlin/net/mamoe/mirai/utils/testFramework/AssertNoCoroutineSuspension.kt

@@ -0,0 +1,101 @@
+/*
+ * Copyright 2019-2023 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.utils.testFramework
+
+import kotlinx.coroutines.*
+import kotlinx.coroutines.test.runTest
+import kotlin.contracts.InvocationKind
+import kotlin.contracts.contract
+import kotlin.coroutines.resume
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertFails
+import kotlin.test.fail
+
+suspend inline fun <R> assertNoCoroutineSuspension(
+    crossinline block: suspend () -> R,
+): R {
+    contract { callsInPlace(block, InvocationKind.EXACTLY_ONCE) }
+    return withContext(Dispatchers.Default.limitedParallelism(1)) {
+        val job = launch(start = CoroutineStart.UNDISPATCHED) {
+            yield()
+            fail("Expected no coroutine suspension")
+        }
+        val ret = block()
+        job.cancel()
+        ret
+    }
+}
+
+/**
+ * Executes [block], and asserts there happens at least one coroutine suspension in [block].
+ *
+ * When the first coroutine suspension happens, [onSuspend] will be called.
+ */
+@OptIn(ExperimentalStdlibApi::class)
+suspend inline fun <R> assertCoroutineSuspends(
+    noinline onSuspend: (suspend () -> Unit)? = null,
+    crossinline block: suspend () -> R,
+): R {
+    contract { callsInPlace(block, InvocationKind.EXACTLY_ONCE) }
+
+    val dispatcher = currentCoroutineContext()[CoroutineDispatcher] ?: Dispatchers.Main.limitedParallelism(1)
+    return withContext(dispatcher.limitedParallelism(1)) {
+        val job = launch(start = CoroutineStart.UNDISPATCHED) {
+            yield() // goto block
+            onSuspend?.invoke()
+        }
+        val ret = block()
+        kotlin.test.assertTrue("Expected coroutine suspension") { job.isCompleted }
+        job.cancel()
+        ret
+    }
+}
+
+class AssertCoroutineSuspensionTest {
+    @Test
+    fun `assertNoCoroutineSuspension no suspension`() = runTest {
+        assertNoCoroutineSuspension {}
+    }
+
+    @Test
+    fun `assertNoCoroutineSuspension suspend cancellable`() = runTest {
+        assertFails {
+            assertNoCoroutineSuspension {
+                suspendCancellableCoroutine<Unit> { }
+            }
+        }.run {
+            assertEquals("Expected no coroutine suspension", message)
+        }
+    }
+
+    @Test
+    fun `assertCoroutineSuspends suspend`() = runTest {
+        assertCoroutineSuspends {
+            suspendCancellableCoroutine {
+                // resume after suspendCancellableCoroutine returns to create a suspension
+                launch(start = CoroutineStart.UNDISPATCHED) {
+                    yield()
+                    it.resume(Unit)
+                }
+            }
+        }
+    }
+
+    @Test
+    fun `assertCoroutineSuspends no suspension`() = runTest {
+        assertFails {
+            assertCoroutineSuspends {}
+        }.run {
+            assertEquals("Expected coroutine suspension", message)
+        }
+    }
+
+}

mirai-core-utils/src/jvmBaseMain/kotlin/MiraiFile.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -62,7 +62,10 @@ public actual interface MiraiFile {
         }
 
         public actual fun getWorkingDir(): MiraiFile {
-            return create(System.getProperty("user.dir"))
+            return create(
+                System.getProperty("user.dir")
+                    ?: throw IllegalStateException("System property 'user.dir' is not available")
+            )
         }
     }
 }

mirai-core-utils/src/jvmBaseMain/kotlin/Resources.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -12,5 +12,5 @@ package net.mamoe.mirai.utils
 
 @TestOnly
 public fun readResource(url: String): String =
-    Thread.currentThread().contextClassLoader.getResourceAsStream(url)?.readBytes()?.decodeToString()
+    Thread.currentThread().contextClassLoader?.getResourceAsStream(url)?.readBytes()?.decodeToString()
         ?: error("Could not find resource '$url'")

mirai-core-utils/src/jvmBaseMain/kotlin/Services.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -56,7 +56,7 @@ public actual fun <T : Any> loadService(clazz: KClass<out T>, fallbackImplementa
 
     return Services.getOverrideOrNull(clazz) ?: services
     ?: throw NoSuchElementException("Could not find an implementation for service class ${clazz.qualifiedName}").apply {
-        if (suppressed != null) addSuppressed(suppressed)
+        if (suppressed != null) addSuppressed(suppressed!!)
     }
 }
 

mirai-core-utils/src/jvmBaseMain/kotlin/ThreadLocal.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -18,4 +18,5 @@ public fun <T : Any?> threadLocal(newInstance: () -> T): ThreadLocal<T> {
     }
 }
 
-public operator fun <T> ThreadLocal<T>.getValue(t: Any?, property: KProperty<Any?>): T = this.get()
+public operator fun <T> ThreadLocal<T>.getValue(t: Any?, property: KProperty<Any?>): T =
+    this.get() as T // `get()` is from Java and has type of `T!`

mirai-core-utils/src/main/AndroidManifest.xml

@@ -1,14 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!--
-  ~ Copyright 2019-2020 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/master/LICENSE
-  -->
-
-<manifest package="net.mamoe.mirai" xmlns:android="http://schemas.android.com/apk/res/android">
-    <uses-permission android:name="android.permission.READ_PHONE_STATE"/>
-    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
-</manifest>

mirai-core/build.gradle.kts

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -12,10 +12,12 @@
 import BinaryCompatibilityConfigurator.configureBinaryValidators
 import org.jetbrains.kotlin.gradle.plugin.mpp.AbstractNativeLibrary
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
+import shadow.relocateCompileOnly
+import shadow.relocateImplementation
 
 plugins {
     kotlin("multiplatform")
-    // id("kotlinx-atomicfu")
+    id("kotlinx-atomicfu")
     kotlin("plugin.serialization")
     id("me.him188.kotlin-jvm-blocking-bridge")
     id("me.him188.kotlin-dynamic-delegation")
@@ -27,8 +29,9 @@ description = "Mirai Protocol implementation for QQ Android"
 
 kotlin {
     explicitApi()
+    apply(plugin = "explicit-api")
 
-    configureJvmTargetsHierarchical()
+    configureJvmTargetsHierarchical("net.mamoe.mirai.internal")
     configureNativeTargetsHierarchical(project)
     configureNativeTargetBinaries(project) // register native binaries for mirai-core only
 
@@ -46,6 +49,9 @@ kotlin {
                 implementation(`kotlinx-serialization-protobuf`)
                 implementation(`kotlinx-atomicfu`)
 
+                // runtime from mirai-core-utils
+                relocateCompileOnly(`ktor-io_relocated`)
+
 //                relocateImplementation(`ktor-http_relocated`)
 //                relocateImplementation(`ktor-serialization_relocated`)
 //                relocateImplementation(`ktor-websocket-serialization_relocated`)
@@ -76,15 +82,23 @@ kotlin {
 
         findByName("androidMain")?.apply {
             dependencies {
-                compileOnly(`android-runtime`)
+                if (rootProject.property("mirai.android.target.api.level")!!.toString().toInt() < 23) {
+                    // Ship with BC if we are targeting 23 or lower where AndroidKeyStore is not stable enough.
+                    // For more info, read `net.mamoe.mirai.internal.utils.crypto.EcdhAndroidKt.create` in `androidMain`.
+                    implementation(bouncycastle)
+                }
             }
         }
+
+        // For Android with JDK
         findByName("androidTest")?.apply {
             dependencies {
-                implementation(kotlin("test", Versions.kotlinCompiler))
-                implementation(kotlin("test-junit5", Versions.kotlinCompiler))
-                implementation(kotlin("test-annotations-common"))
-                implementation(kotlin("test-common"))
+                implementation(bouncycastle)
+            }
+        }
+        // For Android with SDK
+        findByName("androidUnitTest")?.apply {
+            dependencies {
                 implementation(bouncycastle)
             }
         }
@@ -118,13 +132,28 @@ kotlin {
 
 
         // Ktor
-
         findByName("commonMain")?.apply {
+            dependencies {
+                compileOnly(`ktor-io`)
+                implementation(`ktor-client-core`)
+            }
+        }
+        findByName("jvmBaseMain")?.apply {
+            // relocate for JVM like modules
             dependencies {
                 relocateCompileOnly(`ktor-io_relocated`) // runtime from mirai-core-utils
                 relocateImplementation(`ktor-client-core_relocated`)
             }
         }
+        configure(NATIVE_TARGETS.map { getByName(it + "Main") }
+                + NATIVE_TARGETS.map { getByName(it + "Test") }) {
+            // no relocation in native, include binaries
+            dependencies {
+                api(`ktor-io`) {
+                    exclude(ExcludeProperties.`slf4j-api`)
+                }
+            }
+        }
         findByName("jvmBaseMain")?.apply {
             dependencies {
                 relocateImplementation(`ktor-client-okhttp_relocated`)
@@ -188,6 +217,10 @@ kotlin {
     }
 }
 
+atomicfu {
+    transformJvm = false
+}
+
 afterEvaluate {
     val main = projectDir.resolve("src/nativeTest/kotlin/local/TestMain.kt")
     if (!main.exists()) {
@@ -222,7 +255,7 @@ if (tasks.findByName("androidMainClasses") != null) {
         group = "verification"
         this.mustRunAfter("androidMainClasses")
     }
-    tasks.getByName("androidTest").dependsOn("checkAndroidApiLevel")
+    tasks.getByName("androidBaseTest").dependsOn("checkAndroidApiLevel")
 }
 
 configureMppPublishing()
@@ -234,4 +267,4 @@ configureBinaryValidators(setOf("jvm", "android").filterTargets())
 //    developer("Mamoe Technologies", email = "support@mamoe.net", url = "https://github.com/mamoe")
 //    licenseFromGitHubProject("AGPLv3", "dev")
 //    publishPlatformArtifactsInRootModule = "jvm"
-//}
+//}

mirai-core/src/androidInstrumentedTest/kotlin/package.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -7,4 +7,4 @@
  * https://github.com/mamoe/mirai/blob/dev/LICENSE
  */
 
-package net.mameo.mirai
+package net.mamoe.mirai.internal

mirai-core/src/androidInstrumentedTest/kotlin/test/initializeTestJvm.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -9,16 +9,6 @@
 
 package net.mamoe.mirai.internal.test
 
-import kotlin.test.Test
-
-internal actual fun initPlatform() {
-    // nothing to do
-}
-
-
-internal actual class PlatformInitializationTest : AbstractTest() {
-    @Test
-    actual fun test() {
-        // nop
-    }
+internal actual fun initializeTestPlatformBeforeCommon() {
+    // nop
 }

mirai-core/src/androidInstrumentedTest/kotlin/testFramework/currentPlatform.kt

@@ -0,0 +1,12 @@
+/*
+ * Copyright 2019-2023 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.testFramework
+
+actual fun currentPlatform(): Platform = Platform.AndroidInstrumentedTest

mirai-core/src/androidMain/AndroidManifest.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+  ~ Copyright 2019-2023 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
+  -->
+
+<manifest package="net.mamoe.mirai.internal" xmlns:android="http://schemas.android.com/apk/res/android">
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

mirai-core/src/androidMain/kotlin/utils/crypto/EcdhAndroid.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -9,9 +9,14 @@
 
 package net.mamoe.mirai.internal.utils.crypto
 
+import java.security.Provider
 import java.security.Security
 
 internal actual fun Ecdh.Companion.create(): Ecdh<*, *> =
+// WARNING: If you change the SDK version checks here, 
+//          search for usages of `mirai.android.target.api.level` and see if you need to change elsewhere! 
+    //          Especially in mirai-core/build.gradle.kts (configuring bouncy-castle dependency)
+
     if (kotlin.runCatching {
             // When running tests on JVM desktop, `ClassNotFoundException` will be got
             android.os.Build.VERSION.SDK_INT >= 23
@@ -24,5 +29,9 @@ internal actual fun Ecdh.Companion.create(): Ecdh<*, *> =
         // See https://developer.android.com/training/articles/keystore#SupportedKeyPairGenerators for details
 
         // Let's use BC instead, BC is bundled into older Android
-        JceEcdhWithProvider(Security.getProvider("BC"))
+        JceEcdhWithProvider(
+            Security.getProvider("BC")
+                ?: Class.forName("org.bouncycastle.jce.provider.BouncyCastleProvider")
+                    .getConstructor().newInstance() as Provider // in tests
+        )
     }

mirai-core/src/androidTest/kotlin/android/util/Log.kt

@@ -1,127 +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_MEMBER", "INVISIBLE_REFERENCE")
-
-package android.util
-
-import net.mamoe.mirai.internal.utils.StdoutLogger
-
-// Dummy implementation for tests, since we don't have an Android SDK
-
-@Suppress("UNUSED_PARAMETER", "unused")
-object Log {
-    const val VERBOSE = 2
-    const val DEBUG = 3
-    const val INFO = 4
-    const val WARN = 5
-    const val ERROR = 6
-    const val ASSERT = 7
-
-    private val stdout = StdoutLogger("AndroidLog")
-
-    @JvmStatic
-    fun v(tag: String?, msg: String?): Int {
-        stdout.verbose(msg)
-        return 0
-    }
-
-    @JvmStatic
-    fun v(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.verbose(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun d(tag: String?, msg: String?): Int {
-        stdout.debug(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun d(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.debug(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun i(tag: String?, msg: String?): Int {
-        stdout.info(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun i(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.info(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun w(tag: String?, msg: String?): Int {
-        stdout.warning(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun w(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.warning(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun w(tag: String?, tr: Throwable?): Int {
-        stdout.warning(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun e(tag: String?, msg: String?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun e(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun wtf(tag: String?, msg: String?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun wtf(tag: String?, tr: Throwable?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun wtf(tag: String?, msg: String?, tr: Throwable?): Int {
-        stdout.error(msg, tr)
-        return 0
-    }
-
-    @JvmStatic
-    fun getStackTraceString(tr: Throwable): String {
-        return tr.stackTraceToString()
-    }
-
-    @JvmStatic
-    fun println(priority: Int, tag: String?, msg: String?): Int {
-        stdout.info(msg, tr)
-        return 0
-    }
-
-
-    private inline val tr get() = null
-    private inline val msg get() = null
-}

mirai-core/src/androidTest/kotlin/package.kt

@@ -1,10 +0,0 @@
-/*
- * 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/master/LICENSE
- */
-
-package net.mamoe.mirai.internal

mirai-core/src/androidTest/kotlin/test/initPlatform.android.kt

@@ -1,38 +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
- */
-
-package net.mamoe.mirai.internal.test
-
-import net.mamoe.mirai.utils.MiraiLogger
-import org.bouncycastle.jce.provider.BouncyCastleProvider
-import java.security.Security
-import kotlin.test.Test
-import kotlin.test.assertIs
-
-internal actual fun initPlatform() {
-    init
-}
-
-private val init: Unit by lazy {
-    if (Security.getProvider(BouncyCastleProvider.PROVIDER_NAME) != null) {
-        Security.removeProvider(BouncyCastleProvider.PROVIDER_NAME)
-    }
-    Security.addProvider(BouncyCastleProvider())
-
-    Unit
-}
-
-internal actual class PlatformInitializationTest : AbstractTest() {
-
-    @Test
-    actual fun test() {
-        @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
-        assertIs<net.mamoe.mirai.internal.utils.StdoutLogger>(MiraiLogger.Factory.create(this::class, "1"))
-    }
-}

mirai-core/src/androidUnitTest/kotlin/package.kt

@@ -0,0 +1,11 @@
+/*
+ * Copyright 2019-2023 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

mirai-core/src/androidUnitTest/kotlin/test/Logger.kt

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2019-2023 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.test
+
+import android.util.Log
+import net.mamoe.mirai.utils.MiraiLogger
+
+/**
+ * Delegate logs to stdout, since android [Log] is not mocked.
+ */
+class JvmLoggerFactory : MiraiLogger.Factory {
+    override fun create(requester: Class<*>, identity: String?): MiraiLogger {
+        @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
+        return net.mamoe.mirai.internal.utils.StdoutLogger(identity ?: requester.simpleName)
+    }
+}

mirai-core/src/androidUnitTest/kotlin/test/initializeTestJvm.kt

@@ -0,0 +1,49 @@
+/*
+ * Copyright 2019-2023 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.test
+
+import net.mamoe.mirai.internal.utils.StructureToStringTransformerNew
+import net.mamoe.mirai.utils.MiraiLogger
+import net.mamoe.mirai.utils.PlatformLogger
+import net.mamoe.mirai.utils.Services
+import org.junit.jupiter.api.Test
+import kotlin.test.assertIsNot
+
+internal actual fun initializeTestPlatformBeforeCommon() {
+    Services.register(
+        net.mamoe.mirai.utils.StructureToStringTransformer::class.qualifiedName!!,
+        StructureToStringTransformerNew::class.qualifiedName!!,
+        ::StructureToStringTransformerNew
+    )
+    Services.registerAsOverride(
+        MiraiLogger.Factory::class.qualifiedName!!,
+        "net.mamoe.mirai.utils.MiraiLogger.Factory"
+    ) {
+        JvmLoggerFactory()
+    }
+
+    // force override
+    @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
+    net.mamoe.mirai.utils.MiraiLoggerFactoryImplementationBridge.setInstance(JvmLoggerFactory())
+    @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
+    net.mamoe.mirai.utils.MiraiLoggerFactoryImplementationBridge.freeze()
+
+    println("[testFramework] Initialized loggers using JvmLoggerFactory")
+
+
+}
+
+internal class AndroidUnitTestPlatformTest : AbstractTest() {
+    @Test
+    fun usesStdoutLogger() {
+        // PlatformLogger uses android.util.Log and will fail
+        assertIsNot<PlatformLogger>(MiraiLogger.Factory.create(this::class))
+    }
+}

mirai-core/src/androidUnitTest/kotlin/testFramework/currentPlatform.kt

@@ -0,0 +1,28 @@
+/*
+ * Copyright 2019-2023 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.testFramework
+
+import net.mamoe.mirai.internal.test.AbstractTest
+import org.junit.jupiter.api.Test
+import kotlin.test.assertIs
+
+actual fun currentPlatform(): Platform = when (System.getenv("mirai.android.sdk.kind")) {
+    "jdk" -> Platform.AndroidUnitTestWithJdk
+    "adk" -> Platform.AndroidUnitTestWithAdk
+    else -> throw IllegalStateException("`mirai.android.sdk.kind` must be `jdk` or `adk`. Ensure you are running tests using Gradle test tasks.")
+}
+
+internal class AndroidUnitTestPlatformTest : AbstractTest() {
+
+    @Test
+    fun currentPlatformIsAvailable() {
+        assertIs<Platform.AndroidUnitTest>(currentPlatform())
+    }
+}

mirai-core/src/commonMain/kotlin/BotAccount.kt

@@ -17,8 +17,13 @@ import net.mamoe.mirai.utils.TestOnly
 
 internal class BotAccount(
     internal val id: Long,
-    val authorization: BotAuthorization,
+    authorization: BotAuthorization,
 ) {
+    var authorization: BotAuthorization = authorization
+        // FIXME: Making this mutable is very bad. 
+        //  But I had to do this because the current test framework is bad, and I don't have time to do a major rewrite. 
+        @TestOnly set
+
     @TestOnly // to be compatible with your local tests :)
     constructor(
         id: Long, pwd: String

mirai-core/src/commonMain/kotlin/message/image/InternalImageProtocolImpl.kt

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019-2022 Mamoe Technologies and contributors.
+ * Copyright 2019-2023 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.
@@ -35,7 +35,7 @@ internal class InternalImageProtocolImpl : InternalImageProtocol {
      * - 上传给群的图片可以通过 GroupPicUp(groupCode=user.id) 或 OffPicUp(dstUin=user.id) 查询
      * - 上传给好友的图片可以通过 GroupPicUp(groupCode=group.id) 或 OffPicUp(dstUin=group.id) 查询
      */
-    fun interface ImageUploadedChecker<C : Contact?> {
+    interface ImageUploadedChecker<C : Contact?> {
         suspend fun isUploaded(
             bot: QQAndroidBot,
             context: C,