2 * Copyright (C) 2007-2009 Collabora Ltd.
3 * Copyright (C) 2007 Marco Barisione <marco@barisione.org>
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 * Authors: Marco Barisione <marco@barisione.org>
20 * Jonny Lamb <jonny.lamb@collabora.co.uk>
21 * Cosimo Cecchi <cosimo.cecchi@collabora.co.uk>
29 #include <sys/types.h>
30 #include <sys/socket.h>
33 #include <glib/gi18n-lib.h>
36 #include <gio/gunixinputstream.h>
37 #include <gio/gunixoutputstream.h>
39 #include <telepathy-glib/proxy-subclass.h>
40 #include <telepathy-glib/util.h>
42 #include "empathy-tp-file.h"
43 #include "empathy-marshal.h"
44 #include "empathy-time.h"
45 #include "empathy-utils.h"
47 #include "extensions/extensions.h"
49 #define DEBUG_FLAG EMPATHY_DEBUG_FT
50 #include "empathy-debug.h"
53 * SECTION:empathy-tp-file
54 * @title: EmpathyTpFile
55 * @short_description: Object which represents a Telepathy file channel
56 * @include: libempathy/empathy-tp-file.h
58 * #EmpathyTpFile is an object which represents a Telepathy file channel.
63 * @parent: parent object
65 * Object which represents a Telepathy file channel.
69 * EMPATHY_TP_FILE_UNKNOWN_SIZE:
71 * Value used for the "size" or "estimated-size" properties when the size of
72 * the transferred file is unknown.
75 /* EmpathyTpFile object */
81 GInputStream *in_stream;
82 GOutputStream *out_stream;
84 /* org.freedesktop.Telepathy.Channel.Type.FileTransfer D-Bus properties */
85 EmpFileTransferState state;
86 EmpFileTransferStateChangeReason state_change_reason;
88 /* transfer properties */
91 GArray *unix_socket_path;
94 /* GCancellable we're passed when offering/accepting the transfer */
95 GCancellable *cancellable;
97 /* callbacks for the operation */
98 EmpathyTpFileProgressCallback progress_callback;
99 gpointer progress_user_data;
100 EmpathyTpFileOperationCallback op_callback;
101 gpointer op_user_data;
103 gboolean dispose_run;
113 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyTpFile)
115 G_DEFINE_TYPE (EmpathyTpFile, empathy_tp_file, G_TYPE_OBJECT);
117 /* private functions */
120 tp_file_get_state_cb (TpProxy *proxy,
124 GObject *weak_object)
126 EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
130 /* set a default value for the state */
131 priv->state = TP_FILE_TRANSFER_STATE_NONE;
135 priv->state = g_value_get_uint (value);
139 tp_file_invalidated_cb (TpProxy *proxy,
143 EmpathyTpFile *tp_file)
145 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
147 DEBUG ("Channel invalidated: %s", message);
149 if (priv->state != TP_FILE_TRANSFER_STATE_COMPLETED &&
150 priv->state != TP_FILE_TRANSFER_STATE_CANCELLED)
152 /* The channel is not in a finished state, an error occured */
153 priv->state = TP_FILE_TRANSFER_STATE_CANCELLED;
154 priv->state_change_reason =
155 TP_FILE_TRANSFER_STATE_CHANGE_REASON_LOCAL_ERROR;
156 g_object_notify (G_OBJECT (tp_file), "state");
161 ft_operation_close_clean (EmpathyTpFile *tp_file)
163 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
165 DEBUG ("Splice close clean");
167 if (priv->op_callback)
168 priv->op_callback (tp_file, NULL, priv->op_user_data);
172 ft_operation_close_with_error (EmpathyTpFile *tp_file,
175 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
177 DEBUG ("Splice close with error %s", error->message);
179 if (priv->op_callback)
180 priv->op_callback (tp_file, error, priv->op_user_data);
184 splice_stream_ready_cb (GObject *source,
188 EmpathyTpFile *tp_file;
189 GError *error = NULL;
193 g_output_stream_splice_finish (G_OUTPUT_STREAM (source), res, &error);
197 ft_operation_close_with_error (tp_file, error);
198 g_clear_error (&error);
204 tp_file_start_transfer (EmpathyTpFile *tp_file)
207 struct sockaddr_un addr;
208 GError *error = NULL;
209 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
211 fd = socket (PF_UNIX, SOCK_STREAM, 0);
216 error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
217 EMPATHY_FT_ERROR_SOCKET, g_strerror (code));
219 DEBUG ("Failed to create socket, closing channel");
221 ft_operation_close_with_error (tp_file, error);
222 g_clear_error (&error);
227 memset (&addr, 0, sizeof (addr));
228 addr.sun_family = AF_UNIX;
229 strncpy (addr.sun_path, priv->unix_socket_path->data,
230 priv->unix_socket_path->len);
232 if (connect (fd, (struct sockaddr*) &addr, sizeof (addr)) < 0)
236 error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
237 EMPATHY_FT_ERROR_SOCKET, g_strerror (code));
239 DEBUG ("Failed to connect socket, closing channel");
241 ft_operation_close_with_error (tp_file, error);
243 g_clear_error (&error);
248 DEBUG ("Start the transfer");
250 priv->start_time = empathy_time_get_current ();
252 /* notify we're starting a transfer */
253 if (priv->progress_callback)
254 priv->progress_callback (tp_file, 0, priv->progress_user_data);
258 GInputStream *socket_stream;
260 socket_stream = g_unix_input_stream_new (fd, TRUE);
262 g_output_stream_splice_async (priv->out_stream, socket_stream,
263 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE |
264 G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
265 G_PRIORITY_DEFAULT, priv->cancellable,
266 splice_stream_ready_cb, tp_file);
268 g_object_unref (socket_stream);
272 GOutputStream *socket_stream;
274 socket_stream = g_unix_output_stream_new (fd, TRUE);
276 g_output_stream_splice_async (socket_stream, priv->in_stream,
277 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE |
278 G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
279 G_PRIORITY_DEFAULT, priv->cancellable,
280 splice_stream_ready_cb, tp_file);
282 g_object_unref (socket_stream);
287 tp_file_state_changed_cb (TpChannel *proxy,
291 GObject *weak_object)
293 EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
295 if (state == priv->state)
298 DEBUG ("File transfer state changed:\n"
299 "old state = %u, state = %u, reason = %u\n"
300 "\tincoming = %s, in_stream = %s, out_stream = %s",
301 priv->state, state, reason,
302 priv->incoming ? "yes" : "no",
303 priv->in_stream ? "present" : "not present",
304 priv->out_stream ? "present" : "not present");
307 priv->state_change_reason = reason;
309 /* If the channel is open AND we have the socket path, we can start the
310 * transfer. The socket path could be NULL if we are not doing the actual
311 * data transfer but are just an observer for the channel.
313 if (state == TP_FILE_TRANSFER_STATE_OPEN &&
314 priv->unix_socket_path != NULL)
315 tp_file_start_transfer (EMPATHY_TP_FILE (weak_object));
317 if (state == TP_FILE_TRANSFER_STATE_COMPLETED)
318 ft_operation_close_clean (EMPATHY_TP_FILE (weak_object));
320 g_object_notify (weak_object, "state");
324 tp_file_transferred_bytes_changed_cb (TpChannel *proxy,
327 GObject *weak_object)
329 EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
332 if (priv->progress_callback)
333 priv->progress_callback (EMPATHY_TP_FILE (weak_object),
334 count, priv->progress_user_data);
338 ft_operation_provide_or_accept_file_cb (TpChannel *proxy,
339 const GValue *address,
342 GObject *weak_object)
344 EmpathyTpFile *tp_file = EMPATHY_TP_FILE (weak_object);
345 GError *myerr = NULL;
346 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
348 g_cancellable_set_error_if_cancelled (priv->cancellable, &myerr);
354 /* if we were both cancelled and failed when calling the method,
355 * report the method error.
357 g_clear_error (&myerr);
358 myerr = g_error_copy (error);
364 DEBUG ("Error: %s", error->message);
365 ft_operation_close_with_error (tp_file, myerr);
366 g_clear_error (&myerr);
370 if (G_VALUE_TYPE (address) == DBUS_TYPE_G_UCHAR_ARRAY)
372 priv->unix_socket_path = g_value_dup_boxed (address);
374 else if (G_VALUE_TYPE (address) == G_TYPE_STRING)
376 /* Old bugged version of telepathy-salut used to store the address
377 * as a 's' instead of an 'ay' */
380 path = g_value_get_string (address);
381 priv->unix_socket_path = g_array_sized_new (TRUE, FALSE, sizeof (gchar),
383 g_array_insert_vals (priv->unix_socket_path, 0, path, strlen (path));
386 DEBUG ("Got unix socket path: %s", priv->unix_socket_path->data);
388 /* if the channel is already open, start the transfer now, otherwise,
389 * wait for the state change signal.
391 if (priv->state == TP_FILE_TRANSFER_STATE_OPEN)
392 tp_file_start_transfer (tp_file);
396 file_read_async_cb (GObject *source,
400 GValue nothing = { 0 };
401 EmpathyTpFile *tp_file = user_data;
402 EmpathyTpFilePriv *priv;
403 GFileInputStream *in_stream;
404 GError *error = NULL;
406 priv = GET_PRIV (tp_file);
408 in_stream = g_file_read_finish (G_FILE (source), res, &error);
412 ft_operation_close_with_error (tp_file, error);
413 g_clear_error (&error);
417 priv->in_stream = G_INPUT_STREAM (in_stream);
419 g_value_init (¬hing, G_TYPE_STRING);
420 g_value_set_static_string (¬hing, "");
422 tp_cli_channel_type_file_transfer_call_provide_file (
424 TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
425 ¬hing, ft_operation_provide_or_accept_file_cb, NULL, NULL, G_OBJECT (tp_file));
429 file_replace_async_cb (GObject *source,
433 GValue nothing = { 0 };
434 EmpathyTpFile *tp_file = user_data;
435 EmpathyTpFilePriv *priv;
436 GError *error = NULL;
437 GFileOutputStream *out_stream;
439 priv = GET_PRIV (tp_file);
441 out_stream = g_file_replace_finish (G_FILE (source), res, &error);
445 ft_operation_close_with_error (tp_file, error);
446 g_clear_error (&error);
451 priv->out_stream = G_OUTPUT_STREAM (out_stream);
453 g_value_init (¬hing, G_TYPE_STRING);
454 g_value_set_static_string (¬hing, "");
456 tp_cli_channel_type_file_transfer_call_accept_file (priv->channel,
457 -1, TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
458 ¬hing, priv->offset,
459 ft_operation_provide_or_accept_file_cb, NULL, NULL, G_OBJECT (tp_file));
462 /* GObject methods */
465 empathy_tp_file_init (EmpathyTpFile *tp_file)
467 EmpathyTpFilePriv *priv;
469 priv = G_TYPE_INSTANCE_GET_PRIVATE ((tp_file),
470 EMPATHY_TYPE_TP_FILE, EmpathyTpFilePriv);
472 tp_file->priv = priv;
476 do_dispose (GObject *object)
478 EmpathyTpFilePriv *priv = GET_PRIV (object);
480 if (priv->dispose_run)
483 priv->dispose_run = TRUE;
487 g_signal_handlers_disconnect_by_func (priv->channel,
488 tp_file_invalidated_cb, object);
489 g_object_unref (priv->channel);
490 priv->channel = NULL;
494 g_object_unref (priv->in_stream);
496 if (priv->out_stream)
497 g_object_unref (priv->out_stream);
499 if (priv->cancellable)
500 g_object_unref (priv->cancellable);
502 G_OBJECT_CLASS (empathy_tp_file_parent_class)->dispose (object);
506 do_finalize (GObject *object)
508 EmpathyTpFilePriv *priv = GET_PRIV (object);
510 g_free (priv->unix_socket_path);
512 G_OBJECT_CLASS (empathy_tp_file_parent_class)->finalize (object);
516 do_get_property (GObject *object,
521 EmpathyTpFilePriv *priv = GET_PRIV (object);
526 g_value_set_object (value, priv->channel);
529 g_value_set_boolean (value, priv->incoming);
532 g_value_set_uint (value, priv->state);
535 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
541 do_set_property (GObject *object,
546 EmpathyTpFilePriv *priv = GET_PRIV (object);
550 priv->channel = g_object_ref (g_value_get_object (value));
553 priv->incoming = g_value_get_boolean (value);
556 priv->state = g_value_get_uint (value);
559 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
565 do_constructor (GType type,
567 GObjectConstructParam *props)
570 EmpathyTpFile *tp_file;
571 EmpathyTpFilePriv *priv;
573 file_obj = G_OBJECT_CLASS (empathy_tp_file_parent_class)->constructor (type,
576 tp_file = EMPATHY_TP_FILE (file_obj);
577 priv = GET_PRIV (tp_file);
579 g_signal_connect (priv->channel, "invalidated",
580 G_CALLBACK (tp_file_invalidated_cb), tp_file);
582 tp_cli_channel_type_file_transfer_connect_to_file_transfer_state_changed (
583 priv->channel, tp_file_state_changed_cb, NULL, NULL,
584 G_OBJECT (tp_file), NULL);
586 tp_cli_channel_type_file_transfer_connect_to_transferred_bytes_changed (
587 priv->channel, tp_file_transferred_bytes_changed_cb,
588 NULL, NULL, G_OBJECT (tp_file), NULL);
590 tp_cli_dbus_properties_call_get (priv->channel,
591 -1, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER, "State", tp_file_get_state_cb,
592 NULL, NULL, file_obj);
594 priv->state_change_reason =
595 TP_FILE_TRANSFER_STATE_CHANGE_REASON_NONE;
601 empathy_tp_file_class_init (EmpathyTpFileClass *klass)
603 GObjectClass *object_class = G_OBJECT_CLASS (klass);
605 object_class->finalize = do_finalize;
606 object_class->dispose = do_dispose;
607 object_class->constructor = do_constructor;
608 object_class->get_property = do_get_property;
609 object_class->set_property = do_set_property;
611 /* Construct-only properties */
612 g_object_class_install_property (object_class,
614 g_param_spec_object ("channel",
616 "The file transfer channel",
619 G_PARAM_CONSTRUCT_ONLY));
621 g_object_class_install_property (object_class,
623 g_param_spec_boolean ("incoming",
624 "direction of transfer",
625 "The direction of the file being transferred",
628 G_PARAM_CONSTRUCT_ONLY));
630 g_object_class_install_property (object_class,
632 g_param_spec_uint ("state",
633 "state of the transfer",
634 "The file transfer state",
641 g_type_class_add_private (object_class, sizeof (EmpathyTpFilePriv));
647 * empathy_tp_file_new:
648 * @channel: a #TpChannel
650 * Creates a new #EmpathyTpFile wrapping @channel, or return a new ref to an
651 * existing #EmpathyTpFile for that channel. The returned #EmpathyTpFile
652 * should be unrefed with g_object_unref() when finished with.
654 * Return value: a new #EmpathyTpFile
657 empathy_tp_file_new (TpChannel *channel, gboolean incoming)
659 EmpathyTpFile *tp_file;
661 g_return_val_if_fail (TP_IS_CHANNEL (channel), NULL);
663 tp_file = g_object_new (EMPATHY_TYPE_TP_FILE,
664 "channel", channel, "incoming", incoming,
671 empathy_tp_file_accept (EmpathyTpFile *tp_file,
674 GCancellable *cancellable,
675 EmpathyTpFileProgressCallback progress_callback,
676 gpointer progress_user_data,
677 EmpathyTpFileOperationCallback op_callback,
678 gpointer op_user_data)
680 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
682 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
683 g_return_if_fail (G_IS_FILE (gfile));
684 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
686 priv->cancellable = g_object_ref (cancellable);
687 priv->progress_callback = progress_callback;
688 priv->progress_user_data = progress_user_data;
689 priv->op_callback = op_callback;
690 priv->op_user_data = op_user_data;
691 priv->offset = offset;
693 g_file_replace_async (gfile, NULL, FALSE, G_FILE_CREATE_NONE,
694 G_PRIORITY_DEFAULT, cancellable, file_replace_async_cb, tp_file);
698 empathy_tp_file_offer (EmpathyTpFile *tp_file,
700 GCancellable *cancellable,
701 EmpathyTpFileProgressCallback progress_callback,
702 gpointer progress_user_data,
703 EmpathyTpFileOperationCallback op_callback,
704 gpointer op_user_data)
706 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
708 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
709 g_return_if_fail (G_IS_FILE (gfile));
710 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
712 priv->cancellable = g_object_ref (cancellable);
713 priv->progress_callback = progress_callback;
714 priv->progress_user_data = progress_user_data;
715 priv->op_callback = op_callback;
716 priv->op_user_data = op_user_data;
718 g_file_read_async (gfile, G_PRIORITY_DEFAULT, cancellable,
719 file_read_async_cb, tp_file);
723 * empathy_tp_file_is_incoming:
724 * @tp_file: an #EmpathyTpFile
726 * Returns whether @tp_file is incoming.
728 * Return value: %TRUE if the @tp_file is incoming, otherwise %FALSE
731 empathy_tp_file_is_incoming (EmpathyTpFile *tp_file)
733 EmpathyTpFilePriv *priv;
735 g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
737 priv = GET_PRIV (tp_file);
739 return priv->incoming;
743 * empathy_tp_file_get_state:
744 * @tp_file: an #EmpathyTpFile
745 * @reason: return location for state change reason, or %NULL
747 * Gets the current state of @tp_file. If @reason is not %NULL, then
748 * it is set to the reason of the last state change.
750 * Return value: a #TpFileTransferState
753 empathy_tp_file_get_state (EmpathyTpFile *tp_file,
754 TpFileTransferStateChangeReason *reason)
756 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
758 g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file),
759 TP_FILE_TRANSFER_STATE_NONE);
762 *reason = priv->state_change_reason;
768 * empathy_tp_file_cancel:
769 * @tp_file: an #EmpathyTpFile
771 * Cancels the file transfer, @tp_file.
774 empathy_tp_file_cancel (EmpathyTpFile *tp_file)
776 EmpathyTpFilePriv *priv;
778 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
780 priv = GET_PRIV (tp_file);
782 DEBUG ("Closing channel..");
783 tp_cli_channel_call_close (priv->channel, -1,
784 NULL, NULL, NULL, NULL);
786 if (priv->cancellable != NULL)
787 g_cancellable_cancel (priv->cancellable);
791 * empathy_tp_file_is_ready:
792 * @tp_file: an #EmpathyTpFile
794 * Returns whether the file channel @tp_file is ready for use.
796 * @tp_file is classed as ready if its state is no longer
797 * %TP_FILE_TRANSFER_STATE_NONE, or if details about the remote
798 * contact have been fully received.
800 * Return value: %TRUE if @tp_file is ready for use
803 empathy_tp_file_is_ready (EmpathyTpFile *tp_file)
805 g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
807 return tp_file->priv->ready;