fix(hide-shorts-button): increase patching compatibility across versions

Signed-off-by: oSumAtrIX <johan.melkonyan1@web.de>
2022-09-18 07:33:11 +02:00 · 2022-09-18 07:33:11 +02:00 · e3b32800ff
parent 68d4142bab
commit e3b32800ff
9 changed files with 175 additions and 166 deletions
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/InjectionUtils.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/InjectionUtils.kt
@ -0,0 +1,30 @@
+package app.revanced.patches.youtube.layout.pivotbar
+
+import app.revanced.patcher.extensions.addInstruction
+import app.revanced.patcher.extensions.instruction
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
+import org.jf.dexlib2.Opcode.MOVE_RESULT_OBJECT
+import org.jf.dexlib2.iface.instruction.OneRegisterInstruction
+
+internal object InjectionUtils {
+    const val REGISTER_TEMPLATE_REPLACEMENT: String = "REGISTER_INDEX"
+
+    /**
+     * Injects an instruction into insertIndex of the hook.
+     * @param hook The hook to insert.
+     * @param insertIndex The index to insert the instruction at.
+     * [MOVE_RESULT_OBJECT] has to be the previous instruction before [insertIndex].
+     */
+    fun MutableMethod.injectHook(hook: String, insertIndex: Int) {
+        val injectTarget = this
+
+        // Register to pass to the hook
+        val registerIndex = insertIndex - 1 // MOVE_RESULT_OBJECT is always the previous instruction
+        val register = (injectTarget.instruction(registerIndex) as OneRegisterInstruction).registerA
+
+        injectTarget.addInstruction(
+            insertIndex,
+            hook.replace("REGISTER_INDEX", register.toString()),
+        )
+    }
+}
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/createbutton/fingerprints/CreateButtonFingerprint.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/createbutton/fingerprints/CreateButtonFingerprint.kt
@ -1,23 +1,23 @@
-package app.revanced.patches.youtube.layout.createbutton.fingerprints
+package app.revanced.patches.youtube.layout.pivotbar.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.layout.createbutton.annotations.CreateButtonCompatibility
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Opcode

-@Name("create-button-fingerprint")
+@Name("pivot-bar-fingerprint")
@MatchingMethod(
    "Lknw", "z"
 )
