Deduplicate code to initialize ClickListeners on playlist controls

Add the separate utility class PlayButtonHelper to handle the initialization of the listeners.
The ClickListeners on playlist controls had different behaviours. This commit fixes that.

The commit also refactors the way how the app determines whether it is started for the first time. The previous version was not clean and recent in this PR caused it to fail.

app/src/main/java/org/schabi/newpipe/fragments/detail/VideoDetailFragment.java

@@ -112,6 +112,7 @@ import org.schabi.newpipe.util.StreamTypeUtil;
 import org.schabi.newpipe.util.ThemeHelper;
 import org.schabi.newpipe.util.external_communication.KoreUtils;
 import org.schabi.newpipe.util.external_communication.ShareUtils;
+import org.schabi.newpipe.util.PlayButtonHelper;
 
 import java.util.ArrayList;
 import java.util.Iterator;
@@ -535,9 +536,11 @@ public final class VideoDetailFragment
         }));
 
         binding.detailControlsBackground.setOnLongClickListener(makeOnLongClickListener(info ->
-                openBackgroundPlayer(true)));
+            openBackgroundPlayer(true)
+        ));
         binding.detailControlsPopup.setOnLongClickListener(makeOnLongClickListener(info ->
-                openPopupPlayer(true)));
+            openPopupPlayer(true)
+        ));
         binding.detailControlsDownload.setOnLongClickListener(makeOnLongClickListener(info ->
                 NavigationHelper.openDownloads(activity)));
 
