finch/gntxfer.c

   1 /*
   2  * finch
   3  *
   4  * Finch is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23 #include <internal.h>
  24 #include "finch.h"
  25
  26 #include <gnt.h>
  27 #include <gntbox.h>
  28 #include <gntbutton.h>
  29 #include <gntcheckbox.h>
  30 #include <gntlabel.h>
  31 #include <gnttree.h>
  32
  33 #include "debug.h"
  34 #include "notify.h"
  35 #include "xfer.h"
  36 #include "protocol.h"
  37 #include "util.h"
  38
  39 #include "gntxfer.h"
  40 #include "prefs.h"
  41
  42 typedef struct
  43 {
  44         gboolean keep_open;
  45         gboolean auto_clear;
  46         gint num_transfers;
  47
  48         GntWidget *window;
  49         GntWidget *tree;
  50
  51         GntWidget *remove_button;
  52         GntWidget *stop_button;
  53         GntWidget *close_button;
  54 } PurpleGntXferDialog;
  55
  56 static PurpleGntXferDialog *xfer_dialog = NULL;
  57
  58 typedef struct
  59 {
  60         gint64 last_updated_time;
  61         gboolean in_list;
  62
  63         char *name;
  64         gboolean notified;   /* Has the completion of the transfer been notified? */
  65
  66 } PurpleGntXferUiData;
  67
  68 enum
  69 {
  70         COLUMN_PROGRESS = 0,
  71         COLUMN_FILENAME,
  72         COLUMN_SIZE,
  73         COLUMN_SPEED,
  74         COLUMN_REMAINING,
  75         COLUMN_STATUS,
  76         NUM_COLUMNS
  77 };
  78
  79
  80 /**************************************************************************
  81  * Utility Functions
  82  **************************************************************************/
  83
  84 static void
  85 update_title_progress(void)
  86 {
  87         GList *list;
  88         int num_active_xfers = 0;
  89         guint64 total_bytes_xferred = 0;
  90         guint64 total_file_size = 0;
  91
  92         if (xfer_dialog == NULL || xfer_dialog->window == NULL)
  93                 return;
  94
  95         /* Find all active transfers */
  96         for (list = gnt_tree_get_rows(GNT_TREE(xfer_dialog->tree)); list; list = list->next) {
  97                 PurpleXfer *xfer = (PurpleXfer *)list->data;
  98
  99                 if (purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_STARTED) {
 100                         num_active_xfers++;
 101                         total_bytes_xferred += purple_xfer_get_bytes_sent(xfer);
 102                         total_file_size += purple_xfer_get_size(xfer);
 103                 }
 104         }
 105
 106         /* Update the title */
 107         if (num_active_xfers > 0) {
 108                 gchar *title;
 109                 int total_pct = 0;
 110
 111                 if (total_file_size > 0) {
 112                         total_pct = 100 * total_bytes_xferred / total_file_size;
 113                 }
 114
 115                 title = g_strdup_printf(ngettext("File Transfers - %d%% of %d file",
 116                                                  "File Transfers - %d%% of %d files",
 117                                                  num_active_xfers),
 118                                 total_pct, num_active_xfers);
 119                 gnt_screen_rename_widget((xfer_dialog->window), title);
 120                 g_free(title);
 121         } else {
 122                 gnt_screen_rename_widget((xfer_dialog->window), _("File Transfers"));
 123         }
 124 }
 125
 126
 127 /**************************************************************************
 128  * Callbacks
 129  **************************************************************************/
 130 static void
 131 toggle_keep_open_cb(GntWidget *w)
 132 {
 133         xfer_dialog->keep_open = !xfer_dialog->keep_open;
 134         purple_prefs_set_bool("/finch/filetransfer/keep_open",
 135                                                 xfer_dialog->keep_open);
 136 }
 137
 138 static void
 139 toggle_clear_finished_cb(GntWidget *w)
 140 {
 141         xfer_dialog->auto_clear = !xfer_dialog->auto_clear;
 142         purple_prefs_set_bool("/finch/filetransfer/clear_finished",
 143                                                 xfer_dialog->auto_clear);
 144         if (xfer_dialog->auto_clear) {
 145                 GList *iter = purple_xfers_get_all();
 146                 while (iter) {
 147                         PurpleXfer *xfer = iter->data;
 148                         iter = iter->next;
 149                         if (purple_xfer_is_completed(xfer) || purple_xfer_is_cancelled(xfer))
 150                         finch_xfer_dialog_remove_xfer(xfer);
 151                 }
 152         }
 153 }
 154
 155 static void
 156 remove_button_cb(GntButton *button)
 157 {
 158         PurpleXfer *selected_xfer = gnt_tree_get_selection_data(GNT_TREE(xfer_dialog->tree));
 159         if (selected_xfer && (purple_xfer_is_completed(selected_xfer) ||
 160                                 purple_xfer_is_cancelled(selected_xfer))) {
 161                 finch_xfer_dialog_remove_xfer(selected_xfer);
 162         }
 163 }
 164
 165 static void
 166 stop_button_cb(GntButton *button)
 167 {
 168         PurpleXfer *selected_xfer = gnt_tree_get_selection_data(GNT_TREE(xfer_dialog->tree));
 169         PurpleXferStatus status;
 170
 171         if (!selected_xfer)
 172                 return;
 173
 174         status = purple_xfer_get_status(selected_xfer);
 175         if (status != PURPLE_XFER_STATUS_CANCEL_LOCAL &&
 176                         status != PURPLE_XFER_STATUS_CANCEL_REMOTE &&
 177                         status != PURPLE_XFER_STATUS_DONE)
 178                 purple_xfer_cancel_local(selected_xfer);
 179 }
 180
 181 /**************************************************************************
 182  * Dialog Building Functions
 183  **************************************************************************/
 184
 185
 186 void
 187 finch_xfer_dialog_new(void)
 188 {
 189         GList *iter;
 190         GntWidget *window;
 191         GntWidget *bbox;
 192         GntWidget *button;
 193         GntWidget *checkbox;
 194         GntWidget *tree;
 195         int widths[] = {8, 12, 8, 8, 8, 8, -1};
 196
 197         if (!xfer_dialog)
 198                 xfer_dialog = g_new0(PurpleGntXferDialog, 1);
 199
 200         xfer_dialog->keep_open =
 201                 purple_prefs_get_bool("/finch/filetransfer/keep_open");
 202         xfer_dialog->auto_clear =
 203                 purple_prefs_get_bool("/finch/filetransfer/clear_finished");
 204
 205         /* Create the window. */
 206         xfer_dialog->window = window = gnt_vbox_new(FALSE);
 207         g_signal_connect(G_OBJECT(window), "destroy", G_CALLBACK(finch_xfer_dialog_destroy), NULL);
 208         gnt_box_set_toplevel(GNT_BOX(window), TRUE);
 209         gnt_box_set_title(GNT_BOX(window), _("File Transfers"));
 210         gnt_box_set_fill(GNT_BOX(window), TRUE);
 211         gnt_box_set_alignment(GNT_BOX(window), GNT_ALIGN_MID);
 212
 213         xfer_dialog->tree = tree = gnt_tree_new_with_columns(NUM_COLUMNS);
 214         gnt_tree_set_column_titles(GNT_TREE(tree), _("Progress"), _("Filename"), _("Size"), _("Speed"), _("Remaining"), _("Status"));
 215         gnt_tree_set_column_width_ratio(GNT_TREE(tree), widths);
 216         gnt_tree_set_column_resizable(GNT_TREE(tree), COLUMN_PROGRESS, FALSE);
 217         gnt_tree_set_column_resizable(GNT_TREE(tree), COLUMN_SIZE, FALSE);
 218         gnt_tree_set_column_resizable(GNT_TREE(tree), COLUMN_SPEED, FALSE);
 219         gnt_tree_set_column_resizable(GNT_TREE(tree), COLUMN_REMAINING, FALSE);
 220         gnt_widget_set_size(tree, 70, -1);
 221         gnt_tree_set_show_title(GNT_TREE(tree), TRUE);
 222         gnt_box_add_widget(GNT_BOX(window), tree);
 223
 224         checkbox = gnt_check_box_new( _("Close this window when all transfers finish"));
 225         gnt_check_box_set_checked(GNT_CHECK_BOX(checkbox),
 226                                                                  !xfer_dialog->keep_open);
 227         g_signal_connect(G_OBJECT(checkbox), "toggled",
 228                                          G_CALLBACK(toggle_keep_open_cb), NULL);
 229         gnt_box_add_widget(GNT_BOX(window), checkbox);
 230
 231         checkbox = gnt_check_box_new(_("Clear finished transfers"));
 232         gnt_check_box_set_checked(GNT_CHECK_BOX(checkbox),
 233                                                                  xfer_dialog->auto_clear);
 234         g_signal_connect(G_OBJECT(checkbox), "toggled",
 235                                          G_CALLBACK(toggle_clear_finished_cb), NULL);
 236         gnt_box_add_widget(GNT_BOX(window), checkbox);
 237
 238         bbox = gnt_hbox_new(FALSE);
 239
 240         xfer_dialog->remove_button = button = gnt_button_new(_("Remove"));
 241         g_signal_connect(G_OBJECT(button), "activate",
 242                                          G_CALLBACK(remove_button_cb), NULL);
 243         gnt_box_add_widget(GNT_BOX(bbox), button);
 244
 245         xfer_dialog->stop_button = button = gnt_button_new(_("Stop"));
 246         g_signal_connect(G_OBJECT(button), "activate",
 247                                          G_CALLBACK(stop_button_cb), NULL);
 248         gnt_box_add_widget(GNT_BOX(bbox), button);
 249
 250         xfer_dialog->close_button = button = gnt_button_new(_("Close"));
 251         g_signal_connect(G_OBJECT(button), "activate",
 252                                          G_CALLBACK(finch_xfer_dialog_destroy), NULL);
 253         gnt_box_add_widget(GNT_BOX(bbox), button);
 254
 255         gnt_box_add_widget(GNT_BOX(window), bbox);
 256
 257         for (iter = purple_xfers_get_all(); iter; iter = iter->next) {
 258                 PurpleXfer *xfer = (PurpleXfer *)iter->data;
 259                 PurpleGntXferUiData *data = purple_xfer_get_ui_data(xfer);
 260                 if (data->in_list) {
 261                         finch_xfer_dialog_add_xfer(xfer);
 262                         finch_xfer_dialog_update_xfer(xfer);
 263                         gnt_tree_set_selected(GNT_TREE(tree), xfer);
 264                 }
 265         }
 266         gnt_widget_show(xfer_dialog->window);
 267 }
 268
 269 void
 270 finch_xfer_dialog_destroy()
 271 {
 272         gnt_widget_destroy(xfer_dialog->window);
 273         g_free(xfer_dialog);
 274         xfer_dialog = NULL;
 275 }
 276
 277 void
 278 finch_xfer_dialog_show()
 279 {
 280         if (xfer_dialog == NULL)
 281                 finch_xfer_dialog_new();
 282         else
 283                 gnt_window_present(xfer_dialog->window);
 284 }
 285
 286 void
 287 finch_xfer_dialog_add_xfer(PurpleXfer *xfer)
 288 {
 289         PurpleGntXferUiData *data;
 290         PurpleXferType type;
 291         char *size_str, *remaining_str;
 292         char *lfilename, *utf8;
 293
 294         g_return_if_fail(xfer_dialog != NULL);
 295         g_return_if_fail(xfer != NULL);
 296
 297         g_object_ref(xfer);
 298
 299         data = purple_xfer_get_ui_data(xfer);
 300         data->in_list = TRUE;
 301
 302         finch_xfer_dialog_show();
 303
 304         data->last_updated_time = 0;
 305
 306         type = purple_xfer_get_xfer_type(xfer);
 307
 308         size_str = g_format_size(purple_xfer_get_size(xfer));
 309         remaining_str = g_format_size(purple_xfer_get_bytes_remaining(xfer));
 310
 311         lfilename = g_path_get_basename(purple_xfer_get_local_filename(xfer));
 312         utf8 = g_filename_to_utf8(lfilename, -1, NULL, NULL, NULL);
 313         g_free(lfilename);
 314         lfilename = utf8;
 315         gnt_tree_add_row_last(GNT_TREE(xfer_dialog->tree), xfer,
 316                 gnt_tree_create_row(GNT_TREE(xfer_dialog->tree),
 317                         "0.0", (type == PURPLE_XFER_TYPE_RECEIVE) ? purple_xfer_get_filename(xfer) : lfilename,
 318                         size_str, "0.0", "",_("Waiting for transfer to begin")), NULL);
 319         g_free(lfilename);
 320
 321         g_free(size_str);
 322         g_free(remaining_str);
 323
 324         xfer_dialog->num_transfers++;
 325
 326         update_title_progress();
 327 }
 328
 329 void
 330 finch_xfer_dialog_remove_xfer(PurpleXfer *xfer)
 331 {
 332         PurpleGntXferUiData *data;
 333
 334         g_return_if_fail(xfer_dialog != NULL);
 335         g_return_if_fail(xfer != NULL);
 336
 337         data = purple_xfer_get_ui_data(xfer);
 338
 339         if (data == NULL)
 340                 return;
 341
 342         if (!data->in_list)
 343                 return;
 344
 345         data->in_list = FALSE;
 346
 347         gnt_tree_remove(GNT_TREE(xfer_dialog->tree), xfer);
 348
 349         xfer_dialog->num_transfers--;
 350
 351         if (xfer_dialog->num_transfers == 0 && !xfer_dialog->keep_open)
 352                 finch_xfer_dialog_destroy();
 353         else
 354                 update_title_progress();
 355         g_object_unref(xfer);
 356 }
 357
 358 void
 359 finch_xfer_dialog_cancel_xfer(PurpleXfer *xfer)
 360 {
 361         PurpleGntXferUiData *data;
 362         const gchar *status;
 363
 364         g_return_if_fail(xfer_dialog != NULL);
 365         g_return_if_fail(xfer != NULL);
 366
 367         data = purple_xfer_get_ui_data(xfer);
 368
 369         if (data == NULL)
 370                 return;
 371
 372         if (!data->in_list)
 373                 return;
 374
 375         if ((purple_xfer_get_status(xfer) == PURPLE_XFER_STATUS_CANCEL_LOCAL) && (xfer_dialog->auto_clear)) {
 376                 finch_xfer_dialog_remove_xfer(xfer);
 377                 return;
 378         }
 379
 380         update_title_progress();
 381
 382         if (purple_xfer_is_cancelled(xfer))
 383                 status = _("Cancelled");
 384         else
 385                 status = _("Failed");
 386
 387         gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_STATUS, status);
 388 }
 389
 390 void
 391 finch_xfer_dialog_update_xfer(PurpleXfer *xfer)
 392 {
 393         PurpleGntXferUiData *data;
 394         char *size_str, *remaining_str;
 395         gint64 current_time;
 396         char prog_str[5];
 397         double kb_sent;
 398         double kbps = 0.0;
 399         gint64 now;
 400         gint64 elapsed = 0;
 401         char *kbsec;
 402         gboolean send;
 403
 404         if (purple_xfer_get_start_time(xfer) > 0) {
 405                 if ((now = purple_xfer_get_end_time(xfer)) == 0) {
 406                         now = g_get_monotonic_time();
 407                 }
 408                 elapsed = now - purple_xfer_get_start_time(xfer);
 409         }
 410
 411         kb_sent = purple_xfer_get_bytes_sent(xfer) / 1000.0;
 412         kbps = (elapsed > 0 ? (kb_sent * G_USEC_PER_SEC) / elapsed : 0);
 413
 414         g_return_if_fail(xfer_dialog != NULL);
 415         g_return_if_fail(xfer != NULL);
 416
 417         if ((data = purple_xfer_get_ui_data(xfer)) == NULL)
 418                 return;
 419
 420         if (data->in_list == FALSE || data->notified)
 421                 return;
 422
 423         current_time = g_get_monotonic_time();
 424         if (((current_time - data->last_updated_time) < G_USEC_PER_SEC) &&
 425                 (!purple_xfer_is_completed(xfer))) {
 426                 /* Don't update the window more than once per second */
 427                 return;
 428         }
 429         data->last_updated_time = current_time;
 430
 431         send = (purple_xfer_get_xfer_type(xfer) == PURPLE_XFER_TYPE_SEND);
 432         size_str = g_format_size(purple_xfer_get_size(xfer));
 433         remaining_str = g_format_size(purple_xfer_get_bytes_remaining(xfer));
 434         kbsec = g_strdup_printf(_("%.2f KB/s"), kbps);
 435
 436         gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_PROGRESS,
 437                         g_ascii_dtostr(prog_str, sizeof(prog_str), purple_xfer_get_progress(xfer) * 100.));
 438         gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_SIZE, size_str);
 439         gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_REMAINING, remaining_str);
 440         gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_SPEED, kbsec);
 441         g_free(size_str);
 442         g_free(remaining_str);
 443         g_free(kbsec);
 444         if (purple_xfer_is_completed(xfer)) {
 445                 gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_STATUS, send ? _("Sent") : _("Received"));
 446                 gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_REMAINING, _("Finished"));
 447                 if (!send) {
 448                         char *msg = g_strdup_printf(_("The file was saved as %s."), purple_xfer_get_local_filename(xfer));
 449                         purple_xfer_conversation_write(xfer, msg, FALSE);
 450                         g_free(msg);
 451                 }
 452                 data->notified = TRUE;
 453         } else {
 454                 gnt_tree_change_text(GNT_TREE(xfer_dialog->tree), xfer, COLUMN_STATUS,
 455                                 send ? _("Sending") : _("Receiving"));
 456         }
 457
 458         update_title_progress();
 459
 460         if (purple_xfer_is_completed(xfer) && xfer_dialog->auto_clear)
 461                 finch_xfer_dialog_remove_xfer(xfer);
 462 }
 463
 464 /**************************************************************************
 465  * File Transfer UI Ops
 466  **************************************************************************/
 467 static void
 468 finch_xfer_new_xfer(PurpleXfer *xfer)
 469 {
 470         PurpleGntXferUiData *data;
 471
 472         /* This is where we're setting xfer's "ui_data" for the first time. */
 473         data = g_new0(PurpleGntXferUiData, 1);
 474         purple_xfer_set_ui_data(xfer, data);
 475 }
 476
 477 static void
 478 finch_xfer_destroy(PurpleXfer *xfer)
 479 {
 480         PurpleGntXferUiData *data;
 481
 482         data = purple_xfer_get_ui_data(xfer);
 483         if (data) {
 484                 g_free(data->name);
 485                 g_free(data);
 486                 purple_xfer_set_ui_data(xfer, NULL);
 487         }
 488 }
 489
 490 static void
 491 finch_xfer_add_xfer(PurpleXfer *xfer)
 492 {
 493         if (!xfer_dialog)
 494                 finch_xfer_dialog_new();
 495
 496         finch_xfer_dialog_add_xfer(xfer);
 497         gnt_tree_set_selected(GNT_TREE(xfer_dialog->tree), xfer);
 498 }
 499
 500 static void
 501 finch_xfer_update_progress(PurpleXfer *xfer, double percent)
 502 {
 503         if (xfer_dialog)
 504                 finch_xfer_dialog_update_xfer(xfer);
 505 }
 506
 507 static void
 508 finch_xfer_cancel_local(PurpleXfer *xfer)
 509 {
 510         if (xfer_dialog)
 511                 finch_xfer_dialog_cancel_xfer(xfer);
 512 }
 513
 514 static void
 515 finch_xfer_cancel_remote(PurpleXfer *xfer)
 516 {
 517         if (xfer_dialog)
 518                 finch_xfer_dialog_cancel_xfer(xfer);
 519 }
 520
 521 static PurpleXferUiOps ops =
 522 {
 523         finch_xfer_new_xfer,
 524         finch_xfer_destroy,
 525         finch_xfer_add_xfer,
 526         finch_xfer_update_progress,
 527         finch_xfer_cancel_local,
 528         finch_xfer_cancel_remote,
 529         NULL, /* ui_write */
 530         NULL, /* ui_read */
 531         NULL, /* data_not_sent */
 532         NULL  /* add_thumbnail */
 533 };
 534
 535 /**************************************************************************
 536  * GNT File Transfer API
 537  **************************************************************************/
 538 void
 539 finch_xfers_init(void)
 540 {
 541         purple_prefs_add_none("/finch/filetransfer");
 542         purple_prefs_add_bool("/finch/filetransfer/clear_finished", TRUE);
 543         purple_prefs_add_bool("/finch/filetransfer/keep_open", FALSE);
 544 }
 545
 546 void
 547 finch_xfers_uninit(void)
 548 {
 549         if (xfer_dialog != NULL)
 550                 finch_xfer_dialog_destroy();
 551 }
 552
 553 PurpleXferUiOps *
 554 finch_xfers_get_ui_ops(void)
 555 {
 556         return &ops;
 557 }