Support m.room.avatar events

The events are detected in /sync output, and avatars for rooms are loaded from respective URLs. Clients can use Room::avatar() method to request a pixmap of a certain size, and react to avatarChanged() in order to update the UI when new pixmaps/avatars arrive. avatarChanged() signal is overloaded with two tasks - the first firing merely indicates that a new avatar is available (without actual pixmap yet available) while the second firing means that an actual pixmap has arrived (all this is entirely transparent for clients, they just should update their pixmaps from Room::avatar() every time when Room::avatarChanged() is emitted).

4 files changed, 80 insertions, 1 deletions

diff --git a/events/event.cpp b/events/event.cpp
index 304f2af6..9963a0ef 100644
--- a/events/event.cpp
+++ b/events/event.cpp
@@ -24,6 +24,7 @@
 #include "roomcanonicalaliasevent.h"
 #include "roommemberevent.h"
 #include "roomtopicevent.h"
+#include "roomavatarevent.h"
 #include "typingevent.h"
 #include "receiptevent.h"
 #include "encryptedevent.h"
@@ -136,6 +137,7 @@ RoomEvent* RoomEvent::fromJson(const QJsonObject& obj)
             "m.room.canonical_alias", make<RoomCanonicalAliasEvent>,
             "m.room.member", make<RoomMemberEvent>,
             "m.room.topic", make<RoomTopicEvent>,
+            "m.room.avatar", make<RoomAvatarEvent>,
             "m.room.encryption", make<EncryptionEvent>,
             /* Insert new ROOM event types BEFORE this line */
             nullptr
diff --git a/events/event.h b/events/event.h
index ec993522..c151ac0e 100644
--- a/events/event.h
+++ b/events/event.h
@@ -34,7 +34,8 @@ namespace QMatrixClient
             enum class Type
             {
                 RoomMessage, RoomName, RoomAliases, RoomCanonicalAlias,
-                RoomMember, RoomTopic, RoomEncryption, RoomEncryptedMessage,
+                RoomMember, RoomTopic, RoomAvatar,
+                RoomEncryption, RoomEncryptedMessage,
                 Typing, Receipt, Unknown
             };
 
diff --git a/events/roomavatarevent.cpp b/events/roomavatarevent.cpp
new file mode 100644
index 00000000..7a5f82a1
--- /dev/null
+++ b/events/roomavatarevent.cpp
@@ -0,0 +1,23 @@
+/******************************************************************************
+ * Copyright (C) 2017 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
+ */
+
+#include "roomavatarevent.h"
+
+using namespace QMatrixClient;
+
+
diff --git a/events/roomavatarevent.h b/events/roomavatarevent.h
new file mode 100644
index 00000000..411de4e8
--- /dev/null
+++ b/events/roomavatarevent.h
@@ -0,0 +1,53 @@
+/******************************************************************************
+ * Copyright (C) 2017 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"
+
+#include <utility>
+
+#include "eventcontent.h"
+
+namespace QMatrixClient
+{
+    class RoomAvatarEvent: public RoomEvent
+    {
+        public:
+            explicit RoomAvatarEvent(EventContent::ImageContent avatar)
+                : RoomEvent(Type::RoomAvatar), _avatar(std::move(avatar))
+            { }
+            explicit RoomAvatarEvent(const QJsonObject& obj)
+                : RoomEvent(Type::RoomAvatar, obj), _avatar(contentJson())
+            { }
+
+            const EventContent::ImageContent& content() const { return _avatar; }
+
+            QJsonObject toJson() const { return _avatar.toJson(); }
+
+            static constexpr const char* TypeId = "m.room.avatar";
+
+        private:
+            // It's a bit of an overkill to use a full-fledged ImageContent
+            // because in reality m.room.avatar usually only has a single URL,
+            // without a thumbnail. But The Spec says there be thumbnails, and
+            // we follow The Spec.
+            EventContent::ImageContent _avatar;
+    };
+
+}  // namespace QMatrixClient