Enable user mentions in Rich Text Editor

Riot.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -50,8 +50,8 @@
       "kind" : "remoteSourceControl",
       "location" : "https://github.com/matrix-org/matrix-wysiwyg-composer-swift",
       "state" : {
-        "revision" : "addf90f3e2a6ab46bd2b2febe117d9cddb646e7d",
-        "version" : "1.1.1"
+        "revision" : "758f226a92d6726ab626c1e78ecd183bdba77016",
+        "version" : "2.0.0"
       }
     },
     {

Riot/Modules/MatrixKit/Views/RoomInputToolbar/MXKRoomInputToolbarView.h

@@ -382,6 +382,11 @@ typedef enum : NSUInteger
  */
 @property (nonatomic) NSAttributedString *attributedTextMessage;
 
+/**
+ Default font for the message composer.
+ */
+@property (nonatomic, readonly, nonnull) UIFont *defaultFont;
+
 - (void)dismissValidationView:(MXKImageView*)validationView;
 
 @end

Riot/Modules/MatrixKit/Views/RoomInputToolbar/MXKRoomInputToolbarView.m

@@ -358,6 +358,10 @@ - (void)pasteText:(NSString *)text
     self.textMessage = [NSString stringWithFormat:@"%@%@", self.textMessage, text];
 }
 
+- (UIFont *)defaultFont
+{
+    return [UIFont systemFontOfSize:15.f];
+}
 
 #pragma mark - MXKFileSizes
 

Riot/Modules/Pills/PillAttachmentViewProvider.swift

@@ -25,25 +25,29 @@ import UIKit
                                                                   avatarLeading: 2.0,
                                                                   avatarSideLength: 16.0,
                                                                   itemSpacing: 4)
-    private weak var messageTextView: MXKMessageTextView?
+    private weak var messageTextView: UITextView?
+    private var pillViewFlusher: PillViewFlusher? {
+        messageTextView as? PillViewFlusher
+    }
 
     // MARK: - Override
     override init(textAttachment: NSTextAttachment, parentView: UIView?, textLayoutManager: NSTextLayoutManager?, location: NSTextLocation) {
         super.init(textAttachment: textAttachment, parentView: parentView, textLayoutManager: textLayoutManager, location: location)
 
-        self.messageTextView = parentView?.superview as? MXKMessageTextView
+        // Keep a reference to the parent text view for size adjustments and pills flushing.
+        messageTextView = parentView?.superview as? UITextView
     }
 
     override func loadView() {
         super.loadView()
 
         guard let textAttachment = self.textAttachment as? PillTextAttachment else {
-            MXLog.debug("[PillAttachmentViewProvider]: attachment is missing or not of expected class")
+            MXLog.failure("[PillAttachmentViewProvider]: attachment is missing or not of expected class")
             return
         }
 
         guard var pillData = textAttachment.data else {
-            MXLog.debug("[PillAttachmentViewProvider]: attachment misses pill data")
+            MXLog.failure("[PillAttachmentViewProvider]: attachment misses pill data")
             return
         }
 
@@ -59,6 +63,11 @@ import UIKit
                                           mediaManager: mainSession?.mediaManager,
                                           andPillData: pillData)
         view = pillView
-        messageTextView?.registerPillView(pillView)
+
+        if let pillViewFlusher {
+            pillViewFlusher.registerPillView(pillView)
+        } else {
+            MXLog.failure("[PillAttachmentViewProvider]: no handler found, pill will not be flushed properly")
+        }
     }
 }

Riot/Modules/Pills/PillProvider.swift

