git.maemo.org Git - modest/blob - src/maemo/modest-progress-bar-widget.c

   1 /* Copyright (c) 2006, Nokia Corporation
   2  * All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  * * Redistributions of source code must retain the above copyright
   9  *   notice, this list of conditions and the following disclaimer.
  10  * * Redistributions in binary form must reproduce the above copyright
  11  *   notice, this list of conditions and the following disclaimer in the
  12  *   documentation and/or other materials provided with the distribution.
  13  * * Neither the name of the Nokia Corporation nor the names of its
  14  *   contributors may be used to endorse or promote products derived from
  15  *   this software without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
  18  * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  19  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  20  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
  21  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  24  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  25  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  26  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  27  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28  */
  29
  30 #include <glib/gi18n.h>
  31 #include <gtk/gtk.h>
  32 #include <widgets/modest-combo-box.h>
  33 #include "modest-progress-bar-widget.h"
  34 #include <string.h>
  35 #include "modest-platform.h"
  36 #include "modest-runtime.h"
  37
  38 /* 'private'/'protected' functions */
  39 static void modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass);
  40 static void modest_progress_bar_widget_init       (ModestProgressBarWidget *obj);
  41 static void modest_progress_bar_widget_finalize   (GObject *obj);
  42
  43 static void modest_progress_bar_add_operation    (ModestProgressObject *self,
  44                                                     ModestMailOperation  *mail_op);
  45
  46 static void modest_progress_bar_remove_operation (ModestProgressObject *self,
  47                                                     ModestMailOperation  *mail_op);
  48
  49 static void modest_progress_bar_cancel_current_operation (ModestProgressObject *self);
  50
  51 static void modest_progress_bar_cancel_all_operations    (ModestProgressObject *self);
  52
  53 static guint modest_progress_bar_num_pending_operations (ModestProgressObject *self);
  54
  55 static void on_progress_changed                    (ModestMailOperation  *mail_op,
  56                                                     ModestMailOperationState *state,
  57                                                     ModestProgressBarWidget *self);
  58
  59 static gboolean     progressbar_clean        (GtkProgressBar *bar);
  60
  61 #define XALIGN 0.5
  62 #define YALIGN 0.5
  63 #define XSPACE 1
  64 #define YSPACE 0
  65
  66 #define LOWER 0
  67 #define UPPER 150
  68
  69 /* list my signals  */
  70 /* enum { */
  71 /*      LAST_SIGNAL */
  72 /* }; */
  73
  74 typedef struct _ObservableData ObservableData;
  75 struct _ObservableData {
  76         guint signal_handler;
  77         ModestMailOperation *mail_op;
  78 };
  79
  80 typedef struct _ModestProgressBarWidgetPrivate ModestProgressBarWidgetPrivate;
  81 struct _ModestProgressBarWidgetPrivate {
  82         GSList              *observables;
  83         ModestMailOperation *current;
  84
  85         guint count;
  86         GtkWidget *progress_bar;
  87 };
  88 #define MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  89                                                  MODEST_TYPE_PROGRESS_BAR_WIDGET, \
  90                                                  ModestProgressBarWidgetPrivate))
  91
  92 /* globals */
  93 static GtkContainerClass *parent_class = NULL;
  94
  95 /* uncomment the following if you have defined any signals */
  96 /* static guint signals[LAST_SIGNAL] = {0}; */
  97
  98 static void
  99 modest_progress_object_init (gpointer g, gpointer iface_data)
 100 {
 101         ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
 102
 103         klass->add_operation_func = modest_progress_bar_add_operation;
 104         klass->remove_operation_func = modest_progress_bar_remove_operation;
 105         klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
 106         klass->cancel_all_operations_func = modest_progress_bar_cancel_all_operations;
 107         klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
 108 }
 109
 110
 111 GType
 112 modest_progress_bar_widget_get_type (void)
 113 {
 114         static GType my_type = 0;
 115         if (!my_type) {
 116                 static const GTypeInfo my_info = {
 117                         sizeof(ModestProgressBarWidgetClass),
 118                         NULL,           /* base init */
 119                         NULL,           /* base finalize */
 120                         (GClassInitFunc) modest_progress_bar_widget_class_init,
 121                         NULL,           /* class finalize */
 122                         NULL,           /* class data */
 123                         sizeof(ModestProgressBarWidget),
 124                         1,              /* n_preallocs */
 125                         (GInstanceInitFunc) modest_progress_bar_widget_init,
 126                         NULL
 127                 };
 128
 129                 static const GInterfaceInfo modest_progress_object_info =
 130                 {
 131                   (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
 132                   NULL,         /* interface_finalize */
 133                   NULL          /* interface_data */
 134                 };
 135
 136                 my_type = g_type_register_static (GTK_TYPE_VBOX,
 137                                                   "ModestProgressBarWidget",
 138                                                   &my_info, 0);
 139
 140                 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
 141                                              &modest_progress_object_info);
 142         }
 143         return my_type;
 144 }
 145
 146 static void
 147 modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass)
 148 {
 149         GObjectClass *gobject_class;
 150         gobject_class = (GObjectClass*) klass;
 151
 152         parent_class            = g_type_class_peek_parent (klass);
 153         gobject_class->finalize = modest_progress_bar_widget_finalize;
 154
 155         g_type_class_add_private (gobject_class, sizeof(ModestProgressBarWidgetPrivate));
 156
 157         /* signal definitions go here, e.g.: */
 158 /*      signals[DATA_CHANGED_SIGNAL] = */
 159 /*              g_signal_new ("data_changed", */
 160 /*                            G_TYPE_FROM_CLASS (klass), */
 161 /*                            G_SIGNAL_RUN_FIRST, */
 162 /*                            G_STRUCT_OFFSET(ModestProgressBarWidgetClass, data_changed), */
 163 /*                            NULL, NULL, */
 164 /*                            g_cclosure_marshal_VOID__VOID, */
 165 /*                            G_TYPE_NONE, 0); */
 166 }
 167
 168 static void
 169 modest_progress_bar_widget_init (ModestProgressBarWidget *self)
 170 {
 171
 172         ModestProgressBarWidgetPrivate *priv;
 173         GtkWidget *align = NULL;
 174         GtkRequisition req;
 175         GtkAdjustment *adj;
 176
 177         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(self);
 178
 179         /* Alignment */
 180         align = gtk_alignment_new(XALIGN, YALIGN, XSPACE, YSPACE);
 181
 182         /* Build GtkProgressBar */
 183         adj = (GtkAdjustment *) gtk_adjustment_new (0, LOWER, UPPER, 0, 0, 0);
 184         priv->progress_bar = gtk_progress_bar_new_with_adjustment (adj);
 185         req.width = 228;
 186         req.height = 64;
 187         gtk_progress_set_text_alignment (GTK_PROGRESS (priv->progress_bar), 0, 0.5);
 188         gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar), PANGO_ELLIPSIZE_END);
 189         gtk_progress_bar_set_pulse_step (GTK_PROGRESS_BAR (priv->progress_bar), 0.05);
 190         gtk_widget_size_request (priv->progress_bar, &req);
 191         gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
 192         gtk_widget_size_request (align, &req);
 193
 194         /* Add progress bar widget */
 195         gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
 196         gtk_widget_show_all (GTK_WIDGET(self));
 197 }
 198
 199 static void
 200 modest_progress_bar_widget_finalize (GObject *obj)
 201 {
 202         ModestProgressBarWidgetPrivate *priv;
 203
 204         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(obj);
 205         if (priv->observables) {
 206                 GSList *tmp;
 207
 208                 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
 209                         ObservableData *ob_data = tmp->data;
 210                         g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
 211                         g_object_unref (ob_data->mail_op);
 212                         g_free (ob_data);
 213                 }
 214                 g_slist_free (priv->observables);
 215                 priv->observables = NULL;
 216         }
 217
 218         G_OBJECT_CLASS(parent_class)->finalize (obj);
 219 }
 220
 221
 222 static void
 223 modest_progress_bar_add_operation (ModestProgressObject *self,
 224                                    ModestMailOperation  *mail_op)
 225 {
 226         ModestProgressBarWidget *me = NULL;
 227         ObservableData *data = NULL;
 228         ModestProgressBarWidgetPrivate *priv = NULL;
 229         ModestMailOperationState *state = NULL;
 230
 231         me = MODEST_PROGRESS_BAR_WIDGET (self);
 232         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 233
 234         data = g_malloc0 (sizeof (ObservableData));
 235         data->mail_op = g_object_ref (mail_op);
 236         data->signal_handler = g_signal_connect (data->mail_op,
 237                                                  "progress-changed",
 238                                                  G_CALLBACK (on_progress_changed),
 239                                                  me);
 240         /* Set curent operation */
 241         if (priv->current == NULL) {
 242                 priv->current = mail_op;
 243
 244                 priv->count = 0;
 245
 246                 /* Call progress_change handler to initialize progress message */
 247                 state = g_malloc0(sizeof(ModestMailOperationState));
 248                 state->done = 0;
 249                 state->total = 0;
 250                 state->op_type = modest_mail_operation_get_type_operation (mail_op);
 251                 on_progress_changed (mail_op, state, me);
 252                 g_free(state);
 253         }
 254
 255         /* Add operation to obserbable objects list */
 256         priv->observables = g_slist_prepend (priv->observables, data);
 257 }
 258
 259 static gint
 260 compare_observable_data (ObservableData *data1, ObservableData *data2)
 261 {
 262         if (data1->mail_op == data2->mail_op)
 263                 return 0;
 264         else
 265                 return 1;
 266 }
 267
 268 static void
 269 modest_progress_bar_remove_operation (ModestProgressObject *self,
 270                                       ModestMailOperation  *mail_op)
 271 {
 272         ModestProgressBarWidget *me;
 273         ModestProgressBarWidgetPrivate *priv;
 274         GSList *link;
 275         ObservableData *tmp_data = NULL;
 276         gboolean is_current;
 277
 278         me = MODEST_PROGRESS_BAR_WIDGET (self);
 279         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 280
 281         is_current = (priv->current == mail_op);
 282
 283         /* Find item */
 284         tmp_data = g_malloc0 (sizeof (ObservableData));
 285         tmp_data->mail_op = mail_op;
 286         link = g_slist_find_custom (priv->observables,
 287                                     tmp_data,
 288                                     (GCompareFunc) compare_observable_data);
 289
 290         /* Remove the item */
 291         if (link) {
 292                 ObservableData *ob_data = link->data;
 293                 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
 294                 g_object_unref (ob_data->mail_op);
 295                 g_free (ob_data);
 296                 priv->observables = g_slist_delete_link (priv->observables, link);
 297                 tmp_data->mail_op = NULL;
 298                 link = NULL;
 299         }
 300
 301         /* Update the current mail operation */
 302         if (is_current) {
 303                 if (priv->observables)
 304                         priv->current = ((ObservableData *) priv->observables->data)->mail_op;
 305                 else
 306                         priv->current = NULL;
 307
 308                 /* Refresh the view */
 309                 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
 310         }
 311
 312         /* free */
 313         g_free(tmp_data);
 314 }
 315
 316 static guint
 317 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
 318 {
 319         ModestProgressBarWidget *me;
 320         ModestProgressBarWidgetPrivate *priv;
 321
 322         me = MODEST_PROGRESS_BAR_WIDGET (self);
 323         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 324
 325         return g_slist_length(priv->observables);
 326 }
 327
 328 static void
 329 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
 330 {
 331         ModestProgressBarWidget *me;
 332         ModestProgressBarWidgetPrivate *priv;
 333
 334         me = MODEST_PROGRESS_BAR_WIDGET (self);
 335         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 336
 337         if (priv->current == NULL) return;
 338
 339         /* If received canceled we shall show banner */
 340         if (modest_mail_operation_get_type_operation (priv->current) ==
 341             MODEST_MAIL_OPERATION_TYPE_RECEIVE)
 342                 modest_platform_information_banner (NULL, NULL,
 343                                                     _("emev_ib_ui_pop3_msg_recv_cancel"));
 344
 345         modest_mail_operation_cancel (priv->current);
 346 }
 347
 348 static void
 349 modest_progress_bar_cancel_all_operations (ModestProgressObject *self)
 350 {
 351         ModestProgressBarWidget *me;
 352         ModestProgressBarWidgetPrivate *priv;
 353
 354         me = MODEST_PROGRESS_BAR_WIDGET (self);
 355         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 356
 357         /* If received canceled we shall show banner */
 358         if (priv->current && modest_mail_operation_get_type_operation (priv->current) ==
 359             MODEST_MAIL_OPERATION_TYPE_RECEIVE)
 360                 modest_platform_information_banner (NULL, NULL,
 361                                                     _("emev_ib_ui_pop3_msg_recv_cancel"));
 362
 363         /* Cancel all the mail operations */
 364         modest_mail_operation_queue_cancel_all (modest_runtime_get_mail_operation_queue ());
 365 }
 366
 367 static void
 368 on_progress_changed (ModestMailOperation  *mail_op,
 369                      ModestMailOperationState *state,
 370                      ModestProgressBarWidget *self)
 371 {
 372         ModestProgressBarWidgetPrivate *priv;
 373         gboolean determined = FALSE;
 374
 375         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
 376
 377         /* If the mail operation is the currently shown one */
 378         if (priv->current == mail_op) {
 379                 gchar *msg = NULL;
 380
 381                 determined = (state->done > 0 && state->total > 1) &&
 382                         !(state->done == 1 && state->total == 100);
 383
 384                 switch (state->op_type) {
 385                 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
 386                         if (determined)
 387                                 msg = g_strdup_printf(_("mcen_me_receiving"),
 388                                                       state->done, state->total);
 389                         else
 390                                 msg = g_strdup(_("mail_me_receiving"));
 391                         break;
 392                 case MODEST_MAIL_OPERATION_TYPE_SEND:
 393                         if (determined)
 394                                 msg = g_strdup_printf(_("mcen_me_sending"), state->done,
 395                                                       state->total);
 396                         else
 397                                 msg = g_strdup(_("mail_me_sending"));
 398                         break;
 399
 400                 case MODEST_MAIL_OPERATION_TYPE_OPEN:
 401                         msg = g_strdup(_("mail_me_opening"));
 402                         break;
 403                 default:
 404                         msg = g_strdup("");
 405                 }
 406
 407                 /* If we have byte information use it */
 408                 if ((state->bytes_done != 0) && (state->bytes_total != 0))
 409                         modest_progress_bar_widget_set_progress (self, msg,
 410                                                                  state->bytes_done,
 411                                                                  state->bytes_total);
 412                 else
 413                         modest_progress_bar_widget_set_progress (self, msg,
 414                                                                  state->done,
 415                                                                  state->total);
 416                 g_free (msg);
 417         }
 418 }
 419
 420 static gboolean
 421 progressbar_clean (GtkProgressBar *bar)
 422 {
 423         gtk_progress_bar_set_fraction (bar, 0);
 424         gtk_progress_bar_set_text (bar, 0);
 425         return FALSE;
 426 }
 427
 428
 429 GtkWidget*
 430 modest_progress_bar_widget_new ()
 431 {
 432         return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
 433 }
 434
 435
 436 void
 437 modest_progress_bar_widget_set_progress (ModestProgressBarWidget *self,
 438                                          const gchar *message,
 439                                          gint done,
 440                                          gint total)
 441 {
 442         ModestProgressBarWidgetPrivate *priv;
 443         gboolean determined = FALSE;
 444
 445         g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
 446         g_return_if_fail (done <= total);
 447
 448         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
 449
 450         priv->count++;
 451
 452         /* Set progress. Tinymail sometimes returns us 1/100 when it
 453            does not have any clue, NOTE that 1/100 could be also a
 454            valid progress (we will loose it), but it will be recovered
 455            once the done is greater than 1 */
 456         determined = (done > 0 && total > 1) &&
 457                 !(done == 1 && total == 100);
 458 /*      if ((done == 0 && total == 0) ||  */
 459 /*          (done == 1 && total == 100)) { */
 460         if (!determined) {
 461                 gtk_progress_bar_set_bar_style (GTK_PROGRESS_BAR (priv->progress_bar), /* Deprecated */
 462                                                 GTK_PROGRESS_CONTINUOUS);
 463                 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
 464                 printf ("debug: %s:\n  undetermined progress (%i) changed (%i/%i) : %i\n", __FUNCTION__,
 465                         (int) priv->progress_bar,
 466                         done,
 467                         total,
 468                         priv->count);
 469         } else {
 470                 gdouble percent = 0;
 471                 if (total != 0) /* Avoid division by zero. */
 472                         percent = (gdouble)done/(gdouble)total;
 473
 474                 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
 475                                                percent);
 476
 477                 printf ("debug: %s:\n  determined progress (%i) changed (%i/%i) : %i\n", __FUNCTION__,
 478                         (int) priv->progress_bar,
 479                         done,
 480                         total,
 481                         priv->count);
 482         }
 483
 484         /* Set text */
 485         gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), message);
 486 }
 487