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-combo-box.h>
34 #include "widgets/modest-progress-bar.h"
35 #include "modest-tny-account.h"
36 #include "modest-platform.h"
37 #include "modest-runtime.h"
39 /* 'private'/'protected' functions */
40 static void modest_progress_bar_class_init (ModestProgressBarClass *klass);
41 static void modest_progress_bar_init (ModestProgressBar *obj);
42 static void modest_progress_bar_finalize (GObject *obj);
44 static void modest_progress_bar_add_operation (ModestProgressObject *self,
45 ModestMailOperation *mail_op);
47 static void modest_progress_bar_remove_operation (ModestProgressObject *self,
48 ModestMailOperation *mail_op);
50 static void modest_progress_bar_cancel_current_operation (ModestProgressObject *self);
52 static void modest_progress_bar_cancel_all_operations (ModestProgressObject *self);
54 static guint modest_progress_bar_num_pending_operations (ModestProgressObject *self);
56 static void on_progress_changed (ModestMailOperation *mail_op,
57 ModestMailOperationState *state,
58 ModestProgressBar *self);
60 static gboolean progressbar_clean (GtkProgressBar *bar);
62 static gboolean modest_progress_bar_is_pulsating (ModestProgressBar *self);
64 static void modest_progress_bar_set_pulsating_mode (ModestProgressBar *self,
66 gboolean is_pulsating);
68 static gchar *progress_string (ModestMailOperationTypeOperation op_type, guint done, guint total);
78 #define MODEST_PROGRESS_BAR_PULSE_INTERVAL 125
85 typedef struct _ObservableData ObservableData;
86 struct _ObservableData {
88 ModestMailOperation *mail_op;
91 typedef struct _ModestProgressBarPrivate ModestProgressBarPrivate;
92 struct _ModestProgressBarPrivate {
94 ModestMailOperation *current;
96 GtkWidget *progress_bar;
97 guint pulsating_timeout;
99 #define MODEST_PROGRESS_BAR_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
100 MODEST_TYPE_PROGRESS_BAR_WIDGET, \
101 ModestProgressBarPrivate))
104 static GtkContainerClass *parent_class = NULL;
106 /* uncomment the following if you have defined any signals */
107 /* static guint signals[LAST_SIGNAL] = {0}; */
110 modest_progress_object_init (gpointer g, gpointer iface_data)
112 ModestProgressObjectIface *klass = (ModestProgressObjectIface *)g;
114 klass->add_operation_func = modest_progress_bar_add_operation;
115 klass->remove_operation_func = modest_progress_bar_remove_operation;
116 klass->cancel_current_operation_func = modest_progress_bar_cancel_current_operation;
117 klass->cancel_all_operations_func = modest_progress_bar_cancel_all_operations;
118 klass->num_pending_operations_func = modest_progress_bar_num_pending_operations;
123 modest_progress_bar_get_type (void)
125 static GType my_type = 0;
127 static const GTypeInfo my_info = {
128 sizeof(ModestProgressBarClass),
129 NULL, /* base init */
130 NULL, /* base finalize */
131 (GClassInitFunc) modest_progress_bar_class_init,
132 NULL, /* class finalize */
133 NULL, /* class data */
134 sizeof(ModestProgressBar),
136 (GInstanceInitFunc) modest_progress_bar_init,
140 static const GInterfaceInfo modest_progress_object_info =
142 (GInterfaceInitFunc) modest_progress_object_init, /* interface_init */
143 NULL, /* interface_finalize */
144 NULL /* interface_data */
147 my_type = g_type_register_static (GTK_TYPE_VBOX,
151 g_type_add_interface_static (my_type, MODEST_TYPE_PROGRESS_OBJECT,
152 &modest_progress_object_info);
158 modest_progress_bar_class_init (ModestProgressBarClass *klass)
160 GObjectClass *gobject_class;
161 gobject_class = (GObjectClass*) klass;
163 parent_class = g_type_class_peek_parent (klass);
164 gobject_class->finalize = modest_progress_bar_finalize;
166 g_type_class_add_private (gobject_class, sizeof(ModestProgressBarPrivate));
170 modest_progress_bar_init (ModestProgressBar *self)
173 ModestProgressBarPrivate *priv;
174 GtkWidget *align = NULL;
178 priv = MODEST_PROGRESS_BAR_GET_PRIVATE(self);
181 align = gtk_alignment_new(XALIGN, YALIGN, XSPACE, YSPACE);
183 /* Build GtkProgressBar */
184 adj = (GtkAdjustment *) gtk_adjustment_new (0, LOWER, UPPER, 0, 0, 0);
185 priv->progress_bar = gtk_progress_bar_new_with_adjustment (adj);
188 gtk_progress_set_text_alignment (GTK_PROGRESS (priv->progress_bar), 0, 0.5);
189 gtk_progress_bar_set_ellipsize (GTK_PROGRESS_BAR (priv->progress_bar), PANGO_ELLIPSIZE_END);
190 gtk_progress_bar_set_pulse_step (GTK_PROGRESS_BAR (priv->progress_bar), 0.25);
191 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), " ");
192 gtk_widget_size_request (priv->progress_bar, &req);
193 gtk_container_add (GTK_CONTAINER (align), priv->progress_bar);
194 gtk_widget_size_request (align, &req);
196 /* Add progress bar widget */
197 gtk_box_pack_start (GTK_BOX(self), align, TRUE, TRUE, 0);
198 gtk_widget_show_all (GTK_WIDGET(self));
200 priv->pulsating_timeout = 0;
204 modest_progress_bar_finalize (GObject *obj)
206 ModestProgressBarPrivate *priv;
208 priv = MODEST_PROGRESS_BAR_GET_PRIVATE(obj);
209 if (priv->observables) {
212 for (tmp = priv->observables; tmp; tmp = g_slist_next (tmp)) {
213 ObservableData *ob_data = tmp->data;
214 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
215 g_object_unref (ob_data->mail_op);
218 g_slist_free (priv->observables);
219 priv->observables = NULL;
223 if (priv->pulsating_timeout != 0)
224 g_source_remove (priv->pulsating_timeout);
226 G_OBJECT_CLASS(parent_class)->finalize (obj);
231 modest_progress_bar_add_operation (ModestProgressObject *self,
232 ModestMailOperation *mail_op)
234 ModestProgressBar *me = NULL;
235 ObservableData *data = NULL;
236 ModestProgressBarPrivate *priv = NULL;
238 me = MODEST_PROGRESS_BAR (self);
239 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
241 data = g_malloc0 (sizeof (ObservableData));
242 data->mail_op = g_object_ref (mail_op);
243 data->signal_handler = g_signal_connect (data->mail_op,
245 G_CALLBACK (on_progress_changed),
247 /* Set curent operation */
248 if (priv->current == NULL) {
249 priv->current = mail_op;
253 /* Call progress_change handler to initialize progress message */
254 /* modest_progress_bar_set_undetermined_progress (MODEST_PROGRESS_BAR(self), mail_op); */
257 /* Add operation to obserbable objects list */
258 priv->observables = g_slist_prepend (priv->observables, data);
262 compare_observable_data (ObservableData *data1, ObservableData *data2)
264 if (data1->mail_op == data2->mail_op)
271 modest_progress_bar_remove_operation (ModestProgressObject *self,
272 ModestMailOperation *mail_op)
274 ModestProgressBar *me;
275 ModestProgressBarPrivate *priv;
277 ObservableData *tmp_data = NULL;
280 me = MODEST_PROGRESS_BAR (self);
281 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
283 is_current = (priv->current == mail_op);
286 tmp_data = g_malloc0 (sizeof (ObservableData));
287 tmp_data->mail_op = mail_op;
288 link = g_slist_find_custom (priv->observables,
290 (GCompareFunc) compare_observable_data);
292 /* Remove the item */
294 ObservableData *ob_data = link->data;
295 g_signal_handler_disconnect (ob_data->mail_op, ob_data->signal_handler);
296 g_object_unref (ob_data->mail_op);
298 priv->observables = g_slist_delete_link (priv->observables, link);
299 tmp_data->mail_op = NULL;
303 /* Update the current mail operation */
305 if (priv->observables) {
307 priv->current = ((ObservableData *) priv->observables->data)->mail_op;
308 msg = progress_string (modest_mail_operation_get_type_operation (MODEST_MAIL_OPERATION (priv->current)), 0, 0);
309 modest_progress_bar_set_pulsating_mode (me, msg, TRUE);
312 priv->current = NULL;
313 modest_progress_bar_set_pulsating_mode (me, NULL, FALSE);
314 progressbar_clean (GTK_PROGRESS_BAR (priv->progress_bar));
317 /* Refresh the view */
325 modest_progress_bar_num_pending_operations (ModestProgressObject *self)
327 ModestProgressBar *me;
328 ModestProgressBarPrivate *priv;
330 me = MODEST_PROGRESS_BAR (self);
331 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
333 return g_slist_length(priv->observables);
337 modest_progress_bar_cancel_current_operation (ModestProgressObject *self)
339 ModestProgressBar *me;
340 ModestProgressBarPrivate *priv;
342 me = MODEST_PROGRESS_BAR (self);
343 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
345 if (priv->current == NULL) return;
347 modest_mail_operation_cancel (priv->current);
351 modest_progress_bar_cancel_all_operations (ModestProgressObject *self)
353 ModestProgressBar *me;
354 ModestProgressBarPrivate *priv;
356 me = MODEST_PROGRESS_BAR (self);
357 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (me);
359 /* Cancel all the mail operations */
360 modest_mail_operation_queue_cancel_all (modest_runtime_get_mail_operation_queue ());
364 progress_string (ModestMailOperationTypeOperation op_type, guint done, guint total)
366 gboolean determined = FALSE;
370 determined = (done > 0 && total > 1) &&
371 !(done == 1 && total == 100);
374 case MODEST_MAIL_OPERATION_TYPE_SEND_AND_RECEIVE:
375 case MODEST_MAIL_OPERATION_TYPE_RECEIVE:
377 msg = g_strdup_printf(_("mcen_me_receiving"),
380 msg = g_strdup(_("mail_me_receiving"));
382 case MODEST_MAIL_OPERATION_TYPE_SEND:
384 msg = g_strdup_printf(_("mcen_me_sending"), done,
387 msg = g_strdup(_("mail_me_sending"));
398 on_progress_changed (ModestMailOperation *mail_op,
399 ModestMailOperationState *state,
400 ModestProgressBar *self)
402 ModestProgressBarPrivate *priv;
404 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
406 /* If the mail operation is the currently shown one */
407 if (priv->current == mail_op) {
410 msg = progress_string (state->op_type, state->done, state->total);
412 /* If we have byte information use it */
413 if ((state->bytes_done != 0) && (state->bytes_total != 0))
414 modest_progress_bar_set_progress (self, msg,
417 else if ((state->done == 0) && (state->total == 0))
418 modest_progress_bar_set_pulsating_mode (self, msg, TRUE);
420 modest_progress_bar_set_progress (self, msg,
428 progressbar_clean (GtkProgressBar *bar)
431 gtk_progress_bar_set_fraction (bar, 0);
432 gtk_progress_bar_set_text (bar, " ");
439 modest_progress_bar_new ()
441 return GTK_WIDGET (g_object_new (MODEST_TYPE_PROGRESS_BAR_WIDGET, NULL));
446 modest_progress_bar_set_progress (ModestProgressBar *self,
447 const gchar *message,
451 ModestProgressBarPrivate *priv;
452 gboolean determined = FALSE;
454 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
455 g_return_if_fail (done <= total);
457 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
461 if (modest_progress_bar_is_pulsating (self))
462 modest_progress_bar_set_pulsating_mode (self, NULL, FALSE);
464 /* Set progress. Tinymail sometimes returns us 1/100 when it
465 does not have any clue, NOTE that 1/100 could be also a
466 valid progress (we will loose it), but it will be recovered
467 once the done is greater than 1 */
468 determined = (done > 0 && total > 1) &&
469 !(done == 1 && total == 100);
471 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
474 if (total != 0) /* Avoid division by zero. */
475 percent = (gdouble)done/(gdouble)total;
477 gtk_progress_bar_set_fraction (GTK_PROGRESS_BAR (priv->progress_bar),
482 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar),
483 (message && message[0] != '\0')?message:" ");
488 modest_progress_bar_set_undetermined_progress (ModestProgressBar *self,
489 ModestMailOperation *mail_op)
491 ModestMailOperationState *state = NULL;
493 state = g_malloc0(sizeof(ModestMailOperationState));
496 state->op_type = modest_mail_operation_get_type_operation (mail_op);
497 on_progress_changed (mail_op, state, self);
501 /* this has to be explicitly removed */
503 do_pulse (gpointer data)
505 ModestProgressBarPrivate *priv;
507 g_return_val_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(data), FALSE);
509 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (data);
510 gtk_progress_bar_pulse (GTK_PROGRESS_BAR (priv->progress_bar));
515 modest_progress_bar_is_pulsating (ModestProgressBar *self)
517 ModestProgressBarPrivate *priv;
519 g_return_val_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self), FALSE);
521 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
523 return priv->pulsating_timeout != 0;
527 modest_progress_bar_set_pulsating_mode (ModestProgressBar *self,
529 gboolean is_pulsating)
531 ModestProgressBarPrivate *priv;
533 g_return_if_fail (MODEST_IS_PROGRESS_BAR_WIDGET(self));
535 priv = MODEST_PROGRESS_BAR_GET_PRIVATE (self);
538 gtk_progress_bar_set_text (GTK_PROGRESS_BAR (priv->progress_bar), msg);
540 if (is_pulsating == (priv->pulsating_timeout != 0))
542 else if (is_pulsating && (priv->pulsating_timeout == 0)) {
544 priv->pulsating_timeout = g_timeout_add (MODEST_PROGRESS_BAR_PULSE_INTERVAL,
546 } else if (!is_pulsating && (priv->pulsating_timeout != 0)) {
548 g_source_remove (priv->pulsating_timeout);
549 priv->pulsating_timeout = 0;