* @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 */
EmpathyTpFileOperationCallback op_callback;
gpointer op_user_data;
+ gboolean is_closed;
+
gboolean dispose_run;
} EmpathyTpFilePriv;
enum {
PROP_0,
PROP_CHANNEL,
- PROP_INCOMING,
- PROP_STATE
+ PROP_INCOMING
};
#define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyTpFile)
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;
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);
priv->state = TP_FILE_TRANSFER_STATE_CANCELLED;
priv->state_change_reason =
TP_FILE_TRANSFER_STATE_CHANGE_REASON_LOCAL_ERROR;
- g_object_notify (G_OBJECT (tp_file), "state");
}
}
{
EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
- DEBUG ("Splice close clean");
+ if (priv->is_closed)
+ return;
+
+ DEBUG ("FT operation close clean");
+
+ priv->is_closed = TRUE;
- if (priv->op_callback)
+ 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);
- DEBUG ("Splice close with error %s", error->message);
+ if (priv->is_closed)
+ return;
+
+ DEBUG ("FT operation close with error %s", error->message);
+
+ priv->is_closed = TRUE;
- if (priv->op_callback)
+ /* 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 != 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;
GError *error = NULL;
g_output_stream_splice_finish (G_OUTPUT_STREAM (source), res, &error);
+ DEBUG ("Splice stream ready cb, error %p", error);
+
if (error != NULL)
{
ft_operation_close_with_error (tp_file, error);
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)
}
}
+static GError *
+error_from_state_change_reason (TpFileTransferStateChangeReason reason)
+{
+ const char *string;
+ GError *retval = NULL;
+
+ string = NULL;
+
+ switch (reason)
+ {
+ case TP_FILE_TRANSFER_STATE_CHANGE_REASON_NONE:
+ string = _("No reason was specified");
+ break;
+ case TP_FILE_TRANSFER_STATE_CHANGE_REASON_REQUESTED:
+ string = _("The change in state was requested");
+ break;
+ case TP_FILE_TRANSFER_STATE_CHANGE_REASON_LOCAL_STOPPED:
+ string = _("You canceled the file transfer");
+ break;
+ case TP_FILE_TRANSFER_STATE_CHANGE_REASON_REMOTE_STOPPED:
+ string = _("The other participant canceled the file transfer");
+ break;
+ case TP_FILE_TRANSFER_STATE_CHANGE_REASON_LOCAL_ERROR:
+ string = _("Error while trying to transfer the file");
+ break;
+ case TP_FILE_TRANSFER_STATE_CHANGE_REASON_REMOTE_ERROR:
+ string = _("The other participant is unable to transfer the file");
+ break;
+ default:
+ string = _("Unknown reason");
+ break;
+ }
+
+ retval = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
+ EMPATHY_FT_ERROR_TP_ERROR, string);
+
+ return retval;
+}
+
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 = NULL;
if (state == priv->state)
return;
if (state == TP_FILE_TRANSFER_STATE_COMPLETED)
ft_operation_close_clean (EMPATHY_TP_FILE (weak_object));
- g_object_notify (weak_object, "state");
+ if (state == TP_FILE_TRANSFER_STATE_CANCELLED)
+ {
+ 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);
+ /* don't notify for 0 bytes count */
+ if (count == 0)
+ 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.
}
}
- if (myerr)
+ if (myerr != NULL)
{
DEBUG ("Error: %s", error->message);
ft_operation_close_with_error (tp_file, myerr);
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;
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));
+ ¬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;
ft_operation_provide_or_accept_file_cb, NULL, NULL, G_OBJECT (tp_file));
}
+static void
+channel_closed_cb (TpChannel *proxy,
+ const GError *error,
+ gpointer user_data,
+ GObject *weak_object)
+{
+ EmpathyTpFile *tp_file = EMPATHY_TP_FILE (weak_object);
+ EmpathyTpFilePriv *priv = GET_PRIV (tp_file);
+ gboolean cancel = GPOINTER_TO_INT (user_data);
+
+ 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");
+
+ 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);
{
EmpathyTpFilePriv *priv = GET_PRIV (object);
- g_free (priv->unix_socket_path);
+ DEBUG ("%p", object);
+
+ if (priv->unix_socket_path != NULL)
+ {
+ g_array_free (priv->unix_socket_path, TRUE);
+ priv->unix_socket_path = 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);
case PROP_INCOMING:
g_value_set_boolean (value, priv->incoming);
break;
- case PROP_STATE:
- g_value_set_uint (value, priv->state);
- break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
break;
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_INCOMING:
priv->incoming = g_value_get_boolean (value);
break;
- case PROP_STATE:
- priv->state = g_value_get_uint (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);
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);
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",
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY));
- g_object_class_install_property (object_class,
- PROP_STATE,
- g_param_spec_uint ("state",
- "state of the transfer",
- "The file transfer state",
- 0,
- G_MAXUINT,
- G_MAXUINT,
- G_PARAM_READWRITE |
- G_PARAM_CONSTRUCT));
-
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, with the direction
+ * specified by @incoming. 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,
+ gboolean incoming)
{
EmpathyTpFile *tp_file;
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)
{
- EmpathyTpFilePriv *priv;
-
g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
-
- priv = GET_PRIV (tp_file);
-
- DEBUG ("Closing channel..");
- tp_cli_channel_call_close (priv->channel, -1,
- NULL, NULL, NULL, NULL);
- if (priv->cancellable != NULL &&
- !g_cancellable_is_cancelled (priv->cancellable))
- g_cancellable_cancel (priv->cancellable);
+ 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_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
+ g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
- return tp_file->priv->ready;
+ close_channel_internal (tp_file, FALSE);
}
projects / empathy.git / blobdiff