kiwix/kiwix-android
1
0
Fork 0
mirror of https://github.com/kiwix/kiwix-android.git synced 2025-09-23 20:54:13 -04:00
Code Issues Packages Projects Releases Wiki Activity

Removed all ObjectBox code from every variant except the Play Store version.

Browse Source
This commit is contained in:
MohitMaliFtechiz 2025-08-22 19:02:52 +05:30 committed by Kelson
parent 86fa171b50
commit 1d9633c6a4
44 changed files with 505 additions and 237 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
app/build.gradle.kts
View File

@ -1,4 +1,3 @@
import com.android.build.gradle.internal.tasks.factory.dependsOn
import com.slack.keeper.optInToKeeper
import org.w3c.dom.Element
import plugin.KiwixConfigurationPlugin

2
app/src/androidTest/java/org/kiwix/kiwixmobile/ObjectBoxToLibkiwixMigratorTest.kt
View File

@ -40,8 +40,6 @@ import org.junit.jupiter.api.Assertions.assertNotNull
import org.junit.jupiter.api.Assertions.assertTrue
import org.kiwix.kiwixmobile.core.CoreApp
import org.kiwix.kiwixmobile.core.dao.entities.BookOnDiskEntity
import org.kiwix.kiwixmobile.core.dao.entities.BookmarkEntity
import org.kiwix.kiwixmobile.core.data.remote.ObjectBoxToLibkiwixMigrator
import org.kiwix.kiwixmobile.core.di.modules.DatabaseModule
import org.kiwix.kiwixmobile.core.entity.LibkiwixBook
import org.kiwix.kiwixmobile.core.page.bookmark.adapter.LibkiwixBookmarkItem

1
app/src/androidTest/java/org/kiwix/kiwixmobile/ObjectBoxToRoomMigratorTest.kt
View File

@ -47,7 +47,6 @@ import org.kiwix.kiwixmobile.core.dao.entities.HistoryEntity
import org.kiwix.kiwixmobile.core.dao.entities.NotesEntity
import org.kiwix.kiwixmobile.core.dao.entities.RecentSearchEntity
import org.kiwix.kiwixmobile.core.data.KiwixRoomDatabase
import org.kiwix.kiwixmobile.core.data.remote.ObjectBoxToRoomMigrator
import org.kiwix.kiwixmobile.core.di.modules.DatabaseModule
import org.kiwix.kiwixmobile.core.page.notes.adapter.NoteListItem
import org.kiwix.kiwixmobile.core.utils.LanguageUtils

4
app/src/androidTest/java/org/kiwix/kiwixmobile/core/di/components/TestComponent.kt
View File

