Add serialization on matrix events

include/Deserializable.h

@@ -47,3 +47,9 @@ public:
 	{
 	}
 };
+
+class Serializable
+{
+public:
+	virtual QJsonObject serialize() const = 0;
+};

include/events/AliasesEventContent.h

@@ -26,10 +26,11 @@ namespace matrix
 {
 namespace events
 {
-class AliasesEventContent : public Deserializable
+class AliasesEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline QList<QString> aliases() const;
 

include/events/AvatarEventContent.h

@@ -30,10 +30,11 @@ namespace events
  * A picture that is associated with the room.
  */
 
-class AvatarEventContent : public Deserializable
+class AvatarEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline QUrl url() const;
 

include/events/CanonicalAliasEventContent.h

@@ -32,10 +32,11 @@ namespace events
  * users which alias to use to advertise the room.
  */
 
-class CanonicalAliasEventContent : public Deserializable
+class CanonicalAliasEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline QString alias() const;
 

include/events/CreateEventContent.h

@@ -29,10 +29,11 @@ namespace events
  * This is the first event in a room and cannot be changed. It acts as the root of all other events.
  */
 
-class CreateEventContent : public Deserializable
+class CreateEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline QString creator() const;
 

include/events/Event.h

@@ -17,6 +17,7 @@
 
 #pragma once
 
+#include <QDebug>
 #include <QJsonValue>
 
 #include "Deserializable.h"
@@ -58,13 +59,14 @@ bool isMessageEvent(EventType type);
 bool isStateEvent(EventType type);
 
 template <class Content>
-class Event : public Deserializable
+class Event : public Deserializable, public Serializable
 {
 public:
 	inline Content content() const;
 	inline EventType eventType() const;
 
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 private:
 	Content content_;
@@ -92,6 +94,56 @@ void Event<Content>::deserialize(const QJsonValue &data)
 	auto object = data.toObject();
 
 	content_.deserialize(object.value("content"));
+	type_ = extractEventType(object);
+}
+
+template <class Content>
+QJsonObject Event<Content>::serialize() const
+{
+	QJsonObject object;
+
+	switch (type_) {
+	case EventType::RoomAliases:
+		object["type"] = "m.room.aliases";
+		break;
+	case EventType::RoomAvatar:
+		object["type"] = "m.room.avatar";
+		break;
+	case EventType::RoomCanonicalAlias:
+		object["type"] = "m.room.canonical_alias";
+		break;
+	case EventType::RoomCreate:
+		object["type"] = "m.room.create";
+		break;
+	case EventType::RoomHistoryVisibility:
+		object["type"] = "m.room.history_visibility";
+		break;
+	case EventType::RoomJoinRules:
+		object["type"] = "m.room.join_rules";
+		break;
+	case EventType::RoomMember:
+		object["type"] = "m.room.member";
+		break;
+	case EventType::RoomMessage:
+		object["type"] = "m.room.message";
+		break;
+	case EventType::RoomName:
+		object["type"] = "m.room.name";
+		break;
+	case EventType::RoomPowerLevels:
+		object["type"] = "m.room.power_levels";
+		break;
+	case EventType::RoomTopic:
+		object["type"] = "m.room.topic";
+		break;
+	case EventType::Unsupported:
+		qWarning() << "Unsupported type to serialize";
+		break;
+	}
+
+	object["content"] = content_.serialize();
+
+	return object;
 }
 }  // namespace events
 }  // namespace matrix

include/events/HistoryVisibilityEventContent.h

@@ -32,12 +32,13 @@ enum class HistoryVisibility {
 	WorldReadable,
 };
 
