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-tny-folder.h>
40 #include <modest-marshal.h>
41 #include <modest-icon-names.h>
42 #include <modest-icon-factory.h>
43 #include <modest-tny-account-store.h>
44 #include <modest-text-utils.h>
46 #include "modest-folder-view.h"
48 /* 'private'/'protected' functions */
49 static void modest_folder_view_class_init (ModestFolderViewClass *klass);
50 static void modest_folder_view_init (ModestFolderView *obj);
51 static void modest_folder_view_finalize (GObject *obj);
53 static gboolean update_model (ModestFolderView *self,
54 ModestTnyAccountStore *account_store);
55 static gboolean update_model_empty (ModestFolderView *self);
57 static void on_selection_changed (GtkTreeSelection *sel, gpointer data);
58 static void on_subscription_changed (TnyStoreAccount *store_account, TnyFolder *folder,
59 ModestFolderView *self);
61 static gboolean modest_folder_view_update_model (ModestFolderView *self,
62 TnyAccountStore *account_store);
64 static void modest_folder_view_disconnect_store_account_handlers (GtkTreeView *self);
66 static gint cmp_rows (GtkTreeModel *tree_model, GtkTreeIter *iter1, GtkTreeIter *iter2,
71 FOLDER_SELECTION_CHANGED_SIGNAL,
75 typedef struct _ModestFolderViewPrivate ModestFolderViewPrivate;
76 struct _ModestFolderViewPrivate {
78 TnyAccountStore *account_store;
79 TnyFolder *cur_folder;
80 gboolean view_is_empty;
83 gulong *store_accounts_handlers;
85 GtkTreeSelection *cur_selection;
86 TnyFolderStoreQuery *query;
89 #define MODEST_FOLDER_VIEW_GET_PRIVATE(o) \
90 (G_TYPE_INSTANCE_GET_PRIVATE((o), \
91 MODEST_TYPE_FOLDER_VIEW, \
92 ModestFolderViewPrivate))
94 static GObjectClass *parent_class = NULL;
96 static guint signals[LAST_SIGNAL] = {0};
99 modest_folder_view_get_type (void)
101 static GType my_type = 0;
103 static const GTypeInfo my_info = {
104 sizeof(ModestFolderViewClass),
105 NULL, /* base init */
106 NULL, /* base finalize */
107 (GClassInitFunc) modest_folder_view_class_init,
108 NULL, /* class finalize */
109 NULL, /* class data */
110 sizeof(ModestFolderView),
112 (GInstanceInitFunc) modest_folder_view_init,
116 my_type = g_type_register_static (GTK_TYPE_TREE_VIEW,
124 modest_folder_view_class_init (ModestFolderViewClass *klass)
126 GObjectClass *gobject_class;
127 gobject_class = (GObjectClass*) klass;
129 parent_class = g_type_class_peek_parent (klass);
130 gobject_class->finalize = modest_folder_view_finalize;
132 klass->update_model = modest_folder_view_update_model;
134 g_type_class_add_private (gobject_class,
135 sizeof(ModestFolderViewPrivate));
137 signals[FOLDER_SELECTION_CHANGED_SIGNAL] =
138 g_signal_new ("folder_selection_changed",
139 G_TYPE_FROM_CLASS (gobject_class),
141 G_STRUCT_OFFSET (ModestFolderViewClass,
142 folder_selection_changed),
144 modest_marshal_VOID__POINTER_BOOLEAN,
145 G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_BOOLEAN);
150 text_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
151 GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer data)
158 gtk_tree_model_get (tree_model, iter,
159 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
160 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
161 TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
162 rendobj = G_OBJECT(renderer);
165 gchar *folder_title = g_strdup_printf ("%s (%d)", fname, unread);
166 g_object_set (rendobj,"text", folder_title, "weight", 800, NULL);
167 g_free (folder_title);
169 g_object_set (rendobj,"text", fname, "weight", 400, NULL);
177 icon_cell_data (GtkTreeViewColumn *column, GtkCellRenderer *renderer,
178 GtkTreeModel *tree_model, GtkTreeIter *iter, gpointer data)
186 rendobj = G_OBJECT(renderer);
187 gtk_tree_model_get (tree_model, iter,
188 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
189 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
190 TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
191 rendobj = G_OBJECT(renderer);
193 if (type == TNY_FOLDER_TYPE_NORMAL || type == TNY_FOLDER_TYPE_UNKNOWN)
194 type = modest_tny_folder_guess_folder_type_from_name (fname);
198 case TNY_FOLDER_TYPE_ROOT:
199 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_ACCOUNT);
201 case TNY_FOLDER_TYPE_INBOX:
202 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_INBOX);
204 case TNY_FOLDER_TYPE_OUTBOX:
205 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OUTBOX);
207 case TNY_FOLDER_TYPE_JUNK:
208 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_JUNK);
210 case TNY_FOLDER_TYPE_SENT:
211 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_SENT);
213 case TNY_FOLDER_TYPE_DRAFTS:
214 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_DRAFTS);
216 case TNY_FOLDER_TYPE_NOTES:
217 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_NOTES);
219 case TNY_FOLDER_TYPE_CALENDAR:
220 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CALENDAR);
222 case TNY_FOLDER_TYPE_CONTACTS:
223 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CONTACTS);
225 case TNY_FOLDER_TYPE_NORMAL:
227 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_NORMAL);
231 g_object_set (rendobj,
232 "pixbuf-expander-open",
233 modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OPEN),
234 "pixbuf-expander-closed",
235 modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CLOSED),
241 modest_folder_view_init (ModestFolderView *obj)
243 ModestFolderViewPrivate *priv;
244 GtkTreeViewColumn *column;
245 GtkCellRenderer *renderer;
246 GtkTreeSelection *sel;
248 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
250 priv->view_is_empty = TRUE;
251 priv->account_store = NULL;
252 priv->cur_folder = NULL;
254 priv->lock = g_mutex_new ();
256 column = gtk_tree_view_column_new ();
257 gtk_tree_view_append_column (GTK_TREE_VIEW(obj),column);
259 renderer = gtk_cell_renderer_pixbuf_new();
260 gtk_tree_view_column_pack_start (column, renderer, FALSE);
261 gtk_tree_view_column_set_cell_data_func(column, renderer,
262 icon_cell_data, NULL, NULL);
264 renderer = gtk_cell_renderer_text_new();
265 gtk_tree_view_column_pack_start (column, renderer, FALSE);
266 gtk_tree_view_column_set_cell_data_func(column, renderer,
267 text_cell_data, NULL, NULL);
269 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
270 gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
272 gtk_tree_view_column_set_spacing (column, 2);
273 gtk_tree_view_column_set_resizable (column, TRUE);
274 gtk_tree_view_column_set_fixed_width (column, TRUE);
275 gtk_tree_view_set_headers_clickable (GTK_TREE_VIEW(obj), FALSE);
276 gtk_tree_view_set_enable_search (GTK_TREE_VIEW(obj), FALSE);
281 modest_folder_view_disconnect_store_account_handlers (GtkTreeView *self)
284 ModestFolderViewPrivate *priv;
286 GtkTreeModelSort *sortable;
289 sortable = GTK_TREE_MODEL_SORT (gtk_tree_view_get_model (self));
293 model = gtk_tree_model_sort_get_model (sortable);
297 priv = MODEST_FOLDER_VIEW_GET_PRIVATE (self);
298 iter = tny_list_create_iterator (TNY_LIST (model));
299 while (!tny_iterator_is_done (iter)) {
300 g_signal_handler_disconnect (G_OBJECT (tny_iterator_get_current (iter)),
301 priv->store_accounts_handlers [i++]);
302 tny_iterator_next (iter);
304 g_object_unref (G_OBJECT (iter));
309 modest_folder_view_finalize (GObject *obj)
311 ModestFolderViewPrivate *priv;
312 GtkTreeSelection *sel;
314 g_return_if_fail (obj);
316 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
317 if (priv->account_store) {
318 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
320 g_object_unref (G_OBJECT(priv->account_store));
321 priv->account_store = NULL;
325 g_mutex_free (priv->lock);
329 if (priv->store_accounts_handlers) {
330 modest_folder_view_disconnect_store_account_handlers (GTK_TREE_VIEW (obj));
331 g_free (priv->store_accounts_handlers);
332 priv->store_accounts_handlers = NULL;
336 g_object_unref (G_OBJECT (priv->query));
340 sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
342 g_signal_handler_disconnect (G_OBJECT(sel), priv->sig2);
344 G_OBJECT_CLASS(parent_class)->finalize (obj);
349 on_account_update (TnyAccountStore *account_store, const gchar *account,
352 update_model_empty (MODEST_FOLDER_VIEW(user_data));
354 if (!update_model (MODEST_FOLDER_VIEW(user_data),
355 MODEST_TNY_ACCOUNT_STORE(account_store)))
356 g_printerr ("modest: failed to update model for changes in '%s'",
361 modest_folder_view_set_title (ModestFolderView *self, const gchar *title)
363 GtkTreeViewColumn *col;
365 g_return_if_fail (self);
367 col = gtk_tree_view_get_column (GTK_TREE_VIEW(self), 0);
369 g_printerr ("modest: failed get column for title\n");
373 gtk_tree_view_column_set_title (col, title);
374 gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(self),
379 modest_folder_view_new (ModestTnyAccountStore *account_store,
380 TnyFolderStoreQuery *query)
383 ModestFolderViewPrivate *priv;
384 GtkTreeSelection *sel;
386 g_return_val_if_fail (account_store, NULL);
388 self = G_OBJECT(g_object_new(MODEST_TYPE_FOLDER_VIEW, NULL));
389 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
391 priv->account_store = g_object_ref (G_OBJECT (account_store));
393 priv->query = g_object_ref (G_OBJECT (query));
395 if (!update_model (MODEST_FOLDER_VIEW(self),
396 MODEST_TNY_ACCOUNT_STORE(account_store)))
397 g_printerr ("modest: failed to update model\n");
399 priv->sig1 = g_signal_connect (G_OBJECT(account_store), "account_update",
400 G_CALLBACK (on_account_update), self);
402 sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(self));
403 priv->sig2 = g_signal_connect (sel, "changed",
404 G_CALLBACK(on_selection_changed), self);
405 return GTK_WIDGET(self);
410 update_model_empty (ModestFolderView *self)
414 ModestFolderViewPrivate *priv;
416 g_return_val_if_fail (self, FALSE);
417 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
419 /* Disconnect old handlers */
420 if (priv->store_accounts_handlers) {
421 modest_folder_view_disconnect_store_account_handlers (GTK_TREE_VIEW (self));
422 g_free (priv->store_accounts_handlers);
423 priv->store_accounts_handlers = NULL;
426 /* Create the new model */
427 store = gtk_tree_store_new (1, G_TYPE_STRING);
428 gtk_tree_store_append (store, &iter, NULL);
430 gtk_tree_store_set (store, &iter, 0, _("(empty)"), -1);
432 gtk_tree_view_set_model (GTK_TREE_VIEW(self),
433 GTK_TREE_MODEL(store));
434 g_object_unref (store);
435 priv->view_is_empty = TRUE;
437 g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
444 update_store_account_handlers (ModestFolderView *self, TnyList *account_list)
446 ModestFolderViewPrivate *priv;
450 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
452 /* Listen to subscription changes */
453 len = tny_list_get_length (TNY_LIST (account_list));
455 g_assert (priv->store_accounts_handlers == NULL); /* don't leak */
456 priv->store_accounts_handlers = g_malloc0 (sizeof (guint) * len);
457 iter = tny_list_create_iterator (account_list);
459 if (!tny_iterator_is_done (iter)) {
462 priv->view_is_empty = FALSE;
465 priv->store_accounts_handlers [i++] =
466 g_signal_connect (G_OBJECT (tny_iterator_get_current (iter)),
467 "subscription_changed",
468 G_CALLBACK (on_subscription_changed),
470 tny_iterator_next (iter);
471 } while (!tny_iterator_is_done (iter));
473 g_object_unref (G_OBJECT (iter));
479 update_model (ModestFolderView *self, ModestTnyAccountStore *account_store)
481 ModestFolderViewPrivate *priv;
483 TnyList *account_list;
484 GtkTreeModel *model, *sortable;
486 g_return_val_if_fail (account_store, FALSE);
488 update_model_empty (self);
490 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
492 model = tny_gtk_folder_store_tree_model_new (TRUE, NULL);
493 account_list = TNY_LIST(model);
495 tny_account_store_get_accounts (TNY_ACCOUNT_STORE(account_store),
497 TNY_ACCOUNT_STORE_STORE_ACCOUNTS);
501 sortable = gtk_tree_model_sort_new_with_model (model);
502 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(sortable),
503 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN,
505 gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (sortable),
506 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN,
507 cmp_rows, NULL, NULL);
508 gtk_tree_view_set_model (GTK_TREE_VIEW(self), sortable);
509 update_store_account_handlers (self, account_list);
512 g_object_unref (model);
518 on_selection_changed (GtkTreeSelection *sel, gpointer user_data)
521 TnyFolder *folder = NULL;
523 ModestFolderView *tree_view;
524 ModestFolderViewPrivate *priv;
527 g_return_if_fail (sel);
528 g_return_if_fail (user_data);
530 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(user_data);
531 priv->cur_selection = sel;
533 /* is_empty means that there is only the 'empty' item */
534 if (priv->view_is_empty)
537 /* folder was _un_selected if true */
538 if (!gtk_tree_selection_get_selected (sel, &model, &iter)) {
539 priv->cur_folder = NULL; /* FIXME: need this? */
543 tree_view = MODEST_FOLDER_VIEW (user_data);
544 gtk_tree_model_get (model, &iter,
545 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
546 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder,
549 if (type == TNY_FOLDER_TYPE_ROOT)
552 /* emit 2 signals: one for the unselection of the old one,
553 * and one for the selection of the new on */
554 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
555 priv->cur_folder, FALSE);
556 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
558 if (priv->cur_folder)
559 tny_folder_expunge (priv->cur_folder, NULL); /* FIXME */
560 priv->cur_folder = folder;
565 on_subscription_changed (TnyStoreAccount *store_account,
567 ModestFolderView *self)
569 /* TODO: probably we won't need a full reload, just the store
570 account or even the parent of the folder */
572 ModestFolderViewPrivate *priv;
574 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
575 update_model (self, MODEST_TNY_ACCOUNT_STORE (priv->account_store));
580 modest_folder_view_update_model (ModestFolderView *self, TnyAccountStore *account_store)
582 g_return_val_if_fail (MODEST_IS_FOLDER_VIEW (self), FALSE);
584 g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTION_CHANGED_SIGNAL],
587 return update_model (self, MODEST_TNY_ACCOUNT_STORE(account_store)); /* ugly */
591 modest_folder_view_get_selected (ModestFolderView *self)
593 ModestFolderViewPrivate *priv;
595 g_return_val_if_fail (self, NULL);
597 priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
598 if (priv->cur_folder)
599 g_object_ref (priv->cur_folder);
601 return priv->cur_folder;
607 get_account_name (TnyFolder *folder)
611 account = tny_folder_get_account (folder);
615 return tny_account_get_name (account);
620 cmp_rows (GtkTreeModel *tree_model, GtkTreeIter *iter1, GtkTreeIter *iter2,
624 gchar *name1, *name2;
626 TnyFolder *folder1, *folder2;
628 gtk_tree_model_get (tree_model, iter1,
629 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &name1,
630 TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
631 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder1,
633 gtk_tree_model_get (tree_model, iter2,
634 TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &name2,
635 TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder2,
638 /* local_folders should be the last one */
639 if (type == TNY_FOLDER_TYPE_ROOT) {
640 /* the account name is also the name of the root folder
641 * in case of local folders */
642 if (strcmp (name1, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0)
644 else if (strcmp (name2, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0)
647 cmp = modest_text_utils_utf8_strcmp (name1, name2, TRUE);
649 cmp = modest_text_utils_utf8_strcmp (name1, name2, TRUE);