From ab8a52faf3eba5ad19090f2f976dfb2c31f57b48 Mon Sep 17 00:00:00 2001
From: Aria Moradi <aria.moradi007@gmail.com>
Date: Mon, 27 Sep 2021 14:36:06 +0330
Subject: [PATCH] rename ChapterTable.chapterIndex to ChapterTable.sourceOrder

---
 .../suwayomi/tachidesk/manga/impl/Chapter.kt  | 28 +++++++++----------
 .../suwayomi/tachidesk/manga/impl/Page.kt     |  2 +-
 .../impl/backup/proto/ProtoBackupImport.kt    |  4 +--
 .../manga/impl/download/DownloadManager.kt    |  2 +-
 .../manga/impl/download/Downloader.kt         |  2 +-
 .../manga/model/dataclass/ChapterDataClass.kt |  1 +
 .../manga/model/table/ChapterTable.kt         |  4 +--
 .../M0016_ChapterIndexRenameToSourceOrder.kt  | 17 +++++++++++
 8 files changed, 39 insertions(+), 21 deletions(-)
 create mode 100644 server/src/main/kotlin/suwayomi/tachidesk/server/database/migration/M0016_ChapterIndexRenameToSourceOrder.kt

diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/Chapter.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/Chapter.kt
index 765e3053..47d93099 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/Chapter.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/Chapter.kt
@@ -40,7 +40,7 @@ object Chapter {
             getSourceChapters(mangaId)
         } else {
             transaction {
-                ChapterTable.select { ChapterTable.manga eq mangaId }.orderBy(ChapterTable.chapterIndex to DESC)
+                ChapterTable.select { ChapterTable.manga eq mangaId }.orderBy(ChapterTable.sourceOrder to DESC)
                     .map {
                         ChapterTable.toDataClass(it)
                     }
@@ -80,7 +80,7 @@ object Chapter {
                         it[chapter_number] = fetchedChapter.chapter_number
                         it[scanlator] = fetchedChapter.scanlator
 
-                        it[chapterIndex] = index + 1
+                        it[sourceOrder] = index + 1
                         it[ChapterTable.manga] = mangaId
                     }
                 } else {
@@ -90,7 +90,7 @@ object Chapter {
                         it[chapter_number] = fetchedChapter.chapter_number
                         it[scanlator] = fetchedChapter.scanlator
 
-                        it[chapterIndex] = index + 1
+                        it[sourceOrder] = index + 1
                         it[ChapterTable.manga] = mangaId
                     }
                 }
@@ -103,8 +103,8 @@ object Chapter {
             val dbChapterList = transaction { ChapterTable.select { ChapterTable.manga eq mangaId }.toList() }
 
             dbChapterList.forEach {
-                if (it[ChapterTable.chapterIndex] >= chapterList.size ||
-                    chapterList[it[ChapterTable.chapterIndex] - 1].url != it[ChapterTable.url]
+                if (it[ChapterTable.sourceOrder] >= chapterList.size ||
+                    chapterList[it[ChapterTable.sourceOrder] - 1].url != it[ChapterTable.url]
                 ) {
                     transaction {
                         PageTable.deleteWhere { PageTable.chapter eq it[ChapterTable.id] }
@@ -151,7 +151,7 @@ object Chapter {
     suspend fun getChapter(chapterIndex: Int, mangaId: Int): ChapterDataClass {
         val chapterEntry = transaction {
             ChapterTable.select {
-                (ChapterTable.chapterIndex eq chapterIndex) and (ChapterTable.manga eq mangaId)
+                (ChapterTable.sourceOrder eq chapterIndex) and (ChapterTable.manga eq mangaId)
             }.first()
         }
 
@@ -159,7 +159,7 @@ object Chapter {
             chapterEntry[ChapterTable.isDownloaded] && firstPageExists(mangaId, chapterEntry[ChapterTable.id].value)
         return if (!isReallyDownloaded) {
             transaction {
-                ChapterTable.update({ (ChapterTable.chapterIndex eq chapterIndex) and (ChapterTable.manga eq mangaId) }) {
+                ChapterTable.update({ (ChapterTable.sourceOrder eq chapterIndex) and (ChapterTable.manga eq mangaId) }) {
                     it[isDownloaded] = false
                 }
             }
@@ -203,7 +203,7 @@ object Chapter {
             val pageCount = pageList.count()
 
             transaction {
-                ChapterTable.update({ (ChapterTable.manga eq mangaId) and (ChapterTable.chapterIndex eq chapterIndex) }) {
+                ChapterTable.update({ (ChapterTable.manga eq mangaId) and (ChapterTable.sourceOrder eq chapterIndex) }) {
                     it[ChapterTable.pageCount] = pageCount
                 }
             }
@@ -219,7 +219,7 @@ object Chapter {
                 chapterEntry[ChapterTable.lastPageRead],
                 chapterEntry[ChapterTable.lastReadAt],
 
-                chapterEntry[ChapterTable.chapterIndex],
+                chapterEntry[ChapterTable.sourceOrder],
                 chapterEntry[ChapterTable.isDownloaded],
                 pageCount,
                 chapterCount.toInt(),
@@ -249,7 +249,7 @@ object Chapter {
     ) {
         transaction {
             if (listOf(isRead, isBookmarked, lastPageRead).any { it != null }) {
-                ChapterTable.update({ (ChapterTable.manga eq mangaId) and (ChapterTable.chapterIndex eq chapterIndex) }) { update ->
+                ChapterTable.update({ (ChapterTable.manga eq mangaId) and (ChapterTable.sourceOrder eq chapterIndex) }) { update ->
                     isRead?.also {
                         update[ChapterTable.isRead] = it
                     }
@@ -264,7 +264,7 @@ object Chapter {
             }
 
             markPrevRead?.let {
-                ChapterTable.update({ (ChapterTable.manga eq mangaId) and (ChapterTable.chapterIndex less chapterIndex) }) {
+                ChapterTable.update({ (ChapterTable.manga eq mangaId) and (ChapterTable.sourceOrder less chapterIndex) }) {
                     it[ChapterTable.isRead] = markPrevRead
                 }
             }
@@ -281,7 +281,7 @@ object Chapter {
     fun modifyChapterMeta(mangaId: Int, chapterIndex: Int, key: String, value: String) {
         transaction {
             val chapterId =
-                ChapterTable.select { (ChapterTable.manga eq mangaId) and (ChapterTable.chapterIndex eq chapterIndex) }
+                ChapterTable.select { (ChapterTable.manga eq mangaId) and (ChapterTable.sourceOrder eq chapterIndex) }
                     .first()[ChapterTable.id].value
             val meta =
                 transaction { ChapterMetaTable.select { (ChapterMetaTable.ref eq chapterId) and (ChapterMetaTable.key eq key) } }.firstOrNull()
@@ -302,14 +302,14 @@ object Chapter {
     fun deleteChapter(mangaId: Int, chapterIndex: Int) {
         transaction {
             val chapterId =
-                ChapterTable.select { (ChapterTable.manga eq mangaId) and (ChapterTable.chapterIndex eq chapterIndex) }
+                ChapterTable.select { (ChapterTable.manga eq mangaId) and (ChapterTable.sourceOrder eq chapterIndex) }
                     .first()[ChapterTable.id].value
 
             val chapterDir = getChapterDir(mangaId, chapterId)
 
             File(chapterDir).deleteRecursively()
 
-            ChapterTable.update({ (ChapterTable.manga eq mangaId) and (ChapterTable.chapterIndex eq chapterIndex) }) {
+            ChapterTable.update({ (ChapterTable.manga eq mangaId) and (ChapterTable.sourceOrder eq chapterIndex) }) {
                 it[isDownloaded] = false
             }
         }
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/Page.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/Page.kt
index f9b7fc5e..15385a38 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/Page.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/Page.kt
@@ -46,7 +46,7 @@ object Page {
         val source = getHttpSource(mangaEntry[MangaTable.sourceReference])
         val chapterEntry = transaction {
             ChapterTable.select {
-                (ChapterTable.chapterIndex eq chapterIndex) and (ChapterTable.manga eq mangaId)
+                (ChapterTable.sourceOrder eq chapterIndex) and (ChapterTable.manga eq mangaId)
             }.first()
         }
         val chapterId = chapterEntry[ChapterTable.id].value
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/backup/proto/ProtoBackupImport.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/backup/proto/ProtoBackupImport.kt
index 3f87743e..73d8c98a 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/backup/proto/ProtoBackupImport.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/backup/proto/ProtoBackupImport.kt
@@ -160,7 +160,7 @@ object ProtoBackupImport : ProtoBackupBase() {
                         it[chapter_number] = chapter.chapter_number
                         it[scanlator] = chapter.scanlator
 
-                        it[chapterIndex] = chaptersLength - chapter.source_order
+                        it[sourceOrder] = chaptersLength - chapter.source_order
                         it[ChapterTable.manga] = mangaId
 
                         it[isRead] = chapter.read
@@ -207,7 +207,7 @@ object ProtoBackupImport : ProtoBackupBase() {
                             it[chapter_number] = chapter.chapter_number
                             it[scanlator] = chapter.scanlator
 
-                            it[chapterIndex] = chaptersLength - chapter.source_order
+                            it[sourceOrder] = chaptersLength - chapter.source_order
                             it[ChapterTable.manga] = mangaId
 
                             it[isRead] = chapter.read
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/download/DownloadManager.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/download/DownloadManager.kt
index a7ede413..905683cf 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/download/DownloadManager.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/download/DownloadManager.kt
@@ -77,7 +77,7 @@ object DownloadManager {
                     mangaId,
                     chapter = ChapterTable.toDataClass(
                         transaction {
-                            ChapterTable.select { (ChapterTable.manga eq mangaId) and (ChapterTable.chapterIndex eq chapterIndex) }
+                            ChapterTable.select { (ChapterTable.manga eq mangaId) and (ChapterTable.sourceOrder eq chapterIndex) }
                                 .first()
                         }
                     )
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/download/Downloader.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/download/Downloader.kt
index d989df2c..dd60b49a 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/download/Downloader.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/impl/download/Downloader.kt
@@ -61,7 +61,7 @@ class Downloader(private val downloadQueue: CopyOnWriteArrayList<DownloadChapter
                 }
                 download.state = Finished
                 transaction {
-                    ChapterTable.update({ (ChapterTable.manga eq download.mangaId) and (ChapterTable.chapterIndex eq download.chapterIndex) }) {
+                    ChapterTable.update({ (ChapterTable.manga eq download.mangaId) and (ChapterTable.sourceOrder eq download.chapterIndex) }) {
                         it[isDownloaded] = true
                     }
                 }
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/model/dataclass/ChapterDataClass.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/model/dataclass/ChapterDataClass.kt
index 805ac007..540cd989 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/model/dataclass/ChapterDataClass.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/model/dataclass/ChapterDataClass.kt
@@ -27,6 +27,7 @@ data class ChapterDataClass(
     /** last read page, zero means not read/no data */
     val lastReadAt: Long,
 
+    // TODO(v0.6.0): rename to sourceOrder
     /** this chapter's index, starts with 1 */
     val index: Int,
 
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/ChapterTable.kt b/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/ChapterTable.kt
index 50ce64ac..4dc627f1 100644
--- a/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/ChapterTable.kt
+++ b/server/src/main/kotlin/suwayomi/tachidesk/manga/model/table/ChapterTable.kt
@@ -27,7 +27,7 @@ object ChapterTable : IntIdTable() {
     val lastReadAt = long("last_read_at").default(0)
 
     // index is reserved by a function
-    val chapterIndex = integer("index")
+    val sourceOrder = integer("source_order")
 
     val isDownloaded = bool("is_downloaded").default(false)
 
@@ -48,7 +48,7 @@ fun ChapterTable.toDataClass(chapterEntry: ResultRow) =
         chapterEntry[isBookmarked],
         chapterEntry[lastPageRead],
         chapterEntry[lastReadAt],
-        chapterEntry[chapterIndex],
+        chapterEntry[sourceOrder],
         chapterEntry[isDownloaded],
         chapterEntry[pageCount],
         transaction { ChapterTable.select { manga eq chapterEntry[manga].value }.count().toInt() },
diff --git a/server/src/main/kotlin/suwayomi/tachidesk/server/database/migration/M0016_ChapterIndexRenameToSourceOrder.kt b/server/src/main/kotlin/suwayomi/tachidesk/server/database/migration/M0016_ChapterIndexRenameToSourceOrder.kt
new file mode 100644
index 00000000..42f8faf7
--- /dev/null
+++ b/server/src/main/kotlin/suwayomi/tachidesk/server/database/migration/M0016_ChapterIndexRenameToSourceOrder.kt
@@ -0,0 +1,17 @@
+package suwayomi.tachidesk.server.database.migration
+
+/*
+ * 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/. */
+
+import de.neonew.exposed.migrations.helpers.SQLMigration
+
+@Suppress("ClassName", "unused")
+class M0016_ChapterIndexRenameToSourceOrder : SQLMigration() {
+    override val sql = """
+        ALTER TABLE CHAPTER ALTER COLUMN INDEX RENAME TO SOURCE_ORDER;
+    """.trimIndent()
+}