-class HistoryVisibilityEventContent : public Deserializable
+class HistoryVisibilityEventContent : public Deserializable, public Serializable
 {
 public:
 	inline HistoryVisibility historyVisibility() const;
 
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 private:
 	HistoryVisibility history_visibility_;

include/events/JoinRulesEventContent.h

@@ -44,10 +44,11 @@ enum class JoinRule {
  * Describes how users are allowed to join the room.
  */
 
-class JoinRulesEventContent : public Deserializable
+class JoinRulesEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline JoinRule joinRule() const;
 

include/events/MemberEventContent.h

@@ -47,10 +47,11 @@ enum class Membership {
  * The current membership state of a user in the room.
  */
 
-class MemberEventContent : public Deserializable
+class MemberEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline QUrl avatarUrl() const;
 	inline QString displayName() const;

include/events/MessageEventContent.h

@@ -56,10 +56,11 @@ enum class MessageEventType {
 
 MessageEventType extractMessageEventType(const QJsonObject &data);
 
-class MessageEventContent : public Deserializable
+class MessageEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline QString body() const;
 

include/events/NameEventContent.h

@@ -29,10 +29,11 @@ namespace events
  * A human-friendly room name designed to be displayed to the end-user.
  */
 
-class NameEventContent : public Deserializable
+class NameEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline QString name() const;
 

include/events/PowerLevelsEventContent.h

@@ -36,10 +36,11 @@ enum class PowerLevels {
  * Defines the power levels (privileges) of users in the room.
  */
 
-class PowerLevelsEventContent : public Deserializable
+class PowerLevelsEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline int banLevel() const;
 	inline int inviteLevel() const;

include/events/RoomEvent.h

@@ -36,6 +36,7 @@ public:
 	inline uint64_t timestamp() const;
 
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 private:
 	QString event_id_;
@@ -94,5 +95,18 @@ void RoomEvent<Content>::deserialize(const QJsonValue &data)
 	sender_ = object.value("sender").toString();
 	origin_server_ts_ = object.value("origin_server_ts").toDouble();
 }
+
+template <class Content>
+QJsonObject RoomEvent<Content>::serialize() const
+{
+	QJsonObject object = Event<Content>::serialize();
+
+	object["event_id"] = event_id_;
+	object["room_id"] = room_id_;
+	object["sender"] = sender_;
+	object["origin_server_ts"] = QJsonValue(static_cast<qint64>(origin_server_ts_));
+
+	return object;
+}
 }  // namespace events
 }  // namespace matrix

include/events/StateEvent.h

@@ -33,6 +33,7 @@ public:
 	inline Content previousContent() const;
 
 	void deserialize(const QJsonValue &data);
+	QJsonObject serialize() const;
 
 private:
 	QString state_key_;
@@ -66,5 +67,20 @@ void StateEvent<Content>::deserialize(const QJsonValue &data)
 	if (object.contains("prev_content"))
 		prev_content_.deserialize(object.value("prev_content"));
 }
+
+template <class Content>
+QJsonObject StateEvent<Content>::serialize() const
+{
+	QJsonObject object = RoomEvent<Content>::serialize();
+
+	object["state_key"] = state_key_;
+
+	auto prev = prev_content_.serialize();
+
+	if (!prev.isEmpty())
+		object["prev_content"] = prev;
+
+	return object;
+}
 }  // namespace events
 }  // namespace matrix

include/events/TopicEventContent.h

@@ -29,10 +29,11 @@ namespace events
  * A topic is a short message detailing what is currently being discussed in the room.
  */
 
-class TopicEventContent : public Deserializable
+class TopicEventContent : public Deserializable, public Serializable
 {
 public:
 	void deserialize(const QJsonValue &data) override;
+	QJsonObject serialize() const override;
 
 	inline QString topic() const;
 

src/events/AliasesEventContent.cc

@@ -36,3 +36,18 @@ void AliasesEventContent::deserialize(const QJsonValue &data)
 	for (const auto &alias : aliases)
 		aliases_.push_back(alias.toString());
 }
+
+QJsonObject AliasesEventContent::serialize() const
+{
+	QJsonObject object;
+
+	QJsonArray aliases;
+
+	for (const auto &alias : aliases_)
+		aliases.push_back(alias);
+
+	if (aliases.size() > 0)
+		object["aliases"] = aliases;
+
+	return object;
+}

