Update room properties from room details (#439)

-  Add the edit action in the room details
-  Add "Add topic" button in room details
-  Add the screen behind that action to edit some room properties: avatar, name, topic
   -  Handle the save button action
      - enable the button only if changes are detected
      - display a loader "updating room"
      - display an error dialog if any request has failed
- Check user has the right power level to change various attributes
   - "Add topic" is only shown if there's no topic and they are able to set on
   - Edit menu is only shown if they can change topic, name or avatar
   - On the edit page, any fields they can't change are uneditable

Co-authored-by: Chris Smith <csmith@lunarian.uk>

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/MatrixRoom.kt

@@ -89,4 +89,14 @@ interface MatrixRoom : Closeable {
     suspend fun inviteUserById(id: UserId): Result<Unit>
 
     suspend fun canInvite(): Result<Boolean>
+
+    suspend fun canSendStateEvent(type: StateEventType): Result<Boolean>
+
+    suspend fun updateAvatar(mimeType: String, data: ByteArray): Result<Unit>
+
+    suspend fun removeAvatar(): Result<Unit>
+
+    suspend fun setName(name: String): Result<Unit>
+
+    suspend fun setTopic(topic: String): Result<Unit>
 }

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/StateEventType.kt

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.matrix.api.room
+
+enum class StateEventType {
+    POLICY_RULE_ROOM,
+    POLICY_RULE_SERVER,
+    POLICY_RULE_USER,
+    ROOM_ALIASES,
+    ROOM_AVATAR,
+    ROOM_CANONICAL_ALIAS,
+    ROOM_CREATE,
+    ROOM_ENCRYPTION,
+    ROOM_GUEST_ACCESS,
+    ROOM_HISTORY_VISIBILITY,
+    ROOM_JOIN_RULES,
+    ROOM_MEMBER_EVENT,
+    ROOM_NAME,
+    ROOM_PINNED_EVENTS,
+    ROOM_POWER_LEVELS,
+    ROOM_SERVER_ACL,
+    ROOM_THIRD_PARTY_INVITE,
+    ROOM_TOMBSTONE,
+    ROOM_TOPIC,
+    SPACE_CHILD,
+    SPACE_PARENT;
+}

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/RustMatrixRoom.kt

@@ -27,12 +27,14 @@ import io.element.android.libraries.matrix.api.media.ImageInfo
 import io.element.android.libraries.matrix.api.media.VideoInfo
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.MatrixRoomMembersState
+import io.element.android.libraries.matrix.api.room.StateEventType
 import io.element.android.libraries.matrix.api.room.roomMembers
 import io.element.android.libraries.matrix.api.timeline.MatrixTimeline
 import io.element.android.libraries.matrix.impl.media.map
 import io.element.android.libraries.matrix.impl.timeline.RustMatrixTimeline
 import io.element.android.services.toolbox.api.systemclock.SystemClock
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.flow.Flow
 import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.flow.StateFlow
@@ -224,6 +226,12 @@ class RustMatrixRoom(
         }
     }
 
+    override suspend fun canSendStateEvent(type: StateEventType): Result<Boolean> = withContext(coroutineDispatchers.io) {
+        runCatching {
+            innerRoom.member(sessionId.value).use { it.canSendState(type.map()) }
+        }
+    }
+
     override suspend fun sendImage(file: File, thumbnailFile: File, imageInfo: ImageInfo): Result<Unit> = withContext(coroutineDispatchers.io) {
         runCatching {
             innerRoom.sendImage(file.path, thumbnailFile.path, imageInfo.map())
@@ -247,4 +255,33 @@ class RustMatrixRoom(
             innerRoom.sendFile(file.path, fileInfo.map())
         }
     }
+
+    @OptIn(ExperimentalUnsignedTypes::class)
+    override suspend fun updateAvatar(mimeType: String, data: ByteArray): Result<Unit> =
+        withContext(Dispatchers.IO) {
+            runCatching {
+                innerRoom.uploadAvatar(mimeType, data.toUByteArray().toList())
+            }
+        }
+
+    override suspend fun removeAvatar(): Result<Unit> =
+        withContext(Dispatchers.IO) {
+            runCatching {
+                innerRoom.removeAvatar()
+            }
+        }
+
+    override suspend fun setName(name: String): Result<Unit> =
+        withContext(Dispatchers.IO) {
+            runCatching {
+                innerRoom.setName(name)
+            }
+        }
+
+    override suspend fun setTopic(topic: String): Result<Unit> =
+        withContext(Dispatchers.IO) {
+            runCatching {
+                innerRoom.setTopic(topic)
+            }
+        }
 }

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/room/StateEventType.kt

