Media Model

Create a media model for all the media message in the timeline and then setup `NeoChatMaximizeComponent` so that it can use the media model to scroll through all loaded images and video in the current room.

Depends upon libraries/kirigami-addons!105

FEATURE: 467411

src/models/collapsestateproxymodel.h

@@ -27,6 +27,7 @@ public:
         StateEventsRole, /**< List of state events in the aggregated state. */
         AuthorListRole, /**< List of the first 5 unique authors of the aggregated state event. */
         ExcessAuthorsRole, /**< The number of unique authors beyond the first 5. */
+        LastRole, // Keep this last
     };
 
     /**

src/models/mediamessagefiltermodel.cpp

@@ -0,0 +1,79 @@
+// SPDX-FileCopyrightText: 2023 James Graham <james.h.graham@protonmail.com>
+// SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
+
+#include "mediamessagefiltermodel.h"
+#include "models/messageeventmodel.h"
+#include <room.h>
+
+MediaMessageFilterModel::MediaMessageFilterModel(QObject *parent)
+    : QSortFilterProxyModel(parent)
+{
+}
+
+bool MediaMessageFilterModel::filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const
+{
+    const QModelIndex index = sourceModel()->index(sourceRow, 0, sourceParent);
+
+    if (index.data(MessageEventModel::DelegateTypeRole).toInt() == MessageEventModel::DelegateType::Image
+        || index.data(MessageEventModel::DelegateTypeRole).toInt() == MessageEventModel::DelegateType::Video) {
+        return true;
+    }
+    return false;
+}
+
+QVariant MediaMessageFilterModel::data(const QModelIndex &index, int role) const
+{
+    if (role == SourceRole) {
+        if (mapToSource(index).data(MessageEventModel::DelegateTypeRole).toInt() == MessageEventModel::DelegateType::Image) {
+            return mapToSource(index).data(MessageEventModel::MediaInfoRole).toMap()["source"].toUrl();
+        } else if (mapToSource(index).data(MessageEventModel::DelegateTypeRole).toInt() == MessageEventModel::DelegateType::Video) {
+            auto progressInfo = mapToSource(index).data(MessageEventModel::ProgressInfoRole).value<Quotient::FileTransferInfo>();
+
+            if (progressInfo.completed()) {
+                return mapToSource(index).data(MessageEventModel::ProgressInfoRole).value<Quotient::FileTransferInfo>().localPath;
+            } else {
+                return QUrl();
+            }
+        } else {
+            return QUrl();
+        }
+    }
+    if (role == TempSourceRole) {
+        return mapToSource(index).data(MessageEventModel::MediaInfoRole).toMap()["tempInfo"].toMap()["source"].toUrl();
+    }
+    if (role == TypeRole) {
+        if (mapToSource(index).data(MessageEventModel::DelegateTypeRole).toInt() == MessageEventModel::DelegateType::Image) {
+            return 0;
+        } else {
+            return 1;
+        }
+    }
+    if (role == CaptionRole) {
+        return mapToSource(index).data(Qt::DisplayRole);
+    }
+    if (role == SourceWidthRole) {
+        return mapToSource(index).data(MessageEventModel::MediaInfoRole).toMap()["width"].toFloat();
+    }
+    if (role == SourceHeightRole) {
+        return mapToSource(index).data(MessageEventModel::MediaInfoRole).toMap()["height"].toFloat();
+    }
+
+    return sourceModel()->data(mapToSource(index), role);
+}
+
+QHash<int, QByteArray> MediaMessageFilterModel::roleNames() const
+{
+    auto roles = sourceModel()->roleNames();
+    roles[SourceRole] = "source";
+    roles[TempSourceRole] = "tempSource";
+    roles[TypeRole] = "type";
+    roles[CaptionRole] = "caption";
+    roles[SourceWidthRole] = "sourceWidth";
+    roles[SourceHeightRole] = "sourceHeight";
+    return roles;
+}
+
+int MediaMessageFilterModel::getRowForSourceItem(int sourceRow) const
+{
+    return mapFromSource(sourceModel()->index(sourceRow, 0)).row();
+}

src/models/mediamessagefiltermodel.h

@@ -0,0 +1,56 @@
+// SPDX-FileCopyrightText: 2023 James Graham <james.h.graham@protonmail.com>
+// SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
+
+#pragma once
+
+#include <QSortFilterProxyModel>
+
+#include "models/collapsestateproxymodel.h"
+
+/**
+ * @class MediaMessageFilterModel
+ *
+ * This model filters a MessageEventModel for image and video messages.
+ *
+ * @sa MessageEventModel
+ */
+class MediaMessageFilterModel : public QSortFilterProxyModel
+{
+    Q_OBJECT
+public:
+    /**
+     * @brief Defines the model roles.
+     */
+    enum Roles {
+        SourceRole = CollapseStateProxyModel::LastRole + 1, /**< The mxc source URL for the item. */
+        TempSourceRole, /**< Source for the temporary content (either blurhash or mxc URL). */
+        TypeRole, /**< The type of the media (image or video). */
+        CaptionRole, /**< The caption for the item. */
+        SourceWidthRole, /**< The width of the source item. */
+        SourceHeightRole, /**< The height of the source item. */
+    };
+    Q_ENUM(Roles)
+
+    MediaMessageFilterModel(QObject *parent = nullptr);
+
+    /**
+     * @brief Custom filter to show only image and video messages.
+     */
+    bool filterAcceptsRow(int sourceRow, const QModelIndex &sourceParent) const override;
+
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QSortFilterProxyModel::data
+     */
+    [[nodiscard]] QVariant data(const QModelIndex &idx, int role = Qt::DisplayRole) const override;
+
+    /**
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa Roles, QAbstractProxyModel::roleNames()
+     */
+    [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
+
+    Q_INVOKABLE int getRowForSourceItem(int sourceRow) const;
+};

src/models/messageeventmodel.cpp

@@ -61,7 +61,7 @@ QHash<int, QByteArray> MessageEventModel::roleNames() const
     roles[ShowReadMarkersRole] = "showReadMarkers";
     roles[ReactionRole] = "reaction";
     roles[ShowReactionsRole] = "showReactions";
-    roles[SourceRole] = "source";
+    roles[SourceRole] = "jsonSource";
     roles[MimeTypeRole] = "mimeType";
     roles[AuthorIdRole] = "authorId";
     roles[VerifiedRole] = "verified";