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