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>
33 #include <tny-gtk-account-list-model.h>
34 #include <tny-gtk-folder-store-tree-model.h>
35 #include <tny-gtk-header-list-model.h>
36 #include <tny-account-store.h>
37 #include <tny-account.h>
38 #include <tny-folder.h>
39 #include <modest-marshal.h>
40 #include <modest-icon-names.h>
41 #include <modest-icon-factory.h>
42 #include <modest-tny-account-store.h>
44 #include "modest-folder-view.h"
46 /* 'private'/'protected' functions */
47 static void modest_folder_view_class_init (ModestFolderViewClass *klass);
48 static void modest_folder_view_init (ModestFolderView *obj);
49 static void modest_folder_view_finalize (GObject *obj);
51 static gboolean update_model (ModestFolderView *self,
52 ModestTnyAccountStore *account_store);
53 static gboolean update_model_empty (ModestFolderView *self);
55 static void on_selection_changed (GtkTreeSelection *sel, gpointer data);
56 static void on_subscription_changed (TnyStoreAccount *store_account, TnyFolder *folder,
57 ModestFolderView *self);
59 static gboolean modest_folder_view_update_model (ModestFolderView *self,
60 TnyAccountStore *account_store);
61 static const gchar *get_account_name_from_folder (GtkTreeModel *model, GtkTreeIter iter);
63 static void modest_folder_view_disconnect_store_account_handlers (GtkTreeView *self);
66 FOLDER_SELECTION_CHANGED_SIGNAL,
70 typedef struct _ModestFolderViewPrivate ModestFolderViewPrivate;
71 struct _ModestFolderViewPrivate {
73 TnyAccountStore *account_store;
74 TnyFolder *cur_folder;
75 gboolean view_is_empty;
78 gulong *store_accounts_handlers;
80 GtkTreeSelection *cur_selection;
81 TnyFolderStoreQuery *query;
84 #define MODEST_FOLDER_VIEW_GET_PRIVATE(o) \
85 (G_TYPE_INSTANCE_GET_PRIVATE((o), \
86 MODEST_TYPE_FOLDER_VIEW, \
87 ModestFolderViewPrivate))
89 static GObjectClass *parent_class = NULL;
91 static guint signals[LAST_SIGNAL] = {0};
94 modest_folder_view_get_type (void)
96 static GType my_type = 0;
98 static const GTypeInfo my_info = {
99 sizeof(ModestFolderViewClass),
100 NULL, /* base init */
101 NULL, /* base finalize */
102 (GClassInitFunc) modest_folder_view_class_init,
103 NULL, /* class finalize */
104 NULL, /* class data */
105 sizeof(ModestFolderView),
107 (GInstanceInitFunc) modest_folder_view_init,
111 my_type = g_type_register_static (GTK_TYPE_TREE_VIEW,
119 modest_folder_view_class_init (ModestFolderViewClass *klass)
121 GObjectClass *gobject_class;
122 gobject_class = (GObjectClass*) klass;
124 parent_class = g_type_class_peek_parent (klass);
125 gobject_class->finalize = modest_folder_view_finalize;
127 klass->update_model = modest_folder_view_update_model;
129 g_type_class_add_private (gobject_class,
130 sizeof(ModestFolderViewPrivate));
132 signals[FOLDER_SELECTION_CHANGED_SIGNAL] =
133 g_signal_new ("folder_selection_changed",
134 G_TYPE_FROM_CLASS (gobject_class),
136 G_STRUCT_OFFSET (ModestFolderViewClass,
137 folder_selection_changed),
139 modest_marshal_VOID__POINTER_BOOLEAN,
140 G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_BOOLEAN);
146 text_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
147 GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer data)
154 gtk_tree_model_get (tree_model, iter,
155 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
156 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
157 TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
158 rendobj = G_OBJECT(renderer);
161 gchar *folder_title = g_strdup_printf ("%s (%d)", fname, unread);
162 g_object_set (rendobj,"text", folder_title, "weight", 800, NULL);
163 g_free (folder_title);
165 g_object_set (rendobj,"text", fname, "weight", 400, NULL);
171 /* guess the folder type based on the name, or -1 in case of error */
173 guess_type_from_name (const gchar* name)
181 type = TNY_FOLDER_TYPE_NORMAL;
182 folder = g_utf8_strdown (name, strlen(name));
184 if (strcmp (folder, "inbox") == 0 ||
185 strcmp (folder, _("inbox")) == 0)
186 type = TNY_FOLDER_TYPE_INBOX;
187 else if (strcmp (folder, "outbox") == 0 ||
188 strcmp (folder, _("outbox")) == 0)
189 type = TNY_FOLDER_TYPE_OUTBOX;
190 else if (g_str_has_prefix(folder, "junk") ||
191 g_str_has_prefix(folder, _("junk")))
192 type = TNY_FOLDER_TYPE_JUNK;
193 else if (g_str_has_prefix(folder, "trash") ||
194 g_str_has_prefix(folder, _("trash")))
195 type = TNY_FOLDER_TYPE_JUNK;
196 else if (g_str_has_prefix(folder, "sent") ||
197 g_str_has_prefix(folder, _("sent")))
198 type = TNY_FOLDER_TYPE_SENT;
200 /* these are not *really* TNY_ types */
201 else if (g_str_has_prefix(folder, "draft") ||
202 g_str_has_prefix(folder, _("draft")))
203 type = TNY_FOLDER_TYPE_DRAFTS;
204 else if (g_str_has_prefix(folder, "notes") ||
205 g_str_has_prefix(folder, _("notes")))
206 type = TNY_FOLDER_TYPE_NOTES;
207 else if (g_str_has_prefix(folder, "contacts") ||
208 g_str_has_prefix(folder, _("contacts")))
209 type = TNY_FOLDER_TYPE_CONTACTS;
210 else if (g_str_has_prefix(folder, "calendar") ||
211 g_str_has_prefix(folder, _("calendar")))
212 type = TNY_FOLDER_TYPE_CALENDAR;
221 modest_folder_view_guess_folder_type (TnyFolder *folder)
225 g_return_val_if_fail (folder, -1);
227 type = tny_folder_get_folder_type (folder);
228 if (type == TNY_FOLDER_TYPE_NORMAL)
229 type = guess_type_from_name (tny_folder_get_name (folder));
236 icon_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
237 GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer data)
245 rendobj = G_OBJECT(renderer);
246 gtk_tree_model_get (tree_model, iter,
247 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
248 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
249 TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
250 rendobj = G_OBJECT(renderer);
252 if (type == TNY_FOLDER_TYPE_NORMAL)
253 type = guess_type_from_name (fname);
259 case TNY_FOLDER_TYPE_ROOT:
260 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_ACCOUNT);
262 case TNY_FOLDER_TYPE_INBOX:
263 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_INBOX);
265 case TNY_FOLDER_TYPE_OUTBOX:
266 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_OUTBOX);
268 case TNY_FOLDER_TYPE_JUNK:
269 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_JUNK);
271 case TNY_FOLDER_TYPE_SENT:
272 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_SENT);
274 case TNY_FOLDER_TYPE_DRAFTS:
275 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_DRAFTS);
277 case TNY_FOLDER_TYPE_NOTES:
278 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_NOTES);
280 case TNY_FOLDER_TYPE_CALENDAR:
281 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_CALENDAR);
283 case TNY_FOLDER_TYPE_CONTACTS:
284 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_CONTACTS);
286 case TNY_FOLDER_TYPE_NORMAL:
288 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_NORMAL);
292 g_object_set (rendobj,
293 "pixbuf-expander-open",
294 modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OPEN),
295 "pixbuf-expander-closed",
296 modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CLOSED),
302 modest_folder_view_init (ModestFolderView *obj)
304 ModestFolderViewPrivate *priv;
305 GtkTreeViewColumn *column;
306 GtkCellRenderer *renderer;
307 GtkTreeSelection *sel;
309 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
311 priv->view_is_empty = TRUE;
312 priv->account_store = NULL;
313 priv->cur_folder = NULL;
315 priv->lock = g_mutex_new ();
317 column = gtk_tree_view_column_new ();
318 gtk_tree_view_append_column (GTK_TREE_VIEW(obj),column);
320 renderer = gtk_cell_renderer_pixbuf_new();
321 gtk_tree_view_column_pack_start (column, renderer, FALSE);
322 gtk_tree_view_column_set_cell_data_func(column, renderer,
323 icon_cell_data, NULL, NULL);
325 renderer = gtk_cell_renderer_text_new();
326 gtk_tree_view_column_pack_start (column, renderer, FALSE);
327 gtk_tree_view_column_set_cell_data_func(column, renderer,
328 text_cell_data, NULL, NULL);
330 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
331 gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
333 gtk_tree_view_column_set_spacing (column, 2);
334 gtk_tree_view_column_set_resizable (column, TRUE);
335 gtk_tree_view_column_set_fixed_width (column, TRUE);
336 gtk_tree_view_set_headers_clickable (GTK_TREE_VIEW(obj), FALSE);
337 gtk_tree_view_set_enable_search (GTK_TREE_VIEW(obj), FALSE);
342 modest_folder_view_disconnect_store_account_handlers (GtkTreeView *self)
345 ModestFolderViewPrivate *priv;
347 GtkTreeModelSort *sortable;
350 sortable = GTK_TREE_MODEL_SORT (gtk_tree_view_get_model (self));
354 model = gtk_tree_model_sort_get_model (sortable);
358 priv = MODEST_FOLDER_VIEW_GET_PRIVATE (self);
359 iter = tny_list_create_iterator (TNY_LIST (model));
360 while (!tny_iterator_is_done (iter)) {
361 g_signal_handler_disconnect (G_OBJECT (tny_iterator_get_current (iter)),
362 priv->store_accounts_handlers [i++]);
363 tny_iterator_next (iter);
365 g_object_unref (G_OBJECT (iter));
370 modest_folder_view_finalize (GObject *obj)
372 ModestFolderViewPrivate *priv;
373 GtkTreeSelection *sel;
375 g_return_if_fail (obj);
377 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
378 if (priv->account_store) {
379 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
381 g_object_unref (G_OBJECT(priv->account_store));
382 priv->account_store = NULL;
386 g_mutex_free (priv->lock);
390 if (priv->store_accounts_handlers) {
391 modest_folder_view_disconnect_store_account_handlers (GTK_TREE_VIEW (obj));
392 g_free (priv->store_accounts_handlers);
393 priv->store_accounts_handlers = NULL;
397 g_object_unref (G_OBJECT (priv->query));
401 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
403 g_signal_handler_disconnect (G_OBJECT(sel), priv->sig2);
405 G_OBJECT_CLASS(parent_class)->finalize (obj);
410 on_account_update (TnyAccountStore *account_store, const gchar *account,
413 update_model_empty (MODEST_FOLDER_VIEW(user_data));
415 if (!update_model (MODEST_FOLDER_VIEW(user_data),
416 MODEST_TNY_ACCOUNT_STORE(account_store)))
417 g_printerr ("modest: failed to update model for changes in '%s'",
422 modest_folder_view_set_title (ModestFolderView *self, const gchar *title)
424 GtkTreeViewColumn *col;
426 g_return_if_fail (self);
428 col = gtk_tree_view_get_column (GTK_TREE_VIEW(self), 0);
430 g_printerr ("modest: failed get column for title\n");
434 gtk_tree_view_column_set_title (col, title);
435 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(self),
440 modest_folder_view_new (ModestTnyAccountStore *account_store,
441 TnyFolderStoreQuery *query)
444 ModestFolderViewPrivate *priv;
445 GtkTreeSelection *sel;
447 g_return_val_if_fail (account_store, NULL);
449 self = G_OBJECT(g_object_new(MODEST_TYPE_FOLDER_VIEW, NULL));
450 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
452 priv->account_store = g_object_ref (G_OBJECT (account_store));
454 priv->query = g_object_ref (G_OBJECT (query));
456 if (!update_model (MODEST_FOLDER_VIEW(self),
457 MODEST_TNY_ACCOUNT_STORE(account_store)))
458 g_printerr ("modest: failed to update model\n");
460 priv->sig1 = g_signal_connect (G_OBJECT(account_store), "account_update",
461 G_CALLBACK (on_account_update), self);
463 sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(self));
464 priv->sig2 = g_signal_connect (sel, "changed",
465 G_CALLBACK(on_selection_changed), self);
467 return GTK_WIDGET(self);
472 modest_folder_view_get_selected_account (ModestFolderView *self)
476 ModestFolderViewPrivate *priv;
478 g_return_val_if_fail (self, NULL);
479 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
481 gtk_tree_selection_get_selected (priv->cur_selection, &model, &iter);
483 return get_account_name_from_folder (model, iter);
487 update_model_empty (ModestFolderView *self)
491 ModestFolderViewPrivate *priv;
493 g_return_val_if_fail (self, FALSE);
494 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
496 /* Disconnect old handlers */
497 if (priv->store_accounts_handlers) {
498 modest_folder_view_disconnect_store_account_handlers (GTK_TREE_VIEW (self));
499 g_free (priv->store_accounts_handlers);
500 priv->store_accounts_handlers = NULL;
503 /* Create the new model */
504 store = gtk_tree_store_new (1, G_TYPE_STRING);
505 gtk_tree_store_append (store, &iter, NULL);
507 gtk_tree_store_set (store, &iter, 0, _("(empty)"), -1);
509 gtk_tree_view_set_model (GTK_TREE_VIEW(self),
510 GTK_TREE_MODEL(store));
511 g_object_unref (store);
513 priv->view_is_empty = TRUE;
515 g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
522 update_store_account_handlers (ModestFolderView *self, TnyList *account_list)
524 ModestFolderViewPrivate *priv;
528 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
530 /* Listen to subscription changes */
531 len = tny_list_get_length (TNY_LIST (account_list));
533 g_assert (priv->store_accounts_handlers == NULL); /* don't leak */
534 priv->store_accounts_handlers = g_malloc0 (sizeof (guint) * len);
535 iter = tny_list_create_iterator (account_list);
537 if (!tny_iterator_is_done (iter)) {
540 priv->view_is_empty = FALSE;
543 priv->store_accounts_handlers [i++] =
544 g_signal_connect (G_OBJECT (tny_iterator_get_current (iter)),
545 "subscription_changed",
546 G_CALLBACK (on_subscription_changed),
548 tny_iterator_next (iter);
549 } while (!tny_iterator_is_done (iter));
551 g_object_unref (G_OBJECT (iter));
557 update_model (ModestFolderView *self, ModestTnyAccountStore *account_store)
559 ModestFolderViewPrivate *priv;
561 TnyList *account_list;
562 GtkTreeModel *model, *sortable;
564 g_return_val_if_fail (account_store, FALSE);
565 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
567 model = tny_gtk_folder_store_tree_model_new (TRUE, NULL);
568 account_list = TNY_LIST(model);
570 tny_account_store_get_accounts (TNY_ACCOUNT_STORE(account_store),
572 TNY_ACCOUNT_STORE_STORE_ACCOUNTS);
575 sortable = gtk_tree_model_sort_new_with_model (model);
576 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sortable),
577 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN,
579 gtk_tree_view_set_model (GTK_TREE_VIEW(self), sortable);
581 update_store_account_handlers (self, account_list);
584 g_object_unref (model);
590 on_selection_changed (GtkTreeSelection *sel, gpointer user_data)
593 TnyFolder *folder = NULL;
595 ModestFolderView *tree_view;
596 ModestFolderViewPrivate *priv;
599 g_return_if_fail (sel);
600 g_return_if_fail (user_data);
602 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(user_data);
603 priv->cur_selection = sel;
605 /* is_empty means that there is only the 'empty' item */
606 if (priv->view_is_empty)
609 /* folder was _un_selected if true */
610 if (!gtk_tree_selection_get_selected (sel, &model, &iter)) {
611 priv->cur_folder = NULL; /* FIXME: need this? */
615 tree_view = MODEST_FOLDER_VIEW (user_data);
616 gtk_tree_model_get (model, &iter,
617 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
618 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder,
621 if (type == TNY_FOLDER_TYPE_ROOT)
624 /* emit 2 signals: one for the unselection of the old one,
625 * and one for the selection of the new on */
626 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
627 priv->cur_folder, FALSE);
628 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
631 if (priv->cur_folder)
632 tny_folder_expunge (priv->cur_folder, NULL); /* FIXME */
633 priv->cur_folder = folder;
638 on_subscription_changed (TnyStoreAccount *store_account,
640 ModestFolderView *self)
642 /* TODO: probably we won't need a full reload, just the store
643 account or even the parent of the folder */
645 ModestFolderViewPrivate *priv;
647 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
648 update_model (self, MODEST_TNY_ACCOUNT_STORE (priv->account_store));
653 modest_folder_view_update_model (ModestFolderView *self, TnyAccountStore *account_store)
657 g_return_val_if_fail (MODEST_IS_FOLDER_VIEW (self), FALSE);
658 retval = update_model (self, MODEST_TNY_ACCOUNT_STORE(account_store)); /* ugly */
660 g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTION_CHANGED_SIGNAL],
669 get_account_name_from_folder (GtkTreeModel *model, GtkTreeIter iter)
672 GtkTreeIter new_iter;
673 TnyFolder *account_folder;
676 path = gtk_tree_model_get_path (model, &iter);
677 depth = gtk_tree_path_get_depth (path);
679 for (i = 1; i < depth; ++i)
680 gtk_tree_path_up (path);
682 gtk_tree_model_get_iter (model, &new_iter, path);
683 gtk_tree_model_get (model, &new_iter,
684 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &account_folder,
686 return tny_account_get_name (TNY_ACCOUNT (account_folder));