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