Merge pull request #4402 from vector-im/feature/adm/notification-images

Supporting images in notifications

Author: ouchadam

changelog.d/4402.feature

@@ -0,0 +1 @@
+Adds support for images inside message notifications

vector/src/main/java/im/vector/app/core/extensions/BasicExtensions.kt

@@ -66,3 +66,7 @@ fun String?.insertBeforeLast(insert: String, delimiter: String = "."): String {
         replaceRange(idx, idx, insert)
     }
 }
+
+inline fun <reified R> Any?.takeAs(): R? {
+    return takeIf { it is R } as R?
+}

vector/src/main/java/im/vector/app/features/notifications/NotifiableEventResolver.kt

@@ -15,8 +15,10 @@
  */
 package im.vector.app.features.notifications
 
+import android.net.Uri
 import im.vector.app.BuildConfig
 import im.vector.app.R
+import im.vector.app.core.extensions.takeAs
 import im.vector.app.core.resources.StringProvider
 import im.vector.app.features.displayname.getBestName
 import im.vector.app.features.home.room.detail.timeline.format.DisplayableEventFormatter
@@ -28,12 +30,15 @@ import org.matrix.android.sdk.api.session.crypto.MXCryptoError
 import org.matrix.android.sdk.api.session.events.model.Event
 import org.matrix.android.sdk.api.session.events.model.EventType
 import org.matrix.android.sdk.api.session.events.model.isEdition
+import org.matrix.android.sdk.api.session.events.model.isImageMessage
 import org.matrix.android.sdk.api.session.events.model.toModel
 import org.matrix.android.sdk.api.session.room.model.Membership
 import org.matrix.android.sdk.api.session.room.model.RoomMemberContent
+import org.matrix.android.sdk.api.session.room.model.message.MessageWithAttachmentContent
 import org.matrix.android.sdk.api.session.room.sender.SenderInfo
 import org.matrix.android.sdk.api.session.room.timeline.TimelineEvent
 import org.matrix.android.sdk.api.session.room.timeline.getEditedEventId
+import org.matrix.android.sdk.api.session.room.timeline.getLastMessageContent
 import org.matrix.android.sdk.api.util.toMatrixItem
 import org.matrix.android.sdk.internal.crypto.algorithms.olm.OlmDecryptionResult
 import timber.log.Timber
