* all:
[modest] / src / widgets / modest-folder-view.c
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30 #include <glib/gi18n.h>
31 #include <string.h>
32
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
45 #include "modest-folder-view.h"
46
47 /* 'private'/'protected' functions */
48 static void modest_folder_view_class_init  (ModestFolderViewClass *klass);
49 static void modest_folder_view_init        (ModestFolderView *obj);
50 static void modest_folder_view_finalize    (GObject *obj);
51
52 static gboolean     update_model             (ModestFolderView *self,
53                                               ModestTnyAccountStore *account_store);
54 static gboolean     update_model_empty       (ModestFolderView *self);
55
56 static void         on_selection_changed     (GtkTreeSelection *sel, gpointer data);
57 static void         on_subscription_changed  (TnyStoreAccount *store_account, TnyFolder *folder,
58                                               ModestFolderView *self);
59
60 static gboolean     modest_folder_view_update_model     (ModestFolderView *self,
61                                                          TnyAccountStore *account_store);
62
63 static void         modest_folder_view_disconnect_store_account_handlers (GtkTreeView *self);
64
65 enum {
66         FOLDER_SELECTION_CHANGED_SIGNAL,
67         LAST_SIGNAL
68 };
69
70 typedef struct _ModestFolderViewPrivate ModestFolderViewPrivate;
71 struct _ModestFolderViewPrivate {
72
73         TnyAccountStore     *account_store;
74         TnyFolder           *cur_folder;
75         gboolean             view_is_empty;
76
77         gulong               sig1, sig2;
78         gulong              *store_accounts_handlers;
79         GMutex              *lock;
80         GtkTreeSelection    *cur_selection;
81         TnyFolderStoreQuery *query;
82
83 };
84 #define MODEST_FOLDER_VIEW_GET_PRIVATE(o)                               \
85         (G_TYPE_INSTANCE_GET_PRIVATE((o),                               \
86                                      MODEST_TYPE_FOLDER_VIEW,           \
87                                      ModestFolderViewPrivate))
88 /* globals */
89 static GObjectClass *parent_class = NULL;
90
91 static guint signals[LAST_SIGNAL] = {0}; 
92
93 GType
94 modest_folder_view_get_type (void)
95 {
96         static GType my_type = 0;
97         if (!my_type) {
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),
106                         1,              /* n_preallocs */
107                         (GInstanceInitFunc) modest_folder_view_init,
108                         NULL
109                 };
110                                 
111                 my_type = g_type_register_static (GTK_TYPE_TREE_VIEW,
112                                                   "ModestFolderView",
113                                                   &my_info, 0);         
114         }
115         return my_type;
116 }
117
118 static void
119 modest_folder_view_class_init (ModestFolderViewClass *klass)
120 {
121         GObjectClass *gobject_class;
122         gobject_class = (GObjectClass*) klass;
123
124         parent_class            = g_type_class_peek_parent (klass);
125         gobject_class->finalize = modest_folder_view_finalize;
126         
127         klass->update_model = modest_folder_view_update_model;
128
129         g_type_class_add_private (gobject_class,
130                                   sizeof(ModestFolderViewPrivate));
131         
132         signals[FOLDER_SELECTION_CHANGED_SIGNAL] = 
133                 g_signal_new ("folder_selection_changed",
134                               G_TYPE_FROM_CLASS (gobject_class),
135                               G_SIGNAL_RUN_FIRST,
136                               G_STRUCT_OFFSET (ModestFolderViewClass,
137                                                folder_selection_changed),
138                               NULL, NULL,
139                               modest_marshal_VOID__POINTER_BOOLEAN,
140                               G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_BOOLEAN);
141 }
142
143
144 static void
145 text_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
146                  GtkTreeModel *tree_model,  GtkTreeIter *iter,  gpointer data)
147 {
148         GObject *rendobj;
149         gchar *fname;
150         gint unread;
151         TnyFolderType type;
152         
153         gtk_tree_model_get (tree_model, iter,
154                             TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
155                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
156                             TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
157         rendobj = G_OBJECT(renderer);
158
159         if (unread > 0) {
160                 gchar *folder_title = g_strdup_printf ("%s (%d)", fname, unread);
161                 g_object_set (rendobj,"text", folder_title,  "weight", 800, NULL);
162                 g_free (folder_title);
163         } else 
164                 g_object_set (rendobj,"text", fname, "weight", 400, NULL);
165                 
166         g_free (fname);
167 }
168
169
170
171 static void
172 icon_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
173                  GtkTreeModel *tree_model,  GtkTreeIter *iter, gpointer data)
174 {
175         GObject *rendobj;
176         GdkPixbuf *pixbuf;
177         TnyFolderType type;
178         gchar *fname = NULL;
179         gint unread;
180         
181         rendobj = G_OBJECT(renderer);
182         gtk_tree_model_get (tree_model, iter,
183                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
184                             TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
185                             TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
186         rendobj = G_OBJECT(renderer);
187         
188         if (type == TNY_FOLDER_TYPE_NORMAL || type == TNY_FOLDER_TYPE_UNKNOWN)
189                 type = modest_tny_folder_guess_folder_type_from_name (fname);
190         g_free (fname);
191
192         switch (type) {
193         case TNY_FOLDER_TYPE_ROOT:
194                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_ACCOUNT);
195                 break;
196         case TNY_FOLDER_TYPE_INBOX:
197                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_INBOX);
198                 break;
199         case TNY_FOLDER_TYPE_OUTBOX:
200                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_OUTBOX);
201                 break;
202         case TNY_FOLDER_TYPE_JUNK:
203                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_JUNK);
204                 break;
205         case TNY_FOLDER_TYPE_SENT:
206                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_SENT);
207                 break;
208         case TNY_FOLDER_TYPE_DRAFTS:
209                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_DRAFTS);
210                 break;
211         case TNY_FOLDER_TYPE_NOTES:
212                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_NOTES);
213                 break;
214         case TNY_FOLDER_TYPE_CALENDAR:
215                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_CALENDAR);
216                 break;
217         case TNY_FOLDER_TYPE_CONTACTS:
218                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_CONTACTS);
219                 break;
220         case TNY_FOLDER_TYPE_NORMAL:
221         default:
222                 pixbuf = modest_icon_factory_get_small_icon (MODEST_FOLDER_ICON_NORMAL);
223                 break;
224         }
225
226         g_object_set (rendobj,
227                       "pixbuf-expander-open",
228                       modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OPEN),
229                       "pixbuf-expander-closed",
230                       modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CLOSED),
231                       "pixbuf", pixbuf,
232                       NULL);
233 }
234
235 static void
236 modest_folder_view_init (ModestFolderView *obj)
237 {
238         ModestFolderViewPrivate *priv;
239         GtkTreeViewColumn *column;
240         GtkCellRenderer *renderer;
241         GtkTreeSelection *sel;
242         
243         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
244         
245         priv->view_is_empty  = TRUE;
246         priv->account_store  = NULL;
247         priv->cur_folder     = NULL;
248         priv->query          = NULL;
249         priv->lock           = g_mutex_new ();
250         
251         column = gtk_tree_view_column_new ();   
252         gtk_tree_view_append_column (GTK_TREE_VIEW(obj),column);
253         
254         renderer = gtk_cell_renderer_pixbuf_new();
255         gtk_tree_view_column_pack_start (column, renderer, FALSE);
256         gtk_tree_view_column_set_cell_data_func(column, renderer,
257                                                 icon_cell_data, NULL, NULL);
258         
259         renderer = gtk_cell_renderer_text_new();
260         gtk_tree_view_column_pack_start (column, renderer, FALSE);
261         gtk_tree_view_column_set_cell_data_func(column, renderer,
262                                                 text_cell_data, NULL, NULL);
263         
264         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
265         gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
266
267         gtk_tree_view_column_set_spacing (column, 2);
268         gtk_tree_view_column_set_resizable (column, TRUE);
269         gtk_tree_view_column_set_fixed_width (column, TRUE);            
270         gtk_tree_view_set_headers_clickable (GTK_TREE_VIEW(obj), FALSE);
271         gtk_tree_view_set_enable_search     (GTK_TREE_VIEW(obj), FALSE);
272
273 }
274
275 static void
276 modest_folder_view_disconnect_store_account_handlers (GtkTreeView *self)
277 {
278         TnyIterator *iter;
279         ModestFolderViewPrivate *priv;
280         GtkTreeModel *model;
281         GtkTreeModelSort *sortable;
282         gint i = 0;
283
284         sortable = GTK_TREE_MODEL_SORT (gtk_tree_view_get_model (self));
285         if (!sortable)
286                 return; 
287
288         model = gtk_tree_model_sort_get_model (sortable);
289         if (!model)
290                 return; 
291
292         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE (self);  
293         iter = tny_list_create_iterator (TNY_LIST (model));
294         while (!tny_iterator_is_done (iter)) {
295                 g_signal_handler_disconnect (G_OBJECT (tny_iterator_get_current (iter)),
296                                              priv->store_accounts_handlers [i++]);
297                 tny_iterator_next (iter);
298         }
299         g_object_unref (G_OBJECT (iter));
300 }
301
302
303 static void
304 modest_folder_view_finalize (GObject *obj)
305 {
306         ModestFolderViewPrivate *priv;
307         GtkTreeSelection    *sel;
308         
309         g_return_if_fail (obj);
310         
311         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
312         if (priv->account_store) {
313                 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
314                                              priv->sig1);
315                 g_object_unref (G_OBJECT(priv->account_store));
316                 priv->account_store = NULL;
317         }
318
319         if (priv->lock) {
320                 g_mutex_free (priv->lock);
321                 priv->lock = NULL;
322         }
323
324         if (priv->store_accounts_handlers) {
325                 modest_folder_view_disconnect_store_account_handlers (GTK_TREE_VIEW (obj));
326                 g_free (priv->store_accounts_handlers);
327                 priv->store_accounts_handlers = NULL;
328         }
329
330         if (priv->query) {
331                 g_object_unref (G_OBJECT (priv->query));
332                 priv->query = NULL;
333         }
334
335         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
336         if (sel)
337                 g_signal_handler_disconnect (G_OBJECT(sel), priv->sig2);
338         
339         G_OBJECT_CLASS(parent_class)->finalize (obj);
340 }
341
342
343 static void
344 on_account_update (TnyAccountStore *account_store, const gchar *account,
345                    gpointer user_data)
346 {
347         update_model_empty (MODEST_FOLDER_VIEW(user_data));
348         
349         if (!update_model (MODEST_FOLDER_VIEW(user_data), 
350                            MODEST_TNY_ACCOUNT_STORE(account_store)))
351                 g_printerr ("modest: failed to update model for changes in '%s'",
352                             account);
353 }
354
355 void
356 modest_folder_view_set_title (ModestFolderView *self, const gchar *title)
357 {
358         GtkTreeViewColumn *col;
359         
360         g_return_if_fail (self);
361
362         col = gtk_tree_view_get_column (GTK_TREE_VIEW(self), 0);
363         if (!col) {
364                 g_printerr ("modest: failed get column for title\n");
365                 return;
366         }
367
368         gtk_tree_view_column_set_title (col, title);
369         gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(self),
370                                            title != NULL);
371 }
372
373 GtkWidget*
374 modest_folder_view_new (ModestTnyAccountStore *account_store, 
375                         TnyFolderStoreQuery *query)
376 {
377         GObject *self;
378         ModestFolderViewPrivate *priv;
379         GtkTreeSelection *sel;
380         
381         g_return_val_if_fail (account_store, NULL);
382         
383         self = G_OBJECT(g_object_new(MODEST_TYPE_FOLDER_VIEW, NULL));
384         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
385         
386         priv->account_store = g_object_ref (G_OBJECT (account_store));
387         if (query)
388                 priv->query = g_object_ref (G_OBJECT (query));
389         
390         if (!update_model (MODEST_FOLDER_VIEW(self),
391                            MODEST_TNY_ACCOUNT_STORE(account_store)))
392                 g_printerr ("modest: failed to update model\n");
393         
394         priv->sig1 = g_signal_connect (G_OBJECT(account_store), "account_update",
395                                        G_CALLBACK (on_account_update), self);   
396         
397         sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(self));
398         priv->sig2 = g_signal_connect (sel, "changed",
399                                        G_CALLBACK(on_selection_changed), self);
400
401         return GTK_WIDGET(self);
402 }
403
404
405 static gboolean
406 update_model_empty (ModestFolderView *self)
407 {
408         GtkTreeIter  iter;
409         GtkTreeStore *store;
410         ModestFolderViewPrivate *priv;
411         
412         g_return_val_if_fail (self, FALSE);
413         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
414
415         /* Disconnect old handlers */
416         if (priv->store_accounts_handlers) {
417                 modest_folder_view_disconnect_store_account_handlers (GTK_TREE_VIEW (self));
418                 g_free (priv->store_accounts_handlers);
419                 priv->store_accounts_handlers = NULL;
420         }
421
422         /* Create the new model */
423         store = gtk_tree_store_new (1, G_TYPE_STRING);
424         gtk_tree_store_append (store, &iter, NULL);
425
426         gtk_tree_store_set (store, &iter, 0, _("(empty)"), -1);
427
428         gtk_tree_view_set_model (GTK_TREE_VIEW(self),
429                                  GTK_TREE_MODEL(store));
430         g_object_unref (store);
431
432         priv->view_is_empty = TRUE;
433
434         g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
435                        NULL, TRUE);
436         return TRUE;
437 }
438
439
440 static void
441 update_store_account_handlers (ModestFolderView *self, TnyList *account_list)
442 {
443         ModestFolderViewPrivate *priv;
444         TnyIterator *iter;
445         guint len;
446         
447         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(self);
448
449         /* Listen to subscription changes */
450         len = tny_list_get_length (TNY_LIST (account_list));
451
452         g_assert (priv->store_accounts_handlers == NULL); /* don't leak */
453         priv->store_accounts_handlers = g_malloc0 (sizeof (guint) * len);
454         iter = tny_list_create_iterator (account_list);
455         
456         if (!tny_iterator_is_done (iter)) {
457                 gint i = 0;
458
459                 priv->view_is_empty = FALSE;
460                 do  {
461                         
462                         priv->store_accounts_handlers [i++] =
463                                 g_signal_connect (G_OBJECT (tny_iterator_get_current (iter)),
464                                                   "subscription_changed",
465                                                   G_CALLBACK (on_subscription_changed),
466                                                   self);
467                         tny_iterator_next (iter);
468                 } while (!tny_iterator_is_done (iter));
469         }
470         g_object_unref (G_OBJECT (iter));       
471 }
472
473
474
475 static gboolean
476 update_model (ModestFolderView *self, ModestTnyAccountStore *account_store)
477 {
478         ModestFolderViewPrivate *priv;
479
480         TnyList          *account_list;
481         GtkTreeModel     *model, *sortable;
482
483         g_return_val_if_fail (account_store, FALSE);
484         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(self);
485         
486         model        = tny_gtk_folder_store_tree_model_new (TRUE, NULL);
487         account_list = TNY_LIST(model);
488
489         tny_account_store_get_accounts (TNY_ACCOUNT_STORE(account_store),
490                                         account_list,
491                                         TNY_ACCOUNT_STORE_STORE_ACCOUNTS);
492
493         if (account_list) {
494                 sortable = gtk_tree_model_sort_new_with_model (model);
495                 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sortable),
496                                                       TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, 
497                                                       GTK_SORT_ASCENDING);
498                 gtk_tree_view_set_model (GTK_TREE_VIEW(self), sortable);
499
500                 update_store_account_handlers (self, account_list);
501         }
502
503         g_object_unref (model);
504         return TRUE;
505 }
506
507
508 static void
509 on_selection_changed (GtkTreeSelection *sel, gpointer user_data)
510 {
511         GtkTreeModel            *model;
512         TnyFolder               *folder = NULL;
513         GtkTreeIter             iter;
514         ModestFolderView        *tree_view;
515         ModestFolderViewPrivate *priv;
516         gint                    type;
517
518         g_return_if_fail (sel);
519         g_return_if_fail (user_data);
520         
521         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(user_data);
522         priv->cur_selection = sel;
523         
524         /* is_empty means that there is only the 'empty' item */
525         if (priv->view_is_empty)
526                 return;
527
528         /* folder was _un_selected if true */
529         if (!gtk_tree_selection_get_selected (sel, &model, &iter)) {
530                 priv->cur_folder = NULL; /* FIXME: need this? */
531                return; 
532        }
533         
534         tree_view = MODEST_FOLDER_VIEW (user_data);
535         gtk_tree_model_get (model, &iter,
536                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
537                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder,
538                             -1);
539
540         if (type == TNY_FOLDER_TYPE_ROOT)
541                 return;
542
543         /* emit 2 signals: one for the unselection of the old one,
544          * and one for the selection of the new on */
545         g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
546                        priv->cur_folder, FALSE);
547         g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
548                        folder, TRUE);
549         
550         if (priv->cur_folder)
551                 tny_folder_expunge (priv->cur_folder, NULL); /* FIXME */
552         priv->cur_folder = folder;
553
554 }
555
556 static void 
557 on_subscription_changed  (TnyStoreAccount *store_account, 
558                           TnyFolder *folder,
559                           ModestFolderView *self)
560 {
561         /* TODO: probably we won't need a full reload, just the store
562            account or even the parent of the folder */
563
564         ModestFolderViewPrivate *priv;
565
566         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(self);
567         update_model (self, MODEST_TNY_ACCOUNT_STORE (priv->account_store));
568 }
569
570
571 static gboolean
572 modest_folder_view_update_model (ModestFolderView *self, TnyAccountStore *account_store)
573 {
574         gboolean retval;
575
576         g_return_val_if_fail (MODEST_IS_FOLDER_VIEW (self), FALSE);
577         retval = update_model (self, MODEST_TNY_ACCOUNT_STORE(account_store)); /* ugly */
578
579         g_signal_emit (G_OBJECT(self), signals[FOLDER_SELECTION_CHANGED_SIGNAL],
580                        0, NULL, TRUE);
581
582         return retval;
583 }