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 "empathy-dispatch-operation.h"
26 #include <libempathy/empathy-enum-types.h>
27 #include <libempathy/empathy-tp-contact-factory.h>
28 #include <libempathy/empathy-tp-chat.h>
29 #include <libempathy/empathy-tp-call.h>
30 #include <libempathy/empathy-tp-file.h>
32 #include "empathy-marshal.h"
34 #include "extensions/extensions.h"
36 #define DEBUG_FLAG EMPATHY_DEBUG_DISPATCHER
37 #include <libempathy/empathy-debug.h>
39 G_DEFINE_TYPE(EmpathyDispatchOperation, empathy_dispatch_operation,
42 static void empathy_dispatch_operation_set_status (
43 EmpathyDispatchOperation *self, EmpathyDispatchOperationState status);
44 static void empathy_dispatch_operation_channel_ready_cb (TpChannel *channel,
45 const GError *error, gpointer user_data);
50 /* Ready for dispatching */
52 /* Approved by an approver, can only happens on incoming operations */
54 /* Claimed by a handler */
56 /* Error, channel went away, inspecting it failed etc */
61 static guint signals[LAST_SIGNAL] = {0};
73 /* private structure */
74 typedef struct _EmpathyDispatchOperationPriv \
75 EmpathyDispatchOperationPriv;
77 struct _EmpathyDispatchOperationPriv
79 gboolean dispose_has_run;
80 TpConnection *connection;
82 GObject *channel_wrapper;
83 EmpathyContact *contact;
84 EmpathyDispatchOperationState status;
87 gulong invalidated_handler;
92 (G_TYPE_INSTANCE_GET_PRIVATE ((o), EMPATHY_TYPE_DISPATCH_OPERATION, \
93 EmpathyDispatchOperationPriv))
96 empathy_dispatch_operation_init (EmpathyDispatchOperation *obj)
98 //EmpathyDispatchOperationPriv *priv =
101 /* allocate any data required by the object here */
104 static void empathy_dispatch_operation_dispose (GObject *object);
105 static void empathy_dispatch_operation_finalize (GObject *object);
108 empathy_dispatch_operation_set_property (GObject *object,
109 guint property_id, const GValue *value, GParamSpec *pspec)
111 EmpathyDispatchOperation *operation = EMPATHY_DISPATCH_OPERATION (object);
112 EmpathyDispatchOperationPriv *priv = GET_PRIV (operation);
116 case PROP_CONNECTION:
117 priv->connection = g_value_dup_object (value);
120 priv->channel = g_value_dup_object (value);
122 case PROP_CHANNEL_WRAPPER:
123 priv->channel_wrapper = g_value_dup_object (value);
126 if (priv->contact != NULL)
127 g_object_unref (priv->contact);
128 priv->contact = g_value_dup_object (value);
131 priv->incoming = g_value_get_boolean (value);
137 empathy_dispatch_operation_get_property (GObject *object,
138 guint property_id, GValue *value, GParamSpec *pspec)
140 EmpathyDispatchOperation *operation = EMPATHY_DISPATCH_OPERATION (object);
141 EmpathyDispatchOperationPriv *priv = GET_PRIV (operation);
145 case PROP_CONNECTION:
146 g_value_set_object (value, priv->connection);
149 g_value_set_object (value, priv->channel);
151 case PROP_CHANNEL_WRAPPER:
152 g_value_set_object (value, priv->channel_wrapper);
155 g_value_set_object (value, priv->contact);
158 g_value_set_boolean (value, priv->incoming);
161 g_value_set_enum (value, priv->status);
167 empathy_dispatch_operation_invalidated (TpProxy *proxy, guint domain,
168 gint code, char *message, EmpathyDispatchOperation *self)
170 empathy_dispatch_operation_set_status (self,
171 EMPATHY_DISPATCHER_OPERATION_STATE_INVALIDATED);
173 g_signal_emit (self, signals[INVALIDATED], 0, domain, code, message);
177 dispatcher_operation_got_contact_cb (EmpathyTpContactFactory *factory,
182 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
184 if (priv->contact != NULL)
185 g_object_unref (priv->contact);
186 priv->contact = g_object_ref (contacts->data);
187 g_object_notify (G_OBJECT (self), "contact");
189 tp_channel_call_when_ready (priv->channel,
190 empathy_dispatch_operation_channel_ready_cb, self);
194 empathy_dispatch_operation_constructed (GObject *object)
196 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (object);
197 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
199 TpHandleType handle_type;
201 empathy_dispatch_operation_set_status (self,
202 EMPATHY_DISPATCHER_OPERATION_STATE_PREPARING);
204 priv->invalidated_handler =
205 g_signal_connect (priv->channel, "invalidated",
206 G_CALLBACK (empathy_dispatch_operation_invalidated), self);
208 handle = tp_channel_get_handle (priv->channel, &handle_type);
210 if (handle_type == TP_CONN_HANDLE_TYPE_CONTACT && priv->contact == NULL)
212 EmpathyTpContactFactory *factory;
214 factory = empathy_tp_contact_factory_dup_singleton (priv->connection);
215 empathy_tp_contact_factory_get_from_handles (factory, 1, &handle,
216 dispatcher_operation_got_contact_cb, NULL, NULL, object);
217 g_object_unref (factory);
221 tp_channel_call_when_ready (priv->channel,
222 empathy_dispatch_operation_channel_ready_cb, self);
226 empathy_dispatch_operation_class_init (
227 EmpathyDispatchOperationClass *empathy_dispatch_operation_class)
229 GObjectClass *object_class =
230 G_OBJECT_CLASS (empathy_dispatch_operation_class);
231 GParamSpec *param_spec;
233 g_type_class_add_private (empathy_dispatch_operation_class,
234 sizeof (EmpathyDispatchOperationPriv));
236 object_class->set_property = empathy_dispatch_operation_set_property;
237 object_class->get_property = empathy_dispatch_operation_get_property;
239 object_class->dispose = empathy_dispatch_operation_dispose;
240 object_class->finalize = empathy_dispatch_operation_finalize;
241 object_class->constructed = empathy_dispatch_operation_constructed;
243 signals[READY] = g_signal_new ("ready",
244 G_OBJECT_CLASS_TYPE(empathy_dispatch_operation_class),
248 g_cclosure_marshal_VOID__VOID,
251 signals[APPROVED] = g_signal_new ("approved",
252 G_OBJECT_CLASS_TYPE(empathy_dispatch_operation_class),
256 g_cclosure_marshal_VOID__VOID,
259 signals[CLAIMED] = g_signal_new ("claimed",
260 G_OBJECT_CLASS_TYPE(empathy_dispatch_operation_class),
264 g_cclosure_marshal_VOID__VOID,
267 signals[INVALIDATED] = g_signal_new ("invalidated",
268 G_OBJECT_CLASS_TYPE(empathy_dispatch_operation_class),
272 _empathy_marshal_VOID__UINT_INT_STRING,
273 G_TYPE_NONE, 3, G_TYPE_UINT, G_TYPE_INT, G_TYPE_STRING);
275 param_spec = g_param_spec_object ("connection",
276 "connection", "The telepathy connection",
278 G_PARAM_CONSTRUCT_ONLY |
279 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
280 g_object_class_install_property (object_class, PROP_CONNECTION,
283 param_spec = g_param_spec_object ("channel",
284 "channel", "The telepathy channel",
286 G_PARAM_CONSTRUCT_ONLY |
287 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
288 g_object_class_install_property (object_class, PROP_CHANNEL,
291 param_spec = g_param_spec_object ("channel-wrapper",
292 "channel wrapper", "The empathy specific channel wrapper",
294 G_PARAM_CONSTRUCT_ONLY | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
295 g_object_class_install_property (object_class, PROP_CHANNEL_WRAPPER,
298 param_spec = g_param_spec_object ("contact",
299 "contact", "The empathy contact",
300 EMPATHY_TYPE_CONTACT,
301 G_PARAM_CONSTRUCT | G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
302 g_object_class_install_property (object_class, PROP_CONTACT,
305 param_spec = g_param_spec_boolean ("incoming",
306 "incoming", "Whether or not the channel is incoming",
308 G_PARAM_CONSTRUCT_ONLY |
309 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
310 g_object_class_install_property (object_class, PROP_INCOMING,
313 param_spec = g_param_spec_enum ("status",
314 "status", "Status of the dispatch operation",
315 EMPATHY_TYPE_DISPATCH_OPERATION_STATE, 0,
316 G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
317 g_object_class_install_property (object_class, PROP_STATUS, param_spec);
321 empathy_dispatch_operation_dispose (GObject *object)
323 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (object);
324 EmpathyDispatchOperationPriv *priv =
327 if (priv->dispose_has_run)
330 priv->dispose_has_run = TRUE;
332 g_object_unref (priv->connection);
334 if (priv->channel_wrapper != NULL)
335 g_object_unref (priv->channel_wrapper);
337 if (priv->ready_handler != 0)
338 g_signal_handler_disconnect (priv->channel_wrapper,
339 priv->invalidated_handler);
342 g_signal_handler_disconnect (priv->channel, priv->invalidated_handler);
343 g_object_unref (priv->channel);
346 if (priv->contact != NULL)
347 g_object_unref (priv->contact);
349 if (G_OBJECT_CLASS (empathy_dispatch_operation_parent_class)->dispose)
350 G_OBJECT_CLASS (empathy_dispatch_operation_parent_class)->dispose (object);
354 empathy_dispatch_operation_finalize (GObject *object)
356 /* free any data held directly by the object here */
357 G_OBJECT_CLASS (empathy_dispatch_operation_parent_class)->finalize (object);
361 empathy_dispatch_operation_set_status (EmpathyDispatchOperation *self,
362 EmpathyDispatchOperationState status)
364 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
366 g_assert (status >= priv->status);
369 if (priv->status != status)
371 DEBUG ("Dispatch operation %s status: %d -> %d",
372 empathy_dispatch_operation_get_object_path (self),
373 priv->status, status);
375 priv->status = status;
376 g_object_notify (G_OBJECT (self), "status");
378 if (status == EMPATHY_DISPATCHER_OPERATION_STATE_PENDING)
379 g_signal_emit (self, signals[READY], 0);
384 empathy_dispatcher_operation_tp_chat_ready_cb (GObject *object,
385 GParamSpec *spec, gpointer user_data)
387 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (user_data);
388 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
390 if (!empathy_tp_chat_is_ready (EMPATHY_TP_CHAT (priv->channel_wrapper)))
393 g_signal_handler_disconnect (priv->channel_wrapper, priv->ready_handler);
394 priv->ready_handler = 0;
396 empathy_dispatch_operation_set_status (self,
397 EMPATHY_DISPATCHER_OPERATION_STATE_PENDING);
401 empathy_dispatcher_operation_tp_file_ready_cb (GObject *object,
402 GParamSpec *spec, gpointer user_data)
404 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (user_data);
405 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
407 if (!empathy_tp_file_is_ready (EMPATHY_TP_FILE (priv->channel_wrapper)))
410 g_signal_handler_disconnect (priv->channel_wrapper, priv->ready_handler);
411 priv->ready_handler = 0;
413 empathy_dispatch_operation_set_status (self,
414 EMPATHY_DISPATCHER_OPERATION_STATE_PENDING);
418 empathy_dispatch_operation_channel_ready_cb (TpChannel *channel,
419 const GError *error, gpointer user_data)
421 EmpathyDispatchOperation *self = EMPATHY_DISPATCH_OPERATION (user_data);
422 EmpathyDispatchOperationPriv *priv = GET_PRIV (self);
425 /* The error will be handled in empathy_dispatch_operation_invalidated */
429 g_assert (channel == priv->channel);
431 /* If the channel wrapper is defined, we assume it's ready */
432 if (priv->channel_wrapper != NULL)
435 channel_type = tp_channel_get_channel_type_id (channel);
437 if (channel_type == TP_IFACE_QUARK_CHANNEL_TYPE_TEXT)
439 EmpathyTpChat *chat= empathy_tp_chat_new (channel);
440 priv->channel_wrapper = G_OBJECT (chat);
442 if (!empathy_tp_chat_is_ready (chat))
444 priv->ready_handler = g_signal_connect (chat, "notify::ready",
445 G_CALLBACK (empathy_dispatcher_operation_tp_chat_ready_cb), self);
449 else if (channel_type == TP_IFACE_QUARK_CHANNEL_TYPE_STREAMED_MEDIA)
451 EmpathyTpCall *call = empathy_tp_call_new (channel);
452 priv->channel_wrapper = G_OBJECT (call);
454 else if (channel_type == TP_IFACE_QUARK_CHANNEL_TYPE_FILE_TRANSFER)
456 EmpathyTpFile *file = empathy_tp_file_new (channel);
457 priv->channel_wrapper = G_OBJECT (file);
459 if (!empathy_tp_file_is_ready (file))
461 priv->ready_handler = g_signal_connect (file, "notify::ready",
462 G_CALLBACK (empathy_dispatcher_operation_tp_file_ready_cb), self);
468 empathy_dispatch_operation_set_status (self,
469 EMPATHY_DISPATCHER_OPERATION_STATE_PENDING);
472 EmpathyDispatchOperation *
473 empathy_dispatch_operation_new (TpConnection *connection, TpChannel *channel,
474 EmpathyContact *contact, gboolean incoming)
476 return empathy_dispatch_operation_new_with_wrapper (connection, channel,
477 contact, incoming, NULL);
480 EmpathyDispatchOperation *
481 empathy_dispatch_operation_new_with_wrapper (TpConnection *connection,
482 TpChannel *channel, EmpathyContact *contact, gboolean incoming,
485 g_return_val_if_fail (connection != NULL, NULL);
486 g_return_val_if_fail (channel != NULL, NULL);
488 return EMPATHY_DISPATCH_OPERATION (
489 g_object_new (EMPATHY_TYPE_DISPATCH_OPERATION,
490 "connection", connection,
492 "channel-wrapper", wrapper,
494 "incoming", incoming,
499 empathy_dispatch_operation_start (EmpathyDispatchOperation *operation)
501 EmpathyDispatchOperationPriv *priv;
503 g_return_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation));
505 priv = GET_PRIV (operation);
508 priv->status == EMPATHY_DISPATCHER_OPERATION_STATE_PENDING);
510 if (priv->incoming && !priv->approved)
511 empathy_dispatch_operation_set_status (operation,
512 EMPATHY_DISPATCHER_OPERATION_STATE_APPROVING);
514 empathy_dispatch_operation_set_status (operation,
515 EMPATHY_DISPATCHER_OPERATION_STATE_DISPATCHING);
519 empathy_dispatch_operation_approve (EmpathyDispatchOperation *operation)
521 EmpathyDispatchOperationPriv *priv;
523 g_return_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation));
525 priv = GET_PRIV (operation);
527 if (priv->status == EMPATHY_DISPATCHER_OPERATION_STATE_APPROVING)
529 DEBUG ("Approving operation %s",
530 empathy_dispatch_operation_get_object_path (operation));
532 empathy_dispatch_operation_set_status (operation,
533 EMPATHY_DISPATCHER_OPERATION_STATE_DISPATCHING);
535 g_signal_emit (operation, signals[APPROVED], 0);
537 else if (priv->status < EMPATHY_DISPATCHER_OPERATION_STATE_APPROVING)
539 DEBUG ("Pre-approving operation %s",
540 empathy_dispatch_operation_get_object_path (operation));
541 priv->approved = TRUE;
546 "Ignoring approval for %s as it's already past the approval stage",
547 empathy_dispatch_operation_get_object_path (operation));
551 /* Returns whether or not the operation was successfully claimed */
553 empathy_dispatch_operation_claim (EmpathyDispatchOperation *operation)
555 EmpathyDispatchOperationPriv *priv;
557 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), FALSE);
559 priv = GET_PRIV (operation);
561 if (priv->status == EMPATHY_DISPATCHER_OPERATION_STATE_CLAIMED)
564 empathy_dispatch_operation_set_status (operation,
565 EMPATHY_DISPATCHER_OPERATION_STATE_CLAIMED);
567 g_signal_emit (operation, signals[CLAIMED], 0);
573 empathy_dispatch_operation_get_tp_connection (
574 EmpathyDispatchOperation *operation)
576 EmpathyDispatchOperationPriv *priv;
578 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
580 priv = GET_PRIV (operation);
582 return g_object_ref (priv->connection);
586 empathy_dispatch_operation_get_channel (EmpathyDispatchOperation *operation)
588 EmpathyDispatchOperationPriv *priv;
590 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
592 priv = GET_PRIV (operation);
594 return priv->channel;
598 empathy_dispatch_operation_get_channel_wrapper (
599 EmpathyDispatchOperation *operation)
601 EmpathyDispatchOperationPriv *priv;
603 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
605 priv = GET_PRIV (operation);
607 return priv->channel_wrapper;
611 empathy_dispatch_operation_get_channel_type (
612 EmpathyDispatchOperation *operation)
614 EmpathyDispatchOperationPriv *priv;
616 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
618 priv = GET_PRIV (operation);
620 return tp_channel_get_channel_type (priv->channel);
624 empathy_dispatch_operation_get_channel_type_id (
625 EmpathyDispatchOperation *operation)
627 EmpathyDispatchOperationPriv *priv;
629 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), 0);
631 priv = GET_PRIV (operation);
633 return tp_channel_get_channel_type_id (priv->channel);
637 empathy_dispatch_operation_get_object_path (
638 EmpathyDispatchOperation *operation)
640 EmpathyDispatchOperationPriv *priv;
642 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), NULL);
644 priv = GET_PRIV (operation);
646 return tp_proxy_get_object_path (TP_PROXY (priv->channel));
649 EmpathyDispatchOperationState
650 empathy_dispatch_operation_get_status (EmpathyDispatchOperation *operation)
652 EmpathyDispatchOperationPriv *priv;
654 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation),
655 EMPATHY_DISPATCHER_OPERATION_STATE_PREPARING);
657 priv = GET_PRIV (operation);
663 empathy_dispatch_operation_is_incoming (EmpathyDispatchOperation *operation)
665 EmpathyDispatchOperationPriv *priv;
667 g_return_val_if_fail (EMPATHY_IS_DISPATCH_OPERATION (operation), FALSE);
669 priv = GET_PRIV (operation);
671 return priv->incoming;