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.
30 #include <glib/gi18n.h>
31 #include "modest-account-view.h"
33 #include <modest-account-mgr.h>
34 #include <modest-account-mgr-helpers.h>
35 #include <modest-text-utils.h>
36 #include <modest-runtime.h>
38 #include <gtk/gtkcellrenderertoggle.h>
39 #include <gtk/gtkcellrenderertext.h>
40 #include <gtk/gtktreeselection.h>
41 #include <gtk/gtkliststore.h>
42 #include <string.h> /* For strcmp(). */
44 /* 'private'/'protected' functions */
45 static void modest_account_view_class_init (ModestAccountViewClass *klass);
46 static void modest_account_view_init (ModestAccountView *obj);
47 static void modest_account_view_finalize (GObject *obj);
49 static void modest_account_view_select_account (ModestAccountView *account_view,
50 const gchar* account_name);
53 MODEST_ACCOUNT_VIEW_NAME_COLUMN,
54 MODEST_ACCOUNT_VIEW_DISPLAY_NAME_COLUMN,
55 MODEST_ACCOUNT_VIEW_IS_ENABLED_COLUMN,
56 MODEST_ACCOUNT_VIEW_IS_DEFAULT_COLUMN,
57 MODEST_ACCOUNT_VIEW_PROTO_COLUMN,
58 MODEST_ACCOUNT_VIEW_LAST_UPDATED_COLUMN,
60 MODEST_ACCOUNT_VIEW_COLUMN_NUM
71 typedef struct _ModestAccountViewPrivate ModestAccountViewPrivate;
72 struct _ModestAccountViewPrivate {
73 ModestAccountMgr *account_mgr;
74 gulong sig1, sig2, sig3;
76 /* When this is TRUE, we ignore configuration key changes.
77 * This is useful when making many changes. */
78 gboolean block_conf_updates;
81 #define MODEST_ACCOUNT_VIEW_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
82 MODEST_TYPE_ACCOUNT_VIEW, \
83 ModestAccountViewPrivate))
85 static GtkTreeViewClass *parent_class = NULL;
87 /* uncomment the following if you have defined any signals */
88 /* static guint signals[LAST_SIGNAL] = {0}; */
91 modest_account_view_get_type (void)
93 static GType my_type = 0;
95 static const GTypeInfo my_info = {
96 sizeof(ModestAccountViewClass),
98 NULL, /* base finalize */
99 (GClassInitFunc) modest_account_view_class_init,
100 NULL, /* class finalize */
101 NULL, /* class data */
102 sizeof(ModestAccountView),
104 (GInstanceInitFunc) modest_account_view_init,
107 my_type = g_type_register_static (GTK_TYPE_TREE_VIEW,
115 modest_account_view_class_init (ModestAccountViewClass *klass)
117 GObjectClass *gobject_class;
118 gobject_class = (GObjectClass*) klass;
120 parent_class = g_type_class_peek_parent (klass);
121 gobject_class->finalize = modest_account_view_finalize;
123 g_type_class_add_private (gobject_class, sizeof(ModestAccountViewPrivate));
127 modest_account_view_init (ModestAccountView *obj)
129 ModestAccountViewPrivate *priv;
131 priv = MODEST_ACCOUNT_VIEW_GET_PRIVATE(obj);
133 priv->account_mgr = NULL;
139 modest_account_view_finalize (GObject *obj)
141 ModestAccountViewPrivate *priv;
143 priv = MODEST_ACCOUNT_VIEW_GET_PRIVATE(obj);
145 if (priv->account_mgr) {
147 g_signal_handler_disconnect (priv->account_mgr, priv->sig1);
150 g_signal_handler_disconnect (priv->account_mgr, priv->sig2);
153 g_signal_handler_disconnect (priv->account_mgr, priv->sig3);
155 g_object_unref (G_OBJECT(priv->account_mgr));
156 priv->account_mgr = NULL;
159 G_OBJECT_CLASS(parent_class)->finalize (obj);
162 /* Get the string for the last updated time. Result must be g_freed */
164 get_last_updated_string(ModestAccountMgr* account_mgr, ModestAccountData *account_data)
166 /* FIXME: let's assume that 'last update' applies to the store account... */
167 gchar* last_updated_string;
168 time_t last_updated = account_data->store_account->last_updated;
169 if (!modest_account_mgr_account_is_busy(account_mgr, account_data->account_name))
171 if (last_updated > 0)
172 last_updated_string = modest_text_utils_get_display_date(last_updated);
174 last_updated_string = g_strdup (_("mcen_va_never"));
178 /* FIXME: There should be a logical name in the UI specs */
179 last_updated_string = g_strdup(_("Refreshing..."));
181 return last_updated_string;
185 update_account_view (ModestAccountMgr *account_mgr, ModestAccountView *view)
187 GSList *account_names, *cursor;
190 model = GTK_LIST_STORE(gtk_tree_view_get_model (GTK_TREE_VIEW(view)));
192 /* Get the ID of the currently-selected account,
193 * so we can select it again after rebuilding the list.
194 * Note that the name doesn't change even when the display name changes.
196 gchar *selected_name = modest_account_view_get_selected_account (view);
198 gtk_list_store_clear (model);
200 /* Note: We do not show disabled accounts.
201 * Of course, this means that there is no UI to enable or disable
202 * accounts. That is OK for maemo where no such feature or UI is
203 * specified, so the "enabled" property is used internally to avoid
204 * showing unfinished accounts. If a user-visible "enabled" is
205 * needed in the future, we must use a second property for the
206 * current use instead */
207 cursor = account_names = modest_account_mgr_account_names (account_mgr,
208 TRUE /* only enabled accounts. */);
211 g_warning ("debug: modest_account_mgr_account_names() returned NULL\n");
215 ModestAccountData *account_data;
217 account_name = (gchar*)cursor->data;
219 account_data = modest_account_mgr_get_account_data (account_mgr, account_name);
221 g_printerr ("modest: failed to get account data for %s\n", account_name);
225 /* don't display accounts without stores */
226 if (account_data->store_account) {
230 gchar *last_updated_string = get_last_updated_string(account_mgr, account_data);
232 if (account_data->is_enabled) {
233 gtk_list_store_insert_with_values (
235 MODEST_ACCOUNT_VIEW_NAME_COLUMN, account_name,
236 MODEST_ACCOUNT_VIEW_DISPLAY_NAME_COLUMN, account_data->display_name,
237 MODEST_ACCOUNT_VIEW_IS_ENABLED_COLUMN, account_data->is_enabled,
238 MODEST_ACCOUNT_VIEW_IS_DEFAULT_COLUMN, account_data->is_default,
240 MODEST_ACCOUNT_VIEW_PROTO_COLUMN,
241 modest_protocol_info_get_transport_store_protocol_name (account_data->store_account->proto),
243 MODEST_ACCOUNT_VIEW_LAST_UPDATED_COLUMN, last_updated_string,
246 g_free (last_updated_string);
249 modest_account_mgr_free_account_data (account_mgr, account_data);
250 cursor = cursor->next;
253 modest_account_mgr_free_account_names (account_names);
254 account_names = NULL;
256 /* Try to re-select the same account: */
258 modest_account_view_select_account (view, selected_name);
259 g_free (selected_name);
265 on_account_changed (ModestAccountMgr *account_mgr,
266 const gchar* account, GSList *keys,
267 gboolean server_account, ModestAccountView *self)
269 /* Never update the view in response to gconf changes.
270 * Always do it explicitly instead.
271 * This is because we have no way to avoid 10 updates when changing
272 * 10 items, and this blocks the UI.
274 * But this block/unblock API might be useful on platforms where the
275 * notification does not happen so long after the key was set.
276 * (We have no way to know when the last key was set, to do a final update)..
279 update_account_view (account_mgr, self);
283 on_account_busy_changed(ModestAccountMgr *account_mgr, const gchar *account_name,
284 gboolean busy, ModestAccountView *self)
286 GtkListStore *model = GTK_LIST_STORE(gtk_tree_view_get_model (GTK_TREE_VIEW(self)));
288 if (!gtk_tree_model_get_iter_first(GTK_TREE_MODEL(model), &iter))
293 gtk_tree_model_get(GTK_TREE_MODEL(model), &iter, MODEST_ACCOUNT_VIEW_NAME_COLUMN,
295 if (g_str_equal(cur_name, account_name))
297 ModestAccountData* account_data =
298 modest_account_mgr_get_account_data (account_mgr, account_name);
301 gchar* last_updated_string = get_last_updated_string(account_mgr, account_data);
302 gtk_list_store_set(model, &iter,
303 MODEST_ACCOUNT_VIEW_LAST_UPDATED_COLUMN, last_updated_string,
305 g_free (last_updated_string);
306 modest_account_mgr_free_account_data (account_mgr, account_data);
310 while (gtk_tree_model_iter_next(GTK_TREE_MODEL(model), &iter));
314 on_account_removed (ModestAccountMgr *account_mgr,
315 const gchar* account, gboolean server_account,
316 ModestAccountView *self)
318 update_account_view (account_mgr, self);
322 /* currently unused */
325 on_account_enable_toggled (GtkCellRendererToggle *cell_renderer, gchar *path,
326 ModestAccountView *self)
329 ModestAccountViewPrivate *priv;
334 priv = MODEST_ACCOUNT_VIEW_GET_PRIVATE(self);
335 model = gtk_tree_view_get_model (GTK_TREE_VIEW(self));
337 if (!gtk_tree_model_get_iter_from_string (model, &iter, path)) {
338 g_printerr ("modest: cannot find iterator\n");
341 gtk_tree_model_get (model, &iter, MODEST_ACCOUNT_VIEW_IS_ENABLED_COLUMN, &enabled,
342 MODEST_ACCOUNT_VIEW_NAME_COLUMN, &account_name,
345 /* toggle enabled / disabled */
346 modest_account_mgr_set_enabled (priv->account_mgr, account_name, !enabled);
347 g_free (account_name);
352 find_default_account(ModestAccountView *self, GtkTreeIter *iter)
354 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (self));
356 for (result = gtk_tree_model_get_iter_first(model, iter);
357 result == TRUE; result = gtk_tree_model_iter_next(model, iter))
360 gtk_tree_model_get (model, iter, MODEST_ACCOUNT_VIEW_IS_DEFAULT_COLUMN, &is_default, -1);
369 on_account_default_toggled (GtkCellRendererToggle *cell_renderer, gchar *path,
370 ModestAccountView *self)
372 gboolean is_default = gtk_cell_renderer_toggle_get_active (cell_renderer);
374 /* Do not allow an account to be marked non-default.
375 * Only allow this to be changed by setting another account to default: */
376 gtk_cell_renderer_toggle_set_active (cell_renderer, TRUE);
380 ModestAccountViewPrivate *priv = MODEST_ACCOUNT_VIEW_GET_PRIVATE(self);
381 GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW(self));
384 if (!gtk_tree_model_get_iter_from_string (model, &iter, path)) {
385 g_printerr ("modest: cannot find iterator\n");
389 gchar *account_name = NULL;
390 gtk_tree_model_get (model, &iter, MODEST_ACCOUNT_VIEW_NAME_COLUMN, &account_name,
393 /* Set this previously-non-default account as the default: */
394 if (modest_account_mgr_set_default_account (priv->account_mgr, account_name))
396 /* Explicitely set default column because we are ignoring gconf changes */
397 GtkTreeIter old_default_iter;
398 if (find_default_account (self, &old_default_iter)) {
399 gtk_list_store_set (GTK_LIST_STORE (model), &old_default_iter,
400 MODEST_ACCOUNT_VIEW_IS_DEFAULT_COLUMN, FALSE, -1);
402 g_warning ("%s: Did not find old default account in view", __FUNCTION__);
405 gtk_list_store_set (GTK_LIST_STORE (model), &iter,
406 MODEST_ACCOUNT_VIEW_IS_DEFAULT_COLUMN, TRUE, -1);
409 g_free (account_name);
413 bold_if_default_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
414 GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer user_data)
417 gtk_tree_model_get (tree_model, iter, MODEST_ACCOUNT_VIEW_IS_DEFAULT_COLUMN,
419 g_object_set (G_OBJECT(renderer),
420 "weight", is_default ? 800: 400,
425 init_view (ModestAccountView *self)
427 ModestAccountViewPrivate *priv;
428 GtkCellRenderer *toggle_renderer, *text_renderer;
430 GtkTreeViewColumn *column;
432 priv = MODEST_ACCOUNT_VIEW_GET_PRIVATE(self);
434 model = gtk_list_store_new (6,
435 G_TYPE_STRING, /* account name */
436 G_TYPE_STRING, /* account display name */
437 G_TYPE_BOOLEAN, /* is-enabled */
438 G_TYPE_BOOLEAN, /* is-default */
439 G_TYPE_STRING, /* account proto (pop, imap,...) */
440 G_TYPE_STRING /* last updated (time_t) */
443 gtk_tree_sortable_set_sort_column_id (
444 GTK_TREE_SORTABLE (model), MODEST_ACCOUNT_VIEW_DISPLAY_NAME_COLUMN,
447 gtk_tree_view_set_model (GTK_TREE_VIEW(self), GTK_TREE_MODEL(model));
448 g_object_unref (G_OBJECT (model));
450 toggle_renderer = gtk_cell_renderer_toggle_new ();
451 text_renderer = gtk_cell_renderer_text_new ();
453 /* the is_default column */
454 g_object_set (G_OBJECT(toggle_renderer), "activatable", TRUE, "radio", TRUE, NULL);
455 gtk_tree_view_append_column (GTK_TREE_VIEW(self),
456 gtk_tree_view_column_new_with_attributes (
457 _("mcen_ti_default"), toggle_renderer,
458 "active", MODEST_ACCOUNT_VIEW_IS_DEFAULT_COLUMN, NULL));
460 /* Disable the Maemo GtkTreeView::allow-checkbox-mode Maemo modification,
461 * which causes the model column to be updated automatically when the row is clicked.
462 * Making this the default in Maemo's GTK+ is obviously a bug:
463 * https://maemo.org/bugzilla/show_bug.cgi?id=146
465 * djcb: indeed, they have been removed for post-bora, i added the ifdefs...
467 #ifdef MODEST_HILDON_VERSION_0
468 g_object_set(G_OBJECT(self), "allow-checkbox-mode", FALSE, NULL);
469 g_object_set(G_OBJECT(toggle_renderer), "checkbox-mode", FALSE, NULL);
470 #endif /*MODEST_HILDON_VERSION_0 */
471 g_signal_connect (G_OBJECT(toggle_renderer), "toggled", G_CALLBACK(on_account_default_toggled),
475 column = gtk_tree_view_column_new_with_attributes (_("mcen_ti_account"), text_renderer, "text",
476 MODEST_ACCOUNT_VIEW_DISPLAY_NAME_COLUMN, NULL);
477 gtk_tree_view_append_column (GTK_TREE_VIEW(self), column);
478 gtk_tree_view_column_set_cell_data_func(column, text_renderer, bold_if_default_cell_data,
481 /* last update for this account */
482 column = gtk_tree_view_column_new_with_attributes (_("mcen_ti_lastupdated"), text_renderer,"text",
483 MODEST_ACCOUNT_VIEW_LAST_UPDATED_COLUMN, NULL);
484 gtk_tree_view_append_column (GTK_TREE_VIEW(self),column);
485 gtk_tree_view_column_set_cell_data_func(column, text_renderer, bold_if_default_cell_data,
488 /* Show the column headers,
489 * which does not seem to be the default on Maemo.
491 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(self), TRUE);
493 priv->sig1 = g_signal_connect (G_OBJECT(priv->account_mgr),"account_removed",
494 G_CALLBACK(on_account_removed), self);
495 priv->sig2 = g_signal_connect (G_OBJECT(priv->account_mgr), "account_changed",
496 G_CALLBACK(on_account_changed), self);
497 priv->sig3 = g_signal_connect (G_OBJECT(priv->account_mgr), "account_busy_changed",
498 G_CALLBACK(on_account_busy_changed), self);
504 modest_account_view_new (ModestAccountMgr *account_mgr)
507 ModestAccountViewPrivate *priv;
509 g_return_val_if_fail (account_mgr, NULL);
511 obj = g_object_new(MODEST_TYPE_ACCOUNT_VIEW, NULL);
512 priv = MODEST_ACCOUNT_VIEW_GET_PRIVATE(obj);
514 g_object_ref (G_OBJECT (account_mgr));
515 priv->account_mgr = account_mgr;
517 init_view (MODEST_ACCOUNT_VIEW (obj));
518 update_account_view (account_mgr, MODEST_ACCOUNT_VIEW (obj));
520 return MODEST_ACCOUNT_VIEW (obj);
524 modest_account_view_get_selected_account (ModestAccountView *self)
526 gchar *account_name = NULL;
527 GtkTreeSelection *sel;
531 g_return_val_if_fail (MODEST_IS_ACCOUNT_VIEW (self), NULL);
533 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (self));
534 if (gtk_tree_selection_get_selected (sel, &model, &iter)) {
535 gtk_tree_model_get (model, &iter,
536 MODEST_ACCOUNT_VIEW_NAME_COLUMN,
543 /* This allows us to pass more than one piece of data to the signal handler,
544 * and get a result: */
547 ModestAccountView* self;
548 const gchar *account_name;
552 on_model_foreach_select_account(GtkTreeModel *model,
553 GtkTreePath *path, GtkTreeIter *iter, gpointer user_data)
555 ForEachData *state = (ForEachData*)(user_data);
557 /* Select the item if it has the matching account name: */
558 gchar *this_account_name = NULL;
559 gtk_tree_model_get (model, iter,
560 MODEST_ACCOUNT_VIEW_NAME_COLUMN, &this_account_name,
562 if(this_account_name && state->account_name
563 && (strcmp (this_account_name, state->account_name) == 0)) {
565 GtkTreeSelection *selection =
566 gtk_tree_view_get_selection (GTK_TREE_VIEW (state->self));
567 gtk_tree_selection_select_iter (selection, iter);
569 return TRUE; /* Stop walking the tree. */
572 return FALSE; /* Keep walking the tree. */
575 static void modest_account_view_select_account (ModestAccountView *account_view,
576 const gchar* account_name)
578 /* Create a state instance so we can send two items of data to the signal handler: */
579 ForEachData *state = g_new0 (ForEachData, 1);
580 state->self = account_view;
581 state->account_name = account_name;
583 GtkTreeModel *model = gtk_tree_view_get_model (
584 GTK_TREE_VIEW (account_view));
585 gtk_tree_model_foreach (model,
586 on_model_foreach_select_account, state);