Add RoomChangePermissionsScreen (#2513)

2026-11-03 16:10:20 +00:00 · 2024-03-01 16:11:22 +00:00
parent ce667eab13
commit bd15190b23
19 changed files with 919 additions and 99 deletions
@@ -0,0 +1,68 @@
+//
+// Copyright 2022 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.
+//
+
+// periphery:ignore:all - this is just a roomChangePermissions remove this comment once generating the final file
+
+import Combine
+import SwiftUI
+
+struct RoomChangePermissionsScreenCoordinatorParameters {
+    let permissions: RoomPermissions
+    let permissionsGroup: RoomRolesAndPermissionsScreenPermissionsGroup
+    let roomProxy: RoomProxyProtocol
+    let userIndicatorController: UserIndicatorControllerProtocol
+}
+
+enum RoomChangePermissionsScreenCoordinatorAction {
+    case cancel
+}
+
+final class RoomChangePermissionsScreenCoordinator: CoordinatorProtocol {
+    private let parameters: RoomChangePermissionsScreenCoordinatorParameters
+    private var viewModel: RoomChangePermissionsScreenViewModelProtocol
+    private let actionsSubject: PassthroughSubject<RoomChangePermissionsScreenCoordinatorAction, Never> = .init()
+    private var cancellables = Set<AnyCancellable>()
+    
+    var actions: AnyPublisher<RoomChangePermissionsScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: RoomChangePermissionsScreenCoordinatorParameters) {
+        self.parameters = parameters
+        
+        viewModel = RoomChangePermissionsScreenViewModel(currentPermissions: parameters.permissions,
+                                                         group: parameters.permissionsGroup,
+                                                         roomProxy: parameters.roomProxy,
+                                                         userIndicatorController: parameters.userIndicatorController)
+    }
+    
+    func start() {
+        viewModel.actions.sink { [weak self] action in
+            MXLog.info("Coordinator: received view model action: \(action)")
+            
+            guard let self else { return }
+            switch action {
+            case .cancel:
+                actionsSubject.send(.cancel)
+            }
+        }
+        .store(in: &cancellables)
+    }
+        
+    func toPresentable() -> AnyView {
+        AnyView(RoomChangePermissionsScreen(context: viewModel.context))
+    }
+}
@@ -0,0 +1,105 @@
+//
+// Copyright 2022 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.
+//
+
+import Foundation
+import MatrixRustSDK
+
+enum RoomChangePermissionsScreenViewModelAction {
+    case cancel
+}
+
+struct RoomChangePermissionsScreenViewState: BindableState {
+    /// The screen's title.
+    let title: String
+    /// The current permissions that are set on the room.
+    var currentPermissions: RoomPermissions
+    
+    var bindings: RoomChangePermissionsScreenViewStateBindings
+    
+    /// Whether or not there are and changes to be saved.
+    var hasChanges: Bool {
+        bindings.settings.contains { currentPermissions[keyPath: $0.keyPath] ?? RoomPermissions.defaultValue(for: $0.keyPath) != $0.value }
+    }
+}
+
+struct RoomChangePermissionsScreenViewStateBindings: BindableState {
+    /// All of the settings shown for this screen.
+    var settings: [RoomPermissionsSetting]
+    /// Information about the currently displayed alert.
+    var alertInfo: AlertInfo<RoomChangePermissionsScreenAlertType>?
+}
+
+enum RoomChangePermissionsScreenAlertType {
+    /// The generic error message.
+    case generic
+}
+
+enum RoomChangePermissionsScreenViewAction {
+    /// Save the permissions.
+    case save
+}
+
+extension RoomChangePermissionsScreenViewState {
+    /// Creates a view state for a particular group of permissions.
+    /// - Parameters:
+    ///   - currentPermissions: The current permissions for the room.
+    ///   - group: The group of permissions that should be shown in the screen.
+    init(currentPermissions: RoomPermissions, group: RoomRolesAndPermissionsScreenPermissionsGroup) {
+        switch group {
+        case .roomDetails:
+            let settings = [
+                RoomPermissionsSetting(keyPath: \.roomName,
+                                       value: currentPermissions.roomName ?? RoomPermissions.defaultValue(for: \.roomName),
+                                       title: L10n.screenRoomChangePermissionsRoomName),
+                RoomPermissionsSetting(keyPath: \.roomAvatar,
+                                       value: currentPermissions.roomAvatar ?? RoomPermissions.defaultValue(for: \.roomAvatar),
+                                       title: L10n.screenRoomChangePermissionsRoomAvatar),
+                RoomPermissionsSetting(keyPath: \.roomTopic,
+                                       value: currentPermissions.roomTopic ?? RoomPermissions.defaultValue(for: \.roomTopic),
+                                       title: L10n.screenRoomChangePermissionsRoomTopic)
+            ]
+            
+            self.init(title: L10n.screenRoomChangePermissionsRoomDetails, currentPermissions: currentPermissions, bindings: .init(settings: settings))
+        
+        case .messagesAndContent:
+            let settings = [
+                RoomPermissionsSetting(keyPath: \.eventsDefault,
+                                       value: currentPermissions.eventsDefault ?? RoomPermissions.defaultValue(for: \.eventsDefault),
+                                       title: L10n.screenRoomChangePermissionsSendMessages),
+                RoomPermissionsSetting(keyPath: \.redact,
+                                       value: currentPermissions.redact ?? RoomPermissions.defaultValue(for: \.redact),
+                                       title: L10n.screenRoomChangePermissionsDeleteMessages)
+            ]
+            
+            self.init(title: L10n.screenRoomChangePermissionsMessagesAndContent, currentPermissions: currentPermissions, bindings: .init(settings: settings))
+        
+        case .memberModeration:
+            let settings = [
+                RoomPermissionsSetting(keyPath: \.invite,
+                                       value: currentPermissions.invite ?? RoomPermissions.defaultValue(for: \.invite),
+                                       title: L10n.screenRoomChangePermissionsInvitePeople),
+                RoomPermissionsSetting(keyPath: \.kick,
+                                       value: currentPermissions.kick ?? RoomPermissions.defaultValue(for: \.kick),
+                                       title: L10n.screenRoomChangePermissionsRemovePeople),
+                RoomPermissionsSetting(keyPath: \.ban,
+                                       value: currentPermissions.ban ?? RoomPermissions.defaultValue(for: \.ban),
+                                       title: L10n.screenRoomChangePermissionsBanPeople)
+            ]
+            
+            self.init(title: L10n.screenRoomChangePermissionsMemberModeration, currentPermissions: currentPermissions, bindings: .init(settings: settings))
+        }
+    }
+}
@@ -0,0 +1,101 @@
+//
+// Copyright 2022 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.
+//
+
+import Combine
+import SwiftUI
+
+typealias RoomChangePermissionsScreenViewModelType = StateStoreViewModel<RoomChangePermissionsScreenViewState, RoomChangePermissionsScreenViewAction>
+
+class RoomChangePermissionsScreenViewModel: RoomChangePermissionsScreenViewModelType, RoomChangePermissionsScreenViewModelProtocol {
+    let roomProxy: RoomProxyProtocol
+    let userIndicatorController: UserIndicatorControllerProtocol
+    private var actionsSubject: PassthroughSubject<RoomChangePermissionsScreenViewModelAction, Never> = .init()
+    
+    var actions: AnyPublisher<RoomChangePermissionsScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(currentPermissions: RoomPermissions,
+         group: RoomRolesAndPermissionsScreenPermissionsGroup,
+         roomProxy: RoomProxyProtocol,
+         userIndicatorController: UserIndicatorControllerProtocol) {
+        self.roomProxy = roomProxy
+        self.userIndicatorController = userIndicatorController
+        super.init(initialViewState: .init(currentPermissions: currentPermissions, group: group))
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: RoomChangePermissionsScreenViewAction) {
+        MXLog.info("View model: received view action: \(viewAction)")
+        
+        switch viewAction {
+        case .save:
+            Task { await save() }
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func save() async {
+        guard state.hasChanges else {
+            MXLog.warning("Nothing to save.")
+            return
+        }
+        
+        showLoadingIndicator()
+        
+        defer {
+            hideLoadingIndicator()
+        }
+        
+        var updatedPermissions = RoomPermissions()
+        for setting in state.bindings.settings {
+            updatedPermissions[keyPath: setting.keyPath] = setting.value
+        }
+        
+        switch await roomProxy.applyPowerLevelChanges(updatedPermissions.makePowerLevelChanges()) {
+        case .success:
+            MXLog.info("Success")
+        case .failure:
+            context.alertInfo = AlertInfo(id: .generic)
+            return
+        }
+        
+        switch await roomProxy.currentPowerLevelChanges() {
+        case .success(let powerLevelChanges):
+            state.currentPermissions = .init(powerLevelChanges: powerLevelChanges)
+        case .failure:
+            context.alertInfo = AlertInfo(id: .generic)
+            return
+        }
+    }
+    
+    // MARK: Loading indicator
+    
+    private static let indicatorID = "SavingRoomPermissions"
+    
+    private func showLoadingIndicator() {
+        userIndicatorController.submitIndicator(UserIndicator(id: Self.indicatorID,
+                                                              type: .modal(progress: .indeterminate, interactiveDismissDisabled: true, allowsInteraction: false),
+                                                              title: L10n.commonSaving,
+                                                              persistent: true))
+    }
+    
+    private func hideLoadingIndicator() {
+        userIndicatorController.retractIndicatorWithId(Self.indicatorID)
+    }
+}
@@ -0,0 +1,23 @@
+//
+// Copyright 2022 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.
+//
+
+import Combine
+
+@MainActor
+protocol RoomChangePermissionsScreenViewModelProtocol {
+    var actions: AnyPublisher<RoomChangePermissionsScreenViewModelAction, Never> { get }
+    var context: RoomChangePermissionsScreenViewModelType.Context { get }
+}
@@ -0,0 +1,83 @@
+//
+// Copyright 2022 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.
+//
+
+import Compound
+import SwiftUI
+
+struct RoomChangePermissionsScreen: View {
+    @ObservedObject var context: RoomChangePermissionsScreenViewModel.Context
+    
+    var body: some View {
+        Form {
+            ForEach($context.settings) { $setting in
+                Section {
+                    ListRow(label: .plain(title: setting.title),
+                            kind: .inlinePicker(selection: $setting.value, items: setting.allValues))
+                } header: {
+                    Text(setting.title)
+                        .compoundListSectionHeader()
+                }
+            }
+        }
+        .compoundList()
+        .navigationTitle(context.viewState.title)
+        .navigationBarTitleDisplayMode(.inline)
+        .toolbar { toolbar }
+        .alert(item: $context.alertInfo)
+    }
+    
+    @ToolbarContentBuilder
+    var toolbar: some ToolbarContent {
+        ToolbarItem(placement: .confirmationAction) {
+            Button(L10n.actionSave) {
+                context.send(viewAction: .save)
+            }
+            .disabled(!context.viewState.hasChanges)
+        }
+    }
+}
+
+// MARK: - Previews
+
+struct RoomChangePermissionsScreen_Previews: PreviewProvider, TestablePreview {
+    static let detailsViewModel = makeViewModel(group: .roomDetails)
+    static let messagesViewModel = makeViewModel(group: .messagesAndContent)
+    static let membersViewModel = makeViewModel(group: .memberModeration)
+    
+    static var previews: some View {
+        NavigationStack {
+            RoomChangePermissionsScreen(context: detailsViewModel.context)
+        }
+        .previewDisplayName("Room details")
+        
+        NavigationStack {
+            RoomChangePermissionsScreen(context: messagesViewModel.context)
+        }
+        .previewDisplayName("Messages and Content")
+        
+        NavigationStack {
+            RoomChangePermissionsScreen(context: membersViewModel.context)
+        }
+        .previewDisplayName("Member moderation")
+    }
+    
+    static func makeViewModel(group: RoomRolesAndPermissionsScreenPermissionsGroup) -> RoomChangePermissionsScreenViewModel {
+        RoomChangePermissionsScreenViewModel(currentPermissions: .default,
+                                             group: group,
+                                             roomProxy: RoomProxyMock(with: .init()),
+                                             userIndicatorController: UserIndicatorControllerMock())
+    }
+}