22c8da2abd850978def931638c03da38d6e42606
[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;
223
224         pos = gtk_paned_get_position (paned);
225         
226         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_POS);
227         modest_conf_set_int (conf, key, pos, NULL);
228         g_free (key);
229         
230         return TRUE;
231 }
232
233
234 static gboolean
235 restore_settings_paned (ModestConf *conf, GtkPaned *paned, const gchar *name)
236 {
237         gchar *key;
238         int pos;
239         
240         key = _modest_widget_memory_get_keyname (name, MODEST_WIDGET_MEMORY_PARAM_POS);
241         
242         if (modest_conf_key_exists (conf, key, NULL)) {
243                 pos = modest_conf_get_int (conf, key, NULL);
244                 gtk_paned_set_position (paned, pos);
245         } else {
246                 /* The initial position must follow the 30/70 rule */
247                 gtk_paned_set_position (paned, GTK_WIDGET(paned)->requisition.width/3);
248         }
249
250         g_free (key);
251         return TRUE;
252 }
253
254
255 static gboolean
256 save_settings_header_view (ModestConf *conf, ModestHeaderView *header_view,
257                            const gchar *name)
258 {
259         gchar *key;
260         gchar *sort_key;
261         gchar *sort_value;
262         GString *str;
263         GList *cols, *cursor;
264         TnyFolder *folder;
265         TnyFolderType type;
266         ModestHeaderViewStyle style;
267         gint sort_colid;
268         GtkSortType sort_type;
269         gint sort_flag_id = 0;
270         
271         folder = modest_header_view_get_folder (header_view);
272         if (!folder || modest_header_view_is_empty (header_view))
273                 return TRUE; /* no non-empty folder: no settings */
274         
275         type  = modest_tny_folder_guess_folder_type (folder);
276         style = modest_header_view_get_style   (header_view);
277         
278         key = _modest_widget_memory_get_keyname_with_double_type (name, type, style,
279                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_WIDTH);
280         sort_key = _modest_widget_memory_get_keyname_with_double_type (name, type, style,
281                                                                        MODEST_WIDGET_MEMORY_PARAM_COLUMN_SORT);
282
283         cursor = cols = modest_header_view_get_columns (header_view);
284         if (!cols) {
285                 g_warning ("DEBUG: %s: modest_header_view_get_columns() returned NULL.",
286                          __FUNCTION__);
287         }
288         
289         str = g_string_new (NULL);
290
291         /* NOTE: the exact details of this format are important, as they
292          * are also used in modest-init.
293          */
294         sort_colid = modest_header_view_get_sort_column_id (header_view, type); 
295         sort_type = modest_header_view_get_sort_type (header_view, type); 
296
297         while (cursor) {
298
299                 int col_id, width, sort;
300                 GtkTreeViewColumn *col;
301                 int column_sort_flag;
302                 
303                 col    = GTK_TREE_VIEW_COLUMN (cursor->data);
304                 col_id = GPOINTER_TO_INT(g_object_get_data (G_OBJECT(col),
305                                                             MODEST_HEADER_VIEW_COLUMN));
306                 width = gtk_tree_view_column_get_width (col);
307                 sort = 0;
308                 if (sort_colid == col_id)
309                         sort = (sort_type == GTK_SORT_ASCENDING) ? 1:0;
310                 column_sort_flag = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (col), MODEST_HEADER_VIEW_FLAG_SORT));
311                 if (column_sort_flag != 0)
312                         sort_flag_id = column_sort_flag;
313                 
314                 g_string_append_printf (str, "%d:%d:%d ", col_id, width, sort);
315                 cursor = g_list_next (cursor);
316         }
317
318         if ((str->str == NULL) || (strlen(str->str) == 0)) {
319                 /* TODO: Find out why this happens sometimes. */
320                 g_warning ("DEBUG: %s: Attempting to write an empty value to "
321                         "gconf key %s. Preventing.", __FUNCTION__, key);
322         }
323         else
324                 modest_conf_set_string (conf, key, str->str, NULL);
325
326         /* store current sort column for compact view */
327         if (sort_colid >= 0) {
328                 sort_value = g_strdup_printf("%d:%d:%d", sort_colid, sort_type, sort_flag_id);
329                 modest_conf_set_string (conf, sort_key, sort_value, NULL);
330                 g_free (sort_value);
331         }
332
333
334
335         g_free (key);   
336         g_string_free (str, TRUE);
337         g_list_free (cols);
338         g_object_unref (G_OBJECT (folder));
339         
340         return TRUE;
341 }
342
343
344 static gboolean
345 restore_settings_header_view (ModestConf *conf, ModestHeaderView *header_view,
346                               const gchar *name)
347 {
348         guint col, width;
349         gint sort;
350         gchar *key;
351         gchar *sort_key;
352         TnyFolder *folder;
353         TnyFolderType type;
354         ModestHeaderViewStyle style;
355         gint sort_flag_id = 0;
356         gint sort_colid = -1, sort_type;
357         
358         folder = modest_header_view_get_folder (header_view);
359         if (!folder || modest_header_view_is_empty (header_view))
360                 return TRUE; /* no non-empty folder: no settings */
361         
362         type = modest_tny_folder_guess_folder_type (folder);    style = modest_header_view_get_style   (header_view);
363
364         key = _modest_widget_memory_get_keyname_with_double_type (name, type, style,
365                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_WIDTH);
366         sort_key = _modest_widget_memory_get_keyname_with_double_type (name, type, style,
367                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_SORT);
368
369         if (modest_conf_key_exists (conf, sort_key, NULL)) {
370                 gchar *value = modest_conf_get_string (conf, sort_key, NULL);
371                 sscanf (value, "%d:%d:%d", &sort_colid, &sort_type, &sort_flag_id);
372         }
373
374         if (modest_conf_key_exists (conf, key, NULL)) {
375                 
376                 gchar *data, *cursor;
377                 GList *cols = NULL;
378                 GList *colwidths = NULL;
379                 GList *colsortables = NULL;
380                 GtkTreeModel *sortable;
381
382                 cursor = data = modest_conf_get_string (conf, key, NULL);
383                 while (cursor && sscanf (cursor, "%d:%d:%d ", &col, &width, &sort) == 3) {
384
385                         cols      = g_list_append (cols, GINT_TO_POINTER(col));
386                         colwidths = g_list_append (colwidths, GINT_TO_POINTER(width));
387                         colsortables = g_list_append (colsortables, GINT_TO_POINTER(sort));
388                         cursor = strchr (cursor + 1, ' ');
389                 }
390                 g_free (data);  
391                 
392                 /* Use defaults if gconf has no, or empty information: */
393                 /* We don't know why the value is empty sometimes. */
394                 if (g_list_length(cols) == 0) {
395                         g_warning("%s: gconf key %s was empty. Using default column IDs.\n", 
396                                 __FUNCTION__, key);
397                         g_list_free (cols);
398                         cols = NULL;
399                 }
400                 
401                 if (!cols)
402                         cols = modest_init_get_default_header_view_column_ids (type, style);
403                 
404                 if (cols) {
405                         GList *viewcolumns, *colcursor, *widthcursor;
406                         modest_header_view_set_columns (header_view, cols, type);
407                         sortable = gtk_tree_view_get_model (GTK_TREE_VIEW (header_view));
408
409                         widthcursor = colwidths;
410                         colcursor = viewcolumns = gtk_tree_view_get_columns (GTK_TREE_VIEW(header_view));
411                         while (colcursor && widthcursor) {
412                                 int width = GPOINTER_TO_INT(widthcursor->data);
413                                 int view_column_id = GPOINTER_TO_INT (g_object_get_data (
414                                                                               G_OBJECT (colcursor->data), 
415                                                                               MODEST_HEADER_VIEW_COLUMN));
416                                 if (width > 0)
417                                         gtk_tree_view_column_set_max_width(GTK_TREE_VIEW_COLUMN(colcursor->data),
418                                                                            width);
419                                 if (((view_column_id == MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN) ||
420                                      (view_column_id == MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT)) &&
421                                     (sort_flag_id != 0))
422                                         g_object_set_data (G_OBJECT (colcursor->data), 
423                                                            MODEST_HEADER_VIEW_FLAG_SORT, GINT_TO_POINTER (sort_flag_id));
424                                 colcursor = g_list_next (colcursor);
425                                 widthcursor = g_list_next (widthcursor);
426                         }
427
428                         g_list_free (cols);
429                         g_list_free (colwidths);
430                         g_list_free (colsortables);
431                         g_list_free (viewcolumns);
432                 }
433         }
434
435         if (sort_colid >= 0) {
436                 GtkTreeModel *sortable = gtk_tree_view_get_model (GTK_TREE_VIEW (header_view));
437                 if (sort_colid == TNY_GTK_HEADER_LIST_MODEL_FLAGS_COLUMN)
438                         modest_header_view_sort_by_column_id (header_view, 0, sort_type);
439                 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE(sortable),
440                                                       sort_colid,
441                                                       sort_type);
442                 modest_header_view_sort_by_column_id (header_view, sort_colid, sort_type);
443                 gtk_tree_sortable_sort_column_changed (GTK_TREE_SORTABLE(sortable));
444         }
445
446         g_free (key);
447         g_object_unref (G_OBJECT (folder));
448
449         return TRUE;
450 }
451
452
453
454 static gboolean
455 save_settings_folder_view (ModestConf *conf, ModestFolderView *folder_view,
456                            const gchar *name)
457 {
458         gchar *key;
459         const gchar* account_id;
460
461         /* Save the visible account */
462         key = _modest_widget_memory_get_keyname (name, "visible_server_account_id");
463
464         account_id = modest_folder_view_get_account_id_of_visible_server_account (folder_view);
465         if (account_id)
466                 modest_conf_set_string (conf, key, account_id, NULL);
467         else
468                 modest_conf_remove_key (conf, key, NULL);
469         g_free (key);
470
471         return TRUE;
472 }
473
474 static gboolean
475 restore_settings_folder_view (ModestConf *conf, 
476                               ModestFolderView *folder_view,
477                               const gchar *name)
478 {
479         gchar *key, *account_id;
480
481         /* Restore the visible account */
482         key = _modest_widget_memory_get_keyname (name, "visible_server_account_id");
483
484         if (modest_conf_key_exists (conf, key, NULL)) {
485                 account_id = modest_conf_get_string (conf, key, NULL);
486                 modest_folder_view_set_account_id_of_visible_server_account (folder_view, 
487                                                                              (const gchar *) account_id);
488                 g_free (account_id);
489         } else {
490                 ModestAccountMgr *mgr;
491                 gchar *default_acc;
492
493                 /* If there is no visible account id in the
494                    configuration then pick the default account as
495                    visible account */
496                 mgr = modest_runtime_get_account_mgr ();
497                 default_acc = modest_account_mgr_get_default_account (mgr);
498                 if (default_acc) {
499                         ModestAccountData *acc_data;
500                         const gchar *server_acc_id;
501
502                         acc_data = modest_account_mgr_get_account_data (mgr, (const gchar*) default_acc);
503                         server_acc_id = (const gchar *) acc_data->store_account->account_name;
504
505                         modest_conf_set_string (conf, key, server_acc_id, NULL);
506                         modest_folder_view_set_account_id_of_visible_server_account (folder_view, server_acc_id);
507
508                         g_free (default_acc);
509                 }
510         }
511
512         g_free (key);
513
514         return TRUE;
515 }
516
517
518 static gboolean
519 save_settings_msg_view (ModestConf *conf, 
520                         ModestMsgView *msg_view,
521                         const gchar *name)
522 {
523         return TRUE; /* FIXME: implement this */
524 }
525
526 static gboolean
527 restore_settings_msg_view (ModestConf *conf, ModestMsgView *msg_view,
528                               const gchar *name)
529 {
530         return TRUE; /* FIXME: implement this */
531 }
532
533
534
535 gboolean
536 modest_widget_memory_save (ModestConf *conf, GObject *widget, const gchar *name)
537 {
538         g_return_val_if_fail (conf, FALSE);
539         g_return_val_if_fail (widget, FALSE);
540         g_return_val_if_fail (name, FALSE);
541
542         if (GTK_IS_WINDOW(widget))
543                 return save_settings_window (conf, GTK_WINDOW(widget), name);
544         else if (GTK_IS_PANED(widget))
545                 return save_settings_paned (conf, GTK_PANED(widget), name);
546         else if (MODEST_IS_HEADER_VIEW(widget))
547                 return save_settings_header_view (conf, MODEST_HEADER_VIEW(widget), name);
548         else if (MODEST_IS_FOLDER_VIEW(widget))
549                 return save_settings_folder_view (conf, MODEST_FOLDER_VIEW(widget), name);
550         else if (MODEST_IS_MSG_VIEW(widget))
551                 return save_settings_msg_view (conf, MODEST_MSG_VIEW(widget), name);
552         else if (GTK_IS_WIDGET(widget))
553                 return save_settings_widget (conf, GTK_WIDGET(widget), name);
554         
555         g_printerr ("modest: %p (%s) is not a known widget\n", widget, name);   
556         return FALSE;
557 }
558
559
560
561 gboolean
562 modest_widget_memory_restore (ModestConf *conf, GObject *widget, const gchar *name)
563 {
564         g_return_val_if_fail (conf, FALSE);
565         g_return_val_if_fail (widget, FALSE);
566         g_return_val_if_fail (name, FALSE);
567         
568         if (GTK_IS_WINDOW(widget))
569                 return restore_settings_window (conf, GTK_WINDOW(widget), name);
570         else if (GTK_IS_PANED(widget))
571                 return restore_settings_paned (conf, GTK_PANED(widget), name);
572         else if (MODEST_IS_HEADER_VIEW(widget))
573                 return restore_settings_header_view (conf, MODEST_HEADER_VIEW(widget), name);
574         else if (MODEST_IS_FOLDER_VIEW(widget))
575                 return restore_settings_folder_view (conf, MODEST_FOLDER_VIEW(widget), name);
576         else if (MODEST_IS_MSG_VIEW(widget))
577                 return restore_settings_msg_view (conf, MODEST_MSG_VIEW(widget), name);
578         else if (GTK_IS_WIDGET(widget))
579                 return restore_settings_widget (conf, GTK_WIDGET(widget), name);
580         
581         g_printerr ("modest: %p (%s) is not a known widget\n", widget, name);
582         return FALSE;
583 }