path: root/libempathy/empathy-tp-file.c

/*
 * Copyright (C) 2007-2009 Collabora Ltd.
 * Copyright (C) 2007 Marco Barisione <marco@barisione.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Authors: Marco Barisione <marco@barisione.org>
 *          Jonny Lamb <jonny.lamb@collabora.co.uk>
 *          Cosimo Cecchi <cosimo.cecchi@collabora.co.uk>
 */

#include <config.h>

#include <string.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>

#include <glib/gi18n-lib.h>

#include <gio/gio.h>
#include <gio/gunixinputstream.h>
#include <gio/gunixoutputstream.h>

#include <telepathy-glib/proxy-subclass.h>
#include <telepathy-glib/util.h>

#include "empathy-tp-file.h"
#include "empathy-tp-contact-factory.h"
#include "empathy-marshal.h"
#include "empathy-time.h"
#include "empathy-utils.h"

#include "extensions/extensions.h"

#define DEBUG_FLAG EMPATHY_DEBUG_FT
#include "empathy-debug.h"

/**
 * SECTION:empathy-tp-file
 * @title: EmpathyTpFile
 * @short_description: Object which represents a Telepathy file channel
 * @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.
 */

/* EmpathyTpFile object */

struct _EmpathyTpFilePriv {
  EmpathyContactFactory *factory;
  TpChannel *channel;
  gboolean ready;

  GInputStream *in_stream;
  GOutputStream *out_stream;

  /* org.freedesktop.Telepathy.Channel.Type.FileTransfer D-Bus properties */
  EmpFileTransferState state;
  EmpFileTransferStateChangeReason state_change_reason;

  /* transfer properties */
  gboolean incoming;
  time_t start_time;
  gchar *unix_socket_path;

  /* GCancellable we're passed when offering/accepting the transfer */
  GCancellable *cancellable;

  /* callbacks for the operation */
  EmpathyTpFileProgressCallback progress_callback;
  gpointer progress_user_data;
  EmpathyTpFileOperationCallback op_callback,
  gpointer op_user_data;
};

enum {
  PROP_0,
  PROP_CHANNEL,
  PROP_STATE
};

#define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyTpFile)

G_DEFINE_TYPE (EmpathyTpFile, empathy_tp_file, G_TYPE_OBJECT);

static void
empathy_tp_file_init (EmpathyTpFile *tp_file)
{
  EmpathyTpFilePriv *priv;

  priv = G_TYPE_INSTANCE_GET_PRIVATE ((tp_file),
      EMPATHY_TYPE_TP_FILE, EmpathyTpFilePriv);

  tp_file->priv = priv;
}

static void
tp_file_invalidated_cb (TpProxy       *proxy,
            guint          domain,
            gint           code,
            gchar         *message,
            EmpathyTpFile *tp_file)
{
  EmpathyTpFilePriv *priv = GET_PRIV (tp_file);

  DEBUG ("Channel invalidated: %s", message);

  if (priv->state != EMP_FILE_TRANSFER_STATE_COMPLETED &&
      priv->state != EMP_FILE_TRANSFER_STATE_CANCELLED)
    {
      /* The channel is not in a finished state, an error occured */
      priv->state = EMP_FILE_TRANSFER_STATE_CANCELLED;
      priv->state_change_reason =
          EMP_FILE_TRANSFER_STATE_CHANGE_REASON_LOCAL_ERROR;
      g_object_notify (G_OBJECT (tp_file), "state");
    }
}

static void
tp_file_finalize (GObject *object)
{
  EmpathyTpFilePriv *priv = GET_PRIV (object);

  if (priv->channel)
    {
      g_signal_handlers_disconnect_by_func (priv->channel,
          tp_file_invalidated_cb, object);
      g_object_unref (priv->channel);
      priv->channel = NULL;
    }

  if (priv->factory)
    {
      g_object_unref (priv->factory);
    }

  g_free (priv->filename);
  g_free (priv->unix_socket_path);
  g_free (priv->description);
  g_free (priv->content_hash);
  g_free (priv->content_type);

  if (priv->in_stream)
    g_object_unref (priv->in_stream);

  if (priv->out_stream)
    g_object_unref (priv->out_stream);

  if (priv->cancellable)
    g_object_unref (priv->cancellable);

  if (tp_file->priv->stalled_id != 0)
    g_source_remove (tp_file->priv->stalled_id);

  G_OBJECT_CLASS (empathy_tp_file_parent_class)->finalize (object);
}

