Move backup models to domain module

(cherry picked from commit 5908bd19305b3461165fcfe2da5d2217115562b9) # Conflicts: # app/src/main/java/eu/kanade/tachiyomi/data/backup/create/BackupCreator.kt # app/src/main/java/eu/kanade/tachiyomi/data/backup/create/creators/MangaBackupCreator.kt # app/src/main/java/eu/kanade/tachiyomi/data/backup/restore/BackupRestorer.kt # app/src/main/java/eu/kanade/tachiyomi/data/backup/restore/restorers/MangaRestorer.kt # app/src/main/java/eu/kanade/tachiyomi/di/AppModule.kt # domain/src/main/java/tachiyomi/domain/backup/model/Backup.kt # domain/src/main/java/tachiyomi/domain/backup/model/BackupFlatMetadata.kt # domain/src/main/java/tachiyomi/domain/backup/model/BackupManga.kt # domain/src/main/java/tachiyomi/domain/backup/model/BackupMergedMangaReference.kt # domain/src/main/java/tachiyomi/domain/backup/model/BackupSavedSearch.kt # domain/src/main/java/tachiyomi/domain/backup/model/metadata/BackupSearchMetadata.kt # domain/src/main/java/tachiyomi/domain/backup/model/metadata/BackupSearchTag.kt # domain/src/main/java/tachiyomi/domain/backup/model/metadata/BackupSearchTitle.kt
2023-12-24 17:38:01 -05:00
parent 2238b123f9
commit a96cff950a
35 changed files with 209 additions and 212 deletions
@@ -0,0 +1,20 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.Serializer
+import kotlinx.serialization.protobuf.ProtoNumber
+
+@Serializer(forClass = Backup::class)
+object BackupSerializer
+
+@Serializable
+data class Backup(
+    @ProtoNumber(1) val backupManga: List<BackupManga>,
+    @ProtoNumber(2) var backupCategories: List<BackupCategory> = emptyList(),
+    @ProtoNumber(100) var backupBrokenSources: List<BrokenBackupSource> = emptyList(),
+    @ProtoNumber(101) var backupSources: List<BackupSource> = emptyList(),
+    @ProtoNumber(104) var backupPreferences: List<BackupPreference> = emptyList(),
+    @ProtoNumber(105) var backupSourcePreferences: List<BackupSourcePreferences> = emptyList(),
+    // SY specific values
+    @ProtoNumber(600) var backupSavedSearches: List<BackupSavedSearch> = emptyList(),
+)
@@ -0,0 +1,31 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+import tachiyomi.domain.category.model.Category
+
+@Serializable
+class BackupCategory(
+    @ProtoNumber(1) var name: String,
+    @ProtoNumber(2) var order: Long = 0,
+    // @ProtoNumber(3) val updateInterval: Int = 0, 1.x value not used in 0.x
+    @ProtoNumber(100) var flags: Long = 0,
+    // SY specific values
+    /*@ProtoNumber(600) var mangaOrder: List<Long> = emptyList(),*/
+) {
+    fun toCategory(id: Long) = Category(
+        id = id,
+        name = this@BackupCategory.name,
+        flags = this@BackupCategory.flags,
+        order = this@BackupCategory.order,
+        /*mangaOrder = this@BackupCategory.mangaOrder*/
+    )
+}
+
+val backupCategoryMapper = { category: Category ->
+    BackupCategory(
+        name = category.name,
+        order = category.order,
+        flags = category.flags,
+    )
+}
@@ -0,0 +1,70 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+import tachiyomi.domain.chapter.model.Chapter
+
+@Serializable
+data class BackupChapter(
+    // in 1.x some of these values have different names
+    // url is called key in 1.x
+    @ProtoNumber(1) var url: String,
+    @ProtoNumber(2) var name: String,
+    @ProtoNumber(3) var scanlator: String? = null,
+    @ProtoNumber(4) var read: Boolean = false,
+    @ProtoNumber(5) var bookmark: Boolean = false,
+    // lastPageRead is called progress in 1.x
+    @ProtoNumber(6) var lastPageRead: Long = 0,
+    @ProtoNumber(7) var dateFetch: Long = 0,
+    @ProtoNumber(8) var dateUpload: Long = 0,
+    // chapterNumber is called number is 1.x
+    @ProtoNumber(9) var chapterNumber: Float = 0F,
+    @ProtoNumber(10) var sourceOrder: Long = 0,
+    @ProtoNumber(11) var lastModifiedAt: Long = 0,
+) {
+    fun toChapterImpl(): Chapter {
+        return Chapter.create().copy(
+            url = this@BackupChapter.url,
+            name = this@BackupChapter.name,
+            chapterNumber = this@BackupChapter.chapterNumber.toDouble(),
+            scanlator = this@BackupChapter.scanlator,
+            read = this@BackupChapter.read,
+            bookmark = this@BackupChapter.bookmark,
+            lastPageRead = this@BackupChapter.lastPageRead,
+            dateFetch = this@BackupChapter.dateFetch,
+            dateUpload = this@BackupChapter.dateUpload,
+            sourceOrder = this@BackupChapter.sourceOrder,
+            lastModifiedAt = this@BackupChapter.lastModifiedAt,
+        )
+    }
+}
+
+val backupChapterMapper =
+    { _: Long,
+            _: Long,
+            url: String,
+            name: String,
+            scanlator: String?,
+            read: Boolean,
+            bookmark: Boolean,
+            lastPageRead: Long,
+            chapterNumber: Double,
+            source_order: Long,
+            dateFetch: Long,
+            dateUpload: Long,
+            lastModifiedAt: Long,
+        ->
+        BackupChapter(
+            url = url,
+            name = name,
+            chapterNumber = chapterNumber.toFloat(),
+            scanlator = scanlator,
+            read = read,
+            bookmark = bookmark,
+            lastPageRead = lastPageRead,
+            dateFetch = dateFetch,
+            dateUpload = dateUpload,
+            sourceOrder = source_order,
+            lastModifiedAt = lastModifiedAt,
+        )
+    }
@@ -0,0 +1,33 @@
+package tachiyomi.domain.backup.model
+
+import tachiyomi.domain.backup.model.metadata.BackupSearchMetadata
+import tachiyomi.domain.backup.model.metadata.BackupSearchTag
+import tachiyomi.domain.backup.model.metadata.BackupSearchTitle
+import exh.metadata.metadata.base.FlatMetadata
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+
+@Serializable
+data class BackupFlatMetadata(
+    @ProtoNumber(1) var searchMetadata: BackupSearchMetadata,
+    @ProtoNumber(2) var searchTags: List<BackupSearchTag> = emptyList(),
+    @ProtoNumber(3) var searchTitles: List<BackupSearchTitle> = emptyList(),
+) {
+    fun getFlatMetadata(mangaId: Long): FlatMetadata {
+        return FlatMetadata(
+            metadata = searchMetadata.getSearchMetadata(mangaId),
+            tags = searchTags.map { it.getSearchTag(mangaId) },
+            titles = searchTitles.map { it.getSearchTitle(mangaId) },
+        )
+    }
+
+    companion object {
+        fun copyFrom(flatMetadata: FlatMetadata): BackupFlatMetadata {
+            return BackupFlatMetadata(
+                searchMetadata = BackupSearchMetadata.copyFrom(flatMetadata.metadata),
+                searchTags = flatMetadata.tags.map { BackupSearchTag.copyFrom(it) },
+                searchTitles = flatMetadata.titles.map { BackupSearchTitle.copyFrom(it) },
+            )
+        }
+    }
+}
@@ -0,0 +1,32 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+import tachiyomi.domain.history.model.History
+import java.util.Date
+
+@Serializable
+data class BackupHistory(
+    @ProtoNumber(1) var url: String,
+    @ProtoNumber(2) var lastRead: Long,
+    @ProtoNumber(3) var readDuration: Long = 0,
+) {
+    fun getHistoryImpl(): History {
+        return History.create().copy(
+            readAt = Date(lastRead),
+            readDuration = readDuration,
+        )
+    }
+}
+
+@Deprecated("Replaced with BackupHistory. This is retained for legacy reasons.")
+@Serializable
+data class BrokenBackupHistory(
+    @ProtoNumber(0) var url: String,
+    @ProtoNumber(1) var lastRead: Long,
+    @ProtoNumber(2) var readDuration: Long = 0,
+) {
+    fun toBackupHistory(): BackupHistory {
+        return BackupHistory(url, lastRead, readDuration)
+    }
+}
@@ -0,0 +1,81 @@
+package tachiyomi.domain.backup.model
+
+import eu.kanade.tachiyomi.source.model.UpdateStrategy
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+import tachiyomi.domain.manga.model.CustomMangaInfo
+import tachiyomi.domain.manga.model.Manga
+
+@Suppress("DEPRECATION")
+@Serializable
+data class BackupManga(
+    // in 1.x some of these values have different names
+    @ProtoNumber(1) var source: Long,
+    // url is called key in 1.x
+    @ProtoNumber(2) var url: String,
+    @ProtoNumber(3) var title: String = "",
+    @ProtoNumber(4) var artist: String? = null,
+    @ProtoNumber(5) var author: String? = null,
+    @ProtoNumber(6) var description: String? = null,
+    @ProtoNumber(7) var genre: List<String> = emptyList(),
+    @ProtoNumber(8) var status: Int = 0,
+    // thumbnailUrl is called cover in 1.x
+    @ProtoNumber(9) var thumbnailUrl: String? = null,
+    // @ProtoNumber(10) val customCover: String = "", 1.x value, not used in 0.x
+    // @ProtoNumber(11) val lastUpdate: Long = 0, 1.x value, not used in 0.x
+    // @ProtoNumber(12) val lastInit: Long = 0, 1.x value, not used in 0.x
+    @ProtoNumber(13) var dateAdded: Long = 0,
+    @ProtoNumber(14) var viewer: Int = 0, // Replaced by viewer_flags
+    // @ProtoNumber(15) val flags: Int = 0, 1.x value, not used in 0.x
+    @ProtoNumber(16) var chapters: List<BackupChapter> = emptyList(),
+    @ProtoNumber(17) var categories: List<Long> = emptyList(),
+    @ProtoNumber(18) var tracking: List<BackupTracking> = emptyList(),
+    // Bump by 100 for values that are not saved/implemented in 1.x but are used in 0.x
+    @ProtoNumber(100) var favorite: Boolean = true,
+    @ProtoNumber(101) var chapterFlags: Int = 0,
+    @ProtoNumber(102) var brokenHistory: List<BrokenBackupHistory> = emptyList(),
+    @ProtoNumber(103) var viewer_flags: Int? = null,
+    @ProtoNumber(104) var history: List<BackupHistory> = emptyList(),
+    @ProtoNumber(105) var updateStrategy: UpdateStrategy = UpdateStrategy.ALWAYS_UPDATE,
+    @ProtoNumber(106) var lastModifiedAt: Long = 0,
+    @ProtoNumber(107) var favoriteModifiedAt: Long? = null,
+
+    // SY specific values
+    @ProtoNumber(600) var mergedMangaReferences: List<BackupMergedMangaReference> = emptyList(),
+    @ProtoNumber(601) var flatMetadata: BackupFlatMetadata? = null,
+    @ProtoNumber(602) var customStatus: Int = 0,
+
+    // J2K specific values
+    @ProtoNumber(800) var customTitle: String? = null,
+    @ProtoNumber(801) var customArtist: String? = null,
+    @ProtoNumber(802) var customAuthor: String? = null,
+    // skipping 803 due to using duplicate value in previous builds
+    @ProtoNumber(804) var customDescription: String? = null,
+    @ProtoNumber(805) var customGenre: List<String>? = null,
+
+    // Neko specific values
+    @ProtoNumber(901) var filtered_scanlators: String? = null,
+) {
+    fun getMangaImpl(): Manga {
+        return Manga.create().copy(
+            url = this@BackupManga.url,
+            // SY -->
+            ogTitle = this@BackupManga.title,
+            ogArtist = this@BackupManga.artist,
+            ogAuthor = this@BackupManga.author,
+            ogDescription = this@BackupManga.description,
+            ogGenre = this@BackupManga.genre,
+            ogStatus = this@BackupManga.status.toLong(),
+            // SY <--
+            thumbnailUrl = this@BackupManga.thumbnailUrl,
+            favorite = this@BackupManga.favorite,
+            source = this@BackupManga.source,
+            dateAdded = this@BackupManga.dateAdded,
+            viewerFlags = (this@BackupManga.viewer_flags ?: this@BackupManga.viewer).toLong(),
+            chapterFlags = this@BackupManga.chapterFlags.toLong(),
+            updateStrategy = this@BackupManga.updateStrategy,
+            lastModifiedAt = this@BackupManga.lastModifiedAt,
+            favoriteModifiedAt = this@BackupManga.favoriteModifiedAt,
+        )
+    }
+}
@@ -0,0 +1,61 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+import tachiyomi.domain.manga.model.MergedMangaReference
+
+/*
+* SY merged manga backup class
+ */
+@Serializable
+data class BackupMergedMangaReference(
+    @ProtoNumber(1) var isInfoManga: Boolean,
+    @ProtoNumber(2) var getChapterUpdates: Boolean,
+    @ProtoNumber(3) var chapterSortMode: Int,
+    @ProtoNumber(4) var chapterPriority: Int,
+    @ProtoNumber(5) var downloadChapters: Boolean,
+    @ProtoNumber(6) var mergeUrl: String,
+    @ProtoNumber(7) var mangaUrl: String,
+    @ProtoNumber(8) var mangaSourceId: Long,
+) {
+    fun getMergedMangaReference(): MergedMangaReference {
+        return MergedMangaReference(
+            isInfoManga = isInfoManga,
+            getChapterUpdates = getChapterUpdates,
+            chapterSortMode = chapterSortMode,
+            chapterPriority = chapterPriority,
+            downloadChapters = downloadChapters,
+            mergeUrl = mergeUrl,
+            mangaUrl = mangaUrl,
+            mangaSourceId = mangaSourceId,
+            mergeId = null,
+            mangaId = null,
+            id = -1,
+        )
+    }
+}
+
+val backupMergedMangaReferenceMapper =
+    { _: Long,
+            isInfoManga: Boolean,
+            getChapterUpdates: Boolean,
+            chapterSortMode: Long,
+            chapterPriority: Long,
+            downloadChapters: Boolean,
+            _: Long,
+            mergeUrl: String,
+            _: Long?,
+            mangaUrl: String,
+            mangaSourceId: Long,
+        ->
+        BackupMergedMangaReference(
+            isInfoManga = isInfoManga,
+            getChapterUpdates = getChapterUpdates,
+            chapterSortMode = chapterSortMode.toInt(),
+            chapterPriority = chapterPriority.toInt(),
+            downloadChapters = downloadChapters,
+            mergeUrl = mergeUrl,
+            mangaUrl = mangaUrl,
+            mangaSourceId = mangaSourceId,
+        )
+    }
@@ -0,0 +1,37 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+
+@Serializable
+data class BackupPreference(
+    @ProtoNumber(1) val key: String,
+    @ProtoNumber(2) val value: PreferenceValue,
+)
+
+@Serializable
+data class BackupSourcePreferences(
+    @ProtoNumber(1) val sourceKey: String,
+    @ProtoNumber(2) val prefs: List<BackupPreference>,
+)
+
+@Serializable
+sealed class PreferenceValue
+
+@Serializable
+data class IntPreferenceValue(val value: Int) : PreferenceValue()
+
+@Serializable
+data class LongPreferenceValue(val value: Long) : PreferenceValue()
+
+@Serializable
+data class FloatPreferenceValue(val value: Float) : PreferenceValue()
+
+@Serializable
+data class StringPreferenceValue(val value: String) : PreferenceValue()
+
+@Serializable
+data class BooleanPreferenceValue(val value: Boolean) : PreferenceValue()
+
+@Serializable
+data class StringSetPreferenceValue(val value: Set<String>) : PreferenceValue()
@@ -0,0 +1,25 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+
+/*
+* SY saved searches class
+ */
+@Serializable
+data class BackupSavedSearch(
+    @ProtoNumber(1) val name: String,
+    @ProtoNumber(2) val query: String = "",
+    @ProtoNumber(3) val filterList: String = "",
+    @ProtoNumber(4) val source: Long = 0,
+)
+
+val backupSavedSearchMapper =
+    { _: Long, source: Long, name: String, query: String?, filtersJson: String? ->
+        BackupSavedSearch(
+            source = source,
+            name = name,
+            query = query.orEmpty(),
+            filterList = filtersJson ?: "[]",
+        )
+    }
@@ -0,0 +1,18 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+
+@Serializable
+data class BackupSource(
+    @ProtoNumber(1) var name: String = "",
+    @ProtoNumber(2) var sourceId: Long,
+)
+
+@Serializable
+data class BrokenBackupSource(
+    @ProtoNumber(0) var name: String = "",
+    @ProtoNumber(1) var sourceId: Long,
+) {
+    fun toBackupSource() = BackupSource(name, sourceId)
+}
@@ -0,0 +1,72 @@
+package tachiyomi.domain.backup.model
+
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+import tachiyomi.domain.track.model.Track
+
+@Serializable
+data class BackupTracking(
+    // in 1.x some of these values have different types or names
+    // syncId is called siteId in 1,x
+    @ProtoNumber(1) var syncId: Int,
+    // LibraryId is not null in 1.x
+    @ProtoNumber(2) var libraryId: Long,
+    @Deprecated("Use mediaId instead", level = DeprecationLevel.WARNING)
+    @ProtoNumber(3)
+    var mediaIdInt: Int = 0,
+    // trackingUrl is called mediaUrl in 1.x
+    @ProtoNumber(4) var trackingUrl: String = "",
+    @ProtoNumber(5) var title: String = "",
+    // lastChapterRead is called last read, and it has been changed to a float in 1.x
+    @ProtoNumber(6) var lastChapterRead: Float = 0F,
+    @ProtoNumber(7) var totalChapters: Int = 0,
+    @ProtoNumber(8) var score: Float = 0F,
+    @ProtoNumber(9) var status: Int = 0,
+    // startedReadingDate is called startReadTime in 1.x
+    @ProtoNumber(10) var startedReadingDate: Long = 0,
+    // finishedReadingDate is called endReadTime in 1.x
+    @ProtoNumber(11) var finishedReadingDate: Long = 0,
+    @ProtoNumber(100) var mediaId: Long = 0,
+) {
+
+    @Suppress("DEPRECATION")
+    fun getTrackImpl(): Track {
+        return Track(
+            id = -1,
+            mangaId = -1,
+            syncId = this@BackupTracking.syncId.toLong(),
+            remoteId = if (this@BackupTracking.mediaIdInt != 0) {
+                this@BackupTracking.mediaIdInt.toLong()
+            } else {
+                this@BackupTracking.mediaId
+            },
+            libraryId = this@BackupTracking.libraryId,
+            title = this@BackupTracking.title,
+            lastChapterRead = this@BackupTracking.lastChapterRead.toDouble(),
+            totalChapters = this@BackupTracking.totalChapters.toLong(),
+            score = this@BackupTracking.score.toDouble(),
+            status = this@BackupTracking.status.toLong(),
+            startDate = this@BackupTracking.startedReadingDate,
+            finishDate = this@BackupTracking.finishedReadingDate,
+            remoteUrl = this@BackupTracking.trackingUrl,
+        )
+    }
+}
+
+val backupTrackMapper = {
+        _: Long, _: Long, syncId: Long, mediaId: Long, libraryId: Long?, title: String, lastChapterRead: Double, totalChapters: Long, status: Long, score: Double, remoteUrl: String, startDate: Long, finishDate: Long ->
+    BackupTracking(
+        syncId = syncId.toInt(),
+        mediaId = mediaId,
+        // forced not null so its compatible with 1.x backup system
+        libraryId = libraryId ?: 0,
+        title = title,
+        lastChapterRead = lastChapterRead.toFloat(),
+        totalChapters = totalChapters.toInt(),
+        score = score.toFloat(),
+        status = status.toInt(),
+        startedReadingDate = startDate,
+        finishedReadingDate = finishDate,
+        trackingUrl = remoteUrl,
+    )
+}
@@ -0,0 +1,34 @@
+package tachiyomi.domain.backup.model.metadata
+
+import exh.metadata.sql.models.SearchMetadata
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+
+@Serializable
+data class BackupSearchMetadata(
+    @ProtoNumber(1) var uploader: String? = null,
+    @ProtoNumber(2) var extra: String,
+    @ProtoNumber(3) var indexedExtra: String? = null,
+    @ProtoNumber(4) var extraVersion: Int,
+) {
+    fun getSearchMetadata(mangaId: Long): SearchMetadata {
+        return SearchMetadata(
+            mangaId = mangaId,
+            uploader = uploader,
+            extra = extra,
+            indexedExtra = indexedExtra,
+            extraVersion = extraVersion,
+        )
+    }
+
+    companion object {
+        fun copyFrom(searchMetadata: SearchMetadata): BackupSearchMetadata {
+            return BackupSearchMetadata(
+                uploader = searchMetadata.uploader,
+                extra = searchMetadata.extra,
+                indexedExtra = searchMetadata.indexedExtra,
+                extraVersion = searchMetadata.extraVersion,
+            )
+        }
+    }
+}
@@ -0,0 +1,32 @@
+package tachiyomi.domain.backup.model.metadata
+
+import exh.metadata.sql.models.SearchTag
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+
+@Serializable
+data class BackupSearchTag(
+    @ProtoNumber(1) var namespace: String? = null,
+    @ProtoNumber(2) var name: String,
+    @ProtoNumber(3) var type: Int,
+) {
+    fun getSearchTag(mangaId: Long): SearchTag {
+        return SearchTag(
+            id = null,
+            mangaId = mangaId,
+            namespace = namespace,
+            name = name,
+            type = type,
+        )
+    }
+
+    companion object {
+        fun copyFrom(searchTag: SearchTag): BackupSearchTag {
+            return BackupSearchTag(
+                namespace = searchTag.namespace,
+                name = searchTag.name,
+                type = searchTag.type,
+            )
+        }
+    }
+}
@@ -0,0 +1,29 @@
+package tachiyomi.domain.backup.model.metadata
+
+import exh.metadata.sql.models.SearchTitle
+import kotlinx.serialization.Serializable
+import kotlinx.serialization.protobuf.ProtoNumber
+
+@Serializable
+data class BackupSearchTitle(
+    @ProtoNumber(1) var title: String,
+    @ProtoNumber(2) var type: Int,
+) {
+    fun getSearchTitle(mangaId: Long): SearchTitle {
+        return SearchTitle(
+            id = null,
+            mangaId = mangaId,
+            title = title,
+            type = type,
+        )
+    }
+
+    companion object {
+        fun copyFrom(searchTitle: SearchTitle): BackupSearchTitle {
+            return BackupSearchTitle(
+                title = searchTitle.title,
+                type = searchTitle.type,
+            )
+        }
+    }
+}