refactor: migrate K9.isMessageViewSpamActionVisible to PreferenceDataStore

Author: shamim-emon

core/preference/api/src/commonMain/kotlin/net/thunderbird/core/preference/display/visualSettings/DisplayVisualSettings.kt

@@ -12,6 +12,7 @@ const val DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_ARCHIVE_ACTION_VISIBLE = false
 const val DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_DELETE_ACTION_VISIBLE = true
 const val DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_MOVE_ACTION_VISIBLE = false
 const val DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_COPY_ACTION_VISIBLE = false
+const val DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_SPAM_ACTION_VISIBLE = false
 
 data class DisplayVisualSettings(
     val isShowAnimations: Boolean = DISPLAY_SETTINGS_DEFAULT_IS_SHOW_ANIMATION,
@@ -24,4 +25,5 @@ data class DisplayVisualSettings(
     val isMessageViewDeleteActionVisible: Boolean = DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_DELETE_ACTION_VISIBLE,
     val isMessageViewMoveActionVisible: Boolean = DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_MOVE_ACTION_VISIBLE,
     val isMessageViewCopyActionVisible: Boolean = DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_COPY_ACTION_VISIBLE,
+    val isMessageViewSpamActionVisible: Boolean = DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_SPAM_ACTION_VISIBLE,
 )

core/preference/api/src/commonMain/kotlin/net/thunderbird/core/preference/display/visualSettings/DisplayVisualSettingsPreferenceManager.kt

@@ -11,5 +11,6 @@ const val KEY_MESSAGE_VIEW_ARCHIVE_ACTION_VISIBLE = "messageViewArchiveActionVis
 const val KEY_MESSAGE_VIEW_DELETE_ACTION_VISIBLE = "messageViewDeleteActionVisible"
 const val KEY_MESSAGE_VIEW_MOVE_ACTION_VISIBLE = "messageViewMoveActionVisible"
 const val KEY_MESSAGE_VIEW_COPY_ACTION_VISIBLE = "messageViewCopyActionVisible"
+const val KEY_MESSAGE_VIEW_SPAM_ACTION_VISIBLE = "messageViewSpamActionVisible"
 
 interface DisplayVisualSettingsPreferenceManager : PreferenceManager<DisplayVisualSettings>

core/preference/impl/src/commonMain/kotlin/net/thunderbird/core/preference/display/visualSettings/DefaultDisplayVisualSettingsPreferenceManager.kt

@@ -93,6 +93,10 @@ class DefaultDisplayVisualSettingsPreferenceManager(
             KEY_MESSAGE_VIEW_COPY_ACTION_VISIBLE,
             DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_COPY_ACTION_VISIBLE,
         ),
+        isMessageViewSpamActionVisible = storage.getBoolean(
+            KEY_MESSAGE_VIEW_SPAM_ACTION_VISIBLE,
+            DISPLAY_SETTINGS_DEFAULT_MESSAGE_VIEW_SPAM_ACTION_VISIBLE,
+        ),
     )
 
     private fun writeConfig(config: DisplayVisualSettings) {
@@ -124,6 +128,10 @@ class DefaultDisplayVisualSettingsPreferenceManager(
                     KEY_MESSAGE_VIEW_COPY_ACTION_VISIBLE,
                     config.isMessageViewCopyActionVisible,
                 )
+                storageEditor.putBoolean(
+                    KEY_MESSAGE_VIEW_SPAM_ACTION_VISIBLE,
+                    config.isMessageViewSpamActionVisible,
+                )
                 storageEditor.commit().also { commited ->
                     logger.verbose(TAG) { "writeConfig: storageEditor.commit() resulted in: $commited" }
                 }

legacy/core/src/main/java/com/fsck/k9/K9.kt

@@ -125,10 +125,6 @@ object K9 : KoinComponent {
     var sortType: SortType = AccountDefaultsProvider.DEFAULT_SORT_TYPE
     private val sortAscending = mutableMapOf<SortType, Boolean>()
 
-
-    @JvmStatic
-    var isMessageViewSpamActionVisible = false
-
     @JvmStatic
     var pgpInlineDialogCounter: Int = 0
 
@@ -196,7 +192,6 @@ object K9 : KoinComponent {
             .onDisabledOrUnavailable {
                 fontSizes.load(storage)
             }
-        isMessageViewSpamActionVisible = storage.getBoolean("messageViewSpamActionVisible", false)
 
         pgpInlineDialogCounter = storage.getInt("pgpInlineDialogCounter", 0)
         pgpSignOnlyDialogCounter = storage.getInt("pgpSignOnlyDialogCounter", 0)
@@ -217,7 +212,6 @@ object K9 : KoinComponent {
         editor.putEnum("sortTypeEnum", sortType)
         editor.putBoolean("sortAscending", sortAscending[sortType] ?: false)
         editor.putString("lockScreenNotificationVisibility", lockScreenNotificationVisibility.toString())
-        editor.putBoolean("messageViewSpamActionVisible", isMessageViewSpamActionVisible)
 
         editor.putInt("pgpInlineDialogCounter", pgpInlineDialogCounter)
         editor.putInt("pgpSignOnlyDialogCounter", pgpSignOnlyDialogCounter)

legacy/ui/legacy/src/main/java/com/fsck/k9/ui/messageview/MessageViewFragment.kt

@@ -36,7 +36,6 @@ import app.k9mail.core.android.common.activity.CreateDocumentResultContract
 import app.k9mail.core.ui.legacy.designsystem.atom.icon.Icons
 import app.k9mail.legacy.message.controller.MessageReference
 import com.eygraber.uri.toKmpUri
-import com.fsck.k9.K9
 import com.fsck.k9.activity.MessageCompose
 import com.fsck.k9.activity.MessageLoaderHelper
 import com.fsck.k9.activity.MessageLoaderHelper.MessageLoaderCallbacks
@@ -326,13 +325,22 @@ class MessageViewFragment :
         if (isMoveCapable) {
             val canMessageBeArchived = canMessageBeArchived()
             val canMessageBeMovedToSpam = canMessageBeMovedToSpam()
+            menu.findItem(R.id.move).isVisible =
+                generalSettingsManager.getConfig().display.visualSettings.isMessageViewMoveActionVisible
 
-            menu.findItem(R.id.move).isVisible = generalSettingsManager.getConfig().display
-                .visualSettings.isMessageViewMoveActionVisible
             menu.findItem(R.id.archive).isVisible =
                 canMessageBeArchived &&
-                generalSettingsManager.getConfig().display.visualSettings.isMessageViewArchiveActionVisible
-            menu.findItem(R.id.spam).isVisible = canMessageBeMovedToSpam && K9.isMessageViewSpamActionVisible
+                generalSettingsManager.getConfig()
+                    .display
+                    .visualSettings
+                    .isMessageViewArchiveActionVisible
+
+            menu.findItem(R.id.spam).isVisible =
+                canMessageBeMovedToSpam &&
+                generalSettingsManager.getConfig()
+                    .display
+                    .visualSettings
+                    .isMessageViewSpamActionVisible
 
             menu.findItem(R.id.refile_move).isVisible = true
             menu.findItem(R.id.refile_archive).isVisible = canMessageBeArchived
@@ -406,13 +414,15 @@ class MessageViewFragment :
                 printMessage()
                 return true
             }
+
             R.id.export_eml -> if (
                 featureFlagProvider.provide(MessageViewFeatureFlags.ActionExportEml).isEnabled()
             ) {
                 onExportEml()
             } else {
                 return true
             }
+
             R.id.set_format_plain -> onDisplayPlainText()
             R.id.set_format_html -> onDisplayHTML()
             else -> return false

legacy/ui/legacy/src/main/java/com/fsck/k9/ui/settings/general/GeneralSettingsDataStore.kt

@@ -250,7 +250,7 @@ class GeneralSettingsDataStore(
                     if (visualSettings.isMessageViewArchiveActionVisible) add("archive")
                     if (visualSettings.isMessageViewMoveActionVisible) add("move")
                     if (visualSettings.isMessageViewCopyActionVisible) add("copy")
-                    if (K9.isMessageViewSpamActionVisible) add("spam")
+                    if (visualSettings.isMessageViewSpamActionVisible) add("spam")
                 }
             }
 
@@ -287,11 +287,11 @@ class GeneralSettingsDataStore(
                                 isMessageViewDeleteActionVisible = "delete" in checkedValues,
                                 isMessageViewMoveActionVisible = "move" in checkedValues,
                                 isMessageViewCopyActionVisible = "copy" in checkedValues,
+                                isMessageViewSpamActionVisible = "spam" in checkedValues,
                             ),
                         ),
                     )
                 }
-                K9.isMessageViewSpamActionVisible = "spam" in checkedValues
             }
 
             else -> return