SP3.1: Update room settings for Spaces element-ios#5231

- Changed the Room Settings screen according to the new design
- Implemented the room access flow
- Added room upgrade support
- Implemented the room suggestion screen

RiotSwiftUI/Modules/Room/RoomSuggestion/Coordinator/RoomSuggestionCoordinator.swift

@@ -0,0 +1,115 @@
+/*
+ Copyright 2021 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 UIKit
+
+/// Actions returned by the coordinator callback
+enum RoomSuggestionCoordinatorCoordinatorAction {
+    case done
+    case cancel
+}
+
+@objcMembers
+final class RoomSuggestionCoordinator: Coordinator {
+    
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    private let parameters: RoomSuggestionCoordinatorParameters
+    
+    private var navigationRouter: NavigationRouterType {
+        return self.parameters.navigationRouter
+    }
+    
+    // MARK: Public
+    
+    // Must be used only internally
+    var childCoordinators: [Coordinator] = []
+    
+    var callback: ((RoomSuggestionCoordinatorCoordinatorAction) -> Void)?
+    
+    // MARK: - Setup
+    
+    init(parameters: RoomSuggestionCoordinatorParameters) {
+        self.parameters = parameters
+    }    
+    
+    // MARK: - Public
+    
+    
+    func start() {
+        if #available(iOS 14.0, *) {
+            MXLog.debug("[RoomAccessCoordinator] did start.")
+            let rootCoordinator = self.createRoomSuggestionSpaceChooser()
+            rootCoordinator.start()
+            
+            self.add(childCoordinator: rootCoordinator)
+            
+            if self.navigationRouter.modules.isEmpty == false {
+                self.navigationRouter.push(rootCoordinator, animated: true, popCompletion: { [weak self] in
+                    self?.remove(childCoordinator: rootCoordinator)
+                })
+            } else {
+                self.navigationRouter.setRootModule(rootCoordinator) { [weak self] in
+                    self?.remove(childCoordinator: rootCoordinator)
+                }
+            }
+        }
+    }
+    
+    func toPresentable() -> UIViewController {
+        return self.navigationRouter.toPresentable()
+    }
+    
+    // MARK: - Private
+    
+    @available(iOS 14.0, *)
+    func pushScreen(with coordinator: Coordinator & Presentable) {
+        add(childCoordinator: coordinator)
+        
+        self.navigationRouter.push(coordinator, animated: true, popCompletion: { [weak self] in
+            self?.remove(childCoordinator: coordinator)
+        })
+        
+        coordinator.start()
+    }
+    
+    @available(iOS 14.0, *)
+    private func createRoomSuggestionSpaceChooser() -> MatrixItemChooserCoordinator {
+        let paramaters = MatrixItemChooserCoordinatorParameters(
+            session: parameters.room.mxSession,
+            title: VectorL10n.roomSuggestionSettingsScreenTitle,
+            detail: VectorL10n.roomSuggestionSettingsScreenMessage,
+            viewProvider: RoomSuggestionSpaceChooserViewProvider(navTitle: VectorL10n.roomAccessSettingsScreenNavTitle),
+            itemsProcessor: RoomSuggestionSpaceChooserItemsProcessor(roomId: parameters.room.roomId, session: parameters.room.mxSession))
+        let coordinator = MatrixItemChooserCoordinator(parameters: paramaters)
+        coordinator.completion = { [weak self] result in
+            guard let self = self else { return }
+            
+            switch result {
+            case .back:
+                self.navigationRouter.popModule(animated: true)
+            case .cancel:
+                self.callback?(.cancel)
+            case .done:
+                self.callback?(.done)
+            }
+        }
+        return coordinator
+    }
+
+}

RiotSwiftUI/Modules/Room/RoomSuggestion/Coordinator/RoomSuggestionCoordinatorBridgePresenter.swift

@@ -0,0 +1,94 @@
+//
+// Copyright 2021 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 UIKit
+
+@objc protocol RoomSuggestionCoordinatorBridgePresenterDelegate {
+    func roomSuggestionCoordinatorBridgePresenterDelegateDidCancel(_ coordinatorBridgePresenter: RoomSuggestionCoordinatorBridgePresenter)
+    func roomSuggestionCoordinatorBridgePresenterDelegateDidComplete(_ coordinatorBridgePresenter: RoomSuggestionCoordinatorBridgePresenter)
+}
+
+/// RoomSuggestionCoordinatorBridgePresenter enables to start RoomSuggestionCoordinator from a view controller.
+/// This bridge is used while waiting for global usage of coordinator pattern.
+/// It breaks the Coordinator abstraction and it has been introduced for Objective-C compatibility (mainly for integration in legacy view controllers).
+/// Each bridge should be removed once the underlying Coordinator has been integrated by another Coordinator.
+@objcMembers
+final class RoomSuggestionCoordinatorBridgePresenter: NSObject {
+    
+    // MARK: - Properties
+    
+    // MARK: Private
+    
+    private let room: MXRoom
+    private var coordinator: RoomSuggestionCoordinator?
+    
+    // MARK: Public
+    
+    weak var delegate: RoomSuggestionCoordinatorBridgePresenterDelegate?
+    
+    // MARK: - Setup
+    
+    init(room: MXRoom) {
+        self.room = room
+        super.init()
+    }
+    
+    // MARK: - Public
+    
+    func present(from viewController: UIViewController, animated: Bool) {
+        let navigationRouter = NavigationRouter()
+        let coordinator = RoomSuggestionCoordinator(parameters: RoomSuggestionCoordinatorParameters(room: room, navigationRouter: navigationRouter))
+        coordinator.callback = { [weak self] result in
+            guard let self = self else { return }
+            
+            switch result {
+            case .cancel:
+                self.delegate?.roomSuggestionCoordinatorBridgePresenterDelegateDidCancel(self)
+            case .done:
+                self.delegate?.roomSuggestionCoordinatorBridgePresenterDelegateDidComplete(self)
+            }
+        }
+        let presentable = coordinator.toPresentable()
+        presentable.presentationController?.delegate = self
+        navigationRouter.setRootModule(presentable)
+        viewController.present(navigationRouter.toPresentable(), animated: animated, completion: nil)
+        coordinator.start()
+        
+        self.coordinator = coordinator
+    }
+    
+    func dismiss(animated: Bool, completion: (() -> Void)?) {
+        guard let coordinator = self.coordinator else {
+            return
+        }
+        coordinator.toPresentable().dismiss(animated: animated) {
+            self.coordinator = nil
+
+            if let completion = completion {
+                completion()
+            }
+        }
+    }
+}
+
+// MARK: - UIAdaptivePresentationControllerDelegate
+
+extension RoomSuggestionCoordinatorBridgePresenter: UIAdaptivePresentationControllerDelegate {
+    
+    func roomNotificationSettingsCoordinatorDidComplete(_ presentationController: UIPresentationController) {
+        self.delegate?.roomSuggestionCoordinatorBridgePresenterDelegateDidCancel(self)
+    }
+    
+}

RiotSwiftUI/Modules/Room/RoomSuggestion/Coordinator/RoomSuggestionCoordinatorParameters.swift

@@ -0,0 +1,33 @@
+/*
+ Copyright 2021 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
+
+/// RoomSuggestionCoordinator input parameters
+struct RoomSuggestionCoordinatorParameters {
+    
+    /// The Matrix room
+    let room: MXRoom
+                
+    /// The navigation router that manage physical navigation
+    let navigationRouter: NavigationRouterType
+    
+    init(room: MXRoom,
+         navigationRouter: NavigationRouterType? = nil) {
+        self.room = room
+        self.navigationRouter = navigationRouter ?? NavigationRouter(navigationController: RiotNavigationController())
+    }
+}

RiotSwiftUI/Modules/Room/RoomSuggestion/RoomSuggestionSpaceChooser/Coordinator/RoomSuggestionSpaceChooserViewProvider.swift

@@ -0,0 +1,31 @@
+// 
+// Copyright 2021 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 SwiftUI
+
+class RoomSuggestionSpaceChooserViewProvider: MatrixItemChooserCoordinatorViewProvider {
+    
+    private let navTitle: String?
+    
+    init(navTitle: String?) {
+        self.navTitle = navTitle
+    }
+    
+    @available(iOS 14, *)
+    func view(with viewModel: MatrixItemChooserViewModelType.Context) -> AnyView {
+        return AnyView(RoomSuggestionSpaceChooserSelector(viewModel: viewModel, navTitle: navTitle))
+    }
+}

RiotSwiftUI/Modules/Room/RoomSuggestion/RoomSuggestionSpaceChooser/Service/RoomSuggestionSpaceChooserItemsProcessor.swift

@@ -0,0 +1,124 @@
+// 
+// Copyright 2021 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
+
+/// RoomSuggestionSpaceChooserItemsProcessor operation error
+public enum RoomSuggestionSpaceChooserItemsProcessorError: Int, Error {
+    case parentNotFound
+}
+
+class RoomSuggestionSpaceChooserItemsProcessor: MatrixItemChooserProcessorProtocol {
+    
+    // MARK: Private
+    
+    private let roomId: String
+    private let session: MXSession
+    private var computationErrorList: [Error] = []
+    private var didBuildSpaceGraphObserver: Any?
+
+    // MARK: Setup
+    
+    init(roomId: String, session: MXSession) {
+        self.roomId = roomId
+        self.session = session
+        self.dataSource = MatrixItemChooserRoomDirectParentsDataSource(roomId: roomId, preselectionMode: .suggestedRoom)
+    }
+    
+    deinit {
+        if let observer = self.didBuildSpaceGraphObserver {
+            NotificationCenter.default.removeObserver(observer)
+        }
+    }
+    // MARK: MatrixItemChooserSelectionProcessorProtocol
+    
+    private(set) var dataSource: MatrixItemChooserDataSource
+    
+    var loadingText: String? { nil }
+    
+    func computeSelection(withIds itemsIds: [String], completion: @escaping (Result<Void, Error>) -> Void) {
+        let unselectedItems: [String]
+        let selectedItems: [String]
+        if let preselectedItems = dataSource.preselectedItemIds {
+            unselectedItems = preselectedItems.compactMap({ itemId in
+                return !itemsIds.contains(itemId) ? itemId : nil
+            })
+            selectedItems = itemsIds.compactMap { itemId in
+                return !preselectedItems.contains(itemId) ? itemId : nil
+            }
+        } else {
+            unselectedItems = []
+            selectedItems = itemsIds
+        }
+        
+        computationErrorList = []
+        
+        guard !unselectedItems.isEmpty || !selectedItems.isEmpty else {
+            completion(.success(()))
+            return
+        }
+        
+        setRoom(suggested: false, forParentsWithId: unselectedItems) { [weak self] in
+            self?.setRoom(suggested: true, forParentsWithId: selectedItems, completion: { [weak self] in
+                guard let self = self else { return }
+                
+                if let firstError = self.computationErrorList.first {
+                    completion(.failure(firstError))
+                } else {
+                    self.didBuildSpaceGraphObserver = NotificationCenter.default.addObserver(forName: MXSpaceService.didBuildSpaceGraph, object: nil, queue: OperationQueue.main) { [weak self] notification in
+                        guard let self = self else { return }
+                        
+                        if let observer = self.didBuildSpaceGraphObserver {
+                            NotificationCenter.default.removeObserver(observer)
+                            self.didBuildSpaceGraphObserver = nil
+                        }
+                        
+                        completion(.success(()))
+                    }
+                }
+            })
+        }
+    }
+    
+    func isItemIncluded(_ item: (MatrixListItemData)) -> Bool {
+        return true
+    }
+    
+    // MARK: - Private
+    
+    private func setRoom(suggested: Bool, forParentsWithId parentIds: [String], at index: Int = 0, completion: @escaping () -> Void) {
+        guard index < parentIds.count else {
+            completion()
+            return
+        }
+        
+        guard let space = session.spaceService.getSpace(withId: parentIds[index]) else {
+            computationErrorList.append(RoomSuggestionSpaceChooserItemsProcessorError.parentNotFound)
+            setRoom(suggested: suggested, forParentsWithId: parentIds, at: index + 1, completion: completion)
+            return
+        }
+        
+        space.setChild(withRoomId: roomId, suggested: suggested) { [weak self] response in
+            guard let self = self else { return }
+            
+            if let error = response.error {
+                self.computationErrorList.append(error)
+            }
+            
+            self.setRoom(suggested: suggested, forParentsWithId: parentIds, at: index + 1, completion: completion)
+        }
+    }
+}

RiotSwiftUI/Modules/Room/RoomSuggestion/RoomSuggestionSpaceChooser/View/RoomSuggestionSpaceChooserSelector.swift

@@ -0,0 +1,53 @@
+// 
+// Copyright 2021 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 SwiftUI
+
+@available(iOS 14.0, *)
+struct RoomSuggestionSpaceChooserSelector: View {
+    
+    // MARK: Properties
+    
+    @ObservedObject var viewModel: MatrixItemChooserViewModel.Context
+    let navTitle: String?
+    
+    // MARK: Private
+    
+    @Environment(\.theme) private var theme: ThemeSwiftUI
+
+    @ViewBuilder
+    var body: some View {
+        MatrixItemChooser(viewModel: viewModel)
+            .background(theme.colors.background)
+            .navigationTitle(VectorL10n.roomSuggestionSettingsScreenNavTitle)
+            .navigationBarBackButtonHidden(true)
+            .toolbar {
+                ToolbarItem(placement: .cancellationAction) {
+                    Button(VectorL10n.cancel) {
+                        viewModel.send(viewAction: .cancel)
+                    }
+                    .disabled(viewModel.viewState.loading)
+                }
+                ToolbarItem(placement: .confirmationAction) {
+                    Button(VectorL10n.done) {
+                        viewModel.send(viewAction: .done)
+                    }
+                    .disabled(viewModel.viewState.loading)
+                }
+            }
+    }
+
+}