Update database migrations and getter/setter

GGAutomaton · GGAutomaton · commit c34549a47d0c · 2022-04-13T21:35:38.000+08:00
diff --git a/app/schemas/org.schabi.newpipe.database.AppDatabase/6.json b/app/schemas/org.schabi.newpipe.database.AppDatabase/6.json
@@ -2,7 +2,7 @@
   "formatVersion": 1,
   "database": {
     "version": 6,
-    "identityHash": "cc9c4d84f52f49105b1c4216b948b5f7",
+    "identityHash": "9ffc14521c566beed378d77430de3f0c",
     "entities": [
       {
         "tableName": "subscriptions",
@@ -447,7 +447,7 @@
       },
       {
         "tableName": "remote_playlists",
-        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`uid` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `service_id` INTEGER NOT NULL, `name` TEXT, `url` TEXT, `thumbnail_url` TEXT, `uploader` TEXT, `stream_count` INTEGER)",
+        "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`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)",
         "fields": [
           {
             "fieldPath": "uid",
@@ -485,6 +485,12 @@
             "affinity": "TEXT",
             "notNull": false
           },
+          {
+            "fieldPath": "displayIndex",
+            "columnName": "display_index",
+            "affinity": "INTEGER",
+            "notNull": true
+          },
           {
             "fieldPath": "streamCount",
             "columnName": "stream_count",
@@ -731,7 +737,7 @@
     "views": [],
     "setupQueries": [
       "CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",
-      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'cc9c4d84f52f49105b1c4216b948b5f7')"
+      "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, '9ffc14521c566beed378d77430de3f0c')"
     ]
   }
 }
diff --git a/app/src/main/java/org/schabi/newpipe/database/Migrations.java b/app/src/main/java/org/schabi/newpipe/database/Migrations.java
@@ -195,31 +195,45 @@ 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 NOT NULL, "
+                        + "(`uid` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "
                         + "`name` TEXT, `thumbnail_url` TEXT,"
-                        + "`display_index` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL)");
+                        + "`display_index` INTEGER NOT NULL DEFAULT 0)");
                 database.execSQL("INSERT INTO `playlists_tmp` (`uid`, `name`, `thumbnail_url`)"
                         + "SELECT `uid`, `name`, `thumbnail_url` FROM `playlists`");
 
-                // drop the old table and create new one
+                // replace the old table
                 database.execSQL("DROP TABLE `playlists`");
-                database.execSQL("CREATE TABLE `playlists` "
-                        + "(`uid` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "
-                        + "`name` TEXT, `thumbnail_url` TEXT,"
-                        + "`display_index` INTEGER NOT NULL UNIQUE)");
+                database.execSQL("ALTER TABLE `playlists_tmp` RENAME TO `playlists`");
 
-                // insert temp data into the new table
-                // set display_index start from zero
-                database.execSQL("INSERT INTO `playlists` SELECT * FROM `playlists_tmp`");
-                database.execSQL("UPDATE `playlists` SET `display_index` = `display_index` - 1");
+                // create index on the new table
+                database.execSQL("CREATE INDEX `index_playlists_name` ON `playlists` (`name`)");
 
