Merge pull request #1484 from Infomaniak/move-signatures-to-MailboxInfos-realm

Move `Signature` from MailboxContent to MailboxInfo

Author: KevinBoulongne

app/src/main/java/com/infomaniak/mail/data/cache/RealmDatabase.kt

@@ -63,7 +63,6 @@ object RealmDatabase {
     //region Realms' mutexes
     private val appSettingsMutex = Mutex()
     private val userInfoMutex = Mutex()
-    private val mailboxInfoMutex = Mutex()
     private val mailboxContentMutex = Mutex()
     //endregion
 
@@ -161,7 +160,7 @@ object RealmDatabase {
 
         //region Configurations versions
         const val USER_INFO_SCHEMA_VERSION = 1L
-        const val MAILBOX_INFO_SCHEMA_VERSION = 5L
+        const val MAILBOX_INFO_SCHEMA_VERSION = 6L
         const val MAILBOX_CONTENT_SCHEMA_VERSION = 16L
         //endregion
 
@@ -185,6 +184,7 @@ object RealmDatabase {
             Mailbox::class,
             MailboxPermissions::class,
             Quotas::class,
+            Signature::class,
         )
         val mailboxContentSet = setOf(
             Folder::class,
@@ -200,7 +200,6 @@ object RealmDatabase {
             SwissTransferContainer::class,
             SwissTransferFile::class,
             Attendee::class,
-            Signature::class,
             Bimi::class,
         )
         //endregion

app/src/main/java/com/infomaniak/mail/data/cache/RealmMigrations.kt

@@ -36,6 +36,7 @@ val MAILBOX_CONTENT_MIGRATION = AutomaticSchemaMigration { migrationContext ->
     migrationContext.deleteRealmFromFirstMigration()
 }
 
+// Migrate to version #1
 private fun MigrationContext.deleteRealmFromFirstMigration() {
-    if (oldRealm.schemaVersion() == 0L) newRealm.deleteAll()
+    if (oldRealm.schemaVersion() < 1L) newRealm.deleteAll()
 }

app/src/main/java/com/infomaniak/mail/data/cache/mailboxContent/SignatureController.kt

@@ -28,7 +28,9 @@ class QuotasController @Inject constructor(
     private val mailboxController: MailboxController,
 ) {
 
+    //region Get data
     fun getQuotasAsync(mailboxObjectId: String): Flow<Quotas?> {
         return mailboxController.getMailboxAsync(mailboxObjectId).map { it.obj?.quotas }
     }
+    //endregion
 }

app/src/main/java/com/infomaniak/mail/data/cache/mailboxInfo/QuotasController.kt

@@ -0,0 +1,37 @@
+/*
+ * Infomaniak Mail - Android
+ * Copyright (C) 2022-2024 Infomaniak Network SA
+ *
+ * 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 com.infomaniak.mail.data.cache.mailboxInfo
+
+import com.infomaniak.mail.data.models.signature.Signature
+import io.realm.kotlin.types.RealmList
+import kotlinx.coroutines.flow.Flow
+import kotlinx.coroutines.flow.mapNotNull
+import javax.inject.Inject
+import javax.inject.Singleton
+
+@Singleton
+class SignatureController @Inject constructor(
+    private val mailboxController: MailboxController,
+) {
+
+    //region Get data
+    fun getSignaturesAsync(mailboxObjectId: String): Flow<RealmList<Signature>> {
+        return mailboxController.getMailboxAsync(mailboxObjectId).mapNotNull { it.obj?.signatures }
+    }
+    //endregion
+}

app/src/main/java/com/infomaniak/mail/data/cache/mailboxInfo/SignatureController.kt

@@ -23,13 +23,14 @@ import androidx.core.app.NotificationManagerCompat
 import com.infomaniak.mail.data.models.AppSettings
 import com.infomaniak.mail.data.models.FeatureFlag
 import com.infomaniak.mail.data.models.Quotas
+import com.infomaniak.mail.data.models.draft.Draft.DraftMode
+import com.infomaniak.mail.data.models.signature.Signature
 import com.infomaniak.mail.utils.UnreadDisplay
+import com.infomaniak.mail.utils.extensions.getDefault
 import io.realm.kotlin.ext.realmListOf
 import io.realm.kotlin.ext.realmSetOf
 import io.realm.kotlin.serializers.RealmListKSerializer
-import io.realm.kotlin.types.RealmList
 import io.realm.kotlin.types.RealmObject
-import io.realm.kotlin.types.RealmSet
 import io.realm.kotlin.types.annotations.Ignore
 import io.realm.kotlin.types.annotations.PrimaryKey
 import kotlinx.serialization.SerialName
@@ -61,7 +62,7 @@ class Mailbox : RealmObject {
     var isLocked: Boolean = false
     @SerialName("unseen_messages")
     var unreadCountRemote: Int = 0
-    var aliases: RealmList<String> = realmListOf()
+    var aliases = realmListOf<String>()
     //endregion
 
     //region Local data (Transient)
@@ -77,11 +78,13 @@ class Mailbox : RealmObject {
     @Transient
     var permissions: MailboxPermissions? = null
     @Transient
-    private var _featureFlags: RealmSet<String> = realmSetOf()
+    var signatures = realmListOf<Signature>()
+    @Transient
+    private var _featureFlags = realmSetOf<String>()
     @Transient
     var externalMailFlagEnabled: Boolean = false
     @Transient
-    var trustedDomains: RealmList<String> = realmListOf()
+    var trustedDomains = realmListOf<String>()
     //endregion
 
     //region UI data (Transient & Ignore)
@@ -113,6 +116,10 @@ class Mailbox : RealmObject {
         this.permissions = permissions
     }
 
+    fun getDefaultSignatureWithFallback(draftMode: DraftMode? = null): Signature {
+        return signatures.getDefault(draftMode) ?: signatures.first()
+    }
+
     fun notificationsIsDisabled(notificationManagerCompat: NotificationManagerCompat): Boolean = with(notificationManagerCompat) {
         val isGroupBlocked = getNotificationChannelGroupCompat(channelGroupId)?.isBlocked == true
         val isChannelBlocked = getNotificationChannelCompat(channelId)?.importance == NotificationManagerCompat.IMPORTANCE_NONE

app/src/main/java/com/infomaniak/mail/data/models/mailbox/Mailbox.kt

@@ -21,18 +21,16 @@ import android.content.Context
 import com.infomaniak.mail.R
 import com.infomaniak.mail.data.models.draft.Draft
 import com.infomaniak.mail.utils.AccountUtils
-import io.realm.kotlin.types.RealmObject
+import io.realm.kotlin.types.EmbeddedRealmObject
 import io.realm.kotlin.types.annotations.Ignore
-import io.realm.kotlin.types.annotations.PrimaryKey
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.Transient
 
 @Serializable
-class Signature : RealmObject {
+class Signature : EmbeddedRealmObject {
 
     //region Remote data
-    @PrimaryKey
     var id: Int = 0
     var name: String = ""
     @SerialName("full_name")

app/src/main/java/com/infomaniak/mail/data/models/signature/Signature.kt

@@ -49,6 +49,7 @@ import com.infomaniak.mail.data.models.message.Message
 import com.infomaniak.mail.data.models.thread.Thread
 import com.infomaniak.mail.data.models.thread.Thread.ThreadFilter
 import com.infomaniak.mail.di.IoDispatcher
+import com.infomaniak.mail.di.MailboxInfoRealm
 import com.infomaniak.mail.ui.main.SnackbarManager
 import com.infomaniak.mail.ui.main.SnackbarManager.UndoData
 import com.infomaniak.mail.utils.AccountUtils
@@ -64,6 +65,7 @@ import com.infomaniak.mail.utils.coroutineContext
 import com.infomaniak.mail.utils.extensions.*
 import com.infomaniak.mail.views.itemViews.AvatarMergedContactData
 import dagger.hilt.android.lifecycle.HiltViewModel
+import io.realm.kotlin.Realm
 import io.realm.kotlin.ext.copyFromRealm
 import io.realm.kotlin.ext.toRealmList
 import io.realm.kotlin.notifications.ResultsChange
@@ -93,6 +95,7 @@ class MainViewModel @Inject constructor(
     private val sharedUtils: SharedUtils,
     private val threadController: ThreadController,
     private val snackbarManager: SnackbarManager,
+    @MailboxInfoRealm private val mailboxInfoRealm: Realm,
     @IoDispatcher private val ioDispatcher: CoroutineDispatcher,
 ) : AndroidViewModel(application) {
 
@@ -350,7 +353,7 @@ class MainViewModel @Inject constructor(
 
     private fun updateSignatures(mailbox: Mailbox) = viewModelScope.launch(ioCoroutineContext) {
         SentryLog.d(TAG, "Force refresh Signatures")
-        updateSignatures(mailbox, mailboxContentRealm())
+        updateSignatures(mailbox, mailboxInfoRealm)
     }
 
     private fun updateFeatureFlag(mailbox: Mailbox) = viewModelScope.launch(ioCoroutineContext) {

app/src/main/java/com/infomaniak/mail/ui/MainViewModel.kt

@@ -23,14 +23,14 @@ import androidx.lifecycle.asLiveData
 import androidx.lifecycle.viewModelScope
 import com.infomaniak.lib.core.utils.SingleLiveEvent
 import com.infomaniak.mail.data.api.ApiRepository
-import com.infomaniak.mail.data.cache.RealmDatabase
-import com.infomaniak.mail.data.cache.mailboxContent.SignatureController
 import com.infomaniak.mail.data.cache.mailboxInfo.MailboxController
+import com.infomaniak.mail.data.cache.mailboxInfo.SignatureController
 import com.infomaniak.mail.data.models.signature.Signature
 import com.infomaniak.mail.di.IoDispatcher
-import com.infomaniak.mail.utils.AccountUtils
+import com.infomaniak.mail.di.MailboxInfoRealm
 import com.infomaniak.mail.utils.SharedUtils.Companion.updateSignatures
 import dagger.hilt.android.lifecycle.HiltViewModel
+import io.realm.kotlin.Realm
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.launch
 import javax.inject.Inject
@@ -39,17 +39,18 @@ import com.infomaniak.lib.core.R as RCore
 @HiltViewModel
 class SignatureSettingViewModel @Inject constructor(
     mailboxController: MailboxController,
+    signatureController: SignatureController,
     private val savedStateHandle: SavedStateHandle,
+    @MailboxInfoRealm private val mailboxInfoRealm: Realm,
     @IoDispatcher private val ioDispatcher: CoroutineDispatcher,
 ) : ViewModel() {
 
     private val coroutineContext = viewModelScope.coroutineContext + ioDispatcher
 
     private val mailboxObjectId inline get() = savedStateHandle.get<String>(SignatureSettingFragmentArgs::mailboxObjectId.name)!!
     val mailbox = mailboxController.getMailbox(mailboxObjectId)!!
-    private val customRealm = RealmDatabase.newMailboxContentInstance(AccountUtils.currentUserId, mailbox.mailboxId)
 
-    val signaturesLive = SignatureController.getSignaturesAsync(customRealm).asLiveData(coroutineContext)
+    val signaturesLive = signatureController.getSignaturesAsync(mailboxObjectId).asLiveData(coroutineContext)
     val showError = SingleLiveEvent<Int>() // StringRes
 
     fun setDefaultSignature(signature: Signature?) = viewModelScope.launch(ioDispatcher) {
@@ -63,14 +64,9 @@ class SignatureSettingViewModel @Inject constructor(
     }
 
     fun updateSignatures() = viewModelScope.launch(ioDispatcher) {
-        updateSignatures(mailbox, customRealm)?.also { translatedError ->
+        updateSignatures(mailbox, mailboxInfoRealm)?.also { translatedError ->
             val title = if (translatedError == 0) RCore.string.anErrorHasOccurred else translatedError
             showError.postValue(title)
         }
     }
-
-    override fun onCleared() {
-        customRealm.close()
-        super.onCleared()
-    }
 }

app/src/main/java/com/infomaniak/mail/ui/main/settings/mailbox/SignatureSettingViewModel.kt

@@ -38,7 +38,6 @@ import com.infomaniak.mail.data.cache.RealmDatabase
 import com.infomaniak.mail.data.cache.mailboxContent.DraftController
 import com.infomaniak.mail.data.cache.mailboxContent.MessageController
 import com.infomaniak.mail.data.cache.mailboxContent.ReplyForwardFooterManager
-import com.infomaniak.mail.data.cache.mailboxContent.SignatureController
 import com.infomaniak.mail.data.cache.mailboxInfo.MailboxController
 import com.infomaniak.mail.data.cache.userInfo.MergedContactController
 import com.infomaniak.mail.data.models.Attachment
@@ -63,11 +62,8 @@ import com.infomaniak.mail.utils.*
 import com.infomaniak.mail.utils.ContactUtils.arrangeMergedContacts
 import com.infomaniak.mail.utils.JsoupParserUtil.jsoupParseWithLog
 import com.infomaniak.mail.utils.Utils
+import com.infomaniak.mail.utils.extensions.*
 import com.infomaniak.mail.utils.extensions.AttachmentExtensions.findSpecificAttachment
-import com.infomaniak.mail.utils.extensions.appContext
-import com.infomaniak.mail.utils.extensions.htmlToText
-import com.infomaniak.mail.utils.extensions.isEmail
-import com.infomaniak.mail.utils.extensions.valueOrEmpty
 import dagger.hilt.android.lifecycle.HiltViewModel
 import io.realm.kotlin.MutableRealm
 import io.realm.kotlin.Realm
@@ -206,7 +202,7 @@ class NewMessageViewModel @Inject constructor(
 
         runCatching {
 
-            signatures = SignatureController.getAllSignatures(realm)
+            signatures = currentMailbox.signatures
                 .also { signaturesCount = it.count() }
                 .toMutableList()
                 .apply { add(index = 0, element = Signature.getDummySignature(appContext, email = currentMailbox.email)) }
@@ -216,7 +212,7 @@ class NewMessageViewModel @Inject constructor(
             draft = if (isNewMessage) {
                 getNewDraft(signatures, intent, realm) ?: return@runCatching
             } else {
-                getExistingDraft(draftLocalUuid, realm) ?: return@runCatching
+                getExistingDraft(draftLocalUuid) ?: return@runCatching
             }
         }.onFailure(Sentry::captureException)
 
@@ -238,11 +234,11 @@ class NewMessageViewModel @Inject constructor(
         emit(draft)
     }
 
-    private fun getExistingDraft(localUuid: String?, realm: Realm): Draft? {
+    private fun getExistingDraft(localUuid: String?): Draft? {
         return getLocalOrRemoteDraft(localUuid)?.also { draft ->
             saveNavArgsToSavedState(draft.localUuid)
             if (draft.identityId.isNullOrBlank()) {
-                draft.identityId = SignatureController.getDefaultSignatureWithFallback(realm, draftMode)?.id?.toString()
+                draft.identityId = currentMailbox.getDefaultSignatureWithFallback().id.toString()
             }
             splitSignatureAndQuoteFromBody(draft)
         }
@@ -274,7 +270,7 @@ class NewMessageViewModel @Inject constructor(
             }
         }
 
-        val defaultSignature = SignatureController.getDefaultSignature(realm, draftMode)
+        val defaultSignature = signatures.getDefault(draftMode)
         val shouldPreselectSignature = draftMode == DraftMode.REPLY || draftMode == DraftMode.REPLY_ALL
         val signature = if (shouldPreselectSignature) {
             defaultSignature ?: guessMostFittingSignature(previousMessage!!, signatures)