refactor: Replace HookFunction with a dedicated Patch class

Author: chsbuffer

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

@@ -26,11 +26,13 @@ import org.luckypray.dexkit.wrap.DexMethod
 import java.lang.reflect.Constructor
 import java.lang.reflect.Member
 import java.lang.reflect.Method
-import kotlin.reflect.KFunction0
 import kotlin.reflect.KProperty0
 import kotlin.system.measureTimeMillis
 
-private typealias HookFunction = KFunction0<Unit>
+fun patch(name: String = "", description: String = "", func: BaseHook.() -> Unit) =
+    Patch(name, description, func)
+
+class Patch(val name: String, val description: String, val run: BaseHook.() -> Unit)
 
 interface IHook {
     val classLoader: ClassLoader
@@ -91,7 +93,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)
@@ -122,10 +125,9 @@ class DependedHookFailedException(
 abstract class BaseHook(private val app: Application, val lpparam: LoadPackageParam) : IHook {
     override val classLoader = lpparam.classLoader!!
 
-    // hooks
-    abstract val hooks: Array<HookFunction>
-    private val appliedHooks = mutableSetOf<HookFunction>()
-    private val failedHooks = mutableListOf<HookFunction>()
+    abstract val patches: Array<Patch>
+    private val appliedPatches = mutableSetOf<Patch>()
+    private val failedPatches = mutableListOf<Patch>()
 
     // cache
     private val moduleRel = BuildConfig.COMMIT_HASH
@@ -172,32 +174,32 @@ abstract class BaseHook(private val app: Application, val lpparam: LoadPackagePa
     }
 
     private fun applyHooks() {
-        hooks.forEach { hook ->
-            if (appliedHooks.contains(hook)) return@forEach
-            runCatching(hook).onFailure { err ->
+        patches.forEach { hook ->
+            if (appliedPatches.contains(hook)) return@forEach
+            runCatching { hook.run(this) }.onFailure { err ->
                 XposedBridge.log(err)
-                failedHooks.add(hook)
+                failedPatches.add(hook)
             }.onSuccess {
-                appliedHooks.add(hook)
+                appliedPatches.add(hook)
             }
         }
     }
 
     private fun handleResult() {
         cache.saveCache()
-        val success = failedHooks.isEmpty()
+        val success = failedPatches.isEmpty()
         if (!success) {
             XposedBridge.log("${lpparam.appInfo.packageName} version: ${getAppVersion()}")
-            Utils.showToastLong("Error while apply following Hooks:\n${failedHooks.joinToString { it.name }}")
+            Utils.showToastLong("Error while apply following patches:\n${failedPatches.joinToString { it.name }}")
         }
     }
 
     private fun logDebugInfo() {
-        val success = failedHooks.isEmpty()
+        val success = failedPatches.isEmpty()
         if (DEBUG) {
             XposedBridge.log("${lpparam.appInfo.packageName} version: ${getAppVersion()}")
             if (success) {
-                Utils.showToastLong("apply hooks success")
+                Utils.showToastLong("apply patches success")
             }
         }
     }
@@ -213,18 +215,18 @@ abstract class BaseHook(private val app: Application, val lpparam: LoadPackagePa
         return "$versionName ($versionCode)"
     }
 
-    fun dependsOn(vararg hooks: HookFunction) {
-        hooks.forEach { hook ->
-            if (appliedHooks.contains(hook)) return@forEach
-            runCatching(hook).onFailure { err ->
+    fun dependsOn(vararg patches: Patch) {
+        patches.forEach { hook ->
+            if (appliedPatches.contains(hook)) return@forEach
+            runCatching { (hook.run(this)) }.onFailure { err ->
                 throw DependedHookFailedException(hook.name, err)
             }.onSuccess {
-                appliedHooks.add(hook)
+                appliedPatches.add(hook)
             }
         }
     }
 
-    fun ExtensionResourceHook() {
+    val ExtensionResourceHook = patch {
         app.addModuleAssets()
         StringRef.resources = app.resources
         StringRef.packageName = BuildConfig.APPLICATION_ID

app/src/main/java/io/github/chsbuffer/revancedxposed/meta/MetaHook.kt

@@ -7,5 +7,5 @@ import io.github.chsbuffer.revancedxposed.meta.ads.HideAds
 
 class MetaHook(app: Application, lpparam: XC_LoadPackage.LoadPackageParam) :
     BaseHook(app, lpparam) {
-    override val hooks = arrayOf(::HideAds)
+    override val patches = arrayOf(HideAds)
 }

app/src/main/java/io/github/chsbuffer/revancedxposed/meta/ads/HideAdsPatch.kt

@@ -1,8 +1,10 @@
 package io.github.chsbuffer.revancedxposed.meta.ads
 
 import de.robv.android.xposed.XC_MethodReplacement
-import io.github.chsbuffer.revancedxposed.meta.MetaHook
+import io.github.chsbuffer.revancedxposed.patch
 
-fun MetaHook.HideAds() {
+val HideAds = patch(
+    name = "Hide ads",
+) {
     ::adInjectorFingerprint.hookMethod(XC_MethodReplacement.DO_NOTHING)
 }

app/src/main/java/io/github/chsbuffer/revancedxposed/music/MusicHook.kt

@@ -14,16 +14,16 @@ import io.github.chsbuffer.revancedxposed.music.misc.settings.SettingsHook
 import io.github.chsbuffer.revancedxposed.shared.misc.CheckRecycleBitmapMediaSession
 
 class MusicHook(app: Application, lpparam: LoadPackageParam) : BaseHook(app, lpparam) {
-    override val hooks = arrayOf(
-        ::ExtensionResourceHook,
-        ::HideVideoAds,
-        ::BackgroundPlayback,
-        ::HideUpgradeButton,
-        ::HideGetPremium,
-        ::EnableExclusiveAudioPlayback,
-        ::CheckRecycleBitmapMediaSession,
-        ::EnableDebugging,
-        ::SanitizeSharingLinks,
-        ::SettingsHook
+    override val patches = arrayOf(
+        ExtensionResourceHook,
+        HideVideoAds,
+        BackgroundPlayback,
+        HideUpgradeButton,
+        HideGetPremium,
+        EnableExclusiveAudioPlayback,
+        CheckRecycleBitmapMediaSession,
+        EnableDebugging,
+        SanitizeSharingLinks,
+        SettingsHook
     )
 }

app/src/main/java/io/github/chsbuffer/revancedxposed/music/ad/video/HideVideoAds.kt

@@ -1,12 +1,15 @@
 package io.github.chsbuffer.revancedxposed.music.ad.video
 
 import app.revanced.extension.music.patches.HideVideoAdsPatch
-import io.github.chsbuffer.revancedxposed.music.MusicHook
+import io.github.chsbuffer.revancedxposed.patch
 import io.github.chsbuffer.revancedxposed.music.misc.settings.PreferenceScreen
 import io.github.chsbuffer.revancedxposed.scopedHook
 import io.github.chsbuffer.revancedxposed.shared.misc.settings.preference.SwitchPreference
 
-fun MusicHook.HideVideoAds() {
+val HideVideoAds = patch(
+    name = "Hide music video ads",
+    description = "Adds an option to hide ads that appear while listening to or streaming music videos, podcasts, or songs.",
+) {
     PreferenceScreen.ADS.addPreferences(
         SwitchPreference("revanced_music_hide_video_ads"),
     )

app/src/main/java/io/github/chsbuffer/revancedxposed/music/audio/exclusiveaudio/EnableExclusiveAudioPlayback.kt

@@ -1,8 +1,11 @@
 package io.github.chsbuffer.revancedxposed.music.audio.exclusiveaudio
 
 import de.robv.android.xposed.XC_MethodReplacement
-import io.github.chsbuffer.revancedxposed.music.MusicHook
+import io.github.chsbuffer.revancedxposed.patch
 
-fun MusicHook.EnableExclusiveAudioPlayback() {
+val EnableExclusiveAudioPlayback = patch(
+    name = "Enable exclusive audio playback",
+    description = "Enables the option to play audio without video.",
+) {
     ::AllowExclusiveAudioPlaybackFingerprint.hookMethod(XC_MethodReplacement.returnConstant(true))
 }

app/src/main/java/io/github/chsbuffer/revancedxposed/music/layout/premium/HideGetPremiumPatch.kt

@@ -4,11 +4,14 @@ import android.view.View
 import app.revanced.extension.music.patches.HideGetPremiumPatch
 import app.revanced.extension.shared.Logger
 import app.revanced.extension.shared.Utils
-import io.github.chsbuffer.revancedxposed.music.MusicHook
+import io.github.chsbuffer.revancedxposed.patch
 import io.github.chsbuffer.revancedxposed.music.misc.settings.PreferenceScreen
 import io.github.chsbuffer.revancedxposed.shared.misc.settings.preference.SwitchPreference
 
-fun MusicHook.HideGetPremium() {
+val HideGetPremium = patch(
+    name = "Hide 'Get Music Premium'",
+    description = "Adds an option to hide the \"Get Music Premium\" label in the settings and account menu.",
+) {
     PreferenceScreen.ADS.addPreferences(
         SwitchPreference("revanced_music_hide_get_premium_label"),
     )

app/src/main/java/io/github/chsbuffer/revancedxposed/music/layout/upgradebutton/HideUpgradeButtonPatch.kt

@@ -1,9 +1,13 @@
 package io.github.chsbuffer.revancedxposed.music.layout.upgradebutton
 
 import de.robv.android.xposed.XposedHelpers
-import io.github.chsbuffer.revancedxposed.music.MusicHook
+import io.github.chsbuffer.revancedxposed.patch
 
-fun MusicHook.HideUpgradeButton() {
+val HideUpgradeButton = patch(
+    name = "Hide upgrade button",
+    description = "Hides the upgrade tab from the pivot bar.",
+) {
+    // TODO Patch is obsolete and was replaced by navigation bar patch
     ::pivotBarConstructorFingerprint.hookMethod {
         val pivotBarElementField = ::pivotBarElementField.field
 

app/src/main/java/io/github/chsbuffer/revancedxposed/music/misc/backgroundplayback/BackgroundPlaybackPatch.kt

@@ -1,9 +1,12 @@
 package io.github.chsbuffer.revancedxposed.music.misc.backgroundplayback
 
 import de.robv.android.xposed.XC_MethodReplacement
-import io.github.chsbuffer.revancedxposed.music.MusicHook
+import io.github.chsbuffer.revancedxposed.patch
 
-fun MusicHook.BackgroundPlayback() {
+val BackgroundPlayback = patch(
+    name = "Remove background playback restrictions",
+    description = "Removes restrictions on background playback, including playing kids videos in the background.",
+) {
     ::backgroundPlaybackDisableFingerprint.hookMethod(XC_MethodReplacement.returnConstant(true))
     ::kidsBackgroundPlaybackPolicyControllerFingerprint.hookMethod(XC_MethodReplacement.DO_NOTHING)
 }

app/src/main/java/io/github/chsbuffer/revancedxposed/music/misc/debugging/EnableDebuggingPatch.kt

@@ -1,10 +1,13 @@
 package io.github.chsbuffer.revancedxposed.music.misc.debugging
 
-import io.github.chsbuffer.revancedxposed.shared.misc.debugging.EnableDebugging
-import io.github.chsbuffer.revancedxposed.music.MusicHook
+import io.github.chsbuffer.revancedxposed.patch
 import io.github.chsbuffer.revancedxposed.music.misc.settings.PreferenceScreen
+import io.github.chsbuffer.revancedxposed.shared.misc.debugging.EnableDebugging
 
-fun MusicHook.EnableDebugging() {
+val EnableDebugging = patch(
+    name = "Enable debugging",
+    description = "Adds options for debugging and exporting ReVanced logs to the clipboard.",
+) {
     EnableDebugging(
         preferenceScreen = PreferenceScreen.MISC
     )