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 #define DEBUG_FLAG EMPATHY_DEBUG_FT
48 #include "empathy-debug.h"
51 * SECTION:empathy-tp-file
52 * @title: EmpathyTpFile
53 * @short_description: Object which represents a Telepathy file channel
54 * @include: libempathy/empathy-tp-file.h
56 * #EmpathyTpFile is an object which represents a Telepathy file channel.
61 * @parent: parent object
63 * Object which represents a Telepathy file channel.
67 * EMPATHY_TP_FILE_UNKNOWN_SIZE:
69 * Value used for the "size" or "estimated-size" properties when the size of
70 * the transferred file is unknown.
73 /* EmpathyTpFile object */
79 GInputStream *in_stream;
80 GOutputStream *out_stream;
82 /* org.freedesktop.Telepathy.Channel.Type.FileTransfer D-Bus properties */
83 TpFileTransferState state;
84 TpFileTransferStateChangeReason state_change_reason;
86 /* transfer properties */
89 GArray *unix_socket_path;
92 /* GCancellable we're passed when offering/accepting the transfer */
93 GCancellable *cancellable;
95 /* callbacks for the operation */
96 EmpathyTpFileProgressCallback progress_callback;
97 gpointer progress_user_data;
98 EmpathyTpFileOperationCallback op_callback;
99 gpointer op_user_data;
101 gboolean dispose_run;
110 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyTpFile)
112 G_DEFINE_TYPE (EmpathyTpFile, empathy_tp_file, G_TYPE_OBJECT);
114 /* private functions */
117 tp_file_get_state_cb (TpProxy *proxy,
121 GObject *weak_object)
123 EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
127 /* set a default value for the state */
128 priv->state = TP_FILE_TRANSFER_STATE_NONE;
132 priv->state = g_value_get_uint (value);
136 tp_file_invalidated_cb (TpProxy *proxy,
140 EmpathyTpFile *tp_file)
142 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
144 DEBUG ("Channel invalidated: %s", message);
146 if (priv->state != TP_FILE_TRANSFER_STATE_COMPLETED &&
147 priv->state != TP_FILE_TRANSFER_STATE_CANCELLED)
149 /* The channel is not in a finished state, an error occured */
150 priv->state = TP_FILE_TRANSFER_STATE_CANCELLED;
151 priv->state_change_reason =
152 TP_FILE_TRANSFER_STATE_CHANGE_REASON_LOCAL_ERROR;
157 ft_operation_close_clean (EmpathyTpFile *tp_file)
159 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
161 DEBUG ("Splice close clean");
163 if (priv->op_callback)
164 priv->op_callback (tp_file, NULL, priv->op_user_data);
168 ft_operation_close_with_error (EmpathyTpFile *tp_file,
171 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
173 DEBUG ("Splice close with error %s", error->message);
175 if (priv->op_callback)
176 priv->op_callback (tp_file, error, priv->op_user_data);
180 splice_stream_ready_cb (GObject *source,
184 EmpathyTpFile *tp_file;
185 GError *error = NULL;
189 DEBUG ("Splice stream ready cb");
191 g_output_stream_splice_finish (G_OUTPUT_STREAM (source), res, &error);
195 ft_operation_close_with_error (tp_file, error);
196 g_clear_error (&error);
202 tp_file_start_transfer (EmpathyTpFile *tp_file)
205 struct sockaddr_un addr;
206 GError *error = NULL;
207 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
209 fd = socket (PF_UNIX, SOCK_STREAM, 0);
214 error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
215 EMPATHY_FT_ERROR_SOCKET, g_strerror (code));
217 DEBUG ("Failed to create socket, closing channel");
219 ft_operation_close_with_error (tp_file, error);
220 g_clear_error (&error);
225 memset (&addr, 0, sizeof (addr));
226 addr.sun_family = AF_UNIX;
227 strncpy (addr.sun_path, priv->unix_socket_path->data,
228 priv->unix_socket_path->len);
230 if (connect (fd, (struct sockaddr*) &addr, sizeof (addr)) < 0)
234 error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
235 EMPATHY_FT_ERROR_SOCKET, g_strerror (code));
237 DEBUG ("Failed to connect socket, closing channel");
239 ft_operation_close_with_error (tp_file, error);
241 g_clear_error (&error);
246 DEBUG ("Start the transfer");
248 priv->start_time = empathy_time_get_current ();
250 /* notify we're starting a transfer */
251 if (priv->progress_callback)
252 priv->progress_callback (tp_file, 0, priv->progress_user_data);
256 GInputStream *socket_stream;
258 socket_stream = g_unix_input_stream_new (fd, TRUE);
260 g_output_stream_splice_async (priv->out_stream, socket_stream,
261 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE |
262 G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
263 G_PRIORITY_DEFAULT, priv->cancellable,
264 splice_stream_ready_cb, tp_file);
266 g_object_unref (socket_stream);
270 GOutputStream *socket_stream;
272 socket_stream = g_unix_output_stream_new (fd, TRUE);
274 g_output_stream_splice_async (socket_stream, priv->in_stream,
275 G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE |
276 G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
277 G_PRIORITY_DEFAULT, priv->cancellable,
278 splice_stream_ready_cb, tp_file);
280 g_object_unref (socket_stream);
285 tp_file_state_changed_cb (TpChannel *proxy,
289 GObject *weak_object)
291 EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
293 if (state == priv->state)
296 DEBUG ("File transfer state changed:\n"
297 "old state = %u, state = %u, reason = %u\n"
298 "\tincoming = %s, in_stream = %s, out_stream = %s",
299 priv->state, state, reason,
300 priv->incoming ? "yes" : "no",
301 priv->in_stream ? "present" : "not present",
302 priv->out_stream ? "present" : "not present");
305 priv->state_change_reason = reason;
307 /* If the channel is open AND we have the socket path, we can start the
308 * transfer. The socket path could be NULL if we are not doing the actual
309 * data transfer but are just an observer for the channel.
311 if (state == TP_FILE_TRANSFER_STATE_OPEN &&
312 priv->unix_socket_path != NULL)
313 tp_file_start_transfer (EMPATHY_TP_FILE (weak_object));
315 if (state == TP_FILE_TRANSFER_STATE_COMPLETED)
316 ft_operation_close_clean (EMPATHY_TP_FILE (weak_object));
320 tp_file_transferred_bytes_changed_cb (TpChannel *proxy,
323 GObject *weak_object)
325 EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
327 /* don't notify for 0 bytes count */
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));
463 close_channel_internal (EmpathyTpFile *tp_file,
466 EmpathyTpFilePriv *priv;
468 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
470 priv = GET_PRIV (tp_file);
472 DEBUG ("Closing channel..");
473 tp_cli_channel_call_close (priv->channel, -1,
474 NULL, NULL, NULL, NULL);
476 if (priv->cancellable != NULL &&
477 !g_cancellable_is_cancelled (priv->cancellable) && cancel)
478 g_cancellable_cancel (priv->cancellable);
481 /* GObject methods */
484 empathy_tp_file_init (EmpathyTpFile *tp_file)
486 EmpathyTpFilePriv *priv;
488 priv = G_TYPE_INSTANCE_GET_PRIVATE ((tp_file),
489 EMPATHY_TYPE_TP_FILE, EmpathyTpFilePriv);
491 tp_file->priv = priv;
495 do_dispose (GObject *object)
497 EmpathyTpFilePriv *priv = GET_PRIV (object);
499 if (priv->dispose_run)
502 priv->dispose_run = TRUE;
506 g_signal_handlers_disconnect_by_func (priv->channel,
507 tp_file_invalidated_cb, object);
508 g_object_unref (priv->channel);
509 priv->channel = NULL;
513 g_object_unref (priv->in_stream);
515 if (priv->out_stream)
516 g_object_unref (priv->out_stream);
518 if (priv->cancellable)
519 g_object_unref (priv->cancellable);
521 G_OBJECT_CLASS (empathy_tp_file_parent_class)->dispose (object);
525 do_finalize (GObject *object)
527 EmpathyTpFilePriv *priv = GET_PRIV (object);
529 DEBUG ("%p", object);
531 g_array_free (priv->unix_socket_path, TRUE);
533 G_OBJECT_CLASS (empathy_tp_file_parent_class)->finalize (object);
537 do_get_property (GObject *object,
542 EmpathyTpFilePriv *priv = GET_PRIV (object);
547 g_value_set_object (value, priv->channel);
550 g_value_set_boolean (value, priv->incoming);
553 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
559 do_set_property (GObject *object,
564 EmpathyTpFilePriv *priv = GET_PRIV (object);
568 priv->channel = g_object_ref (g_value_get_object (value));
571 priv->incoming = g_value_get_boolean (value);
574 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
580 do_constructor (GType type,
582 GObjectConstructParam *props)
585 EmpathyTpFile *tp_file;
586 EmpathyTpFilePriv *priv;
588 file_obj = G_OBJECT_CLASS (empathy_tp_file_parent_class)->constructor (type,
591 tp_file = EMPATHY_TP_FILE (file_obj);
592 priv = GET_PRIV (tp_file);
594 g_signal_connect (priv->channel, "invalidated",
595 G_CALLBACK (tp_file_invalidated_cb), tp_file);
597 tp_cli_channel_type_file_transfer_connect_to_file_transfer_state_changed (
598 priv->channel, tp_file_state_changed_cb, NULL, NULL,
599 G_OBJECT (tp_file), NULL);
601 tp_cli_channel_type_file_transfer_connect_to_transferred_bytes_changed (
602 priv->channel, tp_file_transferred_bytes_changed_cb,
603 NULL, NULL, G_OBJECT (tp_file), NULL);
605 tp_cli_dbus_properties_call_get (priv->channel,
606 -1, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER, "State", tp_file_get_state_cb,
607 NULL, NULL, file_obj);
609 priv->state_change_reason =
610 TP_FILE_TRANSFER_STATE_CHANGE_REASON_NONE;
616 empathy_tp_file_class_init (EmpathyTpFileClass *klass)
618 GObjectClass *object_class = G_OBJECT_CLASS (klass);
620 object_class->finalize = do_finalize;
621 object_class->dispose = do_dispose;
622 object_class->constructor = do_constructor;
623 object_class->get_property = do_get_property;
624 object_class->set_property = do_set_property;
626 /* Construct-only properties */
627 g_object_class_install_property (object_class,
629 g_param_spec_object ("channel",
631 "The file transfer channel",
634 G_PARAM_CONSTRUCT_ONLY));
636 g_object_class_install_property (object_class,
638 g_param_spec_boolean ("incoming",
639 "direction of transfer",
640 "The direction of the file being transferred",
643 G_PARAM_CONSTRUCT_ONLY));
645 g_type_class_add_private (object_class, sizeof (EmpathyTpFilePriv));
651 * empathy_tp_file_new:
652 * @channel: a #TpChannel
654 * Creates a new #EmpathyTpFile wrapping @channel, or return a new ref to an
655 * existing #EmpathyTpFile for that channel. The returned #EmpathyTpFile
656 * should be unrefed with g_object_unref() when finished with.
658 * Return value: a new #EmpathyTpFile
661 empathy_tp_file_new (TpChannel *channel, gboolean incoming)
663 EmpathyTpFile *tp_file;
665 g_return_val_if_fail (TP_IS_CHANNEL (channel), NULL);
667 tp_file = g_object_new (EMPATHY_TYPE_TP_FILE,
668 "channel", channel, "incoming", incoming,
675 empathy_tp_file_accept (EmpathyTpFile *tp_file,
678 GCancellable *cancellable,
679 EmpathyTpFileProgressCallback progress_callback,
680 gpointer progress_user_data,
681 EmpathyTpFileOperationCallback op_callback,
682 gpointer op_user_data)
684 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
686 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
687 g_return_if_fail (G_IS_FILE (gfile));
688 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
690 priv->cancellable = g_object_ref (cancellable);
691 priv->progress_callback = progress_callback;
692 priv->progress_user_data = progress_user_data;
693 priv->op_callback = op_callback;
694 priv->op_user_data = op_user_data;
695 priv->offset = offset;
697 g_file_replace_async (gfile, NULL, FALSE, G_FILE_CREATE_NONE,
698 G_PRIORITY_DEFAULT, cancellable, file_replace_async_cb, tp_file);
702 empathy_tp_file_offer (EmpathyTpFile *tp_file,
704 GCancellable *cancellable,
705 EmpathyTpFileProgressCallback progress_callback,
706 gpointer progress_user_data,
707 EmpathyTpFileOperationCallback op_callback,
708 gpointer op_user_data)
710 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
712 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
713 g_return_if_fail (G_IS_FILE (gfile));
714 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
716 priv->cancellable = g_object_ref (cancellable);
717 priv->progress_callback = progress_callback;
718 priv->progress_user_data = progress_user_data;
719 priv->op_callback = op_callback;
720 priv->op_user_data = op_user_data;
722 g_file_read_async (gfile, G_PRIORITY_DEFAULT, cancellable,
723 file_read_async_cb, tp_file);
727 * empathy_tp_file_is_incoming:
728 * @tp_file: an #EmpathyTpFile
730 * Returns whether @tp_file is incoming.
732 * Return value: %TRUE if the @tp_file is incoming, otherwise %FALSE
735 empathy_tp_file_is_incoming (EmpathyTpFile *tp_file)
737 EmpathyTpFilePriv *priv;
739 g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
741 priv = GET_PRIV (tp_file);
743 return priv->incoming;
747 empathy_tp_file_cancel (EmpathyTpFile *tp_file)
749 close_channel_internal (tp_file, TRUE);
753 * empathy_tp_file_is_ready:
754 * @tp_file: an #EmpathyTpFile
756 * Returns whether the file channel @tp_file is ready for use.
758 * @tp_file is classed as ready if its state is no longer
759 * %TP_FILE_TRANSFER_STATE_NONE, or if details about the remote
760 * contact have been fully received.
762 * Return value: %TRUE if @tp_file is ready for use
765 empathy_tp_file_is_ready (EmpathyTpFile *tp_file)
767 close_channel_internal (tp_file, FALSE);