feat: settings patch framework (#266)

2025-06-12 21:27:43 +02:00 · 2022-08-22 01:59:43 +02:00
parent 059913c239
commit 8af8cdbfd6
62 changed files with 1219 additions and 728 deletions
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/autoplaybutton/fingerprints/AutoNavInformerFingerprint.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/autoplaybutton/fingerprints/AutoNavInformerFingerprint.kt
@ -14,10 +14,9 @@ import org.jf.dexlib2.Opcode
@MatchingMethod(
    "LWillAutonavInformer;", "k"
 )
-@FuzzyPatternScanMethod(2)
@AutoplayButtonCompatibility
@Version("0.0.1")
-object AutonavInformerFingerprint : MethodFingerprint(
+object AutoNavInformerFingerprint : MethodFingerprint(
    "Z",
    AccessFlags.PUBLIC or AccessFlags.FINAL,
    null,
@ -31,4 +30,4 @@ object AutonavInformerFingerprint : MethodFingerprint(
    ),
    null,
    { it.definingClass.endsWith("WillAutonavInformer;") }
-)
+)
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/autoplaybutton/fingerprints/LayoutConstructorFingerprint.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/autoplaybutton/fingerprints/LayoutConstructorFingerprint.kt
@ -2,31 +2,19 @@ package app.revanced.patches.youtube.layout.autoplaybutton.fingerprints

 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
-import app.revanced.patcher.extensions.or
-import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
 import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
 import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
 import app.revanced.patches.youtube.layout.autoplaybutton.annotations.AutoplayButtonCompatibility
-import org.jf.dexlib2.AccessFlags
-import org.jf.dexlib2.Opcode

@Name("layout-constructor-fingerprint")
@MatchingMethod(
    "LYouTubeControlsOverlay;", "F"
 )
-@FuzzyPatternScanMethod(2)
@AutoplayButtonCompatibility
@Version("0.0.1")
 object LayoutConstructorFingerprint : MethodFingerprint(
-    "V",
-    AccessFlags.PUBLIC or AccessFlags.FINAL,
-    null,
-    listOf(
-        Opcode.CONST,
-        Opcode.INVOKE_VIRTUAL,
-        Opcode.MOVE_RESULT_OBJECT,
-        Opcode.CHECK_CAST,
-        Opcode.INVOKE_VIRTUAL,
-    ),
-    listOf("1.0x")
-)
+    null, null, null, null, listOf("1.0x"),
+    { methodDef ->
+        methodDef.definingClass.endsWith("YouTubeControlsOverlay;")
+    }
+)
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/autoplaybutton/patch/HideAutoplayButton.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/autoplaybutton/patch/HideAutoplayButton.kt
@ -1,88 +0,0 @@
-package app.revanced.patches.youtube.layout.autoplaybutton.patch
-
-import app.revanced.patcher.annotation.Description
-import app.revanced.patcher.annotation.Name
-import app.revanced.patcher.annotation.Version
-import app.revanced.patcher.data.impl.BytecodeData
-import app.revanced.patcher.extensions.addInstructions
-import app.revanced.patcher.extensions.removeInstruction
-import app.revanced.patcher.patch.PatchResult
-import app.revanced.patcher.patch.PatchResultSuccess
-import app.revanced.patcher.patch.annotations.DependsOn
-import app.revanced.patcher.patch.annotations.Patch
-import app.revanced.patcher.patch.impl.BytecodePatch
-import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
-import app.revanced.patches.youtube.layout.autoplaybutton.annotations.AutoplayButtonCompatibility
-import app.revanced.patches.youtube.layout.autoplaybutton.fingerprints.AutonavInformerFingerprint
-import app.revanced.patches.youtube.layout.autoplaybutton.fingerprints.LayoutConstructorFingerprint
-import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
-import app.revanced.patches.youtube.misc.mapping.patch.ResourceIdMappingProviderResourcePatch
-import org.jf.dexlib2.iface.instruction.WideLiteralInstruction
-import org.jf.dexlib2.iface.instruction.formats.Instruction35c
-
-@Patch
-@DependsOn([ResourceIdMappingProviderResourcePatch::class, IntegrationsPatch::class])
-@Name("hide-autoplay-button")
-@Description("Hides the autoplay button in the video player.")
-@AutoplayButtonCompatibility
-@Version("0.0.1")
-class HideAutoplayButton : BytecodePatch(
-    listOf(
-        LayoutConstructorFingerprint, AutonavInformerFingerprint
-    )
-) {
-    override fun execute(data: BytecodeData): PatchResult {
-        val layoutGenMethod = LayoutConstructorFingerprint.result!!.mutableMethod
-
-        val autonavToggle =
-            ResourceIdMappingProviderResourcePatch.resourceMappings.single { it.type == "id" && it.name == "autonav_toggle" }
-        val autonavPreviewStub =
-            ResourceIdMappingProviderResourcePatch.resourceMappings.single { it.type == "id" && it.name == "autonav_preview_stub" }
-
-        val instructions = layoutGenMethod.implementation!!.instructions
-
-        val autonavToggleConstIndex =
-            instructions.indexOfFirst { (it as? WideLiteralInstruction)?.wideLiteral == autonavToggle.id } + 4
-        val autonavPreviewStubConstIndex =
-            instructions.indexOfFirst { (it as? WideLiteralInstruction)?.wideLiteral == autonavPreviewStub.id } + 4
-
-        injectIfBranch(layoutGenMethod, autonavToggleConstIndex)
-        injectIfBranch(layoutGenMethod, autonavPreviewStubConstIndex)
-
-        val autonavInformerMethod = AutonavInformerFingerprint.result!!.mutableMethod
-
-        //force disable autoplay since it's hard to do without the button
-        autonavInformerMethod.addInstructions(
-            0, """
-            invoke-static {}, Lapp/revanced/integrations/patches/HideAutoplayButtonPatch;->isButtonShown()Z
-            move-result v0
-            if-nez v0, :hidden
-            const/4 v0, 0x0
-            return v0
-            :hidden
-            nop
-        """
-        )
-
-        return PatchResultSuccess()
-    }
-
-    private fun injectIfBranch(method: MutableMethod, index: Int) {
-        val instructions = method.implementation!!.instructions
-        val insn = (instructions.get(index) as? Instruction35c)!!
-        val methodToCall = insn.reference.toString()
-
-        //remove the invoke-virtual because we want to put it in an if-statement
-        method.removeInstruction(index)
-        method.addInstructions(
-            index, """
-            invoke-static {}, Lapp/revanced/integrations/patches/HideAutoplayButtonPatch;->isButtonShown()Z
-            move-result v11
-            if-eqz v11, :hidebutton
-            invoke-virtual {v${insn.registerC}, v${insn.registerD}, v${insn.registerE}}, $methodToCall
-            :hidebutton
-            nop
-        """
-        )
-    }
-}
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/autoplaybutton/patch/HideAutoplayButtonPatch.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/autoplaybutton/patch/HideAutoplayButtonPatch.kt
@ -0,0 +1,92 @@
+package app.revanced.patches.youtube.layout.autoplaybutton.patch
+
+import app.revanced.patcher.annotation.Description
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.extensions.addInstructions
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
+import app.revanced.patcher.patch.annotations.DependsOn
+import app.revanced.patcher.patch.annotations.Patch
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patcher.util.smali.ExternalLabel
+import app.revanced.patches.youtube.layout.autoplaybutton.annotations.AutoplayButtonCompatibility
+import app.revanced.patches.youtube.layout.autoplaybutton.fingerprints.AutoNavInformerFingerprint
+import app.revanced.patches.youtube.layout.autoplaybutton.fingerprints.LayoutConstructorFingerprint
+import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.mapping.patch.ResourceIdMappingProviderResourcePatch
+import app.revanced.patches.youtube.misc.settings.bytecode.patch.SettingsPatch
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.StringResource
+import app.revanced.patches.youtube.misc.settings.framework.components.impl.SwitchPreference
+import org.jf.dexlib2.iface.instruction.Instruction
+import org.jf.dexlib2.iface.instruction.ReferenceInstruction
+import org.jf.dexlib2.iface.instruction.WideLiteralInstruction
+import org.jf.dexlib2.iface.reference.MethodReference
+
+@Patch
+@DependsOn([IntegrationsPatch::class, SettingsPatch::class, ResourceIdMappingProviderResourcePatch::class])
+@Name("hide-autoplay-button")
+@Description("Hides the autoplay button in the video player.")
+@AutoplayButtonCompatibility
+@Version("0.0.1")
+class HideAutoplayButtonPatch : BytecodePatch(
+    listOf(
+        LayoutConstructorFingerprint, AutoNavInformerFingerprint
+    )
+) {
+    override fun execute(data: BytecodeData): PatchResult {
+        SettingsPatch.PreferenceScreen.LAYOUT.addPreferences(
+            SwitchPreference(
+                "revanced_autoplay_button_enabled",
+                StringResource("revanced_autoplay_button_enabled_title", "Show autoplay button"),
+                false,
+                StringResource("revanced_autoplay_button_summary_on", "Autoplay button is shown"),
+                StringResource("revanced_autoplay_button_summary_off", "Autoplay button is hidden")
+            )
+        )
+
+        val autoNavInformerMethod = AutoNavInformerFingerprint.result!!.mutableMethod
+
+        val layoutGenMethodResult = LayoutConstructorFingerprint.result!!
+        val layoutGenMethod = layoutGenMethodResult.mutableMethod
+        val layoutGenMethodInstructions = layoutGenMethod.implementation!!.instructions
+
+        // resolve the offsets such as ...
+        val autoNavPreviewStubId = ResourceIdMappingProviderResourcePatch.resourceMappings.single {
+            it.name == "autonav_preview_stub"
+        }.id
+        // where to insert the branch instructions and ...
+        val insertIndex = layoutGenMethodInstructions.indexOfFirst {
+            (it as? WideLiteralInstruction)?.wideLiteral == autoNavPreviewStubId
+        }
+        // where to branch away
+        val branchIndex = layoutGenMethodInstructions.subList(insertIndex + 1, layoutGenMethodInstructions.size - 1).indexOfFirst {
+            ((it as? ReferenceInstruction)?.reference as? MethodReference)?.name == "addOnLayoutChangeListener"
+        } + 2
+
+        val jumpInstruction = layoutGenMethodInstructions[insertIndex + branchIndex] as Instruction
+        layoutGenMethod.addInstructions(
+            insertIndex, """
+                invoke-static {}, Lapp/revanced/integrations/patches/HideAutoplayButtonPatch;->isButtonShown()Z
+                move-result v11
+                if-eqz v11, :hidden
+            """, listOf(ExternalLabel("hidden", jumpInstruction))
+        )
+
+        //force disable autoplay since it's hard to do without the button
+        autoNavInformerMethod.addInstructions(
+            0, """
+            invoke-static {}, Lapp/revanced/integrations/patches/HideAutoplayButtonPatch;->isButtonShown()Z
+            move-result v0
+            if-nez v0, :hidden
+            const/4 v0, 0x0
+            return v0
+            :hidden
+            nop
+        """
+        )
+
+        return PatchResultSuccess()
+    }
+}