Move Neochat specific libQuotient events to their own folder

src/events/imagepackevent.cpp

@@ -0,0 +1,55 @@
+// SPDX-FileCopyrightText: 2021-2023 Tobias Fella <tobias.fella@kde.org>
+// SPDX-License-Identifier: LGPL-2.0-or-later
+
+#include "imagepackevent.h"
+#include <QJsonObject>
+
+using namespace Quotient;
+
+ImagePackEventContent::ImagePackEventContent(const QJsonObject &json)
+{
+    if (json.contains(QStringLiteral("pack"))) {
+        pack = ImagePackEventContent::Pack{
+            fromJson<Omittable<QString>>(json["pack"].toObject()["display_name"]),
+#ifdef QUOTIENT_07
+            fromJson<Omittable<QUrl>>(json["pack"].toObject()["avatar_url"]),
+#else
+            QUrl(),
+#endif
+            fromJson<Omittable<QStringList>>(json["pack"].toObject()["usage"]),
+            fromJson<Omittable<QString>>(json["pack"].toObject()["attribution"]),
+        };
+    } else {
+        pack = none;
+    }
+
+    const auto &keys = json["images"].toObject().keys();
+    for (const auto &k : keys) {
+        Omittable<EventContent::ImageInfo> info;
+        if (json["images"][k].toObject().contains(QStringLiteral("info"))) {
+#ifdef QUOTIENT_07
+            info = EventContent::ImageInfo(QUrl(json["images"][k]["url"].toString()), json["images"][k]["info"].toObject(), k);
+#else
+            info = EventContent::ImageInfo(QUrl(json["images"][k]["url"].toString()), json["images"][k].toObject(), k);
+#endif
+        } else {
+            info = none;
+        }
+        images += ImagePackImage{
+            k,
+#ifdef QUOTIENT_07
+            fromJson<QUrl>(json["images"][k]["url"].toString()),
+#else
+            QUrl(),
+#endif
+            fromJson<Omittable<QString>>(json["images"][k]["body"]),
+            info,
+            fromJson<Omittable<QStringList>>(json["images"][k]["usage"]),
+        };
+    }
+}
+
+void ImagePackEventContent::fillJson(QJsonObject *o) const
+{
+    // TODO
+}

src/events/imagepackevent.h

@@ -0,0 +1,58 @@
+// SPDX-FileCopyrightText: 2021-2023 Tobias Fella <tobias.fella@kde.org>
+// SPDX-License-Identifier: LGPL-2.0-or-later
+
+#pragma once
+
+#include <QVector>
+#include <events/eventcontent.h>
+#include <events/stateevent.h>
+
+namespace Quotient
+{
+class ImagePackEventContent
+{
+public:
+    struct Pack {
+        Quotient::Omittable<QString> displayName;
+        Quotient::Omittable<QUrl> avatarUrl;
+        Quotient::Omittable<QStringList> usage;
+        Quotient::Omittable<QString> attribution;
+    };
+
+    struct ImagePackImage {
+        QString shortcode;
+        QUrl url;
+        Quotient::Omittable<QString> body;
+        Quotient::Omittable<Quotient::EventContent::ImageInfo> info;
+        Quotient::Omittable<QStringList> usage;
+    };
+
+    Quotient::Omittable<Pack> pack;
+    QVector<ImagePackEventContent::ImagePackImage> images;
+
+    explicit ImagePackEventContent(const QJsonObject &o);
+
+    void fillJson(QJsonObject *o) const;
+};
+
+#ifdef QUOTIENT_07
+class ImagePackEvent : public KeyedStateEventBase<ImagePackEvent, ImagePackEventContent>
+#else
+class ImagePackEvent : public StateEvent<ImagePackEventContent>
+#endif
+{
+public:
+#ifdef QUOTIENT_07
+    QUO_EVENT(ImagePackEvent, "im.ponies.room_emotes")
+    using KeyedStateEventBase::KeyedStateEventBase;
+#else
+    DEFINE_EVENT_TYPEID("im.ponies.room_emotes", ImagePackEvent)
+    explicit ImagePackEvent(const QJsonObject &obj)
+        : StateEvent(typeId(), obj)
+    {
+    }
+#endif
+};
+
+REGISTER_EVENT_TYPE(ImagePackEvent)
+}

src/events/joinrulesevent.cpp

