Sort bookmarked playlists

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

@@ -13,6 +13,8 @@ import org.junit.Assert.assertNull
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
+import org.schabi.newpipe.database.playlist.model.PlaylistEntity
+import org.schabi.newpipe.database.playlist.model.PlaylistRemoteEntity
 import org.schabi.newpipe.extractor.ServiceList
 import org.schabi.newpipe.extractor.stream.StreamType
 
@@ -22,13 +24,17 @@ class DatabaseMigrationTest {
         private const val DEFAULT_SERVICE_ID = 0
         private const val DEFAULT_URL = "https://www.youtube.com/watch?v=cDphUib5iG4"
         private const val DEFAULT_TITLE = "Test Title"
+        private const val DEFAULT_NAME = "Test Name"
         private val DEFAULT_TYPE = StreamType.VIDEO_STREAM
         private const val DEFAULT_DURATION = 480L
         private const val DEFAULT_UPLOADER_NAME = "Uploader Test"
         private const val DEFAULT_THUMBNAIL = "https://example.com/example.jpg"
 
-        private const val DEFAULT_SECOND_SERVICE_ID = 0
+        private const val DEFAULT_SECOND_SERVICE_ID = 1
         private const val DEFAULT_SECOND_URL = "https://www.youtube.com/watch?v=ncQU6iBn5Fc"
+
+        private const val DEFAULT_THIRD_SERVICE_ID = 2
+        private const val DEFAULT_THIRD_URL = "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
     }
 
     @get:Rule
@@ -115,6 +121,13 @@ class DatabaseMigrationTest {
             Migrations.MIGRATION_7_8
         )
 
+        testHelper.runMigrationsAndValidate(
+            AppDatabase.DATABASE_NAME,
+            Migrations.DB_VER_9,
+            true,
+            Migrations.MIGRATION_8_9
+        )
+
         val migratedDatabaseV3 = getMigratedDatabase()
         val listFromDB = migratedDatabaseV3.streamDAO().all.blockingFirst()
 
@@ -198,6 +211,11 @@ class DatabaseMigrationTest {
             true, Migrations.MIGRATION_7_8
         )
 
+        testHelper.runMigrationsAndValidate(
+            AppDatabase.DATABASE_NAME, Migrations.DB_VER_9,
+            true, Migrations.MIGRATION_8_9
+        )
+
         val migratedDatabaseV8 = getMigratedDatabase()
         val listFromDB = migratedDatabaseV8.searchHistoryDAO().all.blockingFirst()
 
@@ -207,6 +225,94 @@ class DatabaseMigrationTest {
         assertNotEquals(listFromDB[0].serviceId, listFromDB[1].serviceId)
     }
 
