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

2026-05-05 23:47:44 +02:00 · 2022-04-04 20:07:06 +02:00
parent ff78d21755
commit 1adfa904ae
27 changed files with 1577 additions and 376 deletions
@@ -0,0 +1,178 @@
+// 
+// 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
+
+/// `RoomContextActionService` implements all the possible actions for an instance of `MXRoom`
+class RoomContextActionService: NSObject, RoomContextActionServiceProtocol {
+    
+    // MARK: - RoomContextActionServiceProtocol
+
+    private(set) var session: MXSession
+    var roomId: String {
+        return room.roomId
+    }
+    internal weak var delegate: RoomContextActionServiceDelegate?
+
+    // MARK: - Properties
+    
+    private let room: MXRoom
+    private let unownedRoomService: UnownedRoomContextActionService
+    
+    // MARK: - Setup
+    
+    init(room: MXRoom, delegate: RoomContextActionServiceDelegate?) {
+        self.room = room
+        self.delegate = delegate
+        self.isRoomJoined = room.summary?.isJoined ?? false
+        self.roomMembership = room.summary?.membership ?? .unknown
+        self.session = room.mxSession
+        self.unownedRoomService = UnownedRoomContextActionService(roomId: room.roomId, canonicalAlias: room.summary?.aliases?.first, session: self.session, delegate: delegate)
+    }
+    
+    // MARK: - Public
+    
+    let isRoomJoined: Bool
+    let roomMembership: MXMembership
+    
+    var isRoomDirect: Bool {
+        get {
+            return room.isDirect
+        }
+        set {
+            delegate?.roomContextActionService(self, updateActivityIndicator: true)
+            room.setIsDirect(newValue, withUserId: nil) { [weak self] in
+                guard let self = self else { return }
+                self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+            } failure: { [weak self] error in
+                guard let self = self else { return }
+                self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+                
+                // Notify the end user
+                if let userId = self.session.myUserId {
+                    NotificationCenter.default.post(name: NSNotification.Name.mxkError, object: error, userInfo: [kMXKErrorUserIdKey: userId])
+                } else {
+                    NotificationCenter.default.post(name: NSNotification.Name.mxkError, object: error)
+                }
+            }
+        }
+    }
+
+    var isRoomMuted: Bool {
+        get {
+            return room.isMuted || room.isMentionsOnly
+        }
+        set {
+            if BuildSettings.showNotificationsV2 {
+                self.delegate?.roomContextActionService(self, showRoomNotificationSettingsForRoomWithId: room.roomId)
+            } else {
+                self.muteRoomNotifications(newValue)
+            }
+        }
+    }
+    
+    var isRoomFavourite: Bool {
+        get {
+            let currentTag = room.accountData.tags?.values.first
+            return currentTag?.name == kMXRoomTagFavourite
+        }
+        set {
+            self.updateRoom(tag: newValue ? kMXRoomTagFavourite : nil)
+        }
+    }
+    
+    var isRoomLowPriority: Bool {
+        get {
+            let currentTag = room.accountData.tags?.values.first
+            return currentTag?.name == kMXRoomTagLowPriority
+        }
+        set {
+            self.updateRoom(tag: newValue ? kMXRoomTagLowPriority : nil)
+        }
+    }
+    
+    private func muteRoomNotifications(_ isMuted: Bool) {
+        self.delegate?.roomContextActionService(self, updateActivityIndicator: true)
+        if isMuted {
+            room.mentionsOnly { [weak self] in
+                guard let self = self else { return }
+                self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+            }
+        } else {
+            room.allMessages { [weak self] in
+                guard let self = self else { return }
+                self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+            }
+        }
+    }
+    
+    private func updateRoom(tag: String?) {
+        self.delegate?.roomContextActionService(self, updateActivityIndicator: true)
+        room.setRoomTag(tag) {
+            self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+        }
+    }
+    
+    func leaveRoom(promptUser: Bool) {
+        guard promptUser else {
+            self.leaveRoom()
+            return
+        }
+        
+        let title = room.isDirect ? VectorL10n.roomParticipantsLeavePromptTitleForDm : VectorL10n.roomParticipantsLeavePromptTitle
+        let message = room.isDirect ? VectorL10n.roomParticipantsLeavePromptMsgForDm : VectorL10n.roomParticipantsLeavePromptMsg
+        
+        let alertController = UIAlertController(title: title, message: message, preferredStyle: .alert)
+        alertController.addAction(UIAlertAction(title: VectorL10n.cancel, style: .cancel, handler: nil))
+        alertController.addAction(UIAlertAction(title: VectorL10n.leave, style: .default, handler: { action in
+            self.leaveRoom()
+        }))
+        self.delegate?.roomContextActionService(self, presentAlert: alertController)
+    }
+
+    func joinRoom() {
+        unownedRoomService.joinRoom()
+    }
+    
+    private func leaveRoom() {
+        self.delegate?.roomContextActionService(self, updateActivityIndicator: true)
+        // cancel pending uploads/downloads
+        // they are useless by now
+        MXMediaManager.cancelDownloads(inCacheFolder: self.room.roomId)
+        
+        // TODO: GFO cancel pending uploads related to this room
+        
+        MXLog.debug("[RoomContextActionService] leaving room \(self.room.roomId ?? "nil")")
+        
+        self.room.leave { [weak self] response in
+            guard let self = self else { return }
+
+            switch response {
+            case .success:
+                self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+                self.delegate?.roomContextActionServiceDidLeaveRoom(self)
+            case .failure(let error):
+                self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+                // Notify the end user
+                if let userId = self.session.myUserId {
+                    NotificationCenter.default.post(name: NSNotification.Name.mxkError, object: error, userInfo: [kMXKErrorUserIdKey: userId])
+                } else {
+                    NotificationCenter.default.post(name: NSNotification.Name.mxkError, object: error)
+                }
+            }
+        }
+    }
+}
@@ -0,0 +1,32 @@
+// 
+// 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
+
+@objc protocol RoomContextActionServiceDelegate {
+    func roomContextActionService(_ service: RoomContextActionServiceProtocol, updateActivityIndicator isActive: Bool)
+    func roomContextActionService(_ service: RoomContextActionServiceProtocol, presentAlert alertController: UIAlertController)
+    func roomContextActionService(_ service: RoomContextActionServiceProtocol, showRoomNotificationSettingsForRoomWithId roomId: String)
+    func roomContextActionServiceDidJoinRoom(_ service: RoomContextActionServiceProtocol)
+    func roomContextActionServiceDidLeaveRoom(_ service: RoomContextActionServiceProtocol)
+}
+
+/// `RoomContextActionServiceProtocol` classes are meant to be called by a `RoomActionProviderProtocol` instance so it provides the implementation of the menu actions.
+@objc protocol RoomContextActionServiceProtocol {
+    var delegate: RoomContextActionServiceDelegate? { get set }
+    var roomId: String { get }
+    var session: MXSession { get }
+}
@@ -0,0 +1,90 @@
+// 
+// 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
+
+/// `RoomContextActionService` implements all the possible actions for a room not owned by the user (e.g. `MXPublicRoom`, `MXSpaceChildInfo`)
+class UnownedRoomContextActionService: NSObject, RoomContextActionServiceProtocol {
+    
+    // MARK: - RoomContextActionServiceProtocol
+
+    internal let roomId: String
+    internal let session: MXSession
+    internal weak var delegate: RoomContextActionServiceDelegate?
+    
+    // MARK: - Properties
+
+    private let canonicalAlias: String?
+    
+    // MARK: - Setup
+    
+    init(roomId: String, canonicalAlias: String?, session: MXSession, delegate: RoomContextActionServiceDelegate?) {
+        self.roomId = roomId
+        self.canonicalAlias = canonicalAlias
+        self.session = session
+        self.delegate = delegate
+    }
+    
+    // MARK: - Public
+    
+    func joinRoom() {
+        self.delegate?.roomContextActionService(self, updateActivityIndicator: true)
+        if let canonicalAlias = canonicalAlias {
+            self.session.matrixRestClient.resolveRoomAlias(canonicalAlias) { [weak self] (response) in
+                guard let self = self else { return }
+                switch response {
+                case .success(let resolution):
+                    self.joinRoom(withId: resolution.roomId, via: resolution.servers)
+                case .failure(let error):
+                    MXLog.warning("[UnownedRoomContextActionService] joinRoom: failed to resolve room alias due to error \(error).")
+                    self.joinRoom(withId: self.roomId, via: nil)
+                }
+            }
+        } else {
+            MXLog.warning("[UnownedRoomContextActionService] joinRoom: no canonical alias provided.")
+            joinRoom(withId: self.roomId, via: nil)
+        }
+    }
+    
+    // MARK: - Private
+    
+    private func joinRoom(withId roomId: String, via viaServers: [String]?) {
+        self.session.joinRoom(roomId, viaServers: viaServers, withSignUrl: nil) { [weak self] response in
+            guard let self = self else { return }
+            switch response {
+            case .success:
+                self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+                self.delegate?.roomContextActionServiceDidJoinRoom(self)
+            case .failure(let error):
+                self.delegate?.roomContextActionService(self, updateActivityIndicator: false)
+                self.delegate?.roomContextActionService(self, presentAlert: self.roomJoinFailedAlert(with: error))
+            }
+        }
+    }
+    
+    private func roomJoinFailedAlert(with error: Error) -> UIAlertController {
+        var message = (error as NSError).userInfo[NSLocalizedDescriptionKey] as? String
+        if message == "No known servers" {
+            // minging kludge until https://matrix.org/jira/browse/SYN-678 is fixed
+            // 'Error when trying to join an empty room should be more explicit'
+            message = VectorL10n.roomErrorJoinFailedEmptyRoom
+        }
+        
+        let alertController = UIAlertController(title: VectorL10n.roomErrorJoinFailedTitle, message: message, preferredStyle: .alert)
+        alertController.addAction(UIAlertAction(title: VectorL10n.ok, style: .default, handler: nil))
+        return alertController
+    }
+}