feat: Handle duplicate streams in the "Add to playlist" dialog

Author: NullPointerException

app/src/main/java/org/schabi/newpipe/database/playlist/PlaylistDuplicatesEntry.java

@@ -0,0 +1,25 @@
+package org.schabi.newpipe.database.playlist;
+
+import androidx.room.ColumnInfo;
+
+/**
+ * This class adds a field to {@link PlaylistMetadataEntry} that contains an integer representing
+ * how many times a specific stream is already contained inside a local playlist. Used to be able
+ * to grey out playlists which already contain the current stream in the playlist append dialog.
+ * @see org.schabi.newpipe.local.playlist.LocalPlaylistManager#getPlaylistDuplicates(String)
+ */
+public class PlaylistDuplicatesEntry extends PlaylistMetadataEntry {
+    public static final String PLAYLIST_TIMES_STREAM_IS_CONTAINED = "timesStreamIsContained";
+    @ColumnInfo(name = PLAYLIST_TIMES_STREAM_IS_CONTAINED)
+    public final long timesStreamIsContained;
+
+    public PlaylistDuplicatesEntry(final long uid,
+                                   final String name,
+                                   final String thumbnailUrl,
+                                   final long displayIndex,
+                                   final long streamCount,
+                                   final long timesStreamIsContained) {
+        super(uid, name, thumbnailUrl,displayIndex, streamCount);
+        this.timesStreamIsContained = timesStreamIsContained;
+    }
+}

app/src/main/java/org/schabi/newpipe/database/playlist/dao/PlaylistStreamDAO.java

@@ -6,6 +6,7 @@
 import androidx.room.Transaction;
 
 import org.schabi.newpipe.database.BasicDAO;
+import org.schabi.newpipe.database.playlist.PlaylistDuplicatesEntry;
 import org.schabi.newpipe.database.playlist.PlaylistMetadataEntry;
 import org.schabi.newpipe.database.playlist.PlaylistStreamEntry;
 import org.schabi.newpipe.database.playlist.model.PlaylistStreamEntity;
@@ -14,6 +15,7 @@
 
 import io.reactivex.rxjava3.core.Flowable;
 
+import static org.schabi.newpipe.database.playlist.PlaylistDuplicatesEntry.PLAYLIST_TIMES_STREAM_IS_CONTAINED;
 import static org.schabi.newpipe.database.playlist.PlaylistMetadataEntry.PLAYLIST_STREAM_COUNT;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_DISPLAY_INDEX;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_ID;
@@ -26,6 +28,8 @@
 import static org.schabi.newpipe.database.playlist.model.PlaylistStreamEntity.PLAYLIST_STREAM_JOIN_TABLE;
 import static org.schabi.newpipe.database.stream.model.StreamEntity.STREAM_ID;
 import static org.schabi.newpipe.database.stream.model.StreamEntity.STREAM_TABLE;
+import static org.schabi.newpipe.database.stream.model.StreamEntity.STREAM_THUMBNAIL_URL;
+import static org.schabi.newpipe.database.stream.model.StreamEntity.STREAM_URL;
 import static org.schabi.newpipe.database.stream.model.StreamStateEntity.JOIN_STREAM_ID_ALIAS;
 import static org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_PROGRESS_MILLIS;
 import static org.schabi.newpipe.database.stream.model.StreamStateEntity.STREAM_STATE_TABLE;
@@ -87,14 +91,23 @@ default Flowable<List<PlaylistStreamEntity>> listByService(final int serviceId)
     Flowable<List<PlaylistMetadataEntry>> getPlaylistMetadata();
 
     @Transaction
