Implement cache using ProtoBuf

Author: chsbuffer

.github/workflows/android.yml

@@ -30,18 +30,9 @@ jobs:
       id: random
       run: echo "NUMBER=$(shuf -i 1-10000 -n 1)" >> $GITHUB_OUTPUT
 
-    - name: Build Debug
-      run: ./gradlew assembleUniversalDebug -PPACKAGE_NAME_SEED=${{ steps.random.outputs.NUMBER }}
-
     - name: Build Release
       run: ./gradlew assembleUniversalRelease -PPACKAGE_NAME_SEED=${{ steps.random.outputs.NUMBER }}
 
-    - name: Upload a Debug Artifact
-      uses: actions/upload-artifact@v4
-      with:
-        name: rvxp-ci-debug-apk
-        path: app/build/outputs/apk/universal/debug
-
     - name: Upload a Release Artifact
       uses: actions/upload-artifact@v4
       with:

app/build.gradle.kts

@@ -4,6 +4,7 @@ import java.util.Random
 plugins {
     alias(libs.plugins.android.application)
     alias(libs.plugins.jetbrains.kotlin.android)
+    alias(libs.plugins.jetbrains.kotlin.plugin.serialization)
 }
 
 val gitCommitHashProvider = providers.exec {
@@ -105,6 +106,7 @@ dependencies {
     implementation(group = "", name = "dexkit-android", ext = "aar")
     implementation("com.google.flatbuffers:flatbuffers-java:23.5.26") // dexkit dependency
     implementation(libs.annotation)
+    implementation(libs.kotlinx.serialization.protobuf)
     testImplementation(kotlin("test-junit5"))
     testImplementation(libs.junit.jupiter.params)
     testImplementation(libs.jadx.core)

app/src/main/java/io/github/chsbuffer/revancedxposed/BaseHook.kt

@@ -10,6 +10,11 @@ import de.robv.android.xposed.XposedBridge
 import de.robv.android.xposed.XposedHelpers
 import de.robv.android.xposed.callbacks.XC_LoadPackage.LoadPackageParam
 import io.github.chsbuffer.revancedxposed.BuildConfig.DEBUG
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.decodeFromByteArray
+import kotlinx.serialization.encodeToByteArray
+import kotlinx.serialization.protobuf.ProtoBuf
 import org.luckypray.dexkit.DexKitBridge
 import org.luckypray.dexkit.DexKitCacheBridge
 import org.luckypray.dexkit.result.ClassData
@@ -18,6 +23,7 @@ import org.luckypray.dexkit.result.MethodData
 import org.luckypray.dexkit.wrap.DexClass
 import org.luckypray.dexkit.wrap.DexField
 import org.luckypray.dexkit.wrap.DexMethod
+import java.io.File
 import java.lang.reflect.Constructor
 import java.lang.reflect.Member
 import java.lang.reflect.Method
@@ -69,9 +75,29 @@ interface IHook {
     fun DexField.toField() = getFieldInstance(classLoader)
 }
 
+fun String.toSha256(): String {
+    val bytes = this.toByteArray()
+    val md = java.security.MessageDigest.getInstance("SHA-256")
+    val digest = md.digest(bytes)
+    return digest.toHexString()
+}
+
+@Serializable
+data class Pairs(
+    val map: MutableMap<String, String?>
+)
+
 @Suppress("UNCHECKED_CAST")
+@OptIn(ExperimentalSerializationApi::class)
 class SharedPrefCache(app: Application) : DexKitCacheBridge.Cache {
-    private val map = mutableMapOf<String, String>()
+    val file = File(app.cacheDir.path, BuildConfig.BUILD_TYPE.toSha256())
+
+    val pref = runCatching { ProtoBuf.decodeFromByteArray<Pairs>(file.readBytes()) }.getOrElse {
+        Pairs(mutableMapOf())
+    }
+
+    val map get() = pref.map
+
     override fun clearAll() {
         map.clear()
     }
@@ -82,7 +108,8 @@ class SharedPrefCache(app: Application) : DexKitCacheBridge.Cache {
 
     override fun getList(
         key: String, default: List<String>?
-    ): List<String>? = map.getOrDefault(key, null)?.takeIf(String::isNotBlank)?.split('|') ?: default
+    ): List<String>? =
+        map.getOrDefault(key, null)?.takeIf(String::isNotBlank)?.split('|') ?: default
 
     override fun put(key: String, value: String) {
         map.put(key, value)
@@ -95,6 +122,10 @@ class SharedPrefCache(app: Application) : DexKitCacheBridge.Cache {
     override fun remove(key: String) {
         map.remove(key)
     }
+
+    fun saveCache() {
+        file.writeBytes(ProtoBuf.encodeToByteArray(pref))
+    }
 }
 
 class DependedHookFailedException(
@@ -121,6 +152,7 @@ abstract class BaseHook(private val app: Application, val lpparam: LoadPackagePa
 
     override fun Hook() {
         val t = measureTimeMillis {
+            tryLoadCache()
             try {
                 applyHooks()
                 handleResult()
@@ -166,6 +198,7 @@ abstract class BaseHook(private val app: Application, val lpparam: LoadPackagePa
     }
 
     private fun handleResult() {
+        cache.saveCache()
         val success = failedHooks.isEmpty()
         if (!success) {
             XposedBridge.log("${lpparam.appInfo.packageName} version: ${getAppVersion()}")

gradle/libs.versions.toml

@@ -21,9 +21,11 @@ fuel = { group = "com.github.kittinunf.fuel", name = "fuel", version.ref = "fuel
 junit-jupiter-params = { group = "org.junit.jupiter", name = "junit-jupiter-params", version.ref = "junit" }
 jadx-core = { group = "io.github.skylot", name = "jadx-core", version.ref = "jadx" }
 slf4j-simple = { group = "org.slf4j", name = "slf4j-simple", version.ref = "slf4j" }
+kotlinx-serialization-protobuf = { group = "org.jetbrains.kotlinx", name = "kotlinx-serialization-protobuf", version = "1.9.0" }
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "agp" }
 android-library = { id = "com.android.library", version.ref = "agp" }
 jetbrains-kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
+jetbrains-kotlin-plugin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }