Add user suggestions for @room.

Riot.xcodeproj/xcshareddata/xcschemes/Riot.xcscheme

@@ -1,11 +1,10 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
    LastUpgradeVersion = "1200"
-   version = "1.7">
+   version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
-      buildImplicitDependencies = "YES"
-      runPostActionsOnFailure = "NO">
+      buildImplicitDependencies = "YES">
       <BuildActionEntries>
          <BuildActionEntry
             buildForTesting = "YES"
@@ -16,7 +15,7 @@
             <BuildableReference
                BuildableIdentifier = "primary"
                BlueprintIdentifier = "57B13CC4586E9D43ED24DE1E"
-               BuildableName = "Riot.app"
+               BuildableName = "Element.app"
                BlueprintName = "Riot"
                ReferencedContainer = "container:Riot.xcodeproj">
             </BuildableReference>
@@ -35,11 +34,20 @@
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "57B13CC4586E9D43ED24DE1E"
-            BuildableName = "Riot.app"
+            BuildableName = "Element.app"
             BlueprintName = "Riot"
             ReferencedContainer = "container:Riot.xcodeproj">
          </BuildableReference>
       </MacroExpansion>
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "57B13CC4586E9D43ED24DE1E"
+            BuildableName = "Element.app"
+            BlueprintName = "Riot"
+            ReferencedContainer = "container:Riot.xcodeproj">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
          <TestableReference
             skipped = "NO">
@@ -52,17 +60,6 @@
             </BuildableReference>
          </TestableReference>
       </Testables>
-      <CommandLineArguments>
-      </CommandLineArguments>
-      <CodeCoverageTargets>
-         <BuildableReference
-            BuildableIdentifier = "primary"
-            BlueprintIdentifier = "57B13CC4586E9D43ED24DE1E"
-            BuildableName = "Riot.app"
-            BlueprintName = "Riot"
-            ReferencedContainer = "container:Riot.xcodeproj">
-         </BuildableReference>
-      </CodeCoverageTargets>
    </TestAction>
    <LaunchAction
       buildConfiguration = "Debug"
@@ -80,13 +77,11 @@
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "57B13CC4586E9D43ED24DE1E"
-            BuildableName = "Riot.app"
+            BuildableName = "Element.app"
             BlueprintName = "Riot"
             ReferencedContainer = "container:Riot.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
-      <CommandLineArguments>
-      </CommandLineArguments>
    </LaunchAction>
    <ProfileAction
       buildConfiguration = "Release"
@@ -99,13 +94,11 @@
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "57B13CC4586E9D43ED24DE1E"
-            BuildableName = "Riot.app"
+            BuildableName = "Element.app"
             BlueprintName = "Riot"
             ReferencedContainer = "container:Riot.xcodeproj">
          </BuildableReference>
       </BuildableProductRunnable>
-      <CommandLineArguments>
-      </CommandLineArguments>
    </ProfileAction>
    <AnalyzeAction
       buildConfiguration = "Debug">

Riot/Modules/Room/RoomViewController.m

@@ -1089,7 +1089,8 @@ - (void)displayRoom:(MXKRoomDataSource *)dataSource
     _voiceMessageController.roomId = dataSource.roomId;
 
     _userSuggestionCoordinator = [[UserSuggestionCoordinatorBridge alloc] initWithMediaManager:self.roomDataSource.mxSession.mediaManager
-                                                                                          room:dataSource.room];
+                                                                                          room:dataSource.room
+                                                                                        userID:self.roomDataSource.mxSession.myUserId];
     _userSuggestionCoordinator.delegate = self;
 
     [self setupUserSuggestionViewIfNeeded];
@@ -8047,6 +8048,19 @@ - (void)spaceDetailPresenter:(SpaceDetailPresenter *)presenter didJoinSpaceWithI
 - (void)userSuggestionCoordinatorBridge:(UserSuggestionCoordinatorBridge *)coordinator
              didRequestMentionForMember:(MXRoomMember *)member
                             textTrigger:(NSString *)textTrigger
+{
+    [self removeTriggerTextFromComposer:textTrigger];
+    [self mention:member];
+}
+
+- (void)userSuggestionCoordinatorBridgeDidRequestMentionForRoom:(UserSuggestionCoordinatorBridge *)coordinator
+                                                    textTrigger:(NSString *)textTrigger
+{
+    [self removeTriggerTextFromComposer:textTrigger];
+    [self.inputToolbarView pasteText:[UserSuggestionID.room stringByAppendingString:@" "]];
+}
+
+- (void)removeTriggerTextFromComposer:(NSString *)textTrigger
 {
     RoomInputToolbarView *toolbar = (RoomInputToolbarView *)self.inputToolbarView;
     if (toolbar && textTrigger.length) {
@@ -8057,8 +8071,6 @@ - (void)userSuggestionCoordinatorBridge:(UserSuggestionCoordinatorBridge *)coord
                                                                     range:NSMakeRange(0, attributedTextMessage.length)];
         [toolbar setAttributedTextMessage:attributedTextMessage];
     }
