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 <tny-camel-folder.h>
40 #include <modest-tny-folder.h>
41 #include <modest-marshal.h>
42 #include <modest-icon-names.h>
43 #include <modest-icon-factory.h>
44 #include <modest-tny-account-store.h>
45 #include <modest-text-utils.h>
47 #include "modest-folder-view.h"
49 /* 'private'/'protected' functions */
50 static void modest_folder_view_class_init (ModestFolderViewClass *klass);
51 static void modest_folder_view_init (ModestFolderView *obj);
52 static void modest_folder_view_finalize (GObject *obj);
54 static gboolean update_model (ModestFolderView *self,
55 ModestTnyAccountStore *account_store);
56 static gboolean update_model_empty (ModestFolderView *self);
58 static void on_selection_changed (GtkTreeSelection *sel, gpointer data);
59 static void on_subscription_changed (TnyStoreAccount *store_account, TnyFolder *folder,
60 ModestFolderView *self);
62 static void modest_folder_view_disconnect_store_account_handlers (GtkTreeView *self);
64 static gint cmp_rows (GtkTreeModel *tree_model, GtkTreeIter *iter1, GtkTreeIter *iter2,
69 FOLDER_SELECTION_CHANGED_SIGNAL,
73 typedef struct _ModestFolderViewPrivate ModestFolderViewPrivate;
74 struct _ModestFolderViewPrivate {
75 TnyAccountStore *account_store;
76 TnyFolder *cur_folder;
79 gulong *store_accounts_handlers;
81 GtkTreeSelection *cur_selection;
82 TnyFolderStoreQuery *query;
85 #define MODEST_FOLDER_VIEW_GET_PRIVATE(o) \
86 (G_TYPE_INSTANCE_GET_PRIVATE((o), \
87 MODEST_TYPE_FOLDER_VIEW, \
88 ModestFolderViewPrivate))
90 static GObjectClass *parent_class = NULL;
92 static guint signals[LAST_SIGNAL] = {0};
95 modest_folder_view_get_type (void)
97 static GType my_type = 0;
99 static const GTypeInfo my_info = {
100 sizeof(ModestFolderViewClass),
101 NULL, /* base init */
102 NULL, /* base finalize */
103 (GClassInitFunc) modest_folder_view_class_init,
104 NULL, /* class finalize */
105 NULL, /* class data */
106 sizeof(ModestFolderView),
108 (GInstanceInitFunc) modest_folder_view_init,
112 my_type = g_type_register_static (GTK_TYPE_TREE_VIEW,
120 modest_folder_view_class_init (ModestFolderViewClass *klass)
122 GObjectClass *gobject_class;
123 gobject_class = (GObjectClass*) klass;
125 parent_class = g_type_class_peek_parent (klass);
126 gobject_class->finalize = modest_folder_view_finalize;
128 klass->update_model = modest_folder_view_update_model;
130 g_type_class_add_private (gobject_class,
131 sizeof(ModestFolderViewPrivate));
133 signals[FOLDER_SELECTION_CHANGED_SIGNAL] =
134 g_signal_new ("folder_selection_changed",
135 G_TYPE_FROM_CLASS (gobject_class),
137 G_STRUCT_OFFSET (ModestFolderViewClass,
138 folder_selection_changed),
140 modest_marshal_VOID__POINTER_BOOLEAN,
141 G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_BOOLEAN);
147 text_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
148 GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer data)
156 g_return_if_fail (column);
157 g_return_if_fail (tree_model);
159 gtk_tree_model_get (tree_model, iter,
160 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
161 TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread,
162 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
163 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder,
165 rendobj = G_OBJECT(renderer);
170 if (folder && type != TNY_FOLDER_TYPE_ROOT) { /* FIXME: tnymail bug? crashes with root folders */
171 if (modest_tny_folder_is_local_folder (folder)) {
173 type = modest_tny_folder_get_local_folder_type (folder);
174 if (type != TNY_FOLDER_TYPE_UNKNOWN) {
176 fname = g_strdup(modest_local_folder_info_get_type_display_name (type));
179 } else if (folder && type == TNY_FOLDER_TYPE_ROOT) {
180 if (strcmp (fname, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0) {/* FIXME: hack */
182 fname = g_strdup (MODEST_LOCAL_FOLDERS_DISPLAY_NAME);
187 gchar *folder_title = g_strdup_printf ("%s (%d)", fname, unread);
188 g_object_set (rendobj,"text", folder_title, "weight", 800, NULL);
189 g_free (folder_title);
191 g_object_set (rendobj,"text", fname, "weight", 400, NULL);
199 icon_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
200 GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer data)
208 rendobj = G_OBJECT(renderer);
209 gtk_tree_model_get (tree_model, iter,
210 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
211 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
212 TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
213 rendobj = G_OBJECT(renderer);
215 if (type == TNY_FOLDER_TYPE_NORMAL || type == TNY_FOLDER_TYPE_UNKNOWN)
216 type = modest_tny_folder_guess_folder_type_from_name (fname);
220 case TNY_FOLDER_TYPE_ROOT:
221 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_ACCOUNT);
223 case TNY_FOLDER_TYPE_INBOX:
224 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_INBOX);
226 case TNY_FOLDER_TYPE_OUTBOX:
227 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OUTBOX);
229 case TNY_FOLDER_TYPE_JUNK:
230 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_JUNK);
232 case TNY_FOLDER_TYPE_SENT:
233 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_SENT);
235 case TNY_FOLDER_TYPE_DRAFTS:
236 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_DRAFTS);
238 case TNY_FOLDER_TYPE_NOTES:
239 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_NOTES);
241 case TNY_FOLDER_TYPE_CALENDAR:
242 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CALENDAR);
244 case TNY_FOLDER_TYPE_CONTACTS:
245 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CONTACTS);
247 case TNY_FOLDER_TYPE_NORMAL:
249 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_NORMAL);
253 g_object_set (rendobj,
254 "pixbuf-expander-open",
255 modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OPEN),
256 "pixbuf-expander-closed",
257 modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CLOSED),
263 modest_folder_view_init (ModestFolderView *obj)
265 ModestFolderViewPrivate *priv;
266 GtkTreeViewColumn *column;
267 GtkCellRenderer *renderer;
268 GtkTreeSelection *sel;
270 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
272 priv->account_store = NULL;
273 priv->cur_folder = NULL;
275 priv->lock = g_mutex_new ();
277 column = gtk_tree_view_column_new ();
278 gtk_tree_view_append_column (GTK_TREE_VIEW(obj),column);
280 renderer = gtk_cell_renderer_pixbuf_new();
281 gtk_tree_view_column_pack_start (column, renderer, FALSE);
282 gtk_tree_view_column_set_cell_data_func(column, renderer,
283 icon_cell_data, NULL, NULL);
285 renderer = gtk_cell_renderer_text_new();
286 gtk_tree_view_column_pack_start (column, renderer, FALSE);
287 gtk_tree_view_column_set_cell_data_func(column, renderer,
288 text_cell_data, NULL, NULL);
290 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
291 gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
293 gtk_tree_view_column_set_spacing (column, 2);
294 gtk_tree_view_column_set_resizable (column, TRUE);
295 gtk_tree_view_column_set_fixed_width (column, TRUE);
296 gtk_tree_view_set_headers_clickable (GTK_TREE_VIEW(obj), FALSE);
297 gtk_tree_view_set_enable_search (GTK_TREE_VIEW(obj), FALSE);
302 modest_folder_view_disconnect_store_account_handlers (GtkTreeView *self)
305 ModestFolderViewPrivate *priv;
307 GtkTreeModelSort *sortable;
310 sortable = GTK_TREE_MODEL_SORT (gtk_tree_view_get_model (self));
314 model = gtk_tree_model_sort_get_model (sortable);
318 priv = MODEST_FOLDER_VIEW_GET_PRIVATE (self);
319 iter = tny_list_create_iterator (TNY_LIST (model));
320 while (!tny_iterator_is_done (iter)) {
321 g_signal_handler_disconnect (G_OBJECT (tny_iterator_get_current (iter)),
322 priv->store_accounts_handlers [i++]);
323 tny_iterator_next (iter);
325 g_object_unref (G_OBJECT (iter));
330 modest_folder_view_finalize (GObject *obj)
332 ModestFolderViewPrivate *priv;
333 GtkTreeSelection *sel;
335 g_return_if_fail (obj);
337 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
338 if (priv->account_store) {
339 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
341 g_object_unref (G_OBJECT(priv->account_store));
342 priv->account_store = NULL;
346 g_mutex_free (priv->lock);
350 if (priv->store_accounts_handlers) {
351 modest_folder_view_disconnect_store_account_handlers (GTK_TREE_VIEW (obj));
352 g_free (priv->store_accounts_handlers);
353 priv->store_accounts_handlers = NULL;
357 g_object_unref (G_OBJECT (priv->query));
361 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
363 g_signal_handler_disconnect (G_OBJECT(sel), priv->sig2);
365 G_OBJECT_CLASS(parent_class)->finalize (obj);
370 on_account_update (TnyAccountStore *account_store, const gchar *account,
373 if (!update_model (MODEST_FOLDER_VIEW(user_data),
374 MODEST_TNY_ACCOUNT_STORE(account_store)))
375 g_printerr ("modest: failed to update model for changes in '%s'",
380 modest_folder_view_set_title (ModestFolderView *self, const gchar *title)
382 GtkTreeViewColumn *col;
384 g_return_if_fail (self);
386 col = gtk_tree_view_get_column (GTK_TREE_VIEW(self), 0);
388 g_printerr ("modest: failed get column for title\n");
392 gtk_tree_view_column_set_title (col, title);
393 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(self),
398 modest_folder_view_new (ModestTnyAccountStore *account_store,
399 TnyFolderStoreQuery *query)
402 ModestFolderViewPrivate *priv;
403 GtkTreeSelection *sel;
405 g_return_val_if_fail (account_store, NULL);
407 self = G_OBJECT(g_object_new(MODEST_TYPE_FOLDER_VIEW, NULL));
408 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
410 priv->account_store = g_object_ref (G_OBJECT (account_store));
412 priv->query = g_object_ref (G_OBJECT (query));
414 if (!update_model (MODEST_FOLDER_VIEW(self),
415 MODEST_TNY_ACCOUNT_STORE(account_store)))
416 g_printerr ("modest: failed to update model\n");
418 priv->sig1 = g_signal_connect (G_OBJECT(account_store), "account_update",
419 G_CALLBACK (on_account_update), self);
421 sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(self));
422 priv->sig2 = g_signal_connect (sel, "changed",
423 G_CALLBACK(on_selection_changed), self);
424 return GTK_WIDGET(self);
429 update_model_empty (ModestFolderView *self)
431 ModestFolderViewPrivate *priv;
433 g_return_val_if_fail (self, FALSE);
434 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
436 /* Disconnect old handlers */
437 if (priv->store_accounts_handlers) {
438 modest_folder_view_disconnect_store_account_handlers (GTK_TREE_VIEW (self));
439 g_free (priv->store_accounts_handlers);
440 priv->store_accounts_handlers = NULL;
443 g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
450 update_store_account_handlers (ModestFolderView *self, TnyList *account_list)
452 ModestFolderViewPrivate *priv;
456 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
458 /* Listen to subscription changes */
459 len = tny_list_get_length (TNY_LIST (account_list));
461 g_assert (priv->store_accounts_handlers == NULL); /* don't leak */
462 priv->store_accounts_handlers = g_malloc0 (sizeof (guint) * len);
463 iter = tny_list_create_iterator (account_list);
465 if (!tny_iterator_is_done (iter)) {
470 priv->store_accounts_handlers [i++] =
471 g_signal_connect (G_OBJECT (tny_iterator_get_current (iter)),
472 "subscription_changed",
473 G_CALLBACK (on_subscription_changed),
475 tny_iterator_next (iter);
476 } while (!tny_iterator_is_done (iter));
478 g_object_unref (G_OBJECT (iter));
483 /* this feels dirty; any other way to expand all the root items? */
485 expand_root_items (ModestFolderView *self)
488 path = gtk_tree_path_new_first ();
490 /* all folders should have child items, so.. */
491 while (gtk_tree_view_expand_row (GTK_TREE_VIEW(self), path, FALSE))
492 gtk_tree_path_next (path);
494 gtk_tree_path_free (path);
500 update_model (ModestFolderView *self, ModestTnyAccountStore *account_store)
502 ModestFolderViewPrivate *priv;
504 TnyList *account_list;
505 GtkTreeModel *model, *sortable;
507 g_return_val_if_fail (account_store, FALSE);
509 update_model_empty (self);
511 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
513 model = tny_gtk_folder_store_tree_model_new (FALSE, NULL);
514 account_list = TNY_LIST(model);
516 tny_account_store_get_accounts (TNY_ACCOUNT_STORE(account_store),
518 TNY_ACCOUNT_STORE_STORE_ACCOUNTS);
520 sortable = gtk_tree_model_sort_new_with_model (model);
521 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(sortable),
522 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN,
524 gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (sortable),
525 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN,
526 cmp_rows, NULL, NULL);
527 gtk_tree_view_set_model (GTK_TREE_VIEW(self), sortable);
528 expand_root_items (self); /* expand all account folders */
530 update_store_account_handlers (self, account_list);
533 g_object_unref (model);
539 on_selection_changed (GtkTreeSelection *sel, gpointer user_data)
542 TnyFolder *folder = NULL;
544 ModestFolderView *tree_view;
545 ModestFolderViewPrivate *priv;
548 g_return_if_fail (sel);
549 g_return_if_fail (user_data);
551 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(user_data);
552 priv->cur_selection = sel;
554 /* folder was _un_selected if true */
555 if (!gtk_tree_selection_get_selected (sel, &model, &iter)) {
556 priv->cur_folder = NULL; /* FIXME: need this? */
560 tree_view = MODEST_FOLDER_VIEW (user_data);
561 gtk_tree_model_get (model, &iter,
562 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
563 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder,
566 if (type == TNY_FOLDER_TYPE_ROOT)
569 /* emit 2 signals: one for the unselection of the old one,
570 * and one for the selection of the new on */
571 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
572 priv->cur_folder, FALSE);
573 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
575 if (priv->cur_folder)
576 tny_folder_sync (priv->cur_folder, TRUE, NULL); /* FIXME */
577 priv->cur_folder = folder;
582 on_subscription_changed (TnyStoreAccount *store_account,
584 ModestFolderView *self)
586 /* TODO: probably we won't need a full reload, just the store
587 account or even the parent of the folder */
589 ModestFolderViewPrivate *priv;
591 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
592 update_model (self, MODEST_TNY_ACCOUNT_STORE (priv->account_store));
597 modest_folder_view_update_model (ModestFolderView *self, TnyAccountStore *account_store)
599 g_return_val_if_fail (MODEST_IS_FOLDER_VIEW (self), FALSE);
601 g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTION_CHANGED_SIGNAL],
604 return update_model (self, MODEST_TNY_ACCOUNT_STORE(account_store)); /* ugly */
608 modest_folder_view_get_selected (ModestFolderView *self)
610 ModestFolderViewPrivate *priv;
612 g_return_val_if_fail (self, NULL);
614 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
615 if (priv->cur_folder)
616 g_object_ref (priv->cur_folder);
618 return priv->cur_folder;
622 cmp_rows (GtkTreeModel *tree_model, GtkTreeIter *iter1, GtkTreeIter *iter2,
626 gchar *name1, *name2;
628 TnyFolder *folder1, *folder2;
630 gtk_tree_model_get (tree_model, iter1,
631 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &name1,
632 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
633 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder1,
635 gtk_tree_model_get (tree_model, iter2,
636 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &name2,
637 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder2,
640 /* local_folders should be the last one */
641 if (type == TNY_FOLDER_TYPE_ROOT) {
642 /* the account name is also the name of the root folder
643 * in case of local folders */
644 if (strcmp (name1, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0)
646 else if (strcmp (name2, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0)
649 cmp = modest_text_utils_utf8_strcmp (name1, name2, TRUE);
651 cmp = modest_text_utils_utf8_strcmp (name1, name2, TRUE);