feat: settings patch framework (#266)

2022-08-22 01:59:43 +02:00
parent 8c3866f5e3
commit 9ef93f6618
62 changed files with 1219 additions and 728 deletions
@@ -0,0 +1,13 @@
+package app.revanced.patches.youtube.misc.minimizedplayback.annotations
+
+import app.revanced.patcher.annotation.Compatibility
+import app.revanced.patcher.annotation.Package
+
+@Compatibility(
+    [Package(
+        "com.google.android.youtube", arrayOf("17.14.35", "17.17.34", "17.19.36", "17.20.37", "17.22.36", "17.23.35", "17.23.36", "17.24.34", "17.24.35", "17.25.34", "17.26.35", "17.27.39", "17.28.34", "17.29.34", "17.32.35")
+    )]
+)
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+internal annotation class MinimizedPlaybackCompatibility
@@ -0,0 +1,34 @@
+package app.revanced.patches.youtube.misc.minimizedplayback.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.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.misc.minimizedplayback.annotations.MinimizedPlaybackCompatibility
+import org.jf.dexlib2.AccessFlags
+import org.jf.dexlib2.Opcode
+
+@Name("minimized-playback-kids-fingerprint")
+@MatchingMethod(
+    "LMinimizedPlaybackPolicyController;", "k"
+)
+@MinimizedPlaybackCompatibility
+@Version("0.0.1")
+object MinimizedPlaybackKidsFingerprint : MethodFingerprint(
+    "V",
+    AccessFlags.PUBLIC or AccessFlags.FINAL,
+    listOf("I", "L", "L"),
+    listOf(
+        Opcode.IF_EQZ,
+        Opcode.SGET_OBJECT,
+        Opcode.IF_NE,
+        Opcode.CONST_4,
+        Opcode.IPUT_BOOLEAN,
+        Opcode.IF_EQZ,
+        Opcode.IGET,
+        Opcode.INVOKE_STATIC
+    ),
+    null,
+    { it.definingClass.endsWith("MinimizedPlaybackPolicyController;") }
+)
@@ -0,0 +1,51 @@
+package app.revanced.patches.youtube.misc.minimizedplayback.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.impl.MethodFingerprint
+import app.revanced.patcher.fingerprint.method.annotation.FuzzyPatternScanMethod
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
+import app.revanced.patches.youtube.misc.minimizedplayback.annotations.MinimizedPlaybackCompatibility
+import org.jf.dexlib2.AccessFlags
+import org.jf.dexlib2.Opcode
+
+@Name("minimized-playback-manager-fingerprint")
+@MatchingMethod(
+    "Lyuf", "n"
+)
+@FuzzyPatternScanMethod(2) // FIXME: Test this threshold and find the best value.
+@MinimizedPlaybackCompatibility
+@Version("0.0.1")
+object MinimizedPlaybackManagerFingerprint : MethodFingerprint(
+    "Z",
+    AccessFlags.PUBLIC or AccessFlags.STATIC,
+    listOf("L"),
+    listOf(
+        Opcode.CONST_4,
+        Opcode.IF_EQZ,
+        Opcode.IGET,
+        Opcode.AND_INT_LIT16,
+        Opcode.IF_EQZ,
+        Opcode.IGET_OBJECT,
+        Opcode.IF_NEZ,
+        Opcode.SGET_OBJECT,
+        Opcode.IGET,
+        Opcode.CONST,
+        Opcode.IF_NE,
+        Opcode.IGET_OBJECT,
+        Opcode.IF_NEZ,
+        Opcode.SGET_OBJECT,
+        Opcode.IGET,
+        Opcode.IF_NE,
+        Opcode.IGET_OBJECT,
+        Opcode.CHECK_CAST,
+        Opcode.GOTO,
+        Opcode.SGET_OBJECT,
+        Opcode.GOTO,
+        Opcode.CONST_4,
+        Opcode.IF_EQZ,
+        Opcode.IGET_BOOLEAN,
+        Opcode.IF_EQZ
+    )
+)
@@ -0,0 +1,35 @@
+package app.revanced.patches.youtube.misc.minimizedplayback.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.misc.minimizedplayback.annotations.MinimizedPlaybackCompatibility
+import org.jf.dexlib2.AccessFlags
+import org.jf.dexlib2.Opcode
+
+@Name("minimized-playback-manager-fingerprint")
+@MatchingMethod(
+    "Ladj", "w"
+)
+@FuzzyPatternScanMethod(2)
+@MinimizedPlaybackCompatibility
+@Version("0.0.1")
+object MinimizedPlaybackSettingsFingerprint : MethodFingerprint(
+    "L",
+    AccessFlags.PUBLIC or AccessFlags.FINAL,
+    null,
+    listOf(
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT,
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT,
+        Opcode.IF_EQZ,
+        Opcode.IF_NEZ,
+        Opcode.GOTO,
+        Opcode.IGET_OBJECT,
+        Opcode.CHECK_CAST
+    ),
+)
@@ -0,0 +1,88 @@
+package app.revanced.patches.youtube.misc.minimizedplayback.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.data.impl.toMethodWalker
+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.proxy.mutableTypes.MutableMethod
+import app.revanced.patches.youtube.misc.minimizedplayback.annotations.MinimizedPlaybackCompatibility
+import app.revanced.patches.youtube.misc.minimizedplayback.fingerprints.MinimizedPlaybackKidsFingerprint
+import app.revanced.patches.youtube.misc.minimizedplayback.fingerprints.MinimizedPlaybackManagerFingerprint
+import app.revanced.patches.youtube.misc.minimizedplayback.fingerprints.MinimizedPlaybackSettingsFingerprint
+import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+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.ReferenceInstruction
+import org.jf.dexlib2.iface.reference.MethodReference
+
+
+@Patch
+@Name("minimized-playback")
+@Description("Enables minimized and background playback.")
+@DependsOn([IntegrationsPatch::class, SettingsPatch::class])
+@MinimizedPlaybackCompatibility
+@Version("0.0.1")
+class MinimizedPlaybackPatch : BytecodePatch(
+    listOf(
+        MinimizedPlaybackKidsFingerprint, MinimizedPlaybackManagerFingerprint, MinimizedPlaybackSettingsFingerprint
+    )
+) {
+    override fun execute(data: BytecodeData): PatchResult {
+        SettingsPatch.PreferenceScreen.MISC.addPreferences(
+            SwitchPreference(
+                "revanced_enable_minimized_playback",
+                StringResource("revanced_minimized_playback_enabled_title", "Enable minimized playback"),
+                true,
+                StringResource("revanced_minimized_playback_summary_on", "Minimized playback is enabled"),
+                StringResource("revanced_minimized_playback_summary_off", "Minimized playback is disabled")
+            )
+        )
+
+        // Instead of removing all instructions like Vanced,
+        // we return the method at the beginning instead
+        MinimizedPlaybackManagerFingerprint.result!!.mutableMethod.addInstructions(
+            0, """
+                invoke-static {}, Lapp/revanced/integrations/patches/MinimizedPlaybackPatch;->isMinimizedPlaybackEnabled()Z
+                move-result v0
+                return v0
+                """
+        )
+
+        val method = MinimizedPlaybackSettingsFingerprint.result!!.mutableMethod
+        val booleanCalls = method.implementation!!.instructions.withIndex()
+            .filter { ((it.value as? ReferenceInstruction)?.reference as? MethodReference)?.returnType == "Z" }
+
+        val settingsBooleanIndex = booleanCalls.elementAt(1).index
+        val settingsBooleanMethod =
+            data.toMethodWalker(method).nextMethod(settingsBooleanIndex, true).getMethod() as MutableMethod
+
+        settingsBooleanMethod.addInstructions(
+            0, """
+                invoke-static {}, Lapp/revanced/integrations/patches/MinimizedPlaybackPatch;->isMinimizedPlaybackEnabled()Z
+                move-result v0
+                return v0
+                """
+        )
+
+        MinimizedPlaybackKidsFingerprint.result!!.mutableMethod.addInstructions(
+            0, """
+                invoke-static {}, Lapp/revanced/integrations/patches/MinimizedPlaybackPatch;->isMinimizedPlaybackEnabled()Z
+                move-result v0
+                if-eqz v0, :enable
+                return-void
+                :enable
+                nop
+                """
+        )
+
+        return PatchResultSuccess()
+    }
+}