/* * Copyright (C) 2008 Collabora Ltd. * * This library 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 2.1 of the License, or (at your option) any later version. * * This library 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 this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA * * Authors: Guillaume Desmottes * Elliot Fairweather */ #include #include #include #include #include #include "empathy-enum-types.h" #include "empathy-tp-tube.h" #include "empathy-utils.h" #define DEBUG_FLAG EMPATHY_DEBUG_TP #include "empathy-debug.h" typedef struct { TpSocketAddressType type; EmpathyTpTubeAcceptStreamTubeCb *callback; gpointer user_data; } EmpathyTpTubeAcceptData; static EmpathyTpTubeAcceptData * new_empathy_tp_tube_accept_data (TpSocketAddressType type, EmpathyTpTubeAcceptStreamTubeCb *callback, gpointer user_data) { EmpathyTpTubeAcceptData *r; r = g_slice_new0 (EmpathyTpTubeAcceptData); r->type = type; r->callback = callback; r->user_data = user_data; return r; } static void free_empathy_tp_tube_accept_data (gpointer data) { g_slice_free (EmpathyTpTubeAcceptData, data); } typedef struct { EmpathyTpTubeReadyCb *callback; gpointer user_data; GDestroyNotify destroy; GObject *weak_object; } ReadyCbData; /** * SECTION:empathy-tp-tube * @title:EmpathyTpTube * @short_description: A wrapper around a Telepathy tube channel * @include: libempathy/empathy-tp-tube.h * * #EmpathyTpTube is a convenient object wrapping a Telepathy tube channel. */ /** * EmpathyTpTube: * @parent: parent object * * An object wrapping a Telepathy tube channel. */ #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyTpTube) typedef struct { TpChannel *channel; TpTubeChannelState state; gboolean ready; GSList *ready_callbacks; } EmpathyTpTubePriv; enum { PROP_0, PROP_CHANNEL, PROP_STATE, }; enum { DESTROY, LAST_SIGNAL }; static guint signals[LAST_SIGNAL]; G_DEFINE_TYPE (EmpathyTpTube, empathy_tp_tube, G_TYPE_OBJECT) static void tp_tube_state_changed_cb (TpChannel *channel, TpTubeChannelState state, gpointer user_data, GObject *tube) { EmpathyTpTubePriv *priv = GET_PRIV (tube); if (!priv->ready) /* We didn't get the state yet */ return; DEBUG ("Tube state changed"); priv->state = state; g_object_notify (tube, "state"); } static void tp_tube_invalidated_cb (TpChannel *channel, GQuark domain, gint code, gchar *message, EmpathyTpTube *tube) { DEBUG ("Channel invalidated: %s", message); g_signal_emit (tube, signals[DESTROY], 0); } static void tp_tube_async_cb (TpChannel *channel, const GError *error, gpointer user_data, GObject *tube) { if (error) DEBUG ("Error %s: %s", (gchar *) user_data, error->message); } static void tp_tube_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { EmpathyTpTubePriv *priv = GET_PRIV (object); switch (prop_id) { case PROP_CHANNEL: priv->channel = g_value_dup_object (value); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void tp_tube_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) { EmpathyTpTubePriv *priv = GET_PRIV (object); switch (prop_id) { case PROP_CHANNEL: g_value_set_object (value, priv->channel); break; case PROP_STATE: g_value_set_uint (value, priv->state); break; default: G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec); break; } } static void weak_object_notify (gpointer data, GObject *old_object); static ReadyCbData * ready_cb_data_new (EmpathyTpTube *self, EmpathyTpTubeReadyCb *callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object) { ReadyCbData *d = g_slice_new0 (ReadyCbData); d->callback = callback; d->user_data = user_data; d->destroy = destroy; d->weak_object = weak_object; if (weak_object != NULL) g_object_weak_ref (weak_object, weak_object_notify, self); return d; } static void ready_cb_data_free (ReadyCbData *data, EmpathyTpTube *self) { if (data->destroy != NULL) data->destroy (data->user_data); if (data->weak_object != NULL) g_object_weak_unref (data->weak_object, weak_object_notify, self); g_slice_free (ReadyCbData, data); } static void weak_object_notify (gpointer data, GObject *old_object) { EmpathyTpTube *self = EMPATHY_TP_TUBE (data); EmpathyTpTubePriv *priv = GET_PRIV (self); GSList *l, *ln; for (l = priv->ready_callbacks ; l != NULL ; l = ln ) { ReadyCbData *d = (ReadyCbData *) l->data; ln = g_slist_next (l); if (d->weak_object == old_object) { ready_cb_data_free (d, self); priv->ready_callbacks = g_slist_delete_link (priv->ready_callbacks, l); } } } static void tube_is_ready (EmpathyTpTube *self, const GError *error) { EmpathyTpTubePriv *priv = GET_PRIV (self); GSList *l; priv->ready = TRUE; /* tube has to stay alive while we call the callbacks */ g_object_ref (self); for (l = priv->ready_callbacks ; l != NULL ; l = g_slist_next (l)) { ReadyCbData *data = (ReadyCbData *) l->data; data->callback (self, error, data->user_data, data->weak_object); ready_cb_data_free (data, self); } g_object_unref (self); g_slist_free (priv->ready_callbacks); priv->ready_callbacks = NULL; } static void got_tube_state_cb (TpProxy *proxy, const GValue *out_value, const GError *error, gpointer user_data, GObject *weak_object) { EmpathyTpTube *self = EMPATHY_TP_TUBE (user_data); EmpathyTpTubePriv *priv = GET_PRIV (self); if (error != NULL) { DEBUG ("Error getting State property: %s", error->message); } else { priv->state = g_value_get_uint (out_value); g_object_notify (G_OBJECT (self), "state"); } tube_is_ready (self, error); } static GObject * tp_tube_constructor (GType type, guint n_props, GObjectConstructParam *props) { GObject *self; EmpathyTpTubePriv *priv; self = G_OBJECT_CLASS (empathy_tp_tube_parent_class)->constructor ( type, n_props, props); priv = GET_PRIV (self); g_signal_connect (priv->channel, "invalidated", G_CALLBACK (tp_tube_invalidated_cb), self); priv->ready = FALSE; tp_cli_channel_interface_tube_connect_to_tube_channel_state_changed ( priv->channel, tp_tube_state_changed_cb, NULL, NULL, self, NULL); tp_cli_dbus_properties_call_get (priv->channel, -1, TP_IFACE_CHANNEL_INTERFACE_TUBE, "State", got_tube_state_cb, self, NULL, G_OBJECT (self)); return self; } static void tp_tube_finalize (GObject *object) { EmpathyTpTube *self = EMPATHY_TP_TUBE (object); EmpathyTpTubePriv *priv = GET_PRIV (object); GSList *l; DEBUG ("Finalizing: %p", object); if (priv->channel) { g_signal_handlers_disconnect_by_func (priv->channel, tp_tube_invalidated_cb, object); tp_cli_channel_call_close (priv->channel, -1, tp_tube_async_cb, "closing tube", NULL, NULL); g_object_unref (priv->channel); } for (l = priv->ready_callbacks; l != NULL; l = g_slist_next (l)) { ReadyCbData *d = (ReadyCbData *) l->data; ready_cb_data_free (d, self); } g_slist_free (priv->ready_callbacks); priv->ready_callbacks = NULL; G_OBJECT_CLASS (empathy_tp_tube_parent_class)->finalize (object); } static void empathy_tp_tube_class_init (EmpathyTpTubeClass *klass) { GObjectClass *object_class = G_OBJECT_CLASS (klass); object_class->constructor = tp_tube_constructor; object_class->finalize = tp_tube_finalize; object_class->set_property = tp_tube_set_property; object_class->get_property = tp_tube_get_property; /** * EmpathyTpTube:channel: * * The #TpChannel wrapped by the tube object. */ g_object_class_install_property (object_class, PROP_CHANNEL, g_param_spec_object ("channel", "channel", "channel", TP_TYPE_CHANNEL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY | G_PARAM_STATIC_STRINGS)); /** * EmpathyTpTube:state: * * The state of the tube. */ g_object_class_install_property (object_class, PROP_STATE, g_param_spec_uint ("state", "state", "state", 0, NUM_TP_TUBE_CHANNEL_STATES, 0, G_PARAM_READABLE | G_PARAM_STATIC_NAME | G_PARAM_STATIC_STRINGS)); /** * EmpathyTpTube::destroy: * @self: the tube object * * Emitted when then tube has been invalidated. */ signals[DESTROY] = g_signal_new ("destroy", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, 0, NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); g_type_class_add_private (klass, sizeof (EmpathyTpTubePriv)); } static void empathy_tp_tube_init (EmpathyTpTube *tube) { EmpathyTpTubePriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (tube, EMPATHY_TYPE_TP_TUBE, EmpathyTpTubePriv); tube->priv = priv; } /** * empathy_tp_tube_new: * @channel: a #TpChannel * * Creates a new #EmpathyTpTube. * * Return value: a new #EmpathyTpTube */ EmpathyTpTube * empathy_tp_tube_new (TpChannel *channel) { g_return_val_if_fail (TP_IS_CHANNEL (channel), NULL); return g_object_new (EMPATHY_TYPE_TP_TUBE, "channel", channel, NULL); } /** * empathy_tp_tube_new_stream_tube: * @contact: the #EmpathyContact to which the tube is offered * @type: the type of the listening address of the local service. Either * %TP_SOCKET_ADDRESS_TYPE_IPV4 or %TP_SOCKET_ADDRESS_TYPE_IPV6. * @hostname: the address of the local service * @port: the port of the local service * @service: the service name of the tube * @parameters: the parameters of the tube * * Creates and offers a new #EmpathyTpTube of ChannelType StreamTube. * * Return value: a new #EmpathyTpTube */ EmpathyTpTube * empathy_tp_tube_new_stream_tube (EmpathyContact *contact, TpSocketAddressType type, const gchar *hostname, guint port, const gchar *service, GHashTable *parameters) { TpConnection *connection; TpChannel *channel; gchar *object_path; GHashTable *params; GValue *address; GValue *control_param; EmpathyTpTube *tube = NULL; GError *error = NULL; GHashTable *request; GHashTable *channel_properties; GValue *value; g_return_val_if_fail (EMPATHY_IS_CONTACT (contact), NULL); g_return_val_if_fail (hostname != NULL, NULL); g_return_val_if_fail (service != NULL, NULL); connection = empathy_contact_get_connection (contact); request = g_hash_table_new_full (g_str_hash, g_str_equal, NULL, (GDestroyNotify) tp_g_value_slice_free); /* org.freedesktop.Telepathy.Channel.ChannelType */ value = tp_g_value_slice_new (G_TYPE_STRING); g_value_set_string (value, TP_IFACE_CHANNEL_TYPE_STREAM_TUBE); g_hash_table_insert (request, TP_IFACE_CHANNEL ".ChannelType", value); /* org.freedesktop.Telepathy.Channel.TargetHandleType */ value = tp_g_value_slice_new (G_TYPE_UINT); g_value_set_uint (value, TP_HANDLE_TYPE_CONTACT); g_hash_table_insert (request, TP_IFACE_CHANNEL ".TargetHandleType", value); /* org.freedesktop.Telepathy.Channel.TargetHandleType */ value = tp_g_value_slice_new (G_TYPE_UINT); g_value_set_uint (value, empathy_contact_get_handle (contact)); g_hash_table_insert (request, TP_IFACE_CHANNEL ".TargetHandle", value); /* org.freedesktop.Telepathy.Channel.Type.StreamTube.Service */ value = tp_g_value_slice_new (G_TYPE_STRING); g_value_set_string (value, service); g_hash_table_insert (request, TP_IFACE_CHANNEL_TYPE_STREAM_TUBE ".Service", value); if (!tp_cli_connection_interface_requests_run_create_channel (connection, -1, request, &object_path, &channel_properties, &error, NULL)) { DEBUG ("Error requesting channel: %s", error->message); g_clear_error (&error); g_object_unref (connection); return NULL; } DEBUG ("Offering a new stream tube"); channel = tp_channel_new_from_properties (connection, object_path, channel_properties, NULL); tp_channel_run_until_ready (channel, NULL, NULL); #define ADDRESS_TYPE dbus_g_type_get_struct ("GValueArray",\ G_TYPE_STRING, G_TYPE_UINT, G_TYPE_INVALID) params = g_hash_table_new (g_str_hash, g_str_equal); address = tp_g_value_slice_new (ADDRESS_TYPE); g_value_take_boxed (address, dbus_g_type_specialized_construct (ADDRESS_TYPE)); dbus_g_type_struct_set (address, 0, hostname, 1, port, G_MAXUINT); control_param = tp_g_value_slice_new (G_TYPE_STRING); if (parameters == NULL) /* Pass an empty dict as parameters */ parameters = g_hash_table_new (g_str_hash, g_str_equal); else g_hash_table_ref (parameters); if (!tp_cli_channel_type_stream_tube_run_offer (channel, -1, type, address, TP_SOCKET_ACCESS_CONTROL_LOCALHOST, parameters, &error, NULL)) { DEBUG ("Couldn't offer tube: %s", error->message); g_clear_error (&error); goto OUT; } DEBUG ("Stream tube offered"); tube = empathy_tp_tube_new (channel); OUT: g_object_unref (channel); g_free (object_path); g_hash_table_destroy (request); g_hash_table_destroy (channel_properties); tp_g_value_slice_free (address); tp_g_value_slice_free (control_param); g_object_unref (connection); g_hash_table_unref (parameters); return tube; } static void tp_tube_accept_stream_cb (TpChannel *channel, const GValue *address, const GError *error, gpointer user_data, GObject *weak_object) { EmpathyTpTube *tube = EMPATHY_TP_TUBE (weak_object); EmpathyTpTubeAcceptData *data = (EmpathyTpTubeAcceptData *) user_data; EmpathyTpTubeAddress eaddress; eaddress.type = data->type; if (error) { DEBUG ("Error accepting tube: %s", error->message); data->callback (tube, NULL, error, data->user_data); return; } switch (eaddress.type) { case TP_SOCKET_ADDRESS_TYPE_UNIX: case TP_SOCKET_ADDRESS_TYPE_ABSTRACT_UNIX: eaddress.a.socket.path = g_value_get_boxed (address); break; case TP_SOCKET_ADDRESS_TYPE_IPV4: case TP_SOCKET_ADDRESS_TYPE_IPV6: dbus_g_type_struct_get (address, 0, &eaddress.a.inet.hostname, 1, &eaddress.a.inet.port, G_MAXUINT); break; } data->callback (tube, &eaddress, NULL, data->user_data); } /** * empathy_tp_tube_accept_stream_tube: * @tube: an #EmpathyTpTube * @type: the type of address the connection manager should listen on * @callback: called when the tube has been accepted * @user_data: arbitrary user-supplied data passed to the callback * * Accepts @tube of ChannelType StreamTube and call @callback once it's done. */ void empathy_tp_tube_accept_stream_tube (EmpathyTpTube *tube, TpSocketAddressType type, EmpathyTpTubeAcceptStreamTubeCb *callback, gpointer user_data) { EmpathyTpTubePriv *priv = GET_PRIV (tube); GValue *control_param; EmpathyTpTubeAcceptData *data; g_return_if_fail (EMPATHY_IS_TP_TUBE (tube)); DEBUG ("Accepting stream tube"); /* FIXME allow other acls */ control_param = tp_g_value_slice_new (G_TYPE_STRING); data = new_empathy_tp_tube_accept_data (type, callback, user_data); tp_cli_channel_type_stream_tube_call_accept ( priv->channel, -1, type, TP_SOCKET_ACCESS_CONTROL_LOCALHOST, control_param, tp_tube_accept_stream_cb, data, free_empathy_tp_tube_accept_data, G_OBJECT (tube)); tp_g_value_slice_free (control_param); } /** * EmpathyTpTubeReadyCb: * @tube: an #EmpathyTpTube * @error: %NULL on success, or the reason why the tube can't be ready * @user_data: the @user_data passed to empathy_tp_tube_call_when_ready() * @weak_object: the @weak_object passed to * empathy_tp_tube_call_when_ready() * * Called as the result of empathy_tp_tube_call_when_ready(). If the * tube's properties could be retrieved, * @error is %NULL and @tube is considered to be ready. Otherwise, @error is * non-%NULL and @tube is not ready. */ /** * empathy_tp_tube_call_when_ready: * @tube: an #EmpathyTpTube * @callback: called when the tube becomes ready * @user_data: arbitrary user-supplied data passed to the callback * @destroy: called to destroy @user_data * @weak_object: object to reference weakly; if it is destroyed, @callback * will not be called, but @destroy will still be called * * If @tube is ready for use, call @callback immediately, then return. * Otherwise, arrange for @callback to be called when @tube becomes * ready for use. */ void empathy_tp_tube_call_when_ready (EmpathyTpTube *self, EmpathyTpTubeReadyCb *callback, gpointer user_data, GDestroyNotify destroy, GObject *weak_object) { EmpathyTpTubePriv *priv = GET_PRIV (self); g_return_if_fail (self != NULL); g_return_if_fail (callback != NULL); if (priv->ready) { callback (self, NULL, user_data, weak_object); if (destroy != NULL) destroy (user_data); } else { priv->ready_callbacks = g_slist_prepend (priv->ready_callbacks, ready_cb_data_new (self, callback, user_data, destroy, weak_object)); } }