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