Merge pull request #738 from vector-im/feature/ban_reason

Displaay ban and other membership events reason
element-hq · Dec 9, 2019 · 8b1701e · 8b1701e
2 parents 41d1b77 + ac75fe1
commit 8b1701e
Show file tree

Hide file tree

Showing 26 changed files with 223 additions and 138 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -8,7 +8,7 @@ Improvements 🙌:
  - Support entering a RiotWeb client URL instead of the homeserver URL during connection (#744)
 
 Other changes:
- -
+ - Add reason for all membership events (https://github.com/matrix-org/matrix-doc/pull/2367)
 
 Bugfix 🐛:
  - When automardown is ON, pills are sent as MD in body (#739)
@@ -17,7 +17,7 @@ Translations 🗣:
  -
 
 Build 🧱:
- -
+ - "ban" event are not rendered correctly (#716)
 
 Changes in RiotX 0.9.1 (2019-12-05)
 ===================================================

diff --git a/matrix-sdk-android-rx/src/main/java/im/vector/matrix/rx/RxRoom.kt b/matrix-sdk-android-rx/src/main/java/im/vector/matrix/rx/RxRoom.kt
@@ -57,8 +57,9 @@ class RxRoom(private val room: Room) {
         room.loadRoomMembersIfNeeded(MatrixCallbackSingle(it)).toSingle(it)
     }
 
-    fun joinRoom(viaServers: List<String> = emptyList()): Single<Unit> = Single.create {
-        room.join(viaServers, MatrixCallbackSingle(it)).toSingle(it)
+    fun joinRoom(reason: String? = null,
+                 viaServers: List<String> = emptyList()): Single<Unit> = Single.create {
+        room.join(reason, viaServers, MatrixCallbackSingle(it)).toSingle(it)
     }
 
     fun liveEventReadReceipts(eventId: String): Observable<List<ReadReceipt>> {

diff --git a/matrix-sdk-android-rx/src/main/java/im/vector/matrix/rx/RxSession.kt b/matrix-sdk-android-rx/src/main/java/im/vector/matrix/rx/RxSession.kt
@@ -76,8 +76,10 @@ class RxSession(private val session: Session) {
         session.searchUsersDirectory(search, limit, excludedUserIds, MatrixCallbackSingle(it)).toSingle(it)
     }
 
-    fun joinRoom(roomId: String, viaServers: List<String> = emptyList()): Single<Unit> = Single.create {
-        session.joinRoom(roomId, viaServers, MatrixCallbackSingle(it)).toSingle(it)
+    fun joinRoom(roomId: String,
+                 reason: String? = null,
+                 viaServers: List<String> = emptyList()): Single<Unit> = Single.create {
+        session.joinRoom(roomId, reason, viaServers, MatrixCallbackSingle(it)).toSingle(it)
     }
 }
 

diff --git a/...k-android/src/main/java/im/vector/matrix/android/api/session/room/RoomDirectoryService.kt b/...k-android/src/main/java/im/vector/matrix/android/api/session/room/RoomDirectoryService.kt
@@ -30,12 +30,16 @@ interface RoomDirectoryService {
     /**
      * Get rooms from directory
      */
-    fun getPublicRooms(server: String?, publicRoomsParams: PublicRoomsParams, callback: MatrixCallback<PublicRoomsResponse>): Cancelable
+    fun getPublicRooms(server: String?,
+                       publicRoomsParams: PublicRoomsParams,
+                       callback: MatrixCallback<PublicRoomsResponse>): Cancelable
 
     /**
      * Join a room by id
      */
-    fun joinRoom(roomId: String, callback: MatrixCallback<Unit>): Cancelable
+    fun joinRoom(roomId: String,
+                 reason: String? = null,
+                 callback: MatrixCallback<Unit>): Cancelable
 
     /**
      * Fetches the overall metadata about protocols supported by the homeserver.

diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/RoomService.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/api/session/room/RoomService.kt
@@ -30,14 +30,17 @@ interface RoomService {
     /**
      * Create a room asynchronously
      */
-    fun createRoom(createRoomParams: CreateRoomParams, callback: MatrixCallback<String>): Cancelable
+    fun createRoom(createRoomParams: CreateRoomParams,
+                   callback: MatrixCallback<String>): Cancelable
 
     /**
      * Join a room by id
      * @param roomId the roomId of the room to join
+     * @param reason optional reason for joining the room
      * @param viaServers the servers to attempt to join the room through. One of the servers must be participating in the room.
      */
     fun joinRoom(roomId: String,
+                 reason: String? = null,
                  viaServers: List<String> = emptyList(),
                  callback: MatrixCallback<Unit>): Cancelable
 
@@ -69,5 +72,6 @@ interface RoomService {
     /**
      * Mark all rooms as read
      */
-    fun markAllAsRead(roomIds: List<String>, callback: MatrixCallback<Unit>): Cancelable
+    fun markAllAsRead(roomIds: List<String>,
+                      callback: MatrixCallback<Unit>): Cancelable
 }
diff --git a/...roid/src/main/java/im/vector/matrix/android/api/session/room/members/MembershipService.kt b/...roid/src/main/java/im/vector/matrix/android/api/session/room/members/MembershipService.kt
@@ -52,16 +52,21 @@ interface MembershipService {
     /**
      * Invite a user in the room
      */
-    fun invite(userId: String, callback: MatrixCallback<Unit>): Cancelable
+    fun invite(userId: String,
+               reason: String? = null,
+               callback: MatrixCallback<Unit>): Cancelable
 
     /**
      * Join the room, or accept an invitation.
      */
 
-    fun join(viaServers: List<String> = emptyList(), callback: MatrixCallback<Unit>): Cancelable
+    fun join(reason: String? = null,
+             viaServers: List<String> = emptyList(),
+             callback: MatrixCallback<Unit>): Cancelable
 
     /**
      * Leave the room, or reject an invitation.
      */
-    fun leave(callback: MatrixCallback<Unit>): Cancelable
+    fun leave(reason: String? = null,
+              callback: MatrixCallback<Unit>): Cancelable
 }
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
@@ -26,9 +26,13 @@ import im.vector.matrix.android.api.session.events.model.UnsignedData
 @JsonClass(generateAdapter = true)
 data class RoomMember(
         @Json(name = "membership") val membership: Membership,
+        @Json(name = "reason") val reason: String? = null,
         @Json(name = "displayname") val displayName: String? = null,
         @Json(name = "avatar_url") val avatarUrl: String? = null,
         @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/...c/main/java/im/vector/matrix/android/internal/session/room/DefaultRoomDirectoryService.kt b/...c/main/java/im/vector/matrix/android/internal/session/room/DefaultRoomDirectoryService.kt
@@ -44,9 +44,9 @@ internal class DefaultRoomDirectoryService @Inject constructor(private val getPu
                 .executeBy(taskExecutor)
     }
 
-    override fun joinRoom(roomId: String, callback: MatrixCallback<Unit>): Cancelable {
+    override fun joinRoom(roomId: String, reason: String?, callback: MatrixCallback<Unit>): Cancelable {
         return joinRoomTask
-                .configureWith(JoinRoomTask.Params(roomId)) {
+                .configureWith(JoinRoomTask.Params(roomId, reason)) {
                     this.callback = callback
                 }
                 .executeBy(taskExecutor)

diff --git a/...ndroid/src/main/java/im/vector/matrix/android/internal/session/room/DefaultRoomService.kt b/...ndroid/src/main/java/im/vector/matrix/android/internal/session/room/DefaultRoomService.kt
@@ -96,9 +96,9 @@ internal class DefaultRoomService @Inject constructor(private val monarchy: Mona
                 .executeBy(taskExecutor)
     }
 
-    override fun joinRoom(roomId: String, viaServers: List<String>, callback: MatrixCallback<Unit>): Cancelable {
+    override fun joinRoom(roomId: String, reason: String?, viaServers: List<String>, callback: MatrixCallback<Unit>): Cancelable {
         return joinRoomTask
-                .configureWith(JoinRoomTask.Params(roomId, viaServers)) {
+                .configureWith(JoinRoomTask.Params(roomId, reason, viaServers)) {
                     this.callback = callback
                 }
                 .executeBy(taskExecutor)

diff --git a/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/room/RoomAPI.kt b/matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/room/RoomAPI.kt
@@ -217,7 +217,7 @@ internal interface RoomAPI {
     @POST(NetworkConstants.URI_API_PREFIX_PATH_R0 + "rooms/{roomId}/join")
     fun join(@Path("roomId") roomId: String,
              @Query("server_name") viaServers: List<String>,
-             @Body params: Map<String, String>): Call<Unit>
+             @Body params: Map<String, String?>): Call<Unit>
 
     /**
      * Leave the given room.
@@ -227,7 +227,7 @@ internal interface RoomAPI {
      */
     @POST(NetworkConstants.URI_API_PREFIX_PATH_R0 + "rooms/{roomId}/leave")
     fun leave(@Path("roomId") roomId: String,
-              @Body params: Map<String, String>): Call<Unit>
+              @Body params: Map<String, String?>): Call<Unit>
 
     /**
      * Strips all information out of an event which isn't critical to the integrity of the server-side representation of the room.

diff --git a/...ava/im/vector/matrix/android/internal/session/room/membership/DefaultMembershipService.kt b/...ava/im/vector/matrix/android/internal/session/room/membership/DefaultMembershipService.kt
@@ -83,26 +83,26 @@ internal class DefaultMembershipService @AssistedInject constructor(@Assisted pr
         return result
     }
 
-    override fun invite(userId: String, callback: MatrixCallback<Unit>): Cancelable {
-        val params = InviteTask.Params(roomId, userId)
+    override fun invite(userId: String, reason: String?, callback: MatrixCallback<Unit>): Cancelable {
+        val params = InviteTask.Params(roomId, userId, reason)
         return inviteTask
                 .configureWith(params) {
                     this.callback = callback
                 }
                 .executeBy(taskExecutor)
     }
 
-    override fun join(viaServers: List<String>, callback: MatrixCallback<Unit>): Cancelable {
-        val params = JoinRoomTask.Params(roomId, viaServers)
+    override fun join(reason: String?, viaServers: List<String>, callback: MatrixCallback<Unit>): Cancelable {
+        val params = JoinRoomTask.Params(roomId, reason, viaServers)
         return joinTask
                 .configureWith(params) {
                     this.callback = callback
                 }
                 .executeBy(taskExecutor)
     }
 
-    override fun leave(callback: MatrixCallback<Unit>): Cancelable {
-        val params = LeaveRoomTask.Params(roomId)
+    override fun leave(reason: String?, callback: MatrixCallback<Unit>): Cancelable {
+        val params = LeaveRoomTask.Params(roomId, reason)
         return leaveRoomTask
                 .configureWith(params) {
                     this.callback = callback

diff --git a/...main/java/im/vector/matrix/android/internal/session/room/membership/joining/InviteBody.kt b/...main/java/im/vector/matrix/android/internal/session/room/membership/joining/InviteBody.kt
@@ -21,5 +21,6 @@ import com.squareup.moshi.JsonClass
 
 @JsonClass(generateAdapter = true)
 data class InviteBody(
-        @Json(name = "user_id") val userId: String
+        @Json(name = "user_id") val userId: String,
+        @Json(name = "reason") val reason: String?
 )
diff --git a/...main/java/im/vector/matrix/android/internal/session/room/membership/joining/InviteTask.kt b/...main/java/im/vector/matrix/android/internal/session/room/membership/joining/InviteTask.kt
@@ -24,15 +24,16 @@ import javax.inject.Inject
 internal interface InviteTask : Task<InviteTask.Params, Unit> {
     data class Params(
             val roomId: String,
-            val userId: String
+            val userId: String,
+            val reason: String?
     )
 }
 
 internal class DefaultInviteTask @Inject constructor(private val roomAPI: RoomAPI) : InviteTask {
 
     override suspend fun execute(params: InviteTask.Params) {
         return executeRequest {
-            val body = InviteBody(params.userId)
+            val body = InviteBody(params.userId, params.reason)
             apiCall = roomAPI.invite(params.roomId, body)
         }
     }

diff --git a/...in/java/im/vector/matrix/android/internal/session/room/membership/joining/JoinRoomTask.kt b/...in/java/im/vector/matrix/android/internal/session/room/membership/joining/JoinRoomTask.kt
@@ -32,6 +32,7 @@ import javax.inject.Inject
 internal interface JoinRoomTask : Task<JoinRoomTask.Params, Unit> {
     data class Params(
             val roomId: String,
+            val reason: String?,
             val viaServers: List<String> = emptyList()
     )
 }
@@ -43,7 +44,7 @@ internal class DefaultJoinRoomTask @Inject constructor(private val roomAPI: Room
 
     override suspend fun execute(params: JoinRoomTask.Params) {
         executeRequest<Unit> {
-            apiCall = roomAPI.join(params.roomId, params.viaServers, HashMap())
+            apiCall = roomAPI.join(params.roomId, params.viaServers, mapOf("reason" to params.reason))
         }
         val roomId = params.roomId
         // Wait for room to come back from the sync (but it can maybe be in the DB is the sync response is received before)

diff --git a/...n/java/im/vector/matrix/android/internal/session/room/membership/leaving/LeaveRoomTask.kt b/...n/java/im/vector/matrix/android/internal/session/room/membership/leaving/LeaveRoomTask.kt
@@ -23,15 +23,16 @@ import javax.inject.Inject
 
 internal interface LeaveRoomTask : Task<LeaveRoomTask.Params, Unit> {
     data class Params(
-            val roomId: String
+            val roomId: String,
+            val reason: String?
     )
 }
 
 internal class DefaultLeaveRoomTask @Inject constructor(private val roomAPI: RoomAPI) : LeaveRoomTask {
 
     override suspend fun execute(params: LeaveRoomTask.Params) {
         return executeRequest {
-            apiCall = roomAPI.leave(params.roomId, HashMap())
+            apiCall = roomAPI.leave(params.roomId, mapOf("reason" to params.reason))
         }
     }
 }
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/vector/src/main/java/im/vector/riotx/features/command/Command.kt b/vector/src/main/java/im/vector/riotx/features/command/Command.kt
@@ -27,16 +27,19 @@ import im.vector.riotx.R
 enum class Command(val command: String, val parameters: String, @StringRes val description: Int) {
     EMOTE("/me", "<message>", R.string.command_description_emote),
     BAN_USER("/ban", "<user-id> [reason]", R.string.command_description_ban_user),
-    UNBAN_USER("/unban", "<user-id>", R.string.command_description_unban_user),
+    UNBAN_USER("/unban", "<user-id> [reason]", R.string.command_description_unban_user),
     SET_USER_POWER_LEVEL("/op", "<user-id> [<power-level>]", R.string.command_description_op_user),
     RESET_USER_POWER_LEVEL("/deop", "<user-id>", R.string.command_description_deop_user),
-    INVITE("/invite", "<user-id>", R.string.command_description_invite_user),
-    JOIN_ROOM("/join", "<room-alias>", R.string.command_description_join_room),
-    PART("/part", "<room-alias>", R.string.command_description_part_room),
+    INVITE("/invite", "<user-id> [reason]", R.string.command_description_invite_user),
+    JOIN_ROOM("/join", "<room-alias> [reason]", R.string.command_description_join_room),
+    PART("/part", "<room-alias> [reason]", R.string.command_description_part_room),
     TOPIC("/topic", "<topic>", R.string.command_description_topic),
     KICK_USER("/kick", "<user-id> [reason]", R.string.command_description_kick_user),
     CHANGE_DISPLAY_NAME("/nick", "<display-name>", R.string.command_description_nick),
     MARKDOWN("/markdown", "<on|off>", R.string.command_description_markdown),
     CLEAR_SCALAR_TOKEN("/clear_scalar_token", "", R.string.command_description_clear_scalar_token),
     SPOILER("/spoiler", "<message>", R.string.command_description_spoiler);
+
+    val length
+        get() = command.length + 1
 }