fix custom icon/name settings missing when using some selective patch combinations

Author: LisoUseInAIKyrios

extensions/music/src/main/java/app/revanced/extension/music/settings/preference/MusicPreferenceFragment.java

@@ -5,6 +5,7 @@
 import android.widget.Toolbar;
 
 import app.revanced.extension.music.settings.MusicActivityHook;
+import app.revanced.extension.shared.GmsCoreSupport;
 import app.revanced.extension.shared.Logger;
 import app.revanced.extension.shared.Utils;
 import app.revanced.extension.shared.settings.preference.ToolbarPreferenceFragment;
@@ -30,6 +31,17 @@ protected void initialize() {
             preferenceScreen = getPreferenceScreen();
             Utils.sortPreferenceGroups(preferenceScreen);
             setPreferenceScreenToolbar(preferenceScreen);
+
+            // Clunky work around until preferences are custom classes that manage themselves.
+            // Custom branding only works with non-root install. But the preferences must be
+            // added during patched because of difficulties detecting during patching if it's
+            // a root install. So instead the non-functional preferences are removed during runtime
+            // if the app is mount (root) installation.
+            if (GmsCoreSupport.isPackageNameOriginal()) {
+                removePreferencesIfRooted(
+                        "revanced_custom_branding_name",
+                        "revanced_custom_branding_icon");
+            }
         } catch (Exception ex) {
             Logger.printException(() -> "initialize failure", ex);
         }

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

@@ -6,6 +6,7 @@
 import android.graphics.drawable.Drawable;
 import android.os.Build;
 import android.preference.Preference;
+import android.preference.PreferenceGroup;
 import android.preference.PreferenceScreen;
 import android.util.TypedValue;
 import android.view.ViewGroup;
@@ -22,6 +23,25 @@
 
 @SuppressWarnings({"deprecation", "NewApi"})
 public class ToolbarPreferenceFragment extends AbstractPreferenceFragment {
+
+    /**
+     * Removes the list of preferences from this fragment, if they exist.
+     * @param keys Preference keys.
+     */
+    protected void removePreferencesIfRooted(String ... keys) {
+        for (String key : keys) {
+            Preference pref = findPreference(key);
+            if (pref != null) {
+                Logger.printDebug(() -> "Removing root incompatible preference: " + key);
+                // remove the preference
+                PreferenceGroup parent = pref.getParent();
+                if (parent != null) {
+                    parent.removePreference(pref);
+                }
+            }
+        }
+    }
+
     /**
      * Sets toolbar for all nested preference screens.
      */

extensions/youtube/src/main/java/app/revanced/extension/youtube/settings/preference/YouTubePreferenceFragment.java

@@ -4,6 +4,7 @@
 import android.preference.PreferenceScreen;
 import android.widget.Toolbar;
 
+import app.revanced.extension.shared.GmsCoreSupport;
 import app.revanced.extension.shared.Logger;
 import app.revanced.extension.shared.Utils;
 import app.revanced.extension.shared.settings.preference.ToolbarPreferenceFragment;
@@ -30,6 +31,17 @@ protected void initialize() {
             preferenceScreen = getPreferenceScreen();
             Utils.sortPreferenceGroups(preferenceScreen);
             setPreferenceScreenToolbar(preferenceScreen);
+
+            // Clunky work around until preferences are custom classes that manage themselves.
+            // Custom branding only works with non-root install. But the preferences must be
+            // added during patched because of difficulties detecting during patching if it's
+            // a root install. So instead the non-functional preferences are removed during runtime
+            // if the app is mount (root) installation.
+            if (GmsCoreSupport.isPackageNameOriginal()) {
+                removePreferencesIfRooted(
+                        "revanced_custom_branding_name",
+                        "revanced_custom_branding_icon");
+            }
         } catch (Exception ex) {
             Logger.printException(() -> "initialize failure", ex);
         }

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

@@ -166,49 +166,49 @@ internal fun baseCustomBrandingPatch(
                 }
             }
         },
-        resourcePatch {
-            // Use a second resource patch so patching doesn't show custom branding finishing last.
-            finalize {
-                val useCustomName = customName != null
-                val useCustomIcon = customIcon != null
-
-                if (setOrGetFallbackPackageName(originalAppPackageName) == originalAppPackageName) {
-                    if (useCustomName || useCustomIcon) {
-                        Logger.getLogger(this::class.java.name).warning(
-                            "Custom branding does not work with root installation. No changes applied."
-                        )
-                    }
-                    return@finalize
-                }
+    )
 
-                preferenceScreen.addPreferences(
-                    if (useCustomName) {
-                        ListPreference(
-                            key = "revanced_custom_branding_name",
-                            entriesKey = "revanced_custom_branding_name_custom_entries",
-                            entryValuesKey = "revanced_custom_branding_name_custom_entry_values"
-                        )
-                    } else {
-                        ListPreference("revanced_custom_branding_name")
-                    },
-                    if (useCustomIcon) {
-                        ListPreference(
-                            key = "revanced_custom_branding_icon",
-                            entriesKey = "revanced_custom_branding_icon_custom_entries",
-                            entryValuesKey = "revanced_custom_branding_icon_custom_entry_values"
-                        )
-                    } else {
-                        ListPreference("revanced_custom_branding_icon")
-                    }
+    finalize {
+        // Can only check if app is root installation by checking if change package name patch is in use.
+        // and can only do that in the finalize block here.
+        // The UI preferences cannot be selectively added here, because the settings finalize block
+        // may have already run and the settings are already wrote to file.
+        // Instead, show a warning if any patch option was used (A rooted device launcher ignores the manifest changes),
+        // and the non-functional in-app settings are removed on app startup by extension code.
+        if (customName != null || customIcon != null) {
+            if (setOrGetFallbackPackageName(originalAppPackageName) == originalAppPackageName) {
+                Logger.getLogger(this::class.java.name).warning(
+                    "Custom branding does not work with root installation. No changes applied."
                 )
             }
         }
-    )
+    }
 
     execute {
         addResources("shared", "layout.branding.baseCustomBrandingPatch")
         addResources(addResourcePatchName, "layout.branding.customBrandingPatch")
 
+        preferenceScreen.addPreferences(
+            if (customName != null ) {
+                ListPreference(
+                    key = "revanced_custom_branding_name",
+                    entriesKey = "revanced_custom_branding_name_custom_entries",
+                    entryValuesKey = "revanced_custom_branding_name_custom_entry_values"
+                )
+            } else {
+                ListPreference("revanced_custom_branding_name")
+            },
+            if (customIcon != null) {
+                ListPreference(
+                    key = "revanced_custom_branding_icon",
+                    entriesKey = "revanced_custom_branding_icon_custom_entries",
+                    entryValuesKey = "revanced_custom_branding_icon_custom_entry_values"
+                )
+            } else {
+                ListPreference("revanced_custom_branding_icon")
+            }
+        )
+
         val useCustomName = customName != null
         val useCustomIcon = customIcon != null
 
@@ -228,7 +228,6 @@ internal fun baseCustomBrandingPatch(
             )
         }
 
-
         copyResources(
             "custom-branding",
             // Push notification 'small' icon.