src/events/AvatarEventContent.cc

@@ -36,3 +36,13 @@ void AvatarEventContent::deserialize(const QJsonValue &data)
 	if (!url_.isValid())
 		qWarning() << "Invalid avatar url" << url_;
 }
+
+QJsonObject AvatarEventContent::serialize() const
+{
+	QJsonObject object;
+
+	if (!url_.isEmpty())
+		object["url"] = url_.toString();
+
+	return object;
+}

src/events/CanonicalAliasEventContent.cc

@@ -31,3 +31,13 @@ void CanonicalAliasEventContent::deserialize(const QJsonValue &data)
 
 	alias_ = object.value("alias").toString();
 }
+
+QJsonObject CanonicalAliasEventContent::serialize() const
+{
+	QJsonObject object;
+
+	if (!alias_.isEmpty())
+		object["alias"] = alias_;
+
+	return object;
+}

src/events/CreateEventContent.cc

@@ -31,3 +31,13 @@ void CreateEventContent::deserialize(const QJsonValue &data)
 
 	creator_ = object.value("creator").toString();
 }
+
+QJsonObject CreateEventContent::serialize() const
+{
+	QJsonObject object;
+
+	if (!creator_.isEmpty())
+		object["creator"] = creator_;
+
+	return object;
+}

src/events/HistoryVisibilityEventContent.cc

@@ -42,3 +42,19 @@ void HistoryVisibilityEventContent::deserialize(const QJsonValue &data)
 	else
 		throw DeserializationException(QString("Unknown history_visibility value: %1").arg(value).toUtf8().constData());
 }
+
+QJsonObject HistoryVisibilityEventContent::serialize() const
+{
+	QJsonObject object;
+
+	if (history_visibility_ == HistoryVisibility::Invited)
+		object["history_visibility"] = "invited";
+	else if (history_visibility_ == HistoryVisibility::Joined)
+		object["history_visibility"] = "joined";
+	else if (history_visibility_ == HistoryVisibility::Shared)
+		object["history_visibility"] = "shared";
+	else if (history_visibility_ == HistoryVisibility::WorldReadable)
+		object["history_visibility"] = "world_readable";
+
+	return object;
+}

src/events/JoinRulesEventContent.cc

@@ -42,3 +42,19 @@ void JoinRulesEventContent::deserialize(const QJsonValue &data)
 	else
 		throw DeserializationException(QString("Unknown join_rule value: %1").arg(value).toUtf8().constData());
 }
+
+QJsonObject JoinRulesEventContent::serialize() const
+{
+	QJsonObject object;
+
+	if (join_rule_ == JoinRule::Invite)
+		object["join_rule"] = "invite";
+	else if (join_rule_ == JoinRule::Knock)
+		object["join_rule"] = "knock";
+	else if (join_rule_ == JoinRule::Private)
+		object["join_rule"] = "private";
+	else if (join_rule_ == JoinRule::Public)
+		object["join_rule"] = "public";
+
+	return object;
+}

src/events/MemberEventContent.cc

@@ -55,3 +55,27 @@ void MemberEventContent::deserialize(const QJsonValue &data)
 	if (object.contains("displayname"))
 		display_name_ = object.value("displayname").toString();
 }
+
+QJsonObject MemberEventContent::serialize() const
+{
+	QJsonObject object;
+
+	if (membership_state_ == Membership::Ban)
+		object["membership"] = "ban";
+	else if (membership_state_ == Membership::Invite)
+		object["membership"] = "invite";
+	else if (membership_state_ == Membership::Join)
+		object["membership"] = "join";
+	else if (membership_state_ == Membership::Knock)
+		object["membership"] = "knock";
+	else if (membership_state_ == Membership::Leave)
+		object["membership"] = "leave";
+
+	if (!avatar_url_.isEmpty())
+		object["avatar_url"] = avatar_url_.toString();
+
+	if (!display_name_.isEmpty())
+		object["displayname"] = display_name_;
+
+	return object;
+}

