Manage display name disambiguation (Fixes #172)

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/events/model/Event.kt

@@ -71,6 +71,7 @@ data class Event(
         @Json(name = "content") val content: Content? = null,
         @Json(name = "prev_content") val prevContent: Content? = null,
         @Json(name = "origin_server_ts") val originServerTs: Long? = null,
+        // MatrixId of the sender (TODO rename)
         @Json(name = "sender") val sender: String? = null,
         @Json(name = "state_key") val stateKey: String? = null,
         @Json(name = "room_id") val roomId: String? = null,

matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/timeline/TimelineEvent.kt

@@ -31,6 +31,7 @@ data class TimelineEvent(
         val localId: String,
         val displayIndex: Int,
         val senderName: String?,
+        val isUniqueDisplayName: Boolean,
         val senderAvatar: String?,
         val sendState: SendState,
         val annotations: EventAnnotationsSummary? = null
@@ -53,6 +54,18 @@ data class TimelineEvent(
         }
     }
 
+    fun getDisambiguatedDisplayName(): String {
+        return if (isUniqueDisplayName) {
+            senderName ?: root.sender
+        } else {
+            senderName?.let {
+                it + " (" + root.sender + ")"
+            }
+                    ?: root.sender
+        }
+                ?: ""
+    }
+
     /**
      * Get the metadata associated with a key.
      * @param key the key to get the metadata

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/room/membership/RoomMembers.kt

@@ -54,7 +54,7 @@ internal class RoomMembers(private val realm: Realm,
         }
         return EventEntity
                 .where(realm, roomId, EventType.STATE_ROOM_MEMBER)
-                .contains(EventEntityFields.CONTENT, displayName)
+                .contains(EventEntityFields.CONTENT, "\"displayname\":\"$displayName\"")
                 .distinct(EventEntityFields.STATE_KEY)
                 .findAll()
                 .size == 1

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/room/timeline/TimelineEventFactory.kt

@@ -26,6 +26,7 @@ import im.vector.matrix.android.internal.crypto.MXEventDecryptionResult
 import im.vector.matrix.android.internal.database.mapper.asDomain
 import im.vector.matrix.android.internal.database.model.EventEntity
 import im.vector.matrix.android.internal.session.room.EventRelationExtractor
+import im.vector.matrix.android.internal.session.room.membership.RoomMembers
 import im.vector.matrix.android.internal.session.room.membership.SenderRoomMemberExtractor
 import io.realm.Realm
 import timber.log.Timber
@@ -49,7 +50,11 @@ internal class TimelineEventFactory(
         val cacheKey = sender + eventEntity.localId
         val senderData = senderCache.getOrPut(cacheKey) {
             val senderRoomMember = roomMemberExtractor.extractFrom(eventEntity, realm)
-            SenderData(senderRoomMember?.displayName, senderRoomMember?.avatarUrl)
+            val isUniqueDisplayName = RoomMembers(realm, eventEntity.roomId).isUniqueDisplayName(senderRoomMember?.displayName)
+
+            SenderData(senderRoomMember?.displayName,
+                    isUniqueDisplayName,
+                    senderRoomMember?.avatarUrl)
         }
         val event = eventEntity.asDomain()
         if (event.getClearType() == EventType.ENCRYPTED) {
@@ -62,6 +67,7 @@ internal class TimelineEventFactory(
                 eventEntity.localId,
                 eventEntity.displayIndex,
                 senderData.senderName,
+                senderData.isUniqueDisplayName,
                 senderData.senderAvatar,
                 eventEntity.sendState,
                 relations
@@ -96,7 +102,7 @@ internal class TimelineEventFactory(
 
     private data class SenderData(
             val senderName: String?,
+            val isUniqueDisplayName: Boolean,
             val senderAvatar: String?
     )
-
 }

vector/src/main/java/im/vector/riotredesign/features/home/room/detail/RoomDetailFragment.kt

@@ -222,7 +222,7 @@ class RoomDetailFragment :
                     }
                     //switch to expanded bar
                     composerLayout.composerRelatedMessageTitle.apply {
-                        text = event.senderName
+                        text = event.getDisambiguatedDisplayName()
                         setTextColor(ContextCompat.getColor(requireContext(), getColorFromUserId(event.root.sender)))
                     }
 

vector/src/main/java/im/vector/riotredesign/features/home/room/detail/RoomDetailViewModel.kt

@@ -282,7 +282,7 @@ class RoomDetailViewModel(initialState: RoomDetailViewState,
         val dateFormat = SimpleDateFormat("EEE, d MMM yyyy HH:mm", Locale.getDefault())
         _nonBlockingPopAlert.postValue(LiveEvent(
                 Pair(R.string.last_edited_info_message, listOf(
-                        lastReplace.senderName ?: "?",
+                        lastReplace.getDisambiguatedDisplayName(),
                         dateFormat.format(Date(lastReplace.root.originServerTs ?: 0)))
                 ))
         )

vector/src/main/java/im/vector/riotredesign/features/home/room/detail/timeline/action/ViewReactionViewModel.kt

@@ -50,7 +50,7 @@ class ViewReactionViewModel(private val session: Session,
                 sum.sourceEvents.mapNotNull { room.getTimeLineEvent(it) }.forEach {
                     val localDate = it.root.localDateTime()
                     results.add(ReactionInfo(it.root.eventId!!, sum.key, it.root.sender
-                            ?: "", it.senderName, timelineDateFormatter.formatMessageHour(localDate)))
+                            ?: "", it.getDisambiguatedDisplayName(), timelineDateFormatter.formatMessageHour(localDate)))
                 }
             }
             setState {

vector/src/main/java/im/vector/riotredesign/features/home/room/detail/timeline/format/NoticeEventFormatter.kt

@@ -32,13 +32,13 @@ class NoticeEventFormatter(private val stringProvider: StringProvider) {
 
     fun format(timelineEvent: TimelineEvent): CharSequence? {
         return when (val type = timelineEvent.root.getClearType()) {
-            EventType.STATE_ROOM_NAME          -> formatRoomNameEvent(timelineEvent.root, timelineEvent.senderName)
+            EventType.STATE_ROOM_NAME          -> formatRoomNameEvent(timelineEvent.root, timelineEvent.getDisambiguatedDisplayName())
-            EventType.STATE_ROOM_TOPIC         -> formatRoomTopicEvent(timelineEvent.root, timelineEvent.senderName)
+            EventType.STATE_ROOM_TOPIC         -> formatRoomTopicEvent(timelineEvent.root, timelineEvent.getDisambiguatedDisplayName())
             EventType.STATE_ROOM_MEMBER        -> formatRoomMemberEvent(timelineEvent.root, timelineEvent.senderName())
-            EventType.STATE_HISTORY_VISIBILITY -> formatRoomHistoryVisibilityEvent(timelineEvent.root, timelineEvent.senderName)
+            EventType.STATE_HISTORY_VISIBILITY -> formatRoomHistoryVisibilityEvent(timelineEvent.root, timelineEvent.getDisambiguatedDisplayName())
             EventType.CALL_INVITE,
             EventType.CALL_HANGUP,
-            EventType.CALL_ANSWER              -> formatCallEvent(timelineEvent.root, timelineEvent.senderName)
+            EventType.CALL_ANSWER              -> formatCallEvent(timelineEvent.root, timelineEvent.getDisambiguatedDisplayName())
             else                               -> {
                 Timber.v("Type $type not handled by this formatter")
                 null

vector/src/main/java/im/vector/riotredesign/features/home/room/detail/timeline/helper/TimelineDisplayableEvents.kt

@@ -85,12 +85,11 @@ fun TimelineEvent.senderAvatar(): String? {
 
 fun TimelineEvent.senderName(): String? {
     // We might have no senderName when user leave, so we try to get it from prevContent
-    return senderName
+    return when {
-            ?: if (root.type == EventType.STATE_ROOM_MEMBER) {
+        senderName != null                       -> getDisambiguatedDisplayName()
-                root.prevContent.toModel<RoomMember>()?.displayName
+        root.type == EventType.STATE_ROOM_MEMBER -> root.prevContent.toModel<RoomMember>()?.displayName
-            } else {
+        else                                     -> null
-                null
+    }
-            }
 }
 
 fun TimelineEvent.canBeMerged(): Boolean {

vector/src/main/java/im/vector/riotredesign/features/home/room/detail/timeline/item/AbsMessageItem.kt

@@ -83,7 +83,6 @@ abstract class AbsMessageItem<H : AbsMessageItem.Holder> : BaseEventItem<H>() {
     override fun bind(holder: H) {
         super.bind(holder)
         if (informationData.showInformation) {
-
             holder.avatarImageView.layoutParams = holder.avatarImageView.layoutParams?.apply {
                 val size = dpToPx(avatarStyle.avatarSizeDP, holder.view.context)
                 height = size

vector/src/main/java/im/vector/riotredesign/features/home/room/detail/timeline/util/MessageInformationDataFactory.kt

@@ -22,7 +22,6 @@ import im.vector.riotredesign.core.extensions.localDateTime
 import im.vector.riotredesign.core.resources.ColorProvider
 import im.vector.riotredesign.features.home.getColorFromUserId
 import im.vector.riotredesign.features.home.room.detail.timeline.helper.TimelineDateFormatter
-import im.vector.riotredesign.features.home.room.detail.timeline.helper.senderAvatar
 import im.vector.riotredesign.features.home.room.detail.timeline.item.MessageInformationData
 import im.vector.riotredesign.features.home.room.detail.timeline.item.ReactionInfoData
 import me.gujun.android.span.span
@@ -38,21 +37,21 @@ class MessageInformationDataFactory(private val timelineDateFormatter: TimelineD
         val eventId = event.root.eventId!!
 
         val date = event.root.localDateTime()
-
         val nextDate = nextEvent?.root?.localDateTime()
         val addDaySeparator = date.toLocalDate() != nextDate?.toLocalDate()
         val isNextMessageReceivedMoreThanOneHourAgo = nextDate?.isBefore(date.minusMinutes(60))
                 ?: false
+
         val showInformation =
                 addDaySeparator
                         || event.senderAvatar != nextEvent?.senderAvatar
-                        || event.senderName != nextEvent?.senderName
+                        || event.getDisambiguatedDisplayName() != nextEvent?.getDisambiguatedDisplayName()
                         || (nextEvent?.root?.getClearType() != EventType.MESSAGE && nextEvent?.root?.getClearType() != EventType.ENCRYPTED)
                         || isNextMessageReceivedMoreThanOneHourAgo
 
         val time = timelineDateFormatter.formatMessageHour(date)
-        val avatarUrl = event.senderAvatar()
+        val avatarUrl = event.senderAvatar
-        val memberName = event.senderName ?: event.root.sender ?: ""
+        val memberName = event.getDisambiguatedDisplayName()
         val formattedMemberName = span(memberName) {
             textColor = colorProvider.getColor(getColorFromUserId(event.root.sender
                     ?: ""))