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_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), " ");
 182         gtk_widget_size_request (priv->progress_bar, &req);
 183         gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
 184         gtk_widget_size_request (align, &req);
 185
 186         /* Add progress bar widget */
 187         gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
 188         gtk_widget_show_all (GTK_WIDGET(self));
 189 }
 190
 191 static void
 192 modest_progress_bar_widget_finalize (GObject *obj)
 193 {
 194         ModestProgressBarWidgetPrivate *priv;
 195
 196         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE(obj);
 197         if (priv->observables) {
 198                 GSList *tmp;
 199
 200                 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
 201                         ObservableData *ob_data = tmp->data;
 202                         g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
 203                         g_object_unref (ob_data->mail_op);
 204                         g_free (ob_data);
 205                 }
 206                 g_slist_free (priv->observables);
 207                 priv->observables = NULL;
 208         }
 209
 210         G_OBJECT_CLASS(parent_class)->finalize (obj);
 211 }
 212
 213
 214 static void
 215 modest_progress_bar_add_operation (ModestProgressObject *self,
 216                                    ModestMailOperation  *mail_op)
 217 {
 218         ModestProgressBarWidget *me = NULL;
 219         ObservableData *data = NULL;
 220         ModestProgressBarWidgetPrivate *priv = NULL;
 221
 222         me = MODEST_PROGRESS_BAR_WIDGET (self);
 223         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 224
 225         data = g_malloc0 (sizeof (ObservableData));
 226         data->mail_op = g_object_ref (mail_op);
 227         data->signal_handler = g_signal_connect (data->mail_op,
 228                                                  "progress-changed",
 229                                                  G_CALLBACK (on_progress_changed),
 230                                                  me);
 231         /* Set curent operation */
 232         if (priv->current == NULL) {
 233                 priv->current = mail_op;
 234
 235                 priv->count = 0;
 236
 237                 /* Call progress_change handler to initialize progress message */
 238 /*              modest_progress_bar_widget_set_undetermined_progress (MODEST_PROGRESS_BAR_WIDGET(self), mail_op); */
 239         }
 240
 241         /* Add operation to obserbable objects list */
 242         priv->observables = g_slist_prepend (priv->observables, data);
 243 }
 244
 245 static gint
 246 compare_observable_data (ObservableData *data1, ObservableData *data2)
 247 {
 248         if (data1->mail_op == data2->mail_op)
 249                 return 0;
 250         else
 251                 return 1;
 252 }
 253
 254 static void
 255 modest_progress_bar_remove_operation (ModestProgressObject *self,
 256                                       ModestMailOperation  *mail_op)
 257 {
 258         ModestProgressBarWidget *me;
 259         ModestProgressBarWidgetPrivate *priv;
 260         GSList *link;
 261         ObservableData *tmp_data = NULL;
 262         gboolean is_current;
 263
 264         me = MODEST_PROGRESS_BAR_WIDGET (self);
 265         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 266
 267         is_current = (priv->current == mail_op);
 268
 269         /* Find item */
 270         tmp_data = g_malloc0 (sizeof (ObservableData));
 271         tmp_data->mail_op = mail_op;
 272         link = g_slist_find_custom (priv->observables,
 273                                     tmp_data,
 274                                     (GCompareFunc) compare_observable_data);
 275
 276         /* Remove the item */
 277         if (link) {
 278                 ObservableData *ob_data = link->data;
 279                 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
 280                 g_object_unref (ob_data->mail_op);
 281                 g_free (ob_data);
 282                 priv->observables = g_slist_delete_link (priv->observables, link);
 283                 tmp_data->mail_op = NULL;
 284                 link = NULL;
 285         }
 286
 287         /* Update the current mail operation */
 288         if (is_current) {
 289                 if (priv->observables)
 290                         priv->current = ((ObservableData *) priv->observables->data)->mail_op;
 291                 else
 292                         priv->current = NULL;
 293
 294                 /* Refresh the view */
 295                 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
 296         }
 297
 298         /* free */
 299         g_free(tmp_data);
 300 }
 301
 302 static guint
 303 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
 304 {
 305         ModestProgressBarWidget *me;
 306         ModestProgressBarWidgetPrivate *priv;
 307
 308         me = MODEST_PROGRESS_BAR_WIDGET (self);
 309         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 310
 311         return g_slist_length(priv->observables);
 312 }
 313
 314 static void
 315 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
 316 {
 317         ModestProgressBarWidget *me;
 318         ModestProgressBarWidgetPrivate *priv;
 319
 320         me = MODEST_PROGRESS_BAR_WIDGET (self);
 321         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (me);
 322
 323         if (priv->current == NULL) return;
 324
 325         modest_mail_operation_cancel (priv->current);
 326 }
 327
 328 static void
 329 modest_progress_bar_cancel_all_operations (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         /* Cancel all the mail operations */
 338         modest_mail_operation_queue_cancel_all (modest_runtime_get_mail_operation_queue ());
 339 }
 340
 341 static void
 342 on_progress_changed (ModestMailOperation  *mail_op,
 343                      ModestMailOperationState *state,
 344                      ModestProgressBarWidget *self)
 345 {
 346         ModestProgressBarWidgetPrivate *priv;
 347         gboolean determined = FALSE;
 348
 349         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
 350
 351         /* If the mail operation is the currently shown one */
 352         if (priv->current == mail_op) {
 353                 gchar *msg = NULL;
 354
 355                 determined = (state->done > 0 && state->total > 1) &&
 356                         !(state->done == 1 && state->total == 100);
 357
 358                 switch (state->op_type) {
 359                 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
 360                         if (determined)
 361                                 msg = g_strdup_printf(_("mcen_me_receiving"),
 362                                                       state->done, state->total);
 363                         else
 364                                 msg = g_strdup(_("mail_me_receiving"));
 365                         break;
 366                 case MODEST_MAIL_OPERATION_TYPE_SEND:
 367                         if (determined)
 368                                 msg = g_strdup_printf(_("mcen_me_sending"), state->done,
 369                                                       state->total);
 370                         else
 371                                 msg = g_strdup(_("mail_me_sending"));
 372                         break;
 373
 374                 case MODEST_MAIL_OPERATION_TYPE_OPEN:
 375                         msg = g_strdup(_("mail_me_opening"));
 376                         break;
 377                 default:
 378                         msg = g_strdup("");
 379                 }
 380
 381                 /* If we have byte information use it */
 382                 if ((state->bytes_done != 0) && (state->bytes_total != 0))
 383                         modest_progress_bar_widget_set_progress (self, msg,
 384                                                                  state->bytes_done,
 385                                                                  state->bytes_total);
 386                 else
 387                         modest_progress_bar_widget_set_progress (self, msg,
 388                                                                  state->done,
 389                                                                  state->total);
 390                 g_free (msg);
 391         }
 392 }
 393
 394 static gboolean
 395 progressbar_clean (GtkProgressBar *bar)
 396 {
 397         gtk_progress_bar_set_fraction (bar, 0);
 398         gtk_progress_bar_set_text (bar, " ");
 399         return FALSE;
 400 }
 401
 402
 403 GtkWidget*
 404 modest_progress_bar_widget_new ()
 405 {
 406         return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
 407 }
 408
 409
 410 void
 411 modest_progress_bar_widget_set_progress (ModestProgressBarWidget *self,
 412                                          const gchar *message,
 413                                          gint done,
 414                                          gint total)
 415 {
 416         ModestProgressBarWidgetPrivate *priv;
 417         gboolean determined = FALSE;
 418
 419         g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
 420         g_return_if_fail (done <= total);
 421
 422         priv = MODEST_PROGRESS_BAR_WIDGET_GET_PRIVATE (self);
 423
 424         priv->count++;
 425
 426         /* Set progress. Tinymail sometimes returns us 1/100 when it
 427            does not have any clue, NOTE that 1/100 could be also a
 428            valid progress (we will loose it), but it will be recovered
 429            once the done is greater than 1 */
 430         determined = (done > 0 && total > 1) &&
 431                 !(done == 1 && total == 100);
 432         if (!determined) {
 433                 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
 434         } else {
 435                 gdouble percent = 0;
 436                 if (total != 0) /* Avoid division by zero. */
 437                         percent = (gdouble)done/(gdouble)total;
 438
 439                 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
 440                                                percent);
 441         }
 442
 443         /* Set text */
 444         gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar),
 445                                    (message && message[0] != '\0')?message:" ");
 446 }
 447
 448
 449 void
 450 modest_progress_bar_widget_set_undetermined_progress (ModestProgressBarWidget *self,
 451                                                       ModestMailOperation *mail_op)
 452 {
 453         ModestMailOperationState *state = NULL;
 454
 455         state = g_malloc0(sizeof(ModestMailOperationState));
 456         state->done = 0;
 457         state->total = 0;
 458         state->op_type = modest_mail_operation_get_type_operation (mail_op);
 459         on_progress_changed (mail_op, state, self);
 460         g_free(state);
 461 }