@@ -0,0 +1,68 @@
+/*
+ * Copyright (c) 2023 New Vector Ltd
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.element.android.libraries.matrix.impl.room
+
+import io.element.android.libraries.matrix.api.room.StateEventType
+import org.matrix.rustcomponents.sdk.StateEventType as RustStateEventType
+
+fun StateEventType.map(): RustStateEventType = when (this) {
+    StateEventType.POLICY_RULE_ROOM -> RustStateEventType.POLICY_RULE_ROOM
+    StateEventType.POLICY_RULE_SERVER -> RustStateEventType.POLICY_RULE_SERVER
+    StateEventType.POLICY_RULE_USER -> RustStateEventType.POLICY_RULE_USER
+    StateEventType.ROOM_ALIASES -> RustStateEventType.ROOM_ALIASES
+    StateEventType.ROOM_AVATAR -> RustStateEventType.ROOM_AVATAR
+    StateEventType.ROOM_CANONICAL_ALIAS -> RustStateEventType.ROOM_CANONICAL_ALIAS
+    StateEventType.ROOM_CREATE -> RustStateEventType.ROOM_CREATE
+    StateEventType.ROOM_ENCRYPTION -> RustStateEventType.ROOM_ENCRYPTION
+    StateEventType.ROOM_GUEST_ACCESS -> RustStateEventType.ROOM_GUEST_ACCESS
+    StateEventType.ROOM_HISTORY_VISIBILITY -> RustStateEventType.ROOM_HISTORY_VISIBILITY
+    StateEventType.ROOM_JOIN_RULES -> RustStateEventType.ROOM_JOIN_RULES
+    StateEventType.ROOM_MEMBER_EVENT -> RustStateEventType.ROOM_MEMBER_EVENT
+    StateEventType.ROOM_NAME -> RustStateEventType.ROOM_NAME
+    StateEventType.ROOM_PINNED_EVENTS -> RustStateEventType.ROOM_PINNED_EVENTS
+    StateEventType.ROOM_POWER_LEVELS -> RustStateEventType.ROOM_POWER_LEVELS
+    StateEventType.ROOM_SERVER_ACL -> RustStateEventType.ROOM_SERVER_ACL
+    StateEventType.ROOM_THIRD_PARTY_INVITE -> RustStateEventType.ROOM_THIRD_PARTY_INVITE
+    StateEventType.ROOM_TOMBSTONE -> RustStateEventType.ROOM_TOMBSTONE
+    StateEventType.ROOM_TOPIC -> RustStateEventType.ROOM_TOPIC
+    StateEventType.SPACE_CHILD -> RustStateEventType.SPACE_CHILD
+    StateEventType.SPACE_PARENT -> RustStateEventType.SPACE_PARENT
+}
+
+fun RustStateEventType.map(): StateEventType = when (this) {
+    RustStateEventType.POLICY_RULE_ROOM -> StateEventType.POLICY_RULE_ROOM
+    RustStateEventType.POLICY_RULE_SERVER -> StateEventType.POLICY_RULE_SERVER
+    RustStateEventType.POLICY_RULE_USER -> StateEventType.POLICY_RULE_USER
+    RustStateEventType.ROOM_ALIASES -> StateEventType.ROOM_ALIASES
+    RustStateEventType.ROOM_AVATAR -> StateEventType.ROOM_AVATAR
+    RustStateEventType.ROOM_CANONICAL_ALIAS -> StateEventType.ROOM_CANONICAL_ALIAS
+    RustStateEventType.ROOM_CREATE -> StateEventType.ROOM_CREATE
+    RustStateEventType.ROOM_ENCRYPTION -> StateEventType.ROOM_ENCRYPTION
+    RustStateEventType.ROOM_GUEST_ACCESS -> StateEventType.ROOM_GUEST_ACCESS
+    RustStateEventType.ROOM_HISTORY_VISIBILITY -> StateEventType.ROOM_HISTORY_VISIBILITY
+    RustStateEventType.ROOM_JOIN_RULES -> StateEventType.ROOM_JOIN_RULES
+    RustStateEventType.ROOM_MEMBER_EVENT -> StateEventType.ROOM_MEMBER_EVENT
+    RustStateEventType.ROOM_NAME -> StateEventType.ROOM_NAME
+    RustStateEventType.ROOM_PINNED_EVENTS -> StateEventType.ROOM_PINNED_EVENTS
+    RustStateEventType.ROOM_POWER_LEVELS -> StateEventType.ROOM_POWER_LEVELS
+    RustStateEventType.ROOM_SERVER_ACL -> StateEventType.ROOM_SERVER_ACL
+    RustStateEventType.ROOM_THIRD_PARTY_INVITE -> StateEventType.ROOM_THIRD_PARTY_INVITE
+    RustStateEventType.ROOM_TOMBSTONE -> StateEventType.ROOM_TOMBSTONE
+    RustStateEventType.ROOM_TOPIC -> StateEventType.ROOM_TOPIC
+    RustStateEventType.SPACE_CHILD -> StateEventType.SPACE_CHILD
+    RustStateEventType.SPACE_PARENT -> StateEventType.SPACE_PARENT
+}

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/room/FakeMatrixRoom.kt

@@ -26,6 +26,7 @@ import io.element.android.libraries.matrix.api.media.ImageInfo
 import io.element.android.libraries.matrix.api.media.VideoInfo
 import io.element.android.libraries.matrix.api.room.MatrixRoom
 import io.element.android.libraries.matrix.api.room.MatrixRoomMembersState
+import io.element.android.libraries.matrix.api.room.StateEventType
 import io.element.android.libraries.matrix.api.timeline.MatrixTimeline
 import io.element.android.libraries.matrix.test.A_ROOM_ID
 import io.element.android.libraries.matrix.test.A_SESSION_ID
@@ -62,7 +63,13 @@ class FakeMatrixRoom(
     private var rejectInviteResult = Result.success(Unit)
     private var inviteUserResult = Result.success(Unit)
     private var canInviteResult = Result.success(true)
+    private val canSendStateResults = mutableMapOf<StateEventType, Result<Boolean>>()
     private var sendMediaResult = Result.success(Unit)
+    private var setNameResult = Result.success(Unit)
+    private var setTopicResult = Result.success(Unit)
+    private var updateAvatarResult = Result.success(Unit)
+    private var removeAvatarResult = Result.success(Unit)
+
     var sendMediaCount = 0
         private set
 
@@ -75,6 +82,18 @@ class FakeMatrixRoom(
     var invitedUserId: UserId? = null
         private set
 
+    var newTopic: String? = null
+        private set
+
+    var newName: String? = null
+        private set
+
+    var newAvatarData: ByteArray? = null
+        private set
+
+    var removedAvatar: Boolean = false
+        private set
+
     private var leaveRoomError: Throwable? = null
 
     override val membersStateFlow: MutableStateFlow<MatrixRoomMembersState> = MutableStateFlow(MatrixRoomMembersState.Unknown)
@@ -151,6 +170,10 @@ class FakeMatrixRoom(
         return canInviteResult
     }
 
+    override suspend fun canSendStateEvent(type: StateEventType): Result<Boolean> {
+        return canSendStateResults[type] ?: Result.failure(IllegalStateException("No fake answer"))
+    }
+
     override suspend fun sendImage(file: File, thumbnailFile: File, imageInfo: ImageInfo): Result<Unit> = fakeSendMedia()
 
     override suspend fun sendVideo(file: File, thumbnailFile: File, videoInfo: VideoInfo): Result<Unit> = fakeSendMedia()
@@ -166,6 +189,26 @@ class FakeMatrixRoom(
         }
     }
 
+    override suspend fun updateAvatar(mimeType: String, data: ByteArray): Result<Unit> {
+        newAvatarData = data
+        return updateAvatarResult
+    }
+
+    override suspend fun removeAvatar(): Result<Unit> {
+        removedAvatar = true
+        return removeAvatarResult
+    }
+
+    override suspend fun setName(name: String): Result<Unit> {
+        newName = name
+        return setNameResult
+    }
+
+    override suspend fun setTopic(topic: String): Result<Unit> {
+        newTopic = topic
+        return setTopicResult
+    }
+
     override fun close() = Unit
 
     fun givenLeaveRoomError(throwable: Throwable?) {
@@ -204,6 +247,10 @@ class FakeMatrixRoom(
         canInviteResult = result
     }
 
+    fun givenCanSendStateResult(type: StateEventType, result: Result<Boolean>) {
+        canSendStateResults[type] = result
+    }
+
     fun givenIgnoreResult(result: Result<Unit>) {
         ignoreResult = result
     }
@@ -215,4 +262,20 @@ class FakeMatrixRoom(
     fun givenSendMediaResult(result: Result<Unit>) {
         sendMediaResult = result
     }
+
+    fun givenUpdateAvatarResult(result: Result<Unit>) {
+        updateAvatarResult = result
+    }
+
+    fun givenRemoveAvatarResult(result: Result<Unit>) {
+        removeAvatarResult = result
+    }
+
+    fun givenSetNameResult(result: Result<Unit>) {
+        setNameResult = result
+    }
+
+    fun givenSetTopicResult(result: Result<Unit>) {
+        setTopicResult = result
+    }
 }