Show avatars on message notifications

legacy/common/src/main/java/com/fsck/k9/notification/K9NotificationResourceProvider.kt

@@ -1,8 +1,14 @@
 package com.fsck.k9.notification
 
 import android.content.Context
+import android.graphics.Bitmap
 import app.k9mail.core.ui.legacy.designsystem.atom.icon.Icons
+import com.fsck.k9.activity.misc.ContactPicture
+import com.fsck.k9.mail.Address
 import com.fsck.k9.ui.R
+import com.fsck.k9.view.RecipientSelectView
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.withContext
 
 class K9NotificationResourceProvider(private val context: Context) : NotificationResourceProvider {
     override val iconWarning: Int = Icons.Outlined.Warning
@@ -38,6 +44,10 @@ class K9NotificationResourceProvider(private val context: Context) : Notificatio
     override fun authenticationErrorBody(accountName: String): String =
         context.getString(R.string.notification_authentication_error_text, accountName)
 
+    override suspend fun avatar(address: Address): Bitmap? = withContext(Dispatchers.IO) {
+        ContactPicture.getContactPictureLoader().getContactPicture(RecipientSelectView.Recipient(address))
+    }
+
     override fun notifyErrorTitle(): String = context.getString(R.string.notification_notify_error_title)
 
     override fun notifyErrorText(): String = context.getString(R.string.notification_notify_error_text)

legacy/core/src/main/java/com/fsck/k9/notification/CoreNotificationKoinModule.kt

@@ -103,6 +103,7 @@ val coreNotificationModule = module {
             actionCreator = get(),
             resourceProvider = get(),
             lockScreenNotificationCreator = get(),
+            application = get(),
         )
     }
     factory {

legacy/core/src/main/java/com/fsck/k9/notification/NotificationContent.kt

@@ -1,10 +1,11 @@
 package com.fsck.k9.notification
 
 import app.k9mail.legacy.message.controller.MessageReference
+import com.fsck.k9.mail.Address
 
 internal data class NotificationContent(
     val messageReference: MessageReference,
-    val sender: String,
+    val sender: Address,
     val subject: String,
     val preview: CharSequence,
     val summary: CharSequence,

legacy/core/src/main/java/com/fsck/k9/notification/NotificationContentCreator.kt

@@ -4,6 +4,7 @@ import android.text.SpannableStringBuilder
 import app.k9mail.core.android.common.contact.ContactRepository
 import app.k9mail.legacy.message.extractors.PreviewResult.PreviewType
 import com.fsck.k9.helper.MessageHelper
+import com.fsck.k9.mail.Address
 import com.fsck.k9.mail.Message
 import com.fsck.k9.mailstore.LocalMessage
 import net.thunderbird.core.android.account.LegacyAccount
@@ -19,10 +20,10 @@ internal class NotificationContentCreator(
 
         return NotificationContent(
             messageReference = message.makeMessageReference(),
-            sender = getMessageSenderForDisplay(sender),
+            sender = sender,
             subject = getMessageSubject(message),
             preview = getMessagePreview(message),
-            summary = buildMessageSummary(sender, getMessageSubject(message)),
+            summary = buildMessageSummary(sender.personal, getMessageSubject(message)),
         )
     }
 
@@ -70,7 +71,7 @@ internal class NotificationContentCreator(
     }
 
     @Suppress("ReturnCount")
-    private fun getMessageSender(account: LegacyAccount, message: Message): String? {
+    private fun getMessageSender(account: LegacyAccount, message: Message): Address {
         val localContactRepository =
             if (generalSettingsManager.getConfig().display.isShowContactName) contactRepository else null
         var isSelf = false
@@ -79,33 +80,33 @@ internal class NotificationContentCreator(
         if (!fromAddresses.isNullOrEmpty()) {
             isSelf = account.isAnIdentity(fromAddresses)
             if (!isSelf) {
-                return MessageHelper.toFriendly(
-                    fromAddresses.first(),
+                val firstFrom = fromAddresses.first()
+                val personal = MessageHelper.toFriendly(
+                    firstFrom,
                     generalSettingsManager.getConfig().display.isShowCorrespondentNames,
                     generalSettingsManager.getConfig().display.isChangeContactNameColor,
                     localContactRepository,
                 ).toString()
+                return Address(firstFrom.address, personal)
             }
         }
 
         if (isSelf) {
             // show To: if the message was sent from me
             val recipients = message.getRecipients(Message.RecipientType.TO)
             if (!recipients.isNullOrEmpty()) {
+                val firstRecipient = recipients.first()
                 val recipientDisplayName = MessageHelper.toFriendly(
-                    address = recipients.first(),
+                    address = firstRecipient,
                     isShowCorrespondentNames = generalSettingsManager.getConfig().display.isShowCorrespondentNames,
                     isChangeContactNameColor = generalSettingsManager.getConfig().display.isChangeContactNameColor,
                     contactRepository = localContactRepository,
                 ).toString()
-                return resourceProvider.recipientDisplayName(recipientDisplayName)
+                val personal = resourceProvider.recipientDisplayName(recipientDisplayName)
+                return Address(firstRecipient.address, personal)
             }
         }
 
-        return null
-    }
-
-    private fun getMessageSenderForDisplay(sender: String?): String {
-        return sender ?: resourceProvider.noSender()
+        return Address("no.sender@example.com", resourceProvider.noSender())
     }
 }

legacy/core/src/main/java/com/fsck/k9/notification/NotificationResourceProvider.kt

@@ -1,5 +1,8 @@
 package com.fsck.k9.notification
 
+import android.graphics.Bitmap
+import com.fsck.k9.mail.Address
+
 interface NotificationResourceProvider {
     val iconWarning: Int
     val iconMarkAsRead: Int
@@ -25,6 +28,8 @@ interface NotificationResourceProvider {
     fun authenticationErrorTitle(): String
     fun authenticationErrorBody(accountName: String): String
 
+    suspend fun avatar(address: Address): Bitmap?
+
     fun notifyErrorTitle(): String
     fun notifyErrorText(): String
 

legacy/core/src/main/java/com/fsck/k9/notification/SingleMessageNotificationCreator.kt

@@ -1,8 +1,14 @@
 package com.fsck.k9.notification
 
+import android.app.Application
 import androidx.core.app.NotificationCompat
 import androidx.core.app.NotificationCompat.WearableExtender
+import androidx.core.graphics.drawable.IconCompat
 import com.fsck.k9.notification.NotificationChannelManager.ChannelType
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.launch
 import net.thunderbird.core.logging.legacy.Log
 import androidx.core.app.NotificationCompat.Builder as NotificationBuilder
 
@@ -11,12 +17,15 @@ internal class SingleMessageNotificationCreator(
     private val actionCreator: NotificationActionCreator,
     private val resourceProvider: NotificationResourceProvider,
     private val lockScreenNotificationCreator: LockScreenNotificationCreator,
+    private val application: Application,
 ) {
+    private val scope = CoroutineScope(SupervisorJob() + Dispatchers.Main.immediate)
+
     fun createSingleNotification(
         baseNotificationData: BaseNotificationData,
         singleNotificationData: SingleNotificationData,
         isGroupSummary: Boolean = false,
-    ) {
+    ) = scope.launch {
         val account = baseNotificationData.account
         val notificationId = singleNotificationData.notificationId
         val content = singleNotificationData.content
@@ -27,10 +36,11 @@ internal class SingleMessageNotificationCreator(
             .setGroupSummary(isGroupSummary)
             .setGroupAlertBehavior(NotificationCompat.GROUP_ALERT_SUMMARY)
             .setSmallIcon(resourceProvider.iconNewMail)
+            .setAvatar(singleNotificationData.content)
             .setColor(baseNotificationData.color)
             .setWhen(singleNotificationData.timestamp)
             .setTicker(content.summary)
-            .setContentTitle(content.sender)
+            .setContentTitle(content.sender.personal)
             .setContentText(content.subject)
             .setSubText(baseNotificationData.accountName)
             .setBigText(content.preview)
@@ -52,6 +62,12 @@ internal class SingleMessageNotificationCreator(
         notificationHelper.notify(account, notificationId, notification)
     }
 
+    private suspend fun NotificationBuilder.setAvatar(content: NotificationContent) = apply {
+        resourceProvider.avatar(content.sender)?.let {
+            setLargeIcon(IconCompat.createWithAdaptiveBitmap(it).toIcon(application))
+        }
+    }
+
     private fun NotificationBuilder.setBigText(text: CharSequence) = apply {
         setStyle(NotificationCompat.BigTextStyle().bigText(text))
     }

legacy/core/src/test/java/com/fsck/k9/notification/BaseNotificationDataCreatorTest.kt

@@ -7,6 +7,7 @@ import assertk.assertions.isNotNull
 import assertk.assertions.isSameInstanceAs
 import com.fsck.k9.K9
 import com.fsck.k9.K9.LockScreenNotificationVisibility
+import com.fsck.k9.mail.Address
 import net.thunderbird.core.android.account.Identity
 import net.thunderbird.core.android.account.LegacyAccount
 import net.thunderbird.feature.notification.NotificationLight
@@ -129,7 +130,8 @@ class BaseNotificationDataCreatorTest {
 
         assertThat(result.lockScreenNotificationData).isInstanceOf<LockScreenNotificationData.SenderNames>()
         val senderNamesData = result.lockScreenNotificationData as LockScreenNotificationData.SenderNames
-        assertThat(senderNamesData.senderNames).isEqualTo("Sender One, Sender Two, Sender Three")
+        assertThat(senderNamesData.senderNames)
+            .isEqualTo("Sender One <irrelevant>, Sender Two <irrelevant>, Sender Three <irrelevant>")
     }
 
     @Test
@@ -201,7 +203,7 @@ class BaseNotificationDataCreatorTest {
                 timestamp = 0L,
                 content = NotificationContent(
                     messageReference = mock(),
-                    sender = sender,
+                    sender = Address("irrelevant", sender),
                     preview = "irrelevant",
                     summary = "irrelevant",
                     subject = "irrelevant",

legacy/core/src/test/java/com/fsck/k9/notification/NewMailNotificationManagerTest.kt

@@ -13,6 +13,7 @@ import assertk.assertions.isInstanceOf
 import assertk.assertions.isNotNull
 import assertk.assertions.isNull
 import assertk.assertions.isTrue
+import com.fsck.k9.mail.Address
 import com.fsck.k9.mailstore.LocalMessage
 import com.fsck.k9.mailstore.LocalStore
 import com.fsck.k9.mailstore.LocalStoreProvider
@@ -106,7 +107,7 @@ class NewMailNotificationManagerTest {
         assertThat(result.singleNotificationData.first().content).isEqualTo(
             NotificationContent(
                 messageReference = createMessageReference("msg-1"),
-                sender = "sender",
+                sender = Address("irrelevant", "sender"),
                 subject = "subject",
                 preview = "preview",
                 summary = "summary",
@@ -143,7 +144,7 @@ class NewMailNotificationManagerTest {
         assertThat(result.singleNotificationData.first().content).isEqualTo(
             NotificationContent(
                 messageReference = createMessageReference("msg-2"),
-                sender = "Zoe",
+                sender = Address("irrelevant", "Zoe"),
                 subject = "Meeting",
                 preview = "We need to talk",
                 summary = "Zoe Meeting",
@@ -310,7 +311,7 @@ class NewMailNotificationManagerTest {
             assertThat(singleNotificationData.content).isEqualTo(
                 NotificationContent(
                     messageReference = createMessageReference("msg-restore"),
-                    sender = "Alice",
+                    sender = Address("irrelevant", "Alice"),
                     subject = "Another one",
                     preview = "Are you tired of me yet?",
                     summary = "Alice Another one",
@@ -352,7 +353,7 @@ class NewMailNotificationManagerTest {
             assertThat(singleNotificationData.content).isEqualTo(
                 NotificationContent(
                     messageReference = createMessageReference("uid-1"),
-                    sender = "Sender",
+                    sender = Address("irrelevant", "Sender"),
                     subject = "Subject",
                     preview = "Preview",
                     summary = "Summary",
@@ -365,7 +366,7 @@ class NewMailNotificationManagerTest {
             assertThat(summaryNotificationData.singleNotificationData.content).isEqualTo(
                 NotificationContent(
                     messageReference = createMessageReference("uid-1"),
-                    sender = "Sender",
+                    sender = Address("irrelevant", "Sender"),
                     subject = "Subject",
                     preview = "Preview",
                     summary = "Summary",
@@ -435,7 +436,7 @@ class NewMailNotificationManagerTest {
             on { createFromMessage(account, message) } doReturn
                 NotificationContent(
                     messageReference = createMessageReference(messageUid),
-                    sender,
+                    sender = Address("irrelevant", sender),
                     subject,
                     preview,
                     summary,
@@ -463,7 +464,7 @@ class NewMailNotificationManagerTest {
             on { createFromMessage(account, message) } doReturn
                 NotificationContent(
                     messageReference = createMessageReference(messageUid),
-                    sender,
+                    Address("irrelevant", sender),
                     subject,
                     preview,
                     summary,

legacy/core/src/test/java/com/fsck/k9/notification/NotificationContentCreatorTest.kt

@@ -44,7 +44,7 @@ class NotificationContentCreatorTest : RobolectricTest() {
         val content = contentCreator.createFromMessage(account, message)
 
         assertThat(content.messageReference).isEqualTo(messageReference)
-        assertThat(content.sender).isEqualTo(SENDER_NAME)
+        assertThat(content.sender.personal).isEqualTo(SENDER_NAME)
         assertThat(content.subject).isEqualTo(SUBJECT)
         assertThat(content.preview.toString()).isEqualTo("$SUBJECT\n$PREVIEW")
         assertThat(content.summary.toString()).isEqualTo("$SENDER_NAME $SUBJECT")
@@ -110,8 +110,8 @@ class NotificationContentCreatorTest : RobolectricTest() {
 
         val content = contentCreator.createFromMessage(account, message)
 
-        assertThat(content.sender).isEqualTo("No sender")
-        assertThat(content.summary.toString()).isEqualTo(SUBJECT)
+        assertThat(content.sender.personal).isEqualTo("No sender")
+        assertThat(content.summary.toString()).isEqualTo("No sender $SUBJECT")
     }
 
     @Test
@@ -122,7 +122,7 @@ class NotificationContentCreatorTest : RobolectricTest() {
 
         val content = contentCreator.createFromMessage(account, message)
 
-        assertThat(content.sender).isEqualTo("To:Bob")
+        assertThat(content.sender.personal).isEqualTo("To:Bob")
         assertThat(content.summary.toString()).isEqualTo("To:Bob $SUBJECT")
     }
 
@@ -137,10 +137,10 @@ class NotificationContentCreatorTest : RobolectricTest() {
 
         val content = contentCreator.createFromMessage(account, message)
 
-        assertThat(content.sender).isEqualTo("No sender")
+        assertThat(content.sender.personal).isEqualTo("No sender")
         assertThat(content.subject).isEqualTo("(No subject)")
         assertThat(content.preview.toString()).isEqualTo("(No subject)")
-        assertThat(content.summary.toString()).isEqualTo("(No subject)")
+        assertThat(content.summary.toString()).isEqualTo("No sender (No subject)")
     }
 
     private fun createNotificationContentCreator(): NotificationContentCreator {

legacy/core/src/test/java/com/fsck/k9/notification/NotificationDataStoreTest.kt

@@ -12,6 +12,7 @@ import assertk.assertions.isNotNull
 import assertk.assertions.isNull
 import assertk.assertions.isSameInstanceAs
 import assertk.assertions.isTrue
+import com.fsck.k9.mail.Address
 import kotlin.test.assertNotNull
 import net.thunderbird.core.android.account.LegacyAccount
 import net.thunderbird.core.android.testing.RobolectricTest
@@ -247,7 +248,7 @@ class NotificationDataStoreTest : RobolectricTest() {
     private fun createNotificationContent(messageReference: MessageReference): NotificationContent {
         return NotificationContent(
             messageReference = messageReference,
-            sender = "irrelevant",
+            sender = Address("irrelevant", "irrelevant"),
             subject = "irrelevant",
             preview = "irrelevant",
             summary = "irrelevant",

legacy/core/src/test/java/com/fsck/k9/notification/SingleMessageNotificationDataCreatorTest.kt

@@ -9,6 +9,7 @@ import assertk.assertions.isFalse
 import assertk.assertions.isTrue
 import com.fsck.k9.K9
 import com.fsck.k9.K9.NotificationQuickDelete
+import com.fsck.k9.mail.Address
 import net.thunderbird.core.android.account.LegacyAccount
 import org.junit.Test
 
@@ -265,7 +266,7 @@ class SingleMessageNotificationDataCreatorTest {
 
     private fun createNotificationContent() = NotificationContent(
         messageReference = MessageReference("irrelevant", 1, "irrelevant"),
-        sender = "irrelevant",
+        sender = Address("irrelevant", "irrelevant"),
         subject = "irrelevant",
         preview = "irrelevant",
         summary = "irrelevant",

legacy/core/src/test/java/com/fsck/k9/notification/SummaryNotificationDataCreatorTest.kt

@@ -9,6 +9,7 @@ import assertk.assertions.isFalse
 import assertk.assertions.isInstanceOf
 import assertk.assertions.isTrue
 import com.fsck.k9.K9
+import com.fsck.k9.mail.Address
 import java.util.Calendar
 import kotlin.time.Clock
 import kotlin.time.ExperimentalTime
@@ -296,7 +297,7 @@ class SummaryNotificationDataCreatorTest {
 
     private fun createNotificationContent() = NotificationContent(
         messageReference = MessageReference("irrelevant", 1, "irrelevant"),
-        sender = "irrelevant",
+        sender = Address("irrelevant", "irrelevant"),
         subject = "irrelevant",
         preview = "irrelevant",
         summary = "irrelevant",