* Fixed some issues of the drag and drop system
[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         gtk_tree_view_append_column (GTK_TREE_VIEW(obj),column);
356         
357         renderer = gtk_cell_renderer_pixbuf_new();
358         gtk_tree_view_column_pack_start (column, renderer, FALSE);
359         gtk_tree_view_column_set_cell_data_func(column, renderer,
360                                                 icon_cell_data, NULL, NULL);
361         
362         renderer = gtk_cell_renderer_text_new();
363         gtk_tree_view_column_pack_start (column, renderer, FALSE);
364         gtk_tree_view_column_set_cell_data_func(column, renderer,
365                                                 text_cell_data, NULL, NULL);
366         
367         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
368         gtk_tree_selection_set_mode (sel, GTK_SELECTION_SINGLE);
369
370         gtk_tree_view_column_set_spacing (column, 2);
371         gtk_tree_view_column_set_resizable (column, TRUE);
372         gtk_tree_view_column_set_fixed_width (column, TRUE);            
373         gtk_tree_view_set_headers_clickable (GTK_TREE_VIEW(obj), FALSE);
374         gtk_tree_view_set_enable_search     (GTK_TREE_VIEW(obj), FALSE);
375
376         setup_drag_and_drop (GTK_TREE_VIEW(obj));
377 }
378
379 static void
380 tny_account_store_view_init (gpointer g, gpointer iface_data)
381 {
382         TnyAccountStoreViewIface *klass = (TnyAccountStoreViewIface *)g;
383
384         klass->set_account_store_func = modest_folder_view_set_account_store;
385
386         return;
387 }
388
389 static void
390 modest_folder_view_finalize (GObject *obj)
391 {
392         ModestFolderViewPrivate *priv;
393         GtkTreeSelection    *sel;
394         
395         g_return_if_fail (obj);
396         
397         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(obj);
398
399         if (priv->timer_expander != 0) {
400                 g_source_remove (priv->timer_expander);
401                 priv->timer_expander = 0;
402         }
403
404         if (priv->account_store) {
405                 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
406                                              priv->account_update_signal);
407                 g_signal_handler_disconnect (G_OBJECT(priv->account_store),
408                                              priv->accounts_reloaded_signal);
409                 g_object_unref (G_OBJECT(priv->account_store));
410                 priv->account_store = NULL;
411         }
412
413         if (priv->query) {
414                 g_object_unref (G_OBJECT (priv->query));
415                 priv->query = NULL;
416         }
417
418         sel = gtk_tree_view_get_selection (GTK_TREE_VIEW(obj));
419         if (sel)
420                 g_signal_handler_disconnect (G_OBJECT(sel), priv->changed_signal);
421         
422         G_OBJECT_CLASS(parent_class)->finalize (obj);
423 }
424
425
426 static void
427 modest_folder_view_set_account_store (TnyAccountStoreView *self, TnyAccountStore *account_store)
428 {
429         ModestFolderViewPrivate *priv;
430         TnyDevice *device;
431
432         g_return_if_fail (MODEST_IS_FOLDER_VIEW (self));
433         g_return_if_fail (TNY_IS_ACCOUNT_STORE (account_store));
434
435         priv = MODEST_FOLDER_VIEW_GET_PRIVATE (self);
436         device = tny_account_store_get_device (account_store);
437
438         if (G_UNLIKELY (priv->account_store)) {
439
440                 if (g_signal_handler_is_connected (G_OBJECT (priv->account_store), 
441                                                    priv->account_update_signal))
442                         g_signal_handler_disconnect (G_OBJECT (priv->account_store), 
443                                                      priv->account_update_signal);
444                 if (g_signal_handler_is_connected (G_OBJECT (priv->account_store), 
445                                                    priv->accounts_reloaded_signal))
446                         g_signal_handler_disconnect (G_OBJECT (priv->account_store), 
447                                                      priv->accounts_reloaded_signal);
448
449                 g_object_unref (G_OBJECT (priv->account_store));
450         }
451
452         priv->account_store = g_object_ref (G_OBJECT (account_store));
453
454         priv->account_update_signal = 
455                 g_signal_connect (G_OBJECT(account_store), "account_update",
456                                   G_CALLBACK (on_account_update), self);
457
458         priv->accounts_reloaded_signal = 
459                 g_signal_connect (G_OBJECT(account_store), "accounts_reloaded",
460                                   G_CALLBACK (on_accounts_reloaded), self);
461         
462         if (!update_model (MODEST_FOLDER_VIEW (self),
463                            MODEST_TNY_ACCOUNT_STORE (priv->account_store)))
464                 g_printerr ("modest: failed to update model\n");
465
466         g_object_unref (G_OBJECT (device));
467 }
468
469 static void
470 on_account_update (TnyAccountStore *account_store, const gchar *account,
471                    gpointer user_data)
472 {
473         if (!update_model (MODEST_FOLDER_VIEW(user_data), 
474                            MODEST_TNY_ACCOUNT_STORE(account_store)))
475                 g_printerr ("modest: failed to update model for changes in '%s'",
476                             account);
477 }
478
479 static void 
480 on_accounts_reloaded   (TnyAccountStore *account_store, 
481                         gpointer user_data)
482 {
483         update_model (MODEST_FOLDER_VIEW (user_data), 
484                       MODEST_TNY_ACCOUNT_STORE(account_store));
485 }
486
487 void
488 modest_folder_view_set_title (ModestFolderView *self, const gchar *title)
489 {
490         GtkTreeViewColumn *col;
491         
492         g_return_if_fail (self);
493
494         col = gtk_tree_view_get_column (GTK_TREE_VIEW(self), 0);
495         if (!col) {
496                 g_printerr ("modest: failed get column for title\n");
497                 return;
498         }
499
500         gtk_tree_view_column_set_title (col, title);
501         gtk_tree_view_set_headers_visible (GTK_TREE_VIEW(self),
502                                            title != NULL);
503 }
504
505 GtkWidget*
506 modest_folder_view_new (TnyFolderStoreQuery *query)
507 {
508         GObject *self;
509         ModestFolderViewPrivate *priv;
510         GtkTreeSelection *sel;
511         
512         self = G_OBJECT (g_object_new (MODEST_TYPE_FOLDER_VIEW, NULL));
513         priv = MODEST_FOLDER_VIEW_GET_PRIVATE (self);
514
515         priv->query = g_object_ref (query);
516         
517         sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(self));
518         priv->changed_signal = g_signal_connect (sel, "changed",
519                                                  G_CALLBACK (on_selection_changed), self);
520         return GTK_WIDGET(self);
521 }
522
523 /* this feels dirty; any other way to expand all the root items? */
524 static void
525 expand_root_items (ModestFolderView *self)
526 {
527         GtkTreePath *path;
528         path = gtk_tree_path_new_first ();
529
530         /* all folders should have child items, so.. */
531         while (gtk_tree_view_expand_row (GTK_TREE_VIEW(self), path, FALSE))
532                 gtk_tree_path_next (path);
533         
534         gtk_tree_path_free (path);
535 }
536
537 static gboolean
538 update_model (ModestFolderView *self, ModestTnyAccountStore *account_store)
539 {
540         ModestFolderViewPrivate *priv;
541
542         TnyList          *account_list;
543         GtkTreeModel     *model, *sortable;
544
545         g_return_val_if_fail (account_store, FALSE);
546
547         priv =  MODEST_FOLDER_VIEW_GET_PRIVATE(self);
548         
549         /* Notify that there is no folder selected*/
550         g_signal_emit (G_OBJECT(self), 
551                        signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
552                        NULL, TRUE);
553         
554         /* FIXME: the local accounts are not shown when the query
555            selects only the subscribed folders. */
556 /*      model        = tny_gtk_folder_store_tree_model_new (TRUE, priv->query); */
557         model        = tny_gtk_folder_store_tree_model_new (TRUE, NULL);
558         account_list = TNY_LIST(model);
559
560         tny_account_store_get_accounts (TNY_ACCOUNT_STORE(account_store),
561                                         account_list,
562                                         TNY_ACCOUNT_STORE_STORE_ACCOUNTS);      
563         if (account_list) {
564                 sortable = gtk_tree_model_sort_new_with_model (model);
565                 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(sortable),
566                                                       TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, 
567                                                       GTK_SORT_ASCENDING);
568                 gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (sortable),
569                                                  TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN,
570                                                  cmp_rows, NULL, NULL);
571
572                 /* Set new model */
573                 gtk_tree_view_set_model (GTK_TREE_VIEW(self), sortable);
574                 expand_root_items (self); /* expand all account folders */
575                 g_object_unref (account_list);
576         }
577         
578         return TRUE;
579 }
580
581
582 static void
583 on_selection_changed (GtkTreeSelection *sel, gpointer user_data)
584 {
585         GtkTreeModel            *model_sort, *model;
586         TnyFolder               *folder = NULL;
587         GtkTreeIter             iter, iter_sort;
588         GtkTreePath            *path;
589         ModestFolderView        *tree_view;
590         ModestFolderViewPrivate *priv;
591         gint                    type;
592
593         g_return_if_fail (sel);
594         g_return_if_fail (user_data);
595         
596         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(user_data);
597         priv->cur_selection = sel;
598         
599         /* folder was _un_selected if true */
600         if (!gtk_tree_selection_get_selected (sel, &model_sort, &iter_sort)) {
601                 if (priv->cur_folder)
602                         g_object_unref (priv->cur_folder);
603                 if (priv->cur_row)
604                         gtk_tree_row_reference_free (priv->cur_row);
605                 priv->cur_folder = NULL;
606                 priv->cur_row = NULL;
607                 return; 
608         }
609
610         model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (model_sort));
611         gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (model_sort),
612                                                         &iter,
613                                                         &iter_sort);
614
615         tree_view = MODEST_FOLDER_VIEW (user_data);
616
617         gtk_tree_model_get (model, &iter,
618                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
619                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder,
620                             -1);
621
622         /* If the folder is the same or is a root folder do not notify */
623         if ((type == TNY_FOLDER_TYPE_ROOT) || (priv->cur_folder == folder)) {
624                 g_object_unref (folder);
625                 return;
626         }
627         
628         /* Current folder was unselected */
629         if (priv->cur_folder) {
630                 g_signal_emit (G_OBJECT(tree_view), signals[FOLDER_SELECTION_CHANGED_SIGNAL], 0,
631                                priv->cur_folder, FALSE);
632                 g_object_unref (priv->cur_folder);
633         }
634
635         if (priv->cur_row)
636                 gtk_tree_row_reference_free (priv->cur_row);
637
638         /* New current references */
639         path = gtk_tree_model_get_path (model_sort, &iter_sort);
640         priv->cur_folder = folder;
641         priv->cur_row = gtk_tree_row_reference_new (model_sort, path);
642
643         /* Frees */
644         gtk_tree_path_free (path);
645
646         /* New folder has been selected */
647         g_signal_emit (G_OBJECT(tree_view), 
648                        signals[FOLDER_SELECTION_CHANGED_SIGNAL], 
649                        0, folder, TRUE); 
650 }
651
652 TnyFolder *
653 modest_folder_view_get_selected (ModestFolderView *self)
654 {
655         ModestFolderViewPrivate *priv;
656
657         g_return_val_if_fail (self, NULL);
658         
659         priv = MODEST_FOLDER_VIEW_GET_PRIVATE(self);
660         if (priv->cur_folder)
661                 g_object_ref (priv->cur_folder);
662
663         return priv->cur_folder;
664 }
665
666 static gint
667 cmp_rows (GtkTreeModel *tree_model, GtkTreeIter *iter1, GtkTreeIter *iter2,
668           gpointer user_data)
669 {
670         gint cmp;
671         gchar         *name1, *name2;
672         TnyFolderType type;
673         TnyFolder     *folder1, *folder2;
674         
675         gtk_tree_model_get (tree_model, iter1,
676                             TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &name1,
677                             TNY_GTK_FOLDER_STORE_TREE_MODEL_TYPE_COLUMN, &type,
678                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder1,
679                             -1);
680         gtk_tree_model_get (tree_model, iter2,
681                             TNY_GTK_FOLDER_STORE_TREE_MODEL_NAME_COLUMN, &name2,
682                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, &folder2,
683                             -1);
684
685         /* local_folders should be the last one */
686         if (type == TNY_FOLDER_TYPE_ROOT) {
687                 /* the account name is also the name of the root folder
688                  * in case of local folders */
689                 if (name1 && strcmp (name1, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0)
690                         cmp = +1;
691                 else if (name2 && strcmp (name2, MODEST_LOCAL_FOLDERS_ACCOUNT_NAME) == 0)
692                         cmp = -1;
693                 else 
694                         cmp = modest_text_utils_utf8_strcmp (name1, name2, TRUE);
695         } else 
696                 cmp = modest_text_utils_utf8_strcmp (name1, name2, TRUE);
697
698         
699         if (folder1)
700                 g_object_unref(G_OBJECT(folder1));
701         if (folder2)
702                 g_object_unref(G_OBJECT(folder2));
703         
704         g_free (name1);
705         g_free (name2);
706
707         return cmp;     
708 }
709
710 /*****************************************************************************/
711 /*                        DRAG and DROP stuff                                */
712 /*****************************************************************************/
713
714 /*
715  * This function fills the #GtkSelectionData with the row and the
716  * model that has been dragged. It's called when this widget is a
717  * source for dnd after the event drop happened
718  */
719 static void
720 on_drag_data_get (GtkWidget *widget, 
721                   GdkDragContext *context, 
722                   GtkSelectionData *selection_data, 
723                   guint info, 
724                   guint time, 
725                   gpointer data)
726 {
727         GtkTreeSelection *selection;
728         GtkTreeModel *model_sort, *model;
729         GtkTreeIter iter;
730         GtkTreePath *source_row_sort;
731         GtkTreePath *source_row;
732
733         selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (widget));
734         gtk_tree_selection_get_selected (selection, &model_sort, &iter);
735         source_row_sort = gtk_tree_model_get_path (model_sort, &iter);
736
737         /* Get the unsorted path and model */
738         model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (model_sort));
739         source_row = gtk_tree_model_sort_convert_path_to_child_path (GTK_TREE_MODEL_SORT (model_sort),
740                                                                      source_row_sort);
741
742         gtk_tree_set_row_drag_data (selection_data,
743                                     model,
744                                     source_row);
745
746         gtk_tree_path_free (source_row_sort);
747         gtk_tree_path_free (source_row);
748 }
749
750 typedef struct _DndHelper {
751         gboolean delete_source;
752         GtkTreePath *source_row;
753         GdkDragContext *context;
754         guint time;
755 } DndHelper;
756
757
758 /*
759  * This function is the callback of the
760  * modest_mail_operation_xfer_msg() call. We check here if the message
761  * was correctly asynchronously transfered
762  */
763 static void
764 on_progress_changed (ModestMailOperation *mail_op, gpointer user_data)
765 {
766         ModestMailOperationQueue *queue;
767         gboolean success = FALSE;
768         DndHelper *helper;
769
770         helper = (DndHelper *) user_data;
771
772         if (modest_mail_operation_get_status (mail_op) == 
773             MODEST_MAIL_OPERATION_STATUS_SUCCESS) {
774                 success = TRUE;
775         } else {
776                 const GError *error;
777                 error = modest_mail_operation_get_error (mail_op);
778                 g_warning ("Error transferring messages: %s\n", error->message);
779         }
780
781         /* Remove the mail operation */ 
782         queue = modest_runtime_get_mail_operation_queue ();
783         modest_mail_operation_queue_remove (queue, mail_op);
784         g_object_unref (G_OBJECT (mail_op));
785
786         /* Notify the drag source. Never call delete, the monitor will
787            do the job if needed */
788         gtk_drag_finish (helper->context, success, FALSE, helper->time);
789
790         /* Free the helper */
791         gtk_tree_path_free (helper->source_row);        
792         g_slice_free (DndHelper, helper);
793 }
794
795 /*
796  * This function is used by drag_data_received_cb to manage drag and
797  * drop of a header, i.e, and drag from the header view to the folder
798  * view.
799  */
800 static void
801 drag_and_drop_from_header_view (GtkTreeModel *source_model,
802                                 GtkTreeModel *dest_model,
803                                 GtkTreePath  *dest_row,
804                                 DndHelper    *helper)
805 {
806         TnyHeader *header;
807         TnyFolder *folder;
808         ModestMailOperationQueue *queue;
809         ModestMailOperation *mail_op;
810         gboolean started;
811         GtkTreeIter source_iter, dest_iter;
812
813         /* Get header */
814         gtk_tree_model_get_iter (source_model, &source_iter, helper->source_row);
815         gtk_tree_model_get (source_model, &source_iter, 
816                             TNY_GTK_HEADER_LIST_MODEL_INSTANCE_COLUMN, 
817                             &header, -1);
818
819         /* Get Folder */
820         gtk_tree_model_get_iter (dest_model, &dest_iter, dest_row);
821         gtk_tree_model_get (dest_model, &dest_iter, 
822                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, 
823                             &folder, -1);
824
825         /* Transfer message */
826         queue = modest_runtime_get_mail_operation_queue ();
827         mail_op = modest_mail_operation_new ();
828         started = modest_mail_operation_xfer_msg (mail_op, header,
829                                                   folder, helper->delete_source);
830         if (started) {
831                 g_signal_connect (G_OBJECT (mail_op), "progress_changed",
832                                   G_CALLBACK (on_progress_changed), helper);
833                 modest_mail_operation_queue_add (queue, mail_op);
834         } else {
835                 const GError *error;
836                 error = modest_mail_operation_get_error (mail_op);
837                 if (error)
838                         g_warning ("Error trying to transfer messages: %s\n",
839                                    error->message);
840
841                 g_slice_free (DndHelper, helper);
842         }
843
844         /* Frees */
845         g_object_unref (G_OBJECT (mail_op));
846         g_object_unref (G_OBJECT (header));
847         g_object_unref (G_OBJECT (folder));
848 }
849
850 /*
851  * This function is used by drag_data_received_cb to manage drag and
852  * drop of a folder, i.e, and drag from the folder view to the same
853  * folder view.
854  */
855 static void
856 drag_and_drop_from_folder_view (GtkTreeModel     *source_model,
857                                 GtkTreeModel     *dest_model,
858                                 GtkTreePath      *dest_row,
859                                 GtkSelectionData *selection_data,
860                                 DndHelper        *helper)
861 {
862         ModestMailOperation *mail_op;
863         const GError *error;
864         GtkTreeIter parent_iter, iter;
865         TnyFolder *folder;
866         TnyFolderStore *parent_folder;
867         gboolean success = FALSE;
868
869         /* Check if the drag is possible */
870         if (!gtk_tree_path_compare (helper->source_row, dest_row))
871                 goto out;
872
873         if (!gtk_tree_drag_dest_row_drop_possible (GTK_TREE_DRAG_DEST (dest_model),
874                                                    dest_row,
875                                                    selection_data))
876                 goto out;
877
878         /* Get data */
879         gtk_tree_model_get_iter (source_model, &parent_iter, dest_row);
880         gtk_tree_model_get_iter (source_model, &iter, helper->source_row);
881         gtk_tree_model_get (source_model, &parent_iter, 
882                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN, 
883                             &parent_folder, -1);
884         gtk_tree_model_get (source_model, &iter,
885                             TNY_GTK_FOLDER_STORE_TREE_MODEL_INSTANCE_COLUMN,
886                             &folder, -1);
887
888         /* Do the mail operation */
889         mail_op = modest_mail_operation_new ();
890         modest_mail_operation_xfer_folder (mail_op, folder, parent_folder, 
891                                            helper->delete_source);
892
893         g_object_unref (G_OBJECT (parent_folder));
894         g_object_unref (G_OBJECT (folder));
895
896         error = modest_mail_operation_get_error (mail_op);
897         if (error) {
898                 g_warning ("Error transferring folder: %s\n", error->message);
899                 g_object_unref (G_OBJECT (mail_op));
900                 goto out;
901         }
902         g_object_unref (G_OBJECT (mail_op));
903         success = TRUE;
904  out:
905         gtk_drag_finish (helper->context, success, FALSE, helper->time);
906
907         /* Free the helper */
908         gtk_tree_path_free (helper->source_row);        
909         g_slice_free (DndHelper, helper);
910 }
911
912 /*
913  * This function receives the data set by the "drag-data-get" signal
914  * handler. This information comes within the #GtkSelectionData. This
915  * function will manage both the drags of folders of the treeview and
916  * drags of headers of the header view widget.
917  */
918 static void 
919 on_drag_data_received (GtkWidget *widget, 
920                        GdkDragContext *context, 
921                        gint x, 
922                        gint y, 
923                        GtkSelectionData *selection_data, 
924                        guint target_type, 
925                        guint time, 
926                        gpointer data)
927 {
928         GtkWidget *source_widget;
929         GtkTreeModel *model_sort, *dest_model, *source_model;
930         GtkTreePath *source_row, *dest_row, *child_dest_row;
931         GtkTreeViewDropPosition pos;
932         gboolean success = FALSE, delete_source = FALSE;
933         DndHelper *helper;
934
935         /* Do not allow further process */
936         g_signal_stop_emission_by_name (widget, "drag-data-received");
937
938         /* Get the action */
939         if (context->action == GDK_ACTION_MOVE)
940                 delete_source = TRUE;
941
942         /* Check if the get_data failed */
943         if (selection_data == NULL || selection_data->length < 0)
944                 gtk_drag_finish (context, success, FALSE, time);
945
946         /* Get the models */
947         source_widget = gtk_drag_get_source_widget (context);
948         gtk_tree_get_row_drag_data (selection_data,
949                                     &source_model,
950                                     &source_row);
951
952         model_sort = gtk_tree_view_get_model (GTK_TREE_VIEW (widget));
953         /* Select the destination model */
954         if (source_widget == widget) {
955                 dest_model = source_model;
956         } else {
957                 dest_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (model_sort));
958         }
959
960         /* Get the path to the destination row. Can not call
961            gtk_tree_view_get_drag_dest_row() because the source row
962            is not selected anymore */
963         gtk_tree_view_get_dest_row_at_pos (GTK_TREE_VIEW (widget), x, y,
964                                            &dest_row, &pos);
965
966         /* Only allow drops IN other rows */
967         if (!dest_row || pos == GTK_TREE_VIEW_DROP_BEFORE || pos == GTK_TREE_VIEW_DROP_AFTER)
968                 gtk_drag_finish (context, success, FALSE, time);
969
970         /* Create the helper */
971         helper = g_slice_new0 (DndHelper);
972         helper->delete_source = delete_source;
973         helper->source_row = gtk_tree_path_copy (source_row);
974         helper->context = context;
975         helper->time = time;
976
977         /* Get path from the unsorted model */
978         child_dest_row = 
979                 gtk_tree_model_sort_convert_path_to_child_path (GTK_TREE_MODEL_SORT (model_sort),
980                                                                 dest_row);
981         gtk_tree_path_free (dest_row);
982
983         /* Drags from the header view */
984         if (source_widget != widget) {
985
986                 drag_and_drop_from_header_view (source_model,
987                                                 dest_model,
988                                                 child_dest_row,
989                                                 helper);
990         } else {
991
992
993                 drag_and_drop_from_folder_view (source_model,
994                                                 dest_model,
995                                                 child_dest_row,
996                                                 selection_data, 
997                                                 helper);
998         }
999
1000         /* Frees */
1001         gtk_tree_path_free (source_row);
1002         gtk_tree_path_free (child_dest_row);
1003 }
1004
1005 /*
1006  * We define a "drag-drop" signal handler because we do not want to
1007  * use the default one, because the default one always calls
1008  * gtk_drag_finish and we prefer to do it in the "drag-data-received"
1009  * signal handler, because there we have all the information available
1010  * to know if the dnd was a success or not.
1011  */
1012 static gboolean
1013 drag_drop_cb (GtkWidget      *widget,
1014               GdkDragContext *context,
1015               gint            x,
1016               gint            y,
1017               guint           time,
1018               gpointer        user_data) 
1019 {
1020         gpointer target;
1021
1022         if (!context->targets)
1023                 return FALSE;
1024
1025         /* Check if we're dragging a folder row */
1026         target = gtk_drag_dest_find_target (widget, context, NULL);
1027
1028         /* Request the data from the source. */
1029         gtk_drag_get_data(widget, context, target, time);
1030
1031     return TRUE;
1032 }
1033
1034 /*
1035  * This function expands a node of a tree view if it's not expanded
1036  * yet. Not sure why it needs the threads stuff, but gtk+`example code
1037  * does that, so that's why they're here.
1038  */
1039 static gint
1040 expand_row_timeout (gpointer data)
1041 {
1042         GtkTreeView *tree_view = data;
1043         GtkTreePath *dest_path = NULL;
1044         GtkTreeViewDropPosition pos;
1045         gboolean result = FALSE;
1046         
1047         GDK_THREADS_ENTER ();
1048         
1049         gtk_tree_view_get_drag_dest_row (tree_view,
1050                                          &dest_path,
1051                                          &pos);
1052         
1053         if (dest_path &&
1054             (pos == GTK_TREE_VIEW_DROP_INTO_OR_AFTER ||
1055              pos == GTK_TREE_VIEW_DROP_INTO_OR_BEFORE)) {
1056                 gtk_tree_view_expand_row (tree_view, dest_path, FALSE);
1057                 gtk_tree_path_free (dest_path);
1058         }
1059         else {
1060                 if (dest_path)
1061                         gtk_tree_path_free (dest_path);
1062                 
1063                 result = TRUE;
1064         }
1065         
1066         GDK_THREADS_LEAVE ();
1067
1068         return result;
1069 }
1070
1071 /*
1072  * This function is called whenever the pointer is moved over a widget
1073  * while dragging some data. It installs a timeout that will expand a
1074  * node of the treeview if not expanded yet. This function also calls
1075  * gdk_drag_status in order to set the suggested action that will be
1076  * used by the "drag-data-received" signal handler to know if we
1077  * should do a move or just a copy of the data.
1078  */
1079 static gboolean
1080 on_drag_motion (GtkWidget      *widget,
1081                 GdkDragContext *context,
1082                 gint            x,
1083                 gint            y,
1084                 guint           time,
1085                 gpointer        user_data)  
1086 {
1087         GtkTreeViewDropPosition pos;
1088         GtkTreePath *dest_row;
1089         ModestFolderViewPrivate *priv;
1090         GdkDragAction suggested_action;
1091         gboolean valid_location = FALSE;
1092
1093         priv = MODEST_FOLDER_VIEW_GET_PRIVATE (widget);
1094
1095         if (priv->timer_expander != 0) {
1096                 g_source_remove (priv->timer_expander);
1097                 priv->timer_expander = 0;
1098         }
1099
1100         gtk_tree_view_get_dest_row_at_pos (GTK_TREE_VIEW (widget),
1101                                            x, y,
1102                                            &dest_row,
1103                                            &pos);
1104
1105         /* Do not allow drops between folders */
1106         if (!dest_row ||
1107             pos == GTK_TREE_VIEW_DROP_BEFORE || 
1108             pos == GTK_TREE_VIEW_DROP_AFTER) {
1109                 gtk_tree_view_set_drag_dest_row(GTK_TREE_VIEW (widget), NULL, 0);
1110                 gdk_drag_status(context, 0, time);
1111                 valid_location = FALSE;
1112                 goto out;
1113         } else {
1114                 valid_location = TRUE;
1115         }
1116
1117         /* Expand the selected row after 1/2 second */
1118         if (!gtk_tree_view_row_expanded (GTK_TREE_VIEW (widget), dest_row)) {
1119                 gtk_tree_view_set_drag_dest_row (GTK_TREE_VIEW (widget), dest_row, pos);
1120                 priv->timer_expander = g_timeout_add (500, expand_row_timeout, widget);
1121         }
1122         gtk_tree_path_free (dest_row);
1123
1124         /* Select the desired action. By default we pick MOVE */
1125         suggested_action = GDK_ACTION_MOVE;
1126
1127         if (context->actions == GDK_ACTION_COPY)
1128             gdk_drag_status(context, GDK_ACTION_COPY, time);
1129         else if (context->actions == GDK_ACTION_MOVE)
1130             gdk_drag_status(context, GDK_ACTION_MOVE, time);
1131         else if (context->actions & suggested_action)
1132             gdk_drag_status(context, suggested_action, time);
1133         else
1134             gdk_drag_status(context, GDK_ACTION_DEFAULT, time);
1135
1136  out:
1137         g_signal_stop_emission_by_name (widget, "drag-motion");
1138         return valid_location;
1139 }
1140
1141
1142 /* Folder view drag types */
1143 const GtkTargetEntry folder_view_drag_types[] =
1144 {
1145         { "GTK_TREE_MODEL_ROW", GTK_TARGET_SAME_WIDGET, FOLDER_ROW },
1146         { "GTK_TREE_MODEL_ROW", GTK_TARGET_SAME_APP, HEADER_ROW }
1147 };
1148
1149 /*
1150  * This function sets the treeview as a source and a target for dnd
1151  * events. It also connects all the requirede signals.
1152  */
1153 static void
1154 setup_drag_and_drop (GtkTreeView *self)
1155 {
1156         /* Set up the folder view as a dnd destination. Set only the
1157            highlight flag, otherwise gtk will have a different
1158            behaviour */
1159         gtk_drag_dest_set (GTK_WIDGET (self),
1160                            GTK_DEST_DEFAULT_HIGHLIGHT,
1161                            folder_view_drag_types,
1162                            G_N_ELEMENTS (folder_view_drag_types),
1163                            GDK_ACTION_MOVE | GDK_ACTION_COPY);
1164
1165         g_signal_connect (G_OBJECT (self),
1166                           "drag_data_received",
1167                           G_CALLBACK (on_drag_data_received),
1168                           NULL);
1169
1170
1171         /* Set up the treeview as a dnd source */
1172         gtk_drag_source_set (GTK_WIDGET (self),
1173                              GDK_BUTTON1_MASK,
1174                              folder_view_drag_types,
1175                              G_N_ELEMENTS (folder_view_drag_types),
1176                              GDK_ACTION_MOVE | GDK_ACTION_COPY);
1177
1178         g_signal_connect (G_OBJECT (self),
1179                           "drag_motion",
1180                           G_CALLBACK (on_drag_motion),
1181                           NULL);
1182         
1183         g_signal_connect (G_OBJECT (self),
1184                           "drag_data_get",
1185                           G_CALLBACK (on_drag_data_get),
1186                           NULL);
1187
1188         g_signal_connect (G_OBJECT (self),
1189                           "drag_drop",
1190                           G_CALLBACK (drag_drop_cb),
1191                           NULL);
1192 }