Merge pull request #1699 from Infomaniak/folder_message_search

Display Folder name when we search/read a Thread

Author: LunarX

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

@@ -162,7 +162,7 @@ object RealmDatabase {
         //region Configurations versions
         const val USER_INFO_SCHEMA_VERSION = 1L
         const val MAILBOX_INFO_SCHEMA_VERSION = 4L
-        const val MAILBOX_CONTENT_SCHEMA_VERSION = 9L
+        const val MAILBOX_CONTENT_SCHEMA_VERSION = 10L
         //endregion
 
         //region Configurations names

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

@@ -17,6 +17,7 @@
  */
 package com.infomaniak.mail.data.cache.mailboxContent
 
+import android.content.Context
 import com.infomaniak.mail.data.api.ApiRepository
 import com.infomaniak.mail.data.cache.RealmDatabase
 import com.infomaniak.mail.data.models.Folder
@@ -44,6 +45,7 @@ import okhttp3.OkHttpClient
 import javax.inject.Inject
 
 class ThreadController @Inject constructor(
+    private val context: Context,
     private val mailboxContentRealm: RealmDatabase.MailboxContent,
     @IoDispatcher private val ioDispatcher: CoroutineDispatcher,
 ) {
@@ -110,12 +112,18 @@ class ThreadController @Inject constructor(
 
         return@withContext mailboxContentRealm().writeBlocking {
             val searchFolder = FolderController.getOrCreateSearchFolder(realm = this)
+            val cachedFolderIds = mutableMapOf<String, String>()
+
             remoteThreads.map { remoteThread ->
                 ensureActive()
+
                 remoteThread.isFromSearch = true
 
+                // If we only have 1 Message, we want to display its Folder name.
                 val folderId = if (remoteThread.messages.count() == 1) {
-                    remoteThread.messages.single().folderId
+                    val firstMessageFolderId = remoteThread.messages.single().folderId
+                    setFolderName(firstMessageFolderId, remoteThread, cachedFolderIds)
+                    firstMessageFolderId
                 } else {
                     filterFolder!!.id
                 }
@@ -127,6 +135,19 @@ class ThreadController @Inject constructor(
             }.also(searchFolder.threads::addAll)
         }
     }
+
+    private fun MutableRealm.setFolderName(
+        firstMessageFolderId: String,
+        remoteThread: Thread,
+        cachedFolderIds: MutableMap<String, String>,
+    ) {
+        val folderName = cachedFolderIds[firstMessageFolderId]
+            ?: FolderController.getFolder(firstMessageFolderId, this)
+                ?.getLocalizedName(context)
+                ?.also { cachedFolderIds[firstMessageFolderId] = it }
+
+        folderName?.let { remoteThread.folderName = it }
+    }
     //endregion
 
     //region Edit data

app/src/main/java/com/infomaniak/mail/data/models/thread/Thread.kt

@@ -84,6 +84,8 @@ class Thread : RealmObject {
     @Transient
     var folderId: String = ""
     @Transient
+    var folderName: String = ""
+    @Transient
     var duplicates: RealmList<Message> = realmListOf()
     @Transient
     var messagesIds: RealmSet<String> = realmSetOf()

app/src/main/java/com/infomaniak/mail/ui/main/folder/ThreadListAdapter.kt

@@ -21,6 +21,8 @@ import android.content.Context
 import android.content.res.ColorStateList
 import android.graphics.Canvas
 import android.os.Build
+import android.text.Spannable
+import android.text.TextUtils.TruncateAt
 import android.view.HapticFeedbackConstants
 import android.view.LayoutInflater
 import android.view.View
@@ -46,13 +48,13 @@ import com.infomaniak.mail.R
 import com.infomaniak.mail.data.LocalSettings
 import com.infomaniak.mail.data.LocalSettings.SwipeAction
 import com.infomaniak.mail.data.LocalSettings.ThreadDensity
-import com.infomaniak.mail.data.LocalSettings.ThreadDensity.COMPACT
-import com.infomaniak.mail.data.LocalSettings.ThreadDensity.LARGE
 import com.infomaniak.mail.data.models.Folder.FolderRole
 import com.infomaniak.mail.data.models.correspondent.Recipient
 import com.infomaniak.mail.data.models.thread.Thread
 import com.infomaniak.mail.databinding.*
 import com.infomaniak.mail.ui.main.folder.ThreadListAdapter.ThreadListViewHolder
+import com.infomaniak.mail.ui.main.thread.SubjectFormatter
+import com.infomaniak.mail.ui.main.thread.SubjectFormatter.TagColor
 import com.infomaniak.mail.utils.RealmChangesBinding
 import com.infomaniak.mail.utils.Utils.runCatchingRealm
 import com.infomaniak.mail.utils.extensions.*
@@ -94,6 +96,7 @@ class ThreadListAdapter @Inject constructor(
     private var folderRole: FolderRole? = null
     private var onSwipeFinished: (() -> Unit)? = null
     private var multiSelection: MultiSelectionListener<Thread>? = null
+    private var isFolderNameVisible: Boolean = false
 
     //region Tablet mode
     private var openedThreadPosition: Int? = null
@@ -108,10 +111,12 @@ class ThreadListAdapter @Inject constructor(
         folderRole: FolderRole?,
         onSwipeFinished: (() -> Unit)? = null,
         multiSelection: MultiSelectionListener<Thread>? = null,
+        isFolderNameVisible: Boolean = false,
     ) {
         this.folderRole = folderRole
         this.onSwipeFinished = onSwipeFinished
         this.multiSelection = multiSelection
+        this.isFolderNameVisible = isFolderNameVisible
     }
 
     override fun onAttachedToRecyclerView(recyclerView: RecyclerView) {
@@ -188,6 +193,8 @@ class ThreadListAdapter @Inject constructor(
         setupThreadDensityDependentUi()
         displayAvatar(thread)
 
+        displayFolderName(thread)
+
         with(thread) {
             expeditor.text = formatRecipientNames(computeDisplayedRecipients())
             mailSubject.text = context.formatSubject(subject)
@@ -226,6 +233,37 @@ class ThreadListAdapter @Inject constructor(
         updateSelectedUi(thread)
     }
 
+    private fun CardviewThreadItemBinding.displayFolderName(thread: Thread) {
+        val isCompactMode = localSettings.threadDensity == ThreadDensity.COMPACT
+
+        fun setFolderNameVisibility(isVisible: Boolean) {
+            folderNameExpandMode.isVisible = !isCompactMode && isVisible
+            folderNameCompactMode.isVisible = isCompactMode && isVisible
+        }
+
+        val folderNameView = if (isCompactMode) folderNameCompactMode else folderNameExpandMode
+
+        if (shouldDisplayFolderName(thread.folderName)) {
+            folderNameView.text = computeFolderName(thread)
+            setFolderNameVisibility(isVisible = true)
+        } else {
+            setFolderNameVisibility(isVisible = false)
+        }
+    }
+
+    private fun shouldDisplayFolderName(folderName: String) = isFolderNameVisible && folderName.isNotEmpty()
+
+    private fun CardviewThreadItemBinding.computeFolderName(thread: Thread): Spannable {
+        return context.postfixWithTag(
+            tag = thread.folderName,
+            tagColor = TagColor(R.color.folderTagBackground, R.color.folderTagTextColor),
+            ellipsizeConfiguration = SubjectFormatter.EllipsizeConfiguration(
+                maxWidth = context.resources.getDimension(R.dimen.folderNameTagMaxSize),
+                truncateAt = TruncateAt.END,
+            ),
+        )
+    }
+
     private fun CardviewThreadItemBinding.onThreadClickWithAbilityToOpenMultiSelection(
         thread: Thread,
         listener: MultiSelectionListener<Thread>,
@@ -302,27 +340,27 @@ class ThreadListAdapter @Inject constructor(
 
         multiSelection?.let {
             with(localSettings) {
-                expeditorAvatar.isVisible = !isMultiSelected && threadDensity == LARGE
+                expeditorAvatar.isVisible = !isMultiSelected && threadDensity == ThreadDensity.LARGE
                 checkMarkLayout.isVisible = it.isEnabled
                 checkedState.isVisible = isMultiSelected
-                uncheckedState.isVisible = !isMultiSelected && threadDensity != LARGE
+                uncheckedState.isVisible = !isMultiSelected && threadDensity != ThreadDensity.LARGE
             }
         }
     }
 
     private fun CardviewThreadItemBinding.setupThreadDensityDependentUi() = with(localSettings) {
-        val margin = if (threadDensity == COMPACT) threadMarginCompact else threadMarginOther
+        val margin = if (threadDensity == ThreadDensity.COMPACT) threadMarginCompact else threadMarginOther
         threadCard.setMarginsRelative(top = margin, bottom = margin)
 
-        expeditorAvatar.isVisible = threadDensity == LARGE
-        mailBodyPreview.isGone = threadDensity == COMPACT
+        expeditorAvatar.isVisible = threadDensity == ThreadDensity.LARGE
+        mailBodyPreview.isGone = threadDensity == ThreadDensity.COMPACT
 
         checkMarkBackground.reshapeToDensity()
         uncheckedState.reshapeToDensity()
     }
 
     private fun ImageView.reshapeToDensity() {
-        val checkMarkSize = if (localSettings.threadDensity == LARGE) checkMarkSizeLarge else checkMarkSizeOther
+        val checkMarkSize = if (localSettings.threadDensity == ThreadDensity.LARGE) checkMarkSizeLarge else checkMarkSizeOther
         layoutParams.apply {
             width = checkMarkSize
             height = checkMarkSize
@@ -542,7 +580,7 @@ class ThreadListAdapter @Inject constructor(
             add(folderRole)
         }
 
-        if (threadDensity == COMPACT) {
+        if (threadDensity == ThreadDensity.COMPACT) {
             if (multiSelection?.selectedItems?.let(threads::containsAll) == false) {
                 multiSelection?.selectedItems?.removeAll { !threads.contains(it) }
             }

app/src/main/java/com/infomaniak/mail/ui/main/search/SearchFragment.kt

@@ -143,7 +143,7 @@ class SearchFragment : TwoPaneFragment() {
     }
 
     private fun setupAdapter() {
-        threadListAdapter(folderRole = null)
+        threadListAdapter(folderRole = null, isFolderNameVisible = true)
     }
 
     private fun setupListeners() = with(binding) {

app/src/main/java/com/infomaniak/mail/ui/main/thread/RoundedBackgroundSpan.kt

@@ -1,6 +1,6 @@
 /*
  * Infomaniak Mail - Android
- * Copyright (C) 2023 Infomaniak Network SA
+ * Copyright (C) 2023-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
@@ -26,17 +26,16 @@ import android.text.style.LineHeightSpan
 import android.text.style.ReplacementSpan
 
 /**
- * A span to create a rounded background on a text.
- *
- * If radius is set, it generates a rounded background.
- * If radius is null, it generates a circle background.
+ * A span to create a rounded background with the specified radius on a text.
  */
 class RoundedBackgroundSpan(
     private val backgroundColor: Int,
     private val textColor: Int,
     private val textTypeface: Typeface,
     private val fontSize: Float,
+    private val cornerRadius: Float,
 ) : ReplacementSpan(), LineHeightSpan {
+
     override fun getSize(paint: Paint, text: CharSequence?, start: Int, end: Int, fm: FontMetricsInt?): Int {
         paint.setGivenTextStyle()
         return (LEFT_MARGIN + PADDING + paint.measureText(text, start, end) + PADDING).toInt()
@@ -64,7 +63,7 @@ class RoundedBackgroundSpan(
         )
 
         paint.color = backgroundColor
-        canvas.drawRoundRect(rect, CORNER_RADIUS, CORNER_RADIUS, paint)
+        canvas.drawRoundRect(rect, cornerRadius, cornerRadius, paint)
 
         paint.setGivenTextStyle()
         canvas.drawText(
@@ -96,6 +95,7 @@ class RoundedBackgroundSpan(
         private const val LEFT_MARGIN = 4
         private const val PADDING = 16
         private const val VERTICAL_OFFSET = 4
-        private const val CORNER_RADIUS = 6.0f
+
+        fun getTotalHorizontalSpace(): Int = PADDING * 2 + LEFT_MARGIN
     }
 }