fix(YouTube - Custom branding): Do not add a broken custom icon if the user provides an invalid custom icon path

Author: LisoUseInAIKyrios

patches/src/main/kotlin/app/revanced/patches/music/layout/branding/CustomBrandingPatch.kt

@@ -4,6 +4,7 @@ import app.revanced.patcher.extensions.InstructionExtensions.addInstructionsWith
 import app.revanced.patcher.extensions.InstructionExtensions.getInstruction
 import app.revanced.patcher.patch.bytecodePatch
 import app.revanced.patcher.util.smali.ExternalLabel
+import app.revanced.patches.music.misc.extension.sharedExtensionPatch
 import app.revanced.patches.music.misc.gms.Constants.MUSIC_MAIN_ACTIVITY_NAME
 import app.revanced.patches.music.misc.gms.Constants.MUSIC_PACKAGE_NAME
 import app.revanced.patches.music.misc.gms.musicActivityOnCreateFingerprint
@@ -68,7 +69,7 @@ val customBrandingPatch = baseCustomBrandingPatch(
     preferenceScreen = PreferenceScreen.GENERAL,
 
     block = {
-        dependsOn(disableSplashAnimationPatch)
+        dependsOn(sharedExtensionPatch, disableSplashAnimationPatch)
 
         compatibleWith(
             "com.google.android.apps.youtube.music"(

patches/src/main/kotlin/app/revanced/patches/shared/layout/branding/BaseCustomBrandingPatch.kt

@@ -21,7 +21,6 @@ import app.revanced.util.findElementByAttributeValueOrThrow
 import app.revanced.util.removeFromParent
 import app.revanced.util.returnEarly
 import org.w3c.dom.Element
-import org.w3c.dom.Node
 import org.w3c.dom.NodeList
 import java.io.File
 import java.util.logging.Logger
@@ -106,6 +105,7 @@ internal fun baseCustomBrandingPatch(
 
     dependsOn(
         addResourcesPatch,
+
         bytecodePatch {
             execute {
                 mainActivityOnCreateFingerprint.method.addInstruction(
@@ -201,68 +201,6 @@ internal fun baseCustomBrandingPatch(
             )
         }
 
-        if (useCustomIcon) {
-            // Copy user provided files
-            val iconPathFile = File(customIcon!!.trim())
-
-            if (!iconPathFile.exists()) {
-                throw PatchException(
-                    "The custom icon path cannot be found: " + iconPathFile.absolutePath
-                )
-            }
-
-            if (!iconPathFile.isDirectory) {
-                throw PatchException(
-                    "The custom icon path must be a folder: " + iconPathFile.absolutePath
-                )
-            }
-
-            val sourceFolders = iconPathFile.listFiles { file -> file.isDirectory }
-                ?: throw PatchException("The custom icon path contains no subfolders: " +
-                        iconPathFile.absolutePath)
-
-            val resourceDirectory = get("res")
-            var copiedFiles = false
-
-            // For each source folder, copy the files to the target resource directories.
-            sourceFolders.forEach { dpiSourceFolder ->
-                val targetDpiFolder = resourceDirectory.resolve(dpiSourceFolder.name)
-                if (!targetDpiFolder.exists()) return@forEach
-
-                val customFiles = dpiSourceFolder.listFiles { file ->
-                    file.isFile && file.name in USER_CUSTOM_ADAPTIVE_FILE_NAMES
-                }!!
-
-                if (customFiles.size > 0 && customFiles.size != USER_CUSTOM_ADAPTIVE_FILE_NAMES.size) {
-                    throw PatchException("Must include all required icon files " +
-                            "but only found " + customFiles.map { it.name })
-                }
-
-                customFiles.forEach { imgSourceFile ->
-                    val imgTargetFile = targetDpiFolder.resolve(imgSourceFile.name)
-                    imgSourceFile.copyTo(target = imgTargetFile, overwrite = true)
-
-                    copiedFiles = true
-                }
-            }
-
-            // Copy monochrome if it provided.
-            val monochromeRelativePath = "drawable/$USER_CUSTOM_MONOCHROME_NAME"
-            val monochromeFile = iconPathFile.resolve(monochromeRelativePath)
-            if (monochromeFile.exists()) {
-                monochromeFile.copyTo(
-                    target = resourceDirectory.resolve(monochromeRelativePath),
-                    overwrite = true
-                )
-                copiedFiles = true
-            }
-
-            if (!copiedFiles) {
-                throw PatchException("Could not find any replacement images in " +
-                        "patch option path: " + iconPathFile.absolutePath)
-            }
-        }
-
         document("AndroidManifest.xml").use { document ->
             // Create launch aliases that can be programmatically selected in app.
             fun createAlias(
@@ -316,12 +254,20 @@ internal fun baseCustomBrandingPatch(
                 return alias
             }
 
+            val application = document.getElementsByTagName("application").item(0) as Element
             val intentFilters = document.childNodes.findElementByAttributeValueOrThrow(
                 "android:name",
                 activityAliasNameWithIntents
             ).childNodes
 
-            val application = document.getElementsByTagName("application").item(0) as Element
+            // The YT application name can appear in some places along side the system
+            // YouTube app, such as the settings app list and in the "open with" file picker.
+            // Because the YouTube app cannot be completely uninstalled and only disabled,
+            // use a custom name for this situation to disambiguate which app is which.
+            application.setAttribute(
+                "android:label",
+                "@string/revanced_custom_branding_name_entry_2"
+            )
 
             for (appNameIndex in 1 .. numberOfPresetAppNames) {
                 fun aliasName(name: String): String = ".revanced_" + name + '_' + appNameIndex
@@ -382,6 +328,70 @@ internal fun baseCustomBrandingPatch(
             ).removeFromParent()
         }
 
+        // Copy custom icons last, so if the user enters an invalid icon path
+        // and an exception is thrown then the critical manifest changes are still made.
+        if (useCustomIcon) {
+            // Copy user provided files
+            val iconPathFile = File(customIcon!!.trim())
+
+            if (!iconPathFile.exists()) {
+                throw PatchException(
+                    "The custom icon path cannot be found: " + iconPathFile.absolutePath
+                )
+            }
+
+            if (!iconPathFile.isDirectory) {
+                throw PatchException(
+                    "The custom icon path must be a folder: " + iconPathFile.absolutePath
+                )
+            }
+
+            val sourceFolders = iconPathFile.listFiles { file -> file.isDirectory }
+                ?: throw PatchException("The custom icon path contains no subfolders: " +
+                        iconPathFile.absolutePath)
+
+            val resourceDirectory = get("res")
+            var copiedFiles = false
+
+            // For each source folder, copy the files to the target resource directories.
+            sourceFolders.forEach { dpiSourceFolder ->
+                val targetDpiFolder = resourceDirectory.resolve(dpiSourceFolder.name)
+                if (!targetDpiFolder.exists()) return@forEach
+
+                val customFiles = dpiSourceFolder.listFiles { file ->
+                    file.isFile && file.name in USER_CUSTOM_ADAPTIVE_FILE_NAMES
+                }!!
+
+                if (customFiles.size > 0 && customFiles.size != USER_CUSTOM_ADAPTIVE_FILE_NAMES.size) {
+                    throw PatchException("Must include all required icon files " +
+                            "but only found " + customFiles.map { it.name })
+                }
+
+                customFiles.forEach { imgSourceFile ->
+                    val imgTargetFile = targetDpiFolder.resolve(imgSourceFile.name)
+                    imgSourceFile.copyTo(target = imgTargetFile, overwrite = true)
+
+                    copiedFiles = true
+                }
+            }
+
+            // Copy monochrome if it provided.
+            val monochromeRelativePath = "drawable/$USER_CUSTOM_MONOCHROME_NAME"
+            val monochromeFile = iconPathFile.resolve(monochromeRelativePath)
+            if (monochromeFile.exists()) {
+                monochromeFile.copyTo(
+                    target = resourceDirectory.resolve(monochromeRelativePath),
+                    overwrite = true
+                )
+                copiedFiles = true
+            }
+
+            if (!copiedFiles) {
+                throw PatchException("Could not find any replacement images in " +
+                        "patch option path: " + iconPathFile.absolutePath)
+            }
+        }
+
         executeBlock()
     }
 }