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
 778   contact_handle = empathy_contact_get_handle (priv->contact);
 779
 780   priv->request = tp_asv_new (
 781       TP_PROP_CHANNEL_CHANNEL_TYPE, G_TYPE_STRING,
 782         TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER,
 783       TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, G_TYPE_UINT,
 784         TP_HANDLE_TYPE_CONTACT,
 785       TP_PROP_CHANNEL_TARGET_HANDLE, G_TYPE_UINT,
 786         contact_handle,
 787       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_TYPE, G_TYPE_STRING,
 788         priv->content_type,
 789       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_FILENAME, G_TYPE_STRING,
 790         priv->filename,
 791       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_SIZE, G_TYPE_UINT64,
 792         priv->total_bytes,
 793       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_DATE, G_TYPE_UINT64,
 794         priv->mtime,
 795       NULL);
 796 }
 797
 798 static gboolean
 799 hash_job_done (gpointer user_data)
 800 {
 801   HashingData *hash_data = user_data;
 802   EmpathyFTHandler *handler = hash_data->handler;
 803   EmpathyFTHandlerPriv *priv;
 804   GError *error = NULL;
 805
 806   DEBUG ("Closing stream after hashing.");
 807
 808   priv = GET_PRIV (handler);
 809
 810   if (hash_data->error != NULL)
 811     {
 812       error = hash_data->error;
 813       hash_data->error = NULL;
 814       goto cleanup;
 815     }
 816
 817   DEBUG ("Got file hash %s", g_checksum_get_string (hash_data->checksum));
 818
 819   if (empathy_ft_handler_is_incoming (handler))
 820     {
 821       if (g_strcmp0 (g_checksum_get_string (hash_data->checksum),
 822                      priv->content_hash))
 823         {
 824           DEBUG ("Hash mismatch when checking incoming handler: "
 825                  "received %s, calculated %s", priv->content_hash,
 826                  g_checksum_get_string (hash_data->checksum));
 827
 828           error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
 829               EMPATHY_FT_ERROR_HASH_MISMATCH,
 830               _("File transfer completed, but the file was corrupted"));
 831           goto cleanup;
 832         }
 833       else
 834         {
 835           DEBUG ("Hash verification matched, received %s, calculated %s",
 836                  priv->content_hash,
 837                  g_checksum_get_string (hash_data->checksum));
 838         }
 839     }
 840   else
 841     {
 842       /* set the checksum in the request...
 843        * org.freedesktop.Telepathy.Channel.Type.FileTransfer.ContentHash
 844        */
 845       tp_asv_set_string (priv->request,
 846           TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_HASH,
 847           g_checksum_get_string (hash_data->checksum));
 848     }
 849
 850 cleanup:
 851
 852   if (error != NULL)
 853     {
 854       emit_error_signal (handler, error);
 855       g_clear_error (&error);
 856     }
 857   else
 858     {
 859       g_signal_emit (handler, signals[HASHING_DONE], 0);
 860
 861       if (!empathy_ft_handler_is_incoming (handler))
 862         /* the request is complete now, push it to the dispatcher */
 863         ft_handler_push_to_dispatcher (handler);
 864     }
 865
 866   hash_data_free (hash_data);
 867
 868   return FALSE;
 869 }
 870
 871 static gboolean
 872 emit_hashing_progress (gpointer user_data)
 873 {
 874   HashingData *hash_data = user_data;
 875
 876   g_signal_emit (hash_data->handler, signals[HASHING_PROGRESS], 0,
 877       (guint64) hash_data->total_read, (guint64) hash_data->total_bytes);
 878
 879   return FALSE;
 880 }
 881
 882 static gboolean
 883 do_hash_job (GIOSchedulerJob *job,
 884     GCancellable *cancellable,
 885     gpointer user_data)
 886 {
 887   HashingData *hash_data = user_data;
 888   gssize bytes_read;
 889   EmpathyFTHandlerPriv *priv;
 890   GError *error = NULL;
 891
 892   priv = GET_PRIV (hash_data->handler);
 893
 894 again:
 895   if (hash_data->buffer == NULL)
 896     hash_data->buffer = g_malloc0 (BUFFER_SIZE);
 897
 898   bytes_read = g_input_stream_read (hash_data->stream, hash_data->buffer,
 899                                     BUFFER_SIZE, cancellable, &error);
 900   if (error != NULL)
 901     goto out;
 902
 903   hash_data->total_read += bytes_read;
 904
 905   /* we now have the chunk */
 906   if (bytes_read > 0)
 907     {
 908       g_checksum_update (hash_data->checksum, hash_data->buffer, bytes_read);
 909       g_io_scheduler_job_send_to_mainloop_async (job, emit_hashing_progress,
 910           hash_data, NULL);
 911
 912       g_free (hash_data->buffer);
 913       hash_data->buffer = NULL;
 914
 915       goto again;
 916     }
 917   else
 918   {
 919     g_input_stream_close (hash_data->stream, cancellable, &error);
 920   }
 921
 922 out:
 923   if (error != NULL)
 924     hash_data->error = error;
 925
 926   g_io_scheduler_job_send_to_mainloop_async (job, hash_job_done,
 927       hash_data, NULL);
 928
 929   return FALSE;
 930 }
 931
 932 static gboolean
 933 do_hash_job_incoming (GIOSchedulerJob *job,
 934     GCancellable *cancellable,
 935     gpointer user_data)
 936 {
 937   HashingData *hash_data = user_data;
 938   EmpathyFTHandler *handler = hash_data->handler;
 939   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 940   GError *error = NULL;
 941
 942   DEBUG ("checking integrity for incoming handler");
 943
 944   /* need to get the stream first */
 945   hash_data->stream =
 946     G_INPUT_STREAM (g_file_read (priv->gfile, cancellable, &error));
 947
 948   if (error != NULL)
 949     {
 950       hash_data->error = error;
 951       g_io_scheduler_job_send_to_mainloop_async (job, hash_job_done,
 952           hash_data, NULL);
 953       return FALSE;
 954     }
 955
 956   return do_hash_job (job, cancellable, user_data);
 957 }
 958
 959 static void
 960 ft_handler_read_async_cb (GObject *source,
 961     GAsyncResult *res,
 962     gpointer user_data)
 963 {
 964   GFileInputStream *stream;
 965   GError *error = NULL;
 966   HashingData *hash_data;
 967   EmpathyFTHandler *handler = user_data;
 968   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
 969
 970   DEBUG ("GFile read async CB.");
 971
 972   stream = g_file_read_finish (priv->gfile, res, &error);
 973   if (error != NULL)
 974     {
 975       emit_error_signal (handler, error);
 976       g_clear_error (&error);
 977
 978       return;
 979     }
 980
 981   hash_data = g_slice_new0 (HashingData);
 982   hash_data->stream = G_INPUT_STREAM (stream);
 983   hash_data->total_bytes = priv->total_bytes;
 984   hash_data->handler = g_object_ref (handler);
 985   /* FIXME: MD5 is the only ContentHashType supported right now */
 986   hash_data->checksum = g_checksum_new (G_CHECKSUM_MD5);
 987
 988   tp_asv_set_uint32 (priv->request,
 989       TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_HASH_TYPE,
 990       TP_FILE_HASH_TYPE_MD5);
 991
 992   g_signal_emit (handler, signals[HASHING_STARTED], 0);
 993
 994   g_io_scheduler_push_job (do_hash_job, hash_data, NULL,
 995       G_PRIORITY_DEFAULT, priv->cancellable);
 996 }
 997
 998 static void
 999 callbacks_data_free (gpointer user_data)
