TagEvent: m.tag events parsing

Using them in rooms and connection comes in the next commit.

6 files changed, 107 insertions, 4 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index da5bac9b..709860e8 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -60,6 +60,7 @@ set(libqmatrixclient_SRCS
    events/roomavatarevent.cpp
    events/typingevent.cpp
    events/receiptevent.cpp
+   events/tagevent.cpp
    jobs/requestdata.cpp
    jobs/basejob.cpp
    jobs/checkauthmethods.cpp
diff --git a/events/event.cpp b/events/event.cpp
index 366aa858..b55c44c4 100644
--- a/events/event.cpp
+++ b/events/event.cpp
@@ -24,6 +24,7 @@
 #include "roomavatarevent.h"
 #include "typingevent.h"
 #include "receiptevent.h"
+#include "tagevent.h"
 #include "redactionevent.h"
 #include "logging.h"
 
@@ -44,6 +45,11 @@ Event::Event(Type type, const QJsonObject& rep)
 
 Event::~Event() = default;
 
+QString Event::jsonType() const
+{
+    return originalJsonObject().value("type").toString();
+}
+
 QByteArray Event::originalJson() const
 {
     return QJsonDocument(_originalJson).toJson();
@@ -82,7 +88,7 @@ EventPtr _impl::doMakeEvent<Event>(const QJsonObject& obj)
         return EventPtr(move(e));
 
     return EventPtr { makeIfMatches<Event,
-        TypingEvent, ReceiptEvent>(obj, obj["type"].toString()) };
+        TypingEvent, ReceiptEvent, TagEvent>(obj, obj["type"].toString()) };
 }
 
 RoomEvent::RoomEvent(Event::Type type) : Event(type) { }
diff --git a/events/event.h b/events/event.h
index 1a1b994d..4bd08b55 100644
--- a/events/event.h
+++ b/events/event.h
@@ -45,7 +45,7 @@ namespace QMatrixClient
             enum class Type : quint16
             {
                 Unknown = 0,
-                Typing, Receipt,
+                Typing, Receipt, Tag, DirectChat,
                 RoomEventBase = 0x1000,
                 RoomMessage = RoomEventBase + 1,
                 RoomEncryptedMessage, Redaction,
@@ -63,6 +63,7 @@ namespace QMatrixClient
             virtual ~Event();
 
             Type type() const { return _type; }
+            QString jsonType() const;
             bool isStateEvent() const
             {
                 return (quint16(_type) & 0x1800) == 0x1800;
@@ -76,7 +77,6 @@ namespace QMatrixClient
             // (and in most cases it will be a combination of other fields
             // instead of "content" field).
 
-        protected:
             const QJsonObject contentJson() const;
 
         private:
diff --git a/events/tagevent.cpp b/events/tagevent.cpp
new file mode 100644
index 00000000..9f381c76
--- /dev/null
+++ b/events/tagevent.cpp
@@ -0,0 +1,42 @@
+#include "tagevent.h"
+
+using namespace QMatrixClient;
+
+TagRecord::TagRecord(const QJsonObject& json)
+    : order(json.value("order").toString())
+{ }
+
+TagEvent::TagEvent(const QJsonObject& obj)
+    : Event(Type::Tag, obj)
+{
+    Q_ASSERT(obj["type"].toString() == TypeId);
+}
+
+QStringList TagEvent::tagNames() const
+{
+    return tagsObject().keys();
+}
+
+QHash<QString, TagRecord> TagEvent::tags() const
+{
+    QHash<QString, TagRecord> result;
+    auto allTags { tagsObject() };
+    for (auto it = allTags.begin(); it != allTags.end(); ++ it)
+        result.insert(it.key(), TagRecord(it.value().toObject()));
+    return result;
+}
+
+bool TagEvent::isFavourite() const
+{
+    return tagsObject().contains("m.favourite");
+}
+
+bool TagEvent::isLowPriority() const
+{
+    return tagsObject().contains("m.lowpriority");
+}
+
+QJsonObject TagEvent::tagsObject() const
+{
+    return contentJson().value("tags").toObject();
+}
diff --git a/events/tagevent.h b/events/tagevent.h
new file mode 100644
index 00000000..23b0b703
--- /dev/null
+++ b/events/tagevent.h
@@ -0,0 +1,53 @@
+/******************************************************************************
+ * Copyright (C) 2018 Kitsune Ral <kitsune-ral@users.sf.net>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+ */
+
+#pragma once
+
+#include "event.h"
+
+namespace QMatrixClient
+{
+    struct TagRecord
+    {
+        explicit TagRecord(const QJsonObject& json = {});
+
+        QString order;
+    };
+
+    class TagEvent : public Event
+    {
+        public:
+            explicit TagEvent(const QJsonObject& obj);
+
+            /** Get the list of tag names */
+            QStringList tagNames() const;
+
+            /** Get the list of tags along with information on each */
+            QHash<QString, TagRecord> tags() const;
+
+            /** Check whether the list of tags has m.favourite */
+            bool isFavourite() const;
+            /** Check whether the list of tags has m.lowpriority */
+            bool isLowPriority() const;
+
+            static constexpr const char * TypeId = "m.tag";
+
+        protected:
+            QJsonObject tagsObject() const;
+    };
+}
diff --git a/libqmatrixclient.pri b/libqmatrixclient.pri
index 72637caf..7cfa94a1 100644
--- a/libqmatrixclient.pri
+++ b/libqmatrixclient.pri
@@ -24,6 +24,7 @@ HEADERS += \
     $$PWD/events/roomavatarevent.h \
     $$PWD/events/typingevent.h \
     $$PWD/events/receiptevent.h \
+    $$PWD/events/tagevent.h \
     $$PWD/events/redactionevent.h \
     $$PWD/jobs/requestdata.h \
     $$PWD/jobs/basejob.h \
@@ -55,7 +56,7 @@ SOURCES += \
     $$PWD/events/roommemberevent.cpp \
     $$PWD/events/typingevent.cpp \
     $$PWD/events/receiptevent.cpp \
-    $$PWD/events/redactionevent.cpp \
+    $$PWD/events/tagevent.cpp \
     $$PWD/jobs/requestdata.cpp \
     $$PWD/jobs/basejob.cpp \
     $$PWD/jobs/checkauthmethods.cpp \