diff --git a/.gitignore b/.gitignore index eeb84fb..904907b 100644 --- a/.gitignore +++ b/.gitignore @@ -53,7 +53,6 @@ Makefile.in /src/matrix-http-client.c /src/namespace-info.vala /src/namespace-info.c -/src/matrix-event-room-history-visibility.c /src/matrix-event-room-join-rules.c /src/matrix-event-room-canonical-alias.c /src/matrix-event-room-create.c diff --git a/src/Makefile.am b/src/Makefile.am index 0de0c3e..3671f43 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -21,7 +21,6 @@ libmatrix_glib_0_0_la_VALA_SOURCES = \ matrix-client.vala \ matrix-http-api.vala \ matrix-http-client.vala \ - matrix-event-room-history-visibility.vala \ matrix-event-room-join-rules.vala \ matrix-event-room-canonical-alias.vala \ matrix-event-room-create.vala \ @@ -110,6 +109,7 @@ INST_H_SRC_FILES = \ matrix-event-room-avatar.h \ matrix-event-room-name.h \ matrix-event-room-message.h \ + matrix-event-room-history-visibility.h \ matrix-event-typing.h \ matrix-event-receipt.h \ utils.h \ @@ -158,6 +158,7 @@ libmatrix_glib_0_0_la_SOURCES = \ matrix-event-room-avatar.c \ matrix-event-room-name.c \ matrix-event-room-message.c \ + matrix-event-room-history-visibility.c \ matrix-profile.c \ matrix-room.c \ utils.c \ diff --git a/src/matrix-event-room-history-visibility.c b/src/matrix-event-room-history-visibility.c new file mode 100644 index 0000000..d1138df --- /dev/null +++ b/src/matrix-event-room-history-visibility.c @@ -0,0 +1,262 @@ +/* + * 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-room-history-visibility.h" +#include "utils.h" + +/** + * SECTION:matrix-event-room-history-visibility + * @short_description: event to control history visibility to room members + * + * This is the default event handler for `m.room.history_visibility` events. + * + * This event controls whether a user can see the events that happened in a room from before + * they joined. + */ +enum { + PROP_0, + PROP_VISIBILITY, + NUM_PROPERTIES +}; + +static GParamSpec *matrix_event_room_history_visibility_properties[NUM_PROPERTIES]; + +typedef struct { + MatrixHistoryVisibility _visibility; +} MatrixEventRoomHistoryVisibilityPrivate; + +/** + * MatrixEventRoomHistoryVisibility: + */ +G_DEFINE_TYPE_WITH_PRIVATE(MatrixEventRoomHistoryVisibility, matrix_event_room_history_visibility, MATRIX_EVENT_TYPE_STATE); + +static void +matrix_event_room_history_visibility_real_from_json(MatrixEventBase *matrix_event_base, JsonNode *json_data, GError **error) +{ + MatrixEventRoomHistoryVisibilityPrivate *priv; + JsonObject *root; + JsonObject *content_root; + JsonNode *content_node; + JsonNode *node; + + g_return_if_fail (json_data != NULL); + + priv = matrix_event_room_history_visibility_get_instance_private(MATRIX_EVENT_ROOM_HISTORY_VISIBILITY(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); + +#ifdef DEBUG + if ((node = json_object_get_member(root, "state_key")) != NULL) { + const gchar *state_key = json_node_get_string(node); + + if ((state_key == NULL) || (*state_key == 0)) { + g_warning("state_key of a m.room.history_visibility event is non-empty"); + } + } +#endif + + if ((node = json_object_get_member(content_root, "history_visibility")) != NULL) { + GError *inner_error = NULL; + MatrixHistoryVisibility visibility = _matrix_g_enum_nick_to_value(MATRIX_TYPE_HISTORY_VISIBILITY, json_node_get_string(node), &inner_error); + + if (inner_error != NULL) { + priv->_visibility = MATRIX_HISTORY_VISIBILITY_UNKNOWN; +#ifdef DEBUG + g_warning("Unknown history_visibility value %s", json_node_get_string(node)); +#endif + } else { + priv->_visibility = visibility; + } + } + + MATRIX_EVENT_BASE_CLASS(matrix_event_room_history_visibility_parent_class)->from_json(matrix_event_base, json_data, error); +} + +static void +matrix_event_room_history_visibility_real_to_json(MatrixEventBase *matrix_event_base, JsonNode *json_data, GError **error) +{ + MatrixEventRoomHistoryVisibilityPrivate *priv; + JsonObject *root; + JsonObject *content_root; + JsonNode *content_node; + const gchar *state_key; + gchar *visibility_str; + + g_return_if_fail (json_data != NULL); + + priv = matrix_event_room_history_visibility_get_instance_private(MATRIX_EVENT_ROOM_HISTORY_VISIBILITY(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); + + state_key = matrix_event_state_get_state_key(MATRIX_EVENT_STATE(matrix_event_base)); + + if ((state_key == NULL) || (*state_key == 0)) { + g_set_error(error, MATRIX_ERROR, MATRIX_ERROR_INCOMPLETE, + "Won't generate a m.room.history_visibility event with a non-empty state key"); + + return; + } + + if (priv->_visibility == MATRIX_HISTORY_VISIBILITY_UNKNOWN) { + g_set_error(error, MATRIX_ERROR, MATRIX_ERROR_UNKNOWN_VALUE, + "Won't send m.room.history_visibility event with unknown visibility value"); + + return; + } + + visibility_str = _matrix_g_enum_to_string(MATRIX_TYPE_HISTORY_VISIBILITY, priv->_visibility, '_'); + + json_object_set_string_member(content_root, "history_visibility", visibility_str); + + g_free(visibility_str); + + MATRIX_EVENT_BASE_CLASS(matrix_event_room_history_visibility_parent_class)->to_json(matrix_event_base, json_data, error); +} + +MatrixEventRoomHistoryVisibility * +matrix_event_room_history_visibility_construct(GType object_type) +{ + return (MatrixEventRoomHistoryVisibility *)matrix_event_state_construct(object_type); +} + +/** + * matrix_event_room_history_visibility_new: + * + * Create a new #MatrixEventRoomHistoryVisibility object. + * + * Returns: (transfer full): a new #MatrixEventRoomHistoryVisibility object + */ +MatrixEventRoomHistoryVisibility * +matrix_event_room_history_visibility_new(void) +{ + return matrix_event_room_history_visibility_construct(MATRIX_EVENT_TYPE_ROOM_HISTORY_VISIBILITY); +} + +/** + * matrix_event_room_history_visibility_get_visibility: + * @event: a #MatrixEventRoomHistoryVisibility + * + * Get the history visibility status of the room. + * + * Returns: a #MatrixHistoryVisibility value + */ +MatrixHistoryVisibility +matrix_event_room_history_visibility_get_visibility(MatrixEventRoomHistoryVisibility *matrix_event_room_history_visibility) +{ + MatrixEventRoomHistoryVisibilityPrivate *priv; + + g_return_val_if_fail(matrix_event_room_history_visibility != NULL, 0); + + priv = matrix_event_room_history_visibility_get_instance_private(matrix_event_room_history_visibility); + + return priv->_visibility; +} + +/** + * matrix_event_room_history_visibility_set_visibility: + * @event: a #MatrixEventRoomHistoryVisibility + * @history_visibility: a #MatrixHistoryVisibility value + * + * Set the history visibility in @event. + */ +void +matrix_event_room_history_visibility_set_visibility(MatrixEventRoomHistoryVisibility *matrix_event_room_history_visibility, MatrixHistoryVisibility visibility) +{ + MatrixEventRoomHistoryVisibilityPrivate *priv; + + g_return_if_fail(matrix_event_room_history_visibility != NULL); + + priv = matrix_event_room_history_visibility_get_instance_private(matrix_event_room_history_visibility); + + if (priv->_visibility != visibility) { + priv->_visibility = visibility; + + g_object_notify_by_pspec((GObject *)matrix_event_room_history_visibility, matrix_event_room_history_visibility_properties[PROP_VISIBILITY]); + } +} + +static void +matrix_event_room_history_visibility_finalize(GObject *gobject) { + G_OBJECT_CLASS(matrix_event_room_history_visibility_parent_class)->finalize(gobject); +} + +static void +matrix_event_room_history_visibility_get_property(GObject *gobject, guint property_id, GValue *value, GParamSpec *pspec) +{ + MatrixEventRoomHistoryVisibility *matrix_event_room_history_visibility = MATRIX_EVENT_ROOM_HISTORY_VISIBILITY(gobject); + + switch (property_id) { + case PROP_VISIBILITY: + g_value_set_enum(value, matrix_event_room_history_visibility_get_visibility(matrix_event_room_history_visibility)); + + break; + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(gobject, property_id, pspec); + + break; + } +} + +static void +matrix_event_room_history_visibility_set_property(GObject *gobject, guint property_id, const GValue *value, GParamSpec *pspec) +{ + MatrixEventRoomHistoryVisibility *matrix_event_room_history_visibility = MATRIX_EVENT_ROOM_HISTORY_VISIBILITY(gobject); + + switch (property_id) { + case PROP_VISIBILITY: + matrix_event_room_history_visibility_set_visibility(matrix_event_room_history_visibility, g_value_get_enum(value)); + + break; + default: + G_OBJECT_WARN_INVALID_PROPERTY_ID(gobject, property_id, pspec); + + break; + } +} + +static void +matrix_event_room_history_visibility_class_init(MatrixEventRoomHistoryVisibilityClass *klass) +{ + ((MatrixEventBaseClass *)klass)->from_json = matrix_event_room_history_visibility_real_from_json; + ((MatrixEventBaseClass *)klass)->to_json = matrix_event_room_history_visibility_real_to_json; + G_OBJECT_CLASS(klass)->get_property = matrix_event_room_history_visibility_get_property; + G_OBJECT_CLASS(klass)->set_property = matrix_event_room_history_visibility_set_property; + G_OBJECT_CLASS(klass)->finalize = matrix_event_room_history_visibility_finalize; + + /** + * MatrixEventRoomHistoryVisibiliy:visibility: + * + * Who can see the room history. + */ + matrix_event_room_history_visibility_properties[PROP_VISIBILITY] = g_param_spec_enum( + "visibility", "visibility", "visibility", + MATRIX_TYPE_HISTORY_VISIBILITY, MATRIX_HISTORY_VISIBILITY_UNKNOWN, + G_PARAM_STATIC_STRINGS | G_PARAM_READWRITE); + g_object_class_install_property(G_OBJECT_CLASS(klass), PROP_VISIBILITY, matrix_event_room_history_visibility_properties[PROP_VISIBILITY]); +} + +static void +matrix_event_room_history_visibility_init(MatrixEventRoomHistoryVisibility *matrix_event_room_history_visibility) +{ + MatrixEventRoomHistoryVisibilityPrivate *priv = matrix_event_room_history_visibility_get_instance_private(matrix_event_room_history_visibility); + + priv->_visibility = MATRIX_HISTORY_VISIBILITY_UNKNOWN; +} diff --git a/src/matrix-event-room-history-visibility.h b/src/matrix-event-room-history-visibility.h new file mode 100644 index 0000000..af1f61c --- /dev/null +++ b/src/matrix-event-room-history-visibility.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_ROOM_HISTORY_VISIBILITY_H__ +# define __MATRIX_GLIB_SDK_EVENT_ROOM_HISTORY_VISIBILITY_H__ + +# include +# include "matrix-event-state-base.h" +# include "matrix-enumtypes.h" + +G_BEGIN_DECLS + +#define MATRIX_EVENT_TYPE_ROOM_HISTORY_VISIBILITY (matrix_event_room_history_visibility_get_type ()) +G_DECLARE_DERIVABLE_TYPE(MatrixEventRoomHistoryVisibility, matrix_event_room_history_visibility, MATRIX_EVENT, ROOM_HISTORY_VISIBILITY, MatrixEventState); + +struct _MatrixEventRoomHistoryVisibilityClass { + MatrixEventStateClass parent_class; +}; + +MatrixEventRoomHistoryVisibility *matrix_event_room_history_visibility_new(void); +MatrixEventRoomHistoryVisibility *matrix_event_room_history_visibility_construct(GType object_type); +MatrixHistoryVisibility matrix_event_room_history_visibility_get_visibility(MatrixEventRoomHistoryVisibility *event); +void matrix_event_room_history_visibility_set_visibility(MatrixEventRoomHistoryVisibility *event, MatrixHistoryVisibility history_visibility); + +G_END_DECLS + +#endif /* __MATRIX_GLIB_SDK_EVENT_ROOM_HISTORY_VISIBILITY_H__ */ diff --git a/src/matrix-event-room-history-visibility.vala b/src/matrix-event-room-history-visibility.vala deleted file mode 100644 index fbd0502..0000000 --- a/src/matrix-event-room-history-visibility.vala +++ /dev/null @@ -1,89 +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 a m.room.history_visibility event. - * - * This event controls whether a user can see the events that happened - * in a room from before they joined. - */ -public class Matrix.Event.RoomHistoryVisibility : Matrix.Event.State { - /** - * Who can see the room history. - */ - public Matrix.HistoryVisibility visibility { - get; set; - - default = Matrix.HistoryVisibility.UNKNOWN; - } - - 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 = null; - - if (Config.DEBUG && ((node = root.get_member("state_key")) != null)) { - if (node.get_string() != "") { - warning("state_key of a m.room.history_visibility event is non-empty"); - } - } - - if ((node = content_root.get_member("history_visibility")) != null) { - try { - _visibility = (Matrix.HistoryVisibility)_g_enum_nick_to_value( - typeof(Matrix.HistoryVisibility), node.get_string()); - } catch (Matrix.Error e) { - _visibility = Matrix.HistoryVisibility.UNKNOWN; - - if (Config.DEBUG) { - warning("Unknown history_visibility value %s", node.get_string()); - } - } - } - - base.from_json(json_data); - } - - protected override void - to_json(Json.Node json_data) - throws Matrix.Error - { - var content_root = json_data.get_object() - .get_member("content").get_object(); - - if (_state_key != "") { - throw new Matrix.Error.INCOMPLETE( - "Won't generate a m.room.history_visibility event with a non-empty state key"); - } - - if (visibility == Matrix.HistoryVisibility.UNKNOWN) { - throw new Matrix.Error.UNKNOWN_VALUE( - "Won't send m.room.history_visibility event with unknown visibility value"); - } - - content_root.set_string_member("history_visibility", - _g_enum_value_to_nick( - typeof(Matrix.HistoryVisibility), - visibility)); - - base.to_json(json_data); - } -} diff --git a/src/matrix-event-types.c b/src/matrix-event-types.c index fc1b3f4..acd8760 100644 --- a/src/matrix-event-types.c +++ b/src/matrix-event-types.c @@ -28,6 +28,7 @@ #include "matrix-event-room-avatar.h" #include "matrix-event-room-name.h" #include "matrix-event-room-message.h" +#include "matrix-event-room-history-visibility.h" #include "matrix-message-text.h" #include "matrix-message-location.h" diff --git a/vapi/c-api.vapi b/vapi/c-api.vapi index 40db7ee..5b469b4 100644 --- a/vapi/c-api.vapi +++ b/vapi/c-api.vapi @@ -718,6 +718,17 @@ namespace Matrix { protected override void to_json(Json.Node json_data) throws Matrix.Error; } + + [CCode (cheader_filename = "matrix-event-room-history-visibility.h")] + public class RoomHistoryVisibility : State { + public Matrix.HistoryVisibility visibility { get; set; default = Matrix.HistoryVisibility.UNKNOWN; } + + protected override void from_json(Json.Node json_data) + throws Matrix.Error; + + protected override void to_json(Json.Node json_data) + throws Matrix.Error; + } } [CCode (gir_namespace = "MatrixMessage", gir_version = "0.0")]