static gboolean
tp_file_stalled_cb (EmpathyTpFile *tp_file)
{
  /* We didn't get transferred bytes update for a while, the transfer is
   * stalled. */

  tp_file->priv->speed = 0;
  tp_file->priv->remaining_time = -1;
  g_signal_emit (tp_file, signals[REFRESH], 0);

  return FALSE;
}

static void
tp_file_get_property (GObject *object,
                      guint param_id,
                      GValue *value,
                      GParamSpec *pspec)
{
  EmpathyTpFilePriv = GET_PRIV (object);

  switch (param_id)
    {
      case PROP_CHANNEL:
        g_value_set_object (value, priv->channel);
        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
tp_file_set_property (GObject *object,
                      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_STATE:
        priv->state = g_value_get_uint (value);
        break;
      default:
        G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
        break;
    };
}

static void
tp_file_get_state_cb (TpProxy *proxy,
                      const GValue *value,
                      const GError *error,
                      gpointer user_data,
                      GObject *weak_object)
{
  EmpathyTpFilePriv *priv = GET_PRIV (weak_object);

  if (error)
    {
      /* set a default value for the state */
      priv->state = EMP_FILE_TRANSFER_STATE_NONE;
      return;
    }

  priv->state = g_value_get_uint (value);
}

static GObject *
tp_file_constructor (GType type,
                     guint n_props,
                     GObjectConstructParam *props)
{
  GObject *file_obj;
  EmpathyTpFile *tp_file;
  EmpathyTpFilePriv *priv;
  TpHandle handle;
  GHashTable *properties;
  McAccount *account;

  file_obj = G_OBJECT_CLASS (empathy_tp_file_parent_class)->constructor (type,
      n_props, props);
  
  tp_file = EMPATHY_TP_FILE (file_obj);
  priv = GET_PRIV (tp_file);

  priv->factory = empathy_contact_factory_dup_singleton ();

  g_signal_connect (priv->channel, "invalidated",
    G_CALLBACK (tp_file_invalidated_cb), tp_file);

  emp_cli_channel_type_file_transfer_connect_to_file_transfer_state_changed (
      TP_PROXY (priv->channel), tp_file_state_changed_cb, NULL, NULL,
      G_OBJECT (tp_file), NULL);

  emp_cli_channel_type_file_transfer_connect_to_transferred_bytes_changed (
      TP_PROXY (priv->channel), tp_file_transferred_bytes_changed_cb,
      NULL, NULL, G_OBJECT (tp_file), NULL);

  account = empathy_channel_get_account (priv->channel);

  handle = tp_channel_get_handle (priv->channel, NULL);
  priv->contact = empathy_contact_factory_get_from_handle (
      priv->factory, account, (guint) handle);

  tp_cli_dbus_properties_call_get (priv->channel,
      -1, EMP_IFACE_CHANNEL_TYPE_FILE_TRANSFER, "State", tp_file_get_state_cb,
      NULL, NULL, file_obj);

  priv->state_change_reason =
      EMP_FILE_TRANSFER_STATE_CHANGE_REASON_NONE;

  g_object_unref (account);

  return file_obj;
}

static void
empathy_tp_file_class_init (EmpathyTpFileClass *klass)
{
  GObjectClass *object_class = G_OBJECT_CLASS (klass);

  object_class->finalize = tp_file_finalize;
  object_class->constructor = tp_file_constructor;
  object_class->get_property = tp_file_get_property;
  object_class->set_property = tp_file_set_property;

  /* Construct-only properties */
  g_object_class_install_property (object_class,
      PROP_CHANNEL,
      g_param_spec_object ("channel",
          "telepathy channel",
          "The file transfer channel",
          TP_TYPE_CHANNEL,
          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));
}

static void
ft_operation_close_clean (EmpathyTpFile *tp_file)
{
  EmpathyTpFilePriv *priv = GET_PRIV (tp_file);

  if (priv->op_callback)
    priv->op_callback (tp_file, NULL, priv->op_user_data);
}

static void
ft_operation_close_with_error (EmpathyTpFile *tp_file,
                               GError *error)
{
  EmpathyTpFilePriv *priv = GET_PRIV (tp_file);

  if (priv->op_callback)
    priv->op_callback (tp_file, error, priv->op_user_data);
}

static void
tp_file_state_changed_cb (TpProxy *proxy,
                          guint state,
                          guint reason,
                          gpointer user_data,
                          GObject *weak_object)
{
  EmpathyTpFilePriv *priv = GET_PRIV (weak_object);

  if (state == priv->state)
    return;

  DEBUG ("File transfer state changed:\n"
      "\tfilename = %s, old state = %u, state = %u, reason = %u\n"
      "\tincoming = %s, in_stream = %s, out_stream = %s",
      priv->filename, priv->state, state, reason,
      priv->incoming ? "yes" : "no",
      priv->in_stream ? "present" : "not present",
      priv->out_stream ? "present" : "not present");

  /* If the channel is open AND we have the socket path, we can start the
   * transfer. The socket path could be NULL if we are not doing the actual
   * data transfer but are just an observer for the channel.
   */
  if (state == EMP_FILE_TRANSFER_STATE_OPEN &&
      priv->unix_socket_path != NULL)
    tp_file_start_transfer (tp_file);

  priv->state = state;
  priv->state_change_reason = reason;

  g_object_notify (G_OBJECT (tp_file), "state");
}

static void
tp_file_transferred_bytes_changed_cb (TpProxy *proxy,
                                      guint64 count,
                                      gpointer user_data,
                                      GObject *weak_object)
{
  EmpathyTpFilePriv *priv = GET_PRIV (weak_object);

  if (priv->transferred_bytes == count)
    return;

  priv->transferred_bytes = count;

  /* notify clients */
  if (priv->progress_callback)
    {
      priv->progress_callback (EMPATHY_TP_FILE (weak_object),
          priv->transferred_bytes, priv->size, priv->progress_user_data);
    }
}

static void
splice_stream_ready_cb (GObject *source,
                        GAsyncResult *res,
                        gpointer user_data)
{
  EmpathyTpFile *tp_file;
  GError *error = NULL;

  tp_file = user_data;

  g_output_stream_splice_finish (G_OUTPUT_STREAM (source), res, &error);

  if (error != NULL)
    {
      ft_operation_close_with_error (tp_file, error);
      g_clear_error (&error);
      return;
    }

  ft_operation_close_clean (tp_file);
}

static void
tp_file_start_transfer (EmpathyTpFile *tp_file)
{
  gint fd;
  size_t path_len;
  struct sockaddr_un addr;
  GError *error = NULL;
  EmpathyTpFilePriv *priv = GET_PRIV (tp_file);

  fd = socket (PF_UNIX, SOCK_STREAM, 0);
  if (fd < 0)
    {
      int code = errno;

      error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
          EMPATHY_FT_ERROR_SOCKET, g_strerror (code));

      DEBUG ("Failed to create socket, closing channel");

      ft_operation_close_with_error (tp_file, error);
      g_clear_error (&error);

      return;
    }

  memset (&addr, 0, sizeof (addr));
  addr.sun_family = AF_UNIX;
  path_len = strlen (priv->unix_socket_path);
  strncpy (addr.sun_path, priv->unix_socket_path, path_len);

  if (connect (fd, (struct sockaddr*) &addr, sizeof (addr)) < 0)
    {
      int code = errno;

      error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
          EMPATHY_FT_ERROR_SOCKET, g_strerror (code));

      DEBUG ("Failed to connect socket, closing channel");

      ft_operation_close_with_error (tp_file, error);
      close (fd);
      g_clear_error (&error);

      return;
    }

  DEBUG ("Start the transfer");

  priv->start_time = empathy_time_get_current ();

  /* notify we're starting a transfer */
  if (priv->progress_callback)
    priv->progress_callback (tp_file, 0, priv->size,
        priv->progress_callback_user_data);

  if (priv->incoming)
    {
      GInputStream *socket_stream;

      socket_stream = g_unix_input_stream_new (fd, TRUE);

      g_output_stream_splice_async (priv->out_stream, socket_stream,
          G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE |
          G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
          G_PRIORITY_DEFAULT, priv->cancellable,
          splice_stream_ready_cb, tp_file);

      g_object_unref (socket_stream);
    }
  else
    {
      GOutputStream *socket_stream;

      socket_stream = g_unix_output_stream_new (fd, TRUE);

      g_output_stream_splice_async (socket_stream, priv->in_stream,
          G_OUTPUT_STREAM_SPLICE_CLOSE_SOURCE |
          G_OUTPUT_STREAM_SPLICE_CLOSE_TARGET,
          G_PRIORITY_DEFAULT, priv->cancellable,
          splice_stream_ready_cb, tp_file);

      g_object_unref (socket_stream);
    }
}

