Merge pull request TeamNewPipe#12450 from TeamNewPipe/yt-trending-migration

Author: Stypox

app/build.gradle

@@ -214,7 +214,7 @@ dependencies {
     // the corresponding commit hash, since JitPack sometimes deletes artifacts.
     // If there’s already a git hash, just add more of it to the end (or remove a letter)
     // to cause jitpack to regenerate the artifact.
-    implementation 'com.github.TeamNewPipe:NewPipeExtractor:7adbc48a0aa872c016b8ec089e278d5e12772054'
+    implementation 'com.github.TeamNewPipe:NewPipeExtractor:v0.24.8'
     implementation 'com.github.TeamNewPipe:NoNonsense-FilePicker:5.0.0'
 
 /** Checkstyle **/

app/src/main/java/org/schabi/newpipe/MainActivity.java

@@ -78,8 +78,8 @@
 import org.schabi.newpipe.player.event.OnKeyDownListener;
 import org.schabi.newpipe.player.helper.PlayerHolder;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
-import org.schabi.newpipe.settings.SettingMigrations;
 import org.schabi.newpipe.settings.UpdateSettingsFragment;
+import org.schabi.newpipe.settings.migration.MigrationManager;
 import org.schabi.newpipe.util.Constants;
 import org.schabi.newpipe.util.DeviceUtils;
 import org.schabi.newpipe.util.KioskTranslator;
@@ -195,7 +195,7 @@ protected void onCreate(final Bundle savedInstanceState) {
             UpdateSettingsFragment.askForConsentToUpdateChecks(this);
         }
 
-        SettingMigrations.showUserInfoIfPresent(this);
+        MigrationManager.showUserInfoIfPresent(this);
     }
 
     @Override
