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