1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
31 #include <glib/gi18n.h>
33 #include "widgets/modest-progress-bar.h"
34 #include "modest-tny-account.h"
35 #include "modest-platform.h"
36 #include "modest-runtime.h"
38 /* 'private'/'protected' functions */
39 static void modest_progress_bar_class_init (ModestProgressBarClass *klass);
40 static void modest_progress_bar_init (ModestProgressBar *obj);
41 static void modest_progress_bar_finalize (GObject *obj);
43 static void modest_progress_bar_add_operation (ModestProgressObject *self,
44 ModestMailOperation *mail_op);
46 static void modest_progress_bar_remove_operation (ModestProgressObject *self,
47 ModestMailOperation *mail_op);
49 static void modest_progress_bar_cancel_current_operation (ModestProgressObject *self);
51 static void modest_progress_bar_cancel_all_operations (ModestProgressObject *self);
53 static guint modest_progress_bar_num_pending_operations (ModestProgressObject *self);
55 static void on_progress_changed (ModestMailOperation *mail_op,
56 ModestMailOperationState *state,
57 ModestProgressBar *self);
59 static gboolean progressbar_clean (GtkProgressBar *bar);
61 static gboolean modest_progress_bar_is_pulsating (ModestProgressBar *self);
63 static void modest_progress_bar_set_pulsating_mode (ModestProgressBar *self,
65 gboolean is_pulsating);
67 static gchar *progress_string (ModestMailOperationTypeOperation op_type, guint done, guint total);
77 #define MODEST_PROGRESS_BAR_PULSE_INTERVAL 125
84 typedef struct _ObservableData ObservableData;
85 struct _ObservableData {
87 ModestMailOperation *mail_op;
90 typedef struct _ModestProgressBarPrivate ModestProgressBarPrivate;
91 struct _ModestProgressBarPrivate {
93 ModestMailOperation *current;
95 GtkWidget *progress_bar;
96 guint pulsating_timeout;
98 #define MODEST_PROGRESS_BAR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
99 MODEST_TYPE_PROGRESS_BAR_WIDGET, \
100 ModestProgressBarPrivate))
103 static GtkContainerClass *parent_class = NULL;
105 /* uncomment the following if you have defined any signals */
106 /* static guint signals[LAST_SIGNAL] = {0}; */
109 modest_progress_object_init (gpointer g, gpointer iface_data)
111 ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
113 klass->add_operation_func = modest_progress_bar_add_operation;
114 klass->remove_operation_func = modest_progress_bar_remove_operation;
115 klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
116 klass->cancel_all_operations_func = modest_progress_bar_cancel_all_operations;
117 klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
122 modest_progress_bar_get_type (void)
124 static GType my_type = 0;
126 static const GTypeInfo my_info = {
127 sizeof(ModestProgressBarClass),
128 NULL, /* base init */
129 NULL, /* base finalize */
130 (GClassInitFunc) modest_progress_bar_class_init,
131 NULL, /* class finalize */
132 NULL, /* class data */
133 sizeof(ModestProgressBar),
135 (GInstanceInitFunc) modest_progress_bar_init,
139 static const GInterfaceInfo modest_progress_object_info =
141 (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
142 NULL, /* interface_finalize */
143 NULL /* interface_data */
146 my_type = g_type_register_static (GTK_TYPE_VBOX,
150 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
151 &modest_progress_object_info);
157 modest_progress_bar_class_init (ModestProgressBarClass *klass)
159 GObjectClass *gobject_class;
160 gobject_class = (GObjectClass*) klass;
162 parent_class = g_type_class_peek_parent (klass);
163 gobject_class->finalize = modest_progress_bar_finalize;
165 g_type_class_add_private (gobject_class, sizeof(ModestProgressBarPrivate));
169 modest_progress_bar_init (ModestProgressBar *self)
172 ModestProgressBarPrivate *priv;
173 GtkWidget *align = NULL;
177 priv = MODEST_PROGRESS_BAR_GET_PRIVATE(self);
180 align = gtk_alignment_new(XALIGN, YALIGN, XSPACE, YSPACE);
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);
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.25);
190 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), " ");
191 gtk_widget_size_request (priv->progress_bar, &req);
192 gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
193 gtk_widget_size_request (align, &req);
195 /* Add progress bar widget */
196 gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
197 gtk_widget_show_all (GTK_WIDGET(self));
199 priv->pulsating_timeout = 0;
203 modest_progress_bar_finalize (GObject *obj)
205 ModestProgressBarPrivate *priv;
207 priv = MODEST_PROGRESS_BAR_GET_PRIVATE(obj);
208 if (priv->observables) {
211 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
212 ObservableData *ob_data = tmp->data;
213 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
214 g_object_unref (ob_data->mail_op);
217 g_slist_free (priv->observables);
218 priv->observables = NULL;
222 if (priv->pulsating_timeout != 0)
223 g_source_remove (priv->pulsating_timeout);
225 G_OBJECT_CLASS(parent_class)->finalize (obj);
230 modest_progress_bar_add_operation (ModestProgressObject *self,
231 ModestMailOperation *mail_op)
233 ModestProgressBar *me = NULL;
234 ObservableData *data = NULL;
235 ModestProgressBarPrivate *priv = NULL;
237 me = MODEST_PROGRESS_BAR (self);
238 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
240 data = g_malloc0 (sizeof (ObservableData));
241 data->mail_op = g_object_ref (mail_op);
242 data->signal_handler = g_signal_connect (data->mail_op,
244 G_CALLBACK (on_progress_changed),
246 /* Set curent operation */
247 if (priv->current == NULL) {
248 priv->current = mail_op;
252 /* Call progress_change handler to initialize progress message */
253 /* modest_progress_bar_set_undetermined_progress (MODEST_PROGRESS_BAR(self), mail_op); */
256 /* Add operation to obserbable objects list */
257 priv->observables = g_slist_prepend (priv->observables, data);
261 compare_observable_data (ObservableData *data1, ObservableData *data2)
263 if (data1->mail_op == data2->mail_op)
270 modest_progress_bar_remove_operation (ModestProgressObject *self,
271 ModestMailOperation *mail_op)
273 ModestProgressBar *me;
274 ModestProgressBarPrivate *priv;
276 ObservableData *tmp_data = NULL;
279 me = MODEST_PROGRESS_BAR (self);
280 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
282 is_current = (priv->current == mail_op);
285 tmp_data = g_malloc0 (sizeof (ObservableData));
286 tmp_data->mail_op = mail_op;
287 link = g_slist_find_custom (priv->observables,
289 (GCompareFunc) compare_observable_data);
291 /* Remove the item */
293 ObservableData *ob_data = link->data;
294 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
295 g_object_unref (ob_data->mail_op);
297 priv->observables = g_slist_delete_link (priv->observables, link);
298 tmp_data->mail_op = NULL;
302 /* Update the current mail operation */
304 if (priv->observables) {
306 priv->current = ((ObservableData *) priv->observables->data)->mail_op;
307 msg = progress_string (modest_mail_operation_get_type_operation (MODEST_MAIL_OPERATION (priv->current)), 0, 0);
308 modest_progress_bar_set_pulsating_mode (me, msg, TRUE);
311 priv->current = NULL;
312 modest_progress_bar_set_pulsating_mode (me, NULL, FALSE);
313 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
316 /* Refresh the view */
324 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
326 ModestProgressBar *me;
327 ModestProgressBarPrivate *priv;
329 me = MODEST_PROGRESS_BAR (self);
330 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
332 return g_slist_length(priv->observables);
336 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
338 ModestProgressBar *me;
339 ModestProgressBarPrivate *priv;
341 me = MODEST_PROGRESS_BAR (self);
342 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
344 if (priv->current == NULL) return;
346 modest_mail_operation_cancel (priv->current);
350 modest_progress_bar_cancel_all_operations (ModestProgressObject *self)
352 ModestProgressBar *me;
353 ModestProgressBarPrivate *priv;
355 me = MODEST_PROGRESS_BAR (self);
356 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
358 /* Cancel all the mail operations */
359 modest_mail_operation_queue_cancel_all (modest_runtime_get_mail_operation_queue ());
363 progress_string (ModestMailOperationTypeOperation op_type, guint done, guint total)
365 gboolean determined = FALSE;
369 determined = (done > 0 && total > 1) &&
370 !(done == 1 && total == 100);
373 case MODEST_MAIL_OPERATION_TYPE_SEND_AND_RECEIVE:
374 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
376 msg = g_strdup_printf(_("mcen_me_receiving"),
379 msg = g_strdup(_("mail_me_receiving"));
381 case MODEST_MAIL_OPERATION_TYPE_SEND:
383 msg = g_strdup_printf(_("mcen_me_sending"), done,
386 msg = g_strdup(_("mail_me_sending"));
397 on_progress_changed (ModestMailOperation *mail_op,
398 ModestMailOperationState *state,
399 ModestProgressBar *self)
401 ModestProgressBarPrivate *priv;
403 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
405 /* If the mail operation is the currently shown one */
406 if (priv->current == mail_op) {
409 msg = progress_string (state->op_type, state->done, state->total);
411 /* If we have byte information use it */
412 if ((state->bytes_done != 0) && (state->bytes_total != 0))
413 modest_progress_bar_set_progress (self, msg,
416 else if ((state->done == 0) && (state->total == 0))
417 modest_progress_bar_set_pulsating_mode (self, msg, TRUE);
419 modest_progress_bar_set_progress (self, msg,
427 progressbar_clean (GtkProgressBar *bar)
430 gtk_progress_bar_set_fraction (bar, 0);
431 gtk_progress_bar_set_text (bar, " ");
438 modest_progress_bar_new ()
440 return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
445 modest_progress_bar_set_progress (ModestProgressBar *self,
446 const gchar *message,
450 ModestProgressBarPrivate *priv;
451 gboolean determined = FALSE;
453 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
454 g_return_if_fail (done <= total);
456 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
460 if (modest_progress_bar_is_pulsating (self))
461 modest_progress_bar_set_pulsating_mode (self, NULL, FALSE);
463 /* Set progress. Tinymail sometimes returns us 1/100 when it
464 does not have any clue, NOTE that 1/100 could be also a
465 valid progress (we will loose it), but it will be recovered
466 once the done is greater than 1 */
467 determined = (done > 0 && total > 1) &&
468 !(done == 1 && total == 100);
470 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
473 if (total != 0) /* Avoid division by zero. */
474 percent = (gdouble)done/(gdouble)total;
476 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
481 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar),
482 (message && message[0] != '\0')?message:" ");
487 modest_progress_bar_set_undetermined_progress (ModestProgressBar *self,
488 ModestMailOperation *mail_op)
490 ModestMailOperationState *state = NULL;
492 state = g_malloc0(sizeof(ModestMailOperationState));
495 state->op_type = modest_mail_operation_get_type_operation (mail_op);
496 on_progress_changed (mail_op, state, self);
500 /* this has to be explicitly removed */
502 do_pulse (gpointer data)
504 ModestProgressBarPrivate *priv;
506 g_return_val_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(data), FALSE);
508 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (data);
509 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
514 modest_progress_bar_is_pulsating (ModestProgressBar *self)
516 ModestProgressBarPrivate *priv;
518 g_return_val_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self), FALSE);
520 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
522 return priv->pulsating_timeout != 0;
526 modest_progress_bar_set_pulsating_mode (ModestProgressBar *self,
528 gboolean is_pulsating)
530 ModestProgressBarPrivate *priv;
532 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
534 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
537 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), msg);
539 if (is_pulsating == (priv->pulsating_timeout != 0))
541 else if (is_pulsating && (priv->pulsating_timeout == 0)) {
543 priv->pulsating_timeout = g_timeout_add (MODEST_PROGRESS_BAR_PULSE_INTERVAL,
545 } else if (!is_pulsating && (priv->pulsating_timeout != 0)) {
547 g_source_remove (priv->pulsating_timeout);
548 priv->pulsating_timeout = 0;