static void
ft_operation_provide_or_accept_file_cb (TpProxy *proxy,
                                        const GValue *address,
                                        const GError *error,
                                        gpointer user_data,
                                        GObject *weak_object)
{
  EmpathyTpFile *tp_file = EMPATHY_TP_FILE (weak_object);
  GError *myerr = NULL;
  EmpathyTpFilePriv *priv = GET_PRIV (tp_file);

  g_cancellable_set_error_if_cancelled (priv->cancellable, &myerr);

  if (error)
    {
      if (myerr)
        {
          /* if we were both cancelled and failed when calling the method,
          * report the method error.
          */
          g_clear_error (&myerr);
          myerr = g_error_copy (error);
        }
    }

  if (myerr)
    {
      DEBUG ("Error: %s", error->message);
      ft_operation_close_with_error (tp_file, myerr);
      g_clear_error (&myerr);
      return;
    }

  priv->unix_socket_path = g_value_dup_string (address);

  DEBUG ("Got unix socket path: %s", priv->unix_socket_path);

  if (priv->state == EMP_FILE_TRANSFER_STATE_OPEN)
    tp_file_start_transfer (tp_file);
}

static void
file_read_async_cb (GObject *source,
                    GAsyncResult *res,
                    gpointer user_data)
{
  GValue nothing = { 0 };
  EmpathyTpFile *tp_file = user_data;
  EmpathyTpFilePriv *priv;
  GFileInputStream *in_stream;
  GError *error = NULL;

  priv = GET_PRIV (tp_file);

  in_stream = g_file_read_finish (G_FILE (source), res, &error);

  if (error != NULL)
    {
      ft_operation_close_with_error (tp_file, error);
      g_clear_error (&error);
      return;
    }

  priv->in_stream = G_INPUT_STREAM (in_stream);

  g_value_init (&nothing, G_TYPE_STRING);
  g_value_set_static_string (&nothing, "");

  emp_cli_channel_type_file_transfer_call_provide_file (
      TP_PROXY (tp_file->priv->channel), -1,
      TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
      &nothing, 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)
{
  GValue nothing = { 0 };
  EmpathyTpFile *tp_file = user_data;
  EmpathyTpFilePriv *priv;
  GError *error = NULL;
  GFileOutputStream *out_stream;

  priv = GET_PRIV (tp_file);

  out_stream = g_file_replace_finish (G_FILE (source), res, &error);

  if (error != NULL)
    {
      ft_operation_close_with_error (tp_file, error);
      g_clear_error (&error);

      return;
    }

  priv->out_stream = out_stream;

  priv->filename = g_file_get_basename (gfile);
  g_object_notify (G_OBJECT (tp_file), "filename");

  DEBUG ("Accepting file: filename=%s", tp_file->priv->filename);

  g_value_init (&nothing, G_TYPE_STRING);
  g_value_set_static_string (&nothing, "");

  emp_cli_channel_type_file_transfer_call_accept_file (TP_PROXY (priv->channel),
      -1, TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
      &nothing, offset, ft_operation_provide_or_accept_file_cb, NULL, NULL,
      G_OBJECT (tp_file));
}


/* public methods */

/**
 * empathy_tp_file_new:
 * @channel: a #TpChannel
 *
 * 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.
 *
 * Return value: a new #EmpathyTpFile
 */
EmpathyTpFile *
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,
      NULL);

  return tp_file;
}

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)
{
  EmpathyTpFilePriv *priv = GET_PRIV (tp_file);

  g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
  g_return_if_fail (G_IS_FILE (gfile));
  g_return_if_fail (G_IS_CANCELLABLE (cancellable));

  priv->cancellable = g_object_ref (cancellable);
  priv->progress_callback = progress_callback;
  priv->progress_user_data = progress_user_data;
  priv->op_callback = op_callback;
  priv->op_user_data = op_user_data;
  priv->incoming = TRUE;

  g_file_replace_async (file, G_PRIORITY_DEFAULT, cancellable,
      file_replace_async_cb, tp_file);
}

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)
{
  EmpathyTpFilePriv *priv = GET_PRIV (tp_file);

  g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
  g_return_if_fail (G_IS_FILE (gfile));
  g_return_if_fail (G_IS_CANCELLABLE (cancellable));

  priv->cancellable = g_object_ref (cancellable);
  priv->progress_callback = progress_callback;
  priv->progress_user_data = progress_user_data;
  priv->op_callback = op_callback;
  priv->op_user_data = op_user_data;
  priv->incoming = FALSE;

  g_file_read_async (file, G_PRIORITY_DEFAULT, cancellable,
      file_read_async_cb, tp_file);
}