1000 {
1001   CallbacksData *data = user_data;
1002
1003   if (data->handler != NULL)
1004     g_object_unref (data->handler);
1005
1006   g_slice_free (CallbacksData, data);
1007 }
1008
1009 static gboolean
1010 set_content_hash_type_from_classes (EmpathyFTHandler *handler,
1011     GPtrArray *classes)
1012 {
1013   GArray *possible_values;
1014   guint value;
1015   gboolean valid;
1016   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1017   gboolean support_ft = FALSE;
1018   guint i;
1019
1020   possible_values = g_array_new (TRUE, TRUE, sizeof (guint));
1021
1022   for (i = 0; i < classes->len; i++)
1023     {
1024       GHashTable *fixed;
1025       GStrv allowed;
1026       const gchar *chan_type;
1027
1028       tp_value_array_unpack (g_ptr_array_index (classes, i), 2,
1029           &fixed, &allowed);
1030
1031       chan_type = tp_asv_get_string (fixed, TP_PROP_CHANNEL_CHANNEL_TYPE);
1032
1033       if (tp_strdiff (chan_type, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER))
1034         continue;
1035
1036       if (tp_asv_get_uint32 (fixed, TP_PROP_CHANNEL_TARGET_HANDLE_TYPE, NULL) !=
1037           TP_HANDLE_TYPE_CONTACT)
1038         continue;
1039
1040       support_ft = TRUE;
1041
1042       value = tp_asv_get_uint32
1043         (fixed, TP_PROP_CHANNEL_TYPE_FILE_TRANSFER_CONTENT_HASH_TYPE,
1044          &valid);
1045
1046       if (valid)
1047         g_array_append_val (possible_values, value);
1048     }
1049
1050   if (!support_ft)
1051     {
1052       g_array_free (possible_values, TRUE);
1053       return FALSE;
1054     }
1055
1056   if (possible_values->len == 0)
1057     {
1058       /* there are no channel classes with hash support, disable it. */
1059       priv->use_hash = FALSE;
1060       priv->content_hash_type = TP_FILE_HASH_TYPE_NONE;
1061
1062       goto out;
1063     }
1064
1065   priv->use_hash = TRUE;
1066
1067   if (possible_values->len == 1)
1068     {
1069       priv->content_hash_type = g_array_index (possible_values, guint, 0);
1070     }
1071   else
1072     {
1073       /* order the array and pick the first non zero, so that MD5
1074        * is the preferred value.
1075        */
1076       g_array_sort (possible_values, empathy_uint_compare);
1077
1078       if (g_array_index (possible_values, guint, 0) == 0)
1079         priv->content_hash_type = g_array_index (possible_values, guint, 1);
1080       else
1081         priv->content_hash_type = g_array_index (possible_values, guint, 0);
1082     }
1083
1084 out:
1085   g_array_free (possible_values, TRUE);
1086
1087   DEBUG ("Hash enabled %s; setting content hash type as %u",
1088          priv->use_hash ? "True" : "False", priv->content_hash_type);
1089
1090   return TRUE;
1091 }
1092
1093 static void
1094 conn_prepared_cb (GObject *conn,
1095     GAsyncResult *result,
1096     gpointer user_data)
1097 {
1098   CallbacksData *data = user_data;
1099   EmpathyFTHandler *handler = data->handler;
1100   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1101   GError *myerr = NULL;
1102   TpCapabilities *caps;
1103   GPtrArray *classes;
1104
1105   if (!tp_proxy_prepare_finish (conn, result, &myerr))
1106     {
1107       DEBUG ("Failed to prepare connection: %s", myerr->message);
1108
1109       data->callback (handler, myerr, data->user_data);
1110       goto out;
1111     }
1112
1113   caps = tp_connection_get_capabilities (TP_CONNECTION (conn));
1114   classes = tp_capabilities_get_channel_classes (caps);
1115
1116   /* set whether we support hash and the type of it */
1117   if (!set_content_hash_type_from_classes (handler, classes))
1118     {
1119       g_set_error_literal (&myerr, EMPATHY_FT_ERROR_QUARK,
1120           EMPATHY_FT_ERROR_NOT_SUPPORTED,
1121           _("File transfer not supported by remote contact"));
1122
1123       if (!g_cancellable_is_cancelled (priv->cancellable))
1124         g_cancellable_cancel (priv->cancellable);
1125
1126       data->callback (handler, myerr, data->user_data);
1127       g_clear_error (&myerr);
1128     }
1129   else
1130     {
1131       /* get back to the caller now */
1132       data->callback (handler, NULL, data->user_data);
1133     }
1134
1135 out:
1136   callbacks_data_free (data);
1137 }
1138
1139 static void
1140 ft_handler_complete_request (EmpathyFTHandler *handler)
1141 {
1142   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1143
1144   /* populate the request table with all the known properties */
1145   ft_handler_populate_outgoing_request (handler);
1146
1147   if (priv->use_hash)
1148     /* start hashing the file */
1149     g_file_read_async (priv->gfile, G_PRIORITY_DEFAULT,
1150         priv->cancellable, ft_handler_read_async_cb, handler);
1151   else
1152     /* push directly the handler to the dispatcher */
1153     ft_handler_push_to_dispatcher (handler);
1154 }
1155
1156 static void
1157 ft_handler_gfile_ready_cb (GObject *source,
1158     GAsyncResult *res,
1159     CallbacksData *cb_data)
1160 {
1161   GFileInfo *info;
1162   GError *error = NULL;
1163   GTimeVal mtime;
1164   EmpathyFTHandlerPriv *priv = GET_PRIV (cb_data->handler);
1165
1166   DEBUG ("Got GFileInfo.");
1167
1168   info = g_file_query_info_finish (priv->gfile, res, &error);
1169
1170   if (error != NULL)
1171     goto out;
1172
1173   if (g_file_info_get_file_type (info) != G_FILE_TYPE_REGULAR)
1174     {
1175       error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
1176           EMPATHY_FT_ERROR_INVALID_SOURCE_FILE,
1177           _("The selected file is not a regular file"));
1178       goto out;
1179     }
1180
1181   priv->total_bytes = g_file_info_get_size (info);
1182   if (priv->total_bytes == 0)
1183     {
1184       error = g_error_new_literal (EMPATHY_FT_ERROR_QUARK,
1185           EMPATHY_FT_ERROR_EMPTY_SOURCE_FILE,
1186           _("The selected file is empty"));
1187       goto out;
1188     }
1189
1190   priv->content_type = g_strdup (g_file_info_get_content_type (info));
1191   priv->filename = g_strdup (g_file_info_get_display_name (info));
1192   g_file_info_get_modification_time (info, &mtime);
1193   priv->mtime = mtime.tv_sec;
1194   priv->transferred_bytes = 0;
1195   priv->description = NULL;
1196
1197   g_object_unref (info);
1198
1199 out:
1200   if (error != NULL)
1201     {
1202       if (!g_cancellable_is_cancelled (priv->cancellable))
1203         g_cancellable_cancel (priv->cancellable);
1204
1205       cb_data->callback (cb_data->handler, error, cb_data->user_data);
1206       g_error_free (error);
1207
1208       callbacks_data_free (cb_data);
1209     }
1210   else
1211     {
1212       /* see if FT/hashing are allowed */
1213       TpConnection *connection;
1214       GQuark features[] = { TP_CONNECTION_FEATURE_CAPABILITIES, 0 };
1215
1216       connection = empathy_contact_get_connection (priv->contact);
1217       g_assert (connection != NULL);
1218
1219       tp_proxy_prepare_async (connection, features,
1220           conn_prepared_cb, cb_data);
1221     }
1222 }
1223
1224 static void
1225 contact_factory_contact_cb (TpConnection *connection,
1226     EmpathyContact *contact,
1227     const GError *error,
1228     gpointer user_data,
1229     GObject *weak_object)
1230 {
1231   CallbacksData *cb_data = user_data;
1232   EmpathyFTHandler *handler = EMPATHY_FT_HANDLER (weak_object);
1233   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1234
1235   if (error != NULL)
1236     {
1237       if (!g_cancellable_is_cancelled (priv->cancellable))
1238         g_cancellable_cancel (priv->cancellable);
1239
1240       cb_data->callback (handler, (GError *) error, cb_data->user_data);
1241       callbacks_data_free (cb_data);
1242       return;
1243     }
1244
1245   priv->contact = g_object_ref (contact);
1246
1247   cb_data->callback (handler, NULL, cb_data->user_data);
1248 }
1249
1250 static void
1251 channel_get_all_properties_cb (TpProxy *proxy,
1252     GHashTable *properties,
1253     const GError *error,
1254     gpointer user_data,
1255     GObject *weak_object)
1256 {
1257   CallbacksData *cb_data = user_data;
1258   EmpathyFTHandler *handler = EMPATHY_FT_HANDLER (weak_object);
1259   EmpathyFTHandlerPriv *priv = GET_PRIV (handler);
1260   TpHandle c_handle;
1261
1262   if (error != NULL)
1263     {
1264       if (!g_cancellable_is_cancelled (priv->cancellable))
1265         g_cancellable_cancel (priv->cancellable);
1266
1267       cb_data->callback (handler, (GError *) error, cb_data->user_data);
1268
1269       callbacks_data_free (cb_data);
1270       return;
1271     }
1272
1273   priv->total_bytes = g_value_get_uint64 (
1274       g_hash_table_lookup (properties, "Size"));
1275
1276   priv->transferred_bytes = g_value_get_uint64 (
1277       g_hash_table_lookup (properties, "TransferredBytes"));
1278
1279   priv->filename = g_value_dup_string (
1280       g_hash_table_lookup (properties, "Filename"));
1281
1282   priv->content_hash = g_value_dup_string (
1283       g_hash_table_lookup (properties, "ContentHash"));
1284
1285   priv->content_hash_type = g_value_get_uint (
1286       g_hash_table_lookup (properties, "ContentHashType"));
1287
1288   priv->content_type = g_value_dup_string (
1289       g_hash_table_lookup (properties, "ContentType"));
1290
1291   priv->description = g_value_dup_string (
1292       g_hash_table_lookup (properties, "Description"));
1293
1294   c_handle = tp_channel_get_handle (TP_CHANNEL (proxy), NULL);
1295   empathy_tp_contact_factory_get_from_handle (
1296       tp_channel_borrow_connection (TP_CHANNEL (proxy)), c_handle,
1297       contact_factory_contact_cb, cb_data, callbacks_data_free,
1298       G_OBJECT (handler));
1299 }
1300
1301 /* public methods */
1302
1303 /**
1304  * empathy_ft_handler_new_outgoing:
1305  * @contact: the #EmpathyContact to send @source to
1306  * @source: the #GFile to send
1307  * @callback: callback to be called when the handler has been created
1308  * @user_data: user data to be passed to @callback
1309  *
1310  * Triggers the creation of a new #EmpathyFTHandler for an outgoing transfer.
1311  */
1312 void
1313 empathy_ft_handler_new_outgoing (EmpathyContact *contact,
1314     GFile *source,
1315     EmpathyFTHandlerReadyCallback callback,
1316     gpointer user_data)
1317 {
1318   EmpathyFTHandler *handler;
1319   CallbacksData *data;
1320   EmpathyFTHandlerPriv *priv;
1321
1322   DEBUG ("New handler outgoing");
1323
1324   g_return_if_fail (EMPATHY_IS_CONTACT (contact));
1325   g_return_if_fail (G_IS_FILE (source));
1326
1327   handler = g_object_new (EMPATHY_TYPE_FT_HANDLER,
1328       "contact", contact, "gfile", source, NULL);
1329
1330   priv = GET_PRIV (handler);
1331
1332   data = g_slice_new0 (CallbacksData);
1333   data->callback = callback;
1334   data->user_data = user_data;
1335   data->handler = g_object_ref (handler);
1336
1337   /* start collecting info about the file */
1338   g_file_query_info_async (priv->gfile,
1339       G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME ","
1340       G_FILE_ATTRIBUTE_STANDARD_SIZE ","
1341       G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE ","
1342       G_FILE_ATTRIBUTE_STANDARD_TYPE ","
1343       G_FILE_ATTRIBUTE_TIME_MODIFIED,
1344       G_FILE_QUERY_INFO_NONE, G_PRIORITY_DEFAULT,
1345       NULL, (GAsyncReadyCallback) ft_handler_gfile_ready_cb, data);
1346 }
1347
1348 /**
1349  * empathy_ft_handler_new_incoming:
1350  * @tp_file: the #EmpathyTpFile wrapping the incoming channel
1351  * @callback: callback to be called when the handler has been created
1352  * @user_data: user data to be passed to @callback
1353  *
1354  * Triggers the creation of a new #EmpathyFTHandler for an incoming transfer.
1355  * Note that for the handler to be useful, you will have to set a destination
1356  * file with empathy_ft_handler_incoming_set_destination() after the handler
1357  * is ready.
1358  */
1359 void
1360 empathy_ft_handler_new_incoming (EmpathyTpFile *tp_file,
1361     EmpathyFTHandlerReadyCallback callback,
1362     gpointer user_data)
1363 {
1364   EmpathyFTHandler *handler;
1365   TpChannel *channel;
1366   CallbacksData *data;
1367
1368   g_return_if_fail (EMPATHY_IS_TP_FILE (tp_file));
1369
1370   handler = g_object_new (EMPATHY_TYPE_FT_HANDLER,
1371       "tp-file", tp_file, NULL);
1372
1373   g_object_get (tp_file, "channel", &channel, NULL);
1374
1375   data = g_slice_new0 (CallbacksData);
1376   data->callback = callback;
1377   data->user_data = user_data;
1378   data->handler = g_object_ref (handler);
1379
1380   tp_cli_dbus_properties_call_get_all (channel,
1381       -1, TP_IFACE_CHANNEL_TYPE_FILE_TRANSFER,
1382       channel_get_all_properties_cb, data, NULL, G_OBJECT (handler));
1383 }
1384
1385 /**
1386  * empathy_ft_handler_start_transfer:
1387  * @handler: an #EmpathyFTHandler
1388  *
1389  * Starts the transfer machinery. After this call, the transfer and hashing
1390  * signals will be emitted by the handler.
1391  */
1392 void
1393 empathy_ft_handler_start_transfer (EmpathyFTHandler *handler)
1394 {
1395   EmpathyFTHandlerPriv *priv;
1396
1397   g_return_if_fail (EMPATHY_IS_FT_HANDLER (handler));
1398
1399   priv = GET_PRIV (handler);
1400
1401   if (priv->tpfile == NULL)
1402     {
1403       ft_handler_complete_request (handler);
1404     }
1405   else
1406     {
1407       /* TODO: add support for resume. */
1408       empathy_tp_file_accept (priv->tpfile, 0, priv->gfile, priv->cancellable,
1409           ft_transfer_progress_callback, handler,
1410           ft_transfer_operation_callback, handler);
1411     }
1412 }
1413
1414 /**
1415  * empathy_ft_handler_cancel_transfer:
1416  * @handler: an #EmpathyFTHandler
1417  *
1418  * Cancels an ongoing handler operation. Note that this doesn't destroy
1419  * the object, which will keep all the properties, altough it won't be able
1420  * to do any more I/O.
1421  */
1422 void
1423 empathy_ft_handler_cancel_transfer (EmpathyFTHandler *handler)
1424 {
1425   EmpathyFTHandlerPriv *priv;
1426
1427   g_return_if_fail (EMPATHY_IS_FT_HANDLER (handler));
1428
1429   priv = GET_PRIV (handler);
1430
1431   /* if we don't have an EmpathyTpFile, we are hashing, so
1432    * we can just cancel the GCancellable to stop it.
1433    */
1434   if (priv->tpfile == NULL)
1435     g_cancellable_cancel (priv->cancellable);
1436   else
1437     empathy_tp_file_cancel (priv->tpfile);
1438 }
1439
1440 /**
1441  * empathy_ft_handler_incoming_set_destination:
1442  * @handler: an #EmpathyFTHandler
1443  * @destination: the #GFile where the transfer should be saved
1444  *
1445  * Sets the destination of the incoming handler to be @destination.
1446  * Note that calling this method is mandatory before starting the transfer
1447  * for incoming handlers.
1448  */
1449 void
1450 empathy_ft_handler_incoming_set_destination (EmpathyFTHandler *handler,
1451     GFile *destination)
1452 {
1453   EmpathyFTHandlerPriv *priv;
1454
1455   g_return_if_fail (EMPATHY_IS_FT_HANDLER (handler));
1456   g_return_if_fail (G_IS_FILE (destination));
1457
1458   priv = GET_PRIV (handler);
1459
1460   g_object_set (handler, "gfile", destination, NULL);
1461
1462   /* check if hash is supported. if it isn't, set use_hash to FALSE
1463    * anyway, so that clients won't be expecting us to checksum.
1464    */
1465   if (EMP_STR_EMPTY (priv->content_hash) ||
1466       priv->content_hash_type == TP_FILE_HASH_TYPE_NONE)
1467     priv->use_hash = FALSE;
1468   else
1469     priv->use_hash = TRUE;
1470 }
1471
1472 /**
1473  * empathy_ft_handler_get_filename:
1474  * @handler: an #EmpathyFTHandler
1475  *
1476  * Returns the name of the file being transferred.
1477  *
1478  * Return value: the name of the file being transferred
1479  */
1480 const char *
1481 empathy_ft_handler_get_filename (EmpathyFTHandler *handler)
1482 {
1483   EmpathyFTHandlerPriv *priv;
1484
1485   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), NULL);
1486
1487   priv = GET_PRIV (handler);
1488
1489   return priv->filename;
1490 }
1491
1492 /**
1493  * empathy_ft_handler_get_content_type:
1494  * @handler: an #EmpathyFTHandler
1495  *
1496  * Returns the content type of the file being transferred.
1497  *
1498  * Return value: the content type of the file being transferred
1499  */
1500 const char *
1501 empathy_ft_handler_get_content_type (EmpathyFTHandler *handler)
1502 {
1503   EmpathyFTHandlerPriv *priv;
1504
1505   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), NULL);
1506
1507   priv = GET_PRIV (handler);
1508
1509   return priv->content_type;
1510 }
1511
1512 /**
1513  * empathy_ft_handler_get_contact:
1514  * @handler: an #EmpathyFTHandler
1515  *
1516  * Returns the remote #EmpathyContact at the other side of the transfer.
1517  *
1518  * Return value: the remote #EmpathyContact for @handler
1519  */
1520 EmpathyContact *
1521 empathy_ft_handler_get_contact (EmpathyFTHandler *handler)
1522 {
1523   EmpathyFTHandlerPriv *priv;
1524
1525   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), NULL);
1526
1527   priv = GET_PRIV (handler);
1528
1529   return priv->contact;
1530 }
1531
1532 /**
1533  * empathy_ft_handler_get_gfile:
1534  * @handler: an #EmpathyFTHandler
1535  *
1536  * Returns the #GFile where the transfer is being read/saved.
1537  *
1538  * Return value: the #GFile where the transfer is being read/saved
1539  */
1540 GFile *
1541 empathy_ft_handler_get_gfile (EmpathyFTHandler *handler)
1542 {
1543   EmpathyFTHandlerPriv *priv;
1544
1545   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), NULL);
1546
1547   priv = GET_PRIV (handler);
1548
1549   return priv->gfile;
1550 }
1551
1552 /**
1553  * empathy_ft_handler_get_use_hash:
1554  * @handler: an #EmpathyFTHandler
1555  *
1556  * Returns whether @handler has checksumming enabled. This can depend on
1557  * the CM and the remote contact capabilities.
1558  *
1559  * Return value: %TRUE if the handler has checksumming enabled,
1560  * %FALSE otherwise.
1561  */
1562 gboolean
1563 empathy_ft_handler_get_use_hash (EmpathyFTHandler *handler)
1564 {
1565   EmpathyFTHandlerPriv *priv;
1566
1567   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), FALSE);
1568
1569   priv = GET_PRIV (handler);
1570
1571   return priv->use_hash;
1572 }
1573
1574 /**
1575  * empathy_ft_handler_is_incoming:
1576  * @handler: an #EmpathyFTHandler
1577  *
1578  * Returns whether @handler is incoming or outgoing.
1579  *
1580  * Return value: %TRUE if the handler is incoming, %FALSE otherwise.
1581  */
1582 gboolean
1583 empathy_ft_handler_is_incoming (EmpathyFTHandler *handler)
1584 {
1585   EmpathyFTHandlerPriv *priv;
1586
1587   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), FALSE);
1588
1589   priv = GET_PRIV (handler);
1590
1591   if (priv->tpfile == NULL)
1592     return FALSE;
1593
1594   return empathy_tp_file_is_incoming (priv->tpfile);
1595 }
1596
1597 /**
1598  * empathy_ft_handler_get_transferred_bytes:
1599  * @handler: an #EmpathyFTHandler
1600  *
1601  * Returns the number of bytes already transferred by the handler.
1602  *
1603  * Return value: the number of bytes already transferred by the handler.
1604  */
1605 guint64
1606 empathy_ft_handler_get_transferred_bytes (EmpathyFTHandler *handler)
1607 {
1608   EmpathyFTHandlerPriv *priv;
1609
1610   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), 0);
1611
1612   priv = GET_PRIV (handler);
1613
1614   return priv->transferred_bytes;
1615 }
1616
1617 /**
1618  * empathy_ft_handler_get_total_bytes:
1619  * @handler: an #EmpathyFTHandler
1620  *
1621  * Returns the total size of the file being transferred by the handler.
1622  *
1623  * Return value: a number of bytes indicating the total size of the file being
1624  * transferred by the handler.
1625  */
1626 guint64
1627 empathy_ft_handler_get_total_bytes (EmpathyFTHandler *handler)
1628 {
1629   EmpathyFTHandlerPriv *priv;
1630
1631   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), 0);
1632
1633   priv = GET_PRIV (handler);
1634
1635   return priv->total_bytes;
1636 }
1637
1638 /**
1639  * empathy_ft_handler_is_completed:
1640  * @handler: an #EmpathyFTHandler
1641  *
1642  * Returns whether the transfer for @handler has been completed succesfully.
1643  *
1644  * Return value: %TRUE if the handler has been transferred correctly, %FALSE
1645  * otherwise
1646  */
1647 gboolean
1648 empathy_ft_handler_is_completed (EmpathyFTHandler *handler)
1649 {
1650   EmpathyFTHandlerPriv *priv;
1651
1652   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), FALSE);
1653
1654   priv = GET_PRIV (handler);
1655
1656   return priv->is_completed;
1657 }
1658
1659 /**
1660  * empathy_ft_handler_is_cancelled:
1661  * @handler: an #EmpathyFTHandler
1662  *
1663  * Returns whether the transfer for @handler has been cancelled or has stopped
1664  * due to an error.
1665  *
1666  * Return value: %TRUE if the transfer for @handler has been cancelled
1667  * or has stopped due to an error, %FALSE otherwise.
1668  */
1669 gboolean
1670 empathy_ft_handler_is_cancelled (EmpathyFTHandler *handler)
1671 {
1672   EmpathyFTHandlerPriv *priv;
1673
1674   g_return_val_if_fail (EMPATHY_IS_FT_HANDLER (handler), FALSE);
1675
1676   priv = GET_PRIV (handler);
1677
1678   return g_cancellable_is_cancelled (priv->cancellable);
1679 }