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;
111 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyTpFile)
113 G_DEFINE_TYPE (EmpathyTpFile, empathy_tp_file, G_TYPE_OBJECT);
115 /* private functions */
118 tp_file_get_state_cb (TpProxy *proxy,
122 GObject *weak_object)
124 EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
128 /* set a default value for the state */
129 priv->state = TP_FILE_TRANSFER_STATE_NONE;
133 priv->state = g_value_get_uint (value);
137 tp_file_invalidated_cb (TpProxy *proxy,
141 EmpathyTpFile *tp_file)
143 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
145 DEBUG ("Channel invalidated: %s", message);
147 if (priv->state != TP_FILE_TRANSFER_STATE_COMPLETED &&
148 priv->state != TP_FILE_TRANSFER_STATE_CANCELLED)
150 /* The channel is not in a finished state, an error occured */
151 priv->state = TP_FILE_TRANSFER_STATE_CANCELLED;
152 priv->state_change_reason =
153 TP_FILE_TRANSFER_STATE_CHANGE_REASON_LOCAL_ERROR;
154 g_object_notify (G_OBJECT (tp_file), "state");
159 ft_operation_close_clean (EmpathyTpFile *tp_file)
161 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
163 DEBUG ("Splice close clean");
165 if (priv->op_callback)
166 priv->op_callback (tp_file, NULL, priv->op_user_data);
170 ft_operation_close_with_error (EmpathyTpFile *tp_file,
173 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
175 DEBUG ("Splice close with error %s", error->message);
177 if (priv->op_callback)
178 priv->op_callback (tp_file, error, priv->op_user_data);
182 splice_stream_ready_cb (GObject *source,
186 EmpathyTpFile *tp_file;
187 GError *error = NULL;
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));
318 g_object_notify (weak_object, "state");
322 tp_file_transferred_bytes_changed_cb (TpChannel *proxy,
325 GObject *weak_object)
327 EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
330 if (priv->progress_callback)
331 priv->progress_callback (EMPATHY_TP_FILE (weak_object),
332 count, priv->progress_user_data);
336 ft_operation_provide_or_accept_file_cb (TpChannel *proxy,
337 const GValue *address,
340 GObject *weak_object)
342 EmpathyTpFile *tp_file = EMPATHY_TP_FILE (weak_object);
343 GError *myerr = NULL;
344 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
346 g_cancellable_set_error_if_cancelled (priv->cancellable, &myerr);
352 /* if we were both cancelled and failed when calling the method,
353 * report the method error.
355 g_clear_error (&myerr);
356 myerr = g_error_copy (error);
362 DEBUG ("Error: %s", error->message);
363 ft_operation_close_with_error (tp_file, myerr);
364 g_clear_error (&myerr);
368 if (G_VALUE_TYPE (address) == DBUS_TYPE_G_UCHAR_ARRAY)
370 priv->unix_socket_path = g_value_dup_boxed (address);
372 else if (G_VALUE_TYPE (address) == G_TYPE_STRING)
374 /* Old bugged version of telepathy-salut used to store the address
375 * as a 's' instead of an 'ay' */
378 path = g_value_get_string (address);
379 priv->unix_socket_path = g_array_sized_new (TRUE, FALSE, sizeof (gchar),
381 g_array_insert_vals (priv->unix_socket_path, 0, path, strlen (path));
384 DEBUG ("Got unix socket path: %s", priv->unix_socket_path->data);
386 /* if the channel is already open, start the transfer now, otherwise,
387 * wait for the state change signal.
389 if (priv->state == TP_FILE_TRANSFER_STATE_OPEN)
390 tp_file_start_transfer (tp_file);
394 file_read_async_cb (GObject *source,
398 GValue nothing = { 0 };
399 EmpathyTpFile *tp_file = user_data;
400 EmpathyTpFilePriv *priv;
401 GFileInputStream *in_stream;
402 GError *error = NULL;
404 priv = GET_PRIV (tp_file);
406 in_stream = g_file_read_finish (G_FILE (source), res, &error);
410 ft_operation_close_with_error (tp_file, error);
411 g_clear_error (&error);
415 priv->in_stream = G_INPUT_STREAM (in_stream);
417 g_value_init (¬hing, G_TYPE_STRING);
418 g_value_set_static_string (¬hing, "");
420 tp_cli_channel_type_file_transfer_call_provide_file (
422 TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
423 ¬hing, ft_operation_provide_or_accept_file_cb, NULL, NULL, G_OBJECT (tp_file));
427 file_replace_async_cb (GObject *source,
431 GValue nothing = { 0 };
432 EmpathyTpFile *tp_file = user_data;
433 EmpathyTpFilePriv *priv;
434 GError *error = NULL;
435 GFileOutputStream *out_stream;
437 priv = GET_PRIV (tp_file);
439 out_stream = g_file_replace_finish (G_FILE (source), res, &error);
443 ft_operation_close_with_error (tp_file, error);
444 g_clear_error (&error);
449 priv->out_stream = G_OUTPUT_STREAM (out_stream);
451 g_value_init (¬hing, G_TYPE_STRING);
452 g_value_set_static_string (¬hing, "");
454 tp_cli_channel_type_file_transfer_call_accept_file (priv->channel,
455 -1, TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
456 ¬hing, priv->offset,
457 ft_operation_provide_or_accept_file_cb, NULL, NULL, G_OBJECT (tp_file));
460 /* GObject methods */
463 empathy_tp_file_init (EmpathyTpFile *tp_file)
465 EmpathyTpFilePriv *priv;
467 priv = G_TYPE_INSTANCE_GET_PRIVATE ((tp_file),
468 EMPATHY_TYPE_TP_FILE, EmpathyTpFilePriv);
470 tp_file->priv = priv;
474 do_dispose (GObject *object)
476 EmpathyTpFilePriv *priv = GET_PRIV (object);
478 if (priv->dispose_run)
481 priv->dispose_run = TRUE;
485 g_signal_handlers_disconnect_by_func (priv->channel,
486 tp_file_invalidated_cb, object);
487 g_object_unref (priv->channel);
488 priv->channel = NULL;
492 g_object_unref (priv->in_stream);
494 if (priv->out_stream)
495 g_object_unref (priv->out_stream);
497 if (priv->cancellable)
498 g_object_unref (priv->cancellable);
500 G_OBJECT_CLASS (empathy_tp_file_parent_class)->dispose (object);
504 do_finalize (GObject *object)
506 EmpathyTpFilePriv *priv = GET_PRIV (object);
508 g_free (priv->unix_socket_path);
510 G_OBJECT_CLASS (empathy_tp_file_parent_class)->finalize (object);
514 do_get_property (GObject *object,
519 EmpathyTpFilePriv *priv = GET_PRIV (object);
524 g_value_set_object (value, priv->channel);
527 g_value_set_boolean (value, priv->incoming);
530 g_value_set_uint (value, priv->state);
533 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
539 do_set_property (GObject *object,
544 EmpathyTpFilePriv *priv = GET_PRIV (object);
548 priv->channel = g_object_ref (g_value_get_object (value));
551 priv->incoming = g_value_get_boolean (value);
554 priv->state = g_value_get_uint (value);
557 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
563 do_constructor (GType type,
565 GObjectConstructParam *props)
568 EmpathyTpFile *tp_file;
569 EmpathyTpFilePriv *priv;
571 file_obj = G_OBJECT_CLASS (empathy_tp_file_parent_class)->constructor (type,
574 tp_file = EMPATHY_TP_FILE (file_obj);
575 priv = GET_PRIV (tp_file);
577 g_signal_connect (priv->channel, "invalidated",
578 G_CALLBACK (tp_file_invalidated_cb), tp_file);
580 tp_cli_channel_type_file_transfer_connect_to_file_transfer_state_changed (
581 priv->channel, tp_file_state_changed_cb, NULL, NULL,
582 G_OBJECT (tp_file), NULL);
584 tp_cli_channel_type_file_transfer_connect_to_transferred_bytes_changed (
585 priv->channel, tp_file_transferred_bytes_changed_cb,
586 NULL, NULL, G_OBJECT (tp_file), NULL);
588 tp_cli_dbus_properties_call_get (priv->channel,
589 -1, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER, "State", tp_file_get_state_cb,
590 NULL, NULL, file_obj);
592 priv->state_change_reason =
593 TP_FILE_TRANSFER_STATE_CHANGE_REASON_NONE;
599 empathy_tp_file_class_init (EmpathyTpFileClass *klass)
601 GObjectClass *object_class = G_OBJECT_CLASS (klass);
603 object_class->finalize = do_finalize;
604 object_class->dispose = do_dispose;
605 object_class->constructor = do_constructor;
606 object_class->get_property = do_get_property;
607 object_class->set_property = do_set_property;
609 /* Construct-only properties */
610 g_object_class_install_property (object_class,
612 g_param_spec_object ("channel",
614 "The file transfer channel",
617 G_PARAM_CONSTRUCT_ONLY));
619 g_object_class_install_property (object_class,
621 g_param_spec_boolean ("incoming",
622 "direction of transfer",
623 "The direction of the file being transferred",
626 G_PARAM_CONSTRUCT_ONLY));
628 g_object_class_install_property (object_class,
630 g_param_spec_uint ("state",
631 "state of the transfer",
632 "The file transfer state",
639 g_type_class_add_private (object_class, sizeof (EmpathyTpFilePriv));
645 * empathy_tp_file_new:
646 * @channel: a #TpChannel
648 * Creates a new #EmpathyTpFile wrapping @channel, or return a new ref to an
649 * existing #EmpathyTpFile for that channel. The returned #EmpathyTpFile
650 * should be unrefed with g_object_unref() when finished with.
652 * Return value: a new #EmpathyTpFile
655 empathy_tp_file_new (TpChannel *channel, gboolean incoming)
657 EmpathyTpFile *tp_file;
659 g_return_val_if_fail (TP_IS_CHANNEL (channel), NULL);
661 tp_file = g_object_new (EMPATHY_TYPE_TP_FILE,
662 "channel", channel, "incoming", incoming,
669 empathy_tp_file_accept (EmpathyTpFile *tp_file,
672 GCancellable *cancellable,
673 EmpathyTpFileProgressCallback progress_callback,
674 gpointer progress_user_data,
675 EmpathyTpFileOperationCallback op_callback,
676 gpointer op_user_data)
678 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
680 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
681 g_return_if_fail (G_IS_FILE (gfile));
682 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
684 priv->cancellable = g_object_ref (cancellable);
685 priv->progress_callback = progress_callback;
686 priv->progress_user_data = progress_user_data;
687 priv->op_callback = op_callback;
688 priv->op_user_data = op_user_data;
689 priv->offset = offset;
691 g_file_replace_async (gfile, NULL, FALSE, G_FILE_CREATE_NONE,
692 G_PRIORITY_DEFAULT, cancellable, file_replace_async_cb, tp_file);
696 empathy_tp_file_offer (EmpathyTpFile *tp_file,
698 GCancellable *cancellable,
699 EmpathyTpFileProgressCallback progress_callback,
700 gpointer progress_user_data,
701 EmpathyTpFileOperationCallback op_callback,
702 gpointer op_user_data)
704 EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
706 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
707 g_return_if_fail (G_IS_FILE (gfile));
708 g_return_if_fail (G_IS_CANCELLABLE (cancellable));
710 priv->cancellable = g_object_ref (cancellable);
711 priv->progress_callback = progress_callback;
712 priv->progress_user_data = progress_user_data;
713 priv->op_callback = op_callback;
714 priv->op_user_data = op_user_data;
716 g_file_read_async (gfile, G_PRIORITY_DEFAULT, cancellable,
717 file_read_async_cb, tp_file);
721 * empathy_tp_file_is_incoming:
722 * @tp_file: an #EmpathyTpFile
724 * Returns whether @tp_file is incoming.
726 * Return value: %TRUE if the @tp_file is incoming, otherwise %FALSE
729 empathy_tp_file_is_incoming (EmpathyTpFile *tp_file)
731 EmpathyTpFilePriv *priv;
733 g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
735 priv = GET_PRIV (tp_file);
737 return priv->incoming;
741 empathy_tp_file_cancel (EmpathyTpFile *tp_file)
743 EmpathyTpFilePriv *priv;
745 g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
747 priv = GET_PRIV (tp_file);
749 DEBUG ("Closing channel..");
750 tp_cli_channel_call_close (priv->channel, -1,
751 NULL, NULL, NULL, NULL);
753 if (priv->cancellable != NULL &&
754 !g_cancellable_is_cancelled (priv->cancellable))
755 g_cancellable_cancel (priv->cancellable);
759 * empathy_tp_file_is_ready:
760 * @tp_file: an #EmpathyTpFile
762 * Returns whether the file channel @tp_file is ready for use.
764 * @tp_file is classed as ready if its state is no longer
765 * %TP_FILE_TRANSFER_STATE_NONE, or if details about the remote
766 * contact have been fully received.
768 * Return value: %TRUE if @tp_file is ready for use
771 empathy_tp_file_is_ready (EmpathyTpFile *tp_file)
773 g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
775 return tp_file->priv->ready;