Saving and Restoring the Web View Navigation History Across Sessions

core/src/main/java/org/kiwix/kiwixmobile/core/dao/HistoryRoomDao.kt

@@ -69,7 +69,7 @@ abstract class HistoryRoomDao : PageDao {
       historyItem.dateString
     )?.let {
       it.apply {
-        // update the exiting entity
+        // update the existing entity
         historyUrl = historyItem.historyUrl
         historyTitle = historyItem.title
         timeStamp = historyItem.timeStamp

core/src/main/java/org/kiwix/kiwixmobile/core/dao/WebViewHistoryRoomDao.kt

@@ -0,0 +1,44 @@
+/*
+ * Kiwix Android
+ * Copyright (c) 2024 Kiwix <android.kiwix.org>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+package org.kiwix.kiwixmobile.core.dao
+
+import androidx.room.Dao
+import androidx.room.Insert
+import androidx.room.Query
+import io.reactivex.Flowable
+import org.kiwix.kiwixmobile.core.dao.entities.WebViewHistoryEntity
+
+@Dao
+abstract class WebViewHistoryRoomDao {
+  @Insert
+  abstract fun insertWebViewPageHistoryItem(webViewHistoryEntity: WebViewHistoryEntity)
+
+  @Query("SELECT * FROM WebViewHistoryEntity ORDER BY isForward ASC,timestamp ASC")
+  abstract fun getAllWebViewPagesHistory(): Flowable<List<WebViewHistoryEntity>>
+
+  @Query("Delete from WebViewHistoryEntity")
+  abstract fun clearWebViewPagesHistory()
+
+  fun clearPageHistoryWithPrimaryKey() {
+    clearWebViewPagesHistory()
+  }
+
+  @Query("DELETE FROM sqlite_sequence WHERE name='PageHistoryRoomEntity'")
+  abstract fun resetPrimaryKey()
+}

core/src/main/java/org/kiwix/kiwixmobile/core/dao/entities/WebViewHistoryEntity.kt

@@ -0,0 +1,42 @@
+/*
+ * Kiwix Android
+ * Copyright (c) 2024 Kiwix <android.kiwix.org>
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+package org.kiwix.kiwixmobile.core.dao.entities
+
+import androidx.room.Entity
+import androidx.room.PrimaryKey
+import org.kiwix.kiwixmobile.core.page.history.adapter.WebViewHistoryItem
+
+@Entity
+data class WebViewHistoryEntity(
+  @PrimaryKey(autoGenerate = true) var id: Long = 0L,
+  val zimId: String,
+  val title: String,
+  val pageUrl: String,
+  val isForward: Boolean = false,
+  val timeStamp: Long
+) {
+  constructor(webViewHistoryItem: WebViewHistoryItem) : this(
+    webViewHistoryItem.databaseId,
+    webViewHistoryItem.zimId,
+    webViewHistoryItem.title,
+    webViewHistoryItem.pageUrl,
+    webViewHistoryItem.isForward,
+    webViewHistoryItem.timeStamp
+  )
+}

core/src/main/java/org/kiwix/kiwixmobile/core/data/DataSource.kt

@@ -20,9 +20,11 @@ package org.kiwix.kiwixmobile.core.data
 import io.reactivex.Completable
 import io.reactivex.Flowable
 import io.reactivex.Single
+import org.kiwix.kiwixmobile.core.dao.entities.WebViewHistoryEntity
 import org.kiwix.kiwixmobile.core.page.bookmark.adapter.LibkiwixBookmarkItem
 import org.kiwix.kiwixmobile.core.page.history.adapter.HistoryListItem
 import org.kiwix.kiwixmobile.core.page.history.adapter.HistoryListItem.HistoryItem
+import org.kiwix.kiwixmobile.core.page.history.adapter.WebViewHistoryItem
 import org.kiwix.kiwixmobile.core.page.notes.adapter.NoteListItem
 import org.kiwix.kiwixmobile.core.zim_manager.Language
 import org.kiwix.kiwixmobile.core.zim_manager.fileselect_view.adapter.BooksOnDiskListItem
@@ -51,4 +53,8 @@ interface DataSource {
   fun saveNote(noteListItem: NoteListItem): Completable
   fun deleteNote(noteTitle: String): Completable
   fun deleteNotes(noteList: List<NoteListItem>): Completable
+
+  fun insertWebViewHistoryItem(pageHistory: WebViewHistoryItem): Completable
+  fun getAllWebViewPagesHistory(): Single<List<WebViewHistoryEntity>>
+  fun clearWebViewPagesHistory(): Completable
 }

core/src/main/java/org/kiwix/kiwixmobile/core/data/KiwixRoomDatabase.kt

@@ -29,10 +29,12 @@ import org.kiwix.kiwixmobile.core.dao.DownloadRoomDao
 import org.kiwix.kiwixmobile.core.dao.HistoryRoomDao
 import org.kiwix.kiwixmobile.core.dao.HistoryRoomDaoCoverts
 import org.kiwix.kiwixmobile.core.dao.NotesRoomDao
+import org.kiwix.kiwixmobile.core.dao.WebViewHistoryRoomDao
 import org.kiwix.kiwixmobile.core.dao.RecentSearchRoomDao
 import org.kiwix.kiwixmobile.core.dao.entities.DownloadRoomEntity
 import org.kiwix.kiwixmobile.core.dao.entities.HistoryRoomEntity
 import org.kiwix.kiwixmobile.core.dao.entities.NotesRoomEntity
+import org.kiwix.kiwixmobile.core.dao.entities.WebViewHistoryEntity
 import org.kiwix.kiwixmobile.core.dao.entities.RecentSearchRoomEntity
 import org.kiwix.kiwixmobile.core.dao.entities.ZimSourceRoomConverter
 
@@ -42,9 +44,10 @@ import org.kiwix.kiwixmobile.core.dao.entities.ZimSourceRoomConverter
     RecentSearchRoomEntity::class,
     HistoryRoomEntity::class,
     NotesRoomEntity::class,
-    DownloadRoomEntity::class
+    DownloadRoomEntity::class,
+    WebViewHistoryEntity::class
   ],
-  version = 5,
+  version = 7,
   exportSchema = false
 )
 @TypeConverters(HistoryRoomDaoCoverts::class, ZimSourceRoomConverter::class)
@@ -53,6 +56,7 @@ abstract class KiwixRoomDatabase : RoomDatabase() {
   abstract fun historyRoomDao(): HistoryRoomDao
   abstract fun notesRoomDao(): NotesRoomDao
   abstract fun downloadRoomDao(): DownloadRoomDao
+  abstract fun pageHistoryRoomDao(): WebViewHistoryRoomDao
 
   companion object {
     private var db: KiwixRoomDatabase? = null
@@ -62,7 +66,14 @@ abstract class KiwixRoomDatabase : RoomDatabase() {
           ?: Room.databaseBuilder(context, KiwixRoomDatabase::class.java, "KiwixRoom.db")
             // We have already database name called kiwix.db in order to avoid complexity we named
             // as kiwixRoom.db
-            .addMigrations(MIGRATION_1_2, MIGRATION_2_3, MIGRATION_3_4, MIGRATION_4_5)
+            .addMigrations(
+              MIGRATION_1_2,
+              MIGRATION_2_3,
+              MIGRATION_3_4,
+              MIGRATION_4_5,
+              MIGRATION_5_6,
+              MIGRATION_6_7
+            )
             .build().also { db = it }
       }
     }
@@ -202,6 +213,43 @@ abstract class KiwixRoomDatabase : RoomDatabase() {
       }
     }
 
+    @Suppress("MagicNumber")
+    private val MIGRATION_5_6 = object : Migration(5, 6) {
+      override fun migrate(database: SupportSQLiteDatabase) {
+        database.execSQL(
+          """
+            CREATE TABLE IF NOT EXISTS `PageHistoryRoomEntity` (
+                `id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+                `zimId` TEXT NOT NULL,
+                `title` TEXT NOT NULL,
+                `pageUrl` TEXT NOT NULL,
+                `isForward` INTEGER NOT NULL DEFAULT 0
+                `timeStamp` INTEGER NOT NULL
+            )
+            """
+        )
+      }
+    }
+
+    @Suppress("MagicNumber")
+    private val MIGRATION_6_7 = object : Migration(6, 7) {
+      override fun migrate(database: SupportSQLiteDatabase) {
+        database.execSQL("DROP TABLE PageHistoryRoomEntity")
+        database.execSQL(
+          """
+            CREATE TABLE IF NOT EXISTS `WebViewHistoryEntity` (
+                `id` INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL,
+                `zimId` TEXT NOT NULL,
+                `title` TEXT NOT NULL,
+                `pageUrl` TEXT NOT NULL,
+                `isForward` INTEGER NOT NULL DEFAULT 0,
+                `timeStamp` INTEGER NOT NULL
+            )
+            """
+        )
+      }
+    }
+
     fun destroyInstance() {
       db = null
     }

core/src/main/java/org/kiwix/kiwixmobile/core/data/Repository.kt

@@ -27,13 +27,16 @@ import org.kiwix.kiwixmobile.core.dao.LibkiwixBookmarks
 import org.kiwix.kiwixmobile.core.dao.NewBookDao
 import org.kiwix.kiwixmobile.core.dao.NewLanguagesDao
 import org.kiwix.kiwixmobile.core.dao.NotesRoomDao
+import org.kiwix.kiwixmobile.core.dao.WebViewHistoryRoomDao
 import org.kiwix.kiwixmobile.core.dao.RecentSearchRoomDao
+import org.kiwix.kiwixmobile.core.dao.entities.WebViewHistoryEntity
 import org.kiwix.kiwixmobile.core.di.qualifiers.IO
 import org.kiwix.kiwixmobile.core.di.qualifiers.MainThread
 import org.kiwix.kiwixmobile.core.extensions.HeaderizableList
 import org.kiwix.kiwixmobile.core.page.bookmark.adapter.LibkiwixBookmarkItem
 import org.kiwix.kiwixmobile.core.page.history.adapter.HistoryListItem
 import org.kiwix.kiwixmobile.core.page.history.adapter.HistoryListItem.HistoryItem
+import org.kiwix.kiwixmobile.core.page.history.adapter.WebViewHistoryItem
 import org.kiwix.kiwixmobile.core.page.notes.adapter.NoteListItem
 import org.kiwix.kiwixmobile.core.reader.ZimReaderContainer
 import org.kiwix.kiwixmobile.core.zim_manager.Language
@@ -55,6 +58,7 @@ class Repository @Inject internal constructor(
   private val bookDao: NewBookDao,
   private val libkiwixBookmarks: LibkiwixBookmarks,
   private val historyRoomDao: HistoryRoomDao,
+  private val webViewHistoryRoomDao: WebViewHistoryRoomDao,
   private val notesRoomDao: NotesRoomDao,
   private val languageDao: NewLanguagesDao,
   private val recentSearchRoomDao: RecentSearchRoomDao,
@@ -144,6 +148,24 @@ class Repository @Inject internal constructor(
     Completable.fromAction { notesRoomDao.deleteNotes(noteList) }
       .subscribeOn(io)
 
+  override fun insertWebViewHistoryItem(pageHistory: WebViewHistoryItem): Completable =
+    Completable.fromAction {
+      webViewHistoryRoomDao.insertWebViewPageHistoryItem(
+        WebViewHistoryEntity(pageHistory)
+      )
+    }
+      .subscribeOn(io)
+
+  override fun getAllWebViewPagesHistory() =
+    webViewHistoryRoomDao.getAllWebViewPagesHistory()
+      .first(emptyList())
+      .subscribeOn(io)
+      .observeOn(mainThread)
+
+  override fun clearWebViewPagesHistory(): Completable =
+    Completable.fromAction(webViewHistoryRoomDao::clearPageHistoryWithPrimaryKey)
+      .subscribeOn(io)
+
   override fun deleteNote(noteTitle: String): Completable =
     Completable.fromAction { notesRoomDao.deleteNote(noteTitle) }
       .subscribeOn(io)

core/src/main/java/org/kiwix/kiwixmobile/core/di/components/CoreComponent.kt

@@ -39,6 +39,7 @@ import org.kiwix.kiwixmobile.core.dao.NewLanguagesDao
 import org.kiwix.kiwixmobile.core.dao.NewNoteDao
 import org.kiwix.kiwixmobile.core.dao.NewRecentSearchDao
 import org.kiwix.kiwixmobile.core.dao.NotesRoomDao
+import org.kiwix.kiwixmobile.core.dao.WebViewHistoryRoomDao
 import org.kiwix.kiwixmobile.core.dao.RecentSearchRoomDao
 import org.kiwix.kiwixmobile.core.data.DataModule
 import org.kiwix.kiwixmobile.core.data.DataSource
@@ -109,6 +110,7 @@ interface CoreComponent {
   fun libkiwixBookmarks(): LibkiwixBookmarks
   fun recentSearchRoomDao(): RecentSearchRoomDao
   fun historyRoomDao(): HistoryRoomDao
+  fun pageHistoryRoomDao(): WebViewHistoryRoomDao
   fun noteRoomDao(): NotesRoomDao
   fun objectBoxToRoomMigrator(): ObjectBoxToRoomMigrator
   fun context(): Context

core/src/main/java/org/kiwix/kiwixmobile/core/di/modules/DatabaseModule.kt

@@ -86,6 +86,10 @@ open class DatabaseModule {
   @Singleton
   fun provideHistoryDao(db: KiwixRoomDatabase) = db.historyRoomDao()
 
+  @Provides
+  @Singleton
+  fun providePageHistoryRoomDao(db: KiwixRoomDatabase) = db.pageHistoryRoomDao()
+
   @Singleton
   @Provides
   fun provideNoteRoomDao(db: KiwixRoomDatabase) = db.notesRoomDao()