feat: support sort playlists.(from upstream PR TeamNewPipe#8221)

app/src/androidTest/java/org/schabi/newpipe/database/DatabaseMigrationTest.kt

@@ -84,6 +84,11 @@ class DatabaseMigrationTest {
             true, Migrations.MIGRATION_4_5
         )
 
+        testHelper.runMigrationsAndValidate(
+            AppDatabase.DATABASE_NAME, Migrations.DB_VER_6,
+            true, Migrations.MIGRATION_5_6
+        )
+
         val migratedDatabaseV3 = getMigratedDatabase()
         val listFromDB = migratedDatabaseV3.streamDAO().all.blockingFirst()
 

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

@@ -5,6 +5,7 @@
 import static org.schabi.newpipe.database.Migrations.MIGRATION_2_3;
 import static org.schabi.newpipe.database.Migrations.MIGRATION_3_4;
 import static org.schabi.newpipe.database.Migrations.MIGRATION_4_5;
+import static org.schabi.newpipe.database.Migrations.MIGRATION_5_6;
 
 import android.content.Context;
 import android.database.Cursor;
@@ -24,7 +25,8 @@ private NewPipeDatabase() {
     private static AppDatabase getDatabase(final Context context) {
         return Room
                 .databaseBuilder(context.getApplicationContext(), AppDatabase.class, DATABASE_NAME)
-                .addMigrations(MIGRATION_1_2, MIGRATION_2_3, MIGRATION_3_4, MIGRATION_4_5)
+                .addMigrations(MIGRATION_1_2, MIGRATION_2_3, MIGRATION_3_4, MIGRATION_4_5,
+                        MIGRATION_5_6)
                 .build();
     }
 

app/src/main/java/org/schabi/newpipe/database/AppDatabase.java

@@ -1,6 +1,6 @@
 package org.schabi.newpipe.database;
 
-import static org.schabi.newpipe.database.Migrations.DB_VER_5;
+import static org.schabi.newpipe.database.Migrations.DB_VER_6;
 
 import androidx.room.Database;
 import androidx.room.RoomDatabase;
@@ -38,7 +38,7 @@
                 FeedEntity.class, FeedGroupEntity.class, FeedGroupSubscriptionEntity.class,
                 FeedLastUpdatedEntity.class
         },
-        version = DB_VER_5
+        version = DB_VER_6
 )
 public abstract class AppDatabase extends RoomDatabase {
     public static final String DATABASE_NAME = "newpipe.db";

app/src/main/java/org/schabi/newpipe/database/Migrations.java

@@ -23,6 +23,7 @@ public final class Migrations {
     public static final int DB_VER_3 = 3;
     public static final int DB_VER_4 = 4;
     public static final int DB_VER_5 = 5;
+    public static final int DB_VER_6 = 6;
 
     private static final String TAG = Migrations.class.getName();
     public static final boolean DEBUG = MainActivity.DEBUG;
@@ -184,7 +185,60 @@ public void migrate(@NonNull final SupportSQLiteDatabase database) {
         @Override
         public void migrate(@NonNull final SupportSQLiteDatabase database) {
             database.execSQL("ALTER TABLE `subscriptions` ADD COLUMN `notification_mode` "
-                     + "INTEGER NOT NULL DEFAULT 0");
+                    + "INTEGER NOT NULL DEFAULT 0");
+        }
+    };
+
+    public static final Migration MIGRATION_5_6 = new Migration(DB_VER_5, DB_VER_6) {
+        @Override
+        public void migrate(@NonNull final SupportSQLiteDatabase database) {
+            try {
+                database.beginTransaction();
+
+                // Update playlists.
+                // Create a temp table to initialize display_index.
+                database.execSQL("CREATE TABLE `playlists_tmp` "
+                        + "(`uid` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "
+                        + "`name` TEXT, `thumbnail_url` TEXT,"
+                        + "`display_index` INTEGER NOT NULL DEFAULT 0)");
+                database.execSQL("INSERT INTO `playlists_tmp` (`uid`, `name`, `thumbnail_url`)"
+                        + "SELECT `uid`, `name`, `thumbnail_url` FROM `playlists`");
+
+                // Replace the old table.
+                database.execSQL("DROP TABLE `playlists`");
+                database.execSQL("ALTER TABLE `playlists_tmp` RENAME TO `playlists`");
+
+                // Create index on the new table.
+                database.execSQL("CREATE INDEX `index_playlists_name` ON `playlists` (`name`)");
+
+
+                // Update remote_playlists.
+                // Create a temp table to initialize display_index.
+                database.execSQL("CREATE TABLE `remote_playlists_tmp` "
+                        + "(`uid` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "
+                        + "`service_id` INTEGER NOT NULL, `name` TEXT, `url` TEXT, "
+                        + "`thumbnail_url` TEXT, `uploader` TEXT, "
+                        + "`display_index` INTEGER NOT NULL DEFAULT 0,"
+                        + "`stream_count` INTEGER)");
+                database.execSQL("INSERT INTO `remote_playlists_tmp` (`uid`, `service_id`, "
+                        + "`name`, `url`, `thumbnail_url`, `uploader`, `stream_count`)"
+                        + "SELECT `uid`, `service_id`, `name`, `url`, `thumbnail_url`, `uploader`, "
+                        + "`stream_count` FROM `remote_playlists`");
+
+                // Replace the old table.
+                database.execSQL("DROP TABLE `remote_playlists`");
+                database.execSQL("ALTER TABLE `remote_playlists_tmp` RENAME TO `remote_playlists`");
+
+                // Create index on the new table.
+                database.execSQL("CREATE INDEX `index_remote_playlists_name` "
+                        + "ON `remote_playlists` (`name`)");
+                database.execSQL("CREATE UNIQUE INDEX `index_remote_playlists_service_id_url` "
+                        + "ON `remote_playlists` (`service_id`, `url`)");
+
+                database.setTransactionSuccessful();
+            } finally {
+                database.endTransaction();
+            }
         }
     };
 

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

@@ -11,17 +11,68 @@
 public interface PlaylistLocalItem extends LocalItem {
     String getOrderingName();
 
+    long getDisplayIndex();
+
     static List<PlaylistLocalItem> merge(
             final List<PlaylistMetadataEntry> localPlaylists,
             final List<PlaylistRemoteEntity> remotePlaylists) {
-        final List<PlaylistLocalItem> items = new ArrayList<>(
+
+        // Merge localPlaylists and remotePlaylists by display index.
+        // If two items have the same display index, sort them in CASE_INSENSITIVE_ORDER.
+        // This algorithm is similar to the merge operation in merge sort.
+
+        final List<PlaylistLocalItem> result = new ArrayList<>(
                 localPlaylists.size() + remotePlaylists.size());
-        items.addAll(localPlaylists);
-        items.addAll(remotePlaylists);
+        final List<PlaylistLocalItem> itemsWithSameIndex = new ArrayList<>();
+
+        // The data from database may not be in the display index order
+        Collections.sort(localPlaylists,
+                Comparator.comparingLong(PlaylistMetadataEntry::getDisplayIndex));
+        Collections.sort(remotePlaylists,
+                Comparator.comparingLong(PlaylistRemoteEntity::getDisplayIndex));
+        int i = 0;
+        int j = 0;
+        while (i < localPlaylists.size()) {
+            while (j < remotePlaylists.size()) {
+                if (remotePlaylists.get(j).getDisplayIndex()
+                        <= localPlaylists.get(i).getDisplayIndex()) {
+                    addItem(result, remotePlaylists.get(j), itemsWithSameIndex);
+                    j++;
+                } else {
+                    break;
+                }
+            }
+            addItem(result, localPlaylists.get(i), itemsWithSameIndex);
+            i++;
+        }
+        while (j < remotePlaylists.size()) {
+            addItem(result, remotePlaylists.get(j), itemsWithSameIndex);
+            j++;
+        }
+        addItemsWithSameIndex(result, itemsWithSameIndex);
 
-        Collections.sort(items, Comparator.comparing(PlaylistLocalItem::getOrderingName,
-                Comparator.nullsLast(String.CASE_INSENSITIVE_ORDER)));
+        return result;
+    }
+
+    static void addItem(final List<PlaylistLocalItem> result, final PlaylistLocalItem item,
+                        final List<PlaylistLocalItem> itemsWithSameIndex) {
+        if (!itemsWithSameIndex.isEmpty()
+                && itemsWithSameIndex.get(0).getDisplayIndex() != item.getDisplayIndex()) {
+            // The new item has a different display index, add previous items with same
+            // index to the result.
+            addItemsWithSameIndex(result, itemsWithSameIndex);
+            itemsWithSameIndex.clear();
+        }
+        itemsWithSameIndex.add(item);
+    }
 
-        return items;
+    static void addItemsWithSameIndex(final List<PlaylistLocalItem> result,
+                                      final List<PlaylistLocalItem> itemsWithSameIndex) {
+        if (itemsWithSameIndex.size() > 1) {
+            Collections.sort(itemsWithSameIndex,
+                    Comparator.comparing(PlaylistLocalItem::getOrderingName,
+                            Comparator.nullsLast(String.CASE_INSENSITIVE_ORDER)));
+        }
+        result.addAll(itemsWithSameIndex);
     }
 }

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

@@ -2,6 +2,7 @@
 
 import androidx.room.ColumnInfo;
 
+import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_DISPLAY_INDEX;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_ID;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_NAME;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_THUMBNAIL_URL;
@@ -15,14 +16,17 @@ public class PlaylistMetadataEntry implements PlaylistLocalItem {
     public final String name;
     @ColumnInfo(name = PLAYLIST_THUMBNAIL_URL)
     public final String thumbnailUrl;
+    @ColumnInfo(name = PLAYLIST_DISPLAY_INDEX)
+    public long displayIndex;
     @ColumnInfo(name = PLAYLIST_STREAM_COUNT)
     public final long streamCount;
 
     public PlaylistMetadataEntry(final long uid, final String name, final String thumbnailUrl,
-                                 final long streamCount) {
+                                 final long displayIndex, final long streamCount) {
         this.uid = uid;
         this.name = name;
         this.thumbnailUrl = thumbnailUrl;
+        this.displayIndex = displayIndex;
         this.streamCount = streamCount;
     }
 
@@ -35,4 +39,9 @@ public LocalItemType getLocalItemType() {
     public String getOrderingName() {
         return name;
     }
+
+    @Override
+    public long getDisplayIndex() {
+        return displayIndex;
+    }
 }

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

@@ -2,6 +2,7 @@
 
 import androidx.room.Dao;
 import androidx.room.Query;
+import androidx.room.Transaction;
 
 import org.schabi.newpipe.database.BasicDAO;
 import org.schabi.newpipe.database.playlist.model.PlaylistEntity;
@@ -36,4 +37,17 @@ default Flowable<List<PlaylistEntity>> listByService(final int serviceId) {
 
     @Query("SELECT COUNT(*) FROM " + PLAYLIST_TABLE)
     Flowable<Long> getCount();
+
+    @Transaction
+    default long upsertPlaylist(final PlaylistEntity playlist) {
+        final long playlistId = playlist.getUid();
+
+        if (playlistId == -1) {
+            // This situation is probably impossible.
+            return insert(playlist);
+        } else {
+            update(playlist);
+            return playlistId;
+        }
+    }
 }

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

@@ -31,6 +31,10 @@ public interface PlaylistRemoteDAO extends BasicDAO<PlaylistRemoteEntity> {
             + " WHERE " + REMOTE_PLAYLIST_SERVICE_ID + " = :serviceId")
     Flowable<List<PlaylistRemoteEntity>> listByService(int serviceId);
 
+    @Query("SELECT * FROM " + REMOTE_PLAYLIST_TABLE + " WHERE "
+            + REMOTE_PLAYLIST_ID + " = :playlistId")
+    Flowable<List<PlaylistRemoteEntity>> getPlaylist(long playlistId);
+
     @Query("SELECT * FROM " + REMOTE_PLAYLIST_TABLE + " WHERE "
             + REMOTE_PLAYLIST_URL + " = :url AND " + REMOTE_PLAYLIST_SERVICE_ID + " = :serviceId")
     Flowable<List<PlaylistRemoteEntity>> getPlaylist(long serviceId, String url);

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

@@ -15,6 +15,7 @@
 import io.reactivex.rxjava3.core.Flowable;
 
 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;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_NAME;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_TABLE;
@@ -75,12 +76,25 @@ default Flowable<List<PlaylistStreamEntity>> listByService(final int serviceId)
 
     @Transaction
     @Query("SELECT " + PLAYLIST_ID + ", " + PLAYLIST_NAME + ", " + PLAYLIST_THUMBNAIL_URL + ", "
+            + PLAYLIST_DISPLAY_INDEX + ", "
             + "COALESCE(COUNT(" + JOIN_PLAYLIST_ID + "), 0) AS " + PLAYLIST_STREAM_COUNT
 
             + " FROM " + PLAYLIST_TABLE
             + " LEFT JOIN " + PLAYLIST_STREAM_JOIN_TABLE
             + " ON " + PLAYLIST_ID + " = " + JOIN_PLAYLIST_ID
-            + " GROUP BY " + JOIN_PLAYLIST_ID
+            + " GROUP BY " + PLAYLIST_ID
             + " ORDER BY " + PLAYLIST_NAME + " COLLATE NOCASE ASC")
     Flowable<List<PlaylistMetadataEntry>> getPlaylistMetadata();
+
+    @Transaction
+    @Query("SELECT " + PLAYLIST_ID + ", " + PLAYLIST_NAME + ", " + PLAYLIST_THUMBNAIL_URL + ", "
+            + PLAYLIST_DISPLAY_INDEX + ", "
+            + "COALESCE(COUNT(" + JOIN_PLAYLIST_ID + "), 0) AS " + PLAYLIST_STREAM_COUNT
+
+            + " FROM " + PLAYLIST_TABLE
+            + " LEFT JOIN " + PLAYLIST_STREAM_JOIN_TABLE
+            + " ON " + PLAYLIST_ID + " = " + JOIN_PLAYLIST_ID
+            + " GROUP BY " + PLAYLIST_ID
+            + " ORDER BY " + PLAYLIST_DISPLAY_INDEX)
+    Flowable<List<PlaylistMetadataEntry>> getDisplayIndexOrderedPlaylistMetadata();
 }

app/src/main/java/org/schabi/newpipe/database/playlist/model/PlaylistEntity.java

@@ -2,19 +2,23 @@
 
 import androidx.room.ColumnInfo;
 import androidx.room.Entity;
+import androidx.room.Ignore;
 import androidx.room.Index;
 import androidx.room.PrimaryKey;
 
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_NAME;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_TABLE;
 
+import org.schabi.newpipe.database.playlist.PlaylistMetadataEntry;
+
 @Entity(tableName = PLAYLIST_TABLE,
         indices = {@Index(value = {PLAYLIST_NAME})})
 public class PlaylistEntity {
     public static final String PLAYLIST_TABLE = "playlists";
     public static final String PLAYLIST_ID = "uid";
     public static final String PLAYLIST_NAME = "name";
     public static final String PLAYLIST_THUMBNAIL_URL = "thumbnail_url";
+    public static final String PLAYLIST_DISPLAY_INDEX = "display_index";
 
     @PrimaryKey(autoGenerate = true)
     @ColumnInfo(name = PLAYLIST_ID)
@@ -26,9 +30,21 @@ public class PlaylistEntity {
     @ColumnInfo(name = PLAYLIST_THUMBNAIL_URL)
     private String thumbnailUrl;
 
-    public PlaylistEntity(final String name, final String thumbnailUrl) {
+    @ColumnInfo(name = PLAYLIST_DISPLAY_INDEX)
+    private long displayIndex;
+
+    public PlaylistEntity(final String name, final String thumbnailUrl, final long displayIndex) {
         this.name = name;
         this.thumbnailUrl = thumbnailUrl;
+        this.displayIndex = displayIndex;
+    }
+
+    @Ignore
+    public PlaylistEntity(final PlaylistMetadataEntry item) {
+        this.uid = item.uid;
+        this.name = item.name;
+        this.thumbnailUrl = item.thumbnailUrl;
+        this.displayIndex = item.displayIndex;
     }
 
     public long getUid() {
@@ -54,4 +70,12 @@ public String getThumbnailUrl() {
     public void setThumbnailUrl(final String thumbnailUrl) {
         this.thumbnailUrl = thumbnailUrl;
     }
+
+    public long getDisplayIndex() {
+        return displayIndex;
+    }
+
+    public void setDisplayIndex(final long displayIndex) {
+        this.displayIndex = displayIndex;
+    }
 }