-
-    [self mention:member];
 }
 
 - (void)userSuggestionCoordinatorBridge:(UserSuggestionCoordinatorBridge *)coordinator didUpdateViewHeight:(CGFloat)height

RiotSwiftUI/Modules/Room/UserSuggestion/Coordinator/UserSuggestionCoordinator.swift

@@ -21,12 +21,14 @@ import UIKit
 
 protocol UserSuggestionCoordinatorDelegate: AnyObject {
     func userSuggestionCoordinator(_ coordinator: UserSuggestionCoordinator, didRequestMentionForMember member: MXRoomMember, textTrigger: String?)
+    func userSuggestionCoordinatorDidRequestMentionForRoom(_ coordinator: UserSuggestionCoordinator, textTrigger: String?)
     func userSuggestionCoordinator(_ coordinator: UserSuggestionCoordinator, didUpdateViewHeight height: CGFloat)
 }
 
 struct UserSuggestionCoordinatorParameters {
     let mediaManager: MXMediaManager
     let room: MXRoom
+    let userID: String
 }
 
 final class UserSuggestionCoordinator: Coordinator, Presentable {
@@ -56,7 +58,7 @@ final class UserSuggestionCoordinator: Coordinator, Presentable {
     init(parameters: UserSuggestionCoordinatorParameters) {
         self.parameters = parameters
 
-        roomMemberProvider = UserSuggestionCoordinatorRoomMemberProvider(room: parameters.room)
+        roomMemberProvider = UserSuggestionCoordinatorRoomMemberProvider(room: parameters.room, userID: parameters.userID)
         userSuggestionService = UserSuggestionService(roomMemberProvider: roomMemberProvider)
 
         let viewModel = UserSuggestionViewModel(userSuggestionService: userSuggestionService)
@@ -73,6 +75,11 @@ final class UserSuggestionCoordinator: Coordinator, Presentable {
 
             switch result {
             case .selectedItemWithIdentifier(let identifier):
+                if identifier == UserSuggestionID.room {
+                    self.delegate?.userSuggestionCoordinatorDidRequestMentionForRoom(self, textTrigger: self.userSuggestionService.currentTextTrigger)
+                    return
+                }
+
                 guard let member = self.roomMemberProvider.roomMembers.filter({ $0.userId == identifier }).first else {
                     return
                 }
@@ -130,29 +137,44 @@ final class UserSuggestionCoordinator: Coordinator, Presentable {
 
 private class UserSuggestionCoordinatorRoomMemberProvider: RoomMembersProviderProtocol {
     private let room: MXRoom
+    private let userID: String
 
     var roomMembers: [MXRoomMember] = []
+    var canMentionRoom = false
 
-    init(room: MXRoom) {
+    init(room: MXRoom, userID: String) {
         self.room = room
+        self.userID = userID
+        updateWithPowerLevels()
+    }
+
+    /// Gets the power levels for the room to update suggestions accordingly.
+    func updateWithPowerLevels() {
+        room.state { [weak self] state in
+            guard let self, let powerLevels = state?.powerLevels else { return }
+            let userPowerLevel = powerLevels.powerLevelOfUser(withUserID: self.userID)
+            let mentionRoomPowerLevel = powerLevels.minimumPowerLevel(forNotifications: kMXRoomPowerLevelNotificationsRoomKey,
+                                                                      defaultPower: kMXRoomPowerLevelNotificationsRoomDefault)
+            self.canMentionRoom = userPowerLevel >= mentionRoomPowerLevel
+        }
     }
 
     func fetchMembers(_ members: @escaping ([RoomMembersProviderMember]) -> Void) {
-        room.members({ [weak self] roomMembers in
+        room.members { [weak self] roomMembers in
             guard let self = self, let joinedMembers = roomMembers?.joinedMembers else {
                 return
             }
             self.roomMembers = joinedMembers
             members(self.roomMembersToProviderMembers(joinedMembers))
-        }, lazyLoadedMembers: { [weak self] lazyRoomMembers in
+        } lazyLoadedMembers: { [weak self] lazyRoomMembers in
             guard let self = self, let joinedMembers = lazyRoomMembers?.joinedMembers else {
                 return
             }
             self.roomMembers = joinedMembers
             members(self.roomMembersToProviderMembers(joinedMembers))
-        }, failure: { error in
+        } failure: { error in
             MXLog.error("[UserSuggestionCoordinatorRoomMemberProvider] Failed loading room", context: error)
-        })
+        }
     }
 
     private func roomMembersToProviderMembers(_ roomMembers: [MXRoomMember]) -> [RoomMembersProviderMember] {

RiotSwiftUI/Modules/Room/UserSuggestion/Coordinator/UserSuggestionCoordinatorBridge.swift

@@ -19,6 +19,7 @@ import Foundation
 @objc
 protocol UserSuggestionCoordinatorBridgeDelegate: AnyObject {
     func userSuggestionCoordinatorBridge(_ coordinator: UserSuggestionCoordinatorBridge, didRequestMentionForMember member: MXRoomMember, textTrigger: String?)
+    func userSuggestionCoordinatorBridgeDidRequestMentionForRoom(_ coordinator: UserSuggestionCoordinatorBridge, textTrigger: String?)
     func userSuggestionCoordinatorBridge(_ coordinator: UserSuggestionCoordinatorBridge, didUpdateViewHeight height: CGFloat)
 }
 
@@ -31,8 +32,8 @@ final class UserSuggestionCoordinatorBridge: NSObject {
 
     weak var delegate: UserSuggestionCoordinatorBridgeDelegate?
 
-    init(mediaManager: MXMediaManager, room: MXRoom) {
-        let parameters = UserSuggestionCoordinatorParameters(mediaManager: mediaManager, room: room)
+    init(mediaManager: MXMediaManager, room: MXRoom, userID: String) {
+        let parameters = UserSuggestionCoordinatorParameters(mediaManager: mediaManager, room: room, userID: userID)
         let userSuggestionCoordinator = UserSuggestionCoordinator(parameters: parameters)
         _userSuggestionCoordinator = userSuggestionCoordinator
 
@@ -54,6 +55,10 @@ extension UserSuggestionCoordinatorBridge: UserSuggestionCoordinatorDelegate {
     func userSuggestionCoordinator(_ coordinator: UserSuggestionCoordinator, didRequestMentionForMember member: MXRoomMember, textTrigger: String?) {
         delegate?.userSuggestionCoordinatorBridge(self, didRequestMentionForMember: member, textTrigger: textTrigger)
     }
+
+    func userSuggestionCoordinatorDidRequestMentionForRoom(_ coordinator: UserSuggestionCoordinator, textTrigger: String?) {
+        delegate?.userSuggestionCoordinatorBridgeDidRequestMentionForRoom(self, textTrigger: textTrigger)
+    }
 
     func userSuggestionCoordinator(_ coordinator: UserSuggestionCoordinator, didUpdateViewHeight height: CGFloat) {
         delegate?.userSuggestionCoordinatorBridge(self, didUpdateViewHeight: height)

RiotSwiftUI/Modules/Room/UserSuggestion/Service/UserSuggestionService.swift

@@ -23,7 +23,13 @@ struct RoomMembersProviderMember {
     var avatarUrl: String
 }
 
+class UserSuggestionID: NSObject {
+    /// A special case added for suggesting `@room` mentions.
+    @objc static let room = "@room"
+}
+
 protocol RoomMembersProviderProtocol {
+    var canMentionRoom: Bool { get }
     func fetchMembers(_ members: @escaping ([RoomMembersProviderMember]) -> Void)
 }
 
@@ -100,7 +106,7 @@ class UserSuggestionService: UserSuggestionServiceProtocol {
                 return
             }
 
-            self.suggestionItems = members.map { member in
+            self.suggestionItems = members.withRoom(self.roomMemberProvider.canMentionRoom).map { member in
                 UserSuggestionServiceItem(userId: member.userId, displayName: member.displayName, avatarUrl: member.avatarUrl)
             }
 
@@ -113,3 +119,11 @@ class UserSuggestionService: UserSuggestionServiceProtocol {
         }
     }
 }
+
+extension Array where Element == RoomMembersProviderMember {
+    /// Returns the array with an additional member that represents an `@room` mention.
+    func withRoom(_ canMentionRoom: Bool) -> Self {
+        guard canMentionRoom else { return self }
+        return self + [RoomMembersProviderMember(userId: UserSuggestionID.room, displayName: "Everyone", avatarUrl: "")]
+    }
+}