be73102729579bd02fb84aa04e7dc46a41fff1bc
[modest] / src / modest-runtime.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 <config.h>
31 #include <glib.h>
32 #include <glib-object.h>
33 #include <glib/gstdio.h>
34 #include <modest-runtime.h>
35 #include <modest-defs.h>
36 #include <modest-singletons.h>
37 #include <widgets/modest-header-view.h>
38 #include <widgets/modest-folder-view.h>
39 #include <modest-tny-platform-factory.h>
40 #include <modest-widget-memory.h>
41 #include <modest-widget-memory-priv.h>
42 #include <modest-local-folder-info.h>
43 #include <modest-account-mgr.h>
44 #include <modest-account-mgr-helpers.h>
45
46 #if MODEST_PLATFORM_ID==2 /* maemo/hildon */
47 #include <libosso.h>
48 static gboolean hildon_init (void);
49 #endif /* MODEST_PLATFORM_ID==2 */
50
51 static gboolean init_header_columns (ModestConf *conf, gboolean overwrite);
52 static gboolean init_local_folders  (void);
53 static gboolean init_default_account_maybe  (ModestAccountMgr *acc_mgr);
54 static void     init_i18n (void);
55 static void     debug_g_type_init (void);
56 static void     debug_logging_init (void);
57
58 static ModestSingletons *_singletons = NULL;
59
60 /*
61  * defaults for the column headers
62  */
63
64 typedef struct {
65         ModestHeaderViewColumn col;
66         guint                  width;
67 } FolderCols;
68
69 static const FolderCols INBOX_COLUMNS_DETAILS[] = {
70         {MODEST_HEADER_VIEW_COLUMN_MSGTYPE, 40},
71         {MODEST_HEADER_VIEW_COLUMN_ATTACH,  40},
72         {MODEST_HEADER_VIEW_COLUMN_FROM,    80},
73         {MODEST_HEADER_VIEW_COLUMN_SUBJECT, 80},
74         {MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE, 60},
75         {MODEST_HEADER_VIEW_COLUMN_SIZE, 50}
76 };
77 static const FolderCols INBOX_COLUMNS_TWOLINES[] = {
78         {MODEST_HEADER_VIEW_COLUMN_MSGTYPE, 40},
79         {MODEST_HEADER_VIEW_COLUMN_ATTACH,  40},
80         {MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN, 200}
81 };
82
83 static const FolderCols OUTBOX_COLUMNS_DETAILS[] = {
84          {MODEST_HEADER_VIEW_COLUMN_MSGTYPE, 40},
85          {MODEST_HEADER_VIEW_COLUMN_ATTACH,  40},
86          {MODEST_HEADER_VIEW_COLUMN_TO,    80},
87          {MODEST_HEADER_VIEW_COLUMN_SUBJECT, 80},
88          {MODEST_HEADER_VIEW_COLUMN_SENT_DATE, 80},
89          {MODEST_HEADER_VIEW_COLUMN_SIZE, 50}
90 };
91 static const FolderCols OUTBOX_COLUMNS_TWOLINES[] = {
92          {MODEST_HEADER_VIEW_COLUMN_MSGTYPE, 40},
93          {MODEST_HEADER_VIEW_COLUMN_ATTACH,  40},
94          {MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT,200},
95 };
96          
97 static const TnyFolderType LOCAL_FOLDERS[] = {
98         TNY_FOLDER_TYPE_OUTBOX,
99         TNY_FOLDER_TYPE_DRAFTS,
100         TNY_FOLDER_TYPE_SENT,
101         TNY_FOLDER_TYPE_TRASH,
102         TNY_FOLDER_TYPE_ARCHIVE 
103 };
104
105
106 gboolean
107 modest_runtime_init (void)
108 {
109         ModestSingletons *my_singletons;
110         gboolean reset;
111         
112         if (_singletons) {
113                 g_printerr ("modest: modest_runtime_init can only be called once\n");
114                 return FALSE;
115         }
116         
117         init_i18n();
118         debug_g_type_init();
119         debug_logging_init();
120
121         g_thread_init(NULL);
122         gdk_threads_init ();
123
124         my_singletons = modest_singletons_new ();
125         if (!my_singletons) {
126                 g_printerr ("modest: failed to initialize singletons\n");
127                 return FALSE;
128         }
129
130 #if MODEST_PLATFORM_ID==2 
131         if (!hildon_init ()) {
132                 modest_runtime_uninit ();
133                 g_printerr ("modest: failed to initialize hildon\n");
134                 return FALSE;
135         }
136 #endif /* MODEST_PLATFORM_ID==2 */
137
138         /* based on the debug settings, we decide whether to overwrite old settings */
139         reset = modest_runtime_get_debug_flags () & MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS;
140         if (!init_header_columns(modest_singletons_get_conf (my_singletons), reset)) {
141                 modest_runtime_uninit ();
142                 g_printerr ("modest: failed to init header columns\n");
143                 return FALSE;
144         }
145
146         if (!init_local_folders()) {
147                 modest_runtime_uninit ();
148                 g_printerr ("modest: failed to init local folders\n");
149                 return FALSE;
150         }
151         
152         if (!init_default_account_maybe(modest_singletons_get_account_mgr (my_singletons))) {
153                 modest_runtime_uninit ();
154                 g_printerr ("modest: failed to init default account\n");
155                 return FALSE;
156         }
157
158         /* don't initialize _singletons before all the other init stuff
159          * is done; thus, using any of the singleton stuff before
160          * runtime is fully init'ed  is avoided
161          */
162         _singletons = my_singletons;
163         
164         return TRUE;
165 }
166
167
168 gboolean
169 modest_runtime_init_ui (gint argc, gchar** argv)
170 {
171         if (!gtk_init_check(&argc, &argv)) {
172                 g_printerr ("modest: failed to initialize graphical ui\n");
173                 return FALSE;
174         }
175         return TRUE;
176 }
177
178
179 gboolean
180 modest_runtime_uninit (void)
181 {
182         if (!_singletons) {
183                 g_printerr ("modest: modest_runtime is not initialized\n");
184                 return FALSE;
185         }
186         
187         g_object_unref (G_OBJECT(_singletons));
188         _singletons = NULL;
189
190         return TRUE;
191 }
192
193
194 ModestAccountMgr*
195 modest_runtime_get_account_mgr   (void)
196 {
197         g_return_val_if_fail (_singletons, NULL);
198         return modest_singletons_get_account_mgr (_singletons);
199 }
200
201 ModestTnyAccountStore*
202 modest_runtime_get_account_store   (void)
203 {
204         g_return_val_if_fail (_singletons, NULL);
205         return modest_singletons_get_account_store (_singletons);
206
207 }
208
209 ModestConf*
210 modest_runtime_get_conf (void)
211 {
212         g_return_val_if_fail (_singletons, NULL);
213         return modest_singletons_get_conf (_singletons);
214 }
215
216
217 ModestCacheMgr*
218 modest_runtime_get_cache_mgr (void)
219 {
220         g_return_val_if_fail (_singletons, NULL);
221         return modest_singletons_get_cache_mgr (_singletons);
222 }
223
224
225 ModestMailOperationQueue*
226 modest_runtime_get_mail_operation_queue (void)
227 {
228         g_return_val_if_fail (_singletons, NULL);
229         return modest_singletons_get_mail_operation_queue (_singletons);
230 }
231
232
233 ModestWidgetFactory*
234 modest_runtime_get_widget_factory     (void)
235 {
236         g_return_val_if_fail (_singletons, NULL);
237         return modest_singletons_get_widget_factory (_singletons);
238 }
239
240
241
242 /* http://primates.ximian.com/~federico/news-2006-04.html#memory-debugging-infrastructure*/
243 ModestRuntimeDebugFlags
244 modest_runtime_get_debug_flags ()
245 {
246         static const GDebugKey debug_keys[] = {
247                 { "abort-on-warning", MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING },
248                 { "log-actions",      MODEST_RUNTIME_DEBUG_LOG_ACTIONS },
249                 { "debug-objects",    MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS },
250                 { "debug-signals",    MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS },
251                 { "factory-settings", MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS }
252         };
253         const gchar *str;
254         static ModestRuntimeDebugFlags debug_flags = -1;
255
256         if (debug_flags != -1)
257                 return debug_flags;
258         
259         str = g_getenv (MODEST_DEBUG);
260         
261         if (str != NULL)
262                 debug_flags = g_parse_debug_string (str, debug_keys, G_N_ELEMENTS (debug_keys));
263         else
264                 debug_flags = 0;
265         
266         return debug_flags;
267 }
268
269
270
271
272
273 /* NOTE: the exact details of this format are important, as they
274  * are also used in modest-widget-memory. FIXME: make a shared function
275  * for this with widget-memory
276  */
277 static gboolean
278 save_header_settings (ModestConf *conf, TnyFolderType type,
279                       ModestHeaderViewStyle style,  const FolderCols* cols,
280                       guint col_num, gboolean overwrite)
281 {
282         int i;
283         gchar *key;
284         GString *str;
285
286         g_return_val_if_fail (cols, FALSE);
287
288         key = _modest_widget_memory_get_keyname_with_double_type ("header-view",
289                                                                   type, style,
290                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_WIDTH);
291         /* if we're not in overwrite mode, only write stuff it
292          * there was nothing before */
293         if (!overwrite &&  modest_conf_key_exists(conf, key, NULL)) {
294                 g_free (key);
295                 return TRUE;
296         }
297
298         /* the format is necessarily the same as the one in modest-widget-memory */
299         str = g_string_new (NULL);
300         for (i = 0; i != col_num; ++i) 
301                 g_string_append_printf (str, "%d:%d ",
302                                         cols[i].col, cols[i].width); 
303
304         modest_conf_set_string (conf, key, str->str, NULL);
305         g_free (key);
306         g_string_free (str, TRUE);
307         
308         return TRUE;
309 }
310
311 /**
312  * modest_init_header_columns:
313  * @overwrite: write the setting, even if it already exists
314  * 
315  * will set defaults for the columns to show for folder,
316  * if there are no such settings yet (in ModestWidgetMemory)
317  * 
318  * Returns: TRUE if succeeded, FALSE in case of error
319  */
320 static gboolean
321 init_header_columns (ModestConf *conf, gboolean overwrite)
322 {
323         int folder_type;
324         
325         for (folder_type = TNY_FOLDER_TYPE_UNKNOWN;
326              folder_type <= TNY_FOLDER_TYPE_CALENDAR; ++folder_type) {          
327                 
328                 switch (folder_type) {
329                 case TNY_FOLDER_TYPE_OUTBOX:
330                 case TNY_FOLDER_TYPE_SENT:
331                 case TNY_FOLDER_TYPE_DRAFTS:
332                 save_header_settings (conf, folder_type,
333                                       MODEST_HEADER_VIEW_STYLE_DETAILS,
334                                       OUTBOX_COLUMNS_DETAILS,
335                                       G_N_ELEMENTS(OUTBOX_COLUMNS_DETAILS),
336                                       overwrite);
337                 save_header_settings (conf, folder_type,
338                                       MODEST_HEADER_VIEW_STYLE_TWOLINES,
339                                       OUTBOX_COLUMNS_TWOLINES,
340                                       G_N_ELEMENTS(OUTBOX_COLUMNS_TWOLINES),
341                                       overwrite);
342                 break;
343
344                 default:
345                 save_header_settings (conf, folder_type,
346                                       MODEST_HEADER_VIEW_STYLE_DETAILS,
347                                       INBOX_COLUMNS_DETAILS,
348                                       G_N_ELEMENTS(INBOX_COLUMNS_DETAILS),
349                                       overwrite);
350                 save_header_settings (conf, folder_type,
351                                       MODEST_HEADER_VIEW_STYLE_TWOLINES,
352                                       INBOX_COLUMNS_TWOLINES,
353                                       G_N_ELEMENTS(INBOX_COLUMNS_TWOLINES),
354                                       overwrite);
355                 };
356         }
357         return TRUE;
358 }
359
360 /**
361  * init_local_folders:
362  * 
363  * create the Local Folders folder under cache, if they
364  * do not exist yet.
365  * 
366  * Returns: TRUE if the folder were already there, or
367  * they were created, FALSE otherwise
368  */
369 static gboolean
370 init_local_folders  (void)
371 {
372         int i;
373         gchar *maildir_path;
374         static const gchar* maildirs[] = {
375                 "cur", "new", "tmp"
376         };
377         
378         maildir_path = modest_local_folder_info_get_maildir_path ();
379
380         for (i = 0; i != G_N_ELEMENTS(LOCAL_FOLDERS); ++i) {
381                 int j;
382                 for (j = 0; j != G_N_ELEMENTS(maildirs); ++j) {
383                         gchar *dir;
384                         dir = g_build_filename (maildir_path,
385                                                 modest_local_folder_info_get_type_name(LOCAL_FOLDERS[i]),
386                                                 maildirs[j],
387                                                 NULL);
388                         if (g_mkdir_with_parents (dir, 0755) < 0) {
389                                 g_printerr ("modest: failed to create %s\n", dir);
390                                 g_free (dir);
391                                 g_free (maildir_path);
392                                 return FALSE;
393                         }
394                         g_free(dir);
395                 }
396         }
397         
398         g_free (maildir_path);
399         return TRUE;
400 }
401
402
403
404 static void
405 free_element (gpointer data, gpointer user_data)
406 {
407         g_free (data);
408 }
409
410
411
412 /**
413  * init_default_account_maybe:
414  *
415  * if there are accounts defined, but there is no default account,
416  * it will be defined.
417  * 
418  * Returns: TRUE if there was a default account already,
419  *  or one has been created or there are no accounts yet,
420  *  returns FALSE in case of error
421  */
422 static gboolean
423 init_default_account_maybe  (ModestAccountMgr *acc_mgr)
424 {
425         GSList *all_accounts = NULL;
426         gchar *default_account;
427         gboolean retval = TRUE;
428         
429         all_accounts = modest_account_mgr_account_names (acc_mgr, NULL);
430         if (all_accounts) { /* if there are any accounts, there should be a default one */
431                 default_account = 
432                         modest_account_mgr_get_default_account (acc_mgr);
433                 if (!default_account) {
434                         gchar *first_account;
435                         g_printerr ("modest: no default account defined\n");
436                         first_account = (gchar*)all_accounts->data;
437                         if ((retval = modest_account_mgr_set_default_account (acc_mgr, first_account)))
438                                 g_printerr ("modest: set '%s' as the default account\n",
439                                             first_account);
440                         else
441                                 g_printerr ("modest: failed to set '%s' as the default account\n",
442                                             first_account);
443                         g_free (default_account);
444                 }
445                 g_slist_foreach (all_accounts, free_element, NULL);
446                 g_slist_free    (all_accounts);
447         }
448         return retval;
449 }
450
451
452
453 static void
454 debug_g_type_init (void)
455 {
456         GTypeDebugFlags gflags;
457         ModestRuntimeDebugFlags mflags;
458         
459         gflags = 0;
460         mflags = modest_runtime_get_debug_flags ();
461
462         if (mflags & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS)
463                 gflags |= G_TYPE_DEBUG_OBJECTS;
464         if (mflags & MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS)
465                 gflags |= G_TYPE_DEBUG_SIGNALS;
466
467         g_type_init_with_debug_flags (gflags);
468 }
469
470 static void
471 debug_logging_init (void)
472 {
473         ModestRuntimeDebugFlags mflags;
474         mflags = modest_runtime_get_debug_flags ();
475         
476         if (mflags & MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING)
477                 g_log_set_always_fatal (G_LOG_LEVEL_ERROR |
478                                         G_LOG_LEVEL_CRITICAL |
479                                         G_LOG_LEVEL_WARNING);
480 }
481
482
483 static void
484 init_i18n (void)
485 {
486         bindtextdomain (GETTEXT_PACKAGE, MODEST_LOCALEDIR);
487         bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
488         textdomain (GETTEXT_PACKAGE);
489
490 }
491
492
493 #if MODEST_PLATFORM_ID==2 
494 static gboolean
495 hildon_init (void)
496 {
497         osso_context_t *osso_context =
498                 osso_initialize(PACKAGE, PACKAGE_VERSION,
499                                 TRUE, NULL);    
500         if (!osso_context) {
501                 g_printerr ("modest: failed to acquire osso context\n");
502                 return FALSE;
503         }
504 }
505 #endif /* MODEST_PLATFORM_ID==2 */