+    @Test
+    fun migrateDatabaseFrom8to9() {
+        val databaseInV8 = testHelper.createDatabase(AppDatabase.DATABASE_NAME, Migrations.DB_VER_8)
+
+        val localUid1: Long
+        val localUid2: Long
+        val remoteUid1: Long
+        val remoteUid2: Long
+        databaseInV8.run {
+            localUid1 = insert(
+                "playlists", SQLiteDatabase.CONFLICT_FAIL,
+                ContentValues().apply {
+                    put("name", DEFAULT_NAME + "1")
+                    put("is_thumbnail_permanent", false)
+                    put("thumbnail_stream_id", -1)
+                }
+            )
+            localUid2 = insert(
+                "playlists", SQLiteDatabase.CONFLICT_FAIL,
+                ContentValues().apply {
+                    put("name", DEFAULT_NAME + "2")
+                    put("is_thumbnail_permanent", false)
+                    put("thumbnail_stream_id", -1)
+                }
+            )
+            delete(
+                "playlists", "uid = ?",
+                Array(1) { localUid1 }
+            )
+            remoteUid1 = insert(
+                "remote_playlists", SQLiteDatabase.CONFLICT_FAIL,
+                ContentValues().apply {
+                    put("service_id", DEFAULT_SERVICE_ID)
+                    put("url", DEFAULT_URL)
+                }
+            )
+            remoteUid2 = insert(
+                "remote_playlists", SQLiteDatabase.CONFLICT_FAIL,
+                ContentValues().apply {
+                    put("service_id", DEFAULT_SECOND_SERVICE_ID)
+                    put("url", DEFAULT_SECOND_URL)
+                }
+            )
+            delete(
+                "remote_playlists", "uid = ?",
+                Array(1) { remoteUid2 }
+            )
+            close()
+        }
+
+        testHelper.runMigrationsAndValidate(
+            AppDatabase.DATABASE_NAME,
+            Migrations.DB_VER_9,
+            true,
+            Migrations.MIGRATION_8_9
+        )
+
+        val migratedDatabaseV9 = getMigratedDatabase()
+        var localListFromDB = migratedDatabaseV9.playlistDAO().all.blockingFirst()
+        var remoteListFromDB = migratedDatabaseV9.playlistRemoteDAO().all.blockingFirst()
+
+        assertEquals(1, localListFromDB.size)
+        assertEquals(localUid2, localListFromDB[0].uid)
+        assertEquals(-1, localListFromDB[0].displayIndex)
+        assertEquals(1, remoteListFromDB.size)
+        assertEquals(remoteUid1, remoteListFromDB[0].uid)
+        assertEquals(-1, remoteListFromDB[0].displayIndex)
+
+        val localUid3 = migratedDatabaseV9.playlistDAO().insert(
+            PlaylistEntity(DEFAULT_NAME + "3", false, -1, -1)
+        )
+        val remoteUid3 = migratedDatabaseV9.playlistRemoteDAO().insert(
+            PlaylistRemoteEntity(
+                DEFAULT_THIRD_SERVICE_ID, DEFAULT_NAME, DEFAULT_THIRD_URL,
+                DEFAULT_THUMBNAIL, DEFAULT_UPLOADER_NAME, -1, 10
+            )
+        )
+
+        localListFromDB = migratedDatabaseV9.playlistDAO().all.blockingFirst()
+        remoteListFromDB = migratedDatabaseV9.playlistRemoteDAO().all.blockingFirst()
+        assertEquals(2, localListFromDB.size)
+        assertEquals(localUid3, localListFromDB[1].uid)
+        assertEquals(-1, localListFromDB[1].displayIndex)
+        assertEquals(2, remoteListFromDB.size)
+        assertEquals(remoteUid3, remoteListFromDB[1].uid)
+        assertEquals(-1, remoteListFromDB[1].displayIndex)
+    }
+
     private fun getMigratedDatabase(): AppDatabase {
         val database: AppDatabase = Room.databaseBuilder(
             ApplicationProvider.getApplicationContext(),

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

@@ -8,6 +8,7 @@
 import static org.schabi.newpipe.database.Migrations.MIGRATION_5_6;
 import static org.schabi.newpipe.database.Migrations.MIGRATION_6_7;
 import static org.schabi.newpipe.database.Migrations.MIGRATION_7_8;
+import static org.schabi.newpipe.database.Migrations.MIGRATION_8_9;
 
 import android.content.Context;
 import android.database.Cursor;
@@ -28,7 +29,7 @@ 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,
-                        MIGRATION_5_6, MIGRATION_6_7, MIGRATION_7_8)
+                        MIGRATION_5_6, MIGRATION_6_7, MIGRATION_7_8, MIGRATION_8_9)
                 .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_8;
+import static org.schabi.newpipe.database.Migrations.DB_VER_9;
 
 import androidx.room.Database;
 import androidx.room.RoomDatabase;
@@ -38,7 +38,7 @@
                 FeedEntity.class, FeedGroupEntity.class, FeedGroupSubscriptionEntity.class,
                 FeedLastUpdatedEntity.class
         },
-        version = DB_VER_8
+        version = DB_VER_9
 )
 public abstract class AppDatabase extends RoomDatabase {
     public static final String DATABASE_NAME = "newpipe.db";

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

@@ -26,6 +26,7 @@ public final class Migrations {
     public static final int DB_VER_6 = 6;
     public static final int DB_VER_7 = 7;
     public static final int DB_VER_8 = 8;
+    public static final int DB_VER_9 = 9;
 
     private static final String TAG = Migrations.class.getName();
     public static final boolean DEBUG = MainActivity.DEBUG;
@@ -187,7 +188,7 @@ 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");
         }
     };
 
@@ -245,6 +246,62 @@ public void migrate(@NonNull final SupportSQLiteDatabase database) {
         }
     };
 
+    public static final Migration MIGRATION_8_9 = new Migration(DB_VER_8, DB_VER_9) {
+        @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, `is_thumbnail_permanent` INTEGER NOT NULL, "
+                        + "`thumbnail_stream_id` INTEGER NOT NULL, "
+                        + "`display_index` INTEGER NOT NULL)");
+                database.execSQL("INSERT INTO `playlists_tmp` "
+                        + "(`uid`, `name`, `is_thumbnail_permanent`, `thumbnail_stream_id`, "
+                        + "`display_index`) "
+                        + "SELECT `uid`, `name`, `is_thumbnail_permanent`, `thumbnail_stream_id`, "
+                        + "-1 "
+                        + "FROM `playlists`");
+
+                // Replace the old table, note that this also removes the index on the name which
+                // we don't need anymore.
+                database.execSQL("DROP TABLE `playlists`");
+                database.execSQL("ALTER TABLE `playlists_tmp` RENAME TO `playlists`");
+
+
+                // 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,"
+                        + "`stream_count` INTEGER)");
+                database.execSQL("INSERT INTO `remote_playlists_tmp` (`uid`, `service_id`, "
+                        + "`name`, `url`, `thumbnail_url`, `uploader`, `display_index`, "
+                        + "`stream_count`)"
+                        + "SELECT `uid`, `service_id`, `name`, `url`, `thumbnail_url`, `uploader`, "
+                        + "-1, `stream_count` FROM `remote_playlists`");
+
+                // Replace the old table, note that this also removes the index on the name which
+                // we don't need anymore.
+                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 UNIQUE INDEX `index_remote_playlists_service_id_url` "
+                        + "ON `remote_playlists` (`service_id`, `url`)");
+
+                database.setTransactionSuccessful();
+            } finally {
+                database.endTransaction();
+            }
+        }
+    };
+
     private Migrations() {
     }
 }

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

