libempathy/empathy-tp-file.c

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2007-2008 Collabora Ltd.
   4  * Copyright (C) 2007 Marco Barisione <marco@barisione.org>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * Authors: Marco Barisione <marco@barisione.org>
  21  *          Jonny Lamb <jonny.lamb@collabora.co.uk>
  22  */
  23
  24 #include <config.h>
  25
  26 #include <string.h>
  27 #include <unistd.h>
  28 #include <sys/types.h>
  29 #include <sys/socket.h>
  30 #include <sys/un.h>
  31
  32 #include <glib/gi18n-lib.h>
  33
  34 #include <gio/gio.h>
  35 #include <gio/gunixinputstream.h>
  36 #include <gio/gunixoutputstream.h>
  37
  38 #include <telepathy-glib/proxy-subclass.h>
  39
  40 #include "empathy-tp-file.h"
  41 #include "empathy-contact-factory.h"
  42 #include "empathy-marshal.h"
  43 #include "empathy-time.h"
  44 #include "empathy-utils.h"
  45
  46 #define DEBUG_FLAG EMPATHY_DEBUG_FT
  47 #include "empathy-debug.h"
  48
  49 /**
  50  * SECTION:empathy-tp-file
  51  * @short_description: File channel
  52  * @see_also: #EmpathyTpFile, #EmpathyContact, empathy_dispatcher_send_file()
  53  * @include: libempthy/empathy-tp-file.h
  54  *
  55  * The #EmpathyTpFile object represents a Telepathy file channel.
  56  */
  57
  58 /**
  59  * EMPATHY_TP_FILE_UNKNOWN_SIZE:
  60  *
  61  * Value used for the "size" or "estimated-size" properties when the size of
  62  * the transferred file is unknown.
  63  */
  64
  65 /* Functions to copy the content of a GInputStream to a GOutputStream */
  66
  67 #define N_BUFFERS 2
  68 #define BUFFER_SIZE 4096
  69
  70 typedef struct {
  71   GInputStream *in;
  72   GOutputStream *out;
  73   GCancellable  *cancellable;
  74   char *buff[N_BUFFERS]; /* the temporary buffers */
  75   gsize count[N_BUFFERS]; /* how many bytes are used in the buffers */
  76   gboolean is_full[N_BUFFERS]; /* whether the buffers contain data */
  77   gint curr_read; /* index of the buffer used for reading */
  78   gint curr_write; /* index of the buffer used for writing */
  79   gboolean is_reading; /* we are reading */
  80   gboolean is_writing; /* we are writing */
  81   guint n_closed; /* number of streams that have been closed */
  82   gint ref_count;
  83 } CopyData;
  84
  85 static void schedule_next (CopyData *copy);
  86
  87 static void
  88 copy_data_unref (CopyData *copy)
  89 {
  90   if (--copy->ref_count == 0)
  91     {
  92       gint i;
  93
  94       /* Free the data only if both the input and output streams have
  95        * been closed. */
  96       copy->n_closed++;
  97       if (copy->n_closed < 2)
  98         return;
  99
 100       if (copy->in != NULL)
 101         g_object_unref (copy->in);
 102
 103       if (copy->out != NULL)
 104         g_object_unref (copy->out);
 105
 106       for (i = 0; i < N_BUFFERS; i++)
 107         g_free (copy->buff[i]);
 108
 109       g_object_unref (copy->cancellable);
 110       g_free (copy);
 111     }
 112 }
 113
 114 static void
 115 io_error (CopyData *copy,
 116           GError *error)
 117 {
 118   g_cancellable_cancel (copy->cancellable);
 119
 120   if (error == NULL)
 121     g_warning ("I/O error");
 122   else if (error->domain == G_IO_ERROR && error->code == G_IO_ERROR_CANCELLED)
 123     ; /* Ignore cancellations */
 124   else
 125     g_warning ("I/O error: %d: %s\n", error->code, error->message);
 126
 127   if (copy->in != NULL)
 128     g_input_stream_close (copy->in, NULL, NULL);
 129
 130   if (copy->out != NULL)
 131     g_output_stream_close (copy->out, NULL, NULL);
 132
 133   copy_data_unref (copy);
 134 }
 135
 136 static void
 137 close_done (GObject *source_object,
 138             GAsyncResult *res,
 139             gpointer user_data)
 140 {
 141   CopyData *copy = user_data;
 142
 143   g_object_unref (source_object);
 144   copy_data_unref (copy);
 145 }
 146
 147 static void
 148 write_done_cb (GObject *source_object,
 149                GAsyncResult *res,
 150                gpointer user_data)
 151 {
 152   CopyData *copy = user_data;
 153   gssize count_write;
 154   GError *error = NULL;
 155
 156   count_write = g_output_stream_write_finish (copy->out, res, &error);
 157
 158   if (count_write <= 0)
 159     {
 160       io_error (copy, error);
 161       g_error_free (error);
 162       return;
 163     }
 164
 165   copy->is_full[copy->curr_write] = FALSE;
 166   copy->curr_write = (copy->curr_write + 1) % N_BUFFERS;
 167   copy->is_writing = FALSE;
 168
 169   schedule_next (copy);
 170 }
 171
 172 static void
 173 read_done_cb (GObject *source_object,
 174               GAsyncResult *res,
 175               gpointer user_data)
 176 {
 177   CopyData *copy = user_data;
 178   gssize count_read;
 179   GError *error = NULL;
 180
 181   count_read = g_input_stream_read_finish (copy->in, res, &error);
 182
 183   if (count_read == 0)
 184     {
 185       g_input_stream_close_async (copy->in, 0, copy->cancellable,
 186           close_done, copy);
 187       copy->in = NULL;
 188     }
 189   else if (count_read < 0)
 190     {
 191       io_error (copy, error);
 192       g_error_free (error);
 193       return;
 194     }
 195
 196   copy->count[copy->curr_read] = count_read;
 197   copy->is_full[copy->curr_read] = TRUE;
 198   copy->curr_read = (copy->curr_read + 1) % N_BUFFERS;
 199   copy->is_reading = FALSE;
 200
 201   schedule_next (copy);
 202 }
 203
 204 static void
 205 schedule_next (CopyData *copy)
 206 {
 207   if (copy->in != NULL &&
 208       !copy->is_reading &&
 209       !copy->is_full[copy->curr_read])
 210     {
 211       /* We are not reading and the current buffer is empty, so
 212        * start an async read. */
 213       copy->is_reading = TRUE;
 214       g_input_stream_read_async (copy->in,
 215           copy->buff[copy->curr_read],
 216           BUFFER_SIZE, 0, copy->cancellable,
 217           read_done_cb, copy);
 218     }
 219
 220   if (!copy->is_writing &&
 221       copy->is_full[copy->curr_write])
 222     {
 223       if (copy->count[copy->curr_write] == 0)
 224         {
 225           /* The last read on the buffer read 0 bytes, this
 226            * means that we got an EOF, so we can close
 227            * the output channel. */
 228           g_output_stream_close_async (copy->out, 0,
 229               copy->cancellable,
 230               close_done, copy);
 231       copy->out = NULL;
 232         }
 233       else
 234         {
 235           /* We are not writing and the current buffer contains
 236            * data, so start an async write. */
 237           copy->is_writing = TRUE;
 238           g_output_stream_write_async (copy->out,
 239               copy->buff[copy->curr_write],
 240               copy->count[copy->curr_write],
 241               0, copy->cancellable,
 242               write_done_cb, copy);
 243         }
 244     }
 245 }
 246
 247 static void
 248 copy_stream (GInputStream *in,
 249              GOutputStream *out,
 250              GCancellable *cancellable)
 251 {
 252   CopyData *copy;
 253   gint i;
 254
 255   g_return_if_fail (in != NULL);
 256   g_return_if_fail (out != NULL);
 257
 258   copy = g_new0 (CopyData, 1);
 259   copy->in = g_object_ref (in);
 260   copy->out = g_object_ref (out);
 261   copy->ref_count = 1;
 262
 263   if (cancellable != NULL)
 264     copy->cancellable = g_object_ref (cancellable);
 265   else
 266     copy->cancellable = g_cancellable_new ();
 267
 268   for (i = 0; i < N_BUFFERS; i++)
 269     copy->buff[i] = g_malloc (BUFFER_SIZE);
 270
 271   schedule_next (copy);
 272 }
 273
 274 /* EmpathyTpFile object */
 275
 276 struct _EmpathyTpFilePriv {
 277   EmpathyContactFactory *factory;
 278   MissionControl *mc;
 279   TpChannel *channel;
 280
 281   EmpathyContact *contact;
 282   GInputStream *in_stream;
 283   GOutputStream *out_stream;
 284
 285   /* org.freedesktop.Telepathy.Channel.Type.FileTransfer D-Bus properties */
 286   EmpFileTransferState state;
 287   gchar *content_type;
 288   gchar *filename;
 289   guint64 size;
 290   EmpFileHashType content_hash_type;
 291   gchar *content_hash;
 292   gchar *description;
 293   guint64 transferred_bytes;
 294
 295   gboolean incoming;
 296   EmpFileTransferStateChangeReason state_change_reason;
 297   time_t start_time;
 298   gchar *unix_socket_path;
 299   GCancellable *cancellable;
 300 };
 301
 302 enum {
 303   PROP_0,
 304   PROP_CHANNEL,
 305   PROP_STATE,
 306   PROP_INCOMING,
 307   PROP_FILENAME,
 308   PROP_SIZE,
 309   PROP_CONTENT_TYPE,
 310   PROP_TRANSFERRED_BYTES,
 311   PROP_CONTENT_HASH_TYPE,
 312   PROP_CONTENT_HASH,
 313 };
 314
 315 G_DEFINE_TYPE (EmpathyTpFile, empathy_tp_file, G_TYPE_OBJECT);
 316
 317 static void
 318 empathy_tp_file_init (EmpathyTpFile *tp_file)
 319 {
 320   EmpathyTpFilePriv *priv;
 321
 322   priv = G_TYPE_INSTANCE_GET_PRIVATE ((tp_file),
 323       EMPATHY_TYPE_TP_FILE, EmpathyTpFilePriv);
 324
 325   tp_file->priv = priv;
 326 }
 327
 328 static void
 329 tp_file_invalidated_cb (TpProxy       *proxy,
 330                         guint          domain,
 331                         gint           code,
 332                         gchar         *message,
 333                         EmpathyTpFile *tp_file)
 334 {
 335   DEBUG ("Channel invalidated: %s", message);
 336
 337   if (tp_file->priv->state != EMP_FILE_TRANSFER_STATE_COMPLETED &&
 338       tp_file->priv->state != EMP_FILE_TRANSFER_STATE_CANCELLED)
 339     {
 340       /* The channel is not in a finished state, an error occured */
 341       tp_file->priv->state = EMP_FILE_TRANSFER_STATE_CANCELLED;
 342       tp_file->priv->state_change_reason =
 343           EMP_FILE_TRANSFER_STATE_CHANGE_REASON_LOCAL_ERROR;
 344       g_object_notify (G_OBJECT (tp_file), "state");
 345     }
 346 }
 347
 348 static void
 349 tp_file_finalize (GObject *object)
 350 {
 351   EmpathyTpFile *tp_file = EMPATHY_TP_FILE (object);
 352
 353   if (tp_file->priv->channel)
 354     {
 355       g_signal_handlers_disconnect_by_func (tp_file->priv->channel,
 356           tp_file_invalidated_cb, object);
 357       g_object_unref (tp_file->priv->channel);
 358       tp_file->priv->channel = NULL;
 359     }
 360
 361   if (tp_file->priv->factory)
 362     {
 363       g_object_unref (tp_file->priv->factory);
 364     }
 365   if (tp_file->priv->mc)
 366     {
 367       g_object_unref (tp_file->priv->mc);
 368     }
 369
 370   g_free (tp_file->priv->filename);
 371   g_free (tp_file->priv->unix_socket_path);
 372   g_free (tp_file->priv->description);
 373   g_free (tp_file->priv->content_hash);
 374   g_free (tp_file->priv->content_type);
 375
 376   if (tp_file->priv->in_stream)
 377     g_object_unref (tp_file->priv->in_stream);
 378
 379   if (tp_file->priv->out_stream)
 380     g_object_unref (tp_file->priv->out_stream);
 381
 382   if (tp_file->priv->contact)
 383     g_object_unref (tp_file->priv->contact);
 384
 385   if (tp_file->priv->cancellable)
 386     g_object_unref (tp_file->priv->cancellable);
 387
 388   G_OBJECT_CLASS (empathy_tp_file_parent_class)->finalize (object);
 389 }
 390
 391 static void
 392 tp_file_start_transfer (EmpathyTpFile *tp_file)
 393 {
 394   gint fd;
 395   size_t path_len;
 396   struct sockaddr_un addr;
 397
 398   fd = socket (PF_UNIX, SOCK_STREAM, 0);
 399   if (fd < 0)
 400     {
 401       DEBUG ("Failed to create socket, closing channel");
 402       empathy_tp_file_cancel (tp_file);
 403       return;
 404     }
 405
 406   memset (&addr, 0, sizeof (addr));
 407   addr.sun_family = AF_UNIX;
 408   path_len = strlen (tp_file->priv->unix_socket_path);
 409   strncpy (addr.sun_path, tp_file->priv->unix_socket_path, path_len);
 410
 411   if (connect (fd, (struct sockaddr*) &addr, sizeof (addr)) < 0)
 412     {
 413       DEBUG ("Failed to connect socket, closing channel");
 414       empathy_tp_file_cancel (tp_file);
 415       close (fd);
 416       return;
 417     }
 418
 419   DEBUG ("Start the transfer");
 420
 421   tp_file->priv->start_time = empathy_time_get_current ();
 422   tp_file->priv->cancellable = g_cancellable_new ();
 423   if (tp_file->priv->incoming)
 424     {
 425       GInputStream *socket_stream;
 426
 427       socket_stream = g_unix_input_stream_new (fd, TRUE);
 428       copy_stream (socket_stream, tp_file->priv->out_stream,
 429           tp_file->priv->cancellable);
 430       g_object_unref (socket_stream);
 431     }
 432   else
 433     {
 434       GOutputStream *socket_stream;
 435
 436       socket_stream = g_unix_output_stream_new (fd, TRUE);
 437       copy_stream (tp_file->priv->in_stream, socket_stream,
 438           tp_file->priv->cancellable);
 439       g_object_unref (socket_stream);
 440     }
 441 }
 442
 443 static void
 444 tp_file_state_changed_cb (TpProxy *proxy,
 445                           guint state,
 446                           guint reason,
 447                           gpointer user_data,
 448                           GObject *weak_object)
 449 {
 450   EmpathyTpFile *tp_file = EMPATHY_TP_FILE (weak_object);
 451
 452   if (state == tp_file->priv->state)
 453     return;
 454
 455   DEBUG ("File transfer state changed:\n"
 456       "\tfilename = %s, old state = %u, state = %u, reason = %u\n"
 457       "\tincoming = %s, in_stream = %s, out_stream = %s",
 458       tp_file->priv->filename, tp_file->priv->state, state, reason,
 459       tp_file->priv->incoming ? "yes" : "no",
 460       tp_file->priv->in_stream ? "present" : "not present",
 461       tp_file->priv->out_stream ? "present" : "not present");
 462
 463   /* If the channel is open AND we have the socket path, we can start the
 464    * transfer. The socket path could be NULL if we are not doing the actual
 465    * data transfer but are just an observer for the channel. */
 466   if (state == EMP_FILE_TRANSFER_STATE_OPEN &&
 467       tp_file->priv->unix_socket_path != NULL)
 468     tp_file_start_transfer (tp_file);
 469
 470   tp_file->priv->state = state;
 471   tp_file->priv->state_change_reason = reason;
 472
 473   g_object_notify (G_OBJECT (tp_file), "state");
 474 }
 475
 476 static void
 477 tp_file_transferred_bytes_changed_cb (TpProxy *proxy,
 478                                       guint64 count,
 479                                       gpointer user_data,
 480                                       GObject *weak_object)
 481 {
 482   EmpathyTpFile *tp_file = EMPATHY_TP_FILE (weak_object);
 483
 484   if (tp_file->priv->transferred_bytes == count)
 485     return;
 486
 487   tp_file->priv->transferred_bytes = count;
 488   g_object_notify (G_OBJECT (tp_file), "transferred-bytes");
 489 }
 490
 491 static GObject *
 492 tp_file_constructor (GType type,
 493                      guint n_props,
 494                      GObjectConstructParam *props)
 495 {
 496   GObject *file_obj;
 497   EmpathyTpFile *tp_file;
 498   TpHandle handle;
 499   GHashTable *properties;
 500   McAccount *account;
 501   GValue *requested;
 502
 503   file_obj = G_OBJECT_CLASS (empathy_tp_file_parent_class)->constructor (type,
 504       n_props, props);
 505
 506   tp_file = EMPATHY_TP_FILE (file_obj);
 507
 508   tp_file->priv->factory = empathy_contact_factory_dup_singleton ();
 509   tp_file->priv->mc = empathy_mission_control_new ();
 510
 511   g_signal_connect (tp_file->priv->channel, "invalidated",
 512     G_CALLBACK (tp_file_invalidated_cb), tp_file);
 513
 514   emp_cli_channel_type_file_transfer_connect_to_file_transfer_state_changed (
 515       TP_PROXY (tp_file->priv->channel), tp_file_state_changed_cb, NULL, NULL,
 516       G_OBJECT (tp_file), NULL);
 517
 518   emp_cli_channel_type_file_transfer_connect_to_transferred_bytes_changed (
 519       TP_PROXY (tp_file->priv->channel), tp_file_transferred_bytes_changed_cb,
 520       NULL, NULL, G_OBJECT (tp_file), NULL);
 521
 522   account = empathy_channel_get_account (tp_file->priv->channel);
 523
 524   handle = tp_channel_get_handle (tp_file->priv->channel, NULL);
 525   tp_file->priv->contact = empathy_contact_factory_get_from_handle (
 526       tp_file->priv->factory, account, (guint) handle);
 527
 528   tp_cli_dbus_properties_run_get_all (tp_file->priv->channel,
 529       -1, EMP_IFACE_CHANNEL_TYPE_FILE_TRANSFER, &properties, NULL, NULL);
 530
 531   tp_cli_dbus_properties_run_get (tp_file->priv->channel,
 532       -1, TP_IFACE_CHANNEL, "Requested", &requested, NULL, NULL);
 533
 534   tp_file->priv->size = g_value_get_uint64 (
 535       g_hash_table_lookup (properties, "Size"));
 536
 537   tp_file->priv->state = g_value_get_uint (
 538       g_hash_table_lookup (properties, "State"));
 539
 540   tp_file->priv->state_change_reason =
 541       EMP_FILE_TRANSFER_STATE_CHANGE_REASON_NONE;
 542
 543   tp_file->priv->transferred_bytes = g_value_get_uint64 (
 544       g_hash_table_lookup (properties, "TransferredBytes"));
 545
 546   tp_file->priv->filename = g_value_dup_string (
 547       g_hash_table_lookup (properties, "Filename"));
 548
 549   tp_file->priv->content_hash = g_value_dup_string (
 550       g_hash_table_lookup (properties, "ContentHash"));
 551
 552   tp_file->priv->content_hash_type = g_value_get_uint (
 553       g_hash_table_lookup (properties, "ContentHashType"));
 554
 555   tp_file->priv->content_type = g_value_dup_string (
 556       g_hash_table_lookup (properties, "ContentType"));
 557
 558   tp_file->priv->description = g_value_dup_string (
 559       g_hash_table_lookup (properties, "Description"));
 560
 561   tp_file->priv->incoming = !g_value_get_boolean (requested);
 562
 563   g_hash_table_destroy (properties);
 564   g_object_unref (account);
 565   g_value_unset (requested);
 566
 567   return file_obj;
 568 }
 569
 570 static void
 571 tp_file_get_property (GObject *object,
 572                       guint param_id,
 573                       GValue *value,
 574                       GParamSpec *pspec)
 575 {
 576   EmpathyTpFile *tp_file;
 577
 578   tp_file = EMPATHY_TP_FILE (object);
 579
 580   switch (param_id)
 581     {
 582       case PROP_CHANNEL:
 583         g_value_set_object (value, tp_file->priv->channel);
 584         break;
 585       case PROP_INCOMING:
 586         g_value_set_boolean (value, tp_file->priv->incoming);
 587         break;
 588       case PROP_STATE:
 589         g_value_set_uint (value, tp_file->priv->state);
 590         break;
 591       case PROP_CONTENT_TYPE:
 592         g_value_set_string (value, tp_file->priv->content_type);
 593         break;
 594       case PROP_FILENAME:
 595         g_value_set_string (value, tp_file->priv->filename);
 596         break;
 597       case PROP_SIZE:
 598         g_value_set_uint64 (value, tp_file->priv->size);
 599         break;
 600       case PROP_CONTENT_HASH_TYPE:
 601         g_value_set_uint (value, tp_file->priv->content_hash_type);
 602         break;
 603       case PROP_CONTENT_HASH:
 604         g_value_set_string (value, tp_file->priv->content_hash);
 605         break;
 606       case PROP_TRANSFERRED_BYTES:
 607         g_value_set_uint64 (value, tp_file->priv->transferred_bytes);
 608         break;
 609       default:
 610         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 611         break;
 612     };
 613 }
 614
 615 static void
 616 tp_file_channel_set_dbus_property (gpointer proxy,
 617                                    const gchar *property,
 618                                    const GValue *value)
 619 {
 620         DEBUG ("Setting %s property", property);
 621         tp_cli_dbus_properties_call_set (TP_PROXY (proxy), -1,
 622             EMP_IFACE_CHANNEL_TYPE_FILE_TRANSFER, property, value,
 623             NULL, NULL, NULL, NULL);
 624 }
 625
 626 static void
 627 tp_file_set_property (GObject *object,
 628                       guint param_id,
 629                       const GValue *value,
 630                       GParamSpec *pspec)
 631 {
 632   EmpathyTpFile *tp_file = (EmpathyTpFile *) object;
 633   switch (param_id)
 634     {
 635       case PROP_CHANNEL:
 636         tp_file->priv->channel = g_object_ref (g_value_get_object (value));
 637         break;
 638       case PROP_STATE:
 639         tp_file->priv->state = g_value_get_uint (value);
 640         break;
 641       case PROP_INCOMING:
 642         tp_file->priv->incoming = g_value_get_boolean (value);
 643         break;
 644       case PROP_FILENAME:
 645         g_free (tp_file->priv->filename);
 646         tp_file->priv->filename = g_value_dup_string (value);
 647         tp_file_channel_set_dbus_property (tp_file->priv->channel,
 648             "Filename", value);
 649         break;
 650       case PROP_SIZE:
 651         tp_file->priv->size = g_value_get_uint64 (value);
 652         tp_file_channel_set_dbus_property (tp_file->priv->channel,
 653             "Size", value);
 654         break;
 655       case PROP_CONTENT_TYPE:
 656         tp_file_channel_set_dbus_property (tp_file->priv->channel,
 657             "ContentType", value);
 658         g_free (tp_file->priv->content_type);
 659         tp_file->priv->content_type = g_value_dup_string (value);
 660         break;
 661       case PROP_CONTENT_HASH:
 662         tp_file_channel_set_dbus_property (tp_file->priv->channel,
 663             "ContentHash", value);
 664         g_free (tp_file->priv->content_hash);
 665         tp_file->priv->content_hash = g_value_dup_string (value);
 666         break;
 667       default:
 668         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
 669         break;
 670     };
 671 }
 672
 673 static GHashTable *ft_table = NULL;
 674
 675 static void
 676 tp_file_weak_notify_cb (gpointer channel,
 677                         GObject *tp_file)
 678 {
 679   g_hash_table_remove (ft_table, channel);
 680 }
 681
 682 /**
 683  * empathy_tp_file_new:
 684  * @channel: a Telepathy channel
 685  *
 686  * Creates a new #EmpathyTpFile wrapping @channel, or return a new ref to an
 687  * existing #EmpathyTpFile for that channel.
 688  *
 689  * Returns: a new #EmpathyTpFile
 690  */
 691 EmpathyTpFile *
 692 empathy_tp_file_new (TpChannel *channel)
 693 {
 694   EmpathyTpFile *tp_file;
 695
 696   g_return_val_if_fail (TP_IS_CHANNEL (channel), NULL);
 697
 698   if (ft_table != NULL)
 699     {
 700       tp_file = g_hash_table_lookup (ft_table, channel);
 701       if (tp_file != NULL) {
 702         return g_object_ref (tp_file);
 703       }
 704     }
 705   else
 706     ft_table = g_hash_table_new_full (empathy_proxy_hash,
 707       empathy_proxy_equal, (GDestroyNotify) g_object_unref, NULL);
 708
 709   tp_file = g_object_new (EMPATHY_TYPE_TP_FILE,
 710       "channel", channel,
 711       NULL);
 712
 713   g_hash_table_insert (ft_table, g_object_ref (channel), tp_file);
 714   g_object_weak_ref (G_OBJECT (tp_file), tp_file_weak_notify_cb, channel);
 715
 716   return tp_file;
 717 }
 718
 719 /**
 720  * empathy_tp_file_get_channel
 721  * @tp_file: an #EmpathyTpFile
 722  *
 723  * Returns the Telepathy file transfer channel
 724  *
 725  * Returns: the #TpChannel
 726  */
 727 TpChannel *
 728 empathy_tp_file_get_channel (EmpathyTpFile *tp_file)
 729 {
 730   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), NULL);
 731
 732   return tp_file->priv->channel;
 733 }
 734
 735 static void
 736 tp_file_method_cb (TpProxy *proxy,
 737                    const GValue *address,
 738                    const GError *error,
 739                    gpointer user_data,
 740                    GObject *weak_object)
 741 {
 742   EmpathyTpFile *tp_file = (EmpathyTpFile *) weak_object;
 743
 744   if (error)
 745     {
 746       DEBUG ("Error: %s", error->message);
 747       empathy_tp_file_cancel (tp_file);
 748       return;
 749     }
 750
 751   tp_file->priv->unix_socket_path = g_value_dup_string (address);
 752
 753   DEBUG ("Got unix socket path: %s", tp_file->priv->unix_socket_path);
 754
 755   if (tp_file->priv->state == EMP_FILE_TRANSFER_STATE_OPEN)
 756     tp_file_start_transfer (tp_file);
 757 }
 758
 759 /**
 760  * empathy_tp_file_accept:
 761  * @tp_file: an #EmpathyTpFile
 762  * @offset: position where to start the transfer
 763  * @gfile: a #GFile where to write transfered data
 764  * @error: a #GError set if there is an error when opening @gfile
 765  *
 766  * Accepts a file transfer that's in the "local pending" state (i.e.
 767  * EMP_FILE_TRANSFER_STATE_LOCAL_PENDING).
 768  */
 769 void
 770 empathy_tp_file_accept (EmpathyTpFile *tp_file,
 771                         guint64 offset,
 772                         GFile *gfile,
 773                         GError **error)
 774 {
 775   GValue nothing = { 0 };
 776
 777   g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
 778   g_return_if_fail (G_IS_FILE (gfile));
 779
 780   tp_file->priv->out_stream = G_OUTPUT_STREAM (g_file_replace (gfile, NULL,
 781         FALSE, 0, NULL, error));
 782   if (error && *error)
 783     return;
 784
 785   tp_file->priv->filename = g_file_get_basename (gfile);
 786   g_object_notify (G_OBJECT (tp_file), "filename");
 787
 788   DEBUG ("Accepting file: filename=%s", tp_file->priv->filename);
 789
 790   g_value_init (&nothing, G_TYPE_STRING);
 791   g_value_set_static_string (&nothing, "");
 792
 793   emp_cli_channel_type_file_transfer_call_accept_file (TP_PROXY (
 794       tp_file->priv->channel),
 795       -1, TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
 796       &nothing, offset, tp_file_method_cb, NULL, NULL, G_OBJECT (tp_file));
 797 }
 798
 799 /**
 800  * empathy_tp_file_offer:
 801  * @tp_file: an #EmpathyTpFile
 802  * @gfile: a #GFile where to read the data to transfer
 803  * @error: a #GError set if there is an error when opening @gfile
 804  *
 805  * Offers a file transfer that's in the "not offered" state (i.e.
 806  * EMP_FILE_TRANSFER_STATE_NOT_OFFERED).
 807  */
 808 void
 809 empathy_tp_file_offer (EmpathyTpFile *tp_file, GFile *gfile, GError **error)
 810 {
 811   GValue nothing = { 0 };
 812
 813   g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
 814
 815   tp_file->priv->in_stream = G_INPUT_STREAM (g_file_read (gfile, NULL, error));
 816   if (error && *error)
 817         return;
 818
 819   g_value_init (&nothing, G_TYPE_STRING);
 820   g_value_set_static_string (&nothing, "");
 821
 822   emp_cli_channel_type_file_transfer_call_provide_file (
 823       TP_PROXY (tp_file->priv->channel), -1,
 824       TP_SOCKET_ADDRESS_TYPE_UNIX, TP_SOCKET_ACCESS_CONTROL_LOCALHOST,
 825       &nothing, tp_file_method_cb, NULL, NULL, G_OBJECT (tp_file));
 826 }
 827
 828 EmpathyContact *
 829 empathy_tp_file_get_contact (EmpathyTpFile *tp_file)
 830 {
 831   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), NULL);
 832   return tp_file->priv->contact;
 833 }
 834
 835 const gchar *
 836 empathy_tp_file_get_filename (EmpathyTpFile *tp_file)
 837 {
 838   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), NULL);
 839   return tp_file->priv->filename;
 840 }
 841
 842 gboolean
 843 empathy_tp_file_is_incoming (EmpathyTpFile *tp_file)
 844 {
 845   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), FALSE);
 846   return tp_file->priv->incoming;
 847 }
 848
 849 EmpFileTransferState
 850 empathy_tp_file_get_state (EmpathyTpFile *tp_file,
 851                            EmpFileTransferStateChangeReason *reason)
 852 {
 853   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file),
 854       EMP_FILE_TRANSFER_STATE_NONE);
 855
 856   if (reason != NULL)
 857     *reason = tp_file->priv->state_change_reason;
 858
 859   return tp_file->priv->state;
 860 }
 861
 862 guint64
 863 empathy_tp_file_get_size (EmpathyTpFile *tp_file)
 864 {
 865   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file),
 866       EMPATHY_TP_FILE_UNKNOWN_SIZE);
 867   return tp_file->priv->size;
 868 }
 869
 870 guint64
 871 empathy_tp_file_get_transferred_bytes (EmpathyTpFile *tp_file)
 872 {
 873   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), 0);
 874   return tp_file->priv->transferred_bytes;
 875 }
 876
 877 gint
 878 empathy_tp_file_get_remaining_time (EmpathyTpFile *tp_file)
 879 {
 880   time_t curr_time, elapsed_time;
 881   gdouble time_per_byte;
 882   gdouble remaining_time;
 883
 884   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), -1);
 885
 886   if (tp_file->priv->size == EMPATHY_TP_FILE_UNKNOWN_SIZE)
 887     return -1;
 888
 889   if (tp_file->priv->transferred_bytes == tp_file->priv->size)
 890     return 0;
 891
 892   curr_time = empathy_time_get_current ();
 893   elapsed_time = curr_time - tp_file->priv->start_time;
 894   time_per_byte = (gdouble) elapsed_time /
 895       (gdouble) tp_file->priv->transferred_bytes;
 896   remaining_time = time_per_byte * (tp_file->priv->size -
 897       tp_file->priv->transferred_bytes);
 898
 899   return (gint) remaining_time;
 900 }
 901
 902 const gchar *
 903 empathy_tp_file_get_content_type (EmpathyTpFile *tp_file)
 904 {
 905   g_return_val_if_fail (EMPATHY_IS_TP_FILE (tp_file), NULL);
 906   return tp_file->priv->content_type;
 907 }
 908
 909 void
 910 empathy_tp_file_cancel (EmpathyTpFile *tp_file)
 911 {
 912   g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
 913
 914   DEBUG ("Closing channel..");
 915   tp_cli_channel_call_close (tp_file->priv->channel, -1,
 916     NULL, NULL, NULL, NULL);
 917
 918   if (tp_file->priv->cancellable != NULL)
 919     g_cancellable_cancel (tp_file->priv->cancellable);
 920 }
 921
 922 void
 923 empathy_tp_file_close (EmpathyTpFile *tp_file)
 924 {
 925   empathy_tp_file_cancel (tp_file);
 926 }
 927
 928 static void
 929 empathy_tp_file_class_init (EmpathyTpFileClass *klass)
 930 {
 931   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 932
 933   object_class->finalize = tp_file_finalize;
 934   object_class->constructor = tp_file_constructor;
 935   object_class->get_property = tp_file_get_property;
 936   object_class->set_property = tp_file_set_property;
 937
 938   /* Construct-only properties */
 939   g_object_class_install_property (object_class,
 940       PROP_CHANNEL,
 941       g_param_spec_object ("channel",
 942           "telepathy channel",
 943           "The file transfer channel",
 944           TP_TYPE_CHANNEL,
 945           G_PARAM_READWRITE |
 946           G_PARAM_CONSTRUCT_ONLY));
 947
 948   g_object_class_install_property (object_class,
 949       PROP_STATE,
 950       g_param_spec_uint ("state",
 951           "state of the transfer",
 952           "The file transfer state",
 953           0,
 954           G_MAXUINT,
 955           G_MAXUINT,
 956           G_PARAM_READWRITE |
 957           G_PARAM_CONSTRUCT));
 958
 959   g_object_class_install_property (object_class,
 960       PROP_INCOMING,
 961       g_param_spec_boolean ("incoming",
 962           "incoming",
 963           "Whether the transfer is incoming",
 964           FALSE,
 965           G_PARAM_READWRITE |
 966           G_PARAM_CONSTRUCT));
 967
 968   g_object_class_install_property (object_class,
 969       PROP_FILENAME,
 970       g_param_spec_string ("filename",
 971           "name of the transfer",
 972           "The file transfer filename",
 973           "",
 974           G_PARAM_READWRITE));
 975
 976   g_object_class_install_property (object_class,
 977       PROP_SIZE,
 978       g_param_spec_uint64 ("size",
 979           "size of the file",
 980           "The file transfer size",
 981           0,
 982           G_MAXUINT64,
 983           G_MAXUINT64,
 984           G_PARAM_READWRITE));
 985
 986   g_object_class_install_property (object_class,
 987       PROP_CONTENT_TYPE,
 988       g_param_spec_string ("content-type",
 989           "file transfer content-type",
 990           "The file transfer content-type",
 991           "",
 992           G_PARAM_READWRITE));
 993
 994   g_object_class_install_property (object_class,
 995       PROP_CONTENT_HASH_TYPE,
 996       g_param_spec_uint ("content-hash-type",
 997           "file transfer hash type",
 998           "The type of the file transfer hash",
 999           0,
1000           G_MAXUINT,
1001           0,
1002           G_PARAM_READWRITE));
1003
1004   g_object_class_install_property (object_class,
1005       PROP_CONTENT_HASH,
1006       g_param_spec_string ("content-hash",
1007           "file transfer hash",
1008           "The hash of the transfer's contents",
1009           "",
1010           G_PARAM_READWRITE));
1011
1012   g_object_class_install_property (object_class,
1013       PROP_TRANSFERRED_BYTES,
1014       g_param_spec_uint64 ("transferred-bytes",
1015           "bytes transferred",
1016           "The number of bytes transferred",
1017           0,
1018           G_MAXUINT64,
1019           0,
1020           G_PARAM_READWRITE));
1021
1022   g_type_class_add_private (object_class, sizeof (EmpathyTpFilePriv));
1023 }
1024