2 * empathy-dispatch-operation.c - Source for EmpathyDispatchOperation
3 * Copyright (C) 2008 Collabora Ltd.
4 * @author Sjoerd Simons <sjoerd.simons@collabora.co.uk>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <telepathy-glib/interfaces.h>
27 #include "empathy-dispatch-operation.h"
28 #include <libempathy/empathy-enum-types.h>
29 #include <libempathy/empathy-tp-contact-factory.h>
30 #include <libempathy/empathy-tp-chat.h>
31 #include <libempathy/empathy-tp-call.h>
32 #include <libempathy/empathy-tp-file.h>
34 #include "empathy-marshal.h"
36 #include "extensions/extensions.h"
38 #define DEBUG_FLAG EMPATHY_DEBUG_DISPATCHER
39 #include <libempathy/empathy-debug.h>
41 G_DEFINE_TYPE(EmpathyDispatchOperation, empathy_dispatch_operation,
44 static void empathy_dispatch_operation_set_status (
45 EmpathyDispatchOperation *self, EmpathyDispatchOperationState status);
46 static void empathy_dispatch_operation_channel_ready_cb (TpChannel *channel,
47 const GError *error, gpointer user_data);
52 /* Ready for dispatching */
54 /* Approved by an approver, can only happens on incoming operations */
56 /* Claimed by a handler */
58 /* Error, channel went away, inspecting it failed etc */
63 static guint signals[LAST_SIGNAL] = {0};
75 /* private structure */
76 typedef struct _EmpathyDispatchOperationPriv \
77 EmpathyDispatchOperationPriv;
79 struct _EmpathyDispatchOperationPriv
81 gboolean dispose_has_run;
82 TpConnection *connection;
84 GObject *channel_wrapper;
85 EmpathyContact *contact;
86 EmpathyDispatchOperationState status;
89 gulong invalidated_handler;
94 (G_TYPE_INSTANCE_GET_PRIVATE ((o), EMPATHY_TYPE_DISPATCH_OPERATION, \
95 EmpathyDispatchOperationPriv))
98 empathy_dispatch_operation_init (EmpathyDispatchOperation *obj)
100 //EmpathyDispatchOperationPriv *priv =
103 /* allocate any data required by the object here */
106 static void empathy_dispatch_operation_dispose (GObject *object);
107 static void empathy_dispatch_operation_finalize (GObject *object);
110 empathy_dispatch_operation_set_property (GObject *object,
111 guint property_id, const GValue *value, GParamSpec *pspec)
113 EmpathyDispatchOperation *operation = EMPATHY_DISPATCH_OPERATION (object);
114 EmpathyDispatchOperationPriv *priv = GET_PRIV (operation);
118 case PROP_CONNECTION:
119 priv->connection = g_value_dup_object (value);
122 priv->channel = g_value_dup_object (value);
124 case PROP_CHANNEL_WRAPPER:
125 priv->channel_wrapper = g_value_dup_object (value);
128 if (priv->contact != NULL)
129 g_object_unref (priv->contact);
130 priv->contact = g_value_dup_object (value);
133 priv->incoming = g_value_get_boolean (value);
139 empathy_dispatch_operation_get_property (GObject *object,
140 guint property_id, GValue *value, GParamSpec *pspec)
142 EmpathyDispatchOperation *operation = EMPATHY_DISPATCH_OPERATION (object);
143 EmpathyDispatchOperationPriv *priv = GET_PRIV (operation);
147 case PROP_CONNECTION:
148 g_value_set_object (value, priv->connection);
151 g_value_set_object (value, priv->channel);
153 case PROP_CHANNEL_WRAPPER:
154 g_value_set_object (value, priv->channel_wrapper);
157 g_value_set_object (value, priv->contact);
160 g_value_set_boolean (value, priv->incoming);
163 g_value_set_enum (value, priv->status);
169 empathy_dispatch_operation_invalidated (TpProxy *proxy, guint domain,
170 gint code, char *message, EmpathyDispatchOperation *self)
172 empathy_dispatch_operation_set_status (self,
173 EMPATHY_DISPATCHER_OPERATION_STATE_INVALIDATED);
175 g_signal_emit (self, signals[INVALIDATED], 0, domain, code, message);
179 dispatcher_operation_got_contact_cb (EmpathyTpContactFactory *factory,
180 EmpathyContact *contact,
185 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
189 /* FIXME: We should cancel the operation */
190 DEBUG ("Error: %s", error->message);
194 if (priv->contact != NULL)
195 g_object_unref (priv->contact);
196 priv->contact = g_object_ref (contact);
197 g_object_notify (G_OBJECT (self), "contact");
199 tp_channel_call_when_ready (priv->channel,
200 empathy_dispatch_operation_channel_ready_cb, self);
204 empathy_dispatch_operation_constructed (GObject *object)
206 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (object);
207 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
209 TpHandleType handle_type;
211 empathy_dispatch_operation_set_status (self,
212 EMPATHY_DISPATCHER_OPERATION_STATE_PREPARING);
214 priv->invalidated_handler =
215 g_signal_connect (priv->channel, "invalidated",
216 G_CALLBACK (empathy_dispatch_operation_invalidated), self);
218 handle = tp_channel_get_handle (priv->channel, &handle_type);
220 if (handle_type == TP_HANDLE_TYPE_CONTACT && priv->contact == NULL)
222 EmpathyTpContactFactory *factory;
224 factory = empathy_tp_contact_factory_dup_singleton (priv->connection);
225 empathy_tp_contact_factory_get_from_handle (factory, handle,
226 dispatcher_operation_got_contact_cb, NULL, NULL, object);
227 g_object_unref (factory);
231 tp_channel_call_when_ready (priv->channel,
232 empathy_dispatch_operation_channel_ready_cb, self);
236 empathy_dispatch_operation_class_init (
237 EmpathyDispatchOperationClass *empathy_dispatch_operation_class)
239 GObjectClass *object_class =
240 G_OBJECT_CLASS (empathy_dispatch_operation_class);
241 GParamSpec *param_spec;
243 g_type_class_add_private (empathy_dispatch_operation_class,
244 sizeof (EmpathyDispatchOperationPriv));
246 object_class->set_property = empathy_dispatch_operation_set_property;
247 object_class->get_property = empathy_dispatch_operation_get_property;
249 object_class->dispose = empathy_dispatch_operation_dispose;
250 object_class->finalize = empathy_dispatch_operation_finalize;
251 object_class->constructed = empathy_dispatch_operation_constructed;
253 signals[READY] = g_signal_new ("ready",
254 G_OBJECT_CLASS_TYPE(empathy_dispatch_operation_class),
258 g_cclosure_marshal_VOID__VOID,
261 signals[APPROVED] = g_signal_new ("approved",
262 G_OBJECT_CLASS_TYPE(empathy_dispatch_operation_class),
266 g_cclosure_marshal_VOID__VOID,
269 signals[CLAIMED] = g_signal_new ("claimed",
270 G_OBJECT_CLASS_TYPE(empathy_dispatch_operation_class),
274 g_cclosure_marshal_VOID__VOID,
277 signals[INVALIDATED] = g_signal_new ("invalidated",
278 G_OBJECT_CLASS_TYPE(empathy_dispatch_operation_class),
282 _empathy_marshal_VOID__UINT_INT_STRING,
283 G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_INT, G_TYPE_STRING);
285 param_spec = g_param_spec_object ("connection",
286 "connection", "The telepathy connection",
288 G_PARAM_CONSTRUCT_ONLY |
289 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
290 g_object_class_install_property (object_class, PROP_CONNECTION,
293 param_spec = g_param_spec_object ("channel",
294 "channel", "The telepathy channel",
296 G_PARAM_CONSTRUCT_ONLY |
297 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
298 g_object_class_install_property (object_class, PROP_CHANNEL,
301 param_spec = g_param_spec_object ("channel-wrapper",
302 "channel wrapper", "The empathy specific channel wrapper",
304 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
305 g_object_class_install_property (object_class, PROP_CHANNEL_WRAPPER,
308 param_spec = g_param_spec_object ("contact",
309 "contact", "The empathy contact",
310 EMPATHY_TYPE_CONTACT,
311 G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
312 g_object_class_install_property (object_class, PROP_CONTACT,
315 param_spec = g_param_spec_boolean ("incoming",
316 "incoming", "Whether or not the channel is incoming",
318 G_PARAM_CONSTRUCT_ONLY |
319 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
320 g_object_class_install_property (object_class, PROP_INCOMING,
323 param_spec = g_param_spec_enum ("status",
324 "status", "Status of the dispatch operation",
325 EMPATHY_TYPE_DISPATCH_OPERATION_STATE, 0,
326 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
327 g_object_class_install_property (object_class, PROP_STATUS, param_spec);
331 empathy_dispatch_operation_dispose (GObject *object)
333 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (object);
334 EmpathyDispatchOperationPriv *priv =
337 if (priv->dispose_has_run)
340 priv->dispose_has_run = TRUE;
342 g_object_unref (priv->connection);
344 if (priv->channel_wrapper != NULL)
345 g_object_unref (priv->channel_wrapper);
347 if (priv->ready_handler != 0)
348 g_signal_handler_disconnect (priv->channel_wrapper,
349 priv->invalidated_handler);
352 g_signal_handler_disconnect (priv->channel, priv->invalidated_handler);
353 g_object_unref (priv->channel);
356 if (priv->contact != NULL)
357 g_object_unref (priv->contact);
359 if (G_OBJECT_CLASS (empathy_dispatch_operation_parent_class)->dispose)
360 G_OBJECT_CLASS (empathy_dispatch_operation_parent_class)->dispose (object);
364 empathy_dispatch_operation_finalize (GObject *object)
366 /* free any data held directly by the object here */
367 G_OBJECT_CLASS (empathy_dispatch_operation_parent_class)->finalize (object);
371 empathy_dispatch_operation_set_status (EmpathyDispatchOperation *self,
372 EmpathyDispatchOperationState status)
374 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
376 g_assert (status >= priv->status);
379 if (priv->status != status)
381 DEBUG ("Dispatch operation %s status: %d -> %d",
382 empathy_dispatch_operation_get_object_path (self),
383 priv->status, status);
385 priv->status = status;
386 g_object_notify (G_OBJECT (self), "status");
388 if (status == EMPATHY_DISPATCHER_OPERATION_STATE_PENDING)
389 g_signal_emit (self, signals[READY], 0);
394 empathy_dispatcher_operation_tp_chat_ready_cb (GObject *object,
395 GParamSpec *spec, gpointer user_data)
397 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (user_data);
398 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
400 if (!empathy_tp_chat_is_ready (EMPATHY_TP_CHAT (priv->channel_wrapper)))
403 g_signal_handler_disconnect (priv->channel_wrapper, priv->ready_handler);
404 priv->ready_handler = 0;
406 empathy_dispatch_operation_set_status (self,
407 EMPATHY_DISPATCHER_OPERATION_STATE_PENDING);
411 empathy_dispatch_operation_channel_ready_cb (TpChannel *channel,
412 const GError *error, gpointer user_data)
414 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (user_data);
415 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
418 /* The error will be handled in empathy_dispatch_operation_invalidated */
422 g_assert (channel == priv->channel);
424 /* If the channel wrapper is defined, we assume it's ready */
425 if (priv->channel_wrapper != NULL)
428 channel_type = tp_channel_get_channel_type_id (channel);
430 if (channel_type == TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
432 EmpathyTpChat *chat= empathy_tp_chat_new (channel);
433 priv->channel_wrapper = G_OBJECT (chat);
435 if (!empathy_tp_chat_is_ready (chat))
437 priv->ready_handler = g_signal_connect (chat, "notify::ready",
438 G_CALLBACK (empathy_dispatcher_operation_tp_chat_ready_cb), self);
442 else if (channel_type == TP_IFACE_QUARK_CHANNEL_TYPE_STREAMED_MEDIA)
444 EmpathyTpCall *call = empathy_tp_call_new (channel);
445 priv->channel_wrapper = G_OBJECT (call);
447 else if (channel_type == TP_IFACE_QUARK_CHANNEL_TYPE_FILE_TRANSFER)
449 EmpathyTpFile *file = empathy_tp_file_new (channel, priv->incoming);
450 priv->channel_wrapper = G_OBJECT (file);
454 empathy_dispatch_operation_set_status (self,
455 EMPATHY_DISPATCHER_OPERATION_STATE_PENDING);
458 EmpathyDispatchOperation *
459 empathy_dispatch_operation_new (TpConnection *connection, TpChannel *channel,
460 EmpathyContact *contact, gboolean incoming)
462 return empathy_dispatch_operation_new_with_wrapper (connection, channel,
463 contact, incoming, NULL);
466 EmpathyDispatchOperation *
467 empathy_dispatch_operation_new_with_wrapper (TpConnection *connection,
468 TpChannel *channel, EmpathyContact *contact, gboolean incoming,
471 g_return_val_if_fail (connection != NULL, NULL);
472 g_return_val_if_fail (channel != NULL, NULL);
474 return EMPATHY_DISPATCH_OPERATION (
475 g_object_new (EMPATHY_TYPE_DISPATCH_OPERATION,
476 "connection", connection,
478 "channel-wrapper", wrapper,
480 "incoming", incoming,
485 empathy_dispatch_operation_start (EmpathyDispatchOperation *operation)
487 EmpathyDispatchOperationPriv *priv;
489 g_return_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation));
491 priv = GET_PRIV (operation);
494 priv->status == EMPATHY_DISPATCHER_OPERATION_STATE_PENDING);
496 if (priv->incoming && !priv->approved)
497 empathy_dispatch_operation_set_status (operation,
498 EMPATHY_DISPATCHER_OPERATION_STATE_APPROVING);
500 empathy_dispatch_operation_set_status (operation,
501 EMPATHY_DISPATCHER_OPERATION_STATE_DISPATCHING);
505 empathy_dispatch_operation_approve (EmpathyDispatchOperation *operation)
507 EmpathyDispatchOperationPriv *priv;
509 g_return_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation));
511 priv = GET_PRIV (operation);
513 if (priv->status == EMPATHY_DISPATCHER_OPERATION_STATE_APPROVING)
515 DEBUG ("Approving operation %s",
516 empathy_dispatch_operation_get_object_path (operation));
518 empathy_dispatch_operation_set_status (operation,
519 EMPATHY_DISPATCHER_OPERATION_STATE_DISPATCHING);
521 g_signal_emit (operation, signals[APPROVED], 0);
523 else if (priv->status < EMPATHY_DISPATCHER_OPERATION_STATE_APPROVING)
525 DEBUG ("Pre-approving operation %s",
526 empathy_dispatch_operation_get_object_path (operation));
527 priv->approved = TRUE;
532 "Ignoring approval for %s as it's already past the approval stage",
533 empathy_dispatch_operation_get_object_path (operation));
537 /* Returns whether or not the operation was successfully claimed */
539 empathy_dispatch_operation_claim (EmpathyDispatchOperation *operation)
541 EmpathyDispatchOperationPriv *priv;
543 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), FALSE);
545 priv = GET_PRIV (operation);
547 if (priv->status == EMPATHY_DISPATCHER_OPERATION_STATE_CLAIMED)
550 empathy_dispatch_operation_set_status (operation,
551 EMPATHY_DISPATCHER_OPERATION_STATE_CLAIMED);
553 g_signal_emit (operation, signals[CLAIMED], 0);
559 empathy_dispatch_operation_get_tp_connection (
560 EmpathyDispatchOperation *operation)
562 EmpathyDispatchOperationPriv *priv;
564 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
566 priv = GET_PRIV (operation);
568 return priv->connection;
572 empathy_dispatch_operation_get_channel (EmpathyDispatchOperation *operation)
574 EmpathyDispatchOperationPriv *priv;
576 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
578 priv = GET_PRIV (operation);
580 return priv->channel;
584 empathy_dispatch_operation_get_channel_wrapper (
585 EmpathyDispatchOperation *operation)
587 EmpathyDispatchOperationPriv *priv;
589 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
591 priv = GET_PRIV (operation);
593 return priv->channel_wrapper;
597 empathy_dispatch_operation_get_channel_type (
598 EmpathyDispatchOperation *operation)
600 EmpathyDispatchOperationPriv *priv;
602 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
604 priv = GET_PRIV (operation);
606 return tp_channel_get_channel_type (priv->channel);
610 empathy_dispatch_operation_get_channel_type_id (
611 EmpathyDispatchOperation *operation)
613 EmpathyDispatchOperationPriv *priv;
615 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), 0);
617 priv = GET_PRIV (operation);
619 return tp_channel_get_channel_type_id (priv->channel);
623 empathy_dispatch_operation_get_object_path (
624 EmpathyDispatchOperation *operation)
626 EmpathyDispatchOperationPriv *priv;
628 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
630 priv = GET_PRIV (operation);
632 return tp_proxy_get_object_path (TP_PROXY (priv->channel));
635 EmpathyDispatchOperationState
636 empathy_dispatch_operation_get_status (EmpathyDispatchOperation *operation)
638 EmpathyDispatchOperationPriv *priv;
640 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation),
641 EMPATHY_DISPATCHER_OPERATION_STATE_PREPARING);
643 priv = GET_PRIV (operation);
649 empathy_dispatch_operation_is_incoming (EmpathyDispatchOperation *operation)
651 EmpathyDispatchOperationPriv *priv;
653 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), FALSE);
655 priv = GET_PRIV (operation);
657 return priv->incoming;