2007-08-27 Murray Cumming <murrayc@murrayc.com>
[modest] / src / widgets / modest-global-settings-dialog.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 <glib/gi18n.h>
31 #include <gtk/gtknotebook.h>
32 #include <gtk/gtkstock.h>
33 #include <gtk/gtklabel.h>
34 #include <gtk/gtktogglebutton.h>
35 #include "widgets/modest-global-settings-dialog.h"
36 #include "widgets/modest-global-settings-dialog-priv.h"
37 #include "modest-defs.h"
38 #include "modest-conf.h"
39 #include "modest-runtime.h"
40 #include "modest-ui-constants.h"
41 #include "modest-tny-msg.h"
42 #include "modest-platform.h"
43 #include "widgets/modest-combo-box.h"
44 #ifdef MODEST_PLATFORM_MAEMO
45 #ifdef MODEST_HAVE_HILDON0_WIDGETS
46 #include <hildon-widgets/hildon-number-editor.h>
47 #else
48 #include <hildon/hildon-number-editor.h>
49 #endif /*MODEST_HAVE_HILDON0_WIDGETS*/
50 #endif
51 /* include other impl specific header files */
52
53 #define RETURN_FALSE_ON_ERROR(error) if (error) { g_clear_error (&error); return FALSE; }
54
55 /* 'private'/'protected' functions */
56 static void modest_global_settings_dialog_class_init (ModestGlobalSettingsDialogClass *klass);
57 static void modest_global_settings_dialog_init       (ModestGlobalSettingsDialog *obj);
58 static void modest_global_settings_dialog_finalize   (GObject *obj);
59
60 static void on_response (GtkDialog *dialog,
61                          gint arg1,
62                          gpointer user_data);
63 static void get_current_settings (ModestGlobalSettingsDialogPrivate *priv, 
64                                   ModestGlobalSettingsState *state);
65
66 static ModestConnectedVia current_connection_default (void);
67
68 /* list my signals  */
69 enum {
70         /* MY_SIGNAL_1, */
71         /* MY_SIGNAL_2, */
72         LAST_SIGNAL
73 };
74
75 /* globals */
76 static GtkDialogClass *parent_class = NULL;
77
78 /* uncomment the following if you have defined any signals */
79 /* static guint signals[LAST_SIGNAL] = {0}; */
80
81 GType
82 modest_global_settings_dialog_get_type (void)
83 {
84         static GType my_type = 0;
85         if (!my_type) {
86                 static const GTypeInfo my_info = {
87                         sizeof(ModestGlobalSettingsDialogClass),
88                         NULL,           /* base init */
89                         NULL,           /* base finalize */
90                         (GClassInitFunc) modest_global_settings_dialog_class_init,
91                         NULL,           /* class finalize */
92                         NULL,           /* class data */
93                         sizeof(ModestGlobalSettingsDialog),
94                         1,              /* n_preallocs */
95                         (GInstanceInitFunc) modest_global_settings_dialog_init,
96                         NULL
97                 };
98                 my_type = g_type_register_static (GTK_TYPE_DIALOG,
99                                                   "ModestGlobalSettingsDialog",
100                                                   &my_info, 0);
101         }
102         return my_type;
103 }
104
105 static void
106 modest_global_settings_dialog_class_init (ModestGlobalSettingsDialogClass *klass)
107 {
108         GObjectClass *gobject_class;
109         gobject_class = (GObjectClass*) klass;
110
111         parent_class            = g_type_class_peek_parent (klass);
112         gobject_class->finalize = modest_global_settings_dialog_finalize;
113
114         g_type_class_add_private (gobject_class, sizeof(ModestGlobalSettingsDialogPrivate));
115
116         klass->current_connection_func = current_connection_default;
117 }
118
119 static void
120 modest_global_settings_dialog_init (ModestGlobalSettingsDialog *self)
121 {
122         ModestGlobalSettingsDialogPrivate *priv;
123
124         priv = MODEST_GLOBAL_SETTINGS_DIALOG_GET_PRIVATE (self);
125
126         priv->notebook = gtk_notebook_new ();
127         priv->changed = FALSE;
128
129         /* Add the buttons: */
130         gtk_dialog_add_button (GTK_DIALOG (self), _("mcen_bd_dialog_ok"), GTK_RESPONSE_OK);
131         gtk_dialog_add_button (GTK_DIALOG (self), _("mcen_bd_dialog_cancel"), GTK_RESPONSE_CANCEL);
132     
133         /* Connect to the dialog's response signal: */
134         g_signal_connect (G_OBJECT (self), "response", G_CALLBACK (on_response), self);
135
136         /* Set title */
137         gtk_window_set_title (GTK_WINDOW (self), _("mcen_ti_options"));
138 }
139
140 static void
141 modest_global_settings_dialog_finalize (GObject *obj)
142 {
143         ModestGlobalSettingsDialogPrivate *priv = 
144                 MODEST_GLOBAL_SETTINGS_DIALOG_GET_PRIVATE (obj);
145
146         /* These had to stay alive as long as the comboboxes that used them: */
147         modest_pair_list_free (priv->connect_via_list);
148         modest_pair_list_free (priv->update_interval_list);
149         modest_pair_list_free (priv->msg_format_list);
150         
151         G_OBJECT_CLASS(parent_class)->finalize (obj);
152 }
153
154 /*
155  * Creates a pair list (number,string) and adds it to the given list
156  */
157 static void
158 add_to_modest_pair_list (const gint num, const gchar *str, GSList **list)
159 {
160         gint *number;
161         ModestPair *pair;
162
163         number = g_malloc0 (sizeof (gint));
164         *number = num;
165         pair = modest_pair_new (number, g_strdup (str), FALSE);
166         *list = g_slist_prepend (*list, pair);
167 }
168
169 /*
170  * Gets a list of pairs 
171  */
172 ModestPairList *
173 _modest_global_settings_dialog_get_connected_via (void)
174 {
175         GSList *list = NULL;
176
177         add_to_modest_pair_list (MODEST_CONNECTED_VIA_WLAN, 
178                                  _("mcen_va_options_connectiontype_wlan"), 
179                                  &list);
180         add_to_modest_pair_list (MODEST_CONNECTED_VIA_ANY, 
181                                  _("mcen_va_options_connectiontype_all"), 
182                                  &list);
183
184         return (ModestPairList *) g_slist_reverse (list);
185 }
186
187 /*
188  * Gets a list of pairs of update intervals
189  */
190 ModestPairList *
191 _modest_global_settings_dialog_get_update_interval (void)
192 {
193         GSList *list = NULL;
194
195         add_to_modest_pair_list (MODEST_UPDATE_INTERVAL_5_MIN, 
196                                  _("mcen_va_options_updateinterval_5min"), 
197                                  &list);
198         add_to_modest_pair_list (MODEST_UPDATE_INTERVAL_10_MIN, 
199                                  _("mcen_va_options_updateinterval_10min"), 
200                                  &list);
201         add_to_modest_pair_list (MODEST_UPDATE_INTERVAL_15_MIN, 
202                                  _("mcen_va_options_updateinterval_15min"), 
203                                  &list);
204         add_to_modest_pair_list (MODEST_UPDATE_INTERVAL_30_MIN, 
205                                  _("mcen_va_options_updateinterval_30min"), 
206                                  &list);
207         add_to_modest_pair_list (MODEST_UPDATE_INTERVAL_1_HOUR, 
208                                  _("mcen_va_options_updateinterval_1h"), 
209                                  &list);
210         add_to_modest_pair_list (MODEST_UPDATE_INTERVAL_2_HOUR, 
211                                  _("mcen_va_options_updateinterval_2h"), 
212                                  &list);
213
214         return (ModestPairList *) g_slist_reverse (list);
215 }
216
217 /*
218  * Gets a list of pairs 
219  */
220 ModestPairList *
221 _modest_global_settings_dialog_get_msg_formats (void)
222 {
223         GSList *list = NULL;
224
225         add_to_modest_pair_list (MODEST_FILE_FORMAT_FORMATTED_TEXT, 
226                                  _("mcen_va_options_messageformat_html"), 
227                                  &list);
228         add_to_modest_pair_list (MODEST_FILE_FORMAT_PLAIN_TEXT, 
229                                  _("mcen_va_options_messageformat_plain"), 
230                                  &list);
231
232         return (ModestPairList *) g_slist_reverse (list);
233 }
234
235 void   
236 _modest_global_settings_dialog_load_conf (ModestGlobalSettingsDialog *self)
237 {
238         ModestConf *conf;
239         gboolean checked;
240         gint combo_id, value;
241         GError *error = NULL;
242         ModestGlobalSettingsDialogPrivate *priv;
243
244         priv = MODEST_GLOBAL_SETTINGS_DIALOG_GET_PRIVATE (self);
245         conf = modest_runtime_get_conf ();
246
247         /* Autoupdate */
248         checked = modest_conf_get_bool (conf, MODEST_CONF_AUTO_UPDATE, &error);
249         if (error) {
250                 g_clear_error (&error);
251                 error = NULL;
252                 checked = FALSE;
253         }
254         gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->auto_update), checked);
255         priv->initial_state.auto_update = checked;
256
257         /* Connected by */
258         combo_id = modest_conf_get_int (conf, MODEST_CONF_UPDATE_WHEN_CONNECTED_BY, &error);
259         if (error) {
260                 g_error_free (error);
261                 error = NULL;
262                 combo_id = MODEST_CONNECTED_VIA_WLAN;
263         }
264         modest_combo_box_set_active_id (MODEST_COMBO_BOX (priv->connect_via), 
265                                         (gpointer) &combo_id);
266         priv->initial_state.connect_via = combo_id;
267
268         /* Emit toggled to update the visibility of connect_by caption */
269         gtk_toggle_button_toggled (GTK_TOGGLE_BUTTON (priv->auto_update));
270
271         /* Update interval */
272         combo_id = modest_conf_get_int (conf, MODEST_CONF_UPDATE_INTERVAL, &error);
273         if (error) {
274                 g_error_free (error);
275                 error = NULL;
276                 combo_id = MODEST_UPDATE_INTERVAL_15_MIN;
277         }
278         modest_combo_box_set_active_id (MODEST_COMBO_BOX (priv->update_interval), 
279                                         (gpointer) &combo_id);
280         priv->initial_state.update_interval = combo_id;
281
282         /* Size limit */
283         value  = modest_conf_get_int (conf, MODEST_CONF_MSG_SIZE_LIMIT, &error);
284         if (error) {
285                 g_error_free (error);
286                 error = NULL;
287                 value = 1000;
288         }
289         /* It's better to do this in the subclasses, but it's just one
290            line, so we'll leave it here for the moment */
291 #ifdef MODEST_PLATFORM_MAEMO
292         hildon_number_editor_set_value (HILDON_NUMBER_EDITOR (priv->size_limit), value);
293 #else
294         gtk_spin_button_set_value (GTK_SPIN_BUTTON (priv->size_limit), value);
295 #endif
296         priv->initial_state.size_limit = value;
297
298         /* Play sound */
299         checked = modest_conf_get_bool (conf, MODEST_CONF_PLAY_SOUND_MSG_ARRIVE, &error);
300         if (error) {
301                 g_error_free (error);
302                 error = NULL;
303                 checked = FALSE;
304         }
305         gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (priv->play_sound), checked);
306         priv->initial_state.play_sound = checked;
307
308         /* Msg format */
309         checked = modest_conf_get_bool (conf, MODEST_CONF_PREFER_FORMATTED_TEXT, &error);
310         if (error) {
311                 g_error_free (error);
312                 error = NULL;
313                 combo_id = MODEST_FILE_FORMAT_FORMATTED_TEXT;
314         }       
315         combo_id = (checked) ? MODEST_FILE_FORMAT_FORMATTED_TEXT : MODEST_FILE_FORMAT_PLAIN_TEXT;
316         modest_combo_box_set_active_id (MODEST_COMBO_BOX (priv->msg_format), 
317                                         (gpointer) &combo_id);
318         priv->initial_state.prefer_formatted_text = checked;
319 }
320
321 static void 
322 get_current_settings (ModestGlobalSettingsDialogPrivate *priv, 
323                       ModestGlobalSettingsState *state) 
324 {
325         gint *id;
326
327         /* Get values from UI */
328         state->auto_update = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->auto_update));
329         id = modest_combo_box_get_active_id (MODEST_COMBO_BOX (priv->connect_via));
330         state->connect_via = *id;
331 #ifdef MODEST_PLATFORM_MAEMO
332         state->size_limit = hildon_number_editor_get_value (HILDON_NUMBER_EDITOR (priv->size_limit));
333 #else
334         state->size_limit = gtk_spin_button_get_value (GTK_SPIN_BUTTON (priv->size_limit));
335 #endif
336         id = modest_combo_box_get_active_id (MODEST_COMBO_BOX (priv->update_interval));
337         state->update_interval = *id;
338         state->play_sound = gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (priv->play_sound));
339         id = modest_combo_box_get_active_id (MODEST_COMBO_BOX (priv->msg_format));
340         state->prefer_formatted_text = (*id == MODEST_FILE_FORMAT_FORMATTED_TEXT) ? TRUE : FALSE;
341 }
342
343 gboolean
344 _modest_global_settings_dialog_save_conf (ModestGlobalSettingsDialog *self)
345 {
346         ModestConf *conf;
347         ModestGlobalSettingsState current_state;
348         GError *error = NULL;
349         ModestGlobalSettingsDialogPrivate *priv;
350
351         priv = MODEST_GLOBAL_SETTINGS_DIALOG_GET_PRIVATE (self);
352
353         conf = modest_runtime_get_conf ();
354
355         get_current_settings (priv, &current_state);
356
357         /* Save configuration */
358         modest_conf_set_bool (conf, MODEST_CONF_AUTO_UPDATE, current_state.auto_update, &error);
359         RETURN_FALSE_ON_ERROR(error);
360         modest_conf_set_int (conf, MODEST_CONF_UPDATE_WHEN_CONNECTED_BY, current_state.connect_via, NULL);
361         RETURN_FALSE_ON_ERROR(error);
362         modest_conf_set_int (conf, MODEST_CONF_UPDATE_INTERVAL, current_state.update_interval, NULL);
363         RETURN_FALSE_ON_ERROR(error);
364         modest_conf_set_int (conf, MODEST_CONF_MSG_SIZE_LIMIT, current_state.size_limit, NULL);
365         RETURN_FALSE_ON_ERROR(error);
366         modest_conf_set_bool (conf, MODEST_CONF_PLAY_SOUND_MSG_ARRIVE, current_state.play_sound, NULL);
367         RETURN_FALSE_ON_ERROR(error);
368         modest_conf_set_bool (conf, MODEST_CONF_PREFER_FORMATTED_TEXT, current_state.prefer_formatted_text, NULL);
369         RETURN_FALSE_ON_ERROR(error);
370
371         /* Apply changes */
372         if (priv->initial_state.auto_update != current_state.auto_update || 
373             priv->initial_state.connect_via != current_state.connect_via ||
374             priv->initial_state.update_interval != current_state.update_interval) {
375
376                 TnyAccountStore *account_store;
377                 TnyDevice *device;
378
379                 if (!current_state.auto_update) {
380                         modest_platform_set_update_interval (0);
381                         /* To avoid a new indentation level */
382                         goto exit;
383                 }
384
385                 account_store = TNY_ACCOUNT_STORE (modest_runtime_get_account_store ());
386                 device = tny_account_store_get_device (account_store);
387
388                 if (tny_device_is_online (device)) {
389                         /* If connected via any then set update interval */
390                         if (current_state.connect_via == MODEST_CONNECTED_VIA_ANY) {
391                                 modest_platform_set_update_interval (current_state.update_interval);
392                         } else {
393                                 /* Set update interval only if we
394                                    selected the same connect_via
395                                    method than the one already used by
396                                    the device */
397                                 ModestConnectedVia connect_via = 
398                                         MODEST_GLOBAL_SETTINGS_DIALOG_GET_CLASS(self)->current_connection_func ();
399                                 
400                                 if (current_state.connect_via == connect_via)
401                                         modest_platform_set_update_interval (current_state.update_interval);
402                                 else
403                                         modest_platform_set_update_interval (0);
404                         }
405                 } else {
406                         /* Disable autoupdate in offline mode */
407                         modest_platform_set_update_interval (0);
408                 }
409                 g_object_unref (device);                
410         }
411
412 exit:
413         return TRUE;
414 }
415
416 static gboolean
417 settings_changed (ModestGlobalSettingsState initial_state,
418                   ModestGlobalSettingsState current_state)
419 {
420         if (initial_state.auto_update != current_state.auto_update ||
421             initial_state.connect_via != current_state.connect_via ||
422             initial_state.update_interval != current_state.update_interval ||
423             initial_state.size_limit != current_state.size_limit ||
424             initial_state.play_sound != current_state.play_sound ||
425             initial_state.prefer_formatted_text != current_state.prefer_formatted_text)
426                 return TRUE;
427         else
428                 return FALSE;
429 }
430
431 static void
432 on_response (GtkDialog *dialog,
433              gint arg1,
434              gpointer user_data)
435 {
436         ModestGlobalSettingsDialogPrivate *priv;
437         ModestGlobalSettingsState current_state;
438         gboolean changed;
439
440         priv = MODEST_GLOBAL_SETTINGS_DIALOG_GET_PRIVATE (user_data);
441
442         get_current_settings (priv, &current_state);
443         changed = settings_changed (priv->initial_state, current_state);
444
445         if (arg1 == GTK_RESPONSE_OK) {
446                 if (changed) {
447                         gboolean saved;
448
449                         saved = _modest_global_settings_dialog_save_conf (MODEST_GLOBAL_SETTINGS_DIALOG (dialog));
450                         if (saved) {
451                                 modest_platform_run_information_dialog (GTK_WINDOW (user_data),
452                                                                         _("mcen_ib_advsetup_settings_saved"));
453                         } else {
454                                 modest_platform_run_information_dialog (GTK_WINDOW (user_data),
455                                                                         _("mail_ib_setting_failed"));
456                         }
457                 }
458         } else {
459                 if (changed) {
460                         gint response;
461                         response = modest_platform_run_confirmation_dialog (GTK_WINDOW (user_data), 
462                                                                             _("imum_nc_wizard_confirm_lose_changes"));
463                         /* Do not close if the user Cancels */
464                         if (response == GTK_RESPONSE_CANCEL)
465                                 g_signal_stop_emission_by_name (dialog, "response");
466                 }
467         }
468 }
469
470 static ModestConnectedVia 
471 current_connection_default (void)
472 {
473         g_warning ("You must implement %s", __FUNCTION__);
474         g_return_val_if_reached (MODEST_CONNECTED_VIA_ANY);
475 }