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