@@ -263,19 +263,6 @@ public void onDrawerClosed(final View drawerView) {
      */
     private void addDrawerMenuForCurrentService() throws ExtractionException {
         //Tabs
-        final int currentServiceId = ServiceHelper.getSelectedServiceId(this);
-        final StreamingService service = NewPipe.getService(currentServiceId);
-
-        int kioskMenuItemId = 0;
-
-        for (final String ks : service.getKioskList().getAvailableKiosks()) {
-            drawerLayoutBinding.navigation.getMenu()
-                    .add(R.id.menu_tabs_group, kioskMenuItemId, 0, KioskTranslator
-                            .getTranslatedKioskName(ks, this))
-                    .setIcon(KioskTranslator.getKioskIcon(ks));
-            kioskMenuItemId++;
-        }
-
         drawerLayoutBinding.navigation.getMenu()
                 .add(R.id.menu_tabs_group, ITEM_ID_SUBSCRIPTIONS, ORDER,
                         R.string.tab_subscriptions)
@@ -293,6 +280,20 @@ private void addDrawerMenuForCurrentService() throws ExtractionException {
                 .add(R.id.menu_tabs_group, ITEM_ID_HISTORY, ORDER, R.string.action_history)
                 .setIcon(R.drawable.ic_history);
 
+        //Kiosks
+        final int currentServiceId = ServiceHelper.getSelectedServiceId(this);
+        final StreamingService service = NewPipe.getService(currentServiceId);
+
+        int kioskMenuItemId = 0;
+
+        for (final String ks : service.getKioskList().getAvailableKiosks()) {
+            drawerLayoutBinding.navigation.getMenu()
+                    .add(R.id.menu_kiosks_group, kioskMenuItemId, 0, KioskTranslator
+                            .getTranslatedKioskName(ks, this))
+                    .setIcon(KioskTranslator.getKioskIcon(ks));
+            kioskMenuItemId++;
+        }
+
         //Settings and About
         drawerLayoutBinding.navigation.getMenu()
                 .add(R.id.menu_options_about_group, ITEM_ID_SETTINGS, ORDER, R.string.settings)
@@ -312,10 +313,13 @@ private boolean drawerItemSelected(final MenuItem item) {
                 changeService(item);
                 break;
             case R.id.menu_tabs_group:
+                tabSelected(item);
+                break;
+            case R.id.menu_kiosks_group:
                 try {
-                    tabSelected(item);
+                    kioskSelected(item);
                 } catch (final Exception e) {
-                    ErrorUtil.showUiErrorSnackbar(this, "Selecting main page tab", e);
+                    ErrorUtil.showUiErrorSnackbar(this, "Selecting drawer kiosk", e);
                 }
                 break;
             case R.id.menu_options_about_group:
@@ -339,7 +343,7 @@ private void changeService(final MenuItem item) {
                 .setChecked(true);
     }
 
-    private void tabSelected(final MenuItem item) throws ExtractionException {
+    private void tabSelected(final MenuItem item) {
         switch (item.getItemId()) {
             case ITEM_ID_SUBSCRIPTIONS:
                 NavigationHelper.openSubscriptionFragment(getSupportFragmentManager());
@@ -356,18 +360,19 @@ private void tabSelected(final MenuItem item) throws ExtractionException {
             case ITEM_ID_HISTORY:
                 NavigationHelper.openStatisticFragment(getSupportFragmentManager());
                 break;
-            default:
-                final StreamingService currentService = ServiceHelper.getSelectedService(this);
-                int kioskMenuItemId = 0;
-                for (final String kioskId : currentService.getKioskList().getAvailableKiosks()) {
-                    if (kioskMenuItemId == item.getItemId()) {
-                        NavigationHelper.openKioskFragment(getSupportFragmentManager(),
-                                currentService.getServiceId(), kioskId);
-                        break;
-                    }
-                    kioskMenuItemId++;
-                }
+        }
+    }
+
+    private void kioskSelected(final MenuItem item) throws ExtractionException {
+        final StreamingService currentService = ServiceHelper.getSelectedService(this);
+        int kioskMenuItemId = 0;
+        for (final String kioskId : currentService.getKioskList().getAvailableKiosks()) {
+            if (kioskMenuItemId == item.getItemId()) {
+                NavigationHelper.openKioskFragment(getSupportFragmentManager(),
+                        currentService.getServiceId(), kioskId);
                 break;
+            }
+            kioskMenuItemId++;
         }
     }
 
@@ -408,6 +413,7 @@ private void toggleServices() {
 
         drawerLayoutBinding.navigation.getMenu().removeGroup(R.id.menu_services_group);
         drawerLayoutBinding.navigation.getMenu().removeGroup(R.id.menu_tabs_group);
+        drawerLayoutBinding.navigation.getMenu().removeGroup(R.id.menu_kiosks_group);
         drawerLayoutBinding.navigation.getMenu().removeGroup(R.id.menu_options_about_group);
 
         // Show up or down arrow

app/src/main/java/org/schabi/newpipe/settings/NewPipeSettings.java

@@ -13,6 +13,7 @@
 
 import org.schabi.newpipe.App;
 import org.schabi.newpipe.R;
+import org.schabi.newpipe.settings.migration.MigrationManager;
 import org.schabi.newpipe.util.DeviceUtils;
 
 import java.io.File;
@@ -46,7 +47,7 @@ private NewPipeSettings() { }
 
     public static void initSettings(final Context context) {
         // first run migrations, then setDefaultValues, since the latter requires the correct types
-        SettingMigrations.runMigrationsIfNeeded(context);
+        MigrationManager.runMigrationsIfNeeded(context);
 
         // readAgain is true so that if new settings are added their default value is set
         PreferenceManager.setDefaultValues(context, R.xml.main_settings, true);

app/src/main/java/org/schabi/newpipe/settings/migration/MigrationManager.java

@@ -0,0 +1,103 @@
+package org.schabi.newpipe.settings.migration;
+
+import android.content.Context;
+
+import androidx.annotation.NonNull;
+import androidx.appcompat.app.AlertDialog;
+import androidx.core.util.Consumer;
+
+import org.schabi.newpipe.R;
+import org.schabi.newpipe.error.ErrorUtil;
+
+import java.util.ArrayList;
+import java.util.List;
+
+/**
+ * MigrationManager is responsible for running migrations and showing the user information about
+ * the migrations that were applied.
+ */
+public final class MigrationManager {
+
+    private static final String TAG = MigrationManager.class.getSimpleName();
+    /**
+     * List of UI actions that are performed after the UI is initialized (e.g. showing alert
+     * dialogs) to inform the user about changes that were applied by migrations.
+     */
+    private static final List<Consumer<Context>> MIGRATION_INFO = new ArrayList<>();
+
+    private MigrationManager() {
+        // MigrationManager is a utility class that is completely static
+    }
+
+    /**
+     * Run all migrations that are needed for the current version of NewPipe.
+     * This method should be called at the start of the application, before any other operations
+     * that depend on the settings.
+     *
+     * @param context Context that can be used to run migrations
+     */
+    public static void runMigrationsIfNeeded(@NonNull final Context context) {
+        SettingMigrations.runMigrationsIfNeeded(context);
+    }
+
+    /**
+     * Perform UI actions informing about migrations that took place if they are present.
+     * @param context Context that can be used to show dialogs/snackbars/toasts
+     */
+    public static void showUserInfoIfPresent(@NonNull final Context context) {
+        if (MIGRATION_INFO.isEmpty()) {
+            return;
+        }
+
+        try {
+            MIGRATION_INFO.get(0).accept(context);
+        } catch (final Exception e) {
+            ErrorUtil.showUiErrorSnackbar(context, "Showing migration info to the user", e);
+            // Remove the migration that caused the error and continue with the next one
+            MIGRATION_INFO.remove(0);
+            showUserInfoIfPresent(context);
+        }
+    }
+
+    /**
+     * Add a migration info action that will be executed after the UI is initialized.
+     * This can be used to show dialogs/snackbars/toasts to inform the user about changes that
+     * were applied by migrations.
+     *
+     * @param info the action to be executed
+     */
+    public static void addMigrationInfo(final Consumer<Context> info) {
+        MIGRATION_INFO.add(info);
+    }
+
+    /**
+     * This method should be called when the user dismisses the migration info
+     * to check if there are any more migration info actions to be shown.
+     * @param context Context that can be used to show dialogs/snackbars/toasts
+     */
+    public static void onMigrationInfoDismissed(@NonNull final Context context) {
+        MIGRATION_INFO.remove(0);
+        showUserInfoIfPresent(context);
+    }
+
+    /**
+     * Creates a dialog to inform the user about the migration.
+     * @param uiContext Context that can be used to show dialogs/snackbars/toasts
+     * @param title the title of the dialog
+     * @param message the message of the dialog
+     * @return the dialog that can be shown to the user with a custom dismiss listener
+     */
+    static AlertDialog createMigrationInfoDialog(@NonNull final Context uiContext,
+                                                 @NonNull final String title,
+                                                 @NonNull final String message) {
+        return new AlertDialog.Builder(uiContext)
+                .setTitle(title)
+                .setMessage(message)
+                .setPositiveButton(R.string.ok, null)
+                .setOnDismissListener(dialog ->
+                        MigrationManager.onMigrationInfoDismissed(uiContext))
+                .setCancelable(false) // prevents the dialog from being dismissed accidentally
+                .create();
+    }
+
+}