@ -26,6 +26,7 @@ import org.kiwix.kiwixmobile.core.data.DataModule
import org.kiwix.kiwixmobile.core.di.modules.ApplicationModule
import org.kiwix.kiwixmobile.core.di.modules.CoreViewModelModule
import org.kiwix.kiwixmobile.core.di.modules.JNIModule
import org.kiwix.kiwixmobile.core.di.modules.MigrationModule
import org.kiwix.kiwixmobile.core.di.modules.MutexModule
import org.kiwix.kiwixmobile.core.di.modules.SearchModule
import org.kiwix.kiwixmobile.core.di.modules.TestNetworkModule
@ -44,7 +45,8 @@ import javax.inject.Singleton
DataModule::class,
CoreViewModelModule::class,
SearchModule::class,
MutexModule::class
MutexModule::class,
MigrationModule::class
]
)
interface TestComponent : CoreComponent {

6
core/build.gradle.kts
View File

@ -6,16 +6,11 @@ buildscript {
mavenCentral()
maven { setUrl("https://jitpack.io") }
}
dependencies {
classpath(Libs.objectbox_gradle_plugin)
}
}
plugins {
`android-library`
}
plugins.apply(KiwixConfigurationPlugin::class)
apply(plugin = "io.objectbox")
android {
defaultConfig {
@ -62,7 +57,6 @@ dependencies {
debugImplementation(Libs.leakcanary_android)
implementation(Libs.android_arch_lifecycle_extensions)
implementation(Libs.objectbox_kotlin)
implementation(Libs.webkit)
testImplementation(Libs.kotlinx_coroutines_test)
implementation(Libs.kotlinx_coroutines_android)

54
core/src/main/java/org/kiwix/kiwixmobile/core/dao/entities/LanguageEntity.kt
View File

@ -1,54 +0,0 @@
/*
* Kiwix Android
* Copyright (c) 2019 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 io.objectbox.annotation.Convert
import io.objectbox.annotation.Entity
import io.objectbox.annotation.Id
import io.objectbox.converter.PropertyConverter
import org.kiwix.kiwixmobile.core.compat.CompatHelper.Companion.convertToLocal
import org.kiwix.kiwixmobile.core.zim_manager.Language
import java.util.Locale
@Entity
data class LanguageEntity(
@Id var id: Long = 0,
@Convert(converter = StringToLocaleConverter::class, dbType = String::class)
val locale: Locale = Locale.ENGLISH,
val active: Boolean = false,
val occurencesOfLanguage: Int = 0
) {
constructor(language: Language) : this(
0,
language.languageCode.convertToLocal(),
language.active,
language.occurencesOfLanguage
)
fun toLanguageModel() =
Language(locale, active, occurencesOfLanguage, id)
}
class StringToLocaleConverter : PropertyConverter<Locale, String> {
override fun convertToDatabaseValue(entityProperty: Locale?): String =
entityProperty?.isO3Language ?: Locale.ENGLISH.isO3Language
override fun convertToEntityProperty(databaseValue: String?): Locale =
databaseValue?.convertToLocal() ?: Locale.ENGLISH
}

23
core/src/main/java/org/kiwix/kiwixmobile/core/data/ObjectBoxDataMigrationHandler.kt Normal file
View File

@ -0,0 +1,23 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.data
interface ObjectBoxDataMigrationHandler {
suspend fun migrate()
}

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

@ -37,11 +37,10 @@ import org.kiwix.kiwixmobile.core.dao.WebViewHistoryRoomDao
import org.kiwix.kiwixmobile.core.data.DataModule
import org.kiwix.kiwixmobile.core.data.DataSource
import org.kiwix.kiwixmobile.core.data.remote.KiwixService
import org.kiwix.kiwixmobile.core.data.remote.ObjectBoxToLibkiwixMigrator
import org.kiwix.kiwixmobile.core.data.remote.ObjectBoxToRoomMigrator
import org.kiwix.kiwixmobile.core.di.modules.ApplicationModule
import org.kiwix.kiwixmobile.core.di.modules.CoreViewModelModule
import org.kiwix.kiwixmobile.core.di.modules.JNIModule
import org.kiwix.kiwixmobile.core.di.modules.MigrationModule
import org.kiwix.kiwixmobile.core.di.modules.MutexModule
import org.kiwix.kiwixmobile.core.di.modules.NetworkModule
import org.kiwix.kiwixmobile.core.di.modules.SearchModule
@ -65,7 +64,8 @@ import javax.inject.Singleton
DataModule::class,
CoreViewModelModule::class,
SearchModule::class,
MutexModule::class
MutexModule::class,
MigrationModule::class
]
)
interface CoreComponent {
@ -88,14 +88,12 @@ interface CoreComponent {
fun dataSource(): DataSource
fun downloadRoomDao(): DownloadRoomDao
fun connectivityManager(): ConnectivityManager
fun objectBoxToLibkiwixMigrator(): ObjectBoxToLibkiwixMigrator
fun libkiwixBookmarks(): LibkiwixBookmarks
fun libkiwixBooks(): LibkiwixBookOnDisk
fun recentSearchRoomDao(): RecentSearchRoomDao
fun historyRoomDao(): HistoryRoomDao
fun webViewHistoryRoomDao(): WebViewHistoryRoomDao
fun noteRoomDao(): NotesRoomDao
fun objectBoxToRoomMigrator(): ObjectBoxToRoomMigrator
fun context(): Context
fun downloader(): Downloader
fun notificationManager(): NotificationManager
@ -107,7 +105,5 @@ interface CoreComponent {
fun inject(kiwixWebView: KiwixWebView)
fun inject(errorActivity: ErrorActivity)
fun inject(objectBoxToLibkiwixMigrator: ObjectBoxToLibkiwixMigrator)
fun inject(objectBoxToRoomMigrator: ObjectBoxToRoomMigrator)
fun coreServiceComponent(): CoreServiceComponent.Builder
}

10
core/src/main/java/org/kiwix/kiwixmobile/core/di/modules/ApplicationModule.kt
View File

@ -25,8 +25,6 @@ import android.os.storage.StorageManager
import dagger.Module
import dagger.Provides
import org.kiwix.kiwixmobile.core.DarkModeConfig
import org.kiwix.kiwixmobile.core.data.remote.ObjectBoxToLibkiwixMigrator
import org.kiwix.kiwixmobile.core.data.remote.ObjectBoxToRoomMigrator
import org.kiwix.kiwixmobile.core.downloader.DownloadMonitor
import org.kiwix.kiwixmobile.core.downloader.downloadManager.DownloadManagerMonitor
import org.kiwix.kiwixmobile.core.reader.ZimFileReader
@ -54,14 +52,6 @@ class ApplicationModule {
@Singleton
internal fun provideBookUtils(): BookUtils = BookUtils()
@Provides
@Singleton
fun provideObjectBoxToLibkiwixMigrator() = ObjectBoxToLibkiwixMigrator()
@Provides
@Singleton
fun provideObjectBoxToRoomMigrator() = ObjectBoxToRoomMigrator()
@Provides
@Singleton
internal fun provideDownloadMonitor(

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

@ -20,27 +20,12 @@ package org.kiwix.kiwixmobile.core.di.modules
import android.content.Context
import dagger.Module
import dagger.Provides
import io.objectbox.BoxStore
import org.kiwix.kiwixmobile.core.dao.LibkiwixBookOnDisk
import org.kiwix.kiwixmobile.core.dao.entities.MyObjectBox
import org.kiwix.kiwixmobile.core.data.KiwixRoomDatabase
import javax.inject.Singleton
@Module
open class DatabaseModule {
companion object {
var boxStore: BoxStore? = null
}
@Suppress("UnsafeCallOnNullableType")
// NOT RECOMMENDED TODO use custom runner to load TestApplication
@Provides @Singleton fun providesBoxStore(context: Context): BoxStore {
if (boxStore == null) {
boxStore = MyObjectBox.builder().androidContext(context).build()
}
return boxStore!!
}
@Singleton
@Provides
fun provideYourDatabase(

24
core/src/main/java/org/kiwix/kiwixmobile/core/di/modules/MigrationModule.kt Normal file
View File

@ -0,0 +1,24 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.di.modules
import dagger.Module
@Module
abstract class MigrationModule

14
core/src/main/java/org/kiwix/kiwixmobile/core/main/CoreMainActivity.kt
View File

@ -47,8 +47,7 @@ import org.kiwix.kiwixmobile.core.CoreApp
import org.kiwix.kiwixmobile.core.R
import org.kiwix.kiwixmobile.core.base.BaseActivity
import org.kiwix.kiwixmobile.core.base.FragmentActivityExtensions
import org.kiwix.kiwixmobile.core.data.remote.ObjectBoxToLibkiwixMigrator
import org.kiwix.kiwixmobile.core.data.remote.ObjectBoxToRoomMigrator
import org.kiwix.kiwixmobile.core.data.ObjectBoxDataMigrationHandler
import org.kiwix.kiwixmobile.core.di.components.CoreActivityComponent
import org.kiwix.kiwixmobile.core.downloader.DownloadMonitor
import org.kiwix.kiwixmobile.core.downloader.downloadManager.APP_NAME_KEY
@ -165,9 +164,8 @@ abstract class CoreMainActivity : BaseActivity(), WebViewProvider {
abstract val mainActivity: AppCompatActivity
abstract val appName: String
@Inject lateinit var objectBoxToLibkiwixMigrator: ObjectBoxToLibkiwixMigrator
@Inject lateinit var objectBoxToRoomMigrator: ObjectBoxToRoomMigrator
@Inject
lateinit var objectBoxDataMigrationHandler: ObjectBoxDataMigrationHandler
@Inject
lateinit var downloadMonitor: DownloadMonitor
@ -194,11 +192,7 @@ abstract class CoreMainActivity : BaseActivity(), WebViewProvider {
setMainActivityToCoreApp()
// run the migration on background thread to avoid any UI related issues.
CoroutineScope(Dispatchers.IO).launch {
objectBoxToLibkiwixMigrator.migrateObjectBoxDataToLibkiwix()
}
// run the migration on background thread to avoid any UI related issues.
CoroutineScope(Dispatchers.IO).launch {
objectBoxToRoomMigrator.migrateObjectBoxDataToRoom()
objectBoxDataMigrationHandler.migrate()
}
lifecycleScope.launch(Dispatchers.IO) {
createApplicationShortcuts()

11
core/src/main/java/org/kiwix/kiwixmobile/core/page/bookmark/adapter/BookmarkItem.kt
View File

@ -18,7 +18,6 @@
package org.kiwix.kiwixmobile.core.page.bookmark.adapter
import org.kiwix.kiwixmobile.core.dao.entities.BookmarkEntity
import org.kiwix.kiwixmobile.core.page.adapter.Page
import org.kiwix.kiwixmobile.core.reader.ZimFileReader
import org.kiwix.kiwixmobile.core.reader.ZimReaderSource
@ -35,16 +34,6 @@ data class BookmarkItem(
override val url: String = bookmarkUrl,
override val id: Long = databaseId
) : Page {
constructor(entity: BookmarkEntity) : this(
entity.id,
entity.zimId,
entity.zimName,
entity.zimReaderSource,
entity.bookmarkUrl,
entity.bookmarkTitle,
entity.favicon
)
constructor(
title: String,
url: String,

15
core/src/main/java/org/kiwix/kiwixmobile/core/page/bookmark/adapter/LibkiwixBookmarkItem.kt
View File

@ -18,7 +18,6 @@
package org.kiwix.kiwixmobile.core.page.bookmark.adapter
import org.kiwix.kiwixmobile.core.dao.entities.BookmarkEntity
import org.kiwix.kiwixmobile.core.page.adapter.Page
import org.kiwix.kiwixmobile.core.reader.ZimFileReader
import org.kiwix.kiwixmobile.core.reader.ZimReaderSource
@ -71,20 +70,6 @@ data class LibkiwixBookmarkItem(
libKiwixBook = libKiwixBook
)
constructor(
bookmarkEntity: BookmarkEntity,
libkiwixBook: Book?
) : this(
zimId = bookmarkEntity.zimId,
zimFilePath = bookmarkEntity.zimReaderSource?.toDatabase(),
zimReaderSource = bookmarkEntity.zimReaderSource,
zimName = bookmarkEntity.zimName,
bookmarkUrl = bookmarkEntity.bookmarkUrl,
title = bookmarkEntity.bookmarkTitle,
favicon = bookmarkEntity.favicon,
libKiwixBook = libkiwixBook
)
constructor(
zimId: String,
bookmarkUrl: String

14
core/src/main/java/org/kiwix/kiwixmobile/core/page/history/adapter/HistoryListItem.kt
View File

@ -17,7 +17,6 @@
*/
package org.kiwix.kiwixmobile.core.page.history.adapter
import org.kiwix.kiwixmobile.core.dao.entities.HistoryEntity
import org.kiwix.kiwixmobile.core.dao.entities.HistoryRoomEntity
import org.kiwix.kiwixmobile.core.page.adapter.Page
import org.kiwix.kiwixmobile.core.page.adapter.PageRelated
@ -56,19 +55,6 @@ sealed class HistoryListItem : PageRelated {
timeStamp = timeStamp
)
constructor(historyEntity: HistoryEntity) : this(
historyEntity.id,
historyEntity.zimId,
historyEntity.zimName,
historyEntity.zimReaderSource,
historyEntity.favicon,
historyEntity.historyUrl,
historyEntity.historyTitle,
historyEntity.dateString,
historyEntity.timeStamp,
false
)
constructor(historyRoomEntity: HistoryRoomEntity) : this(
historyRoomEntity.id,
historyRoomEntity.zimId,

11
core/src/main/java/org/kiwix/kiwixmobile/core/page/notes/adapter/NoteListItem.kt
View File

@ -1,6 +1,5 @@
package org.kiwix.kiwixmobile.core.page.notes.adapter
import org.kiwix.kiwixmobile.core.dao.entities.NotesEntity
import org.kiwix.kiwixmobile.core.dao.entities.NotesRoomEntity
import org.kiwix.kiwixmobile.core.page.adapter.Page
import org.kiwix.kiwixmobile.core.reader.ZimReaderSource
@ -18,16 +17,6 @@ data class NoteListItem(
override val url: String = zimUrl,
override val id: Long = databaseId
) : Page, Serializable {
constructor(notesEntity: NotesEntity) : this(
notesEntity.id,
notesEntity.zimId,
notesEntity.noteTitle,
notesEntity.zimReaderSource,
notesEntity.zimUrl,
notesEntity.noteFilePath,
notesEntity.favicon
)
constructor(
zimId: String,
title: String,

12
core/src/main/java/org/kiwix/kiwixmobile/core/zim_manager/fileselect_view/BooksOnDiskListItem.kt
View File

@ -19,7 +19,6 @@
package org.kiwix.kiwixmobile.core.zim_manager.fileselect_view
import org.kiwix.kiwixmobile.core.compat.CompatHelper.Companion.convertToLocal
import org.kiwix.kiwixmobile.core.dao.entities.BookOnDiskEntity
import org.kiwix.kiwixmobile.core.dao.entities.DownloadRoomEntity
import org.kiwix.kiwixmobile.core.entity.LibkiwixBook
import org.kiwix.kiwixmobile.core.reader.ZimFileReader
@ -54,17 +53,6 @@ sealed class BooksOnDiskListItem {
book.language.convertToLocal()
}
@Deprecated(
"Now we are using the libkiwix to store and retrieve the local " +
"books so this constructor is no longer used."
)
constructor(bookOnDiskEntity: BookOnDiskEntity) : this(
databaseId = bookOnDiskEntity.id,
file = bookOnDiskEntity.file,
book = bookOnDiskEntity.toBook(),
zimReaderSource = bookOnDiskEntity.zimReaderSource
)
constructor(downloadRoomEntity: DownloadRoomEntity) : this(
book = downloadRoomEntity.toBook(),
zimReaderSource = ZimReaderSource(File(downloadRoomEntity.file))

1
defaultMigration/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
/build

28
defaultMigration/build.gradle.kts Normal file
View File

@ -0,0 +1,28 @@
import plugin.KiwixConfigurationPlugin
plugins {
id("com.android.library")
id("org.jetbrains.kotlin.android")
}
plugins.apply(KiwixConfigurationPlugin::class)
android {
namespace = "org.kiwix.kiwixmobile.defaultmigration"
defaultConfig {
minSdk = 25
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
consumerProguardFiles("consumer-rules.pro")
}
buildTypes {
release {
isMinifyEnabled = false
proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
}
}
}
dependencies {
implementation(project(":core"))
}

0
defaultMigration/consumer-rules.pro Normal file
View File

21
defaultMigration/proguard-rules.pro vendored Normal file
View File

@ -0,0 +1,21 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html
# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}
# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable
# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile

4
defaultMigration/src/main/AndroidManifest.xml Normal file
View File

@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
</manifest>

17
core/src/main/java/org/kiwix/kiwixmobile/core/base/adapter/BaseViewHolder.kt → defaultMigration/src/main/java/org/kiwix/kiwixmobile/defaultmigration/DefaultMigrationComponent.kt
View File

@ -1,6 +1,6 @@
/*
* Kiwix Android
* Copyright (c) 2019 Kiwix <android.kiwix.org>
* Copyright (c) 2025 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
@ -16,16 +16,11 @@
*
*/
package org.kiwix.kiwixmobile.core.base.adapter
package org.kiwix.kiwixmobile.defaultmigration
import android.view.View
import androidx.recyclerview.widget.RecyclerView.ViewHolder
import kotlinx.android.extensions.LayoutContainer
import dagger.Component
abstract class BaseViewHolder<in ITEM>(override val containerView: View) :
ViewHolder(
containerView
),
LayoutContainer {
abstract fun bind(item: ITEM)
@Component(modules = [DefaultMigrationModule::class])
interface DefaultMigrationComponent {
// Do nothing
}

28
defaultMigration/src/main/java/org/kiwix/kiwixmobile/defaultmigration/DefaultMigrationHandler.kt Normal file
View File

@ -0,0 +1,28 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.defaultmigration
import org.kiwix.kiwixmobile.core.data.ObjectBoxDataMigrationHandler
import javax.inject.Inject
class DefaultMigrationHandler @Inject constructor() : ObjectBoxDataMigrationHandler {
override suspend fun migrate() {
// Do nothing
}
}

30
defaultMigration/src/main/java/org/kiwix/kiwixmobile/defaultmigration/DefaultMigrationModule.kt Normal file
View File

@ -0,0 +1,30 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.defaultmigration
import dagger.Module
import dagger.Provides
import org.kiwix.kiwixmobile.core.data.ObjectBoxDataMigrationHandler
@Module
class DefaultMigrationModule {
@Provides
fun provideMigrationHandler(): ObjectBoxDataMigrationHandler =
DefaultMigrationHandler()
}

1
objectboxmigration/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
/build

45
objectboxmigration/build.gradle.kts Normal file
View File

@ -0,0 +1,45 @@
import org.gradle.kotlin.dsl.apply
import plugin.KiwixConfigurationPlugin
plugins {
id("com.android.library")
id("org.jetbrains.kotlin.android")
}
buildscript {
repositories {
google()
mavenCentral()
maven { setUrl("https://jitpack.io") }
}
dependencies {
classpath(Libs.objectbox_gradle_plugin)
}
}
plugins.apply(KiwixConfigurationPlugin::class)
apply(plugin = "io.objectbox")
android {
namespace = "org.kiwix.kiwixmobile.objectboxmigration"
defaultConfig {
minSdk = 25
testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
consumerProguardFiles("consumer-rules.pro")
}
buildTypes {
release {
isMinifyEnabled = false
proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
}
}
}
dependencies {
implementation(Libs.objectbox_kotlin)
implementation(project(":core"))
}

38
core/objectbox-models/default.json → objectboxmigration/objectbox-models/default.json
View File

@ -98,35 +98,6 @@
],
"relations": []
},
{
"id": "4:6278838675135543734",
"lastPropertyId": "4:8812214350305159407",
"name": "LanguageEntity",
"properties": [
{
"id": "1:7795244654012809404",
"name": "id",
"type": 6,
"flags": 1
},
{
"id": "2:9116495537035444904",
"name": "locale",
"type": 9
},
{
"id": "3:452531964346972307",
"name": "active",
"type": 1
},
{
"id": "4:8812214350305159407",
"name": "occurencesOfLanguage",
"type": 5
}
],
"relations": []
},
{
"id": "5:3222423958972105425",
"lastPropertyId": "11:6493253695033019145",
@ -324,7 +295,8 @@
349148274283701276,
7257718270326155947,
7394649290555378565,
8093454424037540087
8093454424037540087,
6278838675135543734
],
"retiredIndexUids": [
1293695782925933448,
@ -399,7 +371,11 @@
5555873126720275555,
2724607601244650879,
5485468735259326535,
4272820830206771469
4272820830206771469,
7795244654012809404,
9116495537035444904,
452531964346972307,
8812214350305159407
],
"retiredRelationUids": [],
"version": 1

0
core/objectbox-models/default.json.bak → objectboxmigration/objectbox-models/default.json.bak
View File

21
objectboxmigration/proguard-rules.pro vendored Normal file
View File

@ -0,0 +1,21 @@
# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
# http://developer.android.com/guide/developing/tools/proguard.html
# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
# public *;
#}
# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable
# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile

4
objectboxmigration/src/main/AndroidManifest.xml Normal file
View File

@ -0,0 +1,4 @@
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android">
</manifest>

34
objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/ObjectBoxMigrationHandler.kt Normal file
View File

@ -0,0 +1,34 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.objectboxmigration
import org.kiwix.kiwixmobile.core.data.ObjectBoxDataMigrationHandler
import org.kiwix.kiwixmobile.objectboxmigration.data.ObjectBoxToLibkiwixMigrator
import org.kiwix.kiwixmobile.objectboxmigration.data.ObjectBoxToRoomMigrator
import javax.inject.Inject
class ObjectBoxMigrationHandler @Inject constructor(
private val objectBoxToRoomMigrator: ObjectBoxToRoomMigrator,
private val objectBoxToLibkiwixMigrator: ObjectBoxToLibkiwixMigrator
) : ObjectBoxDataMigrationHandler {
override suspend fun migrate() {
objectBoxToRoomMigrator.migrateObjectBoxDataToRoom()
objectBoxToLibkiwixMigrator.migrateObjectBoxDataToLibkiwix()
}
}

29
core/src/main/java/org/kiwix/kiwixmobile/core/data/remote/ObjectBoxToLibkiwixMigrator.kt → objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/data/ObjectBoxToLibkiwixMigrator.kt
View File

@ -16,23 +16,22 @@
*
*/
package org.kiwix.kiwixmobile.core.data.remote
package org.kiwix.kiwixmobile.objectboxmigration.data
import io.objectbox.Box
import io.objectbox.BoxStore
import io.objectbox.kotlin.boxFor
import kotlinx.coroutines.sync.Mutex
import kotlinx.coroutines.sync.withLock
import org.kiwix.kiwixmobile.core.CoreApp
import org.kiwix.kiwixmobile.core.dao.LibkiwixBookOnDisk
import org.kiwix.kiwixmobile.core.dao.LibkiwixBookmarks
import org.kiwix.kiwixmobile.core.dao.entities.BookOnDiskEntity
import org.kiwix.kiwixmobile.core.dao.entities.BookmarkEntity
import org.kiwix.kiwixmobile.core.page.bookmark.adapter.LibkiwixBookmarkItem
import org.kiwix.kiwixmobile.core.reader.ZimReaderSource
import org.kiwix.kiwixmobile.core.utils.SharedPreferenceUtil
import org.kiwix.kiwixmobile.core.utils.files.Log
import org.kiwix.kiwixmobile.core.zim_manager.fileselect_view.BooksOnDiskListItem.BookOnDisk
import org.kiwix.kiwixmobile.objectboxmigration.entities.BookOnDiskEntity
import org.kiwix.kiwixmobile.objectboxmigration.entities.BookmarkEntity
import org.kiwix.libkiwix.Book
import org.kiwix.libzim.Archive
import java.io.File
@ -53,7 +52,7 @@ class ObjectBoxToLibkiwixMigrator {
private val migrationMutex = Mutex()
suspend fun migrateObjectBoxDataToLibkiwix() {
CoreApp.coreComponent.inject(this)
// CoreApp.coreComponent.inject(this)
if (!sharedPreferenceUtil.prefIsBookmarksMigrated) {
migrateBookMarks(boxStore.boxFor())
}
@ -73,7 +72,12 @@ class ObjectBoxToLibkiwixMigrator {
bookOnDiskEntity.zimReaderSource = zimReaderSource
}
}
BookOnDisk(bookOnDiskEntity)
BookOnDisk(
databaseId = bookOnDiskEntity.id,
file = bookOnDiskEntity.file,
book = bookOnDiskEntity.toBook(),
zimReaderSource = bookOnDiskEntity.zimReaderSource
)
}
migrationMutex.withLock {
runCatching {
@ -118,13 +122,22 @@ class ObjectBoxToLibkiwixMigrator {
// to display them on the bookmark screen.
null
}
} ?: kotlin.run {
} ?: run {
// for migrating bookmarks for recent custom apps since in recent version of
// custom app we are using the `assetFileDescriptor` which does not have the filePath.
null
}
libkiwixBookmarks.saveBookmark(
LibkiwixBookmarkItem(bookmarkEntity, libkiwixBook),
LibkiwixBookmarkItem(
zimId = bookmarkEntity.zimId,
zimFilePath = bookmarkEntity.zimReaderSource?.toDatabase(),
zimReaderSource = bookmarkEntity.zimReaderSource,
zimName = bookmarkEntity.zimName,
bookmarkUrl = bookmarkEntity.bookmarkUrl,
title = bookmarkEntity.bookmarkTitle,
favicon = bookmarkEntity.favicon,
libKiwixBook = libkiwixBook
),
shouldWriteBookmarkToFile = index == bookMarksList.size - 1
)
archive?.dispose()

38
core/src/main/java/org/kiwix/kiwixmobile/core/data/remote/ObjectBoxToRoomMigrator.kt → objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/data/ObjectBoxToRoomMigrator.kt
View File

@ -16,15 +16,14 @@
*
*/
package org.kiwix.kiwixmobile.core.data.remote
package org.kiwix.kiwixmobile.objectboxmigration.data
import io.objectbox.Box
import io.objectbox.BoxStore
import io.objectbox.kotlin.boxFor
import org.kiwix.kiwixmobile.core.CoreApp
import org.kiwix.kiwixmobile.core.dao.entities.HistoryEntity
import org.kiwix.kiwixmobile.core.dao.entities.NotesEntity
import org.kiwix.kiwixmobile.core.dao.entities.RecentSearchEntity
import org.kiwix.kiwixmobile.objectboxmigration.entities.HistoryEntity
import org.kiwix.kiwixmobile.objectboxmigration.entities.NotesEntity
import org.kiwix.kiwixmobile.objectboxmigration.entities.RecentSearchEntity
import org.kiwix.kiwixmobile.core.data.KiwixRoomDatabase
import org.kiwix.kiwixmobile.core.page.history.adapter.HistoryListItem
import org.kiwix.kiwixmobile.core.page.notes.adapter.NoteListItem
@ -39,7 +38,7 @@ class ObjectBoxToRoomMigrator {
@Inject lateinit var sharedPreferenceUtil: SharedPreferenceUtil
suspend fun migrateObjectBoxDataToRoom() {
CoreApp.coreComponent.inject(this)
// CoreApp.coreComponent.inject(this)
if (!sharedPreferenceUtil.prefIsRecentSearchMigrated) {
migrateRecentSearch(boxStore.boxFor())
}
@ -71,7 +70,20 @@ class ObjectBoxToRoomMigrator {
val historyEntityList = box.all
historyEntityList.forEachIndexed { _, historyEntity ->
kiwixRoomDatabase.historyRoomDao()
.saveHistory(HistoryListItem.HistoryItem(historyEntity))
.saveHistory(
HistoryListItem.HistoryItem(
historyEntity.id,
historyEntity.zimId,
historyEntity.zimName,
historyEntity.zimReaderSource,
historyEntity.favicon,
historyEntity.historyUrl,
historyEntity.historyTitle,
historyEntity.dateString,
historyEntity.timeStamp,
false
)
)
// removing the single entity from the object box after migration.
box.remove(historyEntity.id)
}
@ -81,7 +93,17 @@ class ObjectBoxToRoomMigrator {
suspend fun migrateNotes(box: Box<NotesEntity>) {
val notesEntityList = box.all
notesEntityList.forEachIndexed { _, notesEntity ->
kiwixRoomDatabase.notesRoomDao().saveNote(NoteListItem(notesEntity))
kiwixRoomDatabase.notesRoomDao().saveNote(
NoteListItem(
notesEntity.id,
notesEntity.zimId,
notesEntity.noteTitle,
notesEntity.zimReaderSource,
notesEntity.zimUrl,
notesEntity.noteFilePath,
notesEntity.favicon
)
)
// removing the single entity from the object box after migration.
box.remove(notesEntity.id)
}

41
objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/di/MigrationComponent.kt Normal file
View File

@ -0,0 +1,41 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.objectboxmigration.di
import dagger.Component
import org.kiwix.kiwixmobile.core.di.components.CoreComponent
import org.kiwix.kiwixmobile.objectboxmigration.data.ObjectBoxToLibkiwixMigrator
import org.kiwix.kiwixmobile.objectboxmigration.data.ObjectBoxToRoomMigrator
import org.kiwix.kiwixmobile.objectboxmigration.di.module.DatabaseModule
import org.kiwix.kiwixmobile.objectboxmigration.di.module.ObjectBoxMigrationModule
@MigrationScope
@Component(
dependencies = [CoreComponent::class],
modules = [ObjectBoxMigrationModule::class, DatabaseModule::class]
)
interface MigrationComponent {
fun objectBoxToRoomMigrator(): ObjectBoxToRoomMigrator
fun objectBoxToLibkiwixMigrator(): ObjectBoxToLibkiwixMigrator
@Component.Factory
interface Factory {
fun create(coreComponent: CoreComponent): MigrationComponent
}
}

25
objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/di/MigrationScope.kt Normal file
View File

@ -0,0 +1,25 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.objectboxmigration.di
import javax.inject.Scope
@Scope
@Retention(AnnotationRetention.RUNTIME)
annotation class MigrationScope

42
objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/di/module/DatabaseModule.kt Normal file
View File

@ -0,0 +1,42 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.objectboxmigration.di.module
import android.content.Context
import dagger.Module
import dagger.Provides
import io.objectbox.BoxStore
import org.kiwix.kiwixmobile.objectboxmigration.entities.MyObjectBox
import javax.inject.Singleton
@Module
class DatabaseModule {
companion object {
var boxStore: BoxStore? = null
}
@Suppress("UnsafeCallOnNullableType")
// NOT RECOMMENDED TODO use custom runner to load TestApplication
@Provides @Singleton fun providesBoxStore(context: Context): BoxStore {
if (boxStore == null) {
boxStore = MyObjectBox.builder().androidContext(context).build()
}
return boxStore!!
}
}

46
objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/di/module/ObjectBoxMigrationModule.kt Normal file
View File

@ -0,0 +1,46 @@
/*
* Kiwix Android
* Copyright (c) 2025 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.objectboxmigration.di.module
import dagger.Module
import dagger.Provides
import org.kiwix.kiwixmobile.core.data.ObjectBoxDataMigrationHandler
import org.kiwix.kiwixmobile.objectboxmigration.ObjectBoxMigrationHandler
import org.kiwix.kiwixmobile.objectboxmigration.data.ObjectBoxToLibkiwixMigrator
import org.kiwix.kiwixmobile.objectboxmigration.data.ObjectBoxToRoomMigrator
import org.kiwix.kiwixmobile.objectboxmigration.di.MigrationScope
@Module
class ObjectBoxMigrationModule {
@Provides
@MigrationScope
fun provideObjectBoxToLibkiwixMigrator() = ObjectBoxToLibkiwixMigrator()
@Provides
@MigrationScope
fun provideObjectBoxToRoomMigrator() = ObjectBoxToRoomMigrator()
@Provides
@MigrationScope
fun provideMigrationHandler(
objectBoxToRoomMigrator: ObjectBoxToRoomMigrator,
objectBoxToLibkiwixMigrator: ObjectBoxToLibkiwixMigrator
): ObjectBoxDataMigrationHandler =
ObjectBoxMigrationHandler(objectBoxToRoomMigrator, objectBoxToLibkiwixMigrator)
}

2
core/src/main/java/org/kiwix/kiwixmobile/core/dao/entities/BookOnDiskEntity.kt → objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/entities/BookOnDiskEntity.kt
View File

@ -16,7 +16,7 @@
*
*/
package org.kiwix.kiwixmobile.core.dao.entities
package org.kiwix.kiwixmobile.objectboxmigration.entities
import io.objectbox.annotation.Convert
import io.objectbox.annotation.Entity

2
core/src/main/java/org/kiwix/kiwixmobile/core/dao/entities/BookmarkEntity.kt → objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/entities/BookmarkEntity.kt
View File

@ -15,7 +15,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package org.kiwix.kiwixmobile.core.dao.entities
package org.kiwix.kiwixmobile.objectboxmigration.entities
import io.objectbox.annotation.Convert
import io.objectbox.annotation.Entity

9
core/src/main/java/org/kiwix/kiwixmobile/core/dao/entities/HistoryEntity.kt → objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/entities/HistoryEntity.kt
View File

@ -1,6 +1,6 @@
/*
* Kiwix Android
* Copyright (c) 2019 Kiwix <android.kiwix.org>
* Copyright (c) 2025 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
@ -15,12 +15,13 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package org.kiwix.kiwixmobile.core.dao.entities
package org.kiwix.kiwixmobile.objectboxmigration.entities
import io.objectbox.annotation.Convert
import io.objectbox.annotation.Entity
import io.objectbox.annotation.Id
import org.kiwix.kiwixmobile.core.page.history.adapter.HistoryListItem.HistoryItem
import org.kiwix.kiwixmobile.core.page.history.adapter.HistoryListItem
import org.kiwix.kiwixmobile.core.reader.ZimReaderSource
@Entity
@ -38,7 +39,7 @@ data class HistoryEntity(
val dateString: String,
val timeStamp: Long
) {
constructor(historyItem: HistoryItem) : this(
constructor(historyItem: HistoryListItem.HistoryItem) : this(
historyItem.databaseId,
historyItem.zimId,
historyItem.zimName,

2
core/src/main/java/org/kiwix/kiwixmobile/core/dao/entities/NotesEntity.kt → objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/entities/NotesEntity.kt
View File

@ -16,7 +16,7 @@
*
*/
package org.kiwix.kiwixmobile.core.dao.entities
package org.kiwix.kiwixmobile.objectboxmigration.entities
import io.objectbox.annotation.Convert
import io.objectbox.annotation.Entity

2
core/src/main/java/org/kiwix/kiwixmobile/core/dao/entities/RecentSearchEntity.kt → objectboxmigration/src/main/java/org/kiwix/kiwixmobile/objectboxmigration/entities/RecentSearchEntity.kt
View File

@ -15,7 +15,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
package org.kiwix.kiwixmobile.core.dao.entities
package org.kiwix.kiwixmobile.objectboxmigration.entities
import io.objectbox.annotation.Entity
import io.objectbox.annotation.Id

5
settings.gradle.kts
View File

@ -2,6 +2,9 @@ include(
":core",
":app",
":custom",
":install_time_asset"
":install_time_asset",
":objectboxmigration",
":defaultMigration"
)
rootProject.name = "kiwix-android"
include(":objectboxmigration2")