libempathy/empathy-ft-handler.c

   1 /*
   2  * empathy-ft-handler.c - Source for EmpathyFTHandler
   3  * Copyright (C) 2009 Collabora Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  *
  19  * Author: Cosimo Cecchi <cosimo.cecchi@collabora.co.uk>
  20  */
  21
  22 /* empathy-ft-handler.c */
  23
  24 #include <glib.h>
  25 #include <glib/gi18n.h>
  26 #include <telepathy-glib/account-channel-request.h>
  27 #include <telepathy-glib/util.h>
  28 #include <telepathy-glib/dbus.h>
  29 #include <telepathy-glib/interfaces.h>
  30
  31 #include "empathy-ft-handler.h"
  32 #include "empathy-tp-contact-factory.h"
  33 #include "empathy-dispatcher.h"
  34 #include "empathy-marshal.h"
  35 #include "empathy-time.h"
  36 #include "empathy-utils.h"
  37
  38 #define DEBUG_FLAG EMPATHY_DEBUG_FT
  39 #include "empathy-debug.h"
  40
  41 /**
  42  * SECTION:empathy-ft-handler
  43  * @title: EmpathyFTHandler
  44  * @short_description: an object representing a File Transfer
  45  * @include: libempathy/empathy-ft-handler
  46  *
  47  * #EmpathyFTHandler is the object which represents a File Transfer with all
  48  * its properties.
  49  * The creation of an #EmpathyFTHandler is done with
  50  * empathy_ft_handler_new_outgoing() or empathy_ft_handler_new_incoming(),
  51  * even though clients should not need to call them directly, as
  52  * #EmpathyFTFactory does it for them. Remember that for the file transfer
  53  * to work with an incoming handler,
  54  * empathy_ft_handler_incoming_set_destination() should be called after
  55  * empathy_ft_handler_new_incoming(). #EmpathyFTFactory does this
  56  * automatically.
  57  * It's important to note that, as the creation of the handlers is async, once
  58  * an handler is created, it already has all the interesting properties set,
  59  * like filename, total bytes, content type and so on, making it useful
  60  * to be displayed in an UI.
  61  * The transfer API works like a state machine; it has three signals,
  62  * ::transfer-started, ::transfer-progress, ::transfer-done, which will be
  63  * emitted in the relevant phases.
  64  * In addition, if the handler is created with checksumming enabled,
  65  * other three signals (::hashing-started, ::hashing-progress, ::hashing-done)
  66  * will be emitted before or after the transfer, depending on the direction
  67  * (respectively outgoing and incoming) of the handler.
  68  * At any time between the call to empathy_ft_handler_start_transfer() and
  69  * the last signal, a ::transfer-error can be emitted, indicating that an
  70  * error has happened in the operation. The message of the error is localized
  71  * to use in an UI.
  72  */
  73
  74 G_DEFINE_TYPE (EmpathyFTHandler, empathy_ft_handler, G_TYPE_OBJECT)
  75
  76 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyFTHandler)
  77
  78 #define BUFFER_SIZE 4096
  79
  80 enum {
  81   PROP_TP_FILE = 1,
  82   PROP_G_FILE,
  83   PROP_CONTACT,
  84   PROP_CONTENT_TYPE,
  85   PROP_DESCRIPTION,
  86   PROP_FILENAME,
  87   PROP_MODIFICATION_TIME,
  88   PROP_TOTAL_BYTES,
  89   PROP_TRANSFERRED_BYTES
  90 };
  91
  92 enum {
  93   HASHING_STARTED,
  94   HASHING_PROGRESS,
  95   HASHING_DONE,
  96   TRANSFER_STARTED,
  97   TRANSFER_PROGRESS,
  98   TRANSFER_DONE,
  99   TRANSFER_ERROR,
 100   LAST_SIGNAL
 101 };
 102
 103 typedef struct {
 104   GInputStream *stream;
 105   GError *error /* comment to make the style checker happy */;
 106   guchar *buffer;
 107   GChecksum *checksum;
 108   gssize total_read;
 109   guint64 total_bytes;
 110   EmpathyFTHandler *handler;
 111 } HashingData;
 112
 113 typedef struct {
 114   EmpathyFTHandlerReadyCallback callback;
 115   gpointer user_data;
 116   EmpathyFTHandler *handler;
 117 } CallbacksData;
 118
 119 /* private data */
 120 typedef struct {
 121   gboolean dispose_run;
 122
 123   GFile *gfile;
 124   EmpathyTpFile *tpfile;
 125   GCancellable *cancellable;
 126   gboolean use_hash;
 127
 128   EmpathyDispatcher *dispatcher;
 129
 130   /* request for the new transfer */
 131   GHashTable *request;
 132
 133   /* transfer properties */
 134   EmpathyContact *contact;
 135   gchar *content_type;
 136   gchar *filename;
 137   gchar *description;
 138   guint64 total_bytes;
 139   guint64 transferred_bytes;
 140   guint64 mtime;
 141   gchar *content_hash;
 142   TpFileHashType content_hash_type;
 143
 144   /* time and speed */
 145   gdouble speed;
 146   guint remaining_time;
 147   time_t last_update_time;
 148
 149   gboolean is_completed;
 150 } EmpathyFTHandlerPriv;
 151
 152 static guint signals[LAST_SIGNAL] = { 0 };
 153
 154 static gboolean do_hash_job_incoming (GIOSchedulerJob *job,
 155     GCancellable *cancellable, gpointer user_data);
 156
 157 /* GObject implementations */
 158 static void
 159 do_get_property (GObject *object,
 160     guint property_id,
 161     GValue *value,
 162     GParamSpec *pspec)
 163 {
 164   EmpathyFTHandlerPriv *priv = GET_PRIV (object);
 165
 166   switch (property_id)
 167     {
 168       case PROP_CONTACT:
 169         g_value_set_object (value, priv->contact);
 170         break;
 171       case PROP_CONTENT_TYPE:
 172         g_value_set_string (value, priv->content_type);
 173         break;
 174       case PROP_DESCRIPTION:
 175         g_value_set_string (value, priv->description);
 176         break;
 177       case PROP_FILENAME:
 178         g_value_set_string (value, priv->filename);
 179         break;
 180       case PROP_MODIFICATION_TIME:
 181         g_value_set_uint64 (value, priv->mtime);
 182         break;
 183       case PROP_TOTAL_BYTES:
 184         g_value_set_uint64 (value, priv->total_bytes);
 185         break;
 186       case PROP_TRANSFERRED_BYTES:
 187         g_value_set_uint64 (value, priv->transferred_bytes);
 188         break;
 189       case PROP_G_FILE:
 190         g_value_set_object (value, priv->gfile);
 191         break;
 192       case PROP_TP_FILE:
 193         g_value_set_object (value, priv->tpfile);
 194         break;
 195       default:
 196         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 197     }
 198 }
 199
 200 static void
 201 do_set_property (GObject *object,
 202     guint property_id,
 203     const GValue *value,
 204     GParamSpec *pspec)
 205 {
 206   EmpathyFTHandlerPriv *priv = GET_PRIV (object);
 207
 208   switch (property_id)
 209     {
 210       case PROP_CONTACT:
 211         priv->contact = g_value_dup_object (value);
 212         break;
 213       case PROP_CONTENT_TYPE:
 214         priv->content_type = g_value_dup_string (value);
 215         break;
 216       case PROP_DESCRIPTION:
 217         priv->description = g_value_dup_string (value);
 218         break;
 219       case PROP_FILENAME:
 220         priv->filename = g_value_dup_string (value);
 221         break;
 222       case PROP_MODIFICATION_TIME:
 223         priv->mtime = g_value_get_uint64 (value);
 224         break;
 225       case PROP_TOTAL_BYTES:
 226         priv->total_bytes = g_value_get_uint64 (value);
 227         break;
 228       case PROP_TRANSFERRED_BYTES:
 229         priv->transferred_bytes = g_value_get_uint64 (value);
 230         break;
 231       case PROP_G_FILE:
 232         priv->gfile = g_value_dup_object (value);
 233         break;
 234       case PROP_TP_FILE:
 235         priv->tpfile = g_value_dup_object (value);
 236         break;
 237       default:
 238         G_OBJECT_WARN_INVALID_PROPERTY_ID (object, property_id, pspec);
 239     }
 240 }
 241
 242 static void
 243 do_dispose (GObject *object)
 244 {
 245   EmpathyFTHandlerPriv *priv = GET_PRIV (object);
 246
 247   if (priv->dispose_run)
 248     return;
 249
 250   priv->dispose_run = TRUE;
 251
 252   if (priv->contact != NULL) {
 253     g_object_unref (priv->contact);
 254     priv->contact = NULL;
 255   }
 256
 257   if (priv->gfile != NULL) {
 258     g_object_unref (priv->gfile);
 259     priv->gfile = NULL;
 260   }
 261
 262   if (priv->tpfile != NULL) {
 263     empathy_tp_file_close (priv->tpfile);
 264     g_object_unref (priv->tpfile);
 265     priv->tpfile = NULL;
 266   }
 267
 268   if (priv->cancellable != NULL) {
 269     g_object_unref (priv->cancellable);
 270     priv->cancellable = NULL;
 271   }
 272
 273   if (priv->request != NULL)
 274     {
 275       g_hash_table_unref (priv->request);
 276       priv->request = NULL;
 277     }
 278
 279   if (priv->dispatcher != NULL)
 280     {
 281       g_object_unref (priv->dispatcher);
 282       priv->dispatcher = NULL;
 283     }
 284
 285   G_OBJECT_CLASS (empathy_ft_handler_parent_class)->dispose (object);
 286 }
 287
 288 static void
 289 do_finalize (GObject *object)
 290 {
 291   EmpathyFTHandlerPriv *priv = GET_PRIV (object);
 292
 293   DEBUG ("%p", object);
 294
 295   g_free (priv->content_type);
 296   priv->content_type = NULL;
 297
 298   g_free (priv->filename);
 299   priv->filename = NULL;
 300
 301   g_free (priv->description);
 302   priv->description = NULL;
 303
 304   g_free (priv->content_hash);
 305   priv->content_hash = NULL;
 306
 307   G_OBJECT_CLASS (empathy_ft_handler_parent_class)->finalize (object);
 308 }
 309
 310 static void
 311 empathy_ft_handler_class_init (EmpathyFTHandlerClass *klass)
 312 {
 313   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 314   GParamSpec *param_spec;
 315
 316   g_type_class_add_private (klass, sizeof (EmpathyFTHandlerPriv));
 317
 318   object_class->get_property = do_get_property;
 319   object_class->set_property = do_set_property;
 320   object_class->dispose = do_dispose;
 321   object_class->finalize = do_finalize;
 322
 323   /* properties */
 324
 325   /**
 326    * EmpathyFTHandler:contact:
 327    *
 328    * The remote #EmpathyContact for the transfer
 329    */
 330   param_spec = g_param_spec_object ("contact",
 331     "contact", "The remote contact",
 332     EMPATHY_TYPE_CONTACT,
 333     G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY);
 334   g_object_class_install_property (object_class, PROP_CONTACT, param_spec);
 335
 336   /**
 337    * EmpathyFTHandler:content-type:
 338    *
 339    * The content type of the file being transferred
 340    */
 341   param_spec = g_param_spec_string ("content-type",
 342     "content-type", "The content type of the file", NULL,
 343     G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 344   g_object_class_install_property (object_class,
 345       PROP_CONTENT_TYPE, param_spec);
 346
 347   /**
 348    * EmpathyFTHandler:description:
 349    *
 350    * The description of the file being transferred
 351    */
 352   param_spec = g_param_spec_string ("description",
 353     "description", "The description of the file", NULL,
 354     G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 355   g_object_class_install_property (object_class,
 356       PROP_DESCRIPTION, param_spec);
 357
 358   /**
 359    * EmpathyFTHandler:filename:
 360    *
 361    * The name of the file being transferred
 362    */
 363   param_spec = g_param_spec_string ("filename",
 364     "filename", "The name of the file", NULL,
 365     G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 366   g_object_class_install_property (object_class,
 367       PROP_FILENAME, param_spec);
 368
 369   /**
 370    * EmpathyFTHandler:modification-time:
 371    *
 372    * The modification time of the file being transferred
 373    */
 374   param_spec = g_param_spec_uint64 ("modification-time",
 375     "modification-time", "The mtime of the file", 0,
 376     G_MAXUINT64, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 377   g_object_class_install_property (object_class,
 378       PROP_MODIFICATION_TIME, param_spec);
 379
 380   /**
 381    * EmpathyFTHandler:total-bytes:
 382    *
 383    * The size (in bytes) of the file being transferred
 384    */
 385   param_spec = g_param_spec_uint64 ("total-bytes",
 386     "total-bytes", "The size of the file", 0,
 387     G_MAXUINT64, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 388   g_object_class_install_property (object_class,
 389       PROP_TOTAL_BYTES, param_spec);
 390
 391   /**
 392    * EmpathyFTHandler:transferred-bytes:
 393    *
 394    * The number of the bytes already transferred
 395    */
 396   param_spec = g_param_spec_uint64 ("transferred-bytes",
 397     "transferred-bytes", "The number of bytes already transferred", 0,
 398     G_MAXUINT64, 0, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS);
 399   g_object_class_install_property (object_class,
 400       PROP_TRANSFERRED_BYTES, param_spec);
 401
 402   /**
 403    * EmpathyFTHandler:gfile:
 404    *
 405    * The #GFile object where the transfer actually happens
 406    */
 407   param_spec = g_param_spec_object ("gfile",
 408     "gfile", "The GFile we're handling",
 409     G_TYPE_FILE,
 410     G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
 411   g_object_class_install_property (object_class, PROP_G_FILE, param_spec);
 412
 413   /**
 414    * EmpathyFTHandler:tp-file:
 415    *
 416    * The underlying #EmpathyTpFile managing the transfer
 417    */
 418   param_spec = g_param_spec_object ("tp-file",
 419     "tp-file", "The file's channel wrapper",
 420     EMPATHY_TYPE_TP_FILE,
 421     G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS | G_PARAM_CONSTRUCT_ONLY);
 422   g_object_class_install_property (object_class, PROP_TP_FILE, param_spec);
 423
 424   /* signals */
 425
 426   /**
 427    * EmpathyFTHandler::transfer-started
 428    * @handler: the object which has received the signal
 429    * @tp_file: the #EmpathyTpFile for which the transfer has started
 430    *
 431    * This signal is emitted when the actual transfer starts.
 432    */
 433   signals[TRANSFER_STARTED] =
 434     g_signal_new ("transfer-started", G_TYPE_FROM_CLASS (klass),
 435         G_SIGNAL_RUN_LAST, 0, NULL, NULL,
 436         g_cclosure_marshal_VOID__OBJECT,
 437         G_TYPE_NONE,
 438         1, EMPATHY_TYPE_TP_FILE);
 439
 440   /**
 441    * EmpathyFTHandler::transfer-done
 442    * @handler: the object which has received the signal
 443    * @tp_file: the #EmpathyTpFile for which the transfer has started
 444    *
 445    * This signal will be emitted when the actual transfer is completed
 446    * successfully.
 447    */
 448   signals[TRANSFER_DONE] =
 449     g_signal_new ("transfer-done", G_TYPE_FROM_CLASS (klass),
 450         G_SIGNAL_RUN_LAST, 0, NULL, NULL,
 451         g_cclosure_marshal_VOID__OBJECT,
 452         G_TYPE_NONE,
 453         1, EMPATHY_TYPE_TP_FILE);
 454
 455   /**
 456    * EmpathyFTHandler::transfer-error
 457    * @handler: the object which has received the signal
 458    * @error: a #GError
 459    *
 460    * This signal can be emitted anytime between the call to
 461    * empathy_ft_handler_start_transfer() and the last expected signal
 462    * (::transfer-done or ::hashing-done), and it's guaranteed to be the last
 463    * signal coming from the handler, meaning that no other operation will
 464    * take place after this signal.
 465    */
 466   signals[TRANSFER_ERROR] =
 467     g_signal_new ("transfer-error", G_TYPE_FROM_CLASS (klass),
 468         G_SIGNAL_RUN_LAST, 0, NULL, NULL,
 469         g_cclosure_marshal_VOID__POINTER,
 470         G_TYPE_NONE,
 471         1, G_TYPE_POINTER);
 472
 473   /**
 474    * EmpathyFTHandler::transfer-progress
 475    * @handler: the object which has received the signal
 476    * @current_bytes: the bytes currently transferred
 477    * @total_bytes: the total bytes of the handler
 478    * @remaining_time: the number of seconds remaining for the transfer
 479    * to be completed
 480    * @speed: the current speed of the transfer (in KB/s)
 481    *
 482    * This signal is emitted to notify clients of the progress of the
 483    * transfer.
 484    */
 485   signals[TRANSFER_PROGRESS] =
 486     g_signal_new ("transfer-progress", G_TYPE_FROM_CLASS (klass),
 487         G_SIGNAL_RUN_LAST, 0, NULL, NULL,
 488         _empathy_marshal_VOID__UINT64_UINT64_UINT_DOUBLE,
 489         G_TYPE_NONE,
 490         4, G_TYPE_UINT64, G_TYPE_UINT64, G_TYPE_UINT, G_TYPE_DOUBLE);
 491
 492   /**
 493    * EmpathyFTHandler::hashing-started
 494    * @handler: the object which has received the signal
 495    *
 496    * This signal is emitted when the hashing operation of the handler
 497    * is started. Note that this might happen or not, depending on the CM
 498    * and remote contact capabilities. Clients shoud use
 499    * empathy_ft_handler_get_use_hash() before calling
 500    * empathy_ft_handler_start_transfer() to know whether they should connect
 501    * to this signal.
 502    */
 503   signals[HASHING_STARTED] =
 504     g_signal_new ("hashing-started", G_TYPE_FROM_CLASS (klass),
 505         G_SIGNAL_RUN_LAST, 0, NULL, NULL,
 506         g_cclosure_marshal_VOID__VOID,
 507         G_TYPE_NONE, 0);
 508
 509   /**
 510    * EmpathyFTHandler::hashing-progress
 511    * @handler: the object which has received the signal
 512    * @current_bytes: the bytes currently hashed
 513    * @total_bytes: the total bytes of the handler
 514    *
 515    * This signal is emitted to notify clients of the progress of the
 516    * hashing operation.
 517    */
 518   signals[HASHING_PROGRESS] =
 519     g_signal_new ("hashing-progress", G_TYPE_FROM_CLASS (klass),
 520         G_SIGNAL_RUN_LAST, 0, NULL, NULL,
 521         _empathy_marshal_VOID__UINT64_UINT64,
 522         G_TYPE_NONE,
 523         2, G_TYPE_UINT64, G_TYPE_UINT64);
 524
 525   /**
 526    * EmpathyFTHandler::hashing-done
 527    * @handler: the object which has received the signal
 528    *
 529    * This signal is emitted when the hashing operation of the handler
 530    * is completed.
 531    */
 532   signals[HASHING_DONE] =
 533     g_signal_new ("hashing-done", G_TYPE_FROM_CLASS (klass),
 534         G_SIGNAL_RUN_LAST, 0, NULL, NULL,
 535         g_cclosure_marshal_VOID__VOID,
 536         G_TYPE_NONE, 0);
 537 }
 538
 539 static void
 540 empathy_ft_handler_init (EmpathyFTHandler *self)
 541 {
 542   EmpathyFTHandlerPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
 543     EMPATHY_TYPE_FT_HANDLER, EmpathyFTHandlerPriv);
 544
 545   self->priv = priv;
 546   priv->cancellable = g_cancellable_new ();
 547   priv->dispatcher = empathy_dispatcher_dup_singleton ();
 548 }
 549
 550 /* private functions */
 551
 552 static void
 553 hash_data_free (HashingData *data)
 554 {
 555   g_free (data->buffer);
 556
 557   if (data->stream != NULL)
 558     g_object_unref (data->stream);
 559
 560   if (data->checksum != NULL)
 561     g_checksum_free (data->checksum);
 562
 563   if (data->error != NULL)
 564     g_error_free (data->error);
 565
 566   if (data->handler != NULL)
 567     g_object_unref (data->handler);
 568
 569   g_slice_free (HashingData, data);
 570 }
 571
 572 static GChecksumType
 573 tp_file_hash_to_g_checksum (TpFileHashType type)
 574 {
 575   GChecksumType retval;
 576
 577   switch (type)
 578     {
 579       case TP_FILE_HASH_TYPE_MD5:
 580         retval = G_CHECKSUM_MD5;
 581         break;
 582       case TP_FILE_HASH_TYPE_SHA1:
 583         retval = G_CHECKSUM_SHA1;
 584         break;
 585       case TP_FILE_HASH_TYPE_SHA256:
 586         retval = G_CHECKSUM_SHA256;
 587         break;
 588       case TP_FILE_HASH_TYPE_NONE:
 589       default:
 590         g_assert_not_reached ();
 591         break;
 592     }
 593
 594   return retval;
 595 }
 596
 597 static void
 598 check_hash_incoming (EmpathyFTHandler *handler)
 599 {
 600   HashingData *hash_data;
 601   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 602
 603   if (!EMP_STR_EMPTY (priv->content_hash))
 604     {
 605       hash_data = g_slice_new0 (HashingData);
 606       hash_data->total_bytes = priv->total_bytes;
 607       hash_data->handler = g_object_ref (handler);
 608       hash_data->checksum = g_checksum_new
 609         (tp_file_hash_to_g_checksum (priv->content_hash_type));
 610
 611       g_signal_emit (handler, signals[HASHING_STARTED], 0);
 612
 613       g_io_scheduler_push_job (do_hash_job_incoming, hash_data, NULL,
 614                                G_PRIORITY_DEFAULT, priv->cancellable);
 615     }
 616 }
 617
 618 static void
 619 emit_error_signal (EmpathyFTHandler *handler,
 620     const GError *error)
 621 {
 622   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 623
 624   DEBUG ("Error in transfer: %s\n", error->message);
 625
 626   if (!g_cancellable_is_cancelled (priv->cancellable))
 627     g_cancellable_cancel (priv->cancellable);
 628
 629   g_signal_emit (handler, signals[TRANSFER_ERROR], 0, error);
 630 }
 631
 632 static void
 633 ft_transfer_operation_callback (EmpathyTpFile *tp_file,
 634     const GError *error,
 635     gpointer user_data)
 636 {
 637   EmpathyFTHandler *handler = user_data;
 638   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 639
 640   DEBUG ("Transfer operation callback, error %p", error);
 641
 642   if (error != NULL)
 643     {
 644       emit_error_signal (handler, error);
 645     }
 646   else
 647     {
 648       priv->is_completed = TRUE;
 649       g_signal_emit (handler, signals[TRANSFER_DONE], 0, tp_file);
 650
 651       empathy_tp_file_close (tp_file);
 652
 653       if (empathy_ft_handler_is_incoming (handler) && priv->use_hash)
 654         {
 655           check_hash_incoming (handler);
 656         }
 657     }
 658 }
 659
 660 static void
 661 update_remaining_time_and_speed (EmpathyFTHandler *handler,
 662     guint64 transferred_bytes)
 663 {
 664   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 665   time_t elapsed_time, current_time;
 666   guint64 transferred, last_transferred_bytes;
 667   gdouble speed;
 668   gint remaining_time;
 669
 670   last_transferred_bytes = priv->transferred_bytes;
 671   priv->transferred_bytes = transferred_bytes;
 672
 673   current_time = empathy_time_get_current ();
 674   elapsed_time = current_time - priv->last_update_time;
 675
 676   if (elapsed_time >= 1)
 677     {
 678       transferred = transferred_bytes - last_transferred_bytes;
 679       speed = (gdouble) transferred / (gdouble) elapsed_time;
 680       remaining_time = (priv->total_bytes - priv->transferred_bytes) / speed;
 681       priv->speed = speed;
 682       priv->remaining_time = remaining_time;
 683       priv->last_update_time = current_time;
 684     }
 685 }
 686
 687 static void
 688 ft_transfer_progress_callback (EmpathyTpFile *tp_file,
 689     guint64 transferred_bytes,
 690     gpointer user_data)
 691 {
 692   EmpathyFTHandler *handler = user_data;
 693   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 694
 695   if (empathy_ft_handler_is_cancelled (handler))
 696     return;
 697
 698   if (transferred_bytes == 0)
 699     {
 700       priv->last_update_time = empathy_time_get_current ();
 701       g_signal_emit (handler, signals[TRANSFER_STARTED], 0, tp_file);
 702     }
 703
 704   if (priv->transferred_bytes != transferred_bytes)
 705     {
 706       update_remaining_time_and_speed (handler, transferred_bytes);
 707
 708       g_signal_emit (handler, signals[TRANSFER_PROGRESS], 0,
 709           transferred_bytes, priv->total_bytes, priv->remaining_time,
 710           priv->speed);
 711     }
 712 }
 713
 714 static void
 715 ft_handler_create_channel_cb (GObject *source,
 716     GAsyncResult *result,
 717     gpointer user_data)
 718 {
 719   EmpathyFTHandler *handler = user_data;
 720   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 721   GError *error = NULL;
 722   TpChannel *channel = NULL;
 723
 724   DEBUG ("Dispatcher create channel CB");
 725
 726   channel = tp_account_channel_request_create_and_handle_channel_finish (
 727         TP_ACCOUNT_CHANNEL_REQUEST (source), result, NULL, &error);
 728
 729   if (channel == NULL)
 730     DEBUG ("Failed to request FT channel: %s", error->message);
 731   else
 732     g_cancellable_set_error_if_cancelled (priv->cancellable, &error);
 733
 734   if (error != NULL)
 735     {
 736       emit_error_signal (handler, error);
 737
 738       g_error_free (error);
 739       goto out;
 740     }
 741
 742   priv->tpfile = empathy_tp_file_new (channel);
 743
 744   empathy_tp_file_offer (priv->tpfile, priv->gfile, priv->cancellable,
 745       ft_transfer_progress_callback, handler,
 746       ft_transfer_operation_callback, handler);
 747
 748 out:
 749   tp_clear_object (&channel);
 750 }
 751
 752 static void
 753 ft_handler_push_to_dispatcher (EmpathyFTHandler *handler)
 754 {
 755   TpAccount *account;
 756   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 757   TpAccountChannelRequest *req;
 758
 759   DEBUG ("Pushing request to the dispatcher");
 760
 761   account = empathy_contact_get_account (priv->contact);
 762
 763   req = tp_account_channel_request_new (account, priv->request,
 764       TP_USER_ACTION_TIME_NOT_USER_ACTION);
 765
 766   tp_account_channel_request_create_and_handle_channel_async (req, NULL,
 767       ft_handler_create_channel_cb, handler);
 768
 769   g_object_unref (req);
 770 }
 771
 772 static void
 773 ft_handler_populate_outgoing_request (EmpathyFTHandler *handler)
 774 {
 775   guint contact_handle;
 776   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 777   gchar *uri;
 778
 779   contact_handle = empathy_contact_get_handle (priv->contact);
 780   uri = g_file_get_uri (priv->gfile);
 781
 782   priv->request = tp_asv_new (
 783       TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING,
 784         TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER,
 785       TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT,
 786         TP_HANDLE_TYPE_CONTACT,
 787       TP_PROP_CHANNEL_TARGET_HANDLE, G_TYPE_UINT,
 788         contact_handle,
 789       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_TYPE, G_TYPE_STRING,
 790         priv->content_type,
 791       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_FILENAME, G_TYPE_STRING,
 792         priv->filename,
 793       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_SIZE, G_TYPE_UINT64,
 794         priv->total_bytes,
 795       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_DATE, G_TYPE_UINT64,
 796         priv->mtime,
 797       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_URI, G_TYPE_STRING, uri,
 798       NULL);
 799
 800   g_free (uri);
 801 }
 802
 803 static gboolean
 804 hash_job_done (gpointer user_data)
 805 {
 806   HashingData *hash_data = user_data;
 807   EmpathyFTHandler *handler = hash_data->handler;
 808   EmpathyFTHandlerPriv *priv;
 809   GError *error = NULL;
 810
 811   DEBUG ("Closing stream after hashing.");
 812
 813   priv = GET_PRIV (handler);
 814
 815   if (hash_data->error != NULL)
 816     {
 817       error = hash_data->error;
 818       hash_data->error = NULL;
 819       goto cleanup;
 820     }
 821
 822   DEBUG ("Got file hash %s", g_checksum_get_string (hash_data->checksum));
 823
 824   if (empathy_ft_handler_is_incoming (handler))
 825     {
 826       if (g_strcmp0 (g_checksum_get_string (hash_data->checksum),
 827                      priv->content_hash))
 828         {
 829           DEBUG ("Hash mismatch when checking incoming handler: "
 830                  "received %s, calculated %s", priv->content_hash,
 831                  g_checksum_get_string (hash_data->checksum));
 832
 833           error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
 834               EMPATHY_FT_ERROR_HASH_MISMATCH,
 835               _("File transfer completed, but the file was corrupted"));
 836           goto cleanup;
 837         }
 838       else
 839         {
 840           DEBUG ("Hash verification matched, received %s, calculated %s",
 841                  priv->content_hash,
 842                  g_checksum_get_string (hash_data->checksum));
 843         }
 844     }
 845   else
 846     {
 847       /* set the checksum in the request...
 848        * org.freedesktop.Telepathy.Channel.Type.FileTransfer.ContentHash
 849        */
 850       tp_asv_set_string (priv->request,
 851           TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_HASH,
 852           g_checksum_get_string (hash_data->checksum));
 853     }
 854
 855 cleanup:
 856
 857   if (error != NULL)
 858     {
 859       emit_error_signal (handler, error);
 860       g_clear_error (&error);
 861     }
 862   else
 863     {
 864       g_signal_emit (handler, signals[HASHING_DONE], 0);
 865
 866       if (!empathy_ft_handler_is_incoming (handler))
 867         /* the request is complete now, push it to the dispatcher */
 868         ft_handler_push_to_dispatcher (handler);
 869     }
 870
 871   hash_data_free (hash_data);
 872
 873   return FALSE;
 874 }
 875
 876 static gboolean
 877 emit_hashing_progress (gpointer user_data)
 878 {
 879   HashingData *hash_data = user_data;
 880
 881   g_signal_emit (hash_data->handler, signals[HASHING_PROGRESS], 0,
 882       (guint64) hash_data->total_read, (guint64) hash_data->total_bytes);
 883
 884   return FALSE;
 885 }
 886
 887 static gboolean
 888 do_hash_job (GIOSchedulerJob *job,
 889     GCancellable *cancellable,
 890     gpointer user_data)
 891 {
 892   HashingData *hash_data = user_data;
 893   gssize bytes_read;
 894   EmpathyFTHandlerPriv *priv;
 895   GError *error = NULL;
 896
 897   priv = GET_PRIV (hash_data->handler);
 898
 899 again:
 900   if (hash_data->buffer == NULL)
 901     hash_data->buffer = g_malloc0 (BUFFER_SIZE);
 902
 903   bytes_read = g_input_stream_read (hash_data->stream, hash_data->buffer,
 904                                     BUFFER_SIZE, cancellable, &error);
 905   if (error != NULL)
 906     goto out;
 907
 908   hash_data->total_read += bytes_read;
 909
 910   /* we now have the chunk */
 911   if (bytes_read > 0)
 912     {
 913       g_checksum_update (hash_data->checksum, hash_data->buffer, bytes_read);
 914       g_io_scheduler_job_send_to_mainloop_async (job, emit_hashing_progress,
 915           hash_data, NULL);
 916
 917       g_free (hash_data->buffer);
 918       hash_data->buffer = NULL;
 919
 920       goto again;
 921     }
 922   else
 923   {
 924     g_input_stream_close (hash_data->stream, cancellable, &error);
 925   }
 926
 927 out:
 928   if (error != NULL)
 929     hash_data->error = error;
 930
 931   g_io_scheduler_job_send_to_mainloop_async (job, hash_job_done,
 932       hash_data, NULL);
 933
 934   return FALSE;
 935 }
 936
 937 static gboolean
 938 do_hash_job_incoming (GIOSchedulerJob *job,
 939     GCancellable *cancellable,
 940     gpointer user_data)
 941 {
 942   HashingData *hash_data = user_data;
 943   EmpathyFTHandler *handler = hash_data->handler;
 944   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 945   GError *error = NULL;
 946
 947   DEBUG ("checking integrity for incoming handler");
 948
 949   /* need to get the stream first */
 950   hash_data->stream =
 951     G_INPUT_STREAM (g_file_read (priv->gfile, cancellable, &error));
 952
 953   if (error != NULL)
 954     {
 955       hash_data->error = error;
 956       g_io_scheduler_job_send_to_mainloop_async (job, hash_job_done,
 957           hash_data, NULL);
 958       return FALSE;
 959     }
 960
 961   return do_hash_job (job, cancellable, user_data);
 962 }
 963
 964 static void
 965 ft_handler_read_async_cb (GObject *source,
 966     GAsyncResult *res,
 967     gpointer user_data)
 968 {
 969   GFileInputStream *stream;
 970   GError *error = NULL;
 971   HashingData *hash_data;
 972   EmpathyFTHandler *handler = user_data;
 973   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 974
 975   DEBUG ("GFile read async CB.");
 976
 977   stream = g_file_read_finish (priv->gfile, res, &error);
 978   if (error != NULL)
 979     {
 980       emit_error_signal (handler, error);
 981       g_clear_error (&error);
 982
 983       return;
 984     }
 985
 986   hash_data = g_slice_new0 (HashingData);
 987   hash_data->stream = G_INPUT_STREAM (stream);
 988   hash_data->total_bytes = priv->total_bytes;
 989   hash_data->handler = g_object_ref (handler);
 990   /* FIXME: MD5 is the only ContentHashType supported right now */
 991   hash_data->checksum = g_checksum_new (G_CHECKSUM_MD5);
 992
 993   tp_asv_set_uint32 (priv->request,
 994       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_HASH_TYPE,
 995       TP_FILE_HASH_TYPE_MD5);
 996
 997   g_signal_emit (handler, signals[HASHING_STARTED], 0);
 998
 999   g_io_scheduler_push_job (do_hash_job, hash_data, NULL,
1000       G_PRIORITY_DEFAULT, priv->cancellable);
1001 }
1002
1003 static void
1004 callbacks_data_free (gpointer user_data)
1005 {
1006   CallbacksData *data = user_data;
1007
1008   if (data->handler != NULL)
1009     g_object_unref (data->handler);
1010
1011   g_slice_free (CallbacksData, data);
1012 }
1013
1014 static gboolean
1015 set_content_hash_type_from_classes (EmpathyFTHandler *handler,
1016     GPtrArray *classes)
1017 {
1018   GArray *possible_values;
1019   guint value;
1020   gboolean valid;
1021   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1022   gboolean support_ft = FALSE;
1023   guint i;
1024
1025   possible_values = g_array_new (TRUE, TRUE, sizeof (guint));
1026
1027   for (i = 0; i < classes->len; i++)
1028     {
1029       GHashTable *fixed;
1030       GStrv allowed;
1031       const gchar *chan_type;
1032
1033       tp_value_array_unpack (g_ptr_array_index (classes, i), 2,
1034           &fixed, &allowed);
1035
1036       chan_type = tp_asv_get_string (fixed, TP_PROP_CHANNEL_CHANNEL_TYPE);
1037
1038       if (tp_strdiff (chan_type, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER))
1039         continue;
1040
1041       if (tp_asv_get_uint32 (fixed, TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, NULL) !=
1042           TP_HANDLE_TYPE_CONTACT)
1043         continue;
1044
1045       support_ft = TRUE;
1046
1047       value = tp_asv_get_uint32
1048         (fixed, TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_HASH_TYPE,
1049          &valid);
1050
1051       if (valid)
1052         g_array_append_val (possible_values, value);
1053     }
1054
1055   if (!support_ft)
1056     {
1057       g_array_free (possible_values, TRUE);
1058       return FALSE;
1059     }
1060
1061   if (possible_values->len == 0)
1062     {
1063       /* there are no channel classes with hash support, disable it. */
1064       priv->use_hash = FALSE;
1065       priv->content_hash_type = TP_FILE_HASH_TYPE_NONE;
1066
1067       goto out;
1068     }
1069
1070   priv->use_hash = TRUE;
1071
1072   if (possible_values->len == 1)
1073     {
1074       priv->content_hash_type = g_array_index (possible_values, guint, 0);
1075     }
1076   else
1077     {
1078       /* order the array and pick the first non zero, so that MD5
1079        * is the preferred value.
1080        */
1081       g_array_sort (possible_values, empathy_uint_compare);
1082
1083       if (g_array_index (possible_values, guint, 0) == 0)
1084         priv->content_hash_type = g_array_index (possible_values, guint, 1);
1085       else
1086         priv->content_hash_type = g_array_index (possible_values, guint, 0);
1087     }
1088
1089 out:
1090   g_array_free (possible_values, TRUE);
1091
1092   DEBUG ("Hash enabled %s; setting content hash type as %u",
1093          priv->use_hash ? "True" : "False", priv->content_hash_type);
1094
1095   return TRUE;
1096 }
1097
1098 static void
1099 conn_prepared_cb (GObject *conn,
1100     GAsyncResult *result,
1101     gpointer user_data)
1102 {
1103   CallbacksData *data = user_data;
1104   EmpathyFTHandler *handler = data->handler;
1105   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1106   GError *myerr = NULL;
1107   TpCapabilities *caps;
1108   GPtrArray *classes;
1109
1110   if (!tp_proxy_prepare_finish (conn, result, &myerr))
1111     {
1112       DEBUG ("Failed to prepare connection: %s", myerr->message);
1113
1114       data->callback (handler, myerr, data->user_data);
1115       goto out;
1116     }
1117
1118   caps = tp_connection_get_capabilities (TP_CONNECTION (conn));
1119   classes = tp_capabilities_get_channel_classes (caps);
1120
1121   /* set whether we support hash and the type of it */
1122   if (!set_content_hash_type_from_classes (handler, classes))
1123     {
1124       g_set_error_literal (&myerr, EMPATHY_FT_ERROR_QUARK,
1125           EMPATHY_FT_ERROR_NOT_SUPPORTED,
1126           _("File transfer not supported by remote contact"));
1127
1128       if (!g_cancellable_is_cancelled (priv->cancellable))
1129         g_cancellable_cancel (priv->cancellable);
1130
1131       data->callback (handler, myerr, data->user_data);
1132       g_clear_error (&myerr);
1133     }
1134   else
1135     {
1136       /* get back to the caller now */
1137       data->callback (handler, NULL, data->user_data);
1138     }
1139
1140 out:
1141   callbacks_data_free (data);
1142 }
1143
1144 static void
1145 ft_handler_complete_request (EmpathyFTHandler *handler)
1146 {
1147   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1148
1149   /* populate the request table with all the known properties */
1150   ft_handler_populate_outgoing_request (handler);
1151
1152   if (priv->use_hash)
1153     /* start hashing the file */
1154     g_file_read_async (priv->gfile, G_PRIORITY_DEFAULT,
1155         priv->cancellable, ft_handler_read_async_cb, handler);
1156   else
1157     /* push directly the handler to the dispatcher */
1158     ft_handler_push_to_dispatcher (handler);
1159 }
1160
1161 static void
1162 ft_handler_gfile_ready_cb (GObject *source,
1163     GAsyncResult *res,
1164     CallbacksData *cb_data)
1165 {
1166   GFileInfo *info;
1167   GError *error = NULL;
1168   GTimeVal mtime;
1169   EmpathyFTHandlerPriv *priv = GET_PRIV (cb_data->handler);
1170
1171   DEBUG ("Got GFileInfo.");
1172
1173   info = g_file_query_info_finish (priv->gfile, res, &error);
1174
1175   if (error != NULL)
1176     goto out;
1177
1178   if (g_file_info_get_file_type (info) != G_FILE_TYPE_REGULAR)
1179     {
1180       error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
1181           EMPATHY_FT_ERROR_INVALID_SOURCE_FILE,
1182           _("The selected file is not a regular file"));
1183       goto out;
1184     }
1185
1186   priv->total_bytes = g_file_info_get_size (info);
1187   if (priv->total_bytes == 0)
1188     {
1189       error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
1190           EMPATHY_FT_ERROR_EMPTY_SOURCE_FILE,
1191           _("The selected file is empty"));
1192       goto out;
1193     }
1194
1195   priv->content_type = g_strdup (g_file_info_get_content_type (info));
1196   priv->filename = g_strdup (g_file_info_get_display_name (info));
1197   g_file_info_get_modification_time (info, &mtime);
1198   priv->mtime = mtime.tv_sec;
1199   priv->transferred_bytes = 0;
1200   priv->description = NULL;
1201
1202   g_object_unref (info);
1203
1204 out:
1205   if (error != NULL)
1206     {
1207       if (!g_cancellable_is_cancelled (priv->cancellable))
1208         g_cancellable_cancel (priv->cancellable);
1209
1210       cb_data->callback (cb_data->handler, error, cb_data->user_data);
1211       g_error_free (error);
1212
1213       callbacks_data_free (cb_data);
1214     }
1215   else
1216     {
1217       /* see if FT/hashing are allowed */
1218       TpConnection *connection;
1219       GQuark features[] = { TP_CONNECTION_FEATURE_CAPABILITIES, 0 };
1220
1221       connection = empathy_contact_get_connection (priv->contact);
1222       g_assert (connection != NULL);
1223
1224       tp_proxy_prepare_async (connection, features,
1225           conn_prepared_cb, cb_data);
1226     }
1227 }
1228
1229 static void
1230 contact_factory_contact_cb (TpConnection *connection,
1231     EmpathyContact *contact,
1232     const GError *error,
1233     gpointer user_data,
1234     GObject *weak_object)
1235 {
1236   CallbacksData *cb_data = user_data;
1237   EmpathyFTHandler *handler = EMPATHY_FT_HANDLER (weak_object);
1238   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1239
1240   if (error != NULL)
1241     {
1242       if (!g_cancellable_is_cancelled (priv->cancellable))
1243         g_cancellable_cancel (priv->cancellable);
1244
1245       cb_data->callback (handler, (GError *) error, cb_data->user_data);
1246       callbacks_data_free (cb_data);
1247       return;
1248     }
1249
1250   priv->contact = g_object_ref (contact);
1251
1252   cb_data->callback (handler, NULL, cb_data->user_data);
1253 }
1254
1255 static void
1256 channel_get_all_properties_cb (TpProxy *proxy,
1257     GHashTable *properties,
1258     const GError *error,
1259     gpointer user_data,
1260     GObject *weak_object)
1261 {
1262   CallbacksData *cb_data = user_data;
1263   EmpathyFTHandler *handler = EMPATHY_FT_HANDLER (weak_object);
1264   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1265   TpHandle c_handle;
1266
1267   if (error != NULL)
1268     {
1269       if (!g_cancellable_is_cancelled (priv->cancellable))
1270         g_cancellable_cancel (priv->cancellable);
1271
1272       cb_data->callback (handler, (GError *) error, cb_data->user_data);
1273
1274       callbacks_data_free (cb_data);
1275       return;
1276     }
1277
1278   priv->total_bytes = g_value_get_uint64 (
1279       g_hash_table_lookup (properties, "Size"));
1280
1281   priv->transferred_bytes = g_value_get_uint64 (
1282       g_hash_table_lookup (properties, "TransferredBytes"));
1283
1284   priv->filename = g_value_dup_string (
1285       g_hash_table_lookup (properties, "Filename"));
1286
1287   priv->content_hash = g_value_dup_string (
1288       g_hash_table_lookup (properties, "ContentHash"));
1289
1290   priv->content_hash_type = g_value_get_uint (
1291       g_hash_table_lookup (properties, "ContentHashType"));
1292
1293   priv->content_type = g_value_dup_string (
1294       g_hash_table_lookup (properties, "ContentType"));
1295
1296   priv->description = g_value_dup_string (
1297       g_hash_table_lookup (properties, "Description"));
1298
1299   c_handle = tp_channel_get_handle (TP_CHANNEL (proxy), NULL);
1300   empathy_tp_contact_factory_get_from_handle (
1301       tp_channel_borrow_connection (TP_CHANNEL (proxy)), c_handle,
1302       contact_factory_contact_cb, cb_data, callbacks_data_free,
1303       G_OBJECT (handler));
1304 }
1305
1306 /* public methods */
1307
1308 /**
1309  * empathy_ft_handler_new_outgoing:
1310  * @contact: the #EmpathyContact to send @source to
1311  * @source: the #GFile to send
1312  * @callback: callback to be called when the handler has been created
1313  * @user_data: user data to be passed to @callback
1314  *
1315  * Triggers the creation of a new #EmpathyFTHandler for an outgoing transfer.
1316  */
1317 void
1318 empathy_ft_handler_new_outgoing (EmpathyContact *contact,
1319     GFile *source,
1320     EmpathyFTHandlerReadyCallback callback,
1321     gpointer user_data)
1322 {
1323   EmpathyFTHandler *handler;
1324   CallbacksData *data;
1325   EmpathyFTHandlerPriv *priv;
1326
1327   DEBUG ("New handler outgoing");
1328
1329   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
1330   g_return_if_fail (G_IS_FILE (source));
1331
1332   handler = g_object_new (EMPATHY_TYPE_FT_HANDLER,
1333       "contact", contact, "gfile", source, NULL);
1334
1335   priv = GET_PRIV (handler);
1336
1337   data = g_slice_new0 (CallbacksData);
1338   data->callback = callback;
1339   data->user_data = user_data;
1340   data->handler = g_object_ref (handler);
1341
1342   /* start collecting info about the file */
1343   g_file_query_info_async (priv->gfile,
1344       G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME ","
1345       G_FILE_ATTRIBUTE_STANDARD_SIZE ","
1346       G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE ","
1347       G_FILE_ATTRIBUTE_STANDARD_TYPE ","
1348       G_FILE_ATTRIBUTE_TIME_MODIFIED,
1349       G_FILE_QUERY_INFO_NONE, G_PRIORITY_DEFAULT,
1350       NULL, (GAsyncReadyCallback) ft_handler_gfile_ready_cb, data);
1351 }
1352
1353 /**
1354  * empathy_ft_handler_new_incoming:
1355  * @tp_file: the #EmpathyTpFile wrapping the incoming channel
1356  * @callback: callback to be called when the handler has been created
1357  * @user_data: user data to be passed to @callback
1358  *
1359  * Triggers the creation of a new #EmpathyFTHandler for an incoming transfer.
1360  * Note that for the handler to be useful, you will have to set a destination
1361  * file with empathy_ft_handler_incoming_set_destination() after the handler
1362  * is ready.
1363  */
1364 void
1365 empathy_ft_handler_new_incoming (EmpathyTpFile *tp_file,
1366     EmpathyFTHandlerReadyCallback callback,
1367     gpointer user_data)
1368 {
1369   EmpathyFTHandler *handler;
1370   TpChannel *channel;
1371   CallbacksData *data;
1372
1373   g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
1374
1375   handler = g_object_new (EMPATHY_TYPE_FT_HANDLER,
1376       "tp-file", tp_file, NULL);
1377
1378   g_object_get (tp_file, "channel", &channel, NULL);
1379
1380   data = g_slice_new0 (CallbacksData);
1381   data->callback = callback;
1382   data->user_data = user_data;
1383   data->handler = g_object_ref (handler);
1384
1385   tp_cli_dbus_properties_call_get_all (channel,
1386       -1, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER,
1387       channel_get_all_properties_cb, data, NULL, G_OBJECT (handler));
1388 }
1389
1390 /**
1391  * empathy_ft_handler_start_transfer:
1392  * @handler: an #EmpathyFTHandler
1393  *
1394  * Starts the transfer machinery. After this call, the transfer and hashing
1395  * signals will be emitted by the handler.
1396  */
1397 void
1398 empathy_ft_handler_start_transfer (EmpathyFTHandler *handler)
1399 {
1400   EmpathyFTHandlerPriv *priv;
1401
1402   g_return_if_fail (EMPATHY_IS_FT_HANDLER (handler));
1403
1404   priv = GET_PRIV (handler);
1405
1406   if (priv->tpfile == NULL)
1407     {
1408       ft_handler_complete_request (handler);
1409     }
1410   else
1411     {
1412       /* TODO: add support for resume. */
1413       empathy_tp_file_accept (priv->tpfile, 0, priv->gfile, priv->cancellable,
1414           ft_transfer_progress_callback, handler,
1415           ft_transfer_operation_callback, handler);
1416     }
1417 }
1418
1419 /**
1420  * empathy_ft_handler_cancel_transfer:
1421  * @handler: an #EmpathyFTHandler
1422  *
1423  * Cancels an ongoing handler operation. Note that this doesn't destroy
1424  * the object, which will keep all the properties, altough it won't be able
1425  * to do any more I/O.
1426  */
1427 void
1428 empathy_ft_handler_cancel_transfer (EmpathyFTHandler *handler)
1429 {
1430   EmpathyFTHandlerPriv *priv;
1431
1432   g_return_if_fail (EMPATHY_IS_FT_HANDLER (handler));
1433
1434   priv = GET_PRIV (handler);
1435
1436   /* if we don't have an EmpathyTpFile, we are hashing, so
1437    * we can just cancel the GCancellable to stop it.
1438    */
1439   if (priv->tpfile == NULL)
1440     g_cancellable_cancel (priv->cancellable);
1441   else
1442     empathy_tp_file_cancel (priv->tpfile);
1443 }
1444
1445 /**
1446  * empathy_ft_handler_incoming_set_destination:
1447  * @handler: an #EmpathyFTHandler
1448  * @destination: the #GFile where the transfer should be saved
1449  *
1450  * Sets the destination of the incoming handler to be @destination.
1451  * Note that calling this method is mandatory before starting the transfer
1452  * for incoming handlers.
1453  */
1454 void
1455 empathy_ft_handler_incoming_set_destination (EmpathyFTHandler *handler,
1456     GFile *destination)
1457 {
1458   EmpathyFTHandlerPriv *priv;
1459
1460   g_return_if_fail (EMPATHY_IS_FT_HANDLER (handler));
1461   g_return_if_fail (G_IS_FILE (destination));
1462
1463   priv = GET_PRIV (handler);
1464
1465   g_object_set (handler, "gfile", destination, NULL);
1466
1467   /* check if hash is supported. if it isn't, set use_hash to FALSE
1468    * anyway, so that clients won't be expecting us to checksum.
1469    */
1470   if (EMP_STR_EMPTY (priv->content_hash) ||
1471       priv->content_hash_type == TP_FILE_HASH_TYPE_NONE)
1472     priv->use_hash = FALSE;
1473   else
1474     priv->use_hash = TRUE;
1475 }
1476
1477 /**
1478  * empathy_ft_handler_get_filename:
1479  * @handler: an #EmpathyFTHandler
1480  *
1481  * Returns the name of the file being transferred.
1482  *
1483  * Return value: the name of the file being transferred
1484  */
1485 const char *
1486 empathy_ft_handler_get_filename (EmpathyFTHandler *handler)
1487 {
1488   EmpathyFTHandlerPriv *priv;
1489
1490   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), NULL);
1491
1492   priv = GET_PRIV (handler);
1493
1494   return priv->filename;
1495 }
1496
1497 /**
1498  * empathy_ft_handler_get_content_type:
1499  * @handler: an #EmpathyFTHandler
1500  *
1501  * Returns the content type of the file being transferred.
1502  *
1503  * Return value: the content type of the file being transferred
1504  */
1505 const char *
1506 empathy_ft_handler_get_content_type (EmpathyFTHandler *handler)
1507 {
1508   EmpathyFTHandlerPriv *priv;
1509
1510   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), NULL);
1511
1512   priv = GET_PRIV (handler);
1513
1514   return priv->content_type;
1515 }
1516
1517 /**
1518  * empathy_ft_handler_get_contact:
1519  * @handler: an #EmpathyFTHandler
1520  *
1521  * Returns the remote #EmpathyContact at the other side of the transfer.
1522  *
1523  * Return value: the remote #EmpathyContact for @handler
1524  */
1525 EmpathyContact *
1526 empathy_ft_handler_get_contact (EmpathyFTHandler *handler)
1527 {
1528   EmpathyFTHandlerPriv *priv;
1529
1530   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), NULL);
1531
1532   priv = GET_PRIV (handler);
1533
1534   return priv->contact;
1535 }
1536
1537 /**
1538  * empathy_ft_handler_get_gfile:
1539  * @handler: an #EmpathyFTHandler
1540  *
1541  * Returns the #GFile where the transfer is being read/saved.
1542  *
1543  * Return value: the #GFile where the transfer is being read/saved
1544  */
1545 GFile *
1546 empathy_ft_handler_get_gfile (EmpathyFTHandler *handler)
1547 {
1548   EmpathyFTHandlerPriv *priv;
1549
1550   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), NULL);
1551
1552   priv = GET_PRIV (handler);
1553
1554   return priv->gfile;
1555 }
1556
1557 /**
1558  * empathy_ft_handler_get_use_hash:
1559  * @handler: an #EmpathyFTHandler
1560  *
1561  * Returns whether @handler has checksumming enabled. This can depend on
1562  * the CM and the remote contact capabilities.
1563  *
1564  * Return value: %TRUE if the handler has checksumming enabled,
1565  * %FALSE otherwise.
1566  */
1567 gboolean
1568 empathy_ft_handler_get_use_hash (EmpathyFTHandler *handler)
1569 {
1570   EmpathyFTHandlerPriv *priv;
1571
1572   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), FALSE);
1573
1574   priv = GET_PRIV (handler);
1575
1576   return priv->use_hash;
1577 }
1578
1579 /**
1580  * empathy_ft_handler_is_incoming:
1581  * @handler: an #EmpathyFTHandler
1582  *
1583  * Returns whether @handler is incoming or outgoing.
1584  *
1585  * Return value: %TRUE if the handler is incoming, %FALSE otherwise.
1586  */
1587 gboolean
1588 empathy_ft_handler_is_incoming (EmpathyFTHandler *handler)
1589 {
1590   EmpathyFTHandlerPriv *priv;
1591
1592   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), FALSE);
1593
1594   priv = GET_PRIV (handler);
1595
1596   if (priv->tpfile == NULL)
1597     return FALSE;
1598
1599   return empathy_tp_file_is_incoming (priv->tpfile);
1600 }
1601
1602 /**
1603  * empathy_ft_handler_get_transferred_bytes:
1604  * @handler: an #EmpathyFTHandler
1605  *
1606  * Returns the number of bytes already transferred by the handler.
1607  *
1608  * Return value: the number of bytes already transferred by the handler.
1609  */
1610 guint64
1611 empathy_ft_handler_get_transferred_bytes (EmpathyFTHandler *handler)
1612 {
1613   EmpathyFTHandlerPriv *priv;
1614
1615   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), 0);
1616
1617   priv = GET_PRIV (handler);
1618
1619   return priv->transferred_bytes;
1620 }
1621
1622 /**
1623  * empathy_ft_handler_get_total_bytes:
1624  * @handler: an #EmpathyFTHandler
1625  *
1626  * Returns the total size of the file being transferred by the handler.
1627  *
1628  * Return value: a number of bytes indicating the total size of the file being
1629  * transferred by the handler.
1630  */
1631 guint64
1632 empathy_ft_handler_get_total_bytes (EmpathyFTHandler *handler)
1633 {
1634   EmpathyFTHandlerPriv *priv;
1635
1636   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), 0);
1637
1638   priv = GET_PRIV (handler);
1639
1640   return priv->total_bytes;
1641 }
1642
1643 /**
1644  * empathy_ft_handler_is_completed:
1645  * @handler: an #EmpathyFTHandler
1646  *
1647  * Returns whether the transfer for @handler has been completed succesfully.
1648  *
1649  * Return value: %TRUE if the handler has been transferred correctly, %FALSE
1650  * otherwise
1651  */
1652 gboolean
1653 empathy_ft_handler_is_completed (EmpathyFTHandler *handler)
1654 {
1655   EmpathyFTHandlerPriv *priv;
1656
1657   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), FALSE);
1658
1659   priv = GET_PRIV (handler);
1660
1661   return priv->is_completed;
1662 }
1663
1664 /**
1665  * empathy_ft_handler_is_cancelled:
1666  * @handler: an #EmpathyFTHandler
1667  *
1668  * Returns whether the transfer for @handler has been cancelled or has stopped
1669  * due to an error.
1670  *
1671  * Return value: %TRUE if the transfer for @handler has been cancelled
1672  * or has stopped due to an error, %FALSE otherwise.
1673  */
1674 gboolean
1675 empathy_ft_handler_is_cancelled (EmpathyFTHandler *handler)
1676 {
1677   EmpathyFTHandlerPriv *priv;
1678
1679   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), FALSE);
1680
1681   priv = GET_PRIV (handler);
1682
1683   return g_cancellable_is_cancelled (priv->cancellable);
1684 }