@@ -0,0 +1,16 @@
+// SPDX-FileCopyrightText: 2019 Kitsune Ral <Kitsune-Ral@users.sf.net>
+// SPDX-License-Identifier: LGPL-2.1-or-later
+
+#include "joinrulesevent.h"
+
+using namespace Quotient;
+
+QString JoinRulesEvent::joinRule() const
+{
+    return fromJson<QString>(contentJson()["join_rule"_ls]);
+}
+
+QJsonArray JoinRulesEvent::allow() const
+{
+    return contentJson()["allow"_ls].toArray();
+}

src/events/joinrulesevent.h

@@ -0,0 +1,56 @@
+// SPDX-FileCopyrightText: 2021 Carl Schwan <carl@carlschwan.eu>
+// SPDX-License-Identifier: LGPL-2.1-or-later
+
+#pragma once
+
+#include <events/stateevent.h>
+
+namespace Quotient
+{
+/**
+ * @class JoinRulesEvent
+ *
+ * Class to define a join rule state event.
+ *
+ * @sa Quotient::StateEvent
+ */
+#ifdef QUOTIENT_07
+class JoinRulesEvent : public StateEvent
+#else
+class JoinRulesEvent : public StateEventBase
+#endif
+{
+public:
+#ifdef QUOTIENT_07
+    QUO_EVENT(JoinRulesEvent, "m.room.join_rules")
+#else
+    DEFINE_EVENT_TYPEID("m.room.join_rules", JoinRulesEvent)
+#endif
+
+    explicit JoinRulesEvent(const QJsonObject &obj)
+#ifdef QUOTIENT_07
+        : StateEvent(obj)
+#else
+        : StateEventBase(typeId(), obj)
+#endif
+    {
+    }
+
+    /**
+     * @brief The join rule for the room.
+     *
+     * see https://spec.matrix.org/latest/client-server-api/#mroomjoin_rules for
+     * the available join rules for a room.
+     */
+    QString joinRule() const;
+
+    /**
+     * @brief The allow rule for restricted rooms.
+     *
+     * see https://spec.matrix.org/latest/client-server-api/#mroomjoin_rules for
+     * full details on allow rules.
+     */
+    QJsonArray allow() const;
+};
+REGISTER_EVENT_TYPE(JoinRulesEvent)
+}

src/events/pollevent.cpp

@@ -0,0 +1,38 @@
+// SPDX-FileCopyrightText: 2022 Tobias Fella <tobias.fella@kde.org>
+// SPDX-License-Identifier: LGPL-2.0-or-later
+
+#include "pollevent.h"
+
+using namespace Quotient;
+
+PollStartEvent::PollStartEvent(const QJsonObject &obj)
+    : RoomEvent(obj)
+{
+}
+
+int PollStartEvent::maxSelections() const
+{
+    return contentJson()["org.matrix.msc3381.poll.start"]["max_selections"].toInt();
+}
+
+QString PollStartEvent::question() const
+{
+    return contentJson()["org.matrix.msc3381.poll.start"]["question"]["body"].toString();
+}
+
+PollResponseEvent::PollResponseEvent(const QJsonObject &obj)
+    : RoomEvent(obj)
+{
+}
+
+PollEndEvent::PollEndEvent(const QJsonObject &obj)
+    : RoomEvent(obj)
+{
+}
+
+PollResponseEvent::PollResponseEvent(const QString &pollStartEventId, QStringList responses)
+    : RoomEvent(basicJson(TypeId,
+                          {{"org.matrix.msc3381.poll.response", QJsonObject{{"answers", QJsonArray::fromStringList(responses)}}},
+                           {"m.relates_to", QJsonObject{{"rel_type", "m.reference"}, {"event_id", pollStartEventId}}}}))
+{
+}

src/events/pollevent.h