@@ -26,14 +26,14 @@ private enum PillAttachmentKind {
 struct PillProvider {
     private let session: MXSession
     private let eventFormatter: MXKEventFormatter
-    private let event: MXEvent
+    private let event: MXEvent?
     private let roomState: MXRoomState
     private let latestRoomState: MXRoomState?
     private let isEditMode: Bool
 
     init(withSession session: MXSession,
          eventFormatter: MXKEventFormatter,
-         event: MXEvent,
+         event: MXEvent?,
          roomState: MXRoomState,
          andLatestRoomState latestRoomState: MXRoomState?,
          isEditMode: Bool) {
@@ -46,7 +46,7 @@ struct PillProvider {
         self.isEditMode = isEditMode
     }
 
-    func pillTextAttachmentString(forUrl url: URL, withLabel label: String, event: MXEvent) -> NSAttributedString? {
+    func pillTextAttachmentString(forUrl url: URL, withLabel label: String) -> NSAttributedString? {
 
         // Try to get a pill from this url
         guard let pillType = PillType.from(url: url) else {
@@ -133,6 +133,10 @@ struct PillProvider {
         let avatarUrl = roomMember?.avatarUrl ?? user?.avatarUrl
         let displayName = roomMember?.displayname ?? user?.displayName ?? userId
         let isHighlighted = userId == session.myUserId
+            // No actual event means it is a composer Pill. No highlight
+            && event != nil
+            // No highlight on self-mentions
+            && event?.sender != session.myUserId
 
         let avatar: PillTextAttachmentItem
         if roomMember == nil && user == nil {

Riot/Modules/Pills/PillViewFlusher.swift

@@ -0,0 +1,39 @@
+// 
+// Copyright 2023 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
+import WysiwygComposer
+
+/// Defines behaviour for an object that is able to manage views created
+/// by a `NSTextAttachmentViewProvider`. This can be implemented
+/// by an `UITextView` that would keep track of views in order to
+/// (internally) clear them when required (e.g. when setting a new attributed text).
+///
+/// Note: It is necessary to clear views manually due to a bug in iOS. See `MXKMessageTextView`.
+@available(iOS 15.0, *)
+protocol PillViewFlusher: AnyObject {
+    /// Register a pill view that has been added through `NSTextAttachmentViewProvider`.
+    /// Should be called within the `loadView` function in order to clear the pills properly on text updates.
+    ///
+    /// - Parameter pillView: View to register.
+    func registerPillView(_ pillView: UIView)
+}
+
+@available(iOS 15.0, *)
+extension MXKMessageTextView: PillViewFlusher { }
+
+@available(iOS 15.0, *)
+extension WysiwygTextView: PillViewFlusher { }

Riot/Modules/Pills/PillsFormatter.swift

@@ -65,7 +65,7 @@ class PillsFormatter: NSObject {
 
             // try to get a mention pill from the url
             let label = Range(range, in: newAttr.string).flatMap { String(newAttr.string[$0]) }
-            if let attachmentString: NSAttributedString = provider.pillTextAttachmentString(forUrl: url, withLabel: label ?? "", event: event) {
+            if let attachmentString: NSAttributedString = provider.pillTextAttachmentString(forUrl: url, withLabel: label ?? "") {
                 // replace the url with the pill
                 newAttr.replaceCharacters(in: range, with: attachmentString)
             }
@@ -74,6 +74,41 @@ class PillsFormatter: NSObject {
         return newAttr
     }
 
+    /// Insert text attachments for pills inside given attributed string containing markdown.
+    ///
+    /// - Parameters:
+    ///   - markdownString: An attributed string with markdown formatting
+    ///   - roomState: The current room state
+    ///   - font: The font to use for the pill text
+    /// - Returns: A new attributed string with pills.
+    static func insertPills(in markdownString: NSAttributedString,
+                            withSession session: MXSession,
+                            eventFormatter: MXKEventFormatter,
+                            roomState: MXRoomState,
+                            font: UIFont) -> NSAttributedString {
+        let matches = markdownLinks(in: markdownString)
+
+        // If we have some matches, replace permalinks by a pill version.
+        guard !matches.isEmpty else { return markdownString }
+
+        let pillProvider = PillProvider(withSession: session,
+                                        eventFormatter: eventFormatter,
+                                        event: nil,
+                                        roomState: roomState,
+                                        andLatestRoomState: nil,
+                                        isEditMode: true)
+
+        let mutable = NSMutableAttributedString(attributedString: markdownString)
+
+        matches.reversed().forEach {
+            if let attachmentString = pillProvider.pillTextAttachmentString(forUrl: $0.url, withLabel: $0.label) {
+                mutable.replaceCharacters(in: $0.range, with: attachmentString)
+            }
+        }
+
+        return mutable
+    }
+
     /// Creates a string with all pills of given attributed string replaced by display names.
     ///
     /// - Parameters:
@@ -123,6 +158,20 @@ class PillsFormatter: NSObject {
         }
         return attributedStringWithAttachment(attachment, link: url, font: font)
     }
+
+    static func mentionPill(withUrl url: URL,
+                            andLabel label: String,
+                            session: MXSession,
+                            eventFormatter: MXKEventFormatter,
+                            roomState: MXRoomState) -> NSAttributedString? {
+        let pillProvider = PillProvider(withSession: session,
+                                        eventFormatter: eventFormatter,
+                                        event: nil,
+                                        roomState: roomState,
+                                        andLatestRoomState: nil,
+                                        isEditMode: true)
+        return pillProvider.pillTextAttachmentString(forUrl: url, withLabel: label)
+    }
 
     /// Update alpha of all `PillTextAttachment` contained in given attributed string.
     ///
@@ -160,12 +209,45 @@ class PillsFormatter: NSObject {
             }
         }
     }
-
 }
 
 // MARK: - Private Methods
 @available (iOS 15.0, *)
 extension PillsFormatter {
+    struct MarkdownLinkResult: Equatable {
+        let url: URL
+        let label: String
+        let range: NSRange
+    }
+
+    static func markdownLinks(in attributedString: NSAttributedString) -> [MarkdownLinkResult] {
+        // Create a regexp that detects markdown links.
+        // Pattern source: https://gist.github.com/hugocf/66d6cd241eff921e0e02
+        let pattern = "\\[([^\\]]+)\\]\\(([^\\)\"\\s]+)(?:\\s+\"(.*)\")?\\)"
+        guard let regExp = try? NSRegularExpression(pattern: pattern) else { return [] }
+
+        let matches = regExp.matches(in: attributedString.string,
+                                     range: .init(location: 0, length: attributedString.length))
+
+        return matches.compactMap { match in
+            let labelRange = match.range(at: 1)
+            let urlRange = match.range(at: 2)
+            let label = attributedString.attributedSubstring(from: labelRange).string
+            var url = attributedString.attributedSubstring(from: urlRange).string
+
+            // Note: a valid markdown link can be written with
+            // enclosing <..>, remove them for userId detection.
+            if url.first == "<" && url.last == ">" {
+                url = String(url[url.index(after: url.startIndex)...url.index(url.endIndex, offsetBy: -2)])
+            }
+
+            if let url = URL(string: url) {
+                return MarkdownLinkResult(url: url, label: label, range: match.range)
+            } else {
+                return nil
+            }
+        }
+    }
 
     static func attributedStringWithAttachment(_ attachment: PillTextAttachment, link: URL?, font: UIFont) -> NSAttributedString {
         let string = NSMutableAttributedString(attachment: attachment)

Riot/Modules/Room/RoomViewController.m

@@ -5150,6 +5150,21 @@ - (void)roomInputToolbarViewDidChangeTextMessage:(RoomInputToolbarView *)toolbar
     [self.userSuggestionCoordinator processTextMessage:toolbarView.textMessage];
 }
 
+- (void)didDetectTextPattern:(SuggestionPatternWrapper *)suggestionPattern
+{
+    [self.userSuggestionCoordinator processSuggestionPattern:suggestionPattern];
+}
+
+- (UserSuggestionViewModelContextWrapper *)userSuggestionContext
+{
+    return [self.userSuggestionCoordinator sharedContext];
+}
+
+- (MXMediaManager *)mediaManager
+{
+    return self.roomDataSource.mxSession.mediaManager;
+}
+
 - (void)roomInputToolbarViewDidOpenActionMenu:(RoomInputToolbarView*)toolbarView
 {
     // Consider opening the action menu as beginning to type and share encryption keys if requested.