feat(Custom branding): Add in-app settings to change icon and name

extensions/shared/library/src/main/java/app/revanced/extension/shared/GmsCoreSupport.java

@@ -31,9 +31,6 @@
 
 @SuppressWarnings("unused")
 public class GmsCoreSupport {
-    private static final String PACKAGE_NAME_YOUTUBE = "com.google.android.youtube";
-    private static final String PACKAGE_NAME_YOUTUBE_MUSIC = "com.google.android.apps.youtube.music";
-
     private static final String GMS_CORE_PACKAGE_NAME
             = getGmsCoreVendorGroupId() + ".android.gms";
     private static final Uri GMS_CORE_PROVIDER
@@ -53,6 +50,20 @@ public class GmsCoreSupport {
     @Nullable
     private static volatile Boolean DONT_KILL_MY_APP_MANUFACTURER_SUPPORTED;
 
+    private static String getOriginalPackageName() {
+       return null; // Modified during patching.
+    }
+
+    /**
+     * @return If the current package name is the same as the original unpatched app.
+     *         If `GmsCore support` was not included during patching, this returns true;
+     */
+    public static boolean isPackageNameOriginal() {
+        String originalPackageName = getOriginalPackageName();
+        return originalPackageName == null
+                || originalPackageName.equals(Utils.getContext().getPackageName());
+    }
+
     private static void open(String queryOrLink) {
         Logger.printInfo(() -> "Opening link: " + queryOrLink);
 
@@ -113,11 +124,10 @@ public static void checkGmsCore(Activity context) {
             // Verify the user has not included GmsCore for a root installation.
             // GmsCore Support changes the package name, but with a mounted installation
             // all manifest changes are ignored and the original package name is used.
-            String packageName = context.getPackageName();
-            if (packageName.equals(PACKAGE_NAME_YOUTUBE) || packageName.equals(PACKAGE_NAME_YOUTUBE_MUSIC)) {
+            if (isPackageNameOriginal()) {
                 Logger.printInfo(() -> "App is mounted with root, but GmsCore patch was included");
-                // Cannot use localize text here, since the app will load
-                // resources from the unpatched app and all patch strings are missing.
+                // Cannot use localize text here, since the app will load resources
+                // from the unpatched app and all patch strings are missing.
                 Utils.showToastLong("The 'GmsCore support' patch breaks mount installations");
 
                 // Do not exit. If the app exits before launch completes (and without
@@ -250,8 +260,8 @@ private static String getGmsCoreDownload() {
         };
     }
 
-    // Modified by a patch. Do not touch.
     private static String getGmsCoreVendorGroupId() {
-        return "app.revanced";
+        // Modified during patching.
+        throw new IllegalStateException();
     }
 }

extensions/shared/library/src/main/java/app/revanced/extension/shared/patches/CustomBrandingPatch.java

@@ -0,0 +1,136 @@
+package app.revanced.extension.shared.patches;
+
+import android.content.ComponentName;
+import android.content.Context;
+import android.content.pm.PackageManager;
+
+import java.util.ArrayList;
+import java.util.List;
+
+import app.revanced.extension.shared.GmsCoreSupport;
+import app.revanced.extension.shared.Logger;
+import app.revanced.extension.shared.Utils;
+import app.revanced.extension.shared.settings.BaseSettings;
+
+/**
+ * Patch shared by YouTube and YT Music.
+ */
+@SuppressWarnings("unused")
+public class CustomBrandingPatch {
+
+    // Important: In the future, additional branding themes can be added but all existing and prior
+    // themes cannot be removed or renamed.
+    //
+    // This is because if a user has a branding theme selected, then only that launch alias is enabled.
+    // If a future update removes or renames that alias, then after updating the app is effectively
+    // broken and it cannot be opened and not even clearing the app data will fix it.
+    // In that situation the only fix is to completely uninstall and reinstall again.
+    //
+    // The most that can be done is to hide a theme from the UI and keep the alias with dummy data.
+    public enum BrandingTheme {
+        /**
+         * Original unpatched icon. Must be first enum.
+         */
+        ORIGINAL("revanced_original"),
+        ROUNDED("revanced_rounded"),
+        MINIMAL("revanced_minimal"),
+        SCALED("revanced_scaled"),
+        /**
+         * User provided custom icon. Must be the last enum.
+         */
+        CUSTOM("revanced_custom");
+
+        public final String themeAlias;
+
+        BrandingTheme(String themeAlias) {
+            this.themeAlias = themeAlias;
+        }
+
+        private String packageAndNameIndexToClassAlias(String packageName, int appIndex) {
+            if (appIndex <= 0) {
+                throw new IllegalArgumentException("App index starts at index 1");
+            }
+            return packageName + '.' + themeAlias + '_' + appIndex;
+        }
+    }
+
+    /**
+     * Injection point.
+     *
+     * The total number of app name aliases, including dummy aliases.
+     */
+    private static int numberOfPresetAppNames() {
+        // Modified during patching.
+        throw new IllegalStateException();
+    }
+
+    /**
+     * Injection point.
+     */
+    @SuppressWarnings("ConstantConditions")
+    public static void setBranding() {
+        try {
+            if (GmsCoreSupport.isPackageNameOriginal()) {
+                Logger.printInfo(() -> "App is root mounted. Cannot dynamically change app icon");
+                return;
+            }
+
+            Context context = Utils.getContext();
+            PackageManager pm = context.getPackageManager();
+            String packageName = context.getPackageName();
+
+            BrandingTheme selectedBranding = BaseSettings.CUSTOM_BRANDING_ICON.get();
+            final int selectedNameIndex = BaseSettings.CUSTOM_BRANDING_NAME.get();
+            ComponentName componentToEnable = null;
+            ComponentName defaultComponent = null;
+            List<ComponentName> componentsToDisable = new ArrayList<>();
+
+            for (BrandingTheme theme : BrandingTheme.values()) {
+                // Must always update all aliases including custom alias (last index).
+                final int numberOfPresetAppNames = numberOfPresetAppNames();
+
+                // App name indices starts at 1.
+                for (int index = 1; index <= numberOfPresetAppNames; index++) {
+                    String aliasClass = theme.packageAndNameIndexToClassAlias(packageName, index);
+                    ComponentName component = new ComponentName(packageName, aliasClass);
+                    if (defaultComponent == null) {
+                        // Default is always the first alias.
+                        defaultComponent = component;
+                    }
+
+                    if (index == selectedNameIndex && theme == selectedBranding) {
+                        componentToEnable = component;
+                    } else {
+                        componentsToDisable.add(component);
+                    }
+                }
+            }
+
+            if (componentToEnable == null) {
+                // User imported a bad app name index value. Either the imported data
+                // was corrupted, or they previously had custom name enabled and the app
+                // no longer has a custom name specified.
+                Utils.showToastLong("Custom branding reset");
+                BaseSettings.CUSTOM_BRANDING_ICON.resetToDefault();
+                BaseSettings.CUSTOM_BRANDING_NAME.resetToDefault();
+
+                componentToEnable = defaultComponent;
+                componentsToDisable.remove(defaultComponent);
+            }
+
+            for (ComponentName disable : componentsToDisable) {
+                // Use info logging because if the alias status become corrupt the app cannot launch.
+                Logger.printInfo(() -> "Disabling: " + disable.getClassName());
+                pm.setComponentEnabledSetting(disable,
+                        PackageManager.COMPONENT_ENABLED_STATE_DISABLED, PackageManager.DONT_KILL_APP);
+            }
+
+            ComponentName componentToEnableFinal = componentToEnable;
+            Logger.printInfo(() -> "Enabling:  " + componentToEnableFinal.getClassName());
+            pm.setComponentEnabledSetting(componentToEnable,
+                    PackageManager.COMPONENT_ENABLED_STATE_ENABLED, 0);
+        } catch (Exception ex) {
+            Logger.printException(() -> "setBranding failure", ex);
+        }
+    }
+}

extensions/shared/library/src/main/java/app/revanced/extension/shared/settings/BaseSettings.java

@@ -2,6 +2,7 @@
 
 import static java.lang.Boolean.FALSE;
 import static java.lang.Boolean.TRUE;
+import static app.revanced.extension.shared.patches.CustomBrandingPatch.BrandingTheme;
 import static app.revanced.extension.shared.settings.Setting.parent;
 import static app.revanced.extension.shared.spoof.SpoofVideoStreamsPatch.AudioStreamLanguageOverrideAvailability;
 
@@ -40,4 +41,7 @@ public class BaseSettings {
     public static final BooleanSetting REPLACE_MUSIC_LINKS_WITH_YOUTUBE = new BooleanSetting("revanced_replace_music_with_youtube", FALSE);
 
     public static final BooleanSetting CHECK_WATCH_HISTORY_DOMAIN_NAME = new BooleanSetting("revanced_check_watch_history_domain_name", TRUE, false, false);
+
+    public static final EnumSetting<BrandingTheme> CUSTOM_BRANDING_ICON = new EnumSetting<>("revanced_custom_branding_icon", BrandingTheme.ORIGINAL, true);
+    public static final IntegerSetting CUSTOM_BRANDING_NAME = new IntegerSetting("revanced_custom_branding_name", 1, true);
 }

extensions/shared/library/src/main/java/app/revanced/extension/shared/settings/preference/ReVancedAboutPreference.java

@@ -5,6 +5,7 @@
 import static app.revanced.extension.shared.requests.Route.Method.GET;
 
 import android.annotation.SuppressLint;
+import android.app.Activity;
 import android.app.Dialog;
 import android.app.ProgressDialog;
 import android.content.Context;
@@ -125,6 +126,8 @@ private String createDialogHtml(WebLink[] aboutLinks) {
 
     {
         setOnPreferenceClickListener(pref -> {
+            Context context = pref.getContext();
+
             // Show a progress spinner if the social links are not fetched yet.
             if (!AboutLinksRoutes.hasFetchedLinks() && Utils.isNetworkConnected()) {
                 // Show a progress spinner, but only if the api fetch takes more than a half a second.
@@ -137,17 +140,18 @@ private String createDialogHtml(WebLink[] aboutLinks) {
                 handler.postDelayed(showDialogRunnable, delayToShowProgressSpinner);
 
                 Utils.runOnBackgroundThread(() ->
-                        fetchLinksAndShowDialog(handler, showDialogRunnable, progress));
+                        fetchLinksAndShowDialog(context, handler, showDialogRunnable, progress));
             } else {
                 // No network call required and can run now.
-                fetchLinksAndShowDialog(null, null, null);
+                fetchLinksAndShowDialog(context, null, null, null);
             }
 
             return false;
         });
     }
 
-    private void fetchLinksAndShowDialog(@Nullable Handler handler,
+    private void fetchLinksAndShowDialog(Context context,
+                                         @Nullable Handler handler,
                                          Runnable showDialogRunnable,
                                          @Nullable ProgressDialog progress) {
         WebLink[] links = AboutLinksRoutes.fetchAboutLinks();
@@ -164,7 +168,17 @@ private void fetchLinksAndShowDialog(@Nullable Handler handler,
             if (handler != null) {
                 handler.removeCallbacks(showDialogRunnable);
             }
-            if (progress != null) {
+
+            // Don't continue if the activity is done. To test this tap the
+            // about dialog and immediately press back before the dialog can show.
+            if (context instanceof Activity activity) {
+                if (activity.isFinishing() || activity.isDestroyed()) {
+                    Logger.printDebug(() -> "Not showing about dialog, activity is closed");
+                    return;
+                }
+            }
+
+            if (progress != null && progress.isShowing()) {
                 progress.dismiss();
             }
             new WebViewDialog(getContext(), htmlDialog).show();

patches/api/patches.api

@@ -1919,6 +1919,7 @@ public final class app/revanced/util/ResourceUtilsKt {
 	public static final fun forEachChildElement (Lorg/w3c/dom/Node;Lkotlin/jvm/functions/Function1;)V
 	public static final fun insertFirst (Lorg/w3c/dom/Node;Lorg/w3c/dom/Node;)V
 	public static final fun iterateXmlNodeChildren (Lapp/revanced/patcher/patch/ResourcePatchContext;Ljava/lang/String;Ljava/lang/String;Lkotlin/jvm/functions/Function1;)V
+	public static final fun removeFromParent (Lorg/w3c/dom/Node;)Lorg/w3c/dom/Node;
 }
 
 public final class app/revanced/util/resource/ArrayResource : app/revanced/util/resource/BaseResource {

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

@@ -4,6 +4,10 @@ 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.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
+import app.revanced.patches.music.misc.settings.PreferenceScreen
 import app.revanced.patches.shared.layout.branding.baseCustomBrandingPatch
 import app.revanced.patches.shared.misc.mapping.get
 import app.revanced.patches.shared.misc.mapping.resourceMappingPatch
@@ -50,24 +54,18 @@ private val disableSplashAnimationPatch = bytecodePatch {
     }
 }
 
-private const val APP_NAME = "YT Music ReVanced"
-
 @Suppress("unused")
 val customBrandingPatch = baseCustomBrandingPatch(
-    defaultAppName = APP_NAME,
-    appNameValues = mapOf(
-        "YT Music ReVanced" to APP_NAME,
-        "Music ReVanced" to "Music ReVanced",
-        "Music" to "Music",
-        "YT Music" to "YT Music",
-    ),
-    resourceFolder = "custom-branding/music",
-    iconResourceFileNames = arrayOf(
-        "adaptiveproduct_youtube_music_2024_q4_background_color_108",
-        "adaptiveproduct_youtube_music_2024_q4_foreground_color_108",
-        "ic_launcher_release",
-    ),
-    monochromeIconFileNames = arrayOf("ic_app_icons_themed_youtube_music.xml"),
+    addResourcePatchName = "music",
+    originalLauncherIconName = "ic_launcher_release",
+    originalAppName = "@string/app_launcher_name",
+    originalAppPackageName = MUSIC_PACKAGE_NAME,
+    copyExistingIntentsToAliases = false,
+    numberOfPresetAppNames = 5,
+    mainActivityOnCreateFingerprint = musicActivityOnCreateFingerprint,
+    mainActivityName = MUSIC_MAIN_ACTIVITY_NAME,
+    activityAliasNameWithIntents = MUSIC_MAIN_ACTIVITY_NAME,
+    preferenceScreen = PreferenceScreen.GENERAL,
 
     block = {
         dependsOn(disableSplashAnimationPatch)

patches/src/main/kotlin/app/revanced/patches/music/misc/gms/Constants.kt

@@ -1,6 +1,8 @@
 package app.revanced.patches.music.misc.gms
 
 object Constants {
+    internal const val MUSIC_MAIN_ACTIVITY_NAME = "com.google.android.apps.youtube.music.activities.MusicActivity"
+
     internal const val REVANCED_MUSIC_PACKAGE_NAME = "app.revanced.android.apps.youtube.music"
     internal const val MUSIC_PACKAGE_NAME = "com.google.android.apps.youtube.music"
 }