Add reason for all membership events (matrix-org/matrix-spec-proposal…

…s#2367)
element-hq · Dec 4, 2019 · 6a762fd · 6a762fd
1 parent 0025411
commit 6a762fd
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 14 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -12,6 +12,7 @@ Improvements 🙌:
 
 Other changes:
  - Fix a small grammatical error when an empty room list is shown.
+ - Add reason for all membership events (https://github.com/matrix-org/matrix-doc/pull/2367)
 
 Bugfix 🐛:
  - Do not show long click help if only invitation are displayed

diff --git a/...x-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomMember.kt b/...x-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/model/RoomMember.kt
@@ -32,4 +32,7 @@ data class RoomMember(
         @Json(name = "is_direct") val isDirect: Boolean = false,
         @Json(name = "third_party_invite") val thirdPartyInvite: Invite? = null,
         @Json(name = "unsigned") val unsignedData: UnsignedData? = null
-)
+) {
+    val safeReason
+        get() = reason?.takeIf { it.isNotBlank() }
+}
diff --git a/matrix-sdk-android/src/main/res/values/strings_RiotX.xml b/matrix-sdk-android/src/main/res/values/strings_RiotX.xml
@@ -2,8 +2,19 @@
 <resources>
 
 
+    <string name="notice_room_invite_no_invitee_with_reason">%1$s\'s invitation. Reason: %2$s</string>
+    <string name="notice_room_invite_with_reason">%1$s invited %2$s. Reason: %3$s</string>
+    <string name="notice_room_invite_you_with_reason">%1$s invited you. Reason: %2$s</string>
+    <string name="notice_room_join_with_reason">%1$s joined. Reason: %2$s</string>
+    <string name="notice_room_leave_with_reason">%1$s left. Reason: %2$s</string>
+    <string name="notice_room_reject_with_reason">%1$s rejected the invitation. Reason: %2$s</string>
+    <string name="notice_room_kick_with_reason">%1$s kicked %2$s. Reason: %3$s</string>
+    <string name="notice_room_unban_with_reason">%1$s unbanned %2$s. Reason: %3$s</string>
     <string name="notice_room_ban_with_reason">%1$s banned %2$s. Reason: %3$s</string>
-
+    <string name="notice_room_third_party_invite_with_reason">%1$s sent an invitation to %2$s to join the room. Reason: %3$s</string>
+    <string name="notice_room_third_party_revoked_invite_with_reason">%1$s revoked the invitation for %2$s to join the room. Reason: %3$s</string>
+    <string name="notice_room_third_party_registered_invite_with_reason">%1$s accepted the invitation for %2$s. Reason: %3$s</string>
+    <string name="notice_room_withdraw_with_reason">%1$s withdrew %2$s\'s invitation. Reason: %3$s</string>
 
     <string name="no_network_indicator">There is no network connection right now</string>
 </resources>
diff --git a/...in/java/im/vector/riotx/features/home/room/detail/timeline/format/NoticeEventFormatter.kt b/...in/java/im/vector/riotx/features/home/room/detail/timeline/format/NoticeEventFormatter.kt
@@ -177,41 +177,63 @@ class NoticeEventFormatter @Inject constructor(private val sessionHolder: Active
                 when {
                     eventContent.thirdPartyInvite != null -> {
                         val userWhoHasAccepted = eventContent.thirdPartyInvite?.signed?.mxid ?: event.stateKey
-                        stringProvider.getString(R.string.notice_room_third_party_registered_invite, userWhoHasAccepted, eventContent.thirdPartyInvite?.displayName)
+                        eventContent.safeReason
+                                ?.let { reason -> stringProvider.getString(R.string.notice_room_third_party_registered_invite_with_reason, userWhoHasAccepted, eventContent.thirdPartyInvite?.displayName, reason) }
+                                ?: stringProvider.getString(R.string.notice_room_third_party_registered_invite, userWhoHasAccepted, eventContent.thirdPartyInvite?.displayName)
                     }
                     event.stateKey == selfUserId          ->
-                        stringProvider.getString(R.string.notice_room_invite_you, senderDisplayName)
+                        eventContent.safeReason
+                                ?.let { reason -> stringProvider.getString(R.string.notice_room_invite_you_with_reason, senderDisplayName, reason) }
+                                ?: stringProvider.getString(R.string.notice_room_invite_you, senderDisplayName)
                     event.stateKey.isNullOrEmpty()        ->
-                        stringProvider.getString(R.string.notice_room_invite_no_invitee, senderDisplayName)
+                        eventContent.safeReason
+                                ?.let { reason -> stringProvider.getString(R.string.notice_room_invite_no_invitee_with_reason, senderDisplayName, reason) }
+                                ?: stringProvider.getString(R.string.notice_room_invite_no_invitee, senderDisplayName)
                     else                                  ->
-                        stringProvider.getString(R.string.notice_room_invite, senderDisplayName, targetDisplayName)
+                        eventContent.safeReason
+                                ?.let { reason -> stringProvider.getString(R.string.notice_room_invite, senderDisplayName, targetDisplayName, reason) }
+                                ?: stringProvider.getString(R.string.notice_room_invite, senderDisplayName, targetDisplayName)
                 }
             }
             Membership.JOIN == eventContent?.membership   ->
-                stringProvider.getString(R.string.notice_room_join, senderDisplayName)
+                eventContent.safeReason
+                        ?.let { reason -> stringProvider.getString(R.string.notice_room_join_with_reason, senderDisplayName, reason) }
+                        ?: stringProvider.getString(R.string.notice_room_join, senderDisplayName)
             Membership.LEAVE == eventContent?.membership  ->
                 // 2 cases here: this member may have left voluntarily or they may have been "left" by someone else ie. kicked
                 return if (event.senderId == event.stateKey) {
                     if (prevEventContent?.membership == Membership.INVITE) {
-                        stringProvider.getString(R.string.notice_room_reject, senderDisplayName)
+                        eventContent.safeReason
+                                ?.let { reason -> stringProvider.getString(R.string.notice_room_reject_with_reason, senderDisplayName, reason) }
+                                ?: stringProvider.getString(R.string.notice_room_reject, senderDisplayName)
                     } else {
-                        stringProvider.getString(R.string.notice_room_leave, senderDisplayName)
+                        eventContent.safeReason
+                                ?.let { reason -> stringProvider.getString(R.string.notice_room_leave_with_reason, senderDisplayName, reason) }
+                                ?: stringProvider.getString(R.string.notice_room_leave, senderDisplayName)
                     }
                 } else if (prevEventContent?.membership == Membership.INVITE) {
-                    stringProvider.getString(R.string.notice_room_withdraw, senderDisplayName, targetDisplayName)
+                    eventContent.safeReason
+                            ?.let { reason -> stringProvider.getString(R.string.notice_room_withdraw_with_reason, senderDisplayName, targetDisplayName, reason) }
+                            ?: stringProvider.getString(R.string.notice_room_withdraw, senderDisplayName, targetDisplayName)
                 } else if (prevEventContent?.membership == Membership.JOIN) {
-                    stringProvider.getString(R.string.notice_room_kick, senderDisplayName, targetDisplayName)
+                    eventContent.safeReason
+                            ?.let { reason -> stringProvider.getString(R.string.notice_room_kick_with_reason, senderDisplayName, targetDisplayName, reason) }
+                            ?: stringProvider.getString(R.string.notice_room_kick, senderDisplayName, targetDisplayName)
                 } else if (prevEventContent?.membership == Membership.BAN) {
-                    stringProvider.getString(R.string.notice_room_unban, senderDisplayName, targetDisplayName)
+                    eventContent.safeReason
+                            ?.let { reason -> stringProvider.getString(R.string.notice_room_unban_with_reason, senderDisplayName, targetDisplayName, reason) }
+                            ?: stringProvider.getString(R.string.notice_room_unban, senderDisplayName, targetDisplayName)
                 } else {
                     null
                 }
             Membership.BAN == eventContent?.membership    ->
-                eventContent.reason?.takeIf { it.isNotBlank() }
+                eventContent.safeReason
                         ?.let { reason -> stringProvider.getString(R.string.notice_room_ban_with_reason, senderDisplayName, targetDisplayName, reason) }
                         ?: stringProvider.getString(R.string.notice_room_ban, senderDisplayName, targetDisplayName)
             Membership.KNOCK == eventContent?.membership  ->
-                stringProvider.getString(R.string.notice_room_kick, senderDisplayName, targetDisplayName)
+                eventContent.safeReason
+                        ?.let { reason -> stringProvider.getString(R.string.notice_room_kick_with_reason, senderDisplayName, targetDisplayName, reason) }
+                        ?: stringProvider.getString(R.string.notice_room_kick, senderDisplayName, targetDisplayName)
             else                                          -> null
         }
     }