src/events/MessageEventContent.cc

@@ -61,3 +61,11 @@ void MessageEventContent::deserialize(const QJsonValue &data)
 
 	body_ = object.value("body").toString();
 }
+
+QJsonObject MessageEventContent::serialize() const
+{
+	// TODO: Add for all the message contents.
+	QJsonObject object;
+
+	return object;
+}

src/events/NameEventContent.cc

@@ -31,3 +31,13 @@ void NameEventContent::deserialize(const QJsonValue &data)
 
 	name_ = object.value("name").toString();
 }
+
+QJsonObject NameEventContent::serialize() const
+{
+	QJsonObject object;
+
+	if (!name_.isEmpty())
+		object["name"] = name_;
+
+	return object;
+}

src/events/PowerLevelsEventContent.cc

@@ -65,6 +65,34 @@ void PowerLevelsEventContent::deserialize(const QJsonValue &data)
 	}
 }
 
+QJsonObject PowerLevelsEventContent::serialize() const
+{
+	QJsonObject object;
+
+	object["ban"] = ban_;
+	object["invite"] = invite_;
+	object["kick"] = kick_;
+	object["redact"] = redact_;
+
+	object["events_default"] = events_default_;
+	object["users_default"] = users_default_;
+	object["state_default"] = state_default_;
+
+	QJsonObject users;
+	QJsonObject events;
+
+	for (auto it = users_.constBegin(); it != users_.constEnd(); it++)
+		users.insert(it.key(), it.value());
+
+	for (auto it = events_.constBegin(); it != events_.constEnd(); it++)
+		events.insert(it.key(), it.value());
+
+	object["users"] = users;
+	object["events"] = events;
+
+	return object;
+}
+
 int PowerLevelsEventContent::eventLevel(QString event_type) const
 {
 	if (events_.contains(event_type))

src/events/TopicEventContent.cc

@@ -31,3 +31,13 @@ void TopicEventContent::deserialize(const QJsonValue &data)
 
 	topic_ = object.value("topic").toString();
 }
+
+QJsonObject TopicEventContent::serialize() const
+{
+	QJsonObject object;
+
+	if (!topic_.isEmpty())
+		object["topic"] = topic_;
+
+	return object;
+}

tests/events.cc

@@ -1,4 +1,5 @@
 #include <gtest/gtest.h>
+#include <QDebug>
 #include <QJsonArray>
 
 #include "Event.h"
@@ -28,6 +29,7 @@ TEST(BaseEvent, Deserialization)
 	Event<NameEventContent> name_event;
 	name_event.deserialize(data);
 	EXPECT_EQ(name_event.content().name(), "Room Name");