-    @Query("SELECT " + PLAYLIST_ID + ", " + PLAYLIST_NAME + ", " + PLAYLIST_THUMBNAIL_URL + ", "
+    @Query("SELECT " + PLAYLIST_TABLE + "." + PLAYLIST_ID + ", "
+            + PLAYLIST_NAME + ", "
+            + PLAYLIST_TABLE + "." + PLAYLIST_THUMBNAIL_URL + ", "
             + PLAYLIST_DISPLAY_INDEX + ", "
-            + "COALESCE(COUNT(" + JOIN_PLAYLIST_ID + "), 0) AS " + PLAYLIST_STREAM_COUNT
+            + "COALESCE(COUNT(" + JOIN_PLAYLIST_ID + "), 0) AS " + PLAYLIST_STREAM_COUNT + ", "
+            + "COALESCE(SUM(" + STREAM_URL + " = :streamUrl), 0) AS "
+                + PLAYLIST_TIMES_STREAM_IS_CONTAINED
 
             + " FROM " + PLAYLIST_TABLE
             + " LEFT JOIN " + PLAYLIST_STREAM_JOIN_TABLE
-            + " ON " + PLAYLIST_ID + " = " + JOIN_PLAYLIST_ID
-            + " GROUP BY " + PLAYLIST_ID
+            + " ON " + PLAYLIST_TABLE + "." + PLAYLIST_ID + " = " + JOIN_PLAYLIST_ID
+
+            + " LEFT JOIN " + STREAM_TABLE
+            + " ON " + STREAM_TABLE + "." + STREAM_ID + " = " + JOIN_STREAM_ID
+            + " AND :streamUrl = :streamUrl"
+
+            + " GROUP BY " + JOIN_PLAYLIST_ID
             + " ORDER BY " + PLAYLIST_DISPLAY_INDEX)
-    Flowable<List<PlaylistMetadataEntry>> getDisplayIndexOrderedPlaylistMetadata();
+    Flowable<List<PlaylistDuplicatesEntry>> getPlaylistDuplicatesMetadata(String streamUrl);
 }

app/src/main/java/org/schabi/newpipe/local/dialog/PlaylistAppendDialog.java

@@ -4,6 +4,7 @@
 import android.view.LayoutInflater;
 import android.view.View;
 import android.view.ViewGroup;
+import android.widget.TextView;
 import android.widget.Toast;
 
 import androidx.annotation.NonNull;
@@ -15,6 +16,7 @@
 import org.schabi.newpipe.R;
 import org.schabi.newpipe.database.LocalItem;
 import org.schabi.newpipe.database.playlist.PlaylistMetadataEntry;
+import org.schabi.newpipe.database.playlist.PlaylistDuplicatesEntry;
 import org.schabi.newpipe.database.stream.model.StreamEntity;
 import org.schabi.newpipe.local.LocalItemListAdapter;
 import org.schabi.newpipe.local.playlist.LocalPlaylistManager;
