feat: Magisk module builds on CI

Much of this is taken from AndroPlus's Magisk module repo, thanks!

There's still no release builds for privileged OpenEUICC and the Magisk
module; this is still intentional (for now). However, it is possible to
produce a release Magisk zip locally via the
`:app:assembleReleaseMagiskModule` task.

.forgejo/workflows/build-debug.yml

@@ -33,14 +33,23 @@ jobs:
         uses: https://gitea.angry.im/actions/setup-android@v3
 
       - name: Build Debug APKs
-        run: ./gradlew --no-daemon assembleDebug
+        run: ./gradlew --no-daemon assembleDebug :app:assembleDebugMagiskModuleDir
 
       - name: Copy Artifacts
-        run: find . -name 'app*-debug.apk' -exec cp {} . \;
+        run: |
+          find . -name 'app*-debug.apk' -exec cp {} . \;
+          cp -r app/build/magisk/debug ./magisk-debug
 
-      - name: Upload Artifacts
+      - name: Upload APK Artifacts
         uses: https://gitea.angry.im/actions/upload-artifact@v3
         with:
           name: Debug APKs
           compression-level: 0
           path: app*-debug.apk
+
+      - name: Upload Magisk Artifacts
+        uses: https://gitea.angry.im/actions/upload-artifact@v3
+        with:
+          name: magisk-debug
+          compression-level: 0
+          path: magisk-debug

app/build.gradle.kts