@@ -0,0 +1,72 @@
+// SPDX-FileCopyrightText: 2022 Tobias Fella <tobias.fella@kde.org>
+// SPDX-License-Identifier: LGPL-2.0-or-later
+
+#pragma once
+
+#include <events/eventcontent.h>
+#include <events/roomevent.h>
+
+namespace Quotient
+{
+/**
+ * @class PollStartEvent
+ *
+ * Class to define a poll start event.
+ *
+ * See MSC3381 for full details on polls in the matrix spec
+ * https://github.com/matrix-org/matrix-spec-proposals/blob/travis/msc/polls/proposals/3381-polls.md.
+ *
+ * @sa Quotient::RoomEvent
+ */
+class PollStartEvent : public RoomEvent
+{
+public:
+    QUO_EVENT(PollStartEvent, "org.matrix.msc3381.poll.start");
+    explicit PollStartEvent(const QJsonObject &obj);
+
+    /**
+     * @brief The maximum number of options a user can select in a poll.
+     */
+    int maxSelections() const;
+
+    /**
+     * @brief The question being asked in the poll.
+     */
+    QString question() const;
+};
+
+/**
+ * @class PollResponseEvent
+ *
+ * Class to define a poll response event.
+ *
+ * See MSC3381 for full details on polls in the matrix spec
+ * https://github.com/matrix-org/matrix-spec-proposals/blob/travis/msc/polls/proposals/3381-polls.md.
+ *
+ * @sa Quotient::RoomEvent
+ */
+class PollResponseEvent : public RoomEvent
+{
+public:
+    QUO_EVENT(PollResponseEvent, "org.matrix.msc3381.poll.response");
+    explicit PollResponseEvent(const QJsonObject &obj);
+    explicit PollResponseEvent(const QString &pollStartEventId, QStringList responses);
+};
+
+/**
+ * @class PollEndEvent
+ *
+ * Class to define a poll end event.
+ *
+ * See MSC3381 for full details on polls in the matrix spec
+ * https://github.com/matrix-org/matrix-spec-proposals/blob/travis/msc/polls/proposals/3381-polls.md.
+ *
+ * @sa Quotient::RoomEvent
+ */
+class PollEndEvent : public RoomEvent
+{
+public:
+    QUO_EVENT(PollEndEvent, "org.matrix.msc3381.poll.end");
+    explicit PollEndEvent(const QJsonObject &obj);
+};
+}

src/events/stickerevent.cpp

@@ -0,0 +1,35 @@
+// SPDX-FileCopyrightText: 2020 Carl Schwan <carlschwan@kde.org>
+// SPDX-License-Identifier: LGPL-2.1-or-later
+
+#include "stickerevent.h"
+
+using namespace Quotient;
+
+StickerEvent::StickerEvent(const QJsonObject &obj)
+#ifdef QUOTIENT_07
+    : RoomEvent(obj)
+#else
+    : RoomEvent(typeId(), obj)
+#endif
+    , m_imageContent(EventContent::ImageContent(obj["content"_ls].toObject()))
+{
+}
+
+QString StickerEvent::body() const
+{
+    return content<QString>("body"_ls);
+}
+
+const EventContent::ImageContent &StickerEvent::image() const
+{
+    return m_imageContent;
+}
+
+QUrl StickerEvent::url() const
+{
+#ifdef QUOTIENT_07
+    return m_imageContent.url();
+#else
+    return m_imageContent.url;
+#endif
+}

src/events/stickerevent.h

@@ -0,0 +1,55 @@
+// SPDX-FileCopyrightText: 2020 Carl Schwan <carlschwan@kde.org>
+// SPDX-License-Identifier: LGPL-2.1-or-later
+
+#pragma once
+
+#include <events/eventcontent.h>
+#include <events/roomevent.h>
+
+namespace Quotient
+{
+/**
+ * @class StickerEvent
+ *
+ * Class to define a sticker event.
+ *
+ * Sticker messages are specialised image messages that are displayed without
+ * controls (e.g. no "download" link, or light-box view on click, as would be
+ * displayed for for m.image events).
+ *
+ * @sa Quotient::RoomEvent
+ */
+class StickerEvent : public RoomEvent
+{
+public:
+#ifdef QUOTIENT_07
+    QUO_EVENT(StickerEvent, "m.sticker")
+#else
+    DEFINE_EVENT_TYPEID("m.sticker", StickerEvent)
+#endif
+
+    explicit StickerEvent(const QJsonObject &obj);
+
+    /**
+     * @brief A textual representation or associated description of the sticker image.
+     *
+     * This could be the alt text of the original image, or a message to accompany
+     * and further describe the sticker.
+     */
+    QString body() const;
+
+    /**
+     * @brief Metadata about the image referred to in url including a thumbnail representation.
+     */
+    const EventContent::ImageContent &image() const;
+
+    /**
+     * @brief The URL to the sticker image. This must be a valid mxc:// URI.
+     */
+    QUrl url() const;
+
+private:
+    EventContent::ImageContent m_imageContent;
+};
+REGISTER_EVENT_TYPE(StickerEvent)
+}