From 75c255ac9dc9cacb5fdc4500285c5d421cdcb767 Mon Sep 17 00:00:00 2001 From: Gergely Polonkai Date: Tue, 14 Nov 2017 17:52:07 +0100 Subject: [PATCH] Port MatrixEventReceipt to C --- .gitignore | 1 - src/Makefile.am | 3 +- src/matrix-event-receipt.c | 401 ++++++++++++++++++++++++++++++++++ src/matrix-event-receipt.h | 42 ++++ src/matrix-event-receipt.vala | 171 --------------- src/matrix-event-types.c | 1 + 6 files changed, 446 insertions(+), 173 deletions(-) create mode 100644 src/matrix-event-receipt.c create mode 100644 src/matrix-event-receipt.h delete mode 100644 src/matrix-event-receipt.vala diff --git a/.gitignore b/.gitignore index 9b0e268..b9b2ce9 100644 --- a/.gitignore +++ b/.gitignore @@ -56,7 +56,6 @@ Makefile.in /src/namespace-info.c /src/matrix-event-room-topic.c /src/matrix-event-room-aliases.c -/src/matrix-event-receipt.c /src/matrix-event-room-history-visibility.c /src/matrix-event-room-join-rules.c /src/matrix-event-room-name.c diff --git a/src/Makefile.am b/src/Makefile.am index 8f14f20..19a2ebd 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -24,7 +24,6 @@ libmatrix_glib_0_0_la_VALA_SOURCES = \ matrix-event-room-message.vala \ matrix-event-room-topic.vala \ matrix-event-room-aliases.vala \ - matrix-event-receipt.vala \ matrix-event-room-history-visibility.vala \ matrix-event-room-join-rules.vala \ matrix-event-room-name.vala \ @@ -113,6 +112,7 @@ INST_H_SRC_FILES = \ matrix-event-presence.h \ matrix-event-room-member.h \ matrix-event-typing.h \ + matrix-event-receipt.h \ utils.h \ matrix-profile.h \ $(NULL) @@ -142,6 +142,7 @@ libmatrix_glib_0_0_la_SOURCES = \ matrix-event-typing.c \ matrix-event-room-base.c \ matrix-event-state-base.c \ + matrix-event-receipt.c \ matrix-profile.c \ utils.c \ matrix-enumtypes.c \ diff --git a/src/matrix-event-receipt.c b/src/matrix-event-receipt.c new file mode 100644 index 0000000..1c14455 --- /dev/null +++ b/src/matrix-event-receipt.c @@ -0,0 +1,401 @@ +/* + * This file is part of matrix-glib-sdk + * + * matrix-glib-sdk 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 3 of the License, or (at your option) any later version. + * + * matrix-glib-sdk 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 matrix-glib-sdk. If not, see + * . + */ + +#include "matrix-event-receipt.h" +#include "matrix-enumtypes.h" +#include "config.h" + +/** + * SECTION:matrix-event-receipt + * @short_description: event to inform clients of new receipts + * + * This is the default event handler for `m.receipt` events. + */ +enum { + PROP_0, + PROP_ROOM_ID, + NUM_PROPS +}; +static GParamSpec* matrix_event_receipt_properties[NUM_PROPS]; + +typedef struct { + gchar *_room_id; + GHashTable *_receipt_data; +} MatrixEventReceiptPrivate; + +/** + * MatrixEventReceipt: + */ +G_DEFINE_TYPE_WITH_PRIVATE(MatrixEventReceipt, matrix_event_receipt, MATRIX_EVENT_TYPE_BASE); + +typedef struct { + gchar *event_id; + gchar *typ; + gchar *user; + guint refcount; +} ReceiptData; + +static gboolean +_rd_equal(ReceiptData *k1, ReceiptData *k2) { + if ((k1 == NULL) && (k2 == NULL)) { + return TRUE; + } + + if ((k1 == NULL) || (k2 == NULL)) { + return FALSE; + } + + return ((g_strcmp0(k1->event_id, k2->event_id) == 0) && + (g_strcmp0(k1->typ, k2->typ) == 0) && + (g_strcmp0(k1->user, k2->user) == 0)); +} + +static void +_rd_free(ReceiptData *receipt_data) { + g_return_if_fail(receipt_data != NULL); + + if ( --receipt_data->refcount == 0) { + g_free(receipt_data->event_id); + g_free(receipt_data->typ); + g_free(receipt_data->user); + + g_free(receipt_data); + } +} + +static void +process_event(JsonObject *obj, const gchar *key, JsonNode *member_node, gpointer user_data) +{ + JsonNode *node; + MatrixEventReceiptPrivate *priv = user_data; + + if ((node = json_object_get_member(json_node_get_object(member_node), "m.read")) != NULL) { + JsonObject *read_obj = json_node_get_object(node); + JsonObjectIter inner_iter; + JsonNode *inner_node; + const gchar *inner_key; + + json_object_iter_init(&inner_iter, read_obj); + + while (json_object_iter_next(&inner_iter, &inner_key, &inner_node)) { + gulong *value; + ReceiptData *rd_key; + + if (priv->_receipt_data == NULL) { + priv->_receipt_data = g_hash_table_new_full(g_direct_hash, (GEqualFunc)_rd_equal, (GDestroyNotify)_rd_free, g_free); + } + + rd_key = g_new(ReceiptData, 1); + rd_key->event_id = g_strdup(key); + rd_key->typ = g_strdup("m.read"); + rd_key->user = g_strdup(inner_key); + + value = g_new(gulong, 1); + *value = json_node_get_int(json_object_get_member(json_node_get_object(inner_node), "ts")); + + g_hash_table_replace(priv->_receipt_data, rd_key, value); + } + } else { + g_warning("content.$event-id.m.read is missing from a m.presence event"); + } +} + +static void +matrix_event_receipt_real_from_json(MatrixEventBase *matrix_event_base, JsonNode *json_data, GError **error) +{ + MatrixEventReceiptPrivate *priv; + JsonObject *root; + JsonObject *content_root; + JsonNode *content_node; + JsonNode *node; + GError *inner_error = NULL; + + g_return_if_fail(json_data != NULL); + + priv = matrix_event_receipt_get_instance_private(MATRIX_EVENT_RECEIPT(matrix_event_base)); + + root = json_node_get_object(json_data); + content_node = json_object_get_member(root, "content"); + content_root = json_node_get_object(content_node); + + if ((node = json_object_get_member(root, "room_id")) != NULL) { + g_free(priv->_room_id); + priv->_room_id = g_strdup(json_node_get_string(node)); + } else if (DEBUG) { + g_warning("room_id is missing from a m.receipt event"); + } + + json_object_foreach_member(content_root, process_event, priv); + + MATRIX_EVENT_BASE_CLASS(matrix_event_receipt_parent_class)->from_json(matrix_event_base, json_data, &inner_error); + + if (inner_error != NULL) { + g_propagate_error(error, inner_error); + } +} + +static void +matrix_event_receipt_real_to_json(MatrixEventBase *matrix_event_base, JsonNode *json_data, GError **error) +{ + MatrixEventReceiptPrivate *priv; + JsonObject *root; + JsonObject *content_root; + JsonNode *content_node; + GHashTableIter iter; + gpointer gh_key; + gpointer gh_value; + gint i = 0; + GError *inner_error = NULL; + + g_return_if_fail(json_data != NULL); + + priv = matrix_event_receipt_get_instance_private(MATRIX_EVENT_RECEIPT(matrix_event_base)); + + if (priv->_room_id == NULL) { + g_set_error(error, MATRIX_ERROR, MATRIX_ERROR_INCOMPLETE, + "Won't generate a m.receipt without room_id"); + + return; + } + + root = json_node_get_object(json_data); + content_node = json_object_get_member(root, "content"); + content_root = json_node_get_object(content_node); + + g_hash_table_iter_init(&iter, priv->_receipt_data); + + while (g_hash_table_iter_next(&iter, &gh_key, &gh_value)) { + ReceiptData *key = gh_key; + gulong value = *(gulong *)gh_value; + JsonObject *event_object; + JsonObject *type_object; + JsonObject *user_object; + JsonNode *node; + + if (key->event_id == NULL) { + g_set_error(error, MATRIX_ERROR, MATRIX_ERROR_INCOMPLETE, + "Won't generate a m.receipt event with an empty event ID"); + + + return; + } + + if (key->typ == NULL) { + g_set_error(error, MATRIX_ERROR, MATRIX_ERROR_INCOMPLETE, + "Won't generate a m.receipt event with an empty receipt type"); + + return; + } + + if (key->user == NULL) { + g_set_error(error, MATRIX_ERROR, MATRIX_ERROR_INCOMPLETE, + "Won't generate a m.receipt event with an empty user ID"); + + return; + } + + i++; + + if ((node = json_object_get_member(content_root, key->event_id)) == NULL) { + event_object = json_object_new(); + node = json_node_new(JSON_TYPE_OBJECT); + json_node_set_object(node, event_object); + json_object_set_member(content_root, key->event_id, node); + } else { + event_object = json_node_get_object(node); + } + + if ((node = json_object_get_member(event_object, key->typ)) == NULL) { + type_object = json_object_new(); + node = json_node_new(JSON_TYPE_OBJECT); + json_node_set_object(node, type_object); + json_object_set_member(event_object, key->typ, node); + } else { + type_object = json_node_get_object(node); + } + + if ((node = json_object_get_member(type_object, key->user)) == NULL) { + user_object = json_object_new(); + node = json_node_new(JSON_TYPE_OBJECT); + json_node_set_object(node, user_object); + json_object_set_member(type_object, key->user, node); + } else { + user_object = json_node_get_object(node); + } + + json_object_set_int_member(user_object, "ts", value); + } + + if (i == 0) { + g_set_error(error, MATRIX_ERROR, MATRIX_ERROR_INCOMPLETE, + "Won't generate a m.receipt event with no receipts"); + + return; + } + + json_object_set_string_member(root, "room_id", priv->_room_id); + + MATRIX_EVENT_BASE_CLASS(matrix_event_receipt_parent_class)->to_json(matrix_event_base, json_data, &inner_error); + + if (inner_error != NULL) { + g_propagate_error(error, inner_error); + } +} + +MatrixEventReceipt * +matrix_event_receipt_construct(GType object_type) +{ + return (MatrixEventReceipt *)matrix_event_base_construct(object_type); +} + +/** + * matrix_event_receipt_new: + * + * Create a new #MatrixEventReceipt object. + * + * Returns: (transfer full): a new #MatrixEventReceipt object + */ +MatrixEventReceipt * +matrix_event_receipt_new(void) +{ + return matrix_event_receipt_construct(MATRIX_EVENT_TYPE_RECEIPT); +} + +/** + * matrix_event_receipt_get_room_id: + * @event: a #MatrixEventReceipt + * + * Get the room ID @event belongs to. + * + * The returned value is owned by @event and should not be freed. + * + * Returns: (transfer none) (nullable): a room ID + */ +const gchar * +matrix_event_receipt_get_room_id(MatrixEventReceipt *matrix_event_receipt) +{ + MatrixEventReceiptPrivate *priv; + + g_return_val_if_fail(matrix_event_receipt != NULL, NULL); + + priv = matrix_event_receipt_get_instance_private(matrix_event_receipt); + + return priv->_room_id; +} + +/** + * matrix_event_receipt_set_room_id: + * @event: a #MatrixEventReceipt + * @room_id: (transfer none) (nullable): a room ID + * + * Set the room ID for @event. + */ +void +matrix_event_receipt_set_room_id(MatrixEventReceipt *matrix_event_receipt, const gchar *room_id) +{ + MatrixEventReceiptPrivate *priv; + + g_return_if_fail(matrix_event_receipt != NULL); + + priv = matrix_event_receipt_get_instance_private(matrix_event_receipt); + + if (g_strcmp0(room_id, priv->_room_id) != 0) { + g_free(priv->_room_id); + priv->_room_id = g_strdup(room_id); + + g_object_notify_by_pspec((GObject *)matrix_event_receipt, matrix_event_receipt_properties[PROP_ROOM_ID]); + } +} + +static void +matrix_event_receipt_finalize(GObject *gobject) +{ + MatrixEventReceiptPrivate *priv = matrix_event_receipt_get_instance_private(MATRIX_EVENT_RECEIPT(gobject)); + + g_free(priv->_room_id); + g_hash_table_unref(priv->_receipt_data); + + G_OBJECT_CLASS(matrix_event_receipt_parent_class)->finalize(gobject); +} + +static void +matrix_event_receipt_get_property(GObject *gobject, guint property_id, GValue *value, GParamSpec *pspec) +{ + MatrixEventReceipt *matrix_event_receipt = MATRIX_EVENT_RECEIPT(gobject); + + switch (property_id) { + case PROP_ROOM_ID: + g_value_set_string(value, matrix_event_receipt_get_room_id(matrix_event_receipt)); + + break; + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(gobject, property_id, pspec); + + break; + } +} + +static void +matrix_event_receipt_set_property(GObject *gobject, guint property_id, const GValue *value, GParamSpec *pspec) +{ + MatrixEventReceipt *matrix_event_receipt = MATRIX_EVENT_RECEIPT(gobject); + + switch (property_id) { + case PROP_ROOM_ID: + matrix_event_receipt_set_room_id(matrix_event_receipt, g_value_get_string(value)); + + break; + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(gobject, property_id, pspec); + + break; + } +} + +static void +matrix_event_receipt_class_init(MatrixEventReceiptClass *klass) +{ + ((MatrixEventBaseClass *)klass)->from_json = matrix_event_receipt_real_from_json; + ((MatrixEventBaseClass *)klass)->to_json = matrix_event_receipt_real_to_json; + + G_OBJECT_CLASS(klass)->get_property = matrix_event_receipt_get_property; + G_OBJECT_CLASS(klass)->set_property = matrix_event_receipt_set_property; + G_OBJECT_CLASS(klass)->finalize = matrix_event_receipt_finalize; + + /** + * MatrixEventReceipt:room-id: + * + * The room ID. + */ + matrix_event_receipt_properties[PROP_ROOM_ID] = g_param_spec_string( + "room-id", "room-id", "room-id", + NULL, + G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE); + g_object_class_install_property(G_OBJECT_CLASS(klass), PROP_ROOM_ID, matrix_event_receipt_properties[PROP_ROOM_ID]); +} + +static void +matrix_event_receipt_init(MatrixEventReceipt *matrix_event_receipt) +{ + MatrixEventReceiptPrivate *priv; + + priv = matrix_event_receipt_get_instance_private(matrix_event_receipt); + + priv->_room_id = NULL; + priv->_receipt_data = NULL; +} diff --git a/src/matrix-event-receipt.h b/src/matrix-event-receipt.h new file mode 100644 index 0000000..7a65a6f --- /dev/null +++ b/src/matrix-event-receipt.h @@ -0,0 +1,42 @@ +/* + * This file is part of matrix-glib-sdk + * + * matrix-glib-sdk 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 3 of the License, or (at your option) any later version. + * + * matrix-glib-sdk 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 matrix-glib-sdk. If not, see + * . + */ + +#ifndef __MATRIX_GLIB_SDK_EVENT_RECEIPT_H__ +# define __MATRIX_GLIB_SDK_EVENT_RECEIPT_H__ + +# include +# include "matrix-event-base.h" + +G_BEGIN_DECLS + +# define MATRIX_EVENT_TYPE_RECEIPT matrix_event_receipt_get_type() +G_DECLARE_DERIVABLE_TYPE(MatrixEventReceipt, matrix_event_receipt, MATRIX_EVENT, RECEIPT, MatrixEventBase); + +struct _MatrixEventReceiptClass { + MatrixEventBaseClass parent_class; +}; + +GType matrix_event_receipt_get_type (void) G_GNUC_CONST; +MatrixEventReceipt* matrix_event_receipt_new (void); +MatrixEventReceipt* matrix_event_receipt_construct (GType object_type); +const gchar* matrix_event_receipt_get_room_id (MatrixEventReceipt *event); +void matrix_event_receipt_set_room_id (MatrixEventReceipt *event, const gchar *room_id); + +G_END_DECLS + +#endif /* __MATRIX_GLIB_SDK_EVENT_RECEIPT_H__ */ diff --git a/src/matrix-event-receipt.vala b/src/matrix-event-receipt.vala deleted file mode 100644 index 2019eae..0000000 --- a/src/matrix-event-receipt.vala +++ /dev/null @@ -1,171 +0,0 @@ -/* - * This file is part of matrix-glib-sdk - * - * matrix-glib-sdk 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 3 of the License, or (at your option) any later version. - * - * matrix-glib-sdk 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 matrix-glib-sdk. If not, see - * . - */ - -/** - * Class to hold m.receipt events. - * - * Informs the client of new receipts. - */ -public class Matrix.Event.Receipt : Matrix.Event.Base { - public string? room_id { get; set; default = null; } - - private struct ReceiptData { - string event_id; - string typ; - string user; - } - - private HashTable _receipt_data = null; - - private static bool - _rd_equal(ReceiptData k1, ReceiptData k2) - { - return ((k1.event_id == k2.event_id) - && (k1.typ == k2.typ) - && (k1.user == k2.user)); - } - - private void - _init_receipt_data() - { - _receipt_data = new HashTable(null, (EqualFunc)_rd_equal); - } - - protected override void - from_json(Json.Node json_data) - throws Matrix.Error - { - var root = json_data.get_object(); - var content_root = root.get_member("content").get_object(); - Json.Node? node; - - if ((node = root.get_member("room_id")) != null) { - _room_id = node.get_string(); - } else if (Config.DEBUG) { - warning("room_id is missing from a m.receipt event"); - } - - content_root.foreach_member((obj, event_id, event_content) => { - if ((node = event_content.get_object() - .get_member("m.read")) != null) { - var read_obj = node.get_object(); - read_obj.foreach_member((robj, r_user_id, r_content) => { - if (_receipt_data == null) { - _init_receipt_data(); - } - - ReceiptData rd_key = ReceiptData() { - event_id = event_id, - typ = "m.read", - user = r_user_id - }; - - _receipt_data[rd_key] = - (ulong)r_content.get_object().get_member("ts").get_int(); - }); - } else { - warning("content.$event-id.m.read is missing from a m.presence event"); - } - }); - - base.from_json(json_data); - } - - protected override void - to_json(Json.Node json_data) - throws Matrix.Error - { - Json.Node? node = null; - - if (_room_id == null) { - throw new Matrix.Error.INCOMPLETE( - "Won't generate a m.receipt without room_id"); - } - - var root = json_data.get_object(); - var content_root = root.get_member("content").get_object(); - int i = 0; - Matrix.Error? error = null; - - _receipt_data.foreach( - (key, value) => { - Json.Object event_object; - Json.Object type_object; - Json.Object user_object; - - if (key.event_id == null) { - error = new Matrix.Error.INCOMPLETE( - "Won't generate a m.receipt event with an empty event ID"); - } - - if (key.typ == null) { - error = new Matrix.Error.INCOMPLETE( - "Won't generate a m.receipt event with an empty receipt type"); - } - - if (key.user == null) { - error = new Matrix.Error.INCOMPLETE( - "Won't generate a m.receipt event with an empty user ID"); - } - - i++; - - if ((node = content_root.get_member(key.event_id)) == null) { - event_object = new Json.Object(); - node = new Json.Node(Json.NodeType.OBJECT); - node.set_object(event_object); - content_root.set_member(key.event_id, node); - } else { - event_object = node.get_object(); - } - - if ((node = event_object.get_member(key.typ)) == null) { - type_object = new Json.Object(); - node = new Json.Node(Json.NodeType.OBJECT); - node.set_object(type_object); - event_object.set_member(key.typ, node); - } else { - type_object = node.get_object(); - } - - if ((node = type_object.get_member(key.user)) == null) { - user_object = new Json.Object(); - node = new Json.Node(Json.NodeType.OBJECT); - node.set_object(user_object); - type_object.set_member(key.user, node); - } else { - user_object = node.get_object(); - } - - user_object.set_int_member("ts", value); - }); - - if (error != null) { - throw error; - } - - if (i == 0) { - throw new Matrix.Error.INCOMPLETE( - "Won't generate a m.receipt event with no receipts"); - } - - root.set_string_member("room_id", _room_id); - - base.to_json(json_data); - } -} diff --git a/src/matrix-event-types.c b/src/matrix-event-types.c index a1eeecd..479ddf0 100644 --- a/src/matrix-event-types.c +++ b/src/matrix-event-types.c @@ -22,6 +22,7 @@ #include "matrix-event-presence.h" #include "matrix-event-typing.h" #include "matrix-event-room-member.h" +#include "matrix-event-receipt.h" /* Borrowed from GLib