-                // drop tmp table
-                database.execSQL("DROP TABLE `playlists_tmp`");
+
+                // 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_playlists_name` ON `playlists` (`name`)");
+                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 {
diff --git a/app/src/main/java/org/schabi/newpipe/database/playlist/PlaylistLocalItem.java b/app/src/main/java/org/schabi/newpipe/database/playlist/PlaylistLocalItem.java
@@ -14,6 +14,7 @@ public interface PlaylistLocalItem extends LocalItem {
     static List<PlaylistLocalItem> merge(
             final List<PlaylistMetadataEntry> localPlaylists,
             final List<PlaylistRemoteEntity> remotePlaylists) {
+        // todo: merge algorithm
         final List<PlaylistLocalItem> items = new ArrayList<>(
                 localPlaylists.size() + remotePlaylists.size());
         items.addAll(localPlaylists);
diff --git a/app/src/main/java/org/schabi/newpipe/database/playlist/PlaylistMetadataEntry.java b/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 final 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;
     }
 
diff --git a/app/src/main/java/org/schabi/newpipe/database/playlist/dao/PlaylistStreamDAO.java b/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,6 +76,7 @@ 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
diff --git a/app/src/main/java/org/schabi/newpipe/database/playlist/model/PlaylistRemoteEntity.java b/app/src/main/java/org/schabi/newpipe/database/playlist/model/PlaylistRemoteEntity.java
@@ -31,6 +31,7 @@ public class PlaylistRemoteEntity implements PlaylistLocalItem {
     public static final String REMOTE_PLAYLIST_URL = "url";
     public static final String REMOTE_PLAYLIST_THUMBNAIL_URL = "thumbnail_url";
     public static final String REMOTE_PLAYLIST_UPLOADER_NAME = "uploader";
+    public static final String REMOTE_PLAYLIST_DISPLAY_INDEX = "display_index";
     public static final String REMOTE_PLAYLIST_STREAM_COUNT = "stream_count";
 
     @PrimaryKey(autoGenerate = true)
@@ -52,6 +53,9 @@ public class PlaylistRemoteEntity implements PlaylistLocalItem {
     @ColumnInfo(name = REMOTE_PLAYLIST_UPLOADER_NAME)
     private String uploader;
 
+    @ColumnInfo(name = REMOTE_PLAYLIST_DISPLAY_INDEX)
+    private long displayIndex;
+
     @ColumnInfo(name = REMOTE_PLAYLIST_STREAM_COUNT)
     private Long streamCount;
 
@@ -66,6 +70,19 @@ public PlaylistRemoteEntity(final int serviceId, final String name, final String
         this.streamCount = streamCount;
     }
 
+    @Ignore
+    public PlaylistRemoteEntity(final int serviceId, final String name, final String url,
+                                final String thumbnailUrl, final String uploader,
+                                final long displayIndex, final Long streamCount) {
+        this.serviceId = serviceId;
+        this.name = name;
+        this.url = url;
+        this.thumbnailUrl = thumbnailUrl;
+        this.uploader = uploader;
+        this.displayIndex = displayIndex;
+        this.streamCount = streamCount;
+    }
+
     @Ignore
     public PlaylistRemoteEntity(final PlaylistInfo info) {
         this(info.getServiceId(), info.getName(), info.getUrl(),
@@ -136,6 +153,14 @@ public void setUploader(final String uploader) {
         this.uploader = uploader;
     }
 
+    public long getDisplayIndex() {
+        return displayIndex;
+    }
+
+    public void setDisplayIndex(final long displayIndex) {
+        this.displayIndex = displayIndex;
+    }
+
     public Long getStreamCount() {
         return streamCount;
     }
diff --git a/app/src/main/java/org/schabi/newpipe/local/bookmark/BookmarkFragment.java b/app/src/main/java/org/schabi/newpipe/local/bookmark/BookmarkFragment.java
@@ -308,7 +308,6 @@ private void changeLocalPlaylistName(final long id, final String name) {
                     + "with new name=[" + name + "] items");
         }
 
-        localPlaylistManager.renamePlaylist(id, name);
         final Disposable disposable = localPlaylistManager.renamePlaylist(id, name)
                 .observeOn(AndroidSchedulers.mainThread())
                 .subscribe(longs -> { /*Do nothing on success*/ }, throwable -> showError(
diff --git a/app/src/main/java/org/schabi/newpipe/local/playlist/LocalPlaylistManager.java b/app/src/main/java/org/schabi/newpipe/local/playlist/LocalPlaylistManager.java
@@ -96,12 +96,17 @@ public Single<Integer> deletePlaylist(final long playlistId) {
     }
 
     public Maybe<Integer> renamePlaylist(final long playlistId, final String name) {
-        return modifyPlaylist(playlistId, name, null);
+        return modifyPlaylist(playlistId, name, null, -1);
     }
 
     public Maybe<Integer> changePlaylistThumbnail(final long playlistId,
                                                   final String thumbnailUrl) {
-        return modifyPlaylist(playlistId, null, thumbnailUrl);
+        return modifyPlaylist(playlistId, null, thumbnailUrl, -1);
+    }
+
+    public Maybe<Integer> changePlaylistDisplayIndex(final long playlistId,
+                                                     final long displayIndex) {
+        return modifyPlaylist(playlistId, null, null, displayIndex);
     }
 
     public String getPlaylistThumbnail(final long playlistId) {
@@ -110,7 +115,8 @@ public String getPlaylistThumbnail(final long playlistId) {
 
     private Maybe<Integer> modifyPlaylist(final long playlistId,
                                           @Nullable final String name,
-                                          @Nullable final String thumbnailUrl) {
+                                          @Nullable final String thumbnailUrl,
+                                          final long displayIndex) {
         return playlistTable.getPlaylist(playlistId)
                 .firstElement()
                 .filter(playlistEntities -> !playlistEntities.isEmpty())
@@ -122,6 +128,9 @@ private Maybe<Integer> modifyPlaylist(final long playlistId,
                     if (thumbnailUrl != null) {
                         playlist.setThumbnailUrl(thumbnailUrl);
                     }
+                    if (displayIndex != -1) {
+                        playlist.setDisplayIndex(displayIndex);
+                    }
                     return playlistTable.update(playlist);
                 }).subscribeOn(Schedulers.io());
     }

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`"formatVersion": 1,`
`3`	`3`	`"database": {`
`4`	`4`	`"version": 6,`
`5`		`- "identityHash": "cc9c4d84f52f49105b1c4216b948b5f7",`
	`5`	`+ "identityHash": "9ffc14521c566beed378d77430de3f0c",`
`6`	`6`	`"entities": [`
`7`	`7`	`{`
`8`	`8`	`"tableName": "subscriptions",`
`@@ -447,7 +447,7 @@`
`447`	`447`	`},`
`448`	`448`	`{`
`449`	`449`	`"tableName": "remote_playlists",`
`450`		- "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`uid` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, `service_id` INTEGER NOT NULL, `name` TEXT, `url` TEXT, `thumbnail_url` TEXT, `uploader` TEXT, `stream_count` INTEGER)",
	`450`	+ "createSql": "CREATE TABLE IF NOT EXISTS `${TABLE_NAME}` (`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)",
`451`	`451`	`"fields": [`
`452`	`452`	`{`
`453`	`453`	`"fieldPath": "uid",`
`@@ -485,6 +485,12 @@`
`485`	`485`	`"affinity": "TEXT",`
`486`	`486`	`"notNull": false`
`487`	`487`	`},`
	`488`	`+ {`
	`489`	`+ "fieldPath": "displayIndex",`
	`490`	`+ "columnName": "display_index",`
	`491`	`+ "affinity": "INTEGER",`
	`492`	`+ "notNull": true`
	`493`	`+ },`
`488`	`494`	`{`
`489`	`495`	`"fieldPath": "streamCount",`
`490`	`496`	`"columnName": "stream_count",`
`@@ -731,7 +737,7 @@`
`731`	`737`	`"views": [],`
`732`	`738`	`"setupQueries": [`
`733`	`739`	`"CREATE TABLE IF NOT EXISTS room_master_table (id INTEGER PRIMARY KEY,identity_hash TEXT)",`
`734`		`- "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, 'cc9c4d84f52f49105b1c4216b948b5f7')"`
	`740`	`+ "INSERT OR REPLACE INTO room_master_table (id,identity_hash) VALUES(42, '9ffc14521c566beed378d77430de3f0c')"`
`735`	`741`	`]`
`736`	`742`	`}`
`737`	`743`	`}`
Original file line number	Diff line number	Diff line change
`@@ -308,7 +308,6 @@ private void changeLocalPlaylistName(final long id, final String name) {`
`308`	`308`	`+ "with new name=[" + name + "] items");`
`309`	`309`	`}`
`310`	`310`
`311`		`- localPlaylistManager.renamePlaylist(id, name);`
`312`	`311`	`final Disposable disposable = localPlaylistManager.renamePlaylist(id, name)`
`313`	`312`	`.observeOn(AndroidSchedulers.mainThread())`
`314`	`313`	`.subscribe(longs -> { /Do nothing on success/ }, throwable -> showError(`