@@ -49,11 +54,12 @@ import javax.inject.Inject
 class NotifiableEventResolver @Inject constructor(
         private val stringProvider: StringProvider,
         private val noticeEventFormatter: NoticeEventFormatter,
-        private val displayableEventFormatter: DisplayableEventFormatter) {
+        private val displayableEventFormatter: DisplayableEventFormatter
+) {
 
     // private val eventDisplay = RiotEventDisplay(context)
 
-    fun resolveEvent(event: Event/*, roomState: RoomState?, bingRule: PushRule?*/, session: Session, isNoisy: Boolean): NotifiableEvent? {
+    suspend fun resolveEvent(event: Event/*, roomState: RoomState?, bingRule: PushRule?*/, session: Session, isNoisy: Boolean): NotifiableEvent? {
         val roomID = event.roomId ?: return null
         val eventId = event.eventId ?: return null
         if (event.getClearType() == EventType.STATE_ROOM_MEMBER) {
@@ -89,7 +95,7 @@ class NotifiableEventResolver @Inject constructor(
         }
     }
 
-    fun resolveInMemoryEvent(session: Session, event: Event, canBeReplaced: Boolean): NotifiableEvent? {
+    suspend fun resolveInMemoryEvent(session: Session, event: Event, canBeReplaced: Boolean): NotifiableEvent? {
         if (event.getClearType() != EventType.MESSAGE) return null
 
         // Ignore message edition
@@ -120,7 +126,7 @@ class NotifiableEventResolver @Inject constructor(
         }
     }
 
-    private fun resolveMessageEvent(event: TimelineEvent, session: Session, canBeReplaced: Boolean, isNoisy: Boolean): NotifiableEvent {
+    private suspend fun resolveMessageEvent(event: TimelineEvent, session: Session, canBeReplaced: Boolean, isNoisy: Boolean): NotifiableEvent {
         // The event only contains an eventId, and roomId (type is m.room.*) , we need to get the displayable content (names, avatar, text, etc...)
         val room = session.getRoom(event.root.roomId!! /*roomID cannot be null*/)
 
@@ -140,6 +146,7 @@ class NotifiableEventResolver @Inject constructor(
                     senderName = senderDisplayName,
                     senderId = event.root.senderId,
                     body = body.toString(),
+                    imageUri = event.fetchImageIfPresent(session),
                     roomId = event.root.roomId!!,
                     roomName = roomName,
                     matrixID = session.myUserId
@@ -173,6 +180,7 @@ class NotifiableEventResolver @Inject constructor(
                     senderName = senderDisplayName,
                     senderId = event.root.senderId,
                     body = body,
+                    imageUri = event.fetchImageIfPresent(session),
                     roomId = event.root.roomId!!,
                     roomName = roomName,
                     roomIsDirect = room.roomSummary()?.isDirect ?: false,
@@ -192,6 +200,26 @@ class NotifiableEventResolver @Inject constructor(
         }
     }
 
+    private suspend fun TimelineEvent.fetchImageIfPresent(session: Session): Uri? {
+        return when {
+            root.isEncrypted() && root.mxDecryptionResult == null -> null
+            root.isImageMessage()                                 -> downloadAndExportImage(session)
+            else                                                  -> null
+        }
+    }
+
+    private suspend fun TimelineEvent.downloadAndExportImage(session: Session): Uri? {
+        return kotlin.runCatching {
+            getLastMessageContent()?.takeAs<MessageWithAttachmentContent>()?.let { imageMessage ->
+                val fileService = session.fileService()
+                fileService.downloadFile(imageMessage)
+                fileService.getTemporarySharableURI(imageMessage)
+            }
+        }.onFailure {
+            Timber.e(it, "Failed to download and export image for notification")
+        }.getOrNull()
+    }
+
     private fun resolveStateRoomEvent(event: Event, session: Session, canBeReplaced: Boolean, isNoisy: Boolean): NotifiableEvent? {
         val content = event.content?.toModel<RoomMemberContent>() ?: return null
         val roomId = event.roomId ?: return null

vector/src/main/java/im/vector/app/features/notifications/NotifiableMessageEvent.kt

@@ -15,6 +15,7 @@
  */
 package im.vector.app.features.notifications
 
+import android.net.Uri
 import org.matrix.android.sdk.api.session.events.model.EventType
 
 data class NotifiableMessageEvent(
@@ -26,6 +27,7 @@ data class NotifiableMessageEvent(
         val senderName: String?,
         val senderId: String?,
         val body: String?,
+        val imageUri: Uri?,
         val roomId: String,
         val roomName: String?,
         val roomIsDirect: Boolean = false,

vector/src/main/java/im/vector/app/features/notifications/NotificationBroadcastReceiver.kt

@@ -138,6 +138,7 @@ class NotificationBroadcastReceiver : BroadcastReceiver() {
                         ?: context?.getString(R.string.notification_sender_me),
                 senderId = session.myUserId,
                 body = message,
+                imageUri = null,
                 roomId = room.roomId,
                 roomName = room.roomSummary()?.displayName ?: room.roomId,
                 roomIsDirect = room.roomSummary()?.isDirect == true,

vector/src/main/java/im/vector/app/features/notifications/PushRuleTriggerListener.kt

@@ -16,6 +16,11 @@
 
 package im.vector.app.features.notifications
 
+import kotlinx.coroutines.CancellationException
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.SupervisorJob
+import kotlinx.coroutines.cancelChildren
+import kotlinx.coroutines.launch
 import org.matrix.android.sdk.api.pushrules.PushEvents
 import org.matrix.android.sdk.api.pushrules.PushRuleService
 import org.matrix.android.sdk.api.pushrules.getActions
@@ -31,21 +36,24 @@ class PushRuleTriggerListener @Inject constructor(
 ) : PushRuleService.PushRuleListener {
 
     private var session: Session? = null
+    private val scope: CoroutineScope = CoroutineScope(SupervisorJob())
 
     override fun onEvents(pushEvents: PushEvents) {
-        session?.let { session ->
-            val notifiableEvents = createNotifiableEvents(pushEvents, session)
-            notificationDrawerManager.updateEvents { queuedEvents ->
-                notifiableEvents.forEach { notifiableEvent ->
-                    queuedEvents.onNotifiableEventReceived(notifiableEvent)
+        scope.launch {
+            session?.let { session ->
+                val notifiableEvents = createNotifiableEvents(pushEvents, session)
+                notificationDrawerManager.updateEvents { queuedEvents ->
+                    notifiableEvents.forEach { notifiableEvent ->
+                        queuedEvents.onNotifiableEventReceived(notifiableEvent)
+                    }
+                    queuedEvents.syncRoomEvents(roomsLeft = pushEvents.roomsLeft, roomsJoined = pushEvents.roomsJoined)
+                    queuedEvents.markRedacted(pushEvents.redactedEventIds)
                 }
-                queuedEvents.syncRoomEvents(roomsLeft = pushEvents.roomsLeft, roomsJoined = pushEvents.roomsJoined)
-                queuedEvents.markRedacted(pushEvents.redactedEventIds)
-            }
-        } ?: Timber.e("Called without active session")
+            } ?: Timber.e("Called without active session")
+        }
     }
 
-    private fun createNotifiableEvents(pushEvents: PushEvents, session: Session): List<NotifiableEvent> {
+    private suspend fun createNotifiableEvents(pushEvents: PushEvents, session: Session): List<NotifiableEvent> {
         return pushEvents.matchedEvents.mapNotNull { (event, pushRule) ->
             Timber.v("Push rule match for event ${event.eventId}")
             val action = pushRule.getActions().toNotificationAction()
@@ -67,6 +75,7 @@ class PushRuleTriggerListener @Inject constructor(
     }
 
     fun stop() {
+        scope.coroutineContext.cancelChildren(CancellationException("PushRuleTriggerListener stopping"))
         session?.removePushRuleListener(this)
         session = null
         notificationDrawerManager.clearAllEvents()

vector/src/main/java/im/vector/app/features/notifications/RoomGroupMessageCreator.kt

@@ -114,7 +114,14 @@ class RoomGroupMessageCreator @Inject constructor(
             }
             when {
                 event.isSmartReplyError() -> addMessage(stringProvider.getString(R.string.notification_inline_reply_failed), event.timestamp, senderPerson)
-                else                      -> addMessage(event.body, event.timestamp, senderPerson)
+                else                      -> {
+                    val message = NotificationCompat.MessagingStyle.Message(event.body, event.timestamp, senderPerson).also { message ->
+                        event.imageUri?.let {
+                            message.setData("image/", it)
+                        }
+                    }
+                    addMessage(message)
+                }
             }
         }
     }

vector/src/test/java/im/vector/app/test/fixtures/NotifiableEventFixture.kt

@@ -76,5 +76,6 @@ fun aNotifiableMessageEvent(
         roomName = "room-name",
         roomIsDirect = false,
         canBeReplaced = false,
-        isRedacted = isRedacted
+        isRedacted = isRedacted,
+        imageUri = null
 )