Add support for Apple context menus in matrix items list screens (#5963)

Riot/Modules/ContextMenu/ViewModels/PublicRoomContextPreviewViewModel.swift

@@ -0,0 +1,59 @@
+// 
+// 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
+
+/// `PublicRoomContextPreviewViewModel` provides the data to the `RoomContextPreviewViewController` from an instance of `MXPublicRoom`
+class PublicRoomContextPreviewViewModel: RoomContextPreviewViewModelProtocol {
+    
+    // MARK: - Properties
+    
+    private let publicRoom: MXPublicRoom
+    weak var viewDelegate: RoomContextPreviewViewModelViewDelegate?
+    
+    // MARK: - Setup
+    
+    init(publicRoom: MXPublicRoom) {
+        self.publicRoom = publicRoom
+    }
+    
+    // MARK: - RoomContextPreviewViewModelProtocol
+    
+    func process(viewAction: RoomContextPreviewViewAction) {
+        switch viewAction {
+        case .loadData:
+            self.loadData()
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func loadData() {
+        let mapper = MXRoomTypeMapper(defaultRoomType: .room)
+        let parameters = RoomContextPreviewLoadedParameters(
+            roomId: publicRoom.roomId,
+            roomType: mapper.roomType(from: publicRoom.roomTypeString),
+            displayName: publicRoom.name,
+            topic: publicRoom.topic,
+            avatarUrl: publicRoom.avatarUrl,
+            joinRule: .none,
+            membership: .unknown,
+            inviterId: nil,
+            inviter: nil,
+            membersCount: publicRoom.numJoinedMembers)
+        self.viewDelegate?.roomContextPreviewViewModel(self, didUpdateViewState: .loaded(parameters))
+    }
+}

Riot/Modules/ContextMenu/ViewModels/RoomContextPreviewViewModel.swift

@@ -0,0 +1,91 @@
+// 
+// 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
+
+/// `RoomContextPreviewViewModel` provides the data to the `RoomContextPreviewViewController` from an instance of `MXRoom`
+class RoomContextPreviewViewModel: RoomContextPreviewViewModelProtocol {
+    
+    // MARK: - Properties
+    
+    private let room: MXRoom
+    weak var viewDelegate: RoomContextPreviewViewModelViewDelegate?
+    
+    // MARK: - Setup
+    
+    init(room: MXRoom) {
+        self.room = room
+    }
+    
+    // MARK: - RoomContextPreviewViewModelProtocol
+    
+    func process(viewAction: RoomContextPreviewViewAction) {
+        switch viewAction {
+        case .loadData:
+            self.loadData()
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func loadData() {
+        let parameters = RoomContextPreviewLoadedParameters(
+            roomId: self.room.roomId,
+            roomType: self.room.summary?.roomType ?? .none,
+            displayName: self.room.displayName,
+            topic: self.room.summary?.topic,
+            avatarUrl: self.room.summary?.avatar,
+            joinRule: .public,
+            membership: self.room.summary?.membership ?? .unknown,
+            inviterId: nil,
+            inviter: nil,
+            membersCount: 0)
+        self.viewDelegate?.roomContextPreviewViewModel(self, didUpdateViewState: .loaded(parameters))
+
+        room.state { roomState in
+            let membersCount = roomState?.members.joinedMembers.count ?? 0
+
+            var inviteEvent: MXEvent?
+            roomState?.stateEvents.forEach({ event in
+                guard let membership = event.wireContent["membership"] as? String, membership == "invite", event.stateKey == self.room.mxSession.myUserId else {
+                    return
+                }
+
+                inviteEvent = event
+            })
+            
+            let inviter: MXUser?
+            if let inviterId = inviteEvent?.sender {
+                inviter = self.room.mxSession.user(withUserId: inviterId)
+            } else {
+                inviter = nil
+            }
+            
+            let parameters = RoomContextPreviewLoadedParameters(
+                roomId: self.room.roomId,
+                roomType: self.room.summary?.roomType ?? .none,
+                displayName: self.room.displayName,
+                topic: roomState?.topic,
+                avatarUrl: roomState?.avatar,
+                joinRule: roomState?.joinRule,
+                membership: self.room.summary?.membership ?? .unknown,
+                inviterId: inviteEvent?.sender,
+                inviter: inviter,
+                membersCount: membersCount)
+            self.viewDelegate?.roomContextPreviewViewModel(self, didUpdateViewState: .loaded(parameters))
+        }
+    }
+}

Riot/Modules/ContextMenu/ViewModels/RoomContextPreviewViewModels.swift

@@ -0,0 +1,52 @@
+// 
+// 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
+
+/// All the data potentially loaded by the `RoomContextPreviewViewModelProtocol` to the `RoomContextPreviewViewController`
+struct RoomContextPreviewLoadedParameters {
+    let roomId: String
+    let roomType: MXRoomType
+    let displayName: String?
+    let topic: String?
+    let avatarUrl: String?
+    let joinRule: MXRoomJoinRule?
+    let membership: MXMembership
+    let inviterId: String?
+    let inviter: MXUser?
+    let membersCount: Int
+}
+
+/// `RoomContextPreviewViewController` view state
+enum RoomContextPreviewViewState {
+    case loaded(_ paremeters: RoomContextPreviewLoadedParameters)
+}
+
+/// `RoomContextPreviewViewController` view action
+enum RoomContextPreviewViewAction {
+    case loadData
+}
+
+/// View delegate for `RoomContextPreviewViewModelProtocol`
+protocol RoomContextPreviewViewModelViewDelegate: AnyObject {
+    func roomContextPreviewViewModel(_ viewModel: RoomContextPreviewViewModelProtocol, didUpdateViewState viewSate: RoomContextPreviewViewState)
+}
+
+/// Classes compliant with `RoomContextPreviewViewModelProtocol` are meant to provide the data to the `RoomContextPreviewViewController`
+protocol RoomContextPreviewViewModelProtocol {
+    var viewDelegate: RoomContextPreviewViewModelViewDelegate? { get set }
+    func process(viewAction: RoomContextPreviewViewAction)
+}

Riot/Modules/ContextMenu/ViewModels/SpaceChildContextPreviewViewModel.swift

@@ -0,0 +1,58 @@
+// 
+// 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
+
+/// `SpaceChildContextPreviewViewModel` provides the data to the `RoomContextPreviewViewController` from an instance of `MXSpaceChildInfo`
+class SpaceChildContextPreviewViewModel: RoomContextPreviewViewModelProtocol {
+    
+    // MARK: - Properties
+    
+    private let childInfo: MXSpaceChildInfo
+    weak var viewDelegate: RoomContextPreviewViewModelViewDelegate?
+    
+    // MARK: - Setup
+    
+    init(childInfo: MXSpaceChildInfo) {
+        self.childInfo = childInfo
+    }
+    
+    // MARK: - RoomContextPreviewViewModelProtocol
+    
+    func process(viewAction: RoomContextPreviewViewAction) {
+        switch viewAction {
+        case .loadData:
+            self.loadData()
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func loadData() {
+        let parameters = RoomContextPreviewLoadedParameters(
+            roomId: childInfo.childRoomId,
+            roomType: childInfo.roomType,
+            displayName: childInfo.displayName,
+            topic: childInfo.topic,
+            avatarUrl: childInfo.avatarUrl,
+            joinRule: .none,
+            membership: .unknown,
+            inviterId: nil,
+            inviter: nil,
+            membersCount: childInfo.activeMemberCount)
+        self.viewDelegate?.roomContextPreviewViewModel(self, didUpdateViewState: .loaded(parameters))
+    }
+}