+	EXPECT_EQ(name_event.serialize(), data);
 
 	// TopicEventContent
 	data = QJsonObject{
@@ -37,6 +39,7 @@ TEST(BaseEvent, Deserialization)
 	Event<TopicEventContent> topic_event;
 	topic_event.deserialize(data);
 	EXPECT_EQ(topic_event.content().topic(), "Room Topic");
+	EXPECT_EQ(topic_event.serialize(), data);
 
 	// AvatarEventContent
 	data = QJsonObject{
@@ -46,6 +49,7 @@ TEST(BaseEvent, Deserialization)
 	Event<AvatarEventContent> avatar_event;
 	avatar_event.deserialize(data);
 	EXPECT_EQ(avatar_event.content().url().toString(), "https://matrix.org");
+	EXPECT_EQ(avatar_event.serialize(), data);
 
 	// AliasesEventContent
 	data = QJsonObject{
@@ -55,6 +59,7 @@ TEST(BaseEvent, Deserialization)
 	Event<AliasesEventContent> aliases_event;
 	aliases_event.deserialize(data);
 	EXPECT_EQ(aliases_event.content().aliases().size(), 2);
+	EXPECT_EQ(aliases_event.serialize(), data);
 
 	// CreateEventContent
 	data = QJsonObject{
@@ -64,6 +69,7 @@ TEST(BaseEvent, Deserialization)
 	Event<CreateEventContent> create_event;
 	create_event.deserialize(data);
 	EXPECT_EQ(create_event.content().creator(), "@alice:matrix.org");
+	EXPECT_EQ(create_event.serialize(), data);
 
 	// JoinRulesEventContent
 	data = QJsonObject{
@@ -73,6 +79,7 @@ TEST(BaseEvent, Deserialization)
 	Event<JoinRulesEventContent> join_rules_event;
 	join_rules_event.deserialize(data);
 	EXPECT_EQ(join_rules_event.content().joinRule(), JoinRule::Private);
+	EXPECT_EQ(join_rules_event.serialize(), data);
 }
 
 TEST(BaseEvent, DeserializationException)
@@ -110,6 +117,7 @@ TEST(RoomEvent, Deserialization)
 	EXPECT_EQ(event.sender(), "@alice:matrix.org");
 	EXPECT_EQ(event.timestamp(), 1323238293289323);
 	EXPECT_EQ(event.content().name(), "Name");
+	EXPECT_EQ(event.serialize(), data);
 }
 
 TEST(RoomEvent, DeserializationException)
@@ -152,6 +160,7 @@ TEST(StateEvent, Deserialization)
 	EXPECT_EQ(event.content().name(), "Name");
 	EXPECT_EQ(event.stateKey(), "some_state_key");
 	EXPECT_EQ(event.previousContent().name(), "Previous Name");
+	EXPECT_EQ(event.serialize(), data);
 }
 
 TEST(StateEvent, DeserializationException)
@@ -199,6 +208,7 @@ TEST(AliasesEventContent, Deserialization)
 	content.deserialize(data);
 
 	EXPECT_EQ(content.aliases().size(), 2);
+	EXPECT_EQ(content.serialize(), data);
 }
 
 TEST(AliasesEventContent, NotAnObject)
@@ -232,6 +242,7 @@ TEST(AvatarEventContent, Deserialization)
 	content.deserialize(data);
 
 	EXPECT_EQ(content.url().toString(), "https://matrix.org/avatar.png");
+	EXPECT_EQ(content.serialize(), data);
 }
 
 TEST(AvatarEventContent, NotAnObject)
@@ -264,6 +275,7 @@ TEST(CreateEventContent, Deserialization)
 	content.deserialize(data);
 
 	EXPECT_EQ(content.creator(), "@alice:matrix.org");
+	EXPECT_EQ(content.serialize(), data);
 }
 
 TEST(CreateEventContent, NotAnObject)
@@ -419,6 +431,7 @@ TEST(CanonicalAliasEventContent, Deserialization)
 	content.deserialize(data);
 
 	EXPECT_EQ(content.alias(), "Room Alias");
+	EXPECT_EQ(content.serialize(), data);
 }
 
 TEST(CanonicalAliasEventContent, NotAnObject)
@@ -521,6 +534,7 @@ TEST(NameEventContent, Deserialization)
 	content.deserialize(data);
 
 	EXPECT_EQ(content.name(), "Room Name");
+	EXPECT_EQ(content.serialize(), data);
 }
 
 TEST(NameEventContent, NotAnObject)
@@ -599,6 +613,8 @@ TEST(PowerLevelsEventContent, FullDeserialization)
 	EXPECT_EQ(power_levels.eventLevel("m.message.text"), 8);
 	EXPECT_EQ(power_levels.eventLevel("m.message.image"), 9);
 	EXPECT_EQ(power_levels.eventLevel("m.message.gif"), 5);
+
+	EXPECT_EQ(power_levels.serialize(), data);
 }
 
 TEST(PowerLevelsEventContent, PartialDeserialization)
@@ -651,6 +667,7 @@ TEST(TopicEventContent, Deserialization)
 	content.deserialize(data);
 
 	EXPECT_EQ(content.topic(), "Room Topic");
+	EXPECT_EQ(content.serialize(), data);
 }
 
 TEST(TopicEventContent, NotAnObject)