Feature/backup import add backup flags (#1697)

* Add backup flags to backup restore

* Cleanup default backup flags handling

* Optionally exclude manga from backup

Author: schroda

server/src/main/kotlin/suwayomi/tachidesk/graphql/mutations/BackupMutation.kt

@@ -1,11 +1,13 @@
 package suwayomi.tachidesk.graphql.mutations
 
+import com.expediagroup.graphql.generator.annotations.GraphQLDeprecated
 import io.javalin.http.UploadedFile
 import kotlinx.coroutines.flow.first
 import kotlinx.coroutines.withTimeout
 import suwayomi.tachidesk.graphql.directives.RequireAuth
 import suwayomi.tachidesk.graphql.server.TemporaryFileStorage
 import suwayomi.tachidesk.graphql.types.BackupRestoreStatus
+import suwayomi.tachidesk.graphql.types.PartialBackupFlags
 import suwayomi.tachidesk.graphql.types.toStatus
 import suwayomi.tachidesk.manga.impl.backup.BackupFlags
 import suwayomi.tachidesk.manga.impl.backup.proto.ProtoBackupExport
@@ -19,6 +21,7 @@ class BackupMutation {
     data class RestoreBackupInput(
         val clientMutationId: String? = null,
         val backup: UploadedFile,
+        val flags: PartialBackupFlags? = null,
     )
 
     data class RestoreBackupPayload(
@@ -29,10 +32,14 @@ class BackupMutation {
 
     @RequireAuth
     fun restoreBackup(input: RestoreBackupInput): CompletableFuture<RestoreBackupPayload> {
-        val (clientMutationId, backup) = input
+        val (clientMutationId, backup, flags) = input
 
         return future {
-            val restoreId = ProtoBackupImport.restore(backup.content())
+            val restoreId =
+                ProtoBackupImport.restore(
+                    backup.content(),
+                    BackupFlags.fromPartial(flags),
+                )
 
             withTimeout(10.seconds) {
                 ProtoBackupImport.notifyFlow.first {
@@ -46,11 +53,18 @@ class BackupMutation {
 
     data class CreateBackupInput(
         val clientMutationId: String? = null,
+        val flags: PartialBackupFlags? = null,
+        @GraphQLDeprecated("Will get removed", replaceWith = ReplaceWith("flags"))
         val includeChapters: Boolean? = null,
+        @GraphQLDeprecated("Will get removed", replaceWith = ReplaceWith("flags"))
         val includeCategories: Boolean? = null,
+        @GraphQLDeprecated("Will get removed", replaceWith = ReplaceWith("flags"))
         val includeTracking: Boolean? = null,
+        @GraphQLDeprecated("Will get removed", replaceWith = ReplaceWith("flags"))
         val includeHistory: Boolean? = null,
+        @GraphQLDeprecated("Will get removed", replaceWith = ReplaceWith("flags"))
         val includeClientData: Boolean? = null,
+        @GraphQLDeprecated("Will get removed", replaceWith = ReplaceWith("flags"))
         val includeServerSettings: Boolean? = null,
     )
 
@@ -65,15 +79,19 @@ class BackupMutation {
 
         val backup =
             ProtoBackupExport.createBackup(
-                BackupFlags(
-                    includeManga = true,
-                    includeCategories = input?.includeCategories ?: true,
-                    includeChapters = input?.includeChapters ?: true,
-                    includeTracking = input?.includeTracking ?: true,
-                    includeHistory = input?.includeHistory ?: true,
-                    includeClientData = input?.includeClientData ?: true,
-                    includeServerSettings = input?.includeServerSettings ?: true,
-                ),
+                if (input?.flags != null) {
+                    BackupFlags.fromPartial(input.flags)
+                } else {
+                    BackupFlags(
+                        includeManga = BackupFlags.DEFAULT.includeManga,
+                        includeCategories = input?.includeCategories ?: BackupFlags.DEFAULT.includeCategories,
+                        includeChapters = input?.includeChapters ?: BackupFlags.DEFAULT.includeChapters,
+                        includeTracking = input?.includeTracking ?: BackupFlags.DEFAULT.includeTracking,
+                        includeHistory = input?.includeHistory ?: BackupFlags.DEFAULT.includeHistory,
+                        includeClientData = input?.includeClientData ?: BackupFlags.DEFAULT.includeClientData,
+                        includeServerSettings = input?.includeServerSettings ?: BackupFlags.DEFAULT.includeServerSettings,
+                    )
+                },
             )
 
         TemporaryFileStorage.saveFile(filename, backup)

server/src/main/kotlin/suwayomi/tachidesk/graphql/types/BackupTypes.kt

@@ -1,7 +1,18 @@
 package suwayomi.tachidesk.graphql.types
 
+import suwayomi.tachidesk.manga.impl.backup.IBackupFlags
 import suwayomi.tachidesk.manga.impl.backup.proto.ProtoBackupImport
 
+data class PartialBackupFlags(
+    override val includeManga: Boolean?,
+    override val includeCategories: Boolean?,
+    override val includeChapters: Boolean?,
+    override val includeTracking: Boolean?,
+    override val includeHistory: Boolean?,
+    override val includeClientData: Boolean?,
+    override val includeServerSettings: Boolean?,
+) : IBackupFlags
+
 enum class BackupRestoreState {
     IDLE,
     SUCCESS,

server/src/main/kotlin/suwayomi/tachidesk/manga/controller/BackupController.kt

@@ -89,17 +89,7 @@ object BackupController {
                 ctx.contentType("application/octet-stream")
                 ctx.future {
                     future {
-                        ProtoBackupExport.createBackup(
-                            BackupFlags(
-                                includeManga = true,
-                                includeCategories = true,
-                                includeChapters = true,
-                                includeTracking = true,
-                                includeHistory = true,
-                                includeClientData = true,
-                                includeServerSettings = true,
-                            ),
-                        )
+                        ProtoBackupExport.createBackup(BackupFlags.DEFAULT)
                     }.thenApply { ctx.result(it) }
                 }
             },
@@ -124,17 +114,7 @@ object BackupController {
                 ctx.header("Content-Disposition", """attachment; filename="${Backup.getFilename()}"""")
                 ctx.future {
                     future {
-                        ProtoBackupExport.createBackup(
-                            BackupFlags(
-                                includeManga = true,
-                                includeCategories = true,
-                                includeChapters = true,
-                                includeTracking = true,
-                                includeHistory = true,
-                                includeClientData = true,
-                                includeServerSettings = true,
-                            ),
-                        )
+                        ProtoBackupExport.createBackup(BackupFlags.DEFAULT)
                     }.thenApply { ctx.result(it) }
                 }
             },

server/src/main/kotlin/suwayomi/tachidesk/manga/impl/backup/BackupFlags.kt

@@ -1,18 +1,54 @@
 package suwayomi.tachidesk.manga.impl.backup
 
+import suwayomi.tachidesk.manga.impl.backup.proto.models.Backup
+
 /*
  * Copyright (C) Contributors to the Suwayomi project
  *
  * This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
+interface IBackupFlags {
+    val includeManga: Boolean?
+    val includeCategories: Boolean?
+    val includeChapters: Boolean?
+    val includeTracking: Boolean?
+    val includeHistory: Boolean?
+    val includeClientData: Boolean?
+    val includeServerSettings: Boolean?
+}
+
 data class BackupFlags(
-    val includeManga: Boolean,
-    val includeCategories: Boolean,
-    val includeChapters: Boolean,
-    val includeTracking: Boolean,
-    val includeHistory: Boolean,
-    val includeClientData: Boolean,
-    val includeServerSettings: Boolean,
-)
+    override val includeManga: Boolean,
+    override val includeCategories: Boolean,
+    override val includeChapters: Boolean,
+    override val includeTracking: Boolean,
+    override val includeHistory: Boolean,
+    override val includeClientData: Boolean,
+    override val includeServerSettings: Boolean,
+) : IBackupFlags {
+    companion object {
+        val DEFAULT =
+            BackupFlags(
+                includeManga = true,
+                includeCategories = true,
+                includeChapters = true,
+                includeTracking = true,
+                includeHistory = true,
+                includeClientData = true,
+                includeServerSettings = true,
+            )
+
+        fun fromPartial(partialFlags: IBackupFlags?): BackupFlags =
+            BackupFlags(
+                includeManga = partialFlags?.includeManga ?: DEFAULT.includeManga,
+                includeCategories = partialFlags?.includeCategories ?: DEFAULT.includeCategories,
+                includeChapters = partialFlags?.includeChapters ?: DEFAULT.includeChapters,
+                includeTracking = partialFlags?.includeTracking ?: DEFAULT.includeTracking,
+                includeHistory = partialFlags?.includeHistory ?: DEFAULT.includeHistory,
+                includeClientData = partialFlags?.includeClientData ?: DEFAULT.includeClientData,
+                includeServerSettings = partialFlags?.includeServerSettings ?: DEFAULT.includeServerSettings,
+            )
+    }
+}

server/src/main/kotlin/suwayomi/tachidesk/manga/impl/backup/proto/ProtoBackupExport.kt

@@ -21,6 +21,7 @@ import okio.Sink
 import okio.buffer
 import okio.gzip
 import org.jetbrains.exposed.sql.Query
+import org.jetbrains.exposed.sql.ResultRow
 import org.jetbrains.exposed.sql.SortOrder
 import org.jetbrains.exposed.sql.selectAll
 import org.jetbrains.exposed.sql.transactions.transaction
@@ -118,17 +119,7 @@ object ProtoBackupExport : ProtoBackupBase() {
     private fun createAutomatedBackup() {
         logger.info { "Creating automated backup..." }
 
-        createBackup(
-            BackupFlags(
-                includeManga = true,
-                includeCategories = true,
-                includeChapters = true,
-                includeTracking = true,
-                includeHistory = true,
-                includeClientData = true,
-                includeServerSettings = true,
-            ),
-        ).use { input ->
+        createBackup(BackupFlags.DEFAULT).use { input ->
             val automatedBackupDir = File(applicationDirs.automatedBackupRoot)
             automatedBackupDir.mkdirs()
 
@@ -179,7 +170,12 @@ object ProtoBackupExport : ProtoBackupBase() {
     fun createBackup(flags: BackupFlags): InputStream {
         // Create root object
 
-        val databaseManga = transaction { MangaTable.selectAll().where { MangaTable.inLibrary eq true } }
+        val databaseManga =
+            if (flags.includeManga) {
+                transaction { MangaTable.selectAll().where { MangaTable.inLibrary eq true }.toList() }
+            } else {
+                emptyList()
+            }
 
         val backup: Backup =
             transaction {
@@ -204,7 +200,7 @@ object ProtoBackupExport : ProtoBackupBase() {
     }
 
     private fun backupManga(
-        databaseManga: Query,
+        databaseManga: List<ResultRow>,
         flags: BackupFlags,
     ): List<BackupManga> =
         databaseManga.map { mangaRow ->
@@ -336,7 +332,7 @@ object ProtoBackupExport : ProtoBackupBase() {
     }
 
     private fun backupExtensionInfo(
-        mangas: Query,
+        mangas: List<ResultRow>,
         flags: BackupFlags,
     ): List<BackupSource> {
         val inLibraryMangaSourceIds =