@@ -1,3 +1,4 @@
+import com.android.build.gradle.internal.api.ApkVariantOutputImpl
 import im.angry.openeuicc.build.*
 
 plugins {
@@ -48,4 +49,62 @@ dependencies {
     testImplementation("junit:junit:4.13.2")
     androidTestImplementation("androidx.test.ext:junit:1.1.5")
     androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
+}
+
+val modulePropsTemplate = mutableMapOf(
+    "id" to android.defaultConfig.applicationId!!,
+    "name" to "OpenEUICC",
+    "version" to android.defaultConfig.versionName!!,
+    "versionCode" to "${android.defaultConfig.versionCode}",
+    "author" to "OpenEUICC authors",
+    "description" to "OpenEUICC is an open-source app that provides system-level eSIM integration."
+)
+
+val moduleCustomizeScript = project.file("magisk/customize.sh").readText()
+    .replace("{APK_NAME}", "OpenEUICC")
+    .replace("{PKG_NAME}", android.defaultConfig.applicationId!!)
+
+val moduleUninstallScript = project.file("magisk/uninstall.sh").readText()
+    .replace("{PKG_NAME}", android.defaultConfig.applicationId!!)
+
+tasks.register<MagiskModuleDirTask>("assembleDebugMagiskModuleDir") {
+    variant = "debug"
+    appName = "OpenEUICC"
+    permsFile = project.rootProject.file("privapp_whitelist_im.angry.openeuicc.xml")
+    moduleInstaller = project.file("magisk/module_installer.sh")
+    moduleCustomizeScriptText = moduleCustomizeScript
+    moduleUninstallScriptText = moduleUninstallScript
+    moduleProp = modulePropsTemplate.let {
+        it["description"] = "(debug build) ${it["description"]}"
+        it["versionCode"] = "${(android.applicationVariants.find { it.name == "debug" }!!.outputs.first() as ApkVariantOutputImpl).versionCodeOverride}"
+        it
+    }
+    dependsOn("assembleDebug")
+}
+
+tasks.register<Zip>("assembleDebugMagiskModule") {
+    dependsOn("assembleDebugMagiskModuleDir")
+    from((tasks.getByName("assembleDebugMagiskModuleDir") as MagiskModuleDirTask).outputDir)
+    archiveFileName = "magisk-debug.zip"
+    destinationDirectory = project.layout.buildDirectory.dir("magisk")
+    entryCompression = ZipEntryCompression.STORED
+}
+
+tasks.register<MagiskModuleDirTask>("assembleReleaseMagiskModuleDir") {
+    variant = "release"
+    appName = "OpenEUICC"
+    permsFile = project.rootProject.file("privapp_whitelist_im.angry.openeuicc.xml")
+    moduleInstaller = project.file("magisk/module_installer.sh")
+    moduleCustomizeScriptText = moduleCustomizeScript
+    moduleUninstallScriptText = moduleUninstallScript
+    moduleProp = modulePropsTemplate
+    dependsOn("assembleRelease")
+}
+
+tasks.register<Zip>("assembleReleaseMagiskModule") {
+    dependsOn("assembleReleaseMagiskModuleDir")
+    from((tasks.getByName("assembleReleaseMagiskModuleDir") as MagiskModuleDirTask).outputDir)
+    archiveFileName = "magisk-release.zip"
+    destinationDirectory = project.layout.buildDirectory.dir("magisk")
+    entryCompression = ZipEntryCompression.STORED
 }

app/magisk/customize.sh

@@ -0,0 +1,9 @@
+TMP_FILE="$TMPDIR/{APK_NAME}"
+
+chmod u+x "$MODPATH/uninstall.sh"
+cp "$MODPATH/system/system_ext/{APK_NAME}/{APK_NAME}.apk" "$TMP_FILE"
+
+pm install -r "$TMP_FILE"
+rm -f "$TMP_FILE"
+
+pm grant "{PKG_NAME}" android.permission.READ_PHONE_STATE

app/magisk/module_installer.sh

@@ -0,0 +1,33 @@
+#!/sbin/sh
+
+#################
+# Initialization
+#################
+
+umask 022
+
+# echo before loading util_functions
+ui_print() { echo "$1"; }
+
+require_new_magisk() {
+  ui_print "*******************************"
+  ui_print " Please install Magisk v20.4+! "
+  ui_print "*******************************"
+  exit 1
+}
+
+#########################
+# Load util_functions.sh
+#########################
+
+OUTFD=$2
+ZIPFILE=$3
+
+mount /data 2>/dev/null
+
+[ -f /data/adb/magisk/util_functions.sh ] || require_new_magisk
+. /data/adb/magisk/util_functions.sh
+[ $MAGISK_VER_CODE -lt 20400 ] && require_new_magisk
+
+install_module
+exit 0

app/magisk/uninstall.sh

@@ -0,0 +1 @@
+pm uninstall "{PKG_NAME}"

buildSrc/src/main/kotlin/im/angry/openeuicc/build/Magisk.kt

@@ -0,0 +1,74 @@
+package im.angry.openeuicc.build
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.provider.MapProperty
+import org.gradle.api.provider.Property
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.InputDirectory
+import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.OutputDirectory
+import org.gradle.api.tasks.TaskAction
+import java.io.File
+
+abstract class MagiskModuleDirTask : DefaultTask() {
+    @get:Input
+    abstract val variant : Property<String>
+
+    @get:Input
+    abstract val appName : Property<String>
+
+    @get:InputFile
+    abstract val permsFile : Property<File>
+
+    @get:InputFile
+    abstract val moduleInstaller : Property<File>
+
+    @get:Input
+    abstract val moduleCustomizeScriptText : Property<String>
+
+    @get:Input
+    abstract val moduleUninstallScriptText : Property<String>
+
+    @get:Input
+    abstract val moduleProp : MapProperty<String, String>
+
+    @InputDirectory
+    val inputDir = variant.map { project.layout.buildDirectory.dir("outputs/apk/${it}") }
+
+    @OutputDirectory
+    val outputDir = variant.map { project.layout.buildDirectory.dir("magisk/${it}") }
+
+    @TaskAction
+    fun build() {
+        val dir = outputDir.get().get()
+        project.mkdir(dir)
+        val systemExtDir = dir.dir("system/system_ext")
+        val permDir = dir.dir("system/system_ext/etc/permissions")
+        val appDir = systemExtDir.dir("priv-app/${appName.get()}")
+        val metaInfDir = dir.dir("META-INF/com/google/android")
+        project.mkdir(systemExtDir)
+        project.mkdir(metaInfDir)
+        project.mkdir(appDir)
+        project.mkdir(permDir)
+        project.copy {
+            into(appDir)
+            from(inputDir) {
+                include("app-${variant.get()}.apk")
+                rename("app-${variant.get()}.apk", "${appName.get()}.apk")
+            }
+        }
+        project.copy {
+            from(permsFile)
+            into(permDir)
+        }
+        project.copy {
+            from(moduleInstaller)
+            into(metaInfDir)
+            rename(".*", "update-binary")
+        }
+        dir.file("customize.sh").asFile.writeText(moduleCustomizeScriptText.get())
+        dir.file("uninstall.sh").asFile.writeText(moduleUninstallScriptText.get())
+        metaInfDir.file("updater-script").asFile.writeText("# MAGISK")
+        dir.file("module.prop").asFile.writeText(moduleProp.get().map { (k, v) -> "$k=$v" }.joinToString("\n"))
+    }
+}