* deal (optionally) with the gtk2 ui code
[modest] / src / modest-tny-folder-tree-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-account-tree-model.h>
34 #include <tny-account-store-iface.h>
35 #include <tny-account-iface.h>
36 #include <tny-msg-folder-iface.h>
37 #include <tny-summary-window-iface.h>
38
39 #include "modest-tny-folder-tree-view.h"
40
41 #include <modest-icon-names.h>
42 #include "modest-icon-factory.h"
43
44
45 /* 'private'/'protected' functions */
46 static void modest_tny_folder_tree_view_class_init  (ModestTnyFolderTreeViewClass *klass);
47 static void modest_tny_folder_tree_view_init        (ModestTnyFolderTreeView *obj);
48 static void modest_tny_folder_tree_view_finalize    (GObject *obj);
49
50 //static void modest_tny_folder_tree_view_iface_init   (gpointer iface, gpointer data);
51 static void modest_tny_folder_tree_view_set_account_store (TnySummaryWindowIface *self,
52                                                            TnyAccountStoreIface *account_store);
53 static gboolean update_model (ModestTnyFolderTreeView *self,TnyAccountStoreIface *iface);
54 static gboolean update_model_empty (ModestTnyFolderTreeView *self);
55
56 static void selection_changed (GtkTreeSelection *sel, gpointer data);
57
58 enum {
59         FOLDER_SELECTED_SIGNAL,
60         LAST_SIGNAL
61 };
62
63 typedef struct _ModestTnyFolderTreeViewPrivate ModestTnyFolderTreeViewPrivate;
64 struct _ModestTnyFolderTreeViewPrivate {
65         TnyAccountStoreIface *tny_account_store;
66         TnyMsgFolderIface *cur_folder;
67         gboolean view_is_empty;
68 };
69 #define MODEST_TNY_FOLDER_TREE_VIEW_GET_PRIVATE(o)                      \
70         (G_TYPE_INSTANCE_GET_PRIVATE((o),                               \
71                                      MODEST_TYPE_TNY_FOLDER_TREE_VIEW,  \
72                                      ModestTnyFolderTreeViewPrivate))
73 /* globals */
74 static GObjectClass *parent_class = NULL;
75
76 static guint signals[LAST_SIGNAL] = {0}; 
77
78 GType
79 modest_tny_folder_tree_view_get_type (void)
80 {
81         static GType my_type = 0;
82         if (!my_type) {
83                 static const GTypeInfo my_info = {
84                         sizeof(ModestTnyFolderTreeViewClass),
85                         NULL,           /* base init */
86                         NULL,           /* base finalize */
87                         (GClassInitFunc) modest_tny_folder_tree_view_class_init,
88                         NULL,           /* class finalize */
89                         NULL,           /* class data */
90                         sizeof(ModestTnyFolderTreeView),
91                         1,              /* n_preallocs */
92                         (GInstanceInitFunc) modest_tny_folder_tree_view_init,
93                 };
94                                 
95                 my_type = g_type_register_static (GTK_TYPE_TREE_VIEW,
96                                                   "ModestTnyFolderTreeView",
97                                                   &my_info, 0);         
98         }
99         return my_type;
100 }
101
102 static void
103 modest_tny_folder_tree_view_class_init (ModestTnyFolderTreeViewClass *klass)
104 {
105         GObjectClass *gobject_class;
106         gobject_class = (GObjectClass*) klass;
107
108         parent_class            = g_type_class_peek_parent (klass);
109         gobject_class->finalize = modest_tny_folder_tree_view_finalize;
110         
111         klass->update_model = modest_tny_folder_tree_view_update_model;
112
113         g_type_class_add_private (gobject_class,
114                                   sizeof(ModestTnyFolderTreeViewPrivate));
115         
116         signals[FOLDER_SELECTED_SIGNAL] = 
117                 g_signal_new ("folder_selected",
118                               G_TYPE_FROM_CLASS (gobject_class),
119                               G_SIGNAL_RUN_FIRST,
120                               G_STRUCT_OFFSET (ModestTnyFolderTreeViewClass,
121                                                folder_selected),
122                               NULL, NULL,
123                               g_cclosure_marshal_VOID__POINTER,
124                               G_TYPE_NONE, 1, G_TYPE_POINTER); 
125 }
126
127
128
129 static void
130 text_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
131                    GtkTreeModel *tree_model,  GtkTreeIter *iter,  gpointer data)
132 {
133         GObject *rendobj;
134         gchar *fname;
135         gint unread;
136         TnyMsgFolderType type;
137         
138         gtk_tree_model_get (tree_model, iter,
139                             TNY_ACCOUNT_TREE_MODEL_NAME_COLUMN, &fname,
140                             TNY_ACCOUNT_TREE_MODEL_TYPE_COLUMN, &type,
141                             TNY_ACCOUNT_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
142         rendobj = G_OBJECT(renderer);
143
144         if (unread > 0) {
145                 gchar *folder_title = g_strdup_printf ("%s (%d)", fname, unread);
146                 g_object_set (rendobj,"text", folder_title,  "weight", 800, NULL);
147                 g_free (folder_title);
148         } else 
149                 g_object_set (rendobj,"text", fname, "weight", 400, NULL);
150                 
151         g_free (fname);
152 }
153
154 /* FIXME: move these to TnyMail */
155 enum {
156
157         TNY_MSG_FOLDER_TYPE_NOTES = TNY_MSG_FOLDER_TYPE_SENT + 1, /* urgh */
158         TNY_MSG_FOLDER_TYPE_DRAFTS,
159         TNY_MSG_FOLDER_TYPE_CONTACTS,
160         TNY_MSG_FOLDER_TYPE_CALENDAR
161 };
162         
163 static TnyMsgFolderType
164 guess_folder_type (const gchar* name)
165 {
166         TnyMsgFolderType type;
167         gchar *folder;
168
169         g_return_val_if_fail (name, TNY_MSG_FOLDER_TYPE_NORMAL);
170         
171         type = TNY_MSG_FOLDER_TYPE_NORMAL;
172         folder = g_utf8_strdown (name, strlen(name));
173
174         if (strcmp (folder, "inbox") == 0 ||
175             strcmp (folder, _("inbox")) == 0)
176                 type = TNY_MSG_FOLDER_TYPE_INBOX;
177         else if (strcmp (folder, "outbox") == 0 ||
178                  strcmp (folder, _("outbox")) == 0)
179                 type = TNY_MSG_FOLDER_TYPE_OUTBOX;
180         else if (g_str_has_prefix(folder, "junk") ||
181                  g_str_has_prefix(folder, _("junk")))
182                 type = TNY_MSG_FOLDER_TYPE_JUNK;
183         else if (g_str_has_prefix(folder, "trash") ||
184                  g_str_has_prefix(folder, _("trash")))
185                 type = TNY_MSG_FOLDER_TYPE_JUNK;
186         else if (g_str_has_prefix(folder, "sent") ||
187                  g_str_has_prefix(folder, _("sent")))
188                 type = TNY_MSG_FOLDER_TYPE_SENT;
189
190         /* these are not *really* TNY_ types */
191         else if (g_str_has_prefix(folder, "draft") ||
192                  g_str_has_prefix(folder, _("draft")))
193                 type = TNY_MSG_FOLDER_TYPE_DRAFTS;
194         else if (g_str_has_prefix(folder, "notes") ||
195                  g_str_has_prefix(folder, _("notes")))
196                 type = TNY_MSG_FOLDER_TYPE_NOTES;
197         else if (g_str_has_prefix(folder, "contacts") ||
198                  g_str_has_prefix(folder, _("contacts")))
199                 type = TNY_MSG_FOLDER_TYPE_CONTACTS;
200         else if (g_str_has_prefix(folder, "calendar") ||
201                  g_str_has_prefix(folder, _("calendar")))
202                 type = TNY_MSG_FOLDER_TYPE_CALENDAR;
203         
204         g_free (folder);
205         return type;
206 }
207
208
209 static void
210 icon_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
211                  GtkTreeModel *tree_model,  GtkTreeIter *iter, gpointer data)
212 {
213         GObject *rendobj;
214         GdkPixbuf *pixbuf;
215         TnyMsgFolderType type;
216         gchar *fname = NULL;
217         gint unread;
218         
219         rendobj = G_OBJECT(renderer);
220         gtk_tree_model_get (tree_model, iter,
221                             TNY_ACCOUNT_TREE_MODEL_TYPE_COLUMN, &type,
222                             TNY_ACCOUNT_TREE_MODEL_NAME_COLUMN, &fname,
223                             TNY_ACCOUNT_TREE_MODEL_UNREAD_COLUMN, &unread, -1);
224         rendobj = G_OBJECT(renderer);
225         
226         if (type == TNY_MSG_FOLDER_TYPE_NORMAL)
227                 type = guess_folder_type (fname);
228         
229         if (fname);
230                 g_free (fname);
231
232         switch (type) {
233         case TNY_MSG_FOLDER_TYPE_INBOX:
234                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_INBOX);
235                 break;
236         case TNY_MSG_FOLDER_TYPE_OUTBOX:
237                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OUTBOX);
238                 break;
239         case TNY_MSG_FOLDER_TYPE_JUNK:
240                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_JUNK);
241                 break;
242         case TNY_MSG_FOLDER_TYPE_SENT:
243                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_SENT);
244                 break;
245         case TNY_MSG_FOLDER_TYPE_DRAFTS:
246                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_DRAFTS);
247                 break;
248         case TNY_MSG_FOLDER_TYPE_NOTES:
249                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_NOTES);
250                 break;
251         case TNY_MSG_FOLDER_TYPE_CALENDAR:
252                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CALENDAR);
253                 break;
254         case TNY_MSG_FOLDER_TYPE_CONTACTS:
255                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CONTACTS);
256                 break;
257         case TNY_MSG_FOLDER_TYPE_NORMAL:
258         default:
259                 pixbuf = modest_icon_factory_get_icon (MODEST_FOLDER_ICON_NORMAL);
260                 break;
261         }
262
263         g_object_set (rendobj,
264                       "pixbuf-expander-open",
265                       modest_icon_factory_get_icon (MODEST_FOLDER_ICON_OPEN),
266                       "pixbuf-expander-closed",
267                       modest_icon_factory_get_icon (MODEST_FOLDER_ICON_CLOSED),
268                       "pixbuf", pixbuf,
269                       NULL);
270 }
271
272 static void
273 modest_tny_folder_tree_view_init (ModestTnyFolderTreeView *obj)
274 {
275         ModestTnyFolderTreeViewPrivate *priv;
276         GtkTreeViewColumn *column;
277         GtkCellRenderer *renderer;
278         GtkTreeSelection *sel;
279         
280         priv =  MODEST_TNY_FOLDER_TREE_VIEW_GET_PRIVATE(obj);
281         
282         priv->view_is_empty     = TRUE;
283         priv->tny_account_store = NULL;
284         priv->cur_folder = NULL;
285
286         column = gtk_tree_view_column_new ();
287         gtk_tree_view_column_set_title (column,
288                                         _("All Mail Folders"));
289         
290         gtk_tree_view_append_column (GTK_TREE_VIEW(obj),
291                                      column);
292         
293         renderer = gtk_cell_renderer_pixbuf_new();
294         gtk_tree_view_column_pack_start (column, renderer, FALSE);
295         gtk_tree_view_column_set_cell_data_func(column, renderer,
296                                                 icon_cell_data, NULL, NULL);
297         
298         renderer = gtk_cell_renderer_text_new();
299         gtk_tree_view_column_pack_start (column, renderer, FALSE);
300         gtk_tree_view_column_set_cell_data_func(column, renderer,
301                                                 text_cell_data, NULL, NULL);
302         
303         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
304         gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
305
306         gtk_tree_view_column_set_spacing (column, 2);
307         gtk_tree_view_column_set_resizable (column, TRUE);
308         gtk_tree_view_column_set_fixed_width (column, TRUE);            
309         gtk_tree_view_set_headers_visible   (GTK_TREE_VIEW(obj), TRUE);
310         gtk_tree_view_set_headers_clickable (GTK_TREE_VIEW(obj), FALSE);
311
312 }
313
314
315 static void
316 modest_tny_folder_tree_view_finalize (GObject *obj)
317 {
318         ModestTnyFolderTreeViewPrivate *priv;
319
320         g_return_if_fail (obj);
321         
322         priv =  MODEST_TNY_FOLDER_TREE_VIEW_GET_PRIVATE(obj);
323         if (priv->tny_account_store) {
324                 g_object_unref (G_OBJECT(priv->tny_account_store));
325                 priv->tny_account_store = NULL;
326         }
327
328         (*parent_class->finalize)(obj);
329 }
330
331
332 static void
333 modest_tny_folder_tree_view_set_account_store (TnySummaryWindowIface *self,
334                                                TnyAccountStoreIface *account_store)
335 {
336         ModestTnyFolderTreeViewPrivate *priv;
337
338         g_return_if_fail (self);
339         g_return_if_fail (account_store);
340         
341         priv = MODEST_TNY_FOLDER_TREE_VIEW_GET_PRIVATE(self);
342         if (priv->tny_account_store) {
343                 g_object_unref (priv->tny_account_store);
344                 priv->tny_account_store = NULL;
345         }
346
347         g_object_ref (G_OBJECT(priv->tny_account_store = account_store));
348 }
349
350
351
352 static void
353 on_accounts_update (TnyAccountStoreIface *account_store, const gchar *account,
354                     gpointer user_data)
355 {
356         update_model_empty (MODEST_TNY_FOLDER_TREE_VIEW(user_data));
357         
358         if (!update_model (MODEST_TNY_FOLDER_TREE_VIEW(user_data), account_store))
359                 g_printerr ("modest: failed to update model for changes in '%s'",
360                             account);
361 }
362
363
364 GtkWidget*
365 modest_tny_folder_tree_view_new (TnyAccountStoreIface *account_store)
366 {
367         GObject *self;
368         ModestTnyFolderTreeViewPrivate *priv;
369         GtkTreeSelection *sel;
370
371         self = G_OBJECT(g_object_new(MODEST_TYPE_TNY_FOLDER_TREE_VIEW, NULL));
372         priv = MODEST_TNY_FOLDER_TREE_VIEW_GET_PRIVATE(self);
373
374         g_return_val_if_fail (account_store, NULL);
375         
376         if (!update_model (MODEST_TNY_FOLDER_TREE_VIEW(self), account_store))
377                 g_printerr ("modest: failed to update model");
378
379         g_signal_connect (G_OBJECT(account_store), "update_accounts",
380                           G_CALLBACK (on_accounts_update), self);
381         
382         sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(self));
383         g_signal_connect (sel, "changed",
384                           G_CALLBACK(selection_changed), self);
385                 
386         return GTK_WIDGET(self);
387 }
388
389
390
391
392 static gboolean
393 update_model_empty (ModestTnyFolderTreeView *self)
394 {
395         GtkTreeIter  iter;
396         GtkTreeStore *store;
397         ModestTnyFolderTreeViewPrivate *priv;
398         
399         g_return_val_if_fail (self, FALSE);
400         
401         store = gtk_tree_store_new (1, G_TYPE_STRING);
402         gtk_tree_store_append (store, &iter, NULL);
403
404         gtk_tree_store_set (store, &iter, 0,
405                             _("(empty)"), -1);
406
407         gtk_tree_view_set_model (GTK_TREE_VIEW(self),
408                                  GTK_TREE_MODEL(store));
409         g_object_unref (store);
410
411         priv = MODEST_TNY_FOLDER_TREE_VIEW_GET_PRIVATE(self);
412         priv->view_is_empty = TRUE;
413         
414         return TRUE;
415 }
416
417
418 static gboolean
419 update_model (ModestTnyFolderTreeView *self, TnyAccountStoreIface *account_store)
420 {
421         ModestTnyFolderTreeViewPrivate *priv;
422         TnyListIface     *account_list;
423         GtkTreeModel     *model, *sortable;
424         
425         g_return_val_if_fail (account_store, FALSE);
426         
427         priv =  MODEST_TNY_FOLDER_TREE_VIEW_GET_PRIVATE(self);
428
429         model        = GTK_TREE_MODEL(tny_account_tree_model_new ());
430         account_list = TNY_LIST_IFACE(model);
431
432         update_model_empty (self); /* cleanup */
433         priv->view_is_empty = TRUE;
434         
435         tny_account_store_iface_get_accounts (account_store, account_list,
436                                               TNY_ACCOUNT_STORE_IFACE_STORE_ACCOUNTS);
437         if (!account_list) /* no store accounts found */ 
438                 return TRUE;
439         
440         sortable = gtk_tree_model_sort_new_with_model (model);
441         gtk_tree_view_set_model (GTK_TREE_VIEW(self), sortable);
442
443         priv->view_is_empty = FALSE;    
444         g_object_unref (model);
445
446         return TRUE;
447
448
449
450 void
451 selection_changed (GtkTreeSelection *sel, gpointer user_data)
452 {
453         GtkTreeModel            *model;
454         TnyMsgFolderIface       *folder = NULL;
455         GtkTreeIter             iter;
456         ModestTnyFolderTreeView *tree_view;
457         ModestTnyFolderTreeViewPrivate *priv;
458
459         g_return_if_fail (sel);
460         g_return_if_fail (user_data);
461
462         priv = MODEST_TNY_FOLDER_TREE_VIEW_GET_PRIVATE(user_data);
463
464         /* is_empty means that there is only the 'empty' item */
465         if (priv->view_is_empty)
466                 return;
467         
468         /* folder was _un_selected if true */
469         if (!gtk_tree_selection_get_selected (sel, &model, &iter)) {
470                 
471                 if (priv->cur_folder) 
472                         tny_msg_folder_iface_expunge (priv->cur_folder);
473                 priv->cur_folder = NULL;
474                 return; 
475         }
476
477         tree_view = MODEST_TNY_FOLDER_TREE_VIEW (user_data);
478
479         gtk_tree_model_get (model, &iter,
480                             TNY_ACCOUNT_TREE_MODEL_INSTANCE_COLUMN,
481                             &folder, -1);
482
483         if (priv->cur_folder) 
484                 tny_msg_folder_iface_expunge (priv->cur_folder);
485         priv->cur_folder = folder;
486
487         /* folder will not be defined if you click eg. on the root node */
488         if (folder)
489                 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTED_SIGNAL], 0,
490                                folder);
491 }
492
493
494 gboolean
495 modest_tny_folder_tree_view_update_model(ModestTnyFolderTreeView *self, 
496                                          TnyAccountStoreIface *iface)
497 {
498         g_return_val_if_fail (MODEST_IS_TNY_FOLDER_TREE_VIEW (self), FALSE);
499         
500         return update_model (self, iface);
501 }