chore(release): 4.12.0-dev.2 [skip ci]

# [4.12.0-dev.2](https://github.com/ReVanced/revanced-patches/compare/v4.12.0-dev.1...v4.12.0-dev.2) (2024-07-15)

### Features

* **YouTube:** Add `Bypass image region restrictions` patch ([#3442](https://github.com/ReVanced/revanced-patches/issues/3442)) ([9ef51ab](9ef51abde7))

CHANGELOG.md

@@ -1,3 +1,17 @@
+# [4.12.0-dev.2](https://github.com/ReVanced/revanced-patches/compare/v4.12.0-dev.1...v4.12.0-dev.2) (2024-07-15)
+
+
+### Features
+
+* **YouTube:** Add `Bypass image region restrictions` patch ([#3442](https://github.com/ReVanced/revanced-patches/issues/3442)) ([765fab2](https://github.com/ReVanced/revanced-patches/commit/765fab2af2769349446cc0f2109343ef3bd8c621))
+
+# [4.12.0-dev.1](https://github.com/ReVanced/revanced-patches/compare/v4.11.1-dev.1...v4.12.0-dev.1) (2024-07-13)
+
+
+### Features
+
+* **SoundCloud:** Add `Enable offline sync` patch ([#3407](https://github.com/ReVanced/revanced-patches/issues/3407)) ([4de86c6](https://github.com/ReVanced/revanced-patches/commit/4de86c6407376bcd3cc0513a2f0707410b8d7ccd))
+
 ## [4.11.1-dev.1](https://github.com/ReVanced/revanced-patches/compare/v4.11.0...v4.11.1-dev.1) (2024-07-12)
 
 

api/revanced-patches.api

@@ -1050,6 +1050,12 @@ public final class app/revanced/patches/soundcloud/analytics/DisableTelemetryPat
 	public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
 }
 
+public final class app/revanced/patches/soundcloud/offlinesync/EnableOfflineSyncPatch : app/revanced/patcher/patch/BytecodePatch {
+	public static final field INSTANCE Lapp/revanced/patches/soundcloud/offlinesync/EnableOfflineSyncPatch;
+	public fun execute (Lapp/revanced/patcher/data/BytecodeContext;)V
+	public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
+}
+
 public final class app/revanced/patches/spotify/layout/theme/CustomThemePatch : app/revanced/patcher/patch/ResourcePatch {
 	public static final field INSTANCE Lapp/revanced/patches/spotify/layout/theme/CustomThemePatch;
 	public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
@@ -1718,6 +1724,12 @@ public final class app/revanced/patches/youtube/layout/thumbnails/AlternativeThu
 	public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
 }
 
+public final class app/revanced/patches/youtube/layout/thumbnails/BypassImageRegionRestrictions : app/revanced/patcher/patch/BytecodePatch {
+	public static final field INSTANCE Lapp/revanced/patches/youtube/layout/thumbnails/BypassImageRegionRestrictions;
+	public fun execute (Lapp/revanced/patcher/data/BytecodeContext;)V
+	public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
+}
+
 public final class app/revanced/patches/youtube/misc/announcements/AnnouncementsPatch : app/revanced/patcher/patch/BytecodePatch {
 	public static final field INSTANCE Lapp/revanced/patches/youtube/misc/announcements/AnnouncementsPatch;
 	public fun execute (Lapp/revanced/patcher/data/BytecodeContext;)V
@@ -1784,6 +1796,16 @@ public final class app/revanced/patches/youtube/misc/gms/GmsCoreSupportResourceP
 	public fun execute (Lapp/revanced/patcher/data/ResourceContext;)V
 }
 
+public final class app/revanced/patches/youtube/misc/imageurlhook/CronetImageUrlHook : app/revanced/patcher/patch/BytecodePatch {
+	public static final field INSTANCE Lapp/revanced/patches/youtube/misc/imageurlhook/CronetImageUrlHook;
+	public final fun addImageUrlErrorCallbackHook (Ljava/lang/String;)V
+	public final fun addImageUrlHook (Ljava/lang/String;Z)V
+	public static synthetic fun addImageUrlHook$default (Lapp/revanced/patches/youtube/misc/imageurlhook/CronetImageUrlHook;Ljava/lang/String;ZILjava/lang/Object;)V
+	public final fun addImageUrlSuccessCallbackHook (Ljava/lang/String;)V
+	public fun execute (Lapp/revanced/patcher/data/BytecodeContext;)V
+	public synthetic fun execute (Lapp/revanced/patcher/data/Context;)V
+}
+
 public final class app/revanced/patches/youtube/misc/integrations/IntegrationsPatch : app/revanced/patches/shared/misc/integrations/BaseIntegrationsPatch {
 	public static final field INSTANCE Lapp/revanced/patches/youtube/misc/integrations/IntegrationsPatch;
 }

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 4.11.1-dev.1
+version = 4.12.0-dev.2

src/main/kotlin/app/revanced/patches/soundcloud/ad/HideAdsPatch.kt

@@ -10,7 +10,7 @@ import app.revanced.patcher.patch.annotation.CompatiblePackage
 import app.revanced.patcher.patch.annotation.Patch
 import app.revanced.patcher.util.smali.ExternalLabel
 import app.revanced.patches.soundcloud.ad.fingerprints.InterceptFingerprint
-import app.revanced.patches.soundcloud.ad.fingerprints.FeatureConstructorFingerprint
+import app.revanced.patches.soundcloud.shared.fingerprints.FeatureConstructorFingerprint
 import app.revanced.patches.soundcloud.ad.fingerprints.UserConsumerPlanConstructorFingerprint
 import app.revanced.util.resultOrThrow
 

src/main/kotlin/app/revanced/patches/soundcloud/offlinesync/EnableOfflineSyncPatch.kt

@@ -0,0 +1,83 @@
+package app.revanced.patches.soundcloud.offlinesync
+
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.extensions.InstructionExtensions.addInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructionsWithLabels
+import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.getInstructions
+import app.revanced.patcher.extensions.InstructionExtensions.replaceInstruction
+import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.annotation.CompatiblePackage
+import app.revanced.patcher.patch.annotation.Patch
+import app.revanced.patcher.util.smali.ExternalLabel
+import app.revanced.patches.soundcloud.offlinesync.fingerprints.DownloadOperationsHeaderVerificationFingerprint
+import app.revanced.patches.soundcloud.offlinesync.fingerprints.DownloadOperationsURLBuilderFingerprint
+import app.revanced.patches.soundcloud.shared.fingerprints.FeatureConstructorFingerprint
+import app.revanced.util.getReference
+import app.revanced.util.resultOrThrow
+import com.android.tools.smali.dexlib2.Opcode
+import com.android.tools.smali.dexlib2.iface.instruction.OneRegisterInstruction
+import com.android.tools.smali.dexlib2.iface.reference.FieldReference
+
+@Patch(
+    name = "Enable offline sync",
+    compatiblePackages = [CompatiblePackage("com.soundcloud.android")],
+)
+@Suppress("unused")
+object EnableOfflineSyncPatch : BytecodePatch(
+    setOf(
+        FeatureConstructorFingerprint, DownloadOperationsURLBuilderFingerprint,
+        DownloadOperationsHeaderVerificationFingerprint
+    ),
+) {
+    override fun execute(context: BytecodeContext) {
+        // Enable the feature to allow offline track syncing by modifying the JSON server response.
+        // This method is the constructor of a class representing a "Feature" object parsed from JSON data.
+        // p1 is the name of the feature.
+        // p2 is true if the feature is enabled, false otherwise.
+        FeatureConstructorFingerprint.resultOrThrow().mutableMethod.apply {
+            val afterCheckNotNullIndex = 2
+
+            addInstructionsWithLabels(
+                afterCheckNotNullIndex,
+                """
+                    const-string v0, "offline_sync"
+                    invoke-virtual { p1, v0 }, Ljava/lang/String;->equals(Ljava/lang/Object;)Z
+                    move-result v0
+                    if-eqz v0, :skip
+                    const/4 p2, 0x1
+                """,
+                ExternalLabel("skip", getInstruction(afterCheckNotNullIndex)),
+            )
+        }
+
+        // Patch the URL builder to use the HTTPS_STREAM endpoint
+        // instead of the offline sync endpoint to downloading the track.
+        DownloadOperationsURLBuilderFingerprint.resultOrThrow().mutableMethod.apply {
+            val getEndpointsEnumFieldIndex = 1
+            val getEndpointsEnumFieldInstruction = getInstruction<OneRegisterInstruction>(getEndpointsEnumFieldIndex)
+
+            val targetRegister = getEndpointsEnumFieldInstruction.registerA
+            val endpointsType = getEndpointsEnumFieldInstruction.getReference<FieldReference>()!!.type
+
+            replaceInstruction(
+                getEndpointsEnumFieldIndex,
+                "sget-object v$targetRegister, $endpointsType->HTTPS_STREAM:$endpointsType"
+            )
+        }
+
+        // The HTTPS_STREAM endpoint does not return the necessary headers for offline sync.
+        // Mock the headers to prevent the app from crashing by setting them to empty strings.
+        // The headers are all cosmetic and do not affect the functionality of the app.
+        DownloadOperationsHeaderVerificationFingerprint.resultOrThrow().mutableMethod.apply {
+            // The first three null checks need to be patched.
+            getInstructions().asSequence().filter {
+                it.opcode == Opcode.IF_EQZ
+            }.take(3).map { it.location.index }.forEach { nullCheckIndex ->
+                val headerStringRegister = getInstruction<OneRegisterInstruction>(nullCheckIndex).registerA
+
+                addInstruction(nullCheckIndex, "const-string v$headerStringRegister, \"\"")
+            }
+        }
+    }
+}

src/main/kotlin/app/revanced/patches/soundcloud/offlinesync/fingerprints/DownloadOperationsHeaderVerificationFingerprint.kt

@@ -0,0 +1,21 @@
+package app.revanced.patches.soundcloud.offlinesync.fingerprints
+
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.fingerprint.MethodFingerprint
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.Opcode
+
+internal object DownloadOperationsHeaderVerificationFingerprint : MethodFingerprint(
+    returnType = "V",
+    accessFlags = AccessFlags.PUBLIC or AccessFlags.FINAL,
+    parameters = listOf("L","L"),
+    opcodes = listOf(
+        Opcode.CONST_STRING,
+        Opcode.INVOKE_VIRTUAL,
+        Opcode.MOVE_RESULT_OBJECT,
+        Opcode.CONST_STRING
+    ),
+    customFingerprint = { _, classDef ->
+        classDef.sourceFile == "DownloadOperations.kt"
+    }
+)

src/main/kotlin/app/revanced/patches/soundcloud/offlinesync/fingerprints/DownloadOperationsURLBuilderFingerprint.kt

@@ -0,0 +1,20 @@
+package app.revanced.patches.soundcloud.offlinesync.fingerprints
+
+import app.revanced.patcher.extensions.or
+import app.revanced.patcher.fingerprint.MethodFingerprint
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.Opcode
+
+internal object DownloadOperationsURLBuilderFingerprint : MethodFingerprint(
+    returnType = "Ljava/lang/String",
+    accessFlags = AccessFlags.PUBLIC or AccessFlags.FINAL,
+    parameters = listOf("L","L"),
+    opcodes = listOf(
+        Opcode.IGET_OBJECT,
+        Opcode.SGET_OBJECT,
+        Opcode.FILLED_NEW_ARRAY
+    ),
+    customFingerprint = { _, classDef ->
+        classDef.sourceFile == "DownloadOperations.kt"
+    }
+)

src/main/kotlin/app/revanced/patches/soundcloud/shared/fingerprints/FeatureConstructorFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.soundcloud.ad.fingerprints
+package app.revanced.patches.soundcloud.shared.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/layout/thumbnails/AlternativeThumbnailsPatch.kt

@@ -1,36 +1,18 @@
 package app.revanced.patches.youtube.layout.thumbnails
 
 import app.revanced.patcher.data.BytecodeContext
-import app.revanced.patcher.extensions.InstructionExtensions.addInstruction
-import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
-import app.revanced.patcher.extensions.InstructionExtensions.getInstructions
-import app.revanced.patcher.fingerprint.MethodFingerprint
 import app.revanced.patcher.patch.BytecodePatch
 import app.revanced.patcher.patch.annotation.CompatiblePackage
 import app.revanced.patcher.patch.annotation.Patch
-import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
-import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
 import app.revanced.patches.all.misc.resources.AddResourcesPatch
 import app.revanced.patches.shared.misc.settings.preference.ListPreference
 import app.revanced.patches.shared.misc.settings.preference.NonInteractivePreference
 import app.revanced.patches.shared.misc.settings.preference.SwitchPreference
 import app.revanced.patches.shared.misc.settings.preference.TextPreference
-import app.revanced.patches.youtube.layout.thumbnails.fingerprints.MessageDigestImageUrlFingerprint
-import app.revanced.patches.youtube.layout.thumbnails.fingerprints.MessageDigestImageUrlParentFingerprint
-import app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet.RequestFingerprint
-import app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet.request.callback.OnFailureFingerprint
-import app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet.request.callback.OnResponseStartedFingerprint
-import app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet.request.callback.OnSucceededFingerprint
+import app.revanced.patches.youtube.misc.imageurlhook.CronetImageUrlHook
 import app.revanced.patches.youtube.misc.integrations.IntegrationsPatch
 import app.revanced.patches.youtube.misc.navigation.NavigationBarHookPatch
 import app.revanced.patches.youtube.misc.settings.SettingsPatch
-import app.revanced.util.resultOrThrow
-import com.android.tools.smali.dexlib2.AccessFlags
-import com.android.tools.smali.dexlib2.Opcode
-import com.android.tools.smali.dexlib2.builder.MutableMethodImplementation
-import com.android.tools.smali.dexlib2.iface.instruction.ReferenceInstruction
-import com.android.tools.smali.dexlib2.iface.reference.FieldReference
-import com.android.tools.smali.dexlib2.immutable.ImmutableMethod
 
 @Patch(
     name = "Alternative thumbnails",
@@ -39,7 +21,8 @@ import com.android.tools.smali.dexlib2.immutable.ImmutableMethod
         IntegrationsPatch::class,
         SettingsPatch::class,
         AddResourcesPatch::class,
-        NavigationBarHookPatch::class
+        NavigationBarHookPatch::class,
+        CronetImageUrlHook::class
     ],
     compatiblePackages = [
         CompatiblePackage(
@@ -74,65 +57,10 @@ import com.android.tools.smali.dexlib2.immutable.ImmutableMethod
     ],
 )
 @Suppress("unused")
-object AlternativeThumbnailsPatch : BytecodePatch(
-    setOf(
-        MessageDigestImageUrlParentFingerprint,
-        OnResponseStartedFingerprint,
-        RequestFingerprint,
-    ),
-) {
+object AlternativeThumbnailsPatch : BytecodePatch(emptySet()) {
     private const val INTEGRATIONS_CLASS_DESCRIPTOR =
         "Lapp/revanced/integrations/youtube/patches/AlternativeThumbnailsPatch;"
 
-    private lateinit var loadImageUrlMethod: MutableMethod
-    private var loadImageUrlIndex = 0
-
-    private lateinit var loadImageSuccessCallbackMethod: MutableMethod
-    private var loadImageSuccessCallbackIndex = 0
-
-    private lateinit var loadImageErrorCallbackMethod: MutableMethod
-    private var loadImageErrorCallbackIndex = 0
-
-    /**
-     * @param highPriority If the hook should be called before all other hooks.
-     */
-    @Suppress("SameParameterValue")
-    private fun addImageUrlHook(targetMethodClass: String, highPriority: Boolean) {
-        loadImageUrlMethod.addInstructions(
-            if (highPriority) 0 else loadImageUrlIndex,
-            """
-                invoke-static { p1 }, $targetMethodClass->overrideImageURL(Ljava/lang/String;)Ljava/lang/String;
-                move-result-object p1
-                """,
-        )
-        loadImageUrlIndex += 2
-    }
-
-    /**
-     * If a connection completed, which includes normal 200 responses but also includes
-     * status 404 and other error like http responses.
-     */
-    @Suppress("SameParameterValue")
-    private fun addImageUrlSuccessCallbackHook(targetMethodClass: String) {
-        loadImageSuccessCallbackMethod.addInstruction(
-            loadImageSuccessCallbackIndex++,
-            "invoke-static { p1, p2 }, $targetMethodClass->handleCronetSuccess(" +
-                "Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;)V",
-        )
-    }
-
-    /**
-     * If a connection outright failed to complete any connection.
-     */
-    @Suppress("SameParameterValue")
-    private fun addImageUrlErrorCallbackHook(targetMethodClass: String) {
-        loadImageErrorCallbackMethod.addInstruction(
-            loadImageErrorCallbackIndex++,
-            "invoke-static { p1, p2, p3 }, $targetMethodClass->handleCronetFailure(" +
-                "Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;Ljava/io/IOException;)V",
-        )
-    }
-
     override fun execute(context: BytecodeContext) {
         AddResourcesPatch(this::class)
 
@@ -177,62 +105,8 @@ object AlternativeThumbnailsPatch : BytecodePatch(
             ListPreference("revanced_alt_thumbnail_stills_time", summaryKey = null)
         )
 
-        fun MethodFingerprint.alsoResolve(fingerprint: MethodFingerprint) =
-            also { resolve(context, fingerprint.resultOrThrow().classDef) }.resultOrThrow()
-
-        fun MethodFingerprint.resolveAndLetMutableMethod(
-            fingerprint: MethodFingerprint,
-            block: (MutableMethod) -> Unit,
-        ) = alsoResolve(fingerprint).also { block(it.mutableMethod) }
-
-        MessageDigestImageUrlFingerprint.resolveAndLetMutableMethod(MessageDigestImageUrlParentFingerprint) {
-            loadImageUrlMethod = it
-            addImageUrlHook(INTEGRATIONS_CLASS_DESCRIPTOR, true)
-        }
-
-        OnSucceededFingerprint.resolveAndLetMutableMethod(OnResponseStartedFingerprint) {
-            loadImageSuccessCallbackMethod = it
-            addImageUrlSuccessCallbackHook(INTEGRATIONS_CLASS_DESCRIPTOR)
-        }
-
-        OnFailureFingerprint.resolveAndLetMutableMethod(OnResponseStartedFingerprint) {
-            loadImageErrorCallbackMethod = it
-            addImageUrlErrorCallbackHook(INTEGRATIONS_CLASS_DESCRIPTOR)
-        }
-
-        // The URL is required for the failure callback hook, but the URL field is obfuscated.
-        // Add a helper get method that returns the URL field.
-        RequestFingerprint.resultOrThrow().apply {
-            // The url is the only string field that is set inside the constructor.
-            val urlFieldInstruction = mutableMethod.getInstructions().first {
-                if (it.opcode != Opcode.IPUT_OBJECT) return@first false
-
-                val reference = (it as ReferenceInstruction).reference as FieldReference
-                reference.type == "Ljava/lang/String;"
-            } as ReferenceInstruction
-
-            val urlFieldName = (urlFieldInstruction.reference as FieldReference).name
-            val definingClass = RequestFingerprint.IMPLEMENTATION_CLASS_NAME
-            val addedMethodName = "getHookedUrl"
-            mutableClass.methods.add(
-                ImmutableMethod(
-                    definingClass,
-                    addedMethodName,
-                    emptyList(),
-                    "Ljava/lang/String;",
-                    AccessFlags.PUBLIC.value,
-                    null,
-                    null,
-                    MutableMethodImplementation(2),
-                ).toMutable().apply {
-                    addInstructions(
-                        """
-                        iget-object v0, p0, $definingClass->$urlFieldName:Ljava/lang/String;
-                        return-object v0
-                    """,
-                    )
-                },
-            )
-        }
+        CronetImageUrlHook.addImageUrlHook(INTEGRATIONS_CLASS_DESCRIPTOR)
+        CronetImageUrlHook.addImageUrlSuccessCallbackHook(INTEGRATIONS_CLASS_DESCRIPTOR)
+        CronetImageUrlHook.addImageUrlErrorCallbackHook(INTEGRATIONS_CLASS_DESCRIPTOR)
     }
 }

src/main/kotlin/app/revanced/patches/youtube/layout/thumbnails/BypassImageRegionRestrictions.kt

@@ -0,0 +1,71 @@
+package app.revanced.patches.youtube.layout.thumbnails
+
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.annotation.CompatiblePackage
+import app.revanced.patcher.patch.annotation.Patch
+import app.revanced.patches.all.misc.resources.AddResourcesPatch
+import app.revanced.patches.shared.misc.settings.preference.SwitchPreference
+import app.revanced.patches.youtube.misc.imageurlhook.CronetImageUrlHook
+import app.revanced.patches.youtube.misc.integrations.IntegrationsPatch
+import app.revanced.patches.youtube.misc.settings.SettingsPatch
+
+@Patch(
+    name = "Bypass image region restrictions",
+    description = "Adds an option to use a different host for user avatar and channel images," +
+            "and can fix missing images that are blocked in some countries.",
+    dependencies = [
+        IntegrationsPatch::class,
+        SettingsPatch::class,
+        AddResourcesPatch::class,
+        CronetImageUrlHook::class
+    ],
+    compatiblePackages = [
+        CompatiblePackage(
+            "com.google.android.youtube",
+            [
+                "18.32.39",
+                "18.37.36",
+                "18.38.44",
+                "18.43.45",
+                "18.44.41",
+                "18.45.43",
+                "18.48.39",
+                "18.49.37",
+                "19.01.34",
+                "19.02.39",
+                "19.03.36",
+                "19.04.38",
+                "19.05.36",
+                "19.06.39",
+                "19.07.40",
+                "19.08.36",
+                "19.09.38",
+                "19.10.39",
+                "19.11.43",
+                "19.12.41",
+                "19.13.37",
+                "19.14.43",
+                "19.15.36",
+                "19.16.39",
+            ]
+        )
+    ]
+)
+@Suppress("unused")
+object BypassImageRegionRestrictions : BytecodePatch(emptySet()) {
+    private const val INTEGRATIONS_CLASS_DESCRIPTOR =
+        "Lapp/revanced/integrations/youtube/patches/BypassImageRegionRestrictionsPatch;"
+
+    override fun execute(context: BytecodeContext) {
+        AddResourcesPatch(this::class)
+
+        SettingsPatch.PreferenceScreen.GENERAL_LAYOUT.addPreferences(
+            SwitchPreference("revanced_bypass_image_region_restrictions")
+        )
+
+        // A priority hook is not needed, as the image urls of interest are not modified
+        // by AlternativeThumbnails or any other patch in this repo.
+        CronetImageUrlHook.addImageUrlHook(INTEGRATIONS_CLASS_DESCRIPTOR)
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/misc/imageurlhook/CronetImageUrlHook.kt

@@ -0,0 +1,134 @@
+package app.revanced.patches.youtube.misc.imageurlhook
+
+import app.revanced.patcher.data.BytecodeContext
+import app.revanced.patcher.extensions.InstructionExtensions.addInstruction
+import app.revanced.patcher.extensions.InstructionExtensions.addInstructions
+import app.revanced.patcher.extensions.InstructionExtensions.getInstructions
+import app.revanced.patcher.fingerprint.MethodFingerprint
+import app.revanced.patcher.patch.BytecodePatch
+import app.revanced.patcher.patch.annotation.Patch
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod
+import app.revanced.patcher.util.proxy.mutableTypes.MutableMethod.Companion.toMutable
+import app.revanced.patches.youtube.misc.imageurlhook.fingerprints.MessageDigestImageUrlFingerprint
+import app.revanced.patches.youtube.misc.imageurlhook.fingerprints.MessageDigestImageUrlParentFingerprint
+import app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet.RequestFingerprint
+import app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet.request.callback.OnFailureFingerprint
+import app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet.request.callback.OnResponseStartedFingerprint
+import app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet.request.callback.OnSucceededFingerprint
+import app.revanced.patches.youtube.misc.integrations.IntegrationsPatch
+import app.revanced.util.resultOrThrow
+import com.android.tools.smali.dexlib2.AccessFlags
+import com.android.tools.smali.dexlib2.Opcode
+import com.android.tools.smali.dexlib2.builder.MutableMethodImplementation
+import com.android.tools.smali.dexlib2.iface.instruction.ReferenceInstruction
+import com.android.tools.smali.dexlib2.iface.reference.FieldReference
+import com.android.tools.smali.dexlib2.immutable.ImmutableMethod
+
+@Patch(
+    description = "Hooks Cronet image urls",
+    dependencies = [
+        IntegrationsPatch::class
+    ]
+)
+object CronetImageUrlHook : BytecodePatch(
+    setOf(
+        MessageDigestImageUrlParentFingerprint,
+        OnResponseStartedFingerprint,
+        RequestFingerprint
+    )
+) {
+    private lateinit var loadImageUrlMethod: MutableMethod
+    private var loadImageUrlIndex = 0
+
+    private lateinit var loadImageSuccessCallbackMethod: MutableMethod
+    private var loadImageSuccessCallbackIndex = 0
+
+    private lateinit var loadImageErrorCallbackMethod: MutableMethod
+    private var loadImageErrorCallbackIndex = 0
+
+    /**
+     * @param highPriority If the hook should be called before all other hooks.
+     */
+    fun addImageUrlHook(targetMethodClass: String, highPriority: Boolean = false) {
+        loadImageUrlMethod.addInstructions(
+            if (highPriority) 0 else loadImageUrlIndex,
+            """
+                invoke-static { p1 }, $targetMethodClass->overrideImageURL(Ljava/lang/String;)Ljava/lang/String;
+                move-result-object p1
+                """,
+        )
+        loadImageUrlIndex += 2
+    }
+
+    /**
+     * If a connection completed, which includes normal 200 responses but also includes
+     * status 404 and other error like http responses.
+     */
+    fun addImageUrlSuccessCallbackHook(targetMethodClass: String) {
+        loadImageSuccessCallbackMethod.addInstruction(
+            loadImageSuccessCallbackIndex++,
+            "invoke-static { p1, p2 }, $targetMethodClass->handleCronetSuccess(" +
+                "Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;)V",
+        )
+    }
+
+    /**
+     * If a connection outright failed to complete any connection.
+     */
+    fun addImageUrlErrorCallbackHook(targetMethodClass: String) {
+        loadImageErrorCallbackMethod.addInstruction(
+            loadImageErrorCallbackIndex++,
+            "invoke-static { p1, p2, p3 }, $targetMethodClass->handleCronetFailure(" +
+                "Lorg/chromium/net/UrlRequest;Lorg/chromium/net/UrlResponseInfo;Ljava/io/IOException;)V",
+        )
+    }
+
+    override fun execute(context: BytecodeContext) {
+        fun MethodFingerprint.alsoResolve(fingerprint: MethodFingerprint) =
+            also { resolve(context, fingerprint.resultOrThrow().classDef) }.resultOrThrow()
+
+        loadImageUrlMethod = MessageDigestImageUrlFingerprint
+            .alsoResolve(MessageDigestImageUrlParentFingerprint).mutableMethod
+
+        loadImageSuccessCallbackMethod = OnSucceededFingerprint
+            .alsoResolve(OnResponseStartedFingerprint).mutableMethod
+
+        loadImageErrorCallbackMethod = OnFailureFingerprint
+            .alsoResolve(OnResponseStartedFingerprint).mutableMethod
+
+        // The URL is required for the failure callback hook, but the URL field is obfuscated.
+        // Add a helper get method that returns the URL field.
+        RequestFingerprint.resultOrThrow().apply {
+            // The url is the only string field that is set inside the constructor.
+            val urlFieldInstruction = mutableMethod.getInstructions().single {
+                if (it.opcode != Opcode.IPUT_OBJECT) return@single false
+
+                val reference = (it as ReferenceInstruction).reference as FieldReference
+                reference.type == "Ljava/lang/String;"
+            } as ReferenceInstruction
+
+            val urlFieldName = (urlFieldInstruction.reference as FieldReference).name
+            val definingClass = RequestFingerprint.IMPLEMENTATION_CLASS_NAME
+            val addedMethodName = "getHookedUrl"
+            mutableClass.methods.add(
+                ImmutableMethod(
+                    definingClass,
+                    addedMethodName,
+                    emptyList(),
+                    "Ljava/lang/String;",
+                    AccessFlags.PUBLIC.value,
+                    null,
+                    null,
+                    MutableMethodImplementation(2),
+                ).toMutable().apply {
+                    addInstructions(
+                        """
+                        iget-object v0, p0, $definingClass->$urlFieldName:Ljava/lang/String;
+                        return-object v0
+                    """,
+                    )
+                }
+            )
+        }
+    }
+}

src/main/kotlin/app/revanced/patches/youtube/misc/imageurlhook/fingerprints/MessageDigestImageUrlFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.layout.thumbnails.fingerprints
+package app.revanced.patches.youtube.misc.imageurlhook.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/misc/imageurlhook/fingerprints/MessageDigestImageUrlParentFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.layout.thumbnails.fingerprints
+package app.revanced.patches.youtube.misc.imageurlhook.fingerprints
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/misc/imageurlhook/fingerprints/cronet/RequestFingerprint.kt

@@ -1,8 +1,8 @@
-package app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet
+package app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint
-import app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet.RequestFingerprint.IMPLEMENTATION_CLASS_NAME
+import app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet.RequestFingerprint.IMPLEMENTATION_CLASS_NAME
 import com.android.tools.smali.dexlib2.AccessFlags
 
 internal object RequestFingerprint : MethodFingerprint(

src/main/kotlin/app/revanced/patches/youtube/misc/imageurlhook/fingerprints/cronet/request/callback/OnFailureFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet.request.callback
+package app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet.request.callback
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/misc/imageurlhook/fingerprints/cronet/request/callback/OnResponseStartedFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet.request.callback
+package app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet.request.callback
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/kotlin/app/revanced/patches/youtube/misc/imageurlhook/fingerprints/cronet/request/callback/OnSucceededFingerprint.kt

@@ -1,4 +1,4 @@
-package app.revanced.patches.youtube.layout.thumbnails.fingerprints.cronet.request.callback
+package app.revanced.patches.youtube.misc.imageurlhook.fingerprints.cronet.request.callback
 
 import app.revanced.patcher.extensions.or
 import app.revanced.patcher.fingerprint.MethodFingerprint

src/main/resources/addresources/values/strings.xml

@@ -998,6 +998,11 @@ This is because Crowdin requires temporarily flattening this file and removing t
             <string name="revanced_seekbar_custom_color_value_summary">The color of the seekbar</string>
             <string name="revanced_seekbar_custom_color_invalid">Invalid seekbar color value. Using default value.</string>
         </patch>
+        <patch id="layout.thumbnails.BypassImageRegionRestrictions">
+            <string name="revanced_bypass_image_region_restrictions_title">Bypass image region restrictions</string>
+            <string name="revanced_bypass_image_region_restrictions_summary_on">Using image host yt4.ggpht.com</string>
+            <string name="revanced_bypass_image_region_restrictions_summary_off">Using original image host\n\nEnabling this can fix missing images that are blocked in some regions</string>
+        </patch>
         <patch id="layout.thumbnails.AlternativeThumbnailsPatch">
             <!-- 'Home' should be translated using the same localized wording YouTube displays for the home tab. -->
             <string name="revanced_alt_thumbnail_home_title">Home tab</string>