@@ -13,12 +13,17 @@ public class PlaylistDuplicatesEntry extends PlaylistMetadataEntry {
     @ColumnInfo(name = PLAYLIST_TIMES_STREAM_IS_CONTAINED)
     public final long timesStreamIsContained;
 
+    @SuppressWarnings("checkstyle:ParameterNumber")
     public PlaylistDuplicatesEntry(final long uid,
                                    final String name,
                                    final String thumbnailUrl,
+                                   final boolean isThumbnailPermanent,
+                                   final long thumbnailStreamId,
+                                   final long displayIndex,
                                    final long streamCount,
                                    final long timesStreamIsContained) {
-        super(uid, name, thumbnailUrl, streamCount);
+        super(uid, name, thumbnailUrl, isThumbnailPermanent, thumbnailStreamId, displayIndex,
+                streamCount);
         this.timesStreamIsContained = timesStreamIsContained;
     }
 }

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

@@ -1,22 +1,13 @@
 package org.schabi.newpipe.database.playlist;
 
 import org.schabi.newpipe.database.LocalItem;
-import org.schabi.newpipe.database.playlist.model.PlaylistRemoteEntity;
-
-import java.util.Comparator;
-import java.util.List;
-import java.util.stream.Collectors;
-import java.util.stream.Stream;
 
 public interface PlaylistLocalItem extends LocalItem {
     String getOrderingName();
 
-    static List<PlaylistLocalItem> merge(
-            final List<PlaylistMetadataEntry> localPlaylists,
-            final List<PlaylistRemoteEntity> remotePlaylists) {
-        return Stream.concat(localPlaylists.stream(), remotePlaylists.stream())
-                .sorted(Comparator.comparing(PlaylistLocalItem::getOrderingName,
-                        Comparator.nullsLast(String.CASE_INSENSITIVE_ORDER)))
-                .collect(Collectors.toList());
-    }
+    long getDisplayIndex();
+
+    long getUid();
+
+    void setDisplayIndex(long displayIndex);
 }

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

@@ -2,27 +2,40 @@
 
 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_PERMANENT;
+import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_THUMBNAIL_STREAM_ID;
 import static org.schabi.newpipe.database.playlist.model.PlaylistEntity.PLAYLIST_THUMBNAIL_URL;
 
 public class PlaylistMetadataEntry implements PlaylistLocalItem {
     public static final String PLAYLIST_STREAM_COUNT = "streamCount";
 
     @ColumnInfo(name = PLAYLIST_ID)
-    public final long uid;
+    private final long uid;
     @ColumnInfo(name = PLAYLIST_NAME)
     public final String name;
+    @ColumnInfo(name = PLAYLIST_THUMBNAIL_PERMANENT)
+    private final boolean isThumbnailPermanent;
+    @ColumnInfo(name = PLAYLIST_THUMBNAIL_STREAM_ID)
+    private final long thumbnailStreamId;
     @ColumnInfo(name = PLAYLIST_THUMBNAIL_URL)
     public final String thumbnailUrl;
+    @ColumnInfo(name = PLAYLIST_DISPLAY_INDEX)
+    private 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 boolean isThumbnailPermanent, final long thumbnailStreamId,
+                                 final long displayIndex, final long streamCount) {
         this.uid = uid;
         this.name = name;
         this.thumbnailUrl = thumbnailUrl;
+        this.isThumbnailPermanent = isThumbnailPermanent;
+        this.thumbnailStreamId = thumbnailStreamId;
+        this.displayIndex = displayIndex;
         this.streamCount = streamCount;
     }
 
@@ -35,4 +48,27 @@ public LocalItemType getLocalItemType() {
     public String getOrderingName() {
         return name;
     }
+
+    public boolean isThumbnailPermanent() {
+        return isThumbnailPermanent;
+    }
+
+    public long getThumbnailStreamId() {
+        return thumbnailStreamId;
+    }
+
+    @Override
+    public long getDisplayIndex() {
+        return displayIndex;
+    }
+
+    @Override
+    public long getUid() {
+        return uid;
+    }
+
+    @Override
+    public void setDisplayIndex(final long displayIndex) {
+        this.displayIndex = displayIndex;
+    }
 }