-@FuzzyPatternScanMethod(2) // FIXME: Test this threshold and find the best value.
-@CreateButtonCompatibility
+@FuzzyPatternScanMethod(2)
+// TODO: This fingerprint is used in multiple patches, so technically two compatibilities are needed
+// @CreateButtonCompatibility
@Version("0.0.1")
-object CreateButtonFingerprint : MethodFingerprint(
+object PivotBarFingerprint : MethodFingerprint(
    "V",
    AccessFlags.PUBLIC or AccessFlags.FINAL,
    listOf("Z"),
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/shortsbutton/annotations/ShortsButtonCompatibility.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/shortsbutton/annotations/ShortsButtonCompatibility.kt
@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.layout.shorts.button.annotations
+package app.revanced.patches.youtube.layout.pivotbar.shortsbutton.annotations

 import app.revanced.patcher.annotation.Compatibility
 import app.revanced.patcher.annotation.Package
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/shortsbutton/fingerprints/PivotBarEnumFingerprint.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/shortsbutton/fingerprints/PivotBarEnumFingerprint.kt
@ -0,0 +1,25 @@
+package app.revanced.patches.youtube.layout.pivotbar.shortsbutton.fingerprints
+
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.layout.pivotbar.shortsbutton.annotations.ShortsButtonCompatibility
+import org.jf.dexlib2.Opcode
+
+@Name("pivot-bar-enum-fingerprint")
+@MatchingMethod(
+    "Lknw", "z"
+)
+@ShortsButtonCompatibility
+@Version("0.0.1")
+object PivotBarEnumFingerprint : MethodFingerprint(
+    opcodes = listOf(
+        Opcode.IF_NEZ,
+        Opcode.SGET_OBJECT,
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT,
+        Opcode.IGET,
+        Opcode.AND_INT_LIT8, // unique instruction anchor
+    )
+)
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/shortsbutton/fingerprints/PivotBarShortsButtonViewFingerprint.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/shortsbutton/fingerprints/PivotBarShortsButtonViewFingerprint.kt
@ -0,0 +1,22 @@
+package app.revanced.patches.youtube.layout.pivotbar.shortsbutton.fingerprints
+
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.layout.pivotbar.shortsbutton.annotations.ShortsButtonCompatibility
+import org.jf.dexlib2.Opcode
+
+@Name("pivot-bar-shorts-button-view-fingerprint")
+@MatchingMethod(
+    "Lknw", "z"
+)
+@ShortsButtonCompatibility
+@Version("0.0.1")
+object PivotBarShortsButtonViewFingerprint : MethodFingerprint(
+    opcodes = listOf(
+        Opcode.INVOKE_VIRTUAL_RANGE, // unique instruction anchor
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.GOTO,
+    )
+)
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/shortsbutton/patch/ShortsButtonRemoverPatch.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/pivotbar/shortsbutton/patch/ShortsButtonRemoverPatch.kt
@ -0,0 +1,90 @@
+package app.revanced.patches.youtube.layout.pivotbar.shortsbutton.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.MethodFingerprintExtensions.name
+import app.revanced.patcher.fingerprint.method.utils.MethodFingerprintUtils.resolve
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultError
+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.patches.youtube.layout.pivotbar.InjectionUtils.REGISTER_TEMPLATE_REPLACEMENT
+import app.revanced.patches.youtube.layout.pivotbar.InjectionUtils.injectHook
+import app.revanced.patches.youtube.layout.pivotbar.fingerprints.PivotBarFingerprint
+import app.revanced.patches.youtube.layout.pivotbar.shortsbutton.annotations.ShortsButtonCompatibility
+import app.revanced.patches.youtube.layout.pivotbar.shortsbutton.fingerprints.PivotBarEnumFingerprint
+import app.revanced.patches.youtube.layout.pivotbar.shortsbutton.fingerprints.PivotBarShortsButtonViewFingerprint
+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
+
+@Patch
+@DependsOn([IntegrationsPatch::class, SettingsPatch::class])
+@Name("hide-shorts-button")
+@Description("Hides the shorts button on the navigation bar.")
+@ShortsButtonCompatibility
+@Version("0.0.1")
+class ShortsButtonRemoverPatch : BytecodePatch(
+    listOf(PivotBarFingerprint)
+) {
+    override fun execute(data: BytecodeData): PatchResult {
+        SettingsPatch.PreferenceScreen.LAYOUT.addPreferences(
+            SwitchPreference(
+                "revanced_shorts_button_enabled",
+                StringResource("revanced_shorts_button_enabled_title", "Show shorts button"),
+                false,
+                StringResource("revanced_shorts_button_summary_on", "Shorts button is shown"),
+                StringResource("revanced_shorts_button_summary_off", "Shorts button is hidden")
+            )
+        )
+
+        /*
+         * Resolve fingerprints
+         */
+
+        val pivotBarResult = PivotBarFingerprint.result ?: return PatchResultError("PivotBarFingerprint failed")
+        val fingerprintResults = arrayOf(PivotBarEnumFingerprint, PivotBarShortsButtonViewFingerprint)
+            .onEach {
+                val resolutionSucceeded = it.resolve(
+                    data,
+                    pivotBarResult.method,
+                    pivotBarResult.classDef
+                )
+
+                if (!resolutionSucceeded) return PatchResultError("${it.name} failed")
+            }
+            .map { it.result!!.patternScanResult!! }
+
+        val enumScanResult = fingerprintResults[0]
+        val buttonViewResult = fingerprintResults[1]
+
+        val enumHookInsertIndex = enumScanResult.startIndex
+        val buttonHookInsertIndex = buttonViewResult.endIndex
+
+        /*
+         * Inject hooks
+         */
+
+        val integrationsClass = "Lapp/revanced/integrations/patches/HideShortsButtonPatch;"
+
+        val enumHook =
+            "sput-object v$REGISTER_TEMPLATE_REPLACEMENT, $integrationsClass->lastPivotTab:Ljava/lang/Enum;"
+        val buttonHook =
+            "invoke-static { v$REGISTER_TEMPLATE_REPLACEMENT }, $integrationsClass->hideShortsButton(Landroid/view/View;)V"
+
+        // Inject bottom to top to not mess up the indices
+        mapOf(
+            buttonHook to buttonHookInsertIndex,
+            enumHook to enumHookInsertIndex
+        ).forEach { (hook, insertIndex) ->
+            pivotBarResult.mutableMethod.injectHook(hook, insertIndex)
+        }
+
+        return PatchResultSuccess()
+    }
+}
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/shorts/button/fingerprints/PivotBarButtonTabEnumFingerprint.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/shorts/button/fingerprints/PivotBarButtonTabEnumFingerprint.kt
@ -1,36 +0,0 @@
-package app.revanced.patches.youtube.layout.shorts.button.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.shorts.button.annotations.ShortsButtonCompatibility
-import org.jf.dexlib2.AccessFlags
-import org.jf.dexlib2.Opcode
-
-@Name("pivotbar-buttons-tabenum-fingerprint")
-@MatchingMethod(
-    "Lknw;", "z"
-)
-@FuzzyPatternScanMethod(2) // FIXME: Test this threshold and find the best value.
-@ShortsButtonCompatibility
-@Version("0.0.1")
-object PivotBarButtonTabEnumFingerprint : MethodFingerprint(
-    "V",
-    AccessFlags.PUBLIC or AccessFlags.FINAL,
-    listOf("Z"),
-    listOf(
-        Opcode.SGET_OBJECT,
-        Opcode.IGET,
-        Opcode.INVOKE_STATIC,
-        Opcode.MOVE_RESULT_OBJECT,
-        Opcode.IF_NEZ,
-        Opcode.SGET_OBJECT,
-        Opcode.INVOKE_VIRTUAL,
-        Opcode.MOVE_RESULT,
-        Opcode.IGET_OBJECT,
-        Opcode.CHECK_CAST,
-    )
-)
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/shorts/button/fingerprints/PivotBarButtonsViewFingerprint.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/shorts/button/fingerprints/PivotBarButtonsViewFingerprint.kt
@ -1,33 +0,0 @@
-package app.revanced.patches.youtube.layout.shorts.button.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.layout.shorts.button.annotations.ShortsButtonCompatibility
-import org.jf.dexlib2.AccessFlags
-import org.jf.dexlib2.Opcode
-
-@Name("pivotbar-buttons-view-fingerprint")
-@MatchingMethod(
-    "Lknw;", "z"
-)
-@ShortsButtonCompatibility
-@Version("0.0.1")
-object PivotBarButtonsViewFingerprint : MethodFingerprint(
-    "V",
-    AccessFlags.PUBLIC or AccessFlags.FINAL,
-    listOf("Z"),
-    listOf(
-        Opcode.SGET_OBJECT,
-        Opcode.IGET,
-        Opcode.INVOKE_STATIC,
-        Opcode.MOVE_RESULT_OBJECT,
-        Opcode.IF_NEZ,
-        Opcode.SGET_OBJECT,
-        Opcode.INVOKE_INTERFACE,
-        Opcode.MOVE_RESULT,
-        Opcode.IGET
-    )
-)
--- a/src/main/kotlin/app/revanced/patches/youtube/layout/shorts/button/patch/ShortsButtonRemoverPatch.kt
+++ b/src/main/kotlin/app/revanced/patches/youtube/layout/shorts/button/patch/ShortsButtonRemoverPatch.kt
@ -1,89 +0,0 @@
-package app.revanced.patches.youtube.layout.shorts.button.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.addInstruction
-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.patches.youtube.layout.shorts.button.annotations.ShortsButtonCompatibility
-import app.revanced.patches.youtube.layout.shorts.button.fingerprints.PivotBarButtonTabEnumFingerprint
-import app.revanced.patches.youtube.layout.shorts.button.fingerprints.PivotBarButtonsViewFingerprint
-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.OneRegisterInstruction
-import org.jf.dexlib2.Opcode
-
-@Patch
-@DependsOn([IntegrationsPatch::class, SettingsPatch::class])
-@Name("hide-shorts-button")
-@Description("Hides the shorts button on the navigation bar.")
-@ShortsButtonCompatibility
-@Version("0.0.1")
-class ShortsButtonRemoverPatch : BytecodePatch(
-    listOf(
-        PivotBarButtonTabEnumFingerprint, PivotBarButtonsViewFingerprint
-    )
-) {
-    override fun execute(data: BytecodeData): PatchResult {
-        SettingsPatch.PreferenceScreen.LAYOUT.addPreferences(
-            SwitchPreference(
-                "revanced_shorts_button_enabled",
-                StringResource("revanced_shorts_button_enabled_title", "Show shorts button"),
-                false,
-                StringResource("revanced_shorts_button_summary_on", "Shorts button is shown"),
-                StringResource("revanced_shorts_button_summary_off", "Shorts button is hidden")
-            )
-        )
-
-        val tabEnumResult = PivotBarButtonTabEnumFingerprint.result!!
-        val tabEnumImplementation = tabEnumResult.mutableMethod.implementation!!
-        val scanResultEndIndex = tabEnumResult.patternScanResult!!.endIndex
-        val tabEnumIndex = scanResultEndIndex +
-                if (tabEnumImplementation.instructions[scanResultEndIndex + 1].opcode == Opcode.IGET_OBJECT) {
-                    // for 17.31.xx and lower
-                    7
-                } else {
-                    // since 17.32.xx
-                    10
-                }
-        val moveEnumInstruction = tabEnumImplementation.instructions[tabEnumIndex]
-        val enumRegister = (moveEnumInstruction as OneRegisterInstruction).registerA
-
-        val buttonsViewResult = PivotBarButtonsViewFingerprint.result!!
-        val buttonsViewImplementation = buttonsViewResult.mutableMethod.implementation!!
-        val scanResultStartIndex = buttonsViewResult.patternScanResult!!.startIndex
-        val buttonsViewIndex = scanResultStartIndex +
-                if (buttonsViewImplementation.instructions[scanResultStartIndex - 1].opcode == Opcode.GOTO) {
-                    // since 17.32.xx
-                    -7
-                } else {
-                    // for 17.31.xx and lower
-                    -3
-                }
-        val moveViewInstruction = buttonsViewImplementation.instructions[buttonsViewIndex - 1]
-        val viewRegister = (moveViewInstruction as OneRegisterInstruction).registerA
-
-
-        // Save the tab enum in XGlobals to avoid smali/register workarounds
-        tabEnumResult.mutableMethod.addInstruction(
-            tabEnumIndex,
-            "sput-object v$enumRegister, Lapp/revanced/integrations/patches/HideShortsButtonPatch;->lastPivotTab:Ljava/lang/Enum;"
-        )
-
-        // Hide the button view via proxy by passing it to the hideShortsButton method
-        // It only hides it if the last tab name is "TAB_SHORTS"
-        buttonsViewResult.mutableMethod.addInstruction(
-            buttonsViewIndex + 1,
-            "invoke-static { v$viewRegister }, Lapp/revanced/integrations/patches/HideShortsButtonPatch;->hideShortsButton(Landroid/view/View;)V"
-        )
-
-        return PatchResultSuccess()
-    }
-}