Allow opening message menus for out-of-room events

These are more common than we thought, good examples are pinned or
searched messages - which are not going to be in the room's history
unless you happen to have them loaded. But currently our message menu
infrastructure expects them to be, since its looked up by the room +
event ID.

To fix this is simple, we now move the job of finding the event to the
caller which may use a model instead. I didn't fix all existing
call-sites yet, mainly the message menu opening one since that was the
most obvious bug. But this opens up the door for other assumptions about
room history to be fixed too.

I had to do a bit of C++ re-jiggering in order to expose useful
functions to QML.

src/app/qml/NeochatMaximizeComponent.qml

@@ -154,7 +154,10 @@ Components.AlbumMaximizeComponent {
 
     onOpened: forceActiveFocus()
 
-    onItemRightClicked: RoomManager.viewEventMenu(root.currentEventId, root.currentRoom)
+    onItemRightClicked: {
+        const event = root.currentRoom.findEvent(root.currentEventId);
+        RoomManager.viewEventMenu(event, root.currentRoom)
+    }
 
     onSaveItem: {
         var dialog = saveAsDialog.createObject(QQC2.Overlay.overlay) as Dialogs.FileDialog;

src/app/roommanager.cpp

@@ -282,26 +282,20 @@ void RoomManager::viewEventSource(const QString &eventId)
     Q_EMIT showEventSource(eventId);
 }
 
-void RoomManager::viewEventMenu(const QString &eventId, NeoChatRoom *room, const QString &selectedText, const QString &hoveredLink)
+void RoomManager::viewEventMenu(const RoomEvent *event, NeoChatRoom *room, const QString &selectedText, const QString &hoveredLink)
 {
-    if (eventId.isEmpty()) {
-        qWarning() << "Tried to open event menu with empty event id";
+    if (!event) {
+        qWarning() << "Tried to open event menu with empty event";
         return;
     }
 
-    const auto it = room->findInTimeline(eventId);
-    if (it == room->historyEdge()) {
-        // This is probably a pending event
-        return;
-    }
-    const auto &event = **it;
-    Q_EMIT showDelegateMenu(eventId,
-                            room->qmlSafeMember(event.senderId()),
-                            MessageComponentType::typeForEvent(event),
-                            EventHandler::plainBody(room, &event),
-                            EventHandler::richBody(room, &event),
-                            EventHandler::mediaInfo(room, &event)["mimeType"_L1].toString(),
-                            room->fileTransferInfo(eventId),
+    Q_EMIT showDelegateMenu(event->id(),
+                            room->qmlSafeMember(event->senderId()),
+                            MessageComponentType::typeForEvent(*event),
+                            EventHandler::plainBody(room, event),
+                            EventHandler::richBody(room, event),
+                            EventHandler::mediaInfo(room, event)["mimeType"_L1].toString(),
+                            room->fileTransferInfo(event->id()),
                             selectedText,
                             hoveredLink);
 }

src/app/roommanager.h

@@ -233,7 +233,7 @@ public:
     /**
      * @brief Show a context menu for the given event.
      */
-    Q_INVOKABLE void viewEventMenu(const QString &eventId, NeoChatRoom *room, const QString &selectedText = {}, const QString &hoveredLink = {});
+    Q_INVOKABLE void viewEventMenu(const RoomEvent *event, NeoChatRoom *room, const QString &selectedText = {}, const QString &hoveredLink = {});
 
     /**
      * @brief Set a URL to be loaded as the initial room.

src/libneochat/neochatroom.cpp

@@ -1694,6 +1694,11 @@ std::pair<const Quotient::RoomEvent *, bool> NeoChatRoom::getEvent(const QString
     return std::make_pair(extraIt != m_extraEvents.end() ? extraIt->get() : nullptr, false);
 }
 
+const RoomEvent *NeoChatRoom::findEvent(const QString &eventId) const
+{
+    return getEvent(eventId).first;
+}
+
 const RoomEvent *NeoChatRoom::getReplyForEvent(const RoomEvent &event) const
 {
 #if Quotient_VERSION_MINOR > 9

src/libneochat/neochatroom.h

@@ -538,6 +538,13 @@ public:
      */
     std::pair<const Quotient::RoomEvent *, bool> getEvent(const QString &eventId) const;
 
+    /**
+     * @brief Returns the event object with the given ID if available.
+     *
+     * This function works identically to getEvent, except this is usable from QML.
+     */
+    Q_INVOKABLE const Quotient::RoomEvent *findEvent(const QString &eventId) const;
+
     /**
      * @brief Returns the event that is being replied to. This includes events that were manually loaded using NeoChatRoom::loadReply.
      */

src/messagecontent/CodeComponent.qml

@@ -130,7 +130,10 @@ QQC2.Control {
 
             TapHandler {
                 acceptedDevices: PointerDevice.TouchScreen
-                onLongPressed: RoomManager.viewEventMenu(root.eventId, root.Message.room, root.Message.selectedText, root.Message.hoveredLink);
+                onLongPressed: {
+                    const event = root.Message.room.findEvent(root.eventId);
+                    RoomManager.viewEventMenu(event, root.Message.room, root.Message.selectedText, root.Message.hoveredLink);
+                }
             }
 
             background: null

src/messagecontent/QuoteComponent.qml

@@ -66,7 +66,10 @@ QQC2.Control {
             enabled: !quoteText.hoveredLink
             acceptedDevices: PointerDevice.TouchScreen
             acceptedButtons: Qt.LeftButton
-            onLongPressed: RoomManager.viewEventMenu(root.eventId, root.Message.room, root.Message.selectedText, root.Message.hoveredLink);
+            onLongPressed: {
+                const event = root.Message.room.findEvent(root.eventId);
+                RoomManager.viewEventMenu(event, root.Message.room, root.Message.selectedText, root.Message.hoveredLink);
+            }
         }
     }
 

src/messagecontent/StateComponent.qml

@@ -86,11 +86,12 @@ RowLayout {
     QtObject {
         id: _private
 
-        function showMessageMenu() {
+        function showMessageMenu(): void {
             if (!NeoChatConfig.developerTools) {
                 return;
             }
-            RoomManager.viewEventMenu(root.modelData.eventId, root.Message.room, root.author, "", "");
+            const event = root.Message.room.findEvent(root.modelData.eventId);
+            RoomManager.viewEventMenu(event, root.Message.room, root.author, "", "");
         }
     }
 }

src/messagecontent/TextComponent.qml

@@ -97,12 +97,18 @@ TextEdit {
         enabled: !root.hoveredLink
         acceptedButtons: Qt.LeftButton
         acceptedDevices: PointerDevice.TouchScreen
-        onLongPressed: RoomManager.viewEventMenu(root.eventId, root.Message.room, root.Message.selectedText, root.Message.hoveredLink);
+        onLongPressed: {
+            const event = root.Message.room.findEvent(root.eventId);
+            RoomManager.viewEventMenu(event, root.Message.room, root.Message.selectedText, root.Message.hoveredLink);
+        }
     }
     TapHandler {
         acceptedButtons: Qt.RightButton
         acceptedDevices: PointerDevice.Mouse | PointerDevice.TouchPad | PointerDevice.Stylus
         gesturePolicy: TapHandler.WithinBounds
-        onTapped: RoomManager.viewEventMenu(root.eventId, root.Message.room, root.Message.selectedText, root.Message.hoveredLink);
+        onTapped: {
+            const event = root.Message.room.findEvent(root.eventId);
+            RoomManager.viewEventMenu(event, root.Message.room, root.Message.selectedText, root.Message.hoveredLink);
+        }
     }
 }

src/timeline/HiddenDelegate.qml

@@ -92,8 +92,10 @@ TimelineDelegate {
 
     QtObject {
         id: _private
-        function showMessageMenu() {
-            RoomManager.viewEventMenu(root.eventId, root.room, "");
+
+        function showMessageMenu(): void {
+            let event = root.Message.room.findEvent(root.eventId);
+            RoomManager.viewEventMenu(event, root.room, "");
         }
     }
 }

src/timeline/MessageDelegate.qml

@@ -232,8 +232,9 @@ MessageDelegateBase {
     QtObject {
         id: _private
 
-        function showMessageMenu() {
-            RoomManager.viewEventMenu(root.eventId, root.room, root.Message.selectedText, root.Message.hoveredLink);
+        function showMessageMenu(): void {
+            let event = root.ListView.view.model.findEvent(root.eventId);
+            RoomManager.viewEventMenu(event, root.room, root.Message.selectedText, root.Message.hoveredLink);
         }
     }
 }

src/timeline/models/messagefiltermodel.cpp

@@ -152,6 +152,23 @@ QModelIndex MessageFilterModel::indexForEventId(const QString &eventId) const
     return mapFromSource(eventIndex);
 }
 
+const Quotient::RoomEvent *MessageFilterModel::findEvent(const QString &eventId) const
+{
+    // Check if sourceModel is a message model.
+    auto messageModel = dynamic_cast<MessageModel *>(sourceModel());
+    // See if it's a timeline model.
+    if (!messageModel) {
+        if (const auto timelineModel = dynamic_cast<TimelineModel *>(sourceModel())) {
+            messageModel = timelineModel->timelineMessageModel();
+            if (!messageModel) {
+                return nullptr;
+            }
+        }
+    }
+
+    return messageModel->findEvent(eventId);
+}
+
 bool MessageFilterModel::showAuthor(QModelIndex index) const
 {
     for (auto r = index.row() + 1; r < rowCount(); ++r) {

src/timeline/models/messagefiltermodel.h

@@ -67,9 +67,13 @@ public:
     /**
      * @brief Get the QModelIndex the given event ID in the model.
      */
-    Q_INVOKABLE QModelIndex indexforEventId(const QString &eventId) const;
     Q_INVOKABLE QModelIndex indexForEventId(const QString &eventId) const;
 
+    /**
+     * @brief Finds the event of the given event ID in the model, returning nullptr if no matches were found.
+     */
+    Q_INVOKABLE const Quotient::RoomEvent *findEvent(const QString &eventId) const;
+
     static void setShowAllEvents(bool enabled);
     static void setShowDeletedMessages(bool enabled);
 

src/timeline/models/messagemodel.cpp

@@ -351,16 +351,21 @@ QHash<int, QByteArray> MessageModel::roleNames() const
 
 QModelIndex MessageModel::indexForEventId(const QString &eventId) const
 {
-    if (m_room == nullptr) {
-        return {};
-    }
-
-    const auto it = m_room->findInTimeline(eventId);
-    if (it == m_room->historyEdge()) {
+    const auto matches = match(index(0, 0), EventIdRole, eventId);
+    if (matches.isEmpty()) {
         qWarning() << "Trying to find non-existent event:" << eventId;
         return {};
     }
-    return index(it - m_room->messageEvents().rbegin() + timelineServerIndex());
+    return matches.constFirst();
+}
+
+const RoomEvent *MessageModel::findEvent(const QString &eventId) const
+{
+    const auto index = indexForEventId(eventId);
+    if (const auto event = getEventForIndex(index)) {
+        return &event.value().get();
+    }
+    return nullptr;
 }
 
 void MessageModel::fullEventRefresh(int row)

src/timeline/models/messagemodel.h

@@ -115,9 +115,13 @@ public:
     /**
      * @brief Get the QModelIndex of the given event ID in the model, returning an invalid QModelIndex if no matches were found.
      */
-    Q_INVOKABLE QModelIndex indexforEventId(const QString &eventId) const;
     Q_INVOKABLE QModelIndex indexForEventId(const QString &eventId) const;
 
+    /**
+     * @brief Finds the event of the given event ID in the model, returning nullptr if no matches were found.
+     */
+    Q_INVOKABLE const Quotient::RoomEvent *findEvent(const QString &eventId) const;
+
     static void setHiddenFilter(std::function<bool(const Quotient::RoomEvent *)> hiddenFilter);
 
     static void setThreadsEnabled(bool enableThreads);