@@ -30,6 +32,7 @@ public final class PlaylistAppendDialog extends PlaylistDialog {
 
     private RecyclerView playlistRecyclerView;
     private LocalItemListAdapter playlistAdapter;
+    private TextView playlistDuplicateIndicator;
 
     private final CompositeDisposable playlistDisposables = new CompositeDisposable();
 
@@ -66,13 +69,13 @@ public void onViewCreated(@NonNull final View view, @Nullable final Bundle saved
         playlistAdapter.setSelectedListener(new OnClickGesture<LocalItem>() {
             @Override
             public void selected(final LocalItem selectedItem) {
-                if (!(selectedItem instanceof PlaylistMetadataEntry)
+                if (!(selectedItem instanceof PlaylistDuplicatesEntry)
                         || getStreamEntities() == null) {
                     return;
                 }
                 onPlaylistSelected(
                         playlistManager,
-                        (PlaylistMetadataEntry) selectedItem,
+                        (PlaylistDuplicatesEntry) selectedItem,
                         getStreamEntities()
                 );
             }
@@ -82,10 +85,13 @@ public void selected(final LocalItem selectedItem) {
         playlistRecyclerView.setLayoutManager(new LinearLayoutManager(requireContext()));
         playlistRecyclerView.setAdapter(playlistAdapter);
 
+        playlistDuplicateIndicator = view.findViewById(R.id.playlist_duplicate);
+
         final View newPlaylistButton = view.findViewById(R.id.newPlaylist);
         newPlaylistButton.setOnClickListener(ignored -> openCreatePlaylistDialog());
 
-        playlistDisposables.add(playlistManager.getDisplayIndexOrderedPlaylists()
+        playlistDisposables.add(playlistManager
+                .getPlaylistDuplicates(getStreamEntities().get(0).getUrl())
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(this::onPlaylistsReceived));
     }
@@ -127,23 +133,38 @@ public void openCreatePlaylistDialog() {
         requireDialog().dismiss();
     }
 
-    private void onPlaylistsReceived(@NonNull final List<PlaylistMetadataEntry> playlists) {
-        if (playlistAdapter != null && playlistRecyclerView != null) {
+    private void onPlaylistsReceived(@NonNull final List<PlaylistDuplicatesEntry> playlists) {
+        if (playlistAdapter != null
+                && playlistRecyclerView != null
+                && playlistDuplicateIndicator != null) {
             playlistAdapter.clearStreamItemList();
             playlistAdapter.addItems(playlists);
             playlistRecyclerView.setVisibility(View.VISIBLE);
+            playlistDuplicateIndicator.setVisibility(
+                    anyPlaylistContainsDuplicates(playlists) ? View.VISIBLE : View.GONE);
         }
     }
 
+    private boolean anyPlaylistContainsDuplicates(final List<PlaylistDuplicatesEntry> playlists) {
+        return playlists.stream()
+                .anyMatch(playlist -> playlist.timesStreamIsContained > 0);
+    }
+
     private void onPlaylistSelected(@NonNull final LocalPlaylistManager manager,
-                                    @NonNull final PlaylistMetadataEntry playlist,
+                                    @NonNull final PlaylistDuplicatesEntry playlist,
                                     @NonNull final List<StreamEntity> streams) {
         if (getStreamEntities() == null) {
             return;
         }
+        final String toastText;
+        if (playlist.timesStreamIsContained > 0) {
+            toastText = getString(R.string.playlist_add_stream_success_duplicate,
+                    playlist.timesStreamIsContained);
+        } else {
+            toastText = getString(R.string.playlist_add_stream_success);
+        }
 
-        final Toast successToast = Toast.makeText(getContext(),
-                R.string.playlist_add_stream_success, Toast.LENGTH_SHORT);
+        final Toast successToast = Toast.makeText(getContext(), toastText, Toast.LENGTH_SHORT);
 
         if (playlist.thumbnailUrl.equals("drawable://" + R.drawable.dummy_thumbnail_playlist)) {
             playlistDisposables.add(manager

app/src/main/java/org/schabi/newpipe/local/holder/LocalPlaylistItemHolder.java

@@ -4,6 +4,7 @@
 import android.view.ViewGroup;
 
 import org.schabi.newpipe.database.LocalItem;
+import org.schabi.newpipe.database.playlist.PlaylistDuplicatesEntry;
 import org.schabi.newpipe.database.playlist.PlaylistMetadataEntry;
 import org.schabi.newpipe.local.LocalItemBuilder;
 import org.schabi.newpipe.local.history.HistoryRecordManager;
@@ -14,6 +15,8 @@
 
 public class LocalPlaylistItemHolder extends PlaylistItemHolder {
 
+    private static final float GRAYED_OUT_ALPHA = 0.6f;
+
     public LocalPlaylistItemHolder(final LocalItemBuilder infoItemBuilder, final ViewGroup parent) {
         super(infoItemBuilder, parent);
     }
@@ -39,6 +42,13 @@ public void updateFromItem(final LocalItem localItem,
 
         PicassoHelper.loadPlaylistThumbnail(item.thumbnailUrl).into(itemThumbnailView);
 
+        if (item instanceof PlaylistDuplicatesEntry
+                && ((PlaylistDuplicatesEntry) item).timesStreamIsContained > 0) {
+            itemView.setAlpha(GRAYED_OUT_ALPHA);
+        } else {
+            itemView.setAlpha(1.0f);
+        }
+
         super.updateFromItem(localItem, historyRecordManager, dateTimeFormatter);
     }
 }

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

@@ -3,6 +3,7 @@
 import androidx.annotation.Nullable;
 
 import org.schabi.newpipe.database.AppDatabase;
+import org.schabi.newpipe.database.playlist.PlaylistDuplicatesEntry;
 import org.schabi.newpipe.database.playlist.PlaylistMetadataEntry;
 import org.schabi.newpipe.database.playlist.PlaylistStreamEntry;
 import org.schabi.newpipe.database.playlist.dao.PlaylistDAO;
@@ -106,8 +107,15 @@ public Flowable<List<PlaylistMetadataEntry>> getPlaylists() {
         return playlistStreamTable.getPlaylistMetadata().subscribeOn(Schedulers.io());
     }
 
-    public Flowable<List<PlaylistMetadataEntry>> getDisplayIndexOrderedPlaylists() {
-        return playlistStreamTable.getDisplayIndexOrderedPlaylistMetadata()
+    /**
+     * Get playlists with attached information about how many times the provided stream is already
+     * contained in each playlist.
+     *
+     * @param streamUrl the stream url for which to check for duplicates
+     * @return a list of {@link PlaylistDuplicatesEntry}
+     */
+    public Flowable<List<PlaylistDuplicatesEntry>> getPlaylistDuplicates(final String streamUrl) {
+        return playlistStreamTable.getPlaylistDuplicatesMetadata(streamUrl)
                 .subscribeOn(Schedulers.io());
     }
 

app/src/main/res/layout/dialog_playlists.xml

@@ -35,11 +35,26 @@
             tools:ignore="RtlHardcoded" />
     </RelativeLayout>
 
+    <org.schabi.newpipe.views.NewPipeTextView
+        android:id="@+id/playlist_duplicate"
+        android:layout_width="match_parent"
+        android:layout_height="wrap_content"
+        android:layout_below="@+id/newPlaylist"
+        android:layout_marginHorizontal="@dimen/video_item_search_padding"
+        android:layout_marginBottom="@dimen/video_item_search_padding"
+        android:gravity="center"
+        android:text="@string/duplicate_in_playlist"
+        android:textAppearance="?android:attr/textAppearanceMedium"
+        android:textSize="13sp"
+        android:visibility="gone"
+        tools:text="@tools:sample/lorem[20]"
+        tools:visibility="visible" />
+
     <View
         android:id="@+id/separator"
         android:layout_width="match_parent"
         android:layout_height="1dp"
-        android:layout_below="@+id/newPlaylist"
+        android:layout_below="@+id/playlist_duplicate"
         android:layout_marginLeft="@dimen/video_item_search_padding"
         android:layout_marginRight="@dimen/video_item_search_padding"
         android:background="?attr/separator_color" />

app/src/main/res/values/strings.xml

@@ -435,6 +435,7 @@
     <string name="preferred_player_fetcher_notification_message">"Loading requested content"</string>
     <!-- Local Playlist -->
     <string name="create_playlist">New Playlist</string>
+    <string name="duplicate_in_playlist">The playlists that are grayed out already contain this item.</string>
     <string name="rename_playlist">Rename</string>
     <string name="name">Name</string>
     <string name="add_to_playlist">Add to playlist</string>
@@ -447,6 +448,7 @@
     <string name="delete_playlist_prompt">Delete this playlist\?</string>
     <string name="playlist_creation_success">Playlist created</string>
     <string name="playlist_add_stream_success">Playlisted</string>
+    <string name="playlist_add_stream_success_duplicate">Duplicate added %d time(s)</string>
     <string name="playlist_thumbnail_change_success">Playlist thumbnail changed.</string>
     <string name="playlist_no_uploader">Auto-generated (no uploader found)</string>
     <!-- Players -->