feat: swipe-controls rewrite (#131)

* move patch 'fenster' to 'swipe-controls'

* remove 'injectIntoNamedMethod' function

* move updatePlayerType hook into its own patch

* refactor 'swipe-controls' patch

* add resources for new ui to patch

Co-authored-by: TheJeterLP <joey.peter1998@gmail.com>

src/main/kotlin/app/revanced/extensions/Extensions.kt

@@ -1,6 +1,6 @@
 package app.revanced.extensions
 
-import app.revanced.patcher.data.impl.BytecodeData
+import app.revanced.patcher.data.impl.ResourceData
 import app.revanced.patcher.extensions.addInstructions
 import app.revanced.patcher.patch.PatchResultError
 import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
@@ -14,6 +14,8 @@ import org.jf.dexlib2.builder.instruction.BuilderInstruction21t
 import org.jf.dexlib2.builder.instruction.BuilderInstruction35c
 import org.jf.dexlib2.immutable.reference.ImmutableMethodReference
 import org.w3c.dom.Node
+import java.io.OutputStream
+import java.nio.file.Files
 
 internal fun MutableMethodImplementation.injectHideCall(
     index: Int,
@@ -100,37 +102,65 @@ internal fun MutableMethod.injectConsumableEventHook(hookRef: ImmutableMethodRef
 }
 
 /**
- * Insert instructions into a named method
+ * inject resources into the patched app
  *
- * @param targetClass the name of the class of which the method is a member
- * @param targetMethod the name of the method to insert into
- * @param index index to insert the instructions at. If the index is negative, it is used as an offset to the last method (so -1 inserts at the end of the method)
- * @param instructions the smali instructions to insert (they'll be compiled by MutableMethod.addInstructions)
+ * @param classLoader classloader to use for loading the resources
+ * @param patchDirectoryPath path to the files. this will be the directory you created under the 'resources' source folder
+ * @param resourceType the resource type, for example 'drawable'. this has to match both the source and the target
+ * @param resourceFileNames names of all resources of this type to inject
  */
-internal fun BytecodeData.injectIntoNamedMethod(
-    targetClass: String,
-    targetMethod: String,
-    index: Int,
-    instructions: String
+fun ResourceData.injectResources(
+    classLoader: ClassLoader,
+    patchDirectoryPath: String,
+    resourceType: String,
+    resourceFileNames: List<String>
 ) {
-    var injections = 0
-    this.classes.filter { it.type.endsWith("$targetClass;") }.forEach { classDef ->
-        this.proxy(classDef).resolve().methods.filter { it.name == targetMethod }.forEach { methodDef ->
-            // if index is negative, interpret as an offset from the back
-            var insertIndex = index
-            if (insertIndex < 0) {
-                insertIndex += methodDef.implementation!!.instructions.size
-            }
+    resourceFileNames.forEach { name ->
+        val relativePath = "$resourceType/$name"
+        val sourceRes = classLoader.getResourceAsStream("$patchDirectoryPath/$relativePath")
+            ?: throw PatchResultError("could not open resource '$patchDirectoryPath/$relativePath'")
 
-            // insert instructions
-            methodDef.addInstructions(insertIndex, instructions)
-            injections++
-        }
+        Files.copy(
+            sourceRes,
+            this["res"].resolve(relativePath).toPath()
+        )
     }
+}
 
-    // fail if nothing was injected
-    if (injections <= 0) {
-        throw PatchResultError("failed to inject into $targetClass.$targetMethod: no targets were found")
+/**
+ * inject strings into the patched app
+ *
+ * @param classLoader classloader to use for loading the resources
+ * @param patchDirectoryPath path to the files. this will be the directory you created under the 'resources' source folder
+ * @param languageIdentifier ISO 639-2 two- letter language code identifier (aka the one android uses for values directory)
+ */
+fun ResourceData.injectStrings(
+    classLoader: ClassLoader,
+    patchDirectoryPath: String,
+    languageIdentifier: String? = null,
+) {
+    val relativePath =
+        if (languageIdentifier.isNullOrBlank()) "values/strings.xml" else "values/strings-$languageIdentifier.xml"
+
+    // open source strings.xml
+    val sourceInputStream = classLoader.getResourceAsStream("$patchDirectoryPath/$relativePath")
+        ?: throw PatchResultError("failed to open '$patchDirectoryPath/$relativePath'")
+    xmlEditor[sourceInputStream, OutputStream.nullOutputStream()].use { sourceStringsXml ->
+        val strings = sourceStringsXml.file.getElementsByTagName("resources").item(0).childNodes
+
+        // open target strings.xml
+        xmlEditor["res/$relativePath"].use { targetStringsXml ->
+            val targetFile = targetStringsXml.file
+            val targetRootNode = targetFile.getElementsByTagName("resources").item(0)
+
+            // process all children strings in the source
+            for (i in 0 until strings.length) {
+                // clone the node from source to target
+                val node = strings.item(i).cloneNode(true)
+                targetFile.adoptNode(node)
+                targetRootNode.appendChild(node)
+            }
+        }
     }
 }
 

src/main/kotlin/app/revanced/patches/youtube/interaction/fenster/patch/FensterPatch.kt

@@ -1,121 +0,0 @@
-package app.revanced.patches.youtube.interaction.fenster.patch
-
-import app.revanced.extensions.injectConsumableEventHook
-import app.revanced.extensions.injectIntoNamedMethod
-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.fingerprint.method.impl.MethodFingerprintResult
-import app.revanced.patcher.patch.PatchResult
-import app.revanced.patcher.patch.PatchResultError
-import app.revanced.patcher.patch.PatchResultSuccess
-import app.revanced.patcher.patch.annotations.Dependencies
-import app.revanced.patcher.patch.annotations.Patch
-import app.revanced.patcher.patch.impl.BytecodePatch
-import app.revanced.patches.youtube.interaction.fenster.annotation.FensterCompatibility
-import app.revanced.patches.youtube.interaction.fenster.fingerprints.UpdatePlayerTypeFingerprint
-import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
-import org.jf.dexlib2.immutable.reference.ImmutableMethodReference
-
-@Patch
-@Name("fenster-swipe-controls")
-@Description("Adds volume and brightness swipe controls.")
-@FensterCompatibility
-@Version("0.0.1")
-@Dependencies(dependencies = [IntegrationsPatch::class])
-class FensterPatch : BytecodePatch(
-    listOf(
-        UpdatePlayerTypeFingerprint
-    )
-) {
-    override fun execute(data: BytecodeData): PatchResult {
-        // hook WatchWhileActivity.onStart (main activity lifecycle hook)
-        data.injectIntoNamedMethod(
-            "com/google/android/apps/youtube/app/watchwhile/WatchWhileActivity",
-            "onStart",
-            0,
-            "invoke-static { p0 }, Lapp/revanced/integrations/patches/FensterSwipePatch;->WatchWhileActivity_onStartHookEX(Ljava/lang/Object;)V"
-        )
-
-        // hook YoutubePlayerOverlaysLayout.onFinishInflate (player overlays init hook)
-        data.injectIntoNamedMethod(
-            "com/google/android/apps/youtube/app/common/player/overlay/YouTubePlayerOverlaysLayout",
-            "onFinishInflate",
-            -2,
-            "invoke-static { p0 }, Lapp/revanced/integrations/patches/FensterSwipePatch;->YouTubePlayerOverlaysLayout_onFinishInflateHookEX(Ljava/lang/Object;)V"
-        )
-
-        // hook YoutubePlayerOverlaysLayout.UpdatePlayerType
-        injectUpdatePlayerTypeHook(
-            UpdatePlayerTypeFingerprint.result!!,
-            "com/google/android/apps/youtube/app/common/player/overlay/YouTubePlayerOverlaysLayout"
-        )
-
-        // hook NextGenWatchLayout.onTouchEvent and NextGenWatchLayout.onInterceptTouchEvent (player touch event hook)
-        injectWatchLayoutTouchHooks(
-            data,
-            "com/google/android/apps/youtube/app/watch/nextgenwatch/ui/NextGenWatchLayout"
-        )
-
-        return PatchResultSuccess()
-    }
-
-    @Suppress("SameParameterValue")
-    private fun injectUpdatePlayerTypeHook(fingerPrintResult: MethodFingerprintResult, targetClass: String) {
-        // validate fingerprint found the right class
-        if (!fingerPrintResult.classDef.type.endsWith("$targetClass;")) {
-            throw PatchResultError("$targetClass.UpdatePlayerType fingerprint could not be validated")
-        }
-
-        // insert the hook
-        fingerPrintResult.mutableMethod.addInstruction(
-            0,
-            "invoke-static { p1 }, Lapp/revanced/integrations/patches/FensterSwipePatch;->YouTubePlayerOverlaysLayout_updatePlayerTypeHookEX(Ljava/lang/Object;)V"
-        )
-    }
-
-    /**
-     * Inject onTouch event hooks into the watch layout class
-     *
-     * @param data bytecode data
-     * @param targetClass watch layout class name
-     */
-    @Suppress("SameParameterValue")
-    private fun injectWatchLayoutTouchHooks(data: BytecodeData, targetClass: String) {
-        var touchHooksCount = 0
-        data.classes.filter { it.type.endsWith("$targetClass;") }.forEach { classDef ->
-            // hook onTouchEvent
-            data.proxy(classDef).resolve().methods.filter { it.name == "onTouchEvent" }.forEach { methodDef ->
-                touchHooksCount++
-                methodDef.injectConsumableEventHook(
-                    ImmutableMethodReference(
-                        "Lapp/revanced/integrations/patches/FensterSwipePatch;",
-                        "NextGenWatchLayout_onTouchEventHookEX",
-                        listOf("Ljava/lang/Object;", "Ljava/lang/Object;"),
-                        "Z"
-                    )
-                )
-            }
-
-            // hook onInterceptTouchEvent
-            data.proxy(classDef).resolve().methods.filter { it.name == "onInterceptTouchEvent" }.forEach { methodDef ->
-                touchHooksCount++
-                methodDef.injectConsumableEventHook(
-                    ImmutableMethodReference(
-                        "Lapp/revanced/integrations/patches/FensterSwipePatch;",
-                        "NextGenWatchLayout_onInterceptTouchEventHookEX",
-                        listOf("Ljava/lang/Object;", "Ljava/lang/Object;"),
-                        "Z"
-                    )
-                )
-            }
-        }
-
-        // fail if no touch hooks were inserted
-        if (touchHooksCount <= 0) {
-            throw PatchResultError("failed to inject onTouchEvent hook into NextGenWatchLayout: none found")
-        }
-    }
-}

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/annotation/SwipeControlsCompatibility.kt

@@ -0,0 +1,13 @@
+package app.revanced.patches.youtube.interaction.swipecontrols.annotation
+
+import app.revanced.patcher.annotation.Compatibility
+import app.revanced.patcher.annotation.Package
+
+@Compatibility(
+    [Package(
+        "com.google.android.youtube", arrayOf("17.24.34", "17.25.34")
+    )]
+)
+@Target(AnnotationTarget.CLASS)
+@Retention(AnnotationRetention.RUNTIME)
+internal annotation class SwipeControlsCompatibility

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/fingerprints/WatchWhileOnStartFingerprint.kt

@@ -0,0 +1,21 @@
+package app.revanced.patches.youtube.interaction.swipecontrols.fingerprints
+
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.fingerprint.method.annotation.DirectPatternScanMethod
+import app.revanced.patcher.fingerprint.method.annotation.MatchingMethod
+import app.revanced.patcher.fingerprint.method.impl.MethodFingerprint
+import app.revanced.patches.youtube.interaction.swipecontrols.annotation.SwipeControlsCompatibility
+
+@Name("watch-while-onStart-fingerprint")
+@MatchingMethod(
+    "LWatchWhileActivity;", "onCreate"
+)
+@DirectPatternScanMethod
+@SwipeControlsCompatibility
+@Version("0.0.1")
+object WatchWhileOnStartFingerprint : MethodFingerprint(
+    null, null, null, null, null, { methodDef ->
+        methodDef.definingClass.endsWith("WatchWhileActivity;") && methodDef.name == "onStart"
+    }
+)

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/patch/SwipeControlsPatch.kt

@@ -0,0 +1,42 @@
+package app.revanced.patches.youtube.interaction.swipecontrols.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.Dependencies
+import app.revanced.patcher.patch.annotations.Patch
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patches.youtube.interaction.swipecontrols.annotation.SwipeControlsCompatibility
+import app.revanced.patches.youtube.interaction.swipecontrols.fingerprints.WatchWhileOnStartFingerprint
+import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.playertype.patch.PlayerTypeHookPatch
+
+@Patch
+@Name("swipe-controls")
+@Description("Adds volume and brightness swipe controls.")
+@SwipeControlsCompatibility
+@Version("0.0.2")
+@Dependencies(
+    dependencies = [
+        IntegrationsPatch::class,
+        PlayerTypeHookPatch::class,
+        SwipeControlsResourcesPatch::class
+    ]
+)
+class SwipeControlsPatch : BytecodePatch(
+    listOf(
+        WatchWhileOnStartFingerprint
+    )
+) {
+    override fun execute(data: BytecodeData): PatchResult {
+        WatchWhileOnStartFingerprint.result!!.mutableMethod.addInstruction(
+            0,
+            "invoke-static { p0 }, Lapp/revanced/integrations/patches/SwipeControlsPatch;->WatchWhileActivity_onStartHookEX(Ljava/lang/Object;)V"
+        )
+        return PatchResultSuccess()
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/interaction/swipecontrols/patch/SwipeControlsResourcesPatch.kt

@@ -0,0 +1,32 @@
+package app.revanced.patches.youtube.interaction.swipecontrols.patch
+
+import app.revanced.extensions.injectResources
+import app.revanced.patcher.annotation.Name
+import app.revanced.patcher.annotation.Version
+import app.revanced.patcher.data.impl.ResourceData
+import app.revanced.patcher.patch.PatchResult
+import app.revanced.patcher.patch.PatchResultSuccess
+import app.revanced.patcher.patch.impl.ResourcePatch
+import app.revanced.patches.youtube.interaction.swipecontrols.annotation.SwipeControlsCompatibility
+
+@Name("swipe-controls-resource-patch")
+@SwipeControlsCompatibility
+@Version("0.0.1")
+class SwipeControlsResourcesPatch : ResourcePatch() {
+    override fun execute(data: ResourceData): PatchResult {
+        val resourcesDir = "swipecontrols"
+
+        data.injectResources(
+            this.javaClass.classLoader,
+            resourcesDir,
+            "drawable",
+            listOf(
+                "ic_sc_brightness_auto",
+                "ic_sc_brightness_manual",
+                "ic_sc_volume_mute",
+                "ic_sc_volume_normal"
+            ).map { "$it.xml" }
+        )
+        return PatchResultSuccess()
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/misc/playertype/annotation/PlayerTypeHookCompatibility.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.interaction.fenster.annotation
+package app.revanced.patches.youtube.misc.playertype.annotation
 
 import app.revanced.patcher.annotation.Compatibility
 import app.revanced.patcher.annotation.Package
@@ -10,4 +10,4 @@ import app.revanced.patcher.annotation.Package
 )
 @Target(AnnotationTarget.CLASS)
 @Retention(AnnotationRetention.RUNTIME)
-internal annotation class FensterCompatibility
+internal annotation class PlayerTypeHookCompatibility

src/main/kotlin/app/revanced/patches/youtube/misc/playertype/fingerprint/UpdatePlayerTypeFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.interaction.fenster.fingerprints
+package app.revanced.patches.youtube.misc.playertype.fingerprint
 
 import app.revanced.patcher.annotation.Name
 import app.revanced.patcher.annotation.Version
@@ -6,17 +6,18 @@ 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.interaction.fenster.annotation.FensterCompatibility
+import app.revanced.patches.youtube.interaction.swipecontrols.annotation.SwipeControlsCompatibility
 import org.jf.dexlib2.AccessFlags
 import org.jf.dexlib2.Opcode
 
+//TODO constrain to only match in YoutubePlayerOverlaysLayout?
 @Name("update-player-type-fingerprint")
 @MatchingMethod(
     "LYoutubePlayerOverlaysLayout;",
     "nM"
 )
 @FuzzyPatternScanMethod(2)
-@FensterCompatibility
+@SwipeControlsCompatibility
 @Version("0.0.1")
 object UpdatePlayerTypeFingerprint : MethodFingerprint(
     "V",

src/main/kotlin/app/revanced/patches/youtube/misc/playertype/patch/PlayerTypeHookPatch.kt

@@ -0,0 +1,34 @@
+package app.revanced.patches.youtube.misc.playertype.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.Dependencies
+import app.revanced.patcher.patch.impl.BytecodePatch
+import app.revanced.patches.youtube.misc.integrations.patch.IntegrationsPatch
+import app.revanced.patches.youtube.misc.playertype.annotation.PlayerTypeHookCompatibility
+import app.revanced.patches.youtube.misc.playertype.fingerprint.UpdatePlayerTypeFingerprint
+
+@Name("player-type-hook")
+@Description("hook to get the current player type of WatchWhileActivity")
+@PlayerTypeHookCompatibility
+@Version("0.0.1")
+@Dependencies(dependencies = [IntegrationsPatch::class])
+class PlayerTypeHookPatch : BytecodePatch(
+    listOf(
+        UpdatePlayerTypeFingerprint
+    )
+) {
+    override fun execute(data: BytecodeData): PatchResult {
+        // hook YouTubePlayerOverlaysLayout.updatePlayerLayout()
+        UpdatePlayerTypeFingerprint.result!!.mutableMethod.addInstruction(
+            0,
+            "invoke-static { p1 }, Lapp/revanced/integrations/patches/PlayerTypeHookPatch;->YouTubePlayerOverlaysLayout_updatePlayerTypeHookEX(Ljava/lang/Object;)V"
+        )
+        return PatchResultSuccess()
+    }
+}

src/main/resources/swipecontrols/drawable/ic_sc_brightness_auto.xml

@@ -0,0 +1,5 @@
+<vector android:height="24dp" android:tint="#000000"
+    android:viewportHeight="24" android:viewportWidth="24"
+    android:width="24dp" xmlns:android="http://schemas.android.com/apk/res/android">
+    <path android:fillColor="@android:color/white" android:pathData="M10.85,12.65h2.3L12,9l-1.15,3.65zM20,8.69V4h-4.69L12,0.69 8.69,4H4v4.69L0.69,12 4,15.31V20h4.69L12,23.31 15.31,20H20v-4.69L23.31,12 20,8.69zM14.3,16l-0.7,-2h-3.2l-0.7,2H7.8L11,7h2l3.2,9h-1.9z"/>
+</vector>

src/main/resources/swipecontrols/drawable/ic_sc_brightness_manual.xml

@@ -0,0 +1,5 @@
+<vector android:height="24dp" android:tint="#000000"
+    android:viewportHeight="24" android:viewportWidth="24"
+    android:width="24dp" xmlns:android="http://schemas.android.com/apk/res/android">
+    <path android:fillColor="@android:color/white" android:pathData="M20,15.31L23.31,12 20,8.69V4h-4.69L12,0.69 8.69,4H4v4.69L0.69,12 4,15.31V20h4.69L12,23.31 15.31,20H20v-4.69zM12,18V6c3.31,0 6,2.69 6,6s-2.69,6 -6,6z"/>
+</vector>

src/main/resources/swipecontrols/drawable/ic_sc_volume_mute.xml

@@ -0,0 +1,5 @@
+<vector android:height="24dp" android:tint="#000000"
+    android:viewportHeight="24" android:viewportWidth="24"
+    android:width="24dp" xmlns:android="http://schemas.android.com/apk/res/android">
+    <path android:fillColor="@android:color/white" android:pathData="M16.5,12c0,-1.77 -1.02,-3.29 -2.5,-4.03v2.21l2.45,2.45c0.03,-0.2 0.05,-0.41 0.05,-0.63zM19,12c0,0.94 -0.2,1.82 -0.54,2.64l1.51,1.51C20.63,14.91 21,13.5 21,12c0,-4.28 -2.99,-7.86 -7,-8.77v2.06c2.89,0.86 5,3.54 5,6.71zM4.27,3L3,4.27 7.73,9L3,9v6h4l5,5v-6.73l4.25,4.25c-0.67,0.52 -1.42,0.93 -2.25,1.18v2.06c1.38,-0.31 2.63,-0.95 3.69,-1.81L19.73,21 21,19.73l-9,-9L4.27,3zM12,4L9.91,6.09 12,8.18L12,4z"/>
+</vector>

src/main/resources/swipecontrols/drawable/ic_sc_volume_normal.xml

@@ -0,0 +1,5 @@
+<vector android:height="24dp" android:tint="#000000"
+    android:viewportHeight="24" android:viewportWidth="24"
+    android:width="24dp" xmlns:android="http://schemas.android.com/apk/res/android">
+    <path android:fillColor="@android:color/white" android:pathData="M3,9v6h4l5,5L12,4L7,9L3,9zM16.5,12c0,-1.77 -1.02,-3.29 -2.5,-4.03v8.05c1.48,-0.73 2.5,-2.25 2.5,-4.02zM14,3.23v2.06c2.89,0.86 5,3.54 5,6.71s-2.11,5.85 -5,6.71v2.06c4.01,-0.91 7,-4.49 7,-8.77s-2.99,-7.86 -7,-8.77z"/>
+</vector>