/**
 * empathy_tp_file_is_incoming:
 * @tp_file: an #EmpathyTpFile
 *
 * Returns whether @tp_file is incoming.
 *
 * Return value: %TRUE if the @tp_file is incoming, otherwise %FALSE
 */
gboolean
empathy_tp_file_is_incoming (EmpathyTpFile *tp_file)
{
  g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
  return tp_file->priv->incoming;
}

/**
 * empathy_tp_file_get_state:
 * @tp_file: an #EmpathyTpFile
 * @reason: return location for state change reason, or %NULL
 *
 * Gets the current state of @tp_file. If @reason is not %NULL, then
 * it is set to the reason of the last state change.
 *
 * Return value: a #TpFileTransferState
 */
TpFileTransferState
empathy_tp_file_get_state (EmpathyTpFile *tp_file,
                           TpFileTransferStateChangeReason *reason)
{
  EmpathyTpFilePriv *priv = GET_PRIV (tp_file);

  g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file),
      TP_FILE_TRANSFER_STATE_NONE);

  if (reason != NULL)
    *reason = priv->state_change_reason;

  return priv->state;
}

/**
 * empathy_tp_file_cancel:
 * @tp_file: an #EmpathyTpFile
 *
 * Cancels the file transfer, @tp_file.
 */
void
empathy_tp_file_cancel (EmpathyTpFile *tp_file)
{
  g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));

  DEBUG ("Closing channel..");
  tp_cli_channel_call_close (tp_file->priv->channel, -1,
    NULL, NULL, NULL, NULL);

  if (tp_file->priv->cancellable != NULL)
    g_cancellable_cancel (tp_file->priv->cancellable);
}

/**
 * empathy_tp_file_is_ready:
 * @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
 */
gboolean
empathy_tp_file_is_ready (EmpathyTpFile *tp_file)
{
  g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);

  return tp_file->priv->ready;
}