@@ -620,8 +623,7 @@ public final class VideoDetailFragment
 
         final View.OnTouchListener controlsTouchListener = (view, motionEvent) -> {
             if (motionEvent.getAction() == MotionEvent.ACTION_DOWN
-                && PreferenceManager.getDefaultSharedPreferences(activity)
+                    && PlayButtonHelper.shouldShowHoldToAppendTip(activity)) {
-                    .getBoolean(getString(R.string.show_hold_to_append_key), true)) {
 
                 animate(binding.touchAppendDetail, true, 250, AnimationType.ALPHA, 0, () ->
                         animate(binding.touchAppendDetail, false, 1500, AnimationType.ALPHA, 1000));

app/src/main/java/org/schabi/newpipe/fragments/list/channel/ChannelTabFragment.java

@@ -17,12 +17,12 @@ import org.schabi.newpipe.extractor.channel.tabs.ChannelTabInfo;
 import org.schabi.newpipe.extractor.linkhandler.ListLinkHandler;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
 import org.schabi.newpipe.fragments.list.BaseListInfoFragment;
-import org.schabi.newpipe.player.PlayerType;
+import org.schabi.newpipe.fragments.list.playlist.PlaylistControlViewHolder;
 import org.schabi.newpipe.player.playqueue.ChannelTabPlayQueue;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
 import org.schabi.newpipe.util.ChannelTabHelper;
 import org.schabi.newpipe.util.ExtractorHelper;
-import org.schabi.newpipe.util.NavigationHelper;
+import org.schabi.newpipe.util.PlayButtonHelper;
 
 import java.util.List;
 import java.util.function.Supplier;
@@ -31,7 +31,8 @@ import java.util.stream.Collectors;
 import icepick.State;
 import io.reactivex.rxjava3.core.Single;
 
-public class ChannelTabFragment extends BaseListInfoFragment<InfoItem, ChannelTabInfo> {
+public class ChannelTabFragment extends BaseListInfoFragment<InfoItem, ChannelTabInfo>
+        implements PlaylistControlViewHolder {
 
     @State
     protected ListLinkHandler tabHandler;
@@ -39,7 +40,6 @@ public class ChannelTabFragment extends BaseListInfoFragment<InfoItem, ChannelTa
     protected String channelName;
 
     private PlaylistControlBinding playlistControlBinding;
-
     public static ChannelTabFragment getInstance(final int serviceId,
                                                  final ListLinkHandler tabHandler,
                                                  final String channelName) {
@@ -72,8 +72,8 @@ public class ChannelTabFragment extends BaseListInfoFragment<InfoItem, ChannelTa
     }
 
     @Override
-    public void onDestroy() {
+    public void onDestroyView() {
-        super.onDestroy();
+        super.onDestroyView();
         playlistControlBinding = null;
     }
 
@@ -115,27 +115,12 @@ public class ChannelTabFragment extends BaseListInfoFragment<InfoItem, ChannelTa
                 playlistControlBinding.getRoot().setVisibility(View.GONE);
             }
 
-            playlistControlBinding.playlistCtrlPlayAllButton.setOnClickListener(
+            PlayButtonHelper.initPlaylistControlClickListener(
-                    view -> NavigationHelper.playOnMainPlayer(activity, getPlayQueue()));
+                    activity, playlistControlBinding, this);
-            playlistControlBinding.playlistCtrlPlayPopupButton.setOnClickListener(
-                    view -> NavigationHelper.playOnPopupPlayer(activity, getPlayQueue(), false));
-            playlistControlBinding.playlistCtrlPlayBgButton.setOnClickListener(
-                    view -> NavigationHelper.playOnBackgroundPlayer(activity, getPlayQueue(),
-                            false));
-
-            playlistControlBinding.playlistCtrlPlayPopupButton.setOnLongClickListener(view -> {
-                NavigationHelper.enqueueOnPlayer(activity, getPlayQueue(), PlayerType.POPUP);
-                return true;
-            });
-
-            playlistControlBinding.playlistCtrlPlayBgButton.setOnLongClickListener(view -> {
-                NavigationHelper.enqueueOnPlayer(activity, getPlayQueue(), PlayerType.AUDIO);
-                return true;
-            });
         }
     }
 
-    private PlayQueue getPlayQueue() {
+    public PlayQueue getPlayQueue() {
         final List<StreamInfoItem> streamItems = infoListAdapter.getItemsList().stream()
                 .filter(StreamInfoItem.class::isInstance)
                 .map(StreamInfoItem.class::cast)

app/src/main/java/org/schabi/newpipe/fragments/list/playlist/PlaylistControlViewHolder.java

@@ -0,0 +1,13 @@
+package org.schabi.newpipe.fragments.list.playlist;
+
+import org.schabi.newpipe.player.playqueue.PlayQueue;
+
+/**
+ * Interface for {@code R.layout.playlist_control} view holders
+ * to give access to the play queue.
+ */
+public interface PlaylistControlViewHolder {
+
+    PlayQueue getPlayQueue();
+
+}

app/src/main/java/org/schabi/newpipe/fragments/list/playlist/PlaylistFragment.java

@@ -43,7 +43,6 @@ import org.schabi.newpipe.info_list.dialog.InfoItemDialog;
 import org.schabi.newpipe.info_list.dialog.StreamDialogDefaultEntry;
 import org.schabi.newpipe.local.dialog.PlaylistDialog;
 import org.schabi.newpipe.local.playlist.RemotePlaylistManager;
-import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
 import org.schabi.newpipe.player.playqueue.PlaylistPlayQueue;
 import org.schabi.newpipe.util.ExtractorHelper;
@@ -51,6 +50,7 @@ import org.schabi.newpipe.util.Localization;
 import org.schabi.newpipe.util.NavigationHelper;
 import org.schabi.newpipe.util.PicassoHelper;
 import org.schabi.newpipe.util.external_communication.ShareUtils;
+import org.schabi.newpipe.util.PlayButtonHelper;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -64,7 +64,8 @@ import io.reactivex.rxjava3.core.Single;
 import io.reactivex.rxjava3.disposables.CompositeDisposable;
 import io.reactivex.rxjava3.disposables.Disposable;
 
-public class PlaylistFragment extends BaseListInfoFragment<StreamInfoItem, PlaylistInfo> {
+public class PlaylistFragment extends BaseListInfoFragment<StreamInfoItem, PlaylistInfo>
+        implements PlaylistControlViewHolder {
 
     private static final String PICASSO_PLAYLIST_TAG = "PICASSO_PLAYLIST_TAG";
 
@@ -332,25 +333,10 @@ public class PlaylistFragment extends BaseListInfoFragment<StreamInfoItem, Playl
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(getPlaylistBookmarkSubscriber());
 
-        playlistControlBinding.playlistCtrlPlayAllButton.setOnClickListener(view ->
+        PlayButtonHelper.initPlaylistControlClickListener(activity, playlistControlBinding, this);
-                NavigationHelper.playOnMainPlayer(activity, getPlayQueue()));
-        playlistControlBinding.playlistCtrlPlayPopupButton.setOnClickListener(view ->
-                NavigationHelper.playOnPopupPlayer(activity, getPlayQueue(), false));
-        playlistControlBinding.playlistCtrlPlayBgButton.setOnClickListener(view ->
-                NavigationHelper.playOnBackgroundPlayer(activity, getPlayQueue(), false));
-
-        playlistControlBinding.playlistCtrlPlayPopupButton.setOnLongClickListener(view -> {
-            NavigationHelper.enqueueOnPlayer(activity, getPlayQueue(), PlayerType.POPUP);
-            return true;
-        });
-
-        playlistControlBinding.playlistCtrlPlayBgButton.setOnLongClickListener(view -> {
-            NavigationHelper.enqueueOnPlayer(activity, getPlayQueue(), PlayerType.AUDIO);
-            return true;
-        });
     }
 
-    private PlayQueue getPlayQueue() {
+    public PlayQueue getPlayQueue() {
         return getPlayQueue(0);
     }
 

app/src/main/java/org/schabi/newpipe/local/history/StatisticsPlaylistFragment.java

@@ -28,14 +28,16 @@ import org.schabi.newpipe.databinding.StatisticPlaylistControlBinding;
 import org.schabi.newpipe.error.ErrorInfo;
 import org.schabi.newpipe.error.UserAction;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
+import org.schabi.newpipe.fragments.list.playlist.PlaylistControlViewHolder;
 import org.schabi.newpipe.info_list.dialog.InfoItemDialog;
+import org.schabi.newpipe.info_list.dialog.StreamDialogDefaultEntry;
 import org.schabi.newpipe.local.BaseLocalListFragment;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
 import org.schabi.newpipe.player.playqueue.SinglePlayQueue;
 import org.schabi.newpipe.settings.HistorySettingsFragment;
 import org.schabi.newpipe.util.NavigationHelper;
 import org.schabi.newpipe.util.OnClickGesture;
-import org.schabi.newpipe.info_list.dialog.StreamDialogDefaultEntry;
+import org.schabi.newpipe.util.PlayButtonHelper;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -49,7 +51,8 @@ import io.reactivex.rxjava3.disposables.CompositeDisposable;
 import io.reactivex.rxjava3.disposables.Disposable;
 
 public class StatisticsPlaylistFragment
-        extends BaseLocalListFragment<List<StreamStatisticsEntry>, Void> {
+        extends BaseLocalListFragment<List<StreamStatisticsEntry>, Void>
+        implements PlaylistControlViewHolder {
     private final CompositeDisposable disposables = new CompositeDisposable();
     @State
     Parcelable itemsListState;
@@ -195,14 +198,9 @@ public class StatisticsPlaylistFragment
         if (itemListAdapter != null) {
             itemListAdapter.unsetSelectedListener();
         }
-        if (playlistControlBinding != null) {
-            playlistControlBinding.playlistCtrlPlayBgButton.setOnClickListener(null);
-            playlistControlBinding.playlistCtrlPlayAllButton.setOnClickListener(null);
-            playlistControlBinding.playlistCtrlPlayPopupButton.setOnClickListener(null);
 
-            headerBinding = null;
+        headerBinding = null;
-            playlistControlBinding = null;
+        playlistControlBinding = null;
-        }
 
         if (databaseSubscription != null) {
             databaseSubscription.cancel();
@@ -276,12 +274,8 @@ public class StatisticsPlaylistFragment
             itemsListState = null;
         }
 
-        playlistControlBinding.playlistCtrlPlayAllButton.setOnClickListener(view ->
+        PlayButtonHelper.initPlaylistControlClickListener(activity, playlistControlBinding, this);
-                NavigationHelper.playOnMainPlayer(activity, getPlayQueue()));
+
-        playlistControlBinding.playlistCtrlPlayPopupButton.setOnClickListener(view ->
-                NavigationHelper.playOnPopupPlayer(activity, getPlayQueue(), false));
-        playlistControlBinding.playlistCtrlPlayBgButton.setOnClickListener(view ->
-                NavigationHelper.playOnBackgroundPlayer(activity, getPlayQueue(), false));
         headerBinding.sortButton.setOnClickListener(view -> toggleSortMode());
 
         hideLoading();
@@ -374,7 +368,7 @@ public class StatisticsPlaylistFragment
         }
     }
 
-    private PlayQueue getPlayQueue() {
+    public PlayQueue getPlayQueue() {
         return getPlayQueue(0);
     }
 

app/src/main/java/org/schabi/newpipe/local/playlist/LocalPlaylistFragment.java

@@ -22,7 +22,6 @@ import android.widget.Toast;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.appcompat.app.AlertDialog;
-import androidx.preference.PreferenceManager;
 import androidx.recyclerview.widget.ItemTouchHelper;
 import androidx.recyclerview.widget.RecyclerView;
 import androidx.viewbinding.ViewBinding;
@@ -42,17 +41,18 @@ import org.schabi.newpipe.databinding.PlaylistControlBinding;
 import org.schabi.newpipe.error.ErrorInfo;
 import org.schabi.newpipe.error.UserAction;
 import org.schabi.newpipe.extractor.stream.StreamInfoItem;
+import org.schabi.newpipe.fragments.list.playlist.PlaylistControlViewHolder;
 import org.schabi.newpipe.info_list.dialog.InfoItemDialog;
 import org.schabi.newpipe.info_list.dialog.StreamDialogDefaultEntry;
 import org.schabi.newpipe.local.BaseLocalListFragment;
 import org.schabi.newpipe.local.history.HistoryRecordManager;
-import org.schabi.newpipe.player.PlayerType;
 import org.schabi.newpipe.player.playqueue.PlayQueue;
 import org.schabi.newpipe.player.playqueue.SinglePlayQueue;
 import org.schabi.newpipe.util.Localization;
 import org.schabi.newpipe.util.NavigationHelper;
 import org.schabi.newpipe.util.OnClickGesture;
 import org.schabi.newpipe.util.external_communication.ShareUtils;
+import org.schabi.newpipe.util.PlayButtonHelper;
 
 import java.util.ArrayList;
 import java.util.Collections;
@@ -69,7 +69,8 @@ import io.reactivex.rxjava3.disposables.Disposable;
 import io.reactivex.rxjava3.schedulers.Schedulers;
 import io.reactivex.rxjava3.subjects.PublishSubject;
 
-public class LocalPlaylistFragment extends BaseLocalListFragment<List<PlaylistStreamEntry>, Void> {
+public class LocalPlaylistFragment extends BaseLocalListFragment<List<PlaylistStreamEntry>, Void>
+        implements PlaylistControlViewHolder {
     // Save the list 10 seconds after the last change occurred
     private static final long SAVE_DEBOUNCE_MILLIS = 10000;
     private static final int MINIMUM_INITIAL_DRAG_VELOCITY = 12;
@@ -265,14 +266,10 @@ public class LocalPlaylistFragment extends BaseLocalListFragment<List<PlaylistSt
         if (itemListAdapter != null) {
             itemListAdapter.unsetSelectedListener();
         }
-        if (playlistControlBinding != null) {
-            playlistControlBinding.playlistCtrlPlayBgButton.setOnClickListener(null);
-            playlistControlBinding.playlistCtrlPlayAllButton.setOnClickListener(null);
-            playlistControlBinding.playlistCtrlPlayPopupButton.setOnClickListener(null);
 
-            headerBinding = null;
+        headerBinding = null;
-            playlistControlBinding = null;
+        playlistControlBinding = null;
-        }
+
 
         if (databaseSubscription != null) {
             databaseSubscription.cancel();
@@ -498,38 +495,11 @@ public class LocalPlaylistFragment extends BaseLocalListFragment<List<PlaylistSt
         }
         setVideoCount(itemListAdapter.getItemsList().size());
 
-        playlistControlBinding.playlistCtrlPlayAllButton.setOnClickListener(view -> {
+        PlayButtonHelper.initPlaylistControlClickListener(activity, playlistControlBinding, this);
-            NavigationHelper.playOnMainPlayer(activity, getPlayQueue());
-            showHoldToAppendTipIfNeeded();
-        });
-        playlistControlBinding.playlistCtrlPlayPopupButton.setOnClickListener(view -> {
-            NavigationHelper.playOnPopupPlayer(activity, getPlayQueue(), false);
-            showHoldToAppendTipIfNeeded();
-        });
-        playlistControlBinding.playlistCtrlPlayBgButton.setOnClickListener(view -> {
-            NavigationHelper.playOnBackgroundPlayer(activity, getPlayQueue(), false);
-            showHoldToAppendTipIfNeeded();
-        });
-        playlistControlBinding.playlistCtrlPlayPopupButton.setOnLongClickListener(view -> {
-            NavigationHelper.enqueueOnPlayer(activity, getPlayQueue(), PlayerType.POPUP);
-            return true;
-        });
-
-        playlistControlBinding.playlistCtrlPlayBgButton.setOnLongClickListener(view -> {
-            NavigationHelper.enqueueOnPlayer(activity, getPlayQueue(), PlayerType.AUDIO);
-            return true;
-        });
 
         hideLoading();
     }
 
-    private void showHoldToAppendTipIfNeeded() {
-        if (PreferenceManager.getDefaultSharedPreferences(activity)
-                .getBoolean(getString(R.string.show_hold_to_append_key), true)) {
-            Toast.makeText(activity, R.string.hold_to_append, Toast.LENGTH_SHORT).show();
-        }
-    }
-
     ///////////////////////////////////////////////////////////////////////////
     // Fragment Error Handling
     ///////////////////////////////////////////////////////////////////////////
@@ -853,7 +823,7 @@ public class LocalPlaylistFragment extends BaseLocalListFragment<List<PlaylistSt
         }
     }
 
-    private PlayQueue getPlayQueue() {
+    public PlayQueue getPlayQueue() {
         return getPlayQueue(0);
     }
 

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

@@ -44,21 +44,11 @@ public final class NewPipeSettings {
     private NewPipeSettings() { }
 
     public static void initSettings(final Context context) {
-        // check if there are entries in the prefs to determine whether this is the first app run
+        // check if the last used preference version is set
-        Boolean isFirstRun = null;
+        // to determine whether this is the first app run
-        final Set<String> prefsKeys = PreferenceManager.getDefaultSharedPreferences(context)
+        final int lastUsedPrefVersion = PreferenceManager.getDefaultSharedPreferences(context)
-                .getAll().keySet();
+                .getInt(context.getString(R.string.last_used_preferences_version), -1);
-        for (final String key: prefsKeys) {
+        final boolean isFirstRun = lastUsedPrefVersion == -1;
-            // ACRA stores some info in the prefs during app initialization
-            // which happens before this method is called. Therefore ignore ACRA-related keys.
-            if (!key.toLowerCase().startsWith("acra")) {
-                isFirstRun = false;
-                break;
-            }
-        }
-        if (isFirstRun == null) {
-            isFirstRun = true;
-        }
 
         // first run migrations, then setDefaultValues, since the latter requires the correct types
         SettingMigrations.runMigrationsIfNeeded(context, isFirstRun);

app/src/main/java/org/schabi/newpipe/util/PlayButtonHelper.java

@@ -0,0 +1,90 @@
+package org.schabi.newpipe.util;
+
+import android.content.Context;
+import android.widget.Toast;
+
+import androidx.annotation.NonNull;
+import androidx.appcompat.app.AppCompatActivity;
+import androidx.preference.PreferenceManager;
+
+import org.schabi.newpipe.R;
+import org.schabi.newpipe.databinding.PlaylistControlBinding;
+import org.schabi.newpipe.fragments.list.playlist.PlaylistControlViewHolder;
+import org.schabi.newpipe.player.PlayerType;
+
+/**
+ * Utility class for play buttons and their respective click listeners.
+ */
+public final class PlayButtonHelper {
+
+    private PlayButtonHelper() {
+        // utility class
+    }
+
+    /**
+     * <p>Initialize {@link android.view.View.OnClickListener OnClickListener}
+     * and {@link android.view.View.OnLongClickListener OnLongClickListener} for playlist control
+     * buttons defined in {@code R.layout.playlist_control}.</p>
+     *
+     * @param activity The activity to use for the {@link android.widget.Toast Toast}.
+     * @param playlistControlBinding The binding of the
+     *        {@link R.layout.playlist_control playlist control layout}.
+     * @param fragment The fragment to get the play queue from.
+     */
+    public static void initPlaylistControlClickListener(
+            @NonNull final AppCompatActivity activity,
+            @NonNull final PlaylistControlBinding playlistControlBinding,
+            @NonNull final PlaylistControlViewHolder fragment) {
+        // click listener
+        playlistControlBinding.playlistCtrlPlayAllButton.setOnClickListener(view -> {
+            NavigationHelper.playOnMainPlayer(activity, fragment.getPlayQueue());
+            showHoldToAppendToastIfNeeded(activity);
+        });
+        playlistControlBinding.playlistCtrlPlayPopupButton.setOnClickListener(view -> {
+            NavigationHelper.playOnPopupPlayer(activity, fragment.getPlayQueue(), false);
+            showHoldToAppendToastIfNeeded(activity);
+        });
+        playlistControlBinding.playlistCtrlPlayBgButton.setOnClickListener(view -> {
+            NavigationHelper.playOnBackgroundPlayer(activity, fragment.getPlayQueue(), false);
+            showHoldToAppendToastIfNeeded(activity);
+        });
+
+        // long click listener
+        playlistControlBinding.playlistCtrlPlayPopupButton.setOnLongClickListener(view -> {
+            NavigationHelper.enqueueOnPlayer(activity, fragment.getPlayQueue(), PlayerType.POPUP);
+            return true;
+        });
+        playlistControlBinding.playlistCtrlPlayBgButton.setOnLongClickListener(view -> {
+            NavigationHelper.enqueueOnPlayer(activity, fragment.getPlayQueue(), PlayerType.AUDIO);
+            return true;
+        });
+    }
+
+    /**
+     * <p>Show the "hold to append" toast if the corresponding preference is enabled.</p>
+     *
+     * @param context The context to show the toast.
+     */
+    private static void showHoldToAppendToastIfNeeded(@NonNull final Context context) {
+        if (shouldShowHoldToAppendTip(context)) {
+            Toast.makeText(context, R.string.hold_to_append, Toast.LENGTH_SHORT).show();
+        }
+
+    }
+
+    /**
+     * <p>Check if the "hold to append" toast should be shown.</p>
+     *
+     * <p>
+     * The tip is shown if the corresponding preference is enabled.
+     * This is the default behaviour.
+     * </p>
+     *
+     * @param context The context to get the preference.
+     * @return {@code true} if the tip should be shown, {@code false} otherwise.
+     */
+    public static boolean shouldShowHoldToAppendTip(@NonNull final Context context) {
+        return PreferenceManager.getDefaultSharedPreferences(context)
+                .getBoolean(context.getString(R.string.show_hold_to_append_key), true);
+    }
+}