* Fixes a crash when removing accounts. Added by a code I commited today
[modest] / src / modest-widget-memory.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 <modest-widget-memory.h>
31 #include <modest-widget-memory-priv.h>
32 #include <modest-runtime.h>
33 #include <modest-account-mgr-helpers.h>
34 #include <modest-tny-platform-factory.h>
35 #include <modest-tny-folder.h>
36 #include <modest-init.h>
37 #include <widgets/modest-header-view.h>
38 #include <widgets/modest-msg-view.h>
39 #include <widgets/modest-folder-view.h>
40 #include "widgets/modest-main-window.h"
41 #include <string.h>
42
43 gchar*
44 _modest_widget_memory_get_keyname (const gchar *name, const gchar *param)
45 {
46         gchar *esc_name, *keyname;
47
48         g_return_val_if_fail (name, NULL);
49         g_return_val_if_fail (param, NULL);
50         
51         esc_name = modest_conf_key_escape (name);
52
53         keyname = g_strdup_printf ("%s/%s/%s",
54                                    MODEST_CONF_WIDGET_NAMESPACE, 
55                                    esc_name, param);
56         g_free (esc_name);
57         return keyname;
58 }
59
60
61 gchar*
62 _modest_widget_memory_get_keyname_with_type (const gchar *name, guint type,
63                                              const gchar *param)
64 {
65         gchar *esc_name, *keyname;
66         
67         g_return_val_if_fail (name, NULL);
68         g_return_val_if_fail (param, NULL);
69
70         esc_name = modest_conf_key_escape (name);
71
72         keyname = g_strdup_printf ("%s/%s/%s_%d",
73                                    MODEST_CONF_WIDGET_NAMESPACE, 
74                                    esc_name, param, type);
75         g_free (esc_name);
76         return keyname;
77 }
78
79
80 gchar*
81 _modest_widget_memory_get_keyname_with_double_type (const gchar *name,
82                                                     guint type1, guint type2,
83                                                     const gchar *param)
84 {
85         gchar *esc_name, *keyname;
86         
87         g_return_val_if_fail (name, NULL);
88         g_return_val_if_fail (param, NULL);
89
90         esc_name = modest_conf_key_escape (name);
91
92         keyname = g_strdup_printf ("%s/%s/%s_%d_%d",
93                                    MODEST_CONF_WIDGET_NAMESPACE, 
94                                    esc_name, param, type1, type2);
95         g_free (esc_name);
96         return keyname;
97 }
98
99
100
101 static gboolean
102 save_settings_widget (ModestConf *conf, GtkWidget *widget, const gchar *name)
103 {
104         gchar *key;
105
106         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_HEIGHT);
107         modest_conf_set_int (conf, key, GTK_WIDGET(widget)->allocation.height, NULL);
108         g_free (key);
109         
110         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_WIDTH);
111         modest_conf_set_int (conf, key, GTK_WIDGET(widget)->allocation.width, NULL);
112         g_free (key);
113
114         return TRUE;
115 }
116
117
118 static gboolean
119 restore_settings_widget (ModestConf *conf, GtkWidget *widget, const gchar *name)
120 {
121         GtkRequisition req;
122         gchar *key;
123
124         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_HEIGHT);
125         
126         if (modest_conf_key_exists (conf, key, NULL))
127                 req.height = modest_conf_get_int (conf, key, NULL);
128
129         g_free (key);
130         
131         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_WIDTH);
132         if (modest_conf_key_exists (conf, key, NULL))
133                 req.width = modest_conf_get_int (conf, key, NULL);
134         g_free (key);
135
136         if (req.height && req.width) 
137                 gtk_widget_size_request (widget, &req);
138
139         return TRUE;
140
141 }
142
143
144
145 static gboolean
146 save_settings_window (ModestConf *conf, GtkWindow *win, const gchar *name)
147 {
148         gchar *key;
149         int height, width;
150         
151         gtk_window_get_size (win, &width, &height);
152         
153         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_HEIGHT);
154         modest_conf_set_int (conf, key, height, NULL);
155         g_free (key);
156         
157         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_WIDTH);
158         modest_conf_set_int (conf, key, width, NULL);
159         g_free (key);
160
161         /* Save also the main window style */
162         if (MODEST_IS_MAIN_WINDOW (win)) {
163                 ModestMainWindowStyle style = modest_main_window_get_style (MODEST_MAIN_WINDOW (win));
164
165                 key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_WINDOW_STYLE);
166                 modest_conf_set_int (conf, key, style, NULL);
167                 g_free (key);
168         }
169         
170         return TRUE;
171 }
172
173
174 static gboolean
175 restore_settings_window (ModestConf *conf, GtkWindow *win, const gchar *name)
176 {
177         gchar *key;
178         int height = 0, width = 0;
179
180         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_HEIGHT);
181         
182         if (modest_conf_key_exists (conf, key, NULL))
183                 height = modest_conf_get_int (conf, key, NULL);
184
185         g_free (key);
186
187         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_WIDTH);
188         if (modest_conf_key_exists (conf, key, NULL))
189                 width = modest_conf_get_int (conf, key, NULL);
190
191         g_free (key);
192
193         /* Added this ugly ifdef, because in Maemo the
194            gtk_window_set_default_size() makes "drag-motion" signal
195            report bad coordinates, so drag-and-drop do not work
196            properly */
197 #ifdef MODEST_PLATFORM_GNOME
198         if (height && width)
199                 gtk_window_set_default_size (win, width, height);
200 #endif
201
202         /* Restore also the main window style */
203         if (MODEST_IS_MAIN_WINDOW (win)) {
204                 ModestMainWindowStyle style;
205
206                 key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_WINDOW_STYLE);
207                 if (modest_conf_key_exists (conf, key, NULL)) {
208                         style = (ModestMainWindowStyle) modest_conf_get_int (conf, key, NULL);          
209                         modest_main_window_set_style (MODEST_MAIN_WINDOW (win), style);
210                         g_free (key);
211                 }
212         }
213
214         return TRUE;
215 }
216
217
218 static gboolean
219 save_settings_paned (ModestConf *conf, GtkPaned *paned, const gchar *name)
220 {
221         gchar *key;
222         int pos, percent;
223
224         /* Don't save the paned position if it's not visible, 
225          * because it could not be correct: */
226         if (GTK_WIDGET_REALIZED (GTK_WIDGET (paned))) {
227                 pos = gtk_paned_get_position (paned);
228                 percent = pos * 100 / GTK_WIDGET (paned)->allocation.width;
229
230                 key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_POS);
231                 modest_conf_set_int (conf, key, percent, NULL);
232                 g_free (key);
233         }
234         
235         return TRUE;
236 }
237
238
239 static gboolean
240 restore_settings_paned (ModestConf *conf, GtkPaned *paned, const gchar *name)
241 {
242         gchar *key;
243         int percent, pos;
244         
245         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_POS); 
246         percent = modest_conf_get_int (conf, key, NULL);
247         
248         if (GTK_WIDGET_VISIBLE (GTK_WIDGET (paned)) && GTK_WIDGET_REALIZED (GTK_WIDGET (paned))) {
249                 pos = GTK_WIDGET (paned)->allocation.width * percent /100;
250                 gtk_paned_set_position (paned, pos);
251         }
252
253         g_free (key);
254         return TRUE;
255 }
256
257
258 static gboolean
259 save_settings_header_view (ModestConf *conf, ModestHeaderView *header_view,
260                            const gchar *name)
261 {
262         gchar *key;
263         gchar *sort_key;
264         gchar *sort_value;
265         GString *str;
266         GList *cols, *cursor;
267         TnyFolder *folder;
268         TnyFolderType type;
269         ModestHeaderViewStyle style;
270         gint sort_colid;
271         GtkSortType sort_type;
272         gint sort_flag_id = 0;
273         
274         folder = modest_header_view_get_folder (header_view);
275         if (!folder || modest_header_view_is_empty (header_view)) {
276                 if (folder)
277                         g_object_unref (folder);
278                 return TRUE; /* no non-empty folder: no settings */
279         }
280         
281         type  = modest_tny_folder_guess_folder_type (folder);
282         if (type == TNY_FOLDER_TYPE_INVALID)
283                 g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);
284         
285         style = modest_header_view_get_style   (header_view);
286         
287         key = _modest_widget_memory_get_keyname_with_double_type (name, type, style,
288                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_WIDTH);
289         sort_key = _modest_widget_memory_get_keyname_with_double_type (name, type, style,
290                                                                        MODEST_WIDGET_MEMORY_PARAM_COLUMN_SORT);
291
292         cursor = cols = modest_header_view_get_columns (header_view);
293         if (!cols) {
294                 g_warning ("DEBUG: %s: modest_header_view_get_columns() returned NULL.",
295                          __FUNCTION__);
296         }
297         
298         str = g_string_new (NULL);
299
300         /* NOTE: the exact details of this format are important, as they
301          * are also used in modest-init.
302          */
303         sort_colid = modest_header_view_get_sort_column_id (header_view, type); 
304         sort_type = modest_header_view_get_sort_type (header_view, type); 
305
306         while (cursor) {
307
308                 int col_id, width, sort;
309                 GtkTreeViewColumn *col;
310                 int column_sort_flag;
311                 
312                 col    = GTK_TREE_VIEW_COLUMN (cursor->data);
313                 col_id = GPOINTER_TO_INT(g_object_get_data (G_OBJECT(col),
314                                                             MODEST_HEADER_VIEW_COLUMN));
315                 width = gtk_tree_view_column_get_width (col);
316                 sort = 0;
317                 if (sort_colid == col_id)
318                         sort = (sort_type == GTK_SORT_ASCENDING) ? 1:0;
319                 column_sort_flag = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (col), MODEST_HEADER_VIEW_FLAG_SORT));
320                 if (column_sort_flag != 0)
321                         sort_flag_id = column_sort_flag;
322                 
323                 g_string_append_printf (str, "%d:%d:%d ", col_id, width, sort);
324                 cursor = g_list_next (cursor);
325         }
326
327         if ((str->str == NULL) || (strlen(str->str) == 0)) {
328                 /* TODO: Find out why this happens sometimes. */
329                 g_warning ("DEBUG: %s: Attempting to write an empty value to "
330                         "gconf key %s. Preventing.", __FUNCTION__, key);
331         }
332         else
333                 modest_conf_set_string (conf, key, str->str, NULL);
334
335         /* store current sort column for compact view */
336         if (sort_colid >= 0) {
337                 sort_value = g_strdup_printf("%d:%d:%d", sort_colid, sort_type, sort_flag_id);
338                 modest_conf_set_string (conf, sort_key, sort_value, NULL);
339                 g_free (sort_value);
340         }
341
342
343
344         g_free (key);
345         g_free (sort_key);      
346         g_string_free (str, TRUE);
347         g_list_free (cols);
348         g_object_unref (G_OBJECT (folder));
349         
350         return TRUE;
351 }
352
353
354 static gboolean
355 restore_settings_header_view (ModestConf *conf, ModestHeaderView *header_view,
356                               const gchar *name)
357 {
358         guint col, width;
359         gint sort;
360         gchar *key;
361         gchar *sort_key;
362         TnyFolder *folder;
363         TnyFolderType type;
364         ModestHeaderViewStyle style;
365         gint sort_flag_id = 0;
366         gint sort_colid = -1, sort_type = GTK_SORT_DESCENDING;
367         
368         folder = modest_header_view_get_folder (header_view);
369         if (!folder)
370                 return TRUE; /* no folder: no settings */
371         
372         type = modest_tny_folder_guess_folder_type (folder);    
373         if (type == TNY_FOLDER_TYPE_INVALID)
374                 g_warning ("%s: BUG: TNY_FOLDER_TYPE_INVALID", __FUNCTION__);
375
376         style = modest_header_view_get_style (header_view);
377
378         key = _modest_widget_memory_get_keyname_with_double_type (name, type, style,
379                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_WIDTH);
380         sort_key = _modest_widget_memory_get_keyname_with_double_type (name, type, style,
381                                                                        MODEST_WIDGET_MEMORY_PARAM_COLUMN_SORT);
382
383         if (modest_conf_key_exists (conf, sort_key, NULL)) {
384                 gchar *value = modest_conf_get_string (conf, sort_key, NULL);
385                 sscanf (value, "%d:%d:%d", &sort_colid, &sort_type, &sort_flag_id);
386                 g_free (value);
387         }
388
389         if (modest_conf_key_exists (conf, key, NULL)) {
390                 
391                 gchar *data, *cursor;
392                 GList *cols = NULL;
393                 GList *colwidths = NULL;
394                 GList *colsortables = NULL;
395                 GtkTreeModel *sortable;
396
397                 cursor = data = modest_conf_get_string (conf, key, NULL);
398                 while (cursor && sscanf (cursor, "%d:%d:%d ", &col, &width, &sort) == 3) {
399
400                         cols      = g_list_append (cols, GINT_TO_POINTER(col));
401                         colwidths = g_list_append (colwidths, GINT_TO_POINTER(width));
402                         colsortables = g_list_append (colsortables, GINT_TO_POINTER(sort));
403                         cursor = strchr (cursor + 1, ' ');
404                 }
405                 g_free (data);  
406                 
407                 /* Use defaults if gconf has no, or empty information: */
408                 /* We don't know why the value is empty sometimes. */
409                 if (g_list_length(cols) == 0) {
410                         g_warning("%s: gconf key %s was empty. Using default column IDs.\n", 
411                                 __FUNCTION__, key);
412                         g_list_free (cols);
413                         cols = NULL;
414                 }
415                 
416                 if (!cols)
417                         cols = modest_init_get_default_header_view_column_ids (type, style);
418                 
419                 if (cols) {
420                         GList *viewcolumns, *colcursor, *widthcursor;
421                         modest_header_view_set_columns (header_view, cols, type);
422                         sortable = gtk_tree_view_get_model (GTK_TREE_VIEW (header_view));
423
424                         widthcursor = colwidths;
425                         colcursor = viewcolumns = gtk_tree_view_get_columns (GTK_TREE_VIEW(header_view));
426                         while (colcursor && widthcursor) {
427                                 int width = GPOINTER_TO_INT(widthcursor->data);
428                                 int view_column_id = GPOINTER_TO_INT (g_object_get_data (
429                                                                               G_OBJECT (colcursor->data), 
430                                                                               MODEST_HEADER_VIEW_COLUMN));
431                                 if (width > 0)
432                                         gtk_tree_view_column_set_max_width(GTK_TREE_VIEW_COLUMN(colcursor->data),
433                                                                            width);
434                                 if (((view_column_id == MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN) ||
435                                      (view_column_id == MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT)) &&
436                                     (sort_flag_id != 0))
437                                         g_object_set_data (G_OBJECT (colcursor->data), 
438                                                            MODEST_HEADER_VIEW_FLAG_SORT, GINT_TO_POINTER (sort_flag_id));
439                                 colcursor = g_list_next (colcursor);
440                                 widthcursor = g_list_next (widthcursor);
441                         }
442
443                         g_list_free (cols);
444                         g_list_free (colwidths);
445                         g_list_free (colsortables);
446                         g_list_free (viewcolumns);
447                 }
448         }
449
450         if (sort_colid >= 0) {
451           GtkTreeModel *sortable = 
452                   gtk_tree_model_filter_get_model (
453                           GTK_TREE_MODEL_FILTER (gtk_tree_view_get_model (GTK_TREE_VIEW (header_view))));
454                 if (sort_colid == TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN)
455                         modest_header_view_sort_by_column_id (header_view, 0, sort_type);
456                 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(sortable),
457                                                       sort_colid,
458                                                       sort_type);
459                 modest_header_view_sort_by_column_id (header_view, sort_colid, sort_type);
460                 gtk_tree_sortable_sort_column_changed (GTK_TREE_SORTABLE(sortable));
461         }
462
463         g_free (key);
464         g_free (sort_key);
465         
466         g_object_unref (G_OBJECT (folder));
467
468         return TRUE;
469 }
470
471
472
473 static gboolean
474 save_settings_folder_view (ModestConf *conf, ModestFolderView *folder_view,
475                            const gchar *name)
476 {
477         return TRUE;
478 }
479
480 static gboolean
481 restore_settings_folder_view (ModestConf *conf, 
482                               ModestFolderView *folder_view,
483                               const gchar *name)
484 {
485         ModestAccountMgr *mgr;
486         gchar *default_acc;
487
488         /* Always show the default account as visible server account */
489         mgr = modest_runtime_get_account_mgr ();
490         default_acc = modest_account_mgr_get_default_account (mgr);
491         if (default_acc) {
492                 ModestAccountSettings *settings;
493                 ModestServerAccountSettings *store_settings;
494                 const gchar *server_acc_id;
495
496                 settings = modest_account_mgr_load_account_settings (mgr, (const gchar*) default_acc);
497                 store_settings = modest_account_settings_get_store_settings (settings);
498                 server_acc_id = modest_server_account_settings_get_account_name (store_settings);
499
500                 modest_folder_view_set_account_id_of_visible_server_account (folder_view, server_acc_id);
501                 g_object_unref (store_settings);
502                 g_object_unref (settings);
503                 g_free (default_acc);
504         }
505         return TRUE;
506 }
507
508
509 static gboolean
510 save_settings_msg_view (ModestConf *conf, 
511                         ModestMsgView *msg_view,
512                         const gchar *name)
513 {
514         return TRUE; /* FIXME: implement this */
515 }
516
517 static gboolean
518 restore_settings_msg_view (ModestConf *conf, ModestMsgView *msg_view,
519                               const gchar *name)
520 {
521         return TRUE; /* FIXME: implement this */
522 }
523
524
525
526 gboolean
527 modest_widget_memory_save (ModestConf *conf, GObject *widget, const gchar *name)
528 {
529         g_return_val_if_fail (conf, FALSE);
530         g_return_val_if_fail (widget, FALSE);
531         g_return_val_if_fail (name, FALSE);
532
533         if (GTK_IS_WINDOW(widget))
534                 return save_settings_window (conf, GTK_WINDOW(widget), name);
535         else if (GTK_IS_PANED(widget))
536                 return save_settings_paned (conf, GTK_PANED(widget), name);
537         else if (MODEST_IS_HEADER_VIEW(widget))
538                 return save_settings_header_view (conf, MODEST_HEADER_VIEW(widget), name);
539         else if (MODEST_IS_FOLDER_VIEW(widget))
540                 return save_settings_folder_view (conf, MODEST_FOLDER_VIEW(widget), name);
541         else if (MODEST_IS_MSG_VIEW(widget))
542                 return save_settings_msg_view (conf, MODEST_MSG_VIEW(widget), name);
543         else if (GTK_IS_WIDGET(widget))
544                 return save_settings_widget (conf, GTK_WIDGET(widget), name);
545         
546         g_printerr ("modest: %p (%s) is not a known widget\n", widget, name);   
547         return FALSE;
548 }
549
550
551
552 gboolean
553 modest_widget_memory_restore (ModestConf *conf, GObject *widget, const gchar *name)
554 {
555         g_return_val_if_fail (conf, FALSE);
556         g_return_val_if_fail (widget, FALSE);
557         g_return_val_if_fail (name, FALSE);
558
559         if (GTK_IS_WINDOW(widget))
560                 return restore_settings_window (conf, GTK_WINDOW(widget), name);
561         else if (GTK_IS_PANED(widget))
562                 return restore_settings_paned (conf, GTK_PANED(widget), name);
563         else if (MODEST_IS_HEADER_VIEW(widget))
564                 return restore_settings_header_view (conf, MODEST_HEADER_VIEW(widget), name);
565         else if (MODEST_IS_FOLDER_VIEW(widget))
566                 return restore_settings_folder_view (conf, MODEST_FOLDER_VIEW(widget), name);
567         else if (MODEST_IS_MSG_VIEW(widget))
568                 return restore_settings_msg_view (conf, MODEST_MSG_VIEW(widget), name);
569         else if (GTK_IS_WIDGET(widget))
570                 return restore_settings_widget (conf, GTK_WIDGET(widget), name);
571         
572         g_printerr ("modest: %p (%s) is not a known widget\n", widget, name);
573         return FALSE;
574 }