Attachment 60827 Details for Bug 49215 – TpMessageMixin: add helpers to implement ChatState

[patch] TpMessageMixin: add helpers to implement ChatState

TpMessageMixin-add-helpers-to-implement-ChatState.patch (text/plain), 12.29 KB, created by Xavier Claessens on 2012-05-01 03:13:11 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Xavier Claessens

Created: 2012-05-01 03:13:11 UTC

Size: 12.29 KB

patch

obsolete

>From ab980602f0727fa89a3c0347719508c161a07c03 Mon Sep 17 00:00:00 2001
>From: Xavier Claessens <xavier.claessens@collabora.co.uk>
>Date: Mon, 30 Apr 2012 13:22:42 +0200
>Subject: [PATCH] TpMessageMixin: add helpers to implement ChatState
>
>https://bugs.freedesktop.org/show_bug.cgi?id=49215
>---
> docs/reference/telepathy-glib-sections.txt |    6 +
> telepathy-glib/message-mixin.c             |  241 ++++++++++++++++++++++++++--
> telepathy-glib/message-mixin.h             |   16 ++
> 3 files changed, 250 insertions(+), 13 deletions(-)
>
>diff --git a/docs/reference/telepathy-glib-sections.txt b/docs/reference/telepathy-glib-sections.txt
>index 1a68f78..a027e5b 100644
>--- a/docs/reference/telepathy-glib-sections.txt
>+++ b/docs/reference/telepathy-glib-sections.txt
>@@ -2672,6 +2672,12 @@ tp_message_mixin_take_received
> tp_message_mixin_has_pending_messages
> tp_message_mixin_clear
> tp_message_mixin_text_iface_init
>+<SUBSECTION>
>+TpMessageMixinSendChatStateImpl
>+tp_message_mixin_chat_state_iface_init
>+tp_message_mixin_change_chat_state
>+tp_message_mixin_implement_send_chat_state
>+tp_message_mixin_maybe_send_gone
> <SUBSECTION Private>
> TpMessageMixinPrivate
> </SECTION>
>diff --git a/telepathy-glib/message-mixin.c b/telepathy-glib/message-mixin.c
>index c4a46e9..8e56c46 100644
>--- a/telepathy-glib/message-mixin.c
>+++ b/telepathy-glib/message-mixin.c
>@@ -49,6 +49,15 @@
>  * tp_message_mixin_implement_sending() in the constructor function. If you do
>  * not, any attempt to send a message will fail with NotImplemented.
>  *
>+ * To support chat state, you must call
>+ * tp_message_mixin_implement_send_chat_state() in the constructor function, and
>+ * include the following in the fourth argument of G_DEFINE_TYPE_WITH_CODE():
>+ *
>+ * <informalexample><programlisting>
>+ *  G_IMPLEMENT_INTERFACE (TP_TYPE_SVC_CHANNEL_INTERFACE_CHAT_STATE,
>+ *    tp_message_mixin_chat_state_iface_init);
>+ * </programlisting></informalexample>
>+ *
>  * Since: 0.7.21
>  */
> 
>@@ -99,6 +108,18 @@ struct _TpMessageMixinPrivate
>   /* Receiving */
>   guint recv_id;
>   GQueue *pending;
>+
>+  /* ChatState */
>+
>+  /* TpHandle -> TpChannelChatState */
>+  GHashTable *chat_states;
>+  TpMessageMixinSendChatStateImpl send_chat_state;
>+  /* FALSE unless at least one chat state notification has been sent; <gone/>
>+   * will only be sent when the channel closes if this is TRUE. This prevents
>+   * opening a channel and closing it immediately sending a spurious <gone/> to
>+   * the peer.
>+   */
>+  gboolean send_gone;
> };
> 
> 
>@@ -294,6 +315,166 @@ tp_message_mixin_implement_sending (GObject *object,
>       (gchar **) supported_content_types);
> }
> 
>+/**
>+ * tp_message_mixin_change_chat_state:
>+ * @object: an instance of the implementation that uses this mixin
>+ * @member: a member of this chat
>+ * @state: the new state to set
>+ *
>+ * Change the current chat state of @member to be @state. This emits
>+ * ChatStateChanged signal and update ChatStates property.
>+ *
>+ * Since: 0.UNRELEASED
>+ */
>+void
>+tp_message_mixin_change_chat_state (GObject *object,
>+    TpHandle member,
>+    TpChannelChatState state)
>+{
>+  TpMessageMixin *mixin = TP_MESSAGE_MIXIN (object);
>+
>+  g_return_if_fail (state < TP_NUM_CHANNEL_CHAT_STATES);
>+
>+  if (state == TP_CHANNEL_CHAT_STATE_INACTIVE)
>+    {
>+      g_hash_table_remove (mixin->priv->chat_states,
>+          GUINT_TO_POINTER (member));
>+    }
>+  else
>+    {
>+      g_hash_table_insert (mixin->priv->chat_states,
>+          GUINT_TO_POINTER (member),
>+          GUINT_TO_POINTER (state));
>+    }
>+
>+  tp_svc_channel_interface_chat_state_emit_chat_state_changed (object,
>+      member, state);
>+}
>+
>+/**
>+ * TpMessageMixinSendChatStateImpl:
>+ * @object: an instance of the implementation that uses this mixin
>+ * @state: a #TpChannelChatState to be send
>+ * @error: a #GError to fill
>+ *
>+ * Signature of a virtual method which may be implemented to allow sending chat
>+ * state.
>+ *
>+ * Returns: %TRUE on success, %FALSE otherwise.
>+ * Since: 0.UNRELEASED
>+ */
>+
>+/**
>+ * tp_message_mixin_implement_send_chat_state:
>+ * @object: an instance of the implementation that uses this mixin
>+ * @send_chat_state: send our chat state
>+ *
>+ * Set the callback used to implement SetChatState. This must be called from the
>+ * init, constructor or constructed callback, after tp_message_mixin_init(),
>+ * and may only be called once per object.
>+ *
>+ * Since: 0.UNRELEASED
>+ */
>+void
>+tp_message_mixin_implement_send_chat_state (GObject *object,
>+    TpMessageMixinSendChatStateImpl send_chat_state)
>+{
>+  TpMessageMixin *mixin = TP_MESSAGE_MIXIN (object);
>+
>+  g_return_if_fail (mixin->priv->send_chat_state == NULL);
>+
>+  mixin->priv->send_chat_state = send_chat_state;
>+}
>+
>+/**
>+ * tp_message_mixin_maybe_send_gone:
>+ * @object: An instance of the implementation that uses this mixin
>+ *
>+ * Send #TP_CHANNEL_CHAT_STATE_GONE if needed. This should be called on private
>+ * chats when channel is closed.
>+ *
>+ * Since: 0.UNRELEASED
>+ */
>+void
>+tp_message_mixin_maybe_send_gone (GObject *object)
>+{
>+  TpMessageMixin *mixin = TP_MESSAGE_MIXIN (object);
>+
>+  if (mixin->priv->send_gone && !TP_HAS_GROUP_MIXIN (object) &&
>+      mixin->priv->send_chat_state != NULL)
>+    {
>+      mixin->priv->send_chat_state (object, TP_CHANNEL_CHAT_STATE_GONE, NULL);
>+    }
>+
>+  mixin->priv->send_gone = FALSE;
>+}
>+
>+/* FIXME: Can we assume TpMessageMixin is used with a TpBaseChannel?
>+ * If yes, use tp_base_channel_get_self_handle() */
>+static TpHandle
>+get_self_handle (GObject *object)
>+{
>+  TpMessageMixin *mixin = TP_MESSAGE_MIXIN (object);
>+
>+  if (TP_HAS_GROUP_MIXIN (object))
>+    {
>+      guint ret = 0;
>+
>+      tp_group_mixin_get_self_handle (object, &ret, NULL);
>+      if (ret != 0)
>+        return ret;
>+    }
>+
>+  return tp_base_connection_get_self_handle (mixin->priv->connection);
>+}
>+
>+static void
>+tp_message_mixin_set_chat_state_async (TpSvcChannelInterfaceChatState *iface,
>+    guint state,
>+    DBusGMethodInvocation *context)
>+{
>+  GObject *object = (GObject *) iface;
>+  TpMessageMixin *mixin = TP_MESSAGE_MIXIN (object);
>+  GError *error = NULL;
>+
>+  if (mixin->priv->send_chat_state == NULL)
>+    {
>+      tp_dbus_g_method_return_not_implemented (context);
>+      return;
>+    }
>+
>+  if (state >= TP_NUM_CHANNEL_CHAT_STATES)
>+    {
>+      DEBUG ("invalid chat state %u", state);
>+
>+      g_set_error (&error, TP_ERRORS, TP_ERROR_INVALID_ARGUMENT,
>+          "invalid state: %u", state);
>+      goto error;
>+    }
>+
>+  if (state == TP_CHANNEL_CHAT_STATE_GONE)
>+    {
>+      /* We cannot explicitly set the Gone state */
>+      DEBUG ("you may not explicitly set the Gone state");
>+
>+      g_set_error (&error, TP_ERRORS, TP_ERROR_INVALID_ARGUMENT,
>+          "you may not explicitly set the Gone state");
>+      goto error;
>+    }
>+
>+  if (!mixin->priv->send_chat_state (object, state, &error))
>+    goto error;
>+
>+  mixin->priv->send_gone = TRUE;
>+  tp_message_mixin_change_chat_state (object, get_self_handle (object), state);
>+
>+  tp_svc_channel_interface_chat_state_return_from_set_chat_state (context);
>+  return;
>+
>+error:
>+  dbus_g_method_return_error (context, error);
>+  g_clear_error (&error);
>+}
> 
> /**
>  * tp_message_mixin_init:
>@@ -336,6 +517,8 @@ tp_message_mixin_init (GObject *obj,
>   mixin->priv->connection = g_object_ref (connection);
> 
>   mixin->priv->supported_content_types = g_new0 (gchar *, 1);
>+
>+  mixin->priv->chat_states = g_hash_table_new (NULL, NULL);
> }
> 
> 
>@@ -382,6 +565,8 @@ tp_message_mixin_finalize (GObject *obj)
> 
>   g_object_unref (mixin->priv->connection);
> 
>+  g_hash_table_unref (mixin->priv->chat_states);
>+
>   g_slice_free (TpMessageMixinPrivate, mixin->priv);
> }
> 
>@@ -843,7 +1028,6 @@ struct _TpMessageMixinOutgoingMessagePrivate {
>     gboolean messages:1;
> };
> 
>-
> /**
>  * tp_message_mixin_sent:
>  * @object: An object implementing the Text and Messages interfaces with this
>@@ -898,21 +1082,13 @@ tp_message_mixin_sent (GObject *object,
>       TpChannelTextMessageType message_type;
>       gchar *string;
>       GHashTable *header = g_ptr_array_index (message->parts, 0);
>-      TpHandle self_handle = 0;
>+
>+      mixin->priv->send_gone = TRUE;
> 
>       if (tp_asv_get_uint64 (header, "message-sent", NULL) == 0)
>         tp_message_set_uint64 (message, 0, "message-sent", time (NULL));
> 
>-      if (TP_HAS_GROUP_MIXIN (object))
>-        {
>-          tp_group_mixin_get_self_handle (object, &self_handle, NULL);
>-        }
>-
>-      if (self_handle == 0)
>-        self_handle = tp_base_connection_get_self_handle (
>-            mixin->priv->connection);
>-
>-      tp_cm_message_set_sender (message, self_handle);
>+      tp_cm_message_set_sender (message, get_self_handle (object));
> 
>       /* emit Sent and MessageSent */
> 
>@@ -1104,10 +1280,18 @@ tp_message_mixin_init_dbus_properties (GObjectClass *cls)
>       { "DeliveryReportingSupport", NULL, NULL },
>       { NULL }
>   };
>+  static TpDBusPropertiesMixinPropImpl chat_state_props[] = {
>+      { "ChatStates", NULL, NULL },
>+      { NULL }
>+  };
> 
>   tp_dbus_properties_mixin_implement_interface (cls,
>       TP_IFACE_QUARK_CHANNEL_INTERFACE_MESSAGES,
>       tp_message_mixin_get_dbus_property, NULL, props);
>+
>+  tp_dbus_properties_mixin_implement_interface (cls,
>+      TP_IFACE_QUARK_CHANNEL_INTERFACE_CHAT_STATE,
>+      tp_message_mixin_get_dbus_property, NULL, chat_state_props);
> }
> 
> 
>@@ -1138,6 +1322,7 @@ tp_message_mixin_get_dbus_property (GObject *object,
>   static GQuark q_message_part_support_flags = 0;
>   static GQuark q_delivery_reporting_support_flags = 0;
>   static GQuark q_message_types = 0;
>+  static GQuark q_chat_states = 0;
> 
>   if (G_UNLIKELY (q_pending_messages == 0))
>     {
>@@ -1150,11 +1335,14 @@ tp_message_mixin_get_dbus_property (GObject *object,
>           g_quark_from_static_string ("DeliveryReportingSupport");
>       q_message_types =
>           g_quark_from_static_string ("MessageTypes");
>+      q_chat_states =
>+          g_quark_from_static_string ("ChatStates");
>     }
> 
>   mixin = TP_MESSAGE_MIXIN (object);
> 
>-  g_return_if_fail (interface == TP_IFACE_QUARK_CHANNEL_INTERFACE_MESSAGES);
>+  g_return_if_fail (interface == TP_IFACE_QUARK_CHANNEL_INTERFACE_MESSAGES ||
>+      interface == TP_IFACE_QUARK_CHANNEL_INTERFACE_CHAT_STATE);
>   g_return_if_fail (object != NULL);
>   g_return_if_fail (name != 0);
>   g_return_if_fail (value != NULL);
>@@ -1195,6 +1383,10 @@ tp_message_mixin_get_dbus_property (GObject *object,
>     {
>       g_value_set_boxed (value, mixin->priv->msg_types);
>     }
>+  else if (name == q_chat_states)
>+    {
>+      g_value_set_boxed (value, mixin->priv->chat_states);
>+    }
> }
> 
> 
>@@ -1246,3 +1438,26 @@ tp_message_mixin_messages_iface_init (gpointer g_iface,
>   IMPLEMENT (get_pending_message_content);
> #undef IMPLEMENT
> }
>+
>+/**
>+ * tp_message_mixin_chat_state_iface_init:
>+ * @g_iface: A pointer to the #TpSvcChannelInterfaceChatStateClass in an object
>+ *  class
>+ * @iface_data: Ignored
>+ *
>+ * Fill in this mixin's ChatState method implementations in the given interface
>+ * vtable.
>+ *
>+ * Since: 0.UNRELEASED
>+ */
>+void
>+tp_message_mixin_chat_state_iface_init (gpointer g_iface,
>+                                        gpointer iface_data)
>+{
>+  TpSvcChannelInterfaceChatStateClass *klass = g_iface;
>+
>+#define IMPLEMENT(x) tp_svc_channel_interface_chat_state_implement_##x (\
>+    klass, tp_message_mixin_##x##_async)
>+  IMPLEMENT (set_chat_state);
>+#undef IMPLEMENT
>+}
>diff --git a/telepathy-glib/message-mixin.h b/telepathy-glib/message-mixin.h
>index e3ad4e0..c2bcf40 100644
>--- a/telepathy-glib/message-mixin.h
>+++ b/telepathy-glib/message-mixin.h
>@@ -68,11 +68,27 @@ void tp_message_mixin_implement_sending (GObject *object,
>     TpDeliveryReportingSupportFlags delivery_reporting_support_flags,
>     const gchar * const * supported_content_types);
> 
>+/* ChatState */
>+
>+typedef gboolean (*TpMessageMixinSendChatStateImpl) (GObject *object,
>+    TpChannelChatState state,
>+    GError **error);
>+
>+void tp_message_mixin_change_chat_state (GObject *object,
>+    TpHandle member,
>+    TpChannelChatState state);
>+
>+void tp_message_mixin_implement_send_chat_state (GObject *object,
>+    TpMessageMixinSendChatStateImpl send_chat_state);
>+
>+void tp_message_mixin_maybe_send_gone (GObject *object);
> 
> /* Initialization */
> void tp_message_mixin_text_iface_init (gpointer g_iface, gpointer iface_data);
> void tp_message_mixin_messages_iface_init (gpointer g_iface,
>     gpointer iface_data);
>+void tp_message_mixin_chat_state_iface_init (gpointer g_iface,
>+    gpointer iface_data);
> 
> void tp_message_mixin_init (GObject *obj, gsize offset,
>     TpBaseConnection *connection);
>-- 
>1.7.9.5

Actions: View | Splinter Review

Attachments on bug 49215: 60669 | 60671 | 60698 | 60826 | 60827 | 60828 | 60829 | 60830 | 60884 | 60885 | 60886 | 60887 | 60888

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.