diff --git a/.gitignore b/.gitignore index 96f3923..9b0e268 100644 --- a/.gitignore +++ b/.gitignore @@ -55,7 +55,6 @@ Makefile.in /src/namespace-info.vala /src/namespace-info.c /src/matrix-event-room-topic.c -/src/matrix-event-typing.c /src/matrix-event-room-aliases.c /src/matrix-event-receipt.c /src/matrix-event-room-history-visibility.c diff --git a/src/Makefile.am b/src/Makefile.am index d82471d..8f14f20 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -23,7 +23,6 @@ libmatrix_glib_0_0_la_VALA_SOURCES = \ matrix-http-client.vala \ matrix-event-room-message.vala \ matrix-event-room-topic.vala \ - matrix-event-typing.vala \ matrix-event-room-aliases.vala \ matrix-event-receipt.vala \ matrix-event-room-history-visibility.vala \ @@ -113,6 +112,7 @@ INST_H_SRC_FILES = \ matrix-event-tag.h \ matrix-event-presence.h \ matrix-event-room-member.h \ + matrix-event-typing.h \ utils.h \ matrix-profile.h \ $(NULL) @@ -139,6 +139,7 @@ libmatrix_glib_0_0_la_SOURCES = \ matrix-event-tag.c \ matrix-event-presence.c \ matrix-event-room-member.c \ + matrix-event-typing.c \ matrix-event-room-base.c \ matrix-event-state-base.c \ matrix-profile.c \ diff --git a/src/matrix-event-types.c b/src/matrix-event-types.c index 46b079d..a1eeecd 100644 --- a/src/matrix-event-types.c +++ b/src/matrix-event-types.c @@ -20,6 +20,7 @@ #include "matrix-marshalers.h" #include "matrix-event-tag.h" #include "matrix-event-presence.h" +#include "matrix-event-typing.h" #include "matrix-event-room-member.h" /* diff --git a/src/matrix-event-typing.c b/src/matrix-event-typing.c new file mode 100644 index 0000000..7c1acfa --- /dev/null +++ b/src/matrix-event-typing.c @@ -0,0 +1,333 @@ +/* + * 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-typing.h" +#include "matrix-types.h" +#include "config.h" + +/** + * SECTION:matrix-event-typing + * @short_description: event to inform clients of the typing users + * + * This is the default event handler for `m.typing` events. + * + * Informs the client of the list of users currently typing. + */ +enum { + PROP_0, + PROP_ROOM_ID, + PROP_USER_IDS, + NUM_PROPS +}; + +static GParamSpec* matrix_event_typing_properties[NUM_PROPS]; + +typedef struct { + gchar* _room_id; + gchar** _user_ids; + gint _user_ids_len; + gint __user_ids_size_; +} MatrixEventTypingPrivate; + +/** + * MatrixEventTyping: + */ +G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE(MatrixEventTyping, matrix_event_typing, MATRIX_EVENT_TYPE_BASE); + +static void +set_user_id(JsonArray *ary, guint idx, JsonNode *member_node, gpointer user_data) { + gchar **user_ids = (gchar **)user_data; + + user_ids[idx] = g_strdup(json_node_get_string(member_node)); +} + +static void +matrix_event_typing_real_from_json(MatrixEventBase *matrix_event_base, JsonNode *json_data, GError **error) +{ + MatrixEventTypingPrivate *priv = matrix_event_typing_get_instance_private(MATRIX_EVENT_TYPING(matrix_event_base)); + JsonObject *root; + JsonObject *content_root; + JsonNode *content_node; + JsonNode *node; + GError *inner_error = NULL; + + 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.typing event"); + } + + if ((node = json_object_get_member(content_root, "user_ids")) != NULL) { + JsonArray *user_ids_ary = json_node_get_array(node); + gint user_ids_len = json_array_get_length(user_ids_ary); + + for (int i = 0; i < priv->_user_ids_len; i++) { + g_free(priv->_user_ids[i]); + } + g_free(priv->_user_ids); + + priv->_user_ids = g_new(gchar *, user_ids_len); + + for (int i = 0; i < user_ids_len; i++) { + json_array_foreach_element(user_ids_ary, set_user_id, priv->_user_ids); + } + + priv->_user_ids_len = user_ids_len; + } else if (DEBUG) { + g_warning("content.user_ids is missing from a m.typing event"); + } + + MATRIX_EVENT_BASE_CLASS(matrix_event_typing_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_typing_real_to_json(MatrixEventBase *matrix_event_base, JsonNode *json_data, GError **error) +{ + MatrixEventTypingPrivate *priv = matrix_event_typing_get_instance_private(MATRIX_EVENT_TYPING(matrix_event_base)); + JsonObject *root; + JsonObject *content_root; + JsonArray *user_ids_ary; + JsonNode *content_node; + JsonNode *user_ids_node; + GError *inner_error = NULL; + + if (priv->_room_id == NULL) { + g_set_error(error, MATRIX_ERROR, MATRIX_ERROR_INCOMPLETE, + "Won't generate a m.typing event 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); + + json_object_set_string_member(root, "room_id", priv->_room_id); + + user_ids_ary = json_array_new(); + user_ids_node = json_node_new(JSON_NODE_ARRAY); + json_object_set_member(content_root, "user_ids", user_ids_node); + json_node_set_array(user_ids_node, user_ids_ary); + + for (gint i = 0; i < priv->_user_ids_len; i++) { + json_array_add_string_element(user_ids_ary, priv->_user_ids[i]); + } + + MATRIX_EVENT_BASE_CLASS(matrix_event_typing_parent_class)->to_json(matrix_event_base, json_data, &inner_error); + + if (inner_error != NULL) { + g_propagate_error (error, inner_error); + } +} + +MatrixEventTyping * +matrix_event_typing_new(void) +{ + return (MatrixEventTyping *)matrix_event_base_construct(MATRIX_EVENT_TYPE_TYPING); +} + +const gchar * +matrix_event_typing_get_room_id(MatrixEventTyping *matrix_event_typing) +{ + MatrixEventTypingPrivate *priv; + + g_return_val_if_fail(matrix_event_typing != NULL, NULL); + + priv = matrix_event_typing_get_instance_private(matrix_event_typing); + + return priv->_room_id; +} + +void +matrix_event_typing_set_room_id(MatrixEventTyping *matrix_event_typing, const gchar *room_id) +{ + MatrixEventTypingPrivate *priv; + + g_return_if_fail(matrix_event_typing != NULL); + + priv = matrix_event_typing_get_instance_private(matrix_event_typing); + + 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_typing, matrix_event_typing_properties[PROP_ROOM_ID]); + } +} + +/** + * matrix_event_typing_get_user_ids: + * @event: a #MatrixEventTyping + * @n_user_ids: (nullable): placeholder for the length of the returned list + * + * Returns: (transfer none): a list of typing users + */ +gchar ** +matrix_event_typing_get_user_ids(MatrixEventTyping *matrix_event_typing, int *n_user_ids) +{ + MatrixEventTypingPrivate *priv; + + g_return_val_if_fail(matrix_event_typing != NULL, NULL); + + priv = matrix_event_typing_get_instance_private(matrix_event_typing); + + if (n_user_ids != NULL) { + *n_user_ids = priv->_user_ids_len; + } + + return priv->_user_ids; +} + +void +matrix_event_typing_set_user_ids(MatrixEventTyping *matrix_event_typing, gchar **user_ids, int n_user_ids) +{ + MatrixEventTypingPrivate *priv; + + g_return_if_fail(matrix_event_typing != NULL); + + priv = matrix_event_typing_get_instance_private(matrix_event_typing); + + if (priv->_user_ids != user_ids) { + for (gint i = 0; i < priv->_user_ids_len; i++) { + g_free(priv->_user_ids[i]); + } + + g_free(priv->_user_ids); + + priv->_user_ids = g_new(gchar *, n_user_ids); + + for (gint i = 0; i < n_user_ids; i++) { + priv->_user_ids[i] = g_strdup(user_ids[i]); + } + + priv->_user_ids_len = n_user_ids; + + g_object_notify_by_pspec((GObject *)matrix_event_typing, matrix_event_typing_properties[PROP_USER_IDS]); + } +} + +static void +matrix_event_typing_finalize(GObject *gobject) +{ + MatrixEventTypingPrivate *priv = matrix_event_typing_get_instance_private(MATRIX_EVENT_TYPING(gobject)); + + g_free(priv->_room_id); + + for (gint i = 0; i < priv->_user_ids_len; i++) { + g_free(priv->_user_ids[i]); + } + + priv->_user_ids = (g_free(priv->_user_ids), NULL); + + G_OBJECT_CLASS(matrix_event_typing_parent_class)->finalize(gobject); +} + +static void +matrix_event_typing_get_property(GObject *gobject, guint property_id, GValue* value, GParamSpec* pspec) +{ + MatrixEventTyping *matrix_event_typing = G_TYPE_CHECK_INSTANCE_CAST(gobject, MATRIX_EVENT_TYPE_TYPING, MatrixEventTyping); + + switch (property_id) { + case PROP_ROOM_ID: + g_value_set_string(value, matrix_event_typing_get_room_id(matrix_event_typing)); + + break; + case PROP_USER_IDS: + g_value_set_boxed(value, matrix_event_typing_get_user_ids(matrix_event_typing, NULL)); + + break; + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(gobject, property_id, pspec); + + break; + } +} + +static void +matrix_event_typing_set_property(GObject *gobject, guint property_id, const GValue *value, GParamSpec* pspec) +{ + MatrixEventTyping *matrix_event_typing = G_TYPE_CHECK_INSTANCE_CAST(gobject, MATRIX_EVENT_TYPE_TYPING, MatrixEventTyping); + + switch (property_id) { + case PROP_ROOM_ID: + matrix_event_typing_set_room_id(matrix_event_typing, g_value_get_string (value)); + + break; + case PROP_USER_IDS: + { + gpointer boxed = g_value_get_boxed(value); + + matrix_event_typing_set_user_ids(matrix_event_typing, boxed, (boxed == NULL) ? 0 : g_strv_length(boxed)); + + break; + } + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(gobject, property_id, pspec); + + break; + } +} + +static void +matrix_event_typing_class_init(MatrixEventTypingClass *klass) +{ + ((MatrixEventBaseClass *)klass)->from_json = matrix_event_typing_real_from_json; + ((MatrixEventBaseClass *)klass)->to_json = matrix_event_typing_real_to_json; + G_OBJECT_CLASS(klass)->get_property = matrix_event_typing_get_property; + G_OBJECT_CLASS(klass)->set_property = matrix_event_typing_set_property; + G_OBJECT_CLASS(klass)->finalize = matrix_event_typing_finalize; + + /** + * MatrixEventTyping:room-id: + * + * The ID of the room this event belongs to. + */ + matrix_event_typing_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_typing_properties[PROP_ROOM_ID]); + + /** + * MatrixEventTyping:user-ids: + * + * The list of user IDs typing in this room, if any. + */ + matrix_event_typing_properties[PROP_USER_IDS] = g_param_spec_boxed( + "user-ids", "user-ids", "user-ids", + G_TYPE_STRV, + G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE); + g_object_class_install_property(G_OBJECT_CLASS(klass), PROP_USER_IDS, matrix_event_typing_properties[PROP_USER_IDS]); +} + +static void +matrix_event_typing_init(MatrixEventTyping *matrix_event_typing) +{ + MatrixEventTypingPrivate *priv = matrix_event_typing_get_instance_private(matrix_event_typing); + + priv->_room_id = NULL; +} diff --git a/src/matrix-event-typing.h b/src/matrix-event-typing.h new file mode 100644 index 0000000..08a129b --- /dev/null +++ b/src/matrix-event-typing.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_TYPING_H__ +# define __MATRIX_GLIB_SDK_EVENT_TYPING_H__ + +# include +# include "matrix-event-base.h" + +G_BEGIN_DECLS + +# define MATRIX_EVENT_TYPE_TYPING matrix_event_typing_get_type() +G_DECLARE_DERIVABLE_TYPE(MatrixEventTyping, matrix_event_typing, MATRIX_EVENT, TYPING, MatrixEventBase) + +struct _MatrixEventTypingClass { + MatrixEventBaseClass parent_class; +}; + +MatrixEventTyping* matrix_event_typing_new(void); +const gchar* matrix_event_typing_get_room_id(MatrixEventTyping *event); +void matrix_event_typing_set_room_id(MatrixEventTyping *event, const gchar *room_id); +gchar **matrix_event_typing_get_user_ids(MatrixEventTyping *event, int *n_user_ids); +void matrix_event_typing_set_user_ids(MatrixEventTyping *event, gchar **user_ids, int n_user_ids); + +G_END_DECLS + +#endif /* __MATRIX_GLIB_SDK_EVENT_TYPING_H__ */ diff --git a/src/matrix-event-typing.vala b/src/matrix-event-typing.vala deleted file mode 100644 index d6bdfdb..0000000 --- a/src/matrix-event-typing.vala +++ /dev/null @@ -1,86 +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 an m.typing event. - * - * Informs the client of the list of users currently typing. - */ -public class Matrix.Event.Typing : Matrix.Event.Base { - /** - * The ID of the room this event belongs to. - */ - public string? room_id { get; set; default = null; } - - /** - * The list of user IDs typing in this room, if any. - */ - public string[] user_ids { get; set; } - - 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.typing event"); - } - - if ((node = content_root.get_member("user_ids")) != null) { - _user_ids = new string[node.get_array().get_length()]; - - node.get_array().foreach_element((ary, idx, user_node) => { - _user_ids[idx] = user_node.get_string(); - }); - } else if (Config.DEBUG) { - warning("content.user_ids is missing from a m.typing event"); - } - - base.from_json(json_data); - } - - protected override void - to_json(Json.Node json_data) - throws Matrix.Error - { - if (_room_id == null) { - throw new Matrix.Error.INCOMPLETE( - "Won't generate a m.typing event without room_id"); - } - - var root = json_data.get_object(); - var content_root = root.get_member("content").get_object(); - - root.set_string_member("room_id", _room_id); - - var users_ary = new Json.Array(); - var users_node = new Json.Node(Json.NodeType.ARRAY); - content_root.set_member("user_ids", users_node); - - foreach (var entry in _user_ids) { - users_ary.add_string_element(entry); - } - - base.to_json(json_data); - } -} diff --git a/vapi/c-api.vapi b/vapi/c-api.vapi index c5f65e8..fd5e6d5 100644 --- a/vapi/c-api.vapi +++ b/vapi/c-api.vapi @@ -570,5 +570,17 @@ namespace Matrix { to_json(Json.Node json_data) throws Matrix.Error; } + + [CCode (cheader_filename = "matrix-event-typing.h")] + public class Typing : Base { + public string? room_id { get; set; default = null; } + public string[] user_ids { get; set; } + + protected override void from_json(Json.Node json_data) + throws Matrix.Error; + + protected override void to_json(Json.Node json_data) + throws Matrix.Error; + } } }