#include <string.h>
#include <unistd.h>
#include <errno.h>
+#include <arpa/inet.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
+#include <netinet/in.h>
#include <glib/gi18n-lib.h>
#include <gio/gunixinputstream.h>
#include <gio/gunixoutputstream.h>
+#include <telepathy-glib/gtypes.h>
#include <telepathy-glib/proxy-subclass.h>
#include <telepathy-glib/util.h>
+#include <telepathy-glib/interfaces.h>
#include "empathy-tp-file.h"
#include "empathy-marshal.h"
* @include: libempathy/empathy-tp-file.h
*
* #EmpathyTpFile is an object which represents a Telepathy file channel.
- */
-
-/**
- * EmpathyTpFile:
- * @parent: parent object
- *
- * Object which represents a Telepathy file channel.
- */
-
-/**
- * EMPATHY_TP_FILE_UNKNOWN_SIZE:
- *
- * Value used for the "size" or "estimated-size" properties when the size of
- * the transferred file is unknown.
+ * Usually, clients do not need to deal with #EmpathyTpFile objects directly,
+ * and are supposed to use #EmpathyFTHandler and #EmpathyFTFactory for
+ * transferring files using libempathy.
*/
/* EmpathyTpFile object */
typedef struct {
TpChannel *channel;
- gboolean ready;
GInputStream *in_stream;
GOutputStream *out_stream;
/* org.freedesktop.Telepathy.Channel.Type.FileTransfer D-Bus properties */
TpFileTransferState state;
TpFileTransferStateChangeReason state_change_reason;
+ TpSocketAddressType socket_address_type;
+ TpSocketAccessControl socket_access_control;
/* transfer properties */
gboolean incoming;
time_t start_time;
- GArray *unix_socket_path;
+ GArray *socket_address;
+ guint port;
guint64 offset;
/* GCancellable we're passed when offering/accepting the transfer */
EmpathyTpFileOperationCallback op_callback;
gpointer op_user_data;
+ gboolean is_closing;
+ gboolean is_closed;
+
gboolean dispose_run;
} EmpathyTpFilePriv;
static void
tp_file_get_state_cb (TpProxy *proxy,
- const GValue *value,
- const GError *error,
- gpointer user_data,
- GObject *weak_object)
+ const GValue *value,
+ const GError *error,
+ gpointer user_data,
+ GObject *weak_object)
{
EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
- if (error)
+ if (error != NULL)
{
/* set a default value for the state */
priv->state = TP_FILE_TRANSFER_STATE_NONE;
priv->state = g_value_get_uint (value);
}
+static void
+tp_file_get_available_socket_types_cb (TpProxy *proxy,
+ const GValue *value,
+ const GError *error,
+ gpointer user_data,
+ GObject *weak_object)
+{
+ EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
+ GHashTable *socket_types;
+ GArray *access_controls;
+
+ if (error != NULL ||
+ !G_VALUE_HOLDS (value, TP_HASH_TYPE_SUPPORTED_SOCKET_MAP))
+ {
+ /* set a default value */
+ priv->socket_address_type = TP_SOCKET_ADDRESS_TYPE_UNIX;
+ priv->socket_access_control = TP_SOCKET_ACCESS_CONTROL_LOCALHOST;
+ goto out;
+ }
+
+ socket_types = g_value_get_boxed (value);
+
+ /* here UNIX is preferred to IPV4 */
+ if ((access_controls = g_hash_table_lookup (socket_types,
+ GUINT_TO_POINTER (TP_SOCKET_ADDRESS_TYPE_UNIX))) != NULL)
+ {
+ priv->socket_address_type = TP_SOCKET_ADDRESS_TYPE_UNIX;
+ priv->socket_access_control = TP_SOCKET_ACCESS_CONTROL_LOCALHOST;
+ goto out;
+ }
+
+ if ((access_controls = g_hash_table_lookup (socket_types,
+ GUINT_TO_POINTER (TP_SOCKET_ADDRESS_TYPE_IPV4))) != NULL)
+ {
+ priv->socket_address_type = TP_SOCKET_ADDRESS_TYPE_IPV4;
+
+ /* TODO: we should prefer PORT over LOCALHOST when the CM will
+ * support it.
+ */
+
+ priv->socket_access_control = TP_SOCKET_ACCESS_CONTROL_LOCALHOST;
+ }
+
+out:
+ DEBUG ("Socket address type: %u, access control %u",
+ priv->socket_address_type, priv->socket_access_control);
+}
+
static void
tp_file_invalidated_cb (TpProxy *proxy,
- guint domain,
- gint code,
- gchar *message,
- EmpathyTpFile *tp_file)
+ guint domain,
+ gint code,
+ gchar *message,
+ EmpathyTpFile *tp_file)
{
EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
{
EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
+ if (priv->is_closed)
+ return;
+
DEBUG ("FT operation close clean");
- if (priv->op_callback)
+ priv->is_closed = TRUE;
+
+ if (priv->op_callback != NULL)
priv->op_callback (tp_file, NULL, priv->op_user_data);
}
static void
ft_operation_close_with_error (EmpathyTpFile *tp_file,
- GError *error)
+ GError *error)
{
EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
+ if (priv->is_closed)
+ return;
+
DEBUG ("FT operation close with error %s", error->message);
+ priv->is_closed = TRUE;
+
/* close the channel if it's not cancelled already */
if (priv->state != TP_FILE_TRANSFER_STATE_CANCELLED)
empathy_tp_file_cancel (tp_file);
- if (priv->op_callback)
+ if (priv->op_callback != NULL)
priv->op_callback (tp_file, error, priv->op_user_data);
}
static void
splice_stream_ready_cb (GObject *source,
- GAsyncResult *res,
- gpointer user_data)
+ GAsyncResult *res,
+ gpointer user_data)
{
EmpathyTpFile *tp_file;
+ EmpathyTpFilePriv *priv;
GError *error = NULL;
tp_file = user_data;
-
- DEBUG ("Splice stream ready cb");
+ priv = GET_PRIV (tp_file);
g_output_stream_splice_finish (G_OUTPUT_STREAM (source), res, &error);
- if (error != NULL)
+ DEBUG ("Splice stream ready cb, error %p", error);
+
+ if (error != NULL && !priv->is_closing)
{
ft_operation_close_with_error (tp_file, error);
g_clear_error (&error);
static void
tp_file_start_transfer (EmpathyTpFile *tp_file)
{
- gint fd;
- struct sockaddr_un addr;
+ gint fd, domain, res = 0;
GError *error = NULL;
+ struct sockaddr *my_addr = NULL;
+ size_t my_size = 0;
EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
- fd = socket (PF_UNIX, SOCK_STREAM, 0);
+ if (priv->socket_address_type == TP_SOCKET_ADDRESS_TYPE_UNIX)
+ {
+ domain = AF_UNIX;
+ }
+ else if (priv->socket_address_type == TP_SOCKET_ADDRESS_TYPE_IPV4)
+ {
+ domain = AF_INET;
+ }
+ else
+ {
+ error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
+ EMPATHY_FT_ERROR_NOT_SUPPORTED, _("Socket type not supported"));
+
+ DEBUG ("Socket not supported, closing channel");
+
+ ft_operation_close_with_error (tp_file, error);
+ g_clear_error (&error);
+
+ return;
+ }
+
+ fd = socket (domain, SOCK_STREAM, 0);
+
if (fd < 0)
{
int code = errno;
return;
}
- memset (&addr, 0, sizeof (addr));
- addr.sun_family = AF_UNIX;
- strncpy (addr.sun_path, priv->unix_socket_path->data,
- priv->unix_socket_path->len);
+ if (priv->socket_address_type == TP_SOCKET_ADDRESS_TYPE_UNIX)
+ {
+ struct sockaddr_un addr;
+
+ memset (&addr, 0, sizeof (addr));
+ addr.sun_family = domain;
+ strncpy (addr.sun_path, priv->socket_address->data,
+ priv->socket_address->len);
+
+ my_addr = (struct sockaddr *) &addr;
+ my_size = sizeof (addr);
+ }
+ else if (priv->socket_address_type == TP_SOCKET_ADDRESS_TYPE_IPV4)
+ {
+ struct sockaddr_in addr;
+
+ memset (&addr, 0, sizeof (addr));
+ addr.sin_family = domain;
+ inet_pton (AF_INET, priv->socket_address->data, &addr.sin_addr);
+ addr.sin_port = htons (priv->port);
+
+ my_addr = (struct sockaddr *) &addr;
+ my_size = sizeof (addr);
+ }
+
+ res = connect (fd, my_addr, my_size);
- if (connect (fd, (struct sockaddr*) &addr, sizeof (addr)) < 0)
+ if (res < 0)
{
int code = errno;
priv->start_time = empathy_time_get_current ();
/* notify we're starting a transfer */
- if (priv->progress_callback)
+ if (priv->progress_callback != NULL)
priv->progress_callback (tp_file, 0, priv->progress_user_data);
if (priv->incoming)
error_from_state_change_reason (TpFileTransferStateChangeReason reason)
{
const char *string;
- GError *retval;
+ GError *retval = NULL;
string = NULL;
static void
tp_file_state_changed_cb (TpChannel *proxy,
- guint state,
- guint reason,
- gpointer user_data,
- GObject *weak_object)
+ guint state,
+ guint reason,
+ gpointer user_data,
+ GObject *weak_object)
{
EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
- GError *error;
+ GError *error = NULL;
if (state == priv->state)
return;
* data transfer but are just an observer for the channel.
*/
if (state == TP_FILE_TRANSFER_STATE_OPEN &&
- priv->unix_socket_path != NULL)
+ priv->socket_address != NULL)
tp_file_start_transfer (EMPATHY_TP_FILE (weak_object));
if (state == TP_FILE_TRANSFER_STATE_COMPLETED)
{
error = error_from_state_change_reason (priv->state_change_reason);
ft_operation_close_with_error (EMPATHY_TP_FILE (weak_object), error);
+ g_clear_error (&error);
}
}
static void
tp_file_transferred_bytes_changed_cb (TpChannel *proxy,
- guint64 count,
- gpointer user_data,
- GObject *weak_object)
+ guint64 count,
+ gpointer user_data,
+ GObject *weak_object)
{
EmpathyTpFilePriv *priv = GET_PRIV (weak_object);
return;
/* notify clients */
- if (priv->progress_callback)
+ if (priv->progress_callback != NULL)
priv->progress_callback (EMPATHY_TP_FILE (weak_object),
count, priv->progress_user_data);
}
static void
ft_operation_provide_or_accept_file_cb (TpChannel *proxy,
- const GValue *address,
- const GError *error,
- gpointer user_data,
- GObject *weak_object)
+ const GValue *address,
+ const GError *error,
+ gpointer user_data,
+ GObject *weak_object)
{
EmpathyTpFile *tp_file = EMPATHY_TP_FILE (weak_object);
GError *myerr = NULL;
g_cancellable_set_error_if_cancelled (priv->cancellable, &myerr);
- if (error)
+ if (error != NULL)
{
- if (myerr)
+ if (myerr != NULL)
{
/* if we were both cancelled and failed when calling the method,
* report the method error.
*/
g_clear_error (&myerr);
- myerr = g_error_copy (error);
}
+
+ myerr = g_error_copy (error);
}
- if (myerr)
+ if (myerr != NULL)
{
- DEBUG ("Error: %s", error->message);
+ DEBUG ("Error: %s", myerr->message);
ft_operation_close_with_error (tp_file, myerr);
g_clear_error (&myerr);
return;
if (G_VALUE_TYPE (address) == DBUS_TYPE_G_UCHAR_ARRAY)
{
- priv->unix_socket_path = g_value_dup_boxed (address);
+ priv->socket_address = g_value_dup_boxed (address);
}
else if (G_VALUE_TYPE (address) == G_TYPE_STRING)
{
const gchar *path;
path = g_value_get_string (address);
- priv->unix_socket_path = g_array_sized_new (TRUE, FALSE, sizeof (gchar),
- strlen (path));
- g_array_insert_vals (priv->unix_socket_path, 0, path, strlen (path));
+ priv->socket_address = g_array_sized_new (TRUE, FALSE, sizeof (gchar),
+ strlen (path));
+ g_array_insert_vals (priv->socket_address, 0, path, strlen (path));
+ }
+ else if (G_VALUE_TYPE (address) == TP_STRUCT_TYPE_SOCKET_ADDRESS_IPV4)
+ {
+ GValueArray *val_array;
+ GValue *v;
+ const char *addr;
+
+ val_array = g_value_get_boxed (address);
+
+ /* IPV4 address */
+ v = g_value_array_get_nth (val_array, 0);
+ addr = g_value_get_string (v);
+ priv->socket_address = g_array_sized_new (TRUE, FALSE, sizeof (gchar),
+ strlen (addr));
+ g_array_insert_vals (priv->socket_address, 0, addr, strlen (addr));
+
+ /* port number */
+ v = g_value_array_get_nth (val_array, 1);
+ priv->port = g_value_get_uint (v);
}
- DEBUG ("Got unix socket path: %s", priv->unix_socket_path->data);
+ DEBUG ("Got socket address: %s, port (not zero if IPV4): %d",
+ priv->socket_address->data, priv->port);
/* if the channel is already open, start the transfer now, otherwise,
* wait for the state change signal.
tp_file_start_transfer (tp_file);
}
+static void
+initialize_empty_ac_variant (TpSocketAccessControl ac,
+ GValue *val)
+{
+ /* TODO: we will add more types here once we support PORT access control. */
+ if (ac == TP_SOCKET_ACCESS_CONTROL_LOCALHOST)
+ {
+ g_value_init (val, G_TYPE_STRING);
+ g_value_set_static_string (val, "");
+ }
+}
+
static void
file_read_async_cb (GObject *source,
- GAsyncResult *res,
- gpointer user_data)
+ GAsyncResult *res,
+ gpointer user_data)
{
GValue nothing = { 0 };
EmpathyTpFile *tp_file = user_data;
in_stream = g_file_read_finish (G_FILE (source), res, &error);
- if (error != NULL)
+ if (error != NULL && !priv->is_closing)
{
ft_operation_close_with_error (tp_file, error);
g_clear_error (&error);
priv->in_stream = G_INPUT_STREAM (in_stream);
- g_value_init (¬hing, G_TYPE_STRING);
- g_value_set_static_string (¬hing, "");
+ /* we don't impose specific interface/port requirements even
+ * if we're not using UNIX sockets.
+ */
+ initialize_empty_ac_variant (priv->socket_access_control, ¬hing);
tp_cli_channel_type_file_transfer_call_provide_file (
priv->channel, -1,
- TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
- ¬hing, ft_operation_provide_or_accept_file_cb, NULL, NULL, G_OBJECT (tp_file));
+ priv->socket_address_type, priv->socket_access_control,
+ ¬hing, ft_operation_provide_or_accept_file_cb,
+ NULL, NULL, G_OBJECT (tp_file));
}
static void
file_replace_async_cb (GObject *source,
- GAsyncResult *res,
- gpointer user_data)
+ GAsyncResult *res,
+ gpointer user_data)
{
GValue nothing = { 0 };
EmpathyTpFile *tp_file = user_data;
priv->out_stream = G_OUTPUT_STREAM (out_stream);
- g_value_init (¬hing, G_TYPE_STRING);
- g_value_set_static_string (¬hing, "");
+ /* we don't impose specific interface/port requirements even
+ * if we're not using UNIX sockets.
+ */
+ initialize_empty_ac_variant (priv->socket_access_control, ¬hing);
tp_cli_channel_type_file_transfer_call_accept_file (priv->channel,
- -1, TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
+ -1, priv->socket_address_type, priv->socket_access_control,
¬hing, priv->offset,
ft_operation_provide_or_accept_file_cb, NULL, NULL, G_OBJECT (tp_file));
}
static void
-close_channel_internal (EmpathyTpFile *tp_file,
- gboolean cancel)
+channel_closed_cb (TpChannel *proxy,
+ const GError *error,
+ gpointer user_data,
+ GObject *weak_object)
{
- EmpathyTpFilePriv *priv;
-
- g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
-
- priv = GET_PRIV (tp_file);
+ EmpathyTpFile *tp_file = EMPATHY_TP_FILE (weak_object);
+ EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
+ gboolean cancel = GPOINTER_TO_INT (user_data);
- DEBUG ("Closing channel..");
- tp_cli_channel_call_close (priv->channel, -1,
- NULL, NULL, NULL, NULL);
+ DEBUG ("Channel is closed, should cancel %s", cancel ? "True" : "False");
if (priv->cancellable != NULL &&
!g_cancellable_is_cancelled (priv->cancellable) && cancel)
g_cancellable_cancel (priv->cancellable);
}
+static void
+close_channel_internal (EmpathyTpFile *tp_file,
+ gboolean cancel)
+{
+ EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
+
+ DEBUG ("Closing channel, should cancel %s", cancel ?
+ "True" : "False");
+
+ priv->is_closing = TRUE;
+
+ tp_cli_channel_call_close (priv->channel, -1,
+ channel_closed_cb, GINT_TO_POINTER (cancel), NULL, G_OBJECT (tp_file));
+}
+
/* GObject methods */
static void
priv->dispose_run = TRUE;
- if (priv->channel)
+ if (priv->channel != NULL)
{
g_signal_handlers_disconnect_by_func (priv->channel,
tp_file_invalidated_cb, object);
priv->channel = NULL;
}
- if (priv->in_stream)
+ if (priv->in_stream != NULL)
g_object_unref (priv->in_stream);
- if (priv->out_stream)
+ if (priv->out_stream != NULL)
g_object_unref (priv->out_stream);
- if (priv->cancellable)
+ if (priv->cancellable != NULL)
g_object_unref (priv->cancellable);
G_OBJECT_CLASS (empathy_tp_file_parent_class)->dispose (object);
DEBUG ("%p", object);
- if (priv->unix_socket_path != NULL)
+ if (priv->socket_address != NULL)
{
- g_array_free (priv->unix_socket_path, TRUE);
- priv->unix_socket_path = NULL;
+ g_array_free (priv->socket_address, TRUE);
+ priv->socket_address = NULL;
}
G_OBJECT_CLASS (empathy_tp_file_parent_class)->finalize (object);
static void
do_get_property (GObject *object,
- guint param_id,
- GValue *value,
- GParamSpec *pspec)
+ guint param_id,
+ GValue *value,
+ GParamSpec *pspec)
{
EmpathyTpFilePriv *priv = GET_PRIV (object);
static void
do_set_property (GObject *object,
- guint param_id,
- const GValue *value,
- GParamSpec *pspec)
+ guint param_id,
+ const GValue *value,
+ GParamSpec *pspec)
{
EmpathyTpFilePriv *priv = GET_PRIV (object);
switch (param_id)
case PROP_CHANNEL:
priv->channel = g_object_ref (g_value_get_object (value));
break;
- case PROP_INCOMING:
- priv->incoming = g_value_get_boolean (value);
- break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
break;
};
}
-static GObject *
-do_constructor (GType type,
- guint n_props,
- GObjectConstructParam *props)
+static void
+do_constructed (GObject *object)
{
- GObject *file_obj;
EmpathyTpFile *tp_file;
EmpathyTpFilePriv *priv;
- file_obj = G_OBJECT_CLASS (empathy_tp_file_parent_class)->constructor (type,
- n_props, props);
-
- tp_file = EMPATHY_TP_FILE (file_obj);
+ tp_file = EMPATHY_TP_FILE (object);
priv = GET_PRIV (tp_file);
g_signal_connect (priv->channel, "invalidated",
G_CALLBACK (tp_file_invalidated_cb), tp_file);
+ priv->incoming = !tp_channel_get_requested (priv->channel);
+
tp_cli_channel_type_file_transfer_connect_to_file_transfer_state_changed (
- priv->channel, tp_file_state_changed_cb, NULL, NULL,
- G_OBJECT (tp_file), NULL);
+ priv->channel, tp_file_state_changed_cb, NULL, NULL, object, NULL);
tp_cli_channel_type_file_transfer_connect_to_transferred_bytes_changed (
priv->channel, tp_file_transferred_bytes_changed_cb,
- NULL, NULL, G_OBJECT (tp_file), NULL);
+ NULL, NULL, object, NULL);
tp_cli_dbus_properties_call_get (priv->channel,
-1, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER, "State", tp_file_get_state_cb,
- NULL, NULL, file_obj);
+ NULL, NULL, object);
+
+ tp_cli_dbus_properties_call_get (priv->channel,
+ -1, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER, "AvailableSocketTypes",
+ tp_file_get_available_socket_types_cb, NULL, NULL, object);
priv->state_change_reason =
TP_FILE_TRANSFER_STATE_CHANGE_REASON_NONE;
-
- return file_obj;
}
static void
object_class->finalize = do_finalize;
object_class->dispose = do_dispose;
- object_class->constructor = do_constructor;
+ object_class->constructed = do_constructed;
object_class->get_property = do_get_property;
object_class->set_property = do_set_property;
/* Construct-only properties */
+
+ /**
+ * EmpathyTpFile:channel:
+ *
+ * The #TpChannel requested for the file transfer.
+ */
g_object_class_install_property (object_class,
PROP_CHANNEL,
g_param_spec_object ("channel",
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
+ /**
+ * EmpathyTpFile:incoming:
+ *
+ * %TRUE if the transfer is incoming, %FALSE if it's outgoing.
+ */
g_object_class_install_property (object_class,
PROP_INCOMING,
g_param_spec_boolean ("incoming",
"direction of transfer",
"The direction of the file being transferred",
FALSE,
- G_PARAM_READWRITE |
- G_PARAM_CONSTRUCT_ONLY));
+ G_PARAM_READABLE));
g_type_class_add_private (object_class, sizeof (EmpathyTpFilePriv));
}
/**
* empathy_tp_file_new:
* @channel: a #TpChannel
+ * @incoming: whether the file transfer is incoming or not
*
- * Creates a new #EmpathyTpFile wrapping @channel, or return a new ref to an
- * existing #EmpathyTpFile for that channel. The returned #EmpathyTpFile
- * should be unrefed with g_object_unref() when finished with.
+ * Creates a new #EmpathyTpFile wrapping @channel.
+ * The returned #EmpathyTpFile should be unrefed
+ * with g_object_unref() when finished with.
*
* Return value: a new #EmpathyTpFile
*/
EmpathyTpFile *
-empathy_tp_file_new (TpChannel *channel, gboolean incoming)
+empathy_tp_file_new (TpChannel *channel)
{
EmpathyTpFile *tp_file;
g_return_val_if_fail (TP_IS_CHANNEL (channel), NULL);
tp_file = g_object_new (EMPATHY_TYPE_TP_FILE,
- "channel", channel, "incoming", incoming,
+ "channel", channel,
NULL);
return tp_file;
}
+/**
+ * empathy_tp_file_accept:
+ * @tp_file: an incoming #EmpathyTpFile
+ * @offset: the offset of @gfile where we should start writing
+ * @gfile: the destination #GFile for the transfer
+ * @cancellable: a #GCancellable
+ * @progress_callback: function to callback with progress information
+ * @progress_user_data: user_data to pass to @progress_callback
+ * @op_callback: function to callback when the transfer ends
+ * @op_user_data: user_data to pass to @op_callback
+ *
+ * Accepts an incoming file transfer, saving the result into @gfile.
+ * The callback @op_callback will be called both when the transfer is
+ * successful and in case of an error. Note that cancelling @cancellable,
+ * closes the socket of the file operation in progress, but doesn't
+ * guarantee that the transfer channel will be closed as well. Thus,
+ * empathy_tp_file_cancel() or empathy_tp_file_close() should be used to
+ * actually cancel an ongoing #EmpathyTpFile.
+ */
void
empathy_tp_file_accept (EmpathyTpFile *tp_file,
- guint64 offset,
- GFile *gfile,
- GCancellable *cancellable,
- EmpathyTpFileProgressCallback progress_callback,
- gpointer progress_user_data,
- EmpathyTpFileOperationCallback op_callback,
- gpointer op_user_data)
+ guint64 offset,
+ GFile *gfile,
+ GCancellable *cancellable,
+ EmpathyTpFileProgressCallback progress_callback,
+ gpointer progress_user_data,
+ EmpathyTpFileOperationCallback op_callback,
+ gpointer op_user_data)
{
EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
G_PRIORITY_DEFAULT, cancellable, file_replace_async_cb, tp_file);
}
+
+/**
+ * empathy_tp_file_offer:
+ * @tp_file: an outgoing #EmpathyTpFile
+ * @gfile: the source #GFile for the transfer
+ * @cancellable: a #GCancellable
+ * @progress_callback: function to callback with progress information
+ * @progress_user_data: user_data to pass to @progress_callback
+ * @op_callback: function to callback when the transfer ends
+ * @op_user_data: user_data to pass to @op_callback
+ *
+ * Offers an outgoing file transfer, reading data from @gfile.
+ * The callback @op_callback will be called both when the transfer is
+ * successful and in case of an error. Note that cancelling @cancellable,
+ * closes the socket of the file operation in progress, but doesn't
+ * guarantee that the transfer channel will be closed as well. Thus,
+ * empathy_tp_file_cancel() or empathy_tp_file_close() should be used to
+ * actually cancel an ongoing #EmpathyTpFile.
+ */
void
empathy_tp_file_offer (EmpathyTpFile *tp_file,
- GFile *gfile,
- GCancellable *cancellable,
- EmpathyTpFileProgressCallback progress_callback,
- gpointer progress_user_data,
- EmpathyTpFileOperationCallback op_callback,
- gpointer op_user_data)
+ GFile *gfile,
+ GCancellable *cancellable,
+ EmpathyTpFileProgressCallback progress_callback,
+ gpointer progress_user_data,
+ EmpathyTpFileOperationCallback op_callback,
+ gpointer op_user_data)
{
EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
EmpathyTpFilePriv *priv;
g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
-
+
priv = GET_PRIV (tp_file);
return priv->incoming;
}
+/**
+ * empathy_tp_file_cancel:
+ * @tp_file: an #EmpathyTpFile
+ *
+ * Cancels an ongoing #EmpathyTpFile, first closing the channel and then
+ * cancelling any I/O operation and closing the socket.
+ */
void
empathy_tp_file_cancel (EmpathyTpFile *tp_file)
{
+ g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
+
close_channel_internal (tp_file, TRUE);
}
/**
- * empathy_tp_file_is_ready:
+ * empathy_tp_file_close:
* @tp_file: an #EmpathyTpFile
*
- * Returns whether the file channel @tp_file is ready for use.
- *
- * @tp_file is classed as ready if its state is no longer
- * %TP_FILE_TRANSFER_STATE_NONE, or if details about the remote
- * contact have been fully received.
- *
- * Return value: %TRUE if @tp_file is ready for use
+ * Closes the channel for an ongoing #EmpathyTpFile. It's safe to call this
+ * method after the transfer has ended.
*/
-gboolean
-empathy_tp_file_is_ready (EmpathyTpFile *tp_file)
+void
+empathy_tp_file_close (EmpathyTpFile *tp_file)
{
+ g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
+
close_channel_internal (tp_file, FALSE);
}
projects / empathy.git / blobdiff