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 <string.h>
  31 #include <glib/gi18n.h>
  32 #include <gtk/gtk.h>
  33 #include <widgets/modest-combo-box.h>
  34 #include "modest-progress-bar-widget.h"
  35 #include "modest-tny-account.h"
  36 #include "modest-platform.h"
  37 #include "modest-runtime.h"
  38
  39 /* 'private'/'protected' functions */
  40 static void modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass);
  41 static void modest_progress_bar_widget_init       (ModestProgressBarWidget *obj);
  42 static void modest_progress_bar_widget_finalize   (GObject *obj);
  43
  44 static void modest_progress_bar_add_operation    (ModestProgressObject *self,
  45                                                     ModestMailOperation  *mail_op);
  46
  47 static void modest_progress_bar_remove_operation (ModestProgressObject *self,
  48                                                     ModestMailOperation  *mail_op);
  49
  50 static void modest_progress_bar_cancel_current_operation (ModestProgressObject *self);
  51
  52 static void modest_progress_bar_cancel_all_operations    (ModestProgressObject *self);
  53
  54 static guint modest_progress_bar_num_pending_operations (ModestProgressObject *self);
  55
  56 static void on_progress_changed                    (ModestMailOperation  *mail_op,
  57                                                     ModestMailOperationState *state,
  58                                                     ModestProgressBarWidget *self);
  59
  60 static gboolean     progressbar_clean        (GtkProgressBar *bar);
  61
  62 #define XALIGN 0.5
  63 #define YALIGN 0.5
  64 #define XSPACE 1
  65 #define YSPACE 0
  66
  67 #define LOWER 0
  68 #define UPPER 150
  69
  70 /* list my signals  */
  71 /* enum { */
  72 /*      LAST_SIGNAL */
  73 /* }; */
  74
  75 typedef struct _ObservableData ObservableData;
  76 struct _ObservableData {
  77         guint signal_handler;
  78         ModestMailOperation *mail_op;
  79 };
  80
  81 typedef struct _ModestProgressBarWidgetPrivate ModestProgressBarWidgetPrivate;
  82 struct _ModestProgressBarWidgetPrivate {
  83         GSList              *observables;
  84         ModestMailOperation *current;
  85
  86         guint count;
  87         GtkWidget *progress_bar;
  88 };
  89 #define MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
  90                                                  MODEST_TYPE_PROGRESS_BAR_WIDGET, \
  91                                                  ModestProgressBarWidgetPrivate))
  92
  93 /* globals */
  94 static GtkContainerClass *parent_class = NULL;
  95
  96 /* uncomment the following if you have defined any signals */
  97 /* static guint signals[LAST_SIGNAL] = {0}; */
  98
  99 static void
 100 modest_progress_object_init (gpointer g, gpointer iface_data)
 101 {
 102         ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
 103
 104         klass->add_operation_func = modest_progress_bar_add_operation;
 105         klass->remove_operation_func = modest_progress_bar_remove_operation;
 106         klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
 107         klass->cancel_all_operations_func = modest_progress_bar_cancel_all_operations;
 108         klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
 109 }
 110
 111
 112 GType
 113 modest_progress_bar_widget_get_type (void)
 114 {
 115         static GType my_type = 0;
 116         if (!my_type) {
 117                 static const GTypeInfo my_info = {
 118                         sizeof(ModestProgressBarWidgetClass),
 119                         NULL,           /* base init */
 120                         NULL,           /* base finalize */
 121                         (GClassInitFunc) modest_progress_bar_widget_class_init,
 122                         NULL,           /* class finalize */
 123                         NULL,           /* class data */
 124                         sizeof(ModestProgressBarWidget),
 125                         1,              /* n_preallocs */
 126                         (GInstanceInitFunc) modest_progress_bar_widget_init,
 127                         NULL
 128                 };
 129
 130                 static const GInterfaceInfo modest_progress_object_info =
 131                 {
 132                   (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
 133                   NULL,         /* interface_finalize */
 134                   NULL          /* interface_data */
 135                 };
 136
 137                 my_type = g_type_register_static (GTK_TYPE_VBOX,
 138                                                   "ModestProgressBarWidget",
 139                                                   &my_info, 0);
 140
 141                 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
 142                                              &modest_progress_object_info);
 143         }
 144         return my_type;
 145 }
 146
 147 static void
 148 modest_progress_bar_widget_class_init (ModestProgressBarWidgetClass *klass)
 149 {
 150         GObjectClass *gobject_class;
 151         gobject_class = (GObjectClass*) klass;
 152
 153         parent_class            = g_type_class_peek_parent (klass);
 154         gobject_class->finalize = modest_progress_bar_widget_finalize;
 155
 156         g_type_class_add_private (gobject_class, sizeof(ModestProgressBarWidgetPrivate));
 157 }
 158
 159 static void
 160 modest_progress_bar_widget_init (ModestProgressBarWidget *self)
 161 {
 162
 163         ModestProgressBarWidgetPrivate *priv;
 164         GtkWidget *align = NULL;
 165         GtkRequisition req;
 166         GtkAdjustment *adj;
 167
 168         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(self);
 169
 170         /* Alignment */
 171         align = gtk_alignment_new(XALIGN, YALIGN, XSPACE, YSPACE);
 172
 173         /* Build GtkProgressBar */
 174         adj = (GtkAdjustment *) gtk_adjustment_new (0, LOWER, UPPER, 0, 0, 0);
 175         priv->progress_bar = gtk_progress_bar_new_with_adjustment (adj);
 176         req.width = 228;
 177         req.height = 64;
 178         gtk_progress_set_text_alignment (GTK_PROGRESS (priv->progress_bar), 0, 0.5);
 179         gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar), PANGO_ELLIPSIZE_END);
 180         gtk_progress_bar_set_pulse_step (GTK_PROGRESS_BAR (priv->progress_bar), 0.05);
 181         gtk_widget_size_request (priv->progress_bar, &req);
 182         gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
 183         gtk_widget_size_request (align, &req);
 184
 185         /* Add progress bar widget */
 186         gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
 187         gtk_widget_show_all (GTK_WIDGET(self));
 188 }
 189
 190 static void
 191 modest_progress_bar_widget_finalize (GObject *obj)
 192 {
 193         ModestProgressBarWidgetPrivate *priv;
 194
 195         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(obj);
 196         if (priv->observables) {
 197                 GSList *tmp;
 198
 199                 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
 200                         ObservableData *ob_data = tmp->data;
 201                         g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
 202                         g_object_unref (ob_data->mail_op);
 203                         g_free (ob_data);
 204                 }
 205                 g_slist_free (priv->observables);
 206                 priv->observables = NULL;
 207         }
 208
 209         G_OBJECT_CLASS(parent_class)->finalize (obj);
 210 }
 211
 212
 213 static void
 214 modest_progress_bar_add_operation (ModestProgressObject *self,
 215                                    ModestMailOperation  *mail_op)
 216 {
 217         ModestProgressBarWidget *me = NULL;
 218         ObservableData *data = NULL;
 219         ModestProgressBarWidgetPrivate *priv = NULL;
 220
 221         me = MODEST_PROGRESS_BAR_WIDGET (self);
 222         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 223
 224         data = g_malloc0 (sizeof (ObservableData));
 225         data->mail_op = g_object_ref (mail_op);
 226         data->signal_handler = g_signal_connect (data->mail_op,
 227                                                  "progress-changed",
 228                                                  G_CALLBACK (on_progress_changed),
 229                                                  me);
 230         /* Set curent operation */
 231         if (priv->current == NULL) {
 232                 priv->current = mail_op;
 233
 234                 priv->count = 0;
 235
 236                 /* Call progress_change handler to initialize progress message */
 237 /*              modest_progress_bar_widget_set_undetermined_progress (MODEST_PROGRESS_BAR_WIDGET(self), mail_op); */
 238         }
 239
 240         /* Add operation to obserbable objects list */
 241         priv->observables = g_slist_prepend (priv->observables, data);
 242 }
 243
 244 static gint
 245 compare_observable_data (ObservableData *data1, ObservableData *data2)
 246 {
 247         if (data1->mail_op == data2->mail_op)
 248                 return 0;
 249         else
 250                 return 1;
 251 }
 252
 253 static void
 254 modest_progress_bar_remove_operation (ModestProgressObject *self,
 255                                       ModestMailOperation  *mail_op)
 256 {
 257         ModestProgressBarWidget *me;
 258         ModestProgressBarWidgetPrivate *priv;
 259         GSList *link;
 260         ObservableData *tmp_data = NULL;
 261         gboolean is_current;
 262
 263         me = MODEST_PROGRESS_BAR_WIDGET (self);
 264         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 265
 266         is_current = (priv->current == mail_op);
 267
 268         /* Find item */
 269         tmp_data = g_malloc0 (sizeof (ObservableData));
 270         tmp_data->mail_op = mail_op;
 271         link = g_slist_find_custom (priv->observables,
 272                                     tmp_data,
 273                                     (GCompareFunc) compare_observable_data);
 274
 275         /* Remove the item */
 276         if (link) {
 277                 ObservableData *ob_data = link->data;
 278                 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
 279                 g_object_unref (ob_data->mail_op);
 280                 g_free (ob_data);
 281                 priv->observables = g_slist_delete_link (priv->observables, link);
 282                 tmp_data->mail_op = NULL;
 283                 link = NULL;
 284         }
 285
 286         /* Update the current mail operation */
 287         if (is_current) {
 288                 if (priv->observables)
 289                         priv->current = ((ObservableData *) priv->observables->data)->mail_op;
 290                 else
 291                         priv->current = NULL;
 292
 293                 /* Refresh the view */
 294                 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
 295         }
 296
 297         /* free */
 298         g_free(tmp_data);
 299 }
 300
 301 static guint
 302 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
 303 {
 304         ModestProgressBarWidget *me;
 305         ModestProgressBarWidgetPrivate *priv;
 306
 307         me = MODEST_PROGRESS_BAR_WIDGET (self);
 308         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 309
 310         return g_slist_length(priv->observables);
 311 }
 312
 313 static void
 314 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
 315 {
 316         ModestProgressBarWidget *me;
 317         ModestProgressBarWidgetPrivate *priv;
 318
 319         me = MODEST_PROGRESS_BAR_WIDGET (self);
 320         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 321
 322         if (priv->current == NULL) return;
 323
 324         modest_mail_operation_cancel (priv->current);
 325 }
 326
 327 static void
 328 modest_progress_bar_cancel_all_operations (ModestProgressObject *self)
 329 {
 330         ModestProgressBarWidget *me;
 331         ModestProgressBarWidgetPrivate *priv;
 332
 333         me = MODEST_PROGRESS_BAR_WIDGET (self);
 334         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 335
 336         /* Cancel all the mail operations */
 337         modest_mail_operation_queue_cancel_all (modest_runtime_get_mail_operation_queue ());
 338 }
 339
 340 static void
 341 on_progress_changed (ModestMailOperation  *mail_op,
 342                      ModestMailOperationState *state,
 343                      ModestProgressBarWidget *self)
 344 {
 345         ModestProgressBarWidgetPrivate *priv;
 346         gboolean determined = FALSE;
 347
 348         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
 349
 350         /* If the mail operation is the currently shown one */
 351         if (priv->current == mail_op) {
 352                 gchar *msg = NULL;
 353
 354                 determined = (state->done > 0 && state->total > 1) &&
 355                         !(state->done == 1 && state->total == 100);
 356
 357                 switch (state->op_type) {
 358                 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
 359                         if (determined)
 360                                 msg = g_strdup_printf(_("mcen_me_receiving"),
 361                                                       state->done, state->total);
 362                         else
 363                                 msg = g_strdup(_("mail_me_receiving"));
 364                         break;
 365                 case MODEST_MAIL_OPERATION_TYPE_SEND:
 366                         if (determined)
 367                                 msg = g_strdup_printf(_("mcen_me_sending"), state->done,
 368                                                       state->total);
 369                         else
 370                                 msg = g_strdup(_("mail_me_sending"));
 371                         break;
 372
 373                 case MODEST_MAIL_OPERATION_TYPE_OPEN:
 374                         msg = g_strdup(_("mail_me_opening"));
 375                         break;
 376                 default:
 377                         msg = g_strdup("");
 378                 }
 379
 380                 /* If we have byte information use it */
 381                 if ((state->bytes_done != 0) && (state->bytes_total != 0))
 382                         modest_progress_bar_widget_set_progress (self, msg,
 383                                                                  state->bytes_done,
 384                                                                  state->bytes_total);
 385                 else
 386                         modest_progress_bar_widget_set_progress (self, msg,
 387                                                                  state->done,
 388                                                                  state->total);
 389                 g_free (msg);
 390         }
 391 }
 392
 393 static gboolean
 394 progressbar_clean (GtkProgressBar *bar)
 395 {
 396         gtk_progress_bar_set_fraction (bar, 0);
 397         gtk_progress_bar_set_text (bar, 0);
 398         return FALSE;
 399 }
 400
 401
 402 GtkWidget*
 403 modest_progress_bar_widget_new ()
 404 {
 405         return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
 406 }
 407
 408
 409 void
 410 modest_progress_bar_widget_set_progress (ModestProgressBarWidget *self,
 411                                          const gchar *message,
 412                                          gint done,
 413                                          gint total)
 414 {
 415         ModestProgressBarWidgetPrivate *priv;
 416         gboolean determined = FALSE;
 417
 418         g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
 419         g_return_if_fail (done <= total);
 420
 421         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
 422
 423         priv->count++;
 424
 425         /* Set progress. Tinymail sometimes returns us 1/100 when it
 426            does not have any clue, NOTE that 1/100 could be also a
 427            valid progress (we will loose it), but it will be recovered
 428            once the done is greater than 1 */
 429         determined = (done > 0 && total > 1) &&
 430                 !(done == 1 && total == 100);
 431 /*      if ((done == 0 && total == 0) ||  */
 432 /*          (done == 1 && total == 100)) { */
 433         if (!determined) {
 434 /*              gtk_progress_bar_set_bar_style (GTK_PROGRESS_BAR (priv->progress_bar), /\* Deprecated *\/ */
 435 /*                                              GTK_PROGRESS_CONTINUOUS); */
 436                 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
 437         } else {
 438                 gdouble percent = 0;
 439                 if (total != 0) /* Avoid division by zero. */
 440                         percent = (gdouble)done/(gdouble)total;
 441
 442                 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
 443                                                percent);
 444         }
 445
 446         /* Set text */
 447         gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), message);
 448 }
 449
 450
 451 void
 452 modest_progress_bar_widget_set_undetermined_progress (ModestProgressBarWidget *self,
 453                                                       ModestMailOperation *mail_op)
 454 {
 455         ModestMailOperationState *state = NULL;
 456
 457         state = g_malloc0(sizeof(ModestMailOperationState));
 458         state->done = 0;
 459         state->total = 0;
 460         state->op_type = modest_mail_operation_get_type_operation (mail_op);
 461         on_progress_changed (mail_op, state, self);
 462         g_free(state);
 463 }