* Commented some devive_force_online methods
[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-account-store-view.h>
34 #include <tny-gtk-account-list-model.h>
35 #include <tny-gtk-folder-store-tree-model.h>
36 #include <tny-gtk-header-list-model.h>
37 #include <tny-folder.h>
38 #include <tny-account-store.h>
39 #include <tny-account.h>
40 #include <tny-folder.h>
41 #include <tny-camel-folder.h>
42 #include <tny-simple-list.h>
43 #include <modest-tny-folder.h>
44 #include <modest-marshal.h>
45 #include <modest-icon-names.h>
46 #include <modest-tny-account-store.h>
47 #include <modest-text-utils.h>
48 #include <modest-runtime.h>
49 #include "modest-folder-view.h"
50 #include <modest-dnd.h>
51
52 /* 'private'/'protected' functions */
53 static void modest_folder_view_class_init  (ModestFolderViewClass *klass);
54 static void modest_folder_view_init        (ModestFolderView *obj);
55 static void modest_folder_view_finalize    (GObject *obj);
56
57 static void         tny_account_store_view_init (gpointer g, 
58                                                  gpointer iface_data);
59
60 static void         modest_folder_view_set_account_store (TnyAccountStoreView *self, 
61                                                           TnyAccountStore     *account_store);
62
63 static gboolean     update_model           (ModestFolderView *self,
64                                             ModestTnyAccountStore *account_store);
65
66 static void         on_selection_changed   (GtkTreeSelection *sel, gpointer data);
67
68 static void         on_account_update      (TnyAccountStore *account_store, 
69                                             const gchar *account,
70                                             gpointer user_data);
71
72 static void         on_accounts_reloaded   (TnyAccountStore *store, 
73                                             gpointer user_data);
74
75 static gint         cmp_rows               (GtkTreeModel *tree_model, 
76                                             GtkTreeIter *iter1, 
77                                             GtkTreeIter *iter2,
78                                             gpointer user_data);
79
80 /* DnD functions */
81 static void         on_drag_data_get       (GtkWidget *widget, 
82                                             GdkDragContext *context, 
83                                             GtkSelectionData *selection_data, 
84                                             guint info, 
85                                             guint time, 
86                                             gpointer data);
87
88 static void         on_drag_data_received  (GtkWidget *widget, 
89                                             GdkDragContext *context, 
90                                             gint x, 
91                                             gint y, 
92                                             GtkSelectionData *selection_data, 
93                                             guint info, 
94                                             guint time, 
95                                             gpointer data);
96
97 static gboolean     on_drag_motion         (GtkWidget      *widget,
98                                             GdkDragContext *context,
99                                             gint            x,
100                                             gint            y,
101                                             guint           time,
102                                             gpointer        user_data);
103
104 static gint         expand_row_timeout     (gpointer data);
105
106 static void         setup_drag_and_drop    (GtkTreeView *self);
107
108 enum {
109         FOLDER_SELECTION_CHANGED_SIGNAL,
110         LAST_SIGNAL
111 };
112
113 typedef struct _ModestFolderViewPrivate ModestFolderViewPrivate;
114 struct _ModestFolderViewPrivate {
115         TnyAccountStore     *account_store;
116         TnyFolder           *cur_folder;
117         GtkTreeRowReference *cur_row;
118
119         gulong               account_update_signal;
120         gulong               changed_signal;
121         gulong               accounts_reloaded_signal;
122         
123         GtkTreeSelection    *cur_selection;
124         TnyFolderStoreQuery *query;
125         guint                timer_expander;
126 };
127 #define MODEST_FOLDER_VIEW_GET_PRIVATE(o)                       \
128         (G_TYPE_INSTANCE_GET_PRIVATE((o),                       \
129                                      MODEST_TYPE_FOLDER_VIEW,   \
130                                      ModestFolderViewPrivate))
131 /* globals */
132 static GObjectClass *parent_class = NULL;
133
134 static guint signals[LAST_SIGNAL] = {0}; 
135
136 GType
137 modest_folder_view_get_type (void)
138 {
139         static GType my_type = 0;
140         if (!my_type) {
141                 static const GTypeInfo my_info = {
142                         sizeof(ModestFolderViewClass),
143                         NULL,           /* base init */
144                         NULL,           /* base finalize */
145                         (GClassInitFunc) modest_folder_view_class_init,
146                         NULL,           /* class finalize */
147                         NULL,           /* class data */
148                         sizeof(ModestFolderView),
149                         1,              /* n_preallocs */
150                         (GInstanceInitFunc) modest_folder_view_init,
151                         NULL
152                 };
153
154                 static const GInterfaceInfo tny_account_store_view_info = {
155                         (GInterfaceInitFunc) tny_account_store_view_init, /* interface_init */
156                         NULL,         /* interface_finalize */
157                         NULL          /* interface_data */
158                 };
159
160                                 
161                 my_type = g_type_register_static (GTK_TYPE_TREE_VIEW,
162                                                   "ModestFolderView",
163                                                   &my_info, 0);
164
165                 g_type_add_interface_static (my_type, 
166                                              TNY_TYPE_ACCOUNT_STORE_VIEW, 
167                                              &tny_account_store_view_info);
168         }
169         return my_type;
170 }
171
172 static void
173 modest_folder_view_class_init (ModestFolderViewClass *klass)
174 {
175         GObjectClass *gobject_class;
176         gobject_class = (GObjectClass*) klass;
177
178         parent_class            = g_type_class_peek_parent (klass);
179         gobject_class->finalize = modest_folder_view_finalize;
180
181         g_type_class_add_private (gobject_class,
182                                   sizeof(ModestFolderViewPrivate));
183         
184         signals[FOLDER_SELECTION_CHANGED_SIGNAL] = 
185                 g_signal_new ("folder_selection_changed",
186                               G_TYPE_FROM_CLASS (gobject_class),
187                               G_SIGNAL_RUN_FIRST,
188                               G_STRUCT_OFFSET (ModestFolderViewClass,
189                                                folder_selection_changed),
190                               NULL, NULL,
191                               modest_marshal_VOID__POINTER_BOOLEAN,
192                               G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_BOOLEAN);
193 }
194
195
196
197 static void
198 text_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
199                  GtkTreeModel *tree_model,  GtkTreeIter *iter,  gpointer data)
200 {
201         GObject *rendobj;
202         gchar *fname = NULL;
203         gint unread;
204         TnyFolderType type;
205         TnyFolder *folder = NULL;
206         
207         g_return_if_fail (column);
208         g_return_if_fail (tree_model);
209
210         gtk_tree_model_get (tree_model, iter,
211                             TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
212                             TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread,
213                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
214                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder,
215                             -1);
216         rendobj = G_OBJECT(renderer);
217  
218         if (!fname)
219                 return;
220         
221         if (folder && type != TNY_FOLDER_TYPE_ROOT) { /* FIXME: tnymail bug? crashes with root folders */
222                 if (modest_tny_folder_is_local_folder (folder)) {
223                         TnyFolderType type;
224                         type = modest_tny_folder_get_local_folder_type (folder);
225                         if (type != TNY_FOLDER_TYPE_UNKNOWN) {
226                                 g_free (fname);
227                                 fname = g_strdup(modest_local_folder_info_get_type_display_name (type));
228                         }
229                 }
230         } else if (folder && type == TNY_FOLDER_TYPE_ROOT) {
231                 /* FIXME: todo */
232         }
233                         
234         if (unread > 0) {
235                 gchar *folder_title = g_strdup_printf ("%s (%d)", fname, unread);
236                 g_object_set (rendobj,"text", folder_title,  "weight", 800, NULL);
237                 g_free (folder_title);
238         } else 
239                 g_object_set (rendobj,"text", fname, "weight", 400, NULL);
240                 
241         g_free (fname);
242         if (folder) g_object_unref (G_OBJECT (folder));
243 }
244
245
246 static GdkPixbuf*
247 get_cached_icon (const gchar *name)
248 {
249         GError *err = NULL;
250         gpointer pixbuf;
251         gpointer orig_key;
252         static GHashTable *icon_cache = NULL;
253         
254         g_return_val_if_fail (name, NULL);
255
256         if (G_UNLIKELY(!icon_cache))
257                 icon_cache = modest_cache_mgr_get_cache (modest_runtime_get_cache_mgr(),
258                                                          MODEST_CACHE_MGR_CACHE_TYPE_PIXBUF);
259         
260         if (!icon_cache || !g_hash_table_lookup_extended (icon_cache, name, &orig_key, &pixbuf)) {
261                 pixbuf = (gpointer)gdk_pixbuf_new_from_file (name, &err);
262                 if (!pixbuf) {
263                         g_printerr ("modest: error in icon factory while loading '%s': %s\n",
264                                     name, err->message);
265                         g_error_free (err);
266                 }
267                 /* if we cannot find it, we still insert (if we have a cache), so we get the error
268                  * only once */
269                 if (icon_cache)
270                         g_hash_table_insert (icon_cache, g_strdup(name),(gpointer)pixbuf);
271         }
272         return GDK_PIXBUF(pixbuf);
273 }
274
275
276 static void
277 icon_cell_data  (GtkTreeViewColumn *column,  GtkCellRenderer *renderer,
278                  GtkTreeModel *tree_model,  GtkTreeIter *iter, gpointer data)
279 {
280         GObject *rendobj;
281         GdkPixbuf *pixbuf;
282         TnyFolderType type;
283         gchar *fname = NULL;
284         gint unread;
285         
286         rendobj = G_OBJECT(renderer);
287         gtk_tree_model_get (tree_model, iter,
288                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
289                             TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &fname,
290                             TNY_GTK_FOLDER_STORE_TREE_MODEL_UNREAD_COLUMN, &unread, 
291                             -1);
292         rendobj = G_OBJECT(renderer);
293         
294         if (type == TNY_FOLDER_TYPE_NORMAL || type == TNY_FOLDER_TYPE_UNKNOWN) {
295                 type = modest_tny_folder_guess_folder_type_from_name (fname);
296         }
297         g_free (fname);
298
299         switch (type) {
300         case TNY_FOLDER_TYPE_ROOT:
301                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_ACCOUNT);
302                 break;
303         case TNY_FOLDER_TYPE_INBOX:
304                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_INBOX);
305                 break;
306         case TNY_FOLDER_TYPE_OUTBOX:
307                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_OUTBOX);
308                 break;
309         case TNY_FOLDER_TYPE_JUNK:
310                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_JUNK);
311                 break;
312         case TNY_FOLDER_TYPE_SENT:
313                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_SENT);
314                 break;
315         case TNY_FOLDER_TYPE_TRASH:
316                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_TRASH);
317                 break;
318         case TNY_FOLDER_TYPE_DRAFTS:
319                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_DRAFTS);
320                 break;
321         case TNY_FOLDER_TYPE_NOTES:
322                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_NOTES);
323                 break;
324         case TNY_FOLDER_TYPE_CALENDAR:
325                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_CALENDAR);
326                 break;
327         case TNY_FOLDER_TYPE_CONTACTS:
328                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_CONTACTS);
329                 break;
330         case TNY_FOLDER_TYPE_NORMAL:
331         default:
332                 pixbuf = get_cached_icon (MODEST_FOLDER_ICON_NORMAL);
333                 break;
334         }
335         g_object_set (rendobj, "pixbuf", pixbuf, NULL);
336 }
337
338 static void
339 modest_folder_view_init (ModestFolderView *obj)
340 {
341         ModestFolderViewPrivate *priv;
342         GtkTreeViewColumn *column;
343         GtkCellRenderer *renderer;
344         GtkTreeSelection *sel;
345         
346         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
347         
348         priv->timer_expander = 0;
349         priv->account_store  = NULL;
350         priv->cur_folder     = NULL;
351         priv->cur_row        = NULL;
352         priv->query          = NULL;
353
354         column = gtk_tree_view_column_new ();   
355         
356         renderer = gtk_cell_renderer_pixbuf_new();
357         gtk_tree_view_column_pack_start (column, renderer, FALSE);
358         gtk_tree_view_column_set_cell_data_func(column, renderer,
359                                                 icon_cell_data, NULL, NULL);
360         
361         renderer = gtk_cell_renderer_text_new();
362         gtk_tree_view_column_pack_start (column, renderer, FALSE);
363         gtk_tree_view_column_set_cell_data_func(column, renderer,
364                                                 text_cell_data, NULL, NULL);
365         
366         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
367         gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
368
369         gtk_tree_view_column_set_spacing (column, 2);
370         gtk_tree_view_column_set_resizable (column, TRUE);
371         gtk_tree_view_column_set_fixed_width (column, TRUE);            
372         gtk_tree_view_set_headers_clickable (GTK_TREE_VIEW(obj), FALSE);
373         gtk_tree_view_set_enable_search     (GTK_TREE_VIEW(obj), FALSE);
374
375         gtk_tree_view_append_column (GTK_TREE_VIEW(obj),column);
376
377         setup_drag_and_drop (GTK_TREE_VIEW(obj));
378 }
379
380 static void
381 tny_account_store_view_init (gpointer g, gpointer iface_data)
382 {
383         TnyAccountStoreViewIface *klass = (TnyAccountStoreViewIface *)g;
384
385         klass->set_account_store_func = modest_folder_view_set_account_store;
386
387         return;
388 }
389
390 static void
391 modest_folder_view_finalize (GObject *obj)
392 {
393         ModestFolderViewPrivate *priv;
394         GtkTreeSelection    *sel;
395         
396         g_return_if_fail (obj);
397         
398         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
399
400         if (priv->timer_expander != 0) {
401                 g_source_remove (priv->timer_expander);
402                 priv->timer_expander = 0;
403         }
404
405         if (priv->account_store) {
406                 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
407                                              priv->account_update_signal);
408                 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
409                                              priv->accounts_reloaded_signal);
410                 g_object_unref (G_OBJECT(priv->account_store));
411                 priv->account_store = NULL;
412         }
413
414         if (priv->query) {
415                 g_object_unref (G_OBJECT (priv->query));
416                 priv->query = NULL;
417         }
418
419         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
420         if (sel)
421                 g_signal_handler_disconnect (G_OBJECT(sel), priv->changed_signal);
422         
423         G_OBJECT_CLASS(parent_class)->finalize (obj);
424 }
425
426
427 static void
428 modest_folder_view_set_account_store (TnyAccountStoreView *self, TnyAccountStore *account_store)
429 {
430         ModestFolderViewPrivate *priv;
431         TnyDevice *device;
432
433         g_return_if_fail (MODEST_IS_FOLDER_VIEW (self));
434         g_return_if_fail (TNY_IS_ACCOUNT_STORE (account_store));
435
436         priv = MODEST_FOLDER_VIEW_GET_PRIVATE (self);
437         device = tny_account_store_get_device (account_store);
438
439         if (G_UNLIKELY (priv->account_store)) {
440
441                 if (g_signal_handler_is_connected (G_OBJECT (priv->account_store), 
442                                                    priv->account_update_signal))
443                         g_signal_handler_disconnect (G_OBJECT (priv->account_store), 
444                                                      priv->account_update_signal);
445                 if (g_signal_handler_is_connected (G_OBJECT (priv->account_store), 
446                                                    priv->accounts_reloaded_signal))
447                         g_signal_handler_disconnect (G_OBJECT (priv->account_store), 
448                                                      priv->accounts_reloaded_signal);
449
450                 g_object_unref (G_OBJECT (priv->account_store));
451         }
452
453         priv->account_store = g_object_ref (G_OBJECT (account_store));
454
455         priv->account_update_signal = 
456                 g_signal_connect (G_OBJECT(account_store), "account_update",
457                                   G_CALLBACK (on_account_update), self);
458
459         priv->accounts_reloaded_signal = 
460                 g_signal_connect (G_OBJECT(account_store), "accounts_reloaded",
461                                   G_CALLBACK (on_accounts_reloaded), self);
462         
463         if (!update_model (MODEST_FOLDER_VIEW (self),
464                            MODEST_TNY_ACCOUNT_STORE (priv->account_store)))
465                 g_printerr ("modest: failed to update model\n");
466
467         g_object_unref (G_OBJECT (device));
468 }
469
470 static void
471 on_account_update (TnyAccountStore *account_store, const gchar *account,
472                    gpointer user_data)
473 {
474         if (!update_model (MODEST_FOLDER_VIEW(user_data), 
475                            MODEST_TNY_ACCOUNT_STORE(account_store)))
476                 g_printerr ("modest: failed to update model for changes in '%s'",
477                             account);
478 }
479
480 static void 
481 on_accounts_reloaded   (TnyAccountStore *account_store, 
482                         gpointer user_data)
483 {
484         update_model (MODEST_FOLDER_VIEW (user_data), 
485                       MODEST_TNY_ACCOUNT_STORE(account_store));
486 }
487
488 void
489 modest_folder_view_set_title (ModestFolderView *self, const gchar *title)
490 {
491         GtkTreeViewColumn *col;
492         
493         g_return_if_fail (self);
494
495         col = gtk_tree_view_get_column (GTK_TREE_VIEW(self), 0);
496         if (!col) {
497                 g_printerr ("modest: failed get column for title\n");
498                 return;
499         }
500
501         gtk_tree_view_column_set_title (col, title);
502         gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(self),
503                                            title != NULL);
504 }
505
506 GtkWidget*
507 modest_folder_view_new (TnyFolderStoreQuery *query)
508 {
509         GObject *self;
510         ModestFolderViewPrivate *priv;
511         GtkTreeSelection *sel;
512         
513         self = G_OBJECT (g_object_new (MODEST_TYPE_FOLDER_VIEW, NULL));
514         priv = MODEST_FOLDER_VIEW_GET_PRIVATE (self);
515
516         priv->query = g_object_ref (query);
517         
518         sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(self));
519         priv->changed_signal = g_signal_connect (sel, "changed",
520                                                  G_CALLBACK (on_selection_changed), self);
521         return GTK_WIDGET(self);
522 }
523
524 /* this feels dirty; any other way to expand all the root items? */
525 static void
526 expand_root_items (ModestFolderView *self)
527 {
528         GtkTreePath *path;
529         path = gtk_tree_path_new_first ();
530
531         /* all folders should have child items, so.. */
532         while (gtk_tree_view_expand_row (GTK_TREE_VIEW(self), path, FALSE))
533                 gtk_tree_path_next (path);
534         
535         gtk_tree_path_free (path);
536 }
537
538 static gboolean
539 update_model (ModestFolderView *self, ModestTnyAccountStore *account_store)
540 {
541         ModestFolderViewPrivate *priv;
542
543         TnyList          *account_list;
544         GtkTreeModel     *model, *sortable;
545
546         g_return_val_if_fail (account_store, FALSE);
547
548         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(self);
549         
550         /* Notify that there is no folder selected*/
551         g_signal_emit (G_OBJECT(self), 
552                        signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
553                        NULL, TRUE);
554         
555         /* FIXME: the local accounts are not shown when the query
556            selects only the subscribed folders. */
557 /*      model        = tny_gtk_folder_store_tree_model_new (TRUE, priv->query); */
558         model        = tny_gtk_folder_store_tree_model_new (TRUE, NULL);
559         account_list = TNY_LIST(model);
560
561         tny_account_store_get_accounts (TNY_ACCOUNT_STORE(account_store),
562                                         account_list,
563                                         TNY_ACCOUNT_STORE_STORE_ACCOUNTS);      
564         if (account_list) {
565                 sortable = gtk_tree_model_sort_new_with_model (model);
566                 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(sortable),
567                                                       TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, 
568                                                       GTK_SORT_ASCENDING);
569                 gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (sortable),
570                                                  TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN,
571                                                  cmp_rows, NULL, NULL);
572
573                 /* Set new model */
574                 gtk_tree_view_set_model (GTK_TREE_VIEW(self), sortable);
575                 expand_root_items (self); /* expand all account folders */
576                 g_object_unref (account_list);
577         }
578         
579         return TRUE;
580 }
581
582
583 static void
584 on_selection_changed (GtkTreeSelection *sel, gpointer user_data)
585 {
586         GtkTreeModel            *model_sort, *model;
587         TnyFolder               *folder = NULL;
588         GtkTreeIter             iter, iter_sort;
589         GtkTreePath            *path;
590         ModestFolderView        *tree_view;
591         ModestFolderViewPrivate *priv;
592         gint                    type;
593
594         g_return_if_fail (sel);
595         g_return_if_fail (user_data);
596         
597         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(user_data);
598         priv->cur_selection = sel;
599         
600         /* folder was _un_selected if true */
601         if (!gtk_tree_selection_get_selected (sel, &model_sort, &iter_sort)) {
602                 if (priv->cur_folder)
603                         g_object_unref (priv->cur_folder);
604                 if (priv->cur_row)
605                         gtk_tree_row_reference_free (priv->cur_row);
606                 priv->cur_folder = NULL;
607                 priv->cur_row = NULL;
608                 return; 
609         }
610
611         model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (model_sort));
612         gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (model_sort),
613                                                         &iter,
614                                                         &iter_sort);
615
616         tree_view = MODEST_FOLDER_VIEW (user_data);
617
618         gtk_tree_model_get (model, &iter,
619                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
620                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder,
621                             -1);
622
623         /* If the folder is the same or is a root folder do not notify */
624         if ((type == TNY_FOLDER_TYPE_ROOT) || (priv->cur_folder == folder)) {
625                 g_object_unref (folder);
626                 return;
627         }
628         
629         /* Current folder was unselected */
630         if (priv->cur_folder) {
631                 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
632                                priv->cur_folder, FALSE);
633                 g_object_unref (priv->cur_folder);
634         }
635
636         if (priv->cur_row)
637                 gtk_tree_row_reference_free (priv->cur_row);
638
639         /* New current references */
640         path = gtk_tree_model_get_path (model_sort, &iter_sort);
641         priv->cur_folder = folder;
642         priv->cur_row = gtk_tree_row_reference_new (model_sort, path);
643
644         /* Frees */
645         gtk_tree_path_free (path);
646
647         /* New folder has been selected */
648         g_signal_emit (G_OBJECT(tree_view), 
649                        signals[FOLDER_SELECTION_CHANGED_SIGNAL], 
650                        0, folder, TRUE); 
651 }
652
653 TnyFolder *
654 modest_folder_view_get_selected (ModestFolderView *self)
655 {
656         ModestFolderViewPrivate *priv;
657
658         g_return_val_if_fail (self, NULL);
659         
660         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
661         if (priv->cur_folder)
662                 g_object_ref (priv->cur_folder);
663
664         return priv->cur_folder;
665 }
666
667 static gint
668 cmp_rows (GtkTreeModel *tree_model, GtkTreeIter *iter1, GtkTreeIter *iter2,
669           gpointer user_data)
670 {
671         gint cmp;
672         gchar         *name1, *name2;
673         TnyFolderType type;
674         TnyFolder     *folder1, *folder2;
675         
676         gtk_tree_model_get (tree_model, iter1,
677                             TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &name1,
678                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
679                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder1,
680                             -1);
681         gtk_tree_model_get (tree_model, iter2,
682                             TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &name2,
683                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder2,
684                             -1);
685
686         /* local_folders should be the last one */
687         if (type == TNY_FOLDER_TYPE_ROOT) {
688                 /* the account name is also the name of the root folder
689                  * in case of local folders */
690                 if (name1 && strcmp (name1, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0)
691                         cmp = +1;
692                 else if (name2 && strcmp (name2, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0)
693                         cmp = -1;
694                 else 
695                         cmp = modest_text_utils_utf8_strcmp (name1, name2, TRUE);
696         } else 
697                 cmp = modest_text_utils_utf8_strcmp (name1, name2, TRUE);
698
699         
700         if (folder1)
701                 g_object_unref(G_OBJECT(folder1));
702         if (folder2)
703                 g_object_unref(G_OBJECT(folder2));
704         
705         g_free (name1);
706         g_free (name2);
707
708         return cmp;     
709 }
710
711 /*****************************************************************************/
712 /*                        DRAG and DROP stuff                                */
713 /*****************************************************************************/
714
715 /*
716  * This function fills the #GtkSelectionData with the row and the
717  * model that has been dragged. It's called when this widget is a
718  * source for dnd after the event drop happened
719  */
720 static void
721 on_drag_data_get (GtkWidget *widget, 
722                   GdkDragContext *context, 
723                   GtkSelectionData *selection_data, 
724                   guint info, 
725                   guint time, 
726                   gpointer data)
727 {
728         GtkTreeSelection *selection;
729         GtkTreeModel *model_sort, *model;
730         GtkTreeIter iter;
731         GtkTreePath *source_row_sort;
732         GtkTreePath *source_row;
733
734         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (widget));
735         gtk_tree_selection_get_selected (selection, &model_sort, &iter);
736         source_row_sort = gtk_tree_model_get_path (model_sort, &iter);
737
738         /* Get the unsorted path and model */
739         model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (model_sort));
740         source_row = gtk_tree_model_sort_convert_path_to_child_path (GTK_TREE_MODEL_SORT (model_sort),
741                                                                      source_row_sort);
742
743         gtk_tree_set_row_drag_data (selection_data,
744                                     model,
745                                     source_row);
746
747         gtk_tree_path_free (source_row_sort);
748         gtk_tree_path_free (source_row);
749 }
750
751 typedef struct _DndHelper {
752         gboolean delete_source;
753         GtkTreePath *source_row;
754         GdkDragContext *context;
755         guint time;
756 } DndHelper;
757
758
759 /*
760  * This function is the callback of the
761  * modest_mail_operation_xfer_msg() call. We check here if the message
762  * was correctly asynchronously transfered
763  */
764 static void
765 on_progress_changed (ModestMailOperation *mail_op, gpointer user_data)
766 {
767         ModestMailOperationQueue *queue;
768         gboolean success = FALSE;
769         DndHelper *helper;
770
771         helper = (DndHelper *) user_data;
772
773         if (modest_mail_operation_get_status (mail_op) == 
774             MODEST_MAIL_OPERATION_STATUS_SUCCESS) {
775                 success = TRUE;
776         } else {
777                 const GError *error;
778                 error = modest_mail_operation_get_error (mail_op);
779                 g_warning ("Error transferring messages: %s\n", error->message);
780         }
781
782         /* Remove the mail operation */ 
783         queue = modest_runtime_get_mail_operation_queue ();
784         modest_mail_operation_queue_remove (queue, mail_op);
785         g_object_unref (G_OBJECT (mail_op));
786
787         /* Notify the drag source. Never call delete, the monitor will
788            do the job if needed */
789         gtk_drag_finish (helper->context, success, FALSE, helper->time);
790
791         /* Free the helper */
792         gtk_tree_path_free (helper->source_row);        
793         g_slice_free (DndHelper, helper);
794 }
795
796 /*
797  * This function is used by drag_data_received_cb to manage drag and
798  * drop of a header, i.e, and drag from the header view to the folder
799  * view.
800  */
801 static void
802 drag_and_drop_from_header_view (GtkTreeModel *source_model,
803                                 GtkTreeModel *dest_model,
804                                 GtkTreePath  *dest_row,
805                                 DndHelper    *helper)
806 {
807         TnyHeader *header;
808         TnyFolder *folder;
809         ModestMailOperationQueue *queue;
810         ModestMailOperation *mail_op;
811         gboolean started;
812         GtkTreeIter source_iter, dest_iter;
813
814         /* Get header */
815         gtk_tree_model_get_iter (source_model, &source_iter, helper->source_row);
816         gtk_tree_model_get (source_model, &source_iter, 
817                             TNY_GTK_HEADER_LIST_MODEL_INSTANCE_COLUMN, 
818                             &header, -1);
819
820         /* Get Folder */
821         gtk_tree_model_get_iter (dest_model, &dest_iter, dest_row);
822         gtk_tree_model_get (dest_model, &dest_iter, 
823                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, 
824                             &folder, -1);
825
826         /* Transfer message */
827         queue = modest_runtime_get_mail_operation_queue ();
828         mail_op = modest_mail_operation_new ();
829         started = modest_mail_operation_xfer_msg (mail_op, header,
830                                                   folder, helper->delete_source);
831         if (started) {
832                 g_signal_connect (G_OBJECT (mail_op), "progress_changed",
833                                   G_CALLBACK (on_progress_changed), helper);
834                 modest_mail_operation_queue_add (queue, mail_op);
835         } else {
836                 const GError *error;
837                 error = modest_mail_operation_get_error (mail_op);
838                 if (error)
839                         g_warning ("Error trying to transfer messages: %s\n",
840                                    error->message);
841
842                 g_slice_free (DndHelper, helper);
843         }
844
845         /* Frees */
846         g_object_unref (G_OBJECT (mail_op));
847         g_object_unref (G_OBJECT (header));
848         g_object_unref (G_OBJECT (folder));
849 }
850
851 /*
852  * This function is used by drag_data_received_cb to manage drag and
853  * drop of a folder, i.e, and drag from the folder view to the same
854  * folder view.
855  */
856 static void
857 drag_and_drop_from_folder_view (GtkTreeModel     *source_model,
858                                 GtkTreeModel     *dest_model,
859                                 GtkTreePath      *dest_row,
860                                 GtkSelectionData *selection_data,
861                                 DndHelper        *helper)
862 {
863         ModestMailOperation *mail_op;
864         const GError *error;
865         GtkTreeIter parent_iter, iter;
866         TnyFolder *folder;
867         TnyFolderStore *parent_folder;
868         gboolean success = FALSE;
869
870         /* Check if the drag is possible */
871         if (!gtk_tree_path_compare (helper->source_row, dest_row))
872                 goto out;
873
874         if (!gtk_tree_drag_dest_row_drop_possible (GTK_TREE_DRAG_DEST (dest_model),
875                                                    dest_row,
876                                                    selection_data))
877                 goto out;
878
879         /* Get data */
880         gtk_tree_model_get_iter (source_model, &parent_iter, dest_row);
881         gtk_tree_model_get_iter (source_model, &iter, helper->source_row);
882         gtk_tree_model_get (source_model, &parent_iter, 
883                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, 
884                             &parent_folder, -1);
885         gtk_tree_model_get (source_model, &iter,
886                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN,
887                             &folder, -1);
888
889         /* Do the mail operation */
890         mail_op = modest_mail_operation_new ();
891         modest_mail_operation_xfer_folder (mail_op, folder, parent_folder, 
892                                            helper->delete_source);
893
894         g_object_unref (G_OBJECT (parent_folder));
895         g_object_unref (G_OBJECT (folder));
896
897         error = modest_mail_operation_get_error (mail_op);
898         if (error) {
899                 g_warning ("Error transferring folder: %s\n", error->message);
900                 g_object_unref (G_OBJECT (mail_op));
901                 goto out;
902         }
903         g_object_unref (G_OBJECT (mail_op));
904         success = TRUE;
905  out:
906         gtk_drag_finish (helper->context, success, FALSE, helper->time);
907
908         /* Free the helper */
909         gtk_tree_path_free (helper->source_row);        
910         g_slice_free (DndHelper, helper);
911 }
912
913 /*
914  * This function receives the data set by the "drag-data-get" signal
915  * handler. This information comes within the #GtkSelectionData. This
916  * function will manage both the drags of folders of the treeview and
917  * drags of headers of the header view widget.
918  */
919 static void 
920 on_drag_data_received (GtkWidget *widget, 
921                        GdkDragContext *context, 
922                        gint x, 
923                        gint y, 
924                        GtkSelectionData *selection_data, 
925                        guint target_type, 
926                        guint time, 
927                        gpointer data)
928 {
929         GtkWidget *source_widget;
930         GtkTreeModel *model_sort, *dest_model, *source_model;
931         GtkTreePath *source_row, *dest_row, *child_dest_row;
932         GtkTreeViewDropPosition pos;
933         gboolean success = FALSE, delete_source = FALSE;
934         DndHelper *helper;
935
936         /* Do not allow further process */
937         g_signal_stop_emission_by_name (widget, "drag-data-received");
938
939         /* Get the action */
940         if (context->action == GDK_ACTION_MOVE)
941                 delete_source = TRUE;
942
943         /* Check if the get_data failed */
944         if (selection_data == NULL || selection_data->length < 0)
945                 gtk_drag_finish (context, success, FALSE, time);
946
947         /* Get the models */
948         source_widget = gtk_drag_get_source_widget (context);
949         gtk_tree_get_row_drag_data (selection_data,
950                                     &source_model,
951                                     &source_row);
952
953         model_sort = gtk_tree_view_get_model (GTK_TREE_VIEW (widget));
954         /* Select the destination model */
955         if (source_widget == widget) {
956                 dest_model = source_model;
957         } else {
958                 dest_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (model_sort));
959         }
960
961         /* Get the path to the destination row. Can not call
962            gtk_tree_view_get_drag_dest_row() because the source row
963            is not selected anymore */
964         gtk_tree_view_get_dest_row_at_pos (GTK_TREE_VIEW (widget), x, y,
965                                            &dest_row, &pos);
966
967         /* Only allow drops IN other rows */
968         if (!dest_row || pos == GTK_TREE_VIEW_DROP_BEFORE || pos == GTK_TREE_VIEW_DROP_AFTER)
969                 gtk_drag_finish (context, success, FALSE, time);
970
971         /* Create the helper */
972         helper = g_slice_new0 (DndHelper);
973         helper->delete_source = delete_source;
974         helper->source_row = gtk_tree_path_copy (source_row);
975         helper->context = context;
976         helper->time = time;
977
978         /* Get path from the unsorted model */
979         child_dest_row = 
980                 gtk_tree_model_sort_convert_path_to_child_path (GTK_TREE_MODEL_SORT (model_sort),
981                                                                 dest_row);
982         gtk_tree_path_free (dest_row);
983
984         /* Drags from the header view */
985         if (source_widget != widget) {
986
987                 drag_and_drop_from_header_view (source_model,
988                                                 dest_model,
989                                                 child_dest_row,
990                                                 helper);
991         } else {
992
993
994                 drag_and_drop_from_folder_view (source_model,
995                                                 dest_model,
996                                                 child_dest_row,
997                                                 selection_data, 
998                                                 helper);
999         }
1000
1001         /* Frees */
1002         gtk_tree_path_free (source_row);
1003         gtk_tree_path_free (child_dest_row);
1004 }
1005
1006 /*
1007  * We define a "drag-drop" signal handler because we do not want to
1008  * use the default one, because the default one always calls
1009  * gtk_drag_finish and we prefer to do it in the "drag-data-received"
1010  * signal handler, because there we have all the information available
1011  * to know if the dnd was a success or not.
1012  */
1013 static gboolean
1014 drag_drop_cb (GtkWidget      *widget,
1015               GdkDragContext *context,
1016               gint            x,
1017               gint            y,
1018               guint           time,
1019               gpointer        user_data) 
1020 {
1021         gpointer target;
1022
1023         if (!context->targets)
1024                 return FALSE;
1025
1026         /* Check if we're dragging a folder row */
1027         target = gtk_drag_dest_find_target (widget, context, NULL);
1028
1029         /* Request the data from the source. */
1030         gtk_drag_get_data(widget, context, target, time);
1031
1032     return TRUE;
1033 }
1034
1035 /*
1036  * This function expands a node of a tree view if it's not expanded
1037  * yet. Not sure why it needs the threads stuff, but gtk+`example code
1038  * does that, so that's why they're here.
1039  */
1040 static gint
1041 expand_row_timeout (gpointer data)
1042 {
1043         GtkTreeView *tree_view = data;
1044         GtkTreePath *dest_path = NULL;
1045         GtkTreeViewDropPosition pos;
1046         gboolean result = FALSE;
1047         
1048         GDK_THREADS_ENTER ();
1049         
1050         gtk_tree_view_get_drag_dest_row (tree_view,
1051                                          &dest_path,
1052                                          &pos);
1053         
1054         if (dest_path &&
1055             (pos == GTK_TREE_VIEW_DROP_INTO_OR_AFTER ||
1056              pos == GTK_TREE_VIEW_DROP_INTO_OR_BEFORE)) {
1057                 gtk_tree_view_expand_row (tree_view, dest_path, FALSE);
1058                 gtk_tree_path_free (dest_path);
1059         }
1060         else {
1061                 if (dest_path)
1062                         gtk_tree_path_free (dest_path);
1063                 
1064                 result = TRUE;
1065         }
1066         
1067         GDK_THREADS_LEAVE ();
1068
1069         return result;
1070 }
1071
1072 /*
1073  * This function is called whenever the pointer is moved over a widget
1074  * while dragging some data. It installs a timeout that will expand a
1075  * node of the treeview if not expanded yet. This function also calls
1076  * gdk_drag_status in order to set the suggested action that will be
1077  * used by the "drag-data-received" signal handler to know if we
1078  * should do a move or just a copy of the data.
1079  */
1080 static gboolean
1081 on_drag_motion (GtkWidget      *widget,
1082                 GdkDragContext *context,
1083                 gint            x,
1084                 gint            y,
1085                 guint           time,
1086                 gpointer        user_data)  
1087 {
1088         GtkTreeViewDropPosition pos;
1089         GtkTreePath *dest_row;
1090         ModestFolderViewPrivate *priv;
1091         GdkDragAction suggested_action;
1092         gboolean valid_location = FALSE;
1093
1094         priv = MODEST_FOLDER_VIEW_GET_PRIVATE (widget);
1095
1096         if (priv->timer_expander != 0) {
1097                 g_source_remove (priv->timer_expander);
1098                 priv->timer_expander = 0;
1099         }
1100
1101         gtk_tree_view_get_dest_row_at_pos (GTK_TREE_VIEW (widget),
1102                                            x, y,
1103                                            &dest_row,
1104                                            &pos);
1105
1106         /* Do not allow drops between folders */
1107         if (!dest_row ||
1108             pos == GTK_TREE_VIEW_DROP_BEFORE || 
1109             pos == GTK_TREE_VIEW_DROP_AFTER) {
1110                 gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW (widget), NULL, 0);
1111                 gdk_drag_status(context, 0, time);
1112                 valid_location = FALSE;
1113                 goto out;
1114         } else {
1115                 valid_location = TRUE;
1116         }
1117
1118         /* Expand the selected row after 1/2 second */
1119         if (!gtk_tree_view_row_expanded (GTK_TREE_VIEW (widget), dest_row)) {
1120                 gtk_tree_view_set_drag_dest_row (GTK_TREE_VIEW (widget), dest_row, pos);
1121                 priv->timer_expander = g_timeout_add (500, expand_row_timeout, widget);
1122         }
1123         gtk_tree_path_free (dest_row);
1124
1125         /* Select the desired action. By default we pick MOVE */
1126         suggested_action = GDK_ACTION_MOVE;
1127
1128         if (context->actions == GDK_ACTION_COPY)
1129             gdk_drag_status(context, GDK_ACTION_COPY, time);
1130         else if (context->actions == GDK_ACTION_MOVE)
1131             gdk_drag_status(context, GDK_ACTION_MOVE, time);
1132         else if (context->actions & suggested_action)
1133             gdk_drag_status(context, suggested_action, time);
1134         else
1135             gdk_drag_status(context, GDK_ACTION_DEFAULT, time);
1136
1137  out:
1138         g_signal_stop_emission_by_name (widget, "drag-motion");
1139         return valid_location;
1140 }
1141
1142
1143 /* Folder view drag types */
1144 const GtkTargetEntry folder_view_drag_types[] =
1145 {
1146         { "GTK_TREE_MODEL_ROW", GTK_TARGET_SAME_WIDGET, MODEST_FOLDER_ROW },
1147         { "GTK_TREE_MODEL_ROW", GTK_TARGET_SAME_APP,    MODEST_HEADER_ROW }
1148 };
1149
1150 /*
1151  * This function sets the treeview as a source and a target for dnd
1152  * events. It also connects all the requirede signals.
1153  */
1154 static void
1155 setup_drag_and_drop (GtkTreeView *self)
1156 {
1157         /* Set up the folder view as a dnd destination. Set only the
1158            highlight flag, otherwise gtk will have a different
1159            behaviour */
1160         gtk_drag_dest_set (GTK_WIDGET (self),
1161                            GTK_DEST_DEFAULT_HIGHLIGHT,
1162                            folder_view_drag_types,
1163                            G_N_ELEMENTS (folder_view_drag_types),
1164                            GDK_ACTION_MOVE | GDK_ACTION_COPY);
1165
1166         g_signal_connect (G_OBJECT (self),
1167                           "drag_data_received",
1168                           G_CALLBACK (on_drag_data_received),
1169                           NULL);
1170
1171
1172         /* Set up the treeview as a dnd source */
1173         gtk_drag_source_set (GTK_WIDGET (self),
1174                              GDK_BUTTON1_MASK,
1175                              folder_view_drag_types,
1176                              G_N_ELEMENTS (folder_view_drag_types),
1177                              GDK_ACTION_MOVE | GDK_ACTION_COPY);
1178
1179         g_signal_connect (G_OBJECT (self),
1180                           "drag_motion",
1181                           G_CALLBACK (on_drag_motion),
1182                           NULL);
1183         
1184         g_signal_connect (G_OBJECT (self),
1185                           "drag_data_get",
1186                           G_CALLBACK (on_drag_data_get),
1187                           NULL);
1188
1189         g_signal_connect (G_OBJECT (self),
1190                           "drag_drop",
1191                           G_CALLBACK (drag_drop_cb),
1192                           NULL);
1193 }