6fab641538a11464c16cbfa08b96f0e886d5ad4d
[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 ModestTnySendQueue*
242 modest_runtime_get_send_queue  (TnyTransportAccount *account)
243 {
244         ModestCacheMgr *cache_mgr;
245         GHashTable     *send_queue_cache;
246         gpointer       orig_key, send_queue;
247         
248         g_return_val_if_fail (_singletons, NULL);
249         g_return_val_if_fail (!TNY_IS_TRANSPORT_ACCOUNT(account), NULL);
250
251         cache_mgr = modest_singletons_get_cache_mgr (_singletons);
252         send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
253                                                        MODEST_CACHE_MGR_CACHE_TYPE_PIXBUF);
254         if (!g_hash_table_lookup_extended (send_queue_cache, account, &orig_key, &send_queue)) {
255                 send_queue = (gpointer)modest_tny_send_queue_new (TNY_CAMEL_TRANSPORT_ACCOUNT(account));
256                 g_hash_table_insert (send_queue_cache, account, send_queue);
257         }
258
259         return MODEST_TNY_SEND_QUEUE(send_queue);
260 }
261
262
263
264
265 /* http://primates.ximian.com/~federico/news-2006-04.html#memory-debugging-infrastructure*/
266 ModestRuntimeDebugFlags
267 modest_runtime_get_debug_flags ()
268 {
269         static const GDebugKey debug_keys[] = {
270                 { "abort-on-warning", MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING },
271                 { "log-actions",      MODEST_RUNTIME_DEBUG_LOG_ACTIONS },
272                 { "debug-objects",    MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS },
273                 { "debug-signals",    MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS },
274                 { "factory-settings", MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS }
275         };
276         const gchar *str;
277         static ModestRuntimeDebugFlags debug_flags = -1;
278
279         if (debug_flags != -1)
280                 return debug_flags;
281         
282         str = g_getenv (MODEST_DEBUG);
283         
284         if (str != NULL)
285                 debug_flags = g_parse_debug_string (str, debug_keys, G_N_ELEMENTS (debug_keys));
286         else
287                 debug_flags = 0;
288         
289         return debug_flags;
290 }
291
292
293
294
295
296 /* NOTE: the exact details of this format are important, as they
297  * are also used in modest-widget-memory. FIXME: make a shared function
298  * for this with widget-memory
299  */
300 static gboolean
301 save_header_settings (ModestConf *conf, TnyFolderType type,
302                       ModestHeaderViewStyle style,  const FolderCols* cols,
303                       guint col_num, gboolean overwrite)
304 {
305         int i;
306         gchar *key;
307         GString *str;
308
309         g_return_val_if_fail (cols, FALSE);
310
311         key = _modest_widget_memory_get_keyname_with_double_type ("header-view",
312                                                                   type, style,
313                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_WIDTH);
314         /* if we're not in overwrite mode, only write stuff it
315          * there was nothing before */
316         if (!overwrite &&  modest_conf_key_exists(conf, key, NULL)) {
317                 g_free (key);
318                 return TRUE;
319         }
320
321         /* the format is necessarily the same as the one in modest-widget-memory */
322         str = g_string_new (NULL);
323         for (i = 0; i != col_num; ++i) 
324                 g_string_append_printf (str, "%d:%d ",
325                                         cols[i].col, cols[i].width); 
326
327         modest_conf_set_string (conf, key, str->str, NULL);
328         g_free (key);
329         g_string_free (str, TRUE);
330         
331         return TRUE;
332 }
333
334 /**
335  * modest_init_header_columns:
336  * @overwrite: write the setting, even if it already exists
337  * 
338  * will set defaults for the columns to show for folder,
339  * if there are no such settings yet (in ModestWidgetMemory)
340  * 
341  * Returns: TRUE if succeeded, FALSE in case of error
342  */
343 static gboolean
344 init_header_columns (ModestConf *conf, gboolean overwrite)
345 {
346         int folder_type;
347         
348         for (folder_type = TNY_FOLDER_TYPE_UNKNOWN;
349              folder_type <= TNY_FOLDER_TYPE_CALENDAR; ++folder_type) {          
350                 
351                 switch (folder_type) {
352                 case TNY_FOLDER_TYPE_OUTBOX:
353                 case TNY_FOLDER_TYPE_SENT:
354                 case TNY_FOLDER_TYPE_DRAFTS:
355                 save_header_settings (conf, folder_type,
356                                       MODEST_HEADER_VIEW_STYLE_DETAILS,
357                                       OUTBOX_COLUMNS_DETAILS,
358                                       G_N_ELEMENTS(OUTBOX_COLUMNS_DETAILS),
359                                       overwrite);
360                 save_header_settings (conf, folder_type,
361                                       MODEST_HEADER_VIEW_STYLE_TWOLINES,
362                                       OUTBOX_COLUMNS_TWOLINES,
363                                       G_N_ELEMENTS(OUTBOX_COLUMNS_TWOLINES),
364                                       overwrite);
365                 break;
366
367                 default:
368                 save_header_settings (conf, folder_type,
369                                       MODEST_HEADER_VIEW_STYLE_DETAILS,
370                                       INBOX_COLUMNS_DETAILS,
371                                       G_N_ELEMENTS(INBOX_COLUMNS_DETAILS),
372                                       overwrite);
373                 save_header_settings (conf, folder_type,
374                                       MODEST_HEADER_VIEW_STYLE_TWOLINES,
375                                       INBOX_COLUMNS_TWOLINES,
376                                       G_N_ELEMENTS(INBOX_COLUMNS_TWOLINES),
377                                       overwrite);
378                 };
379         }
380         return TRUE;
381 }
382
383 /**
384  * init_local_folders:
385  * 
386  * create the Local Folders folder under cache, if they
387  * do not exist yet.
388  * 
389  * Returns: TRUE if the folder were already there, or
390  * they were created, FALSE otherwise
391  */
392 static gboolean
393 init_local_folders  (void)
394 {
395         int i;
396         gchar *maildir_path;
397         static const gchar* maildirs[] = {
398                 "cur", "new", "tmp"
399         };
400         
401         maildir_path = modest_local_folder_info_get_maildir_path ();
402
403         for (i = 0; i != G_N_ELEMENTS(LOCAL_FOLDERS); ++i) {
404                 int j;
405                 for (j = 0; j != G_N_ELEMENTS(maildirs); ++j) {
406                         gchar *dir;
407                         dir = g_build_filename (maildir_path,
408                                                 modest_local_folder_info_get_type_name(LOCAL_FOLDERS[i]),
409                                                 maildirs[j],
410                                                 NULL);
411                         if (g_mkdir_with_parents (dir, 0755) < 0) {
412                                 g_printerr ("modest: failed to create %s\n", dir);
413                                 g_free (dir);
414                                 g_free (maildir_path);
415                                 return FALSE;
416                         }
417                         g_free(dir);
418                 }
419         }
420         
421         g_free (maildir_path);
422         return TRUE;
423 }
424
425
426
427 static void
428 free_element (gpointer data, gpointer user_data)
429 {
430         g_free (data);
431 }
432
433
434
435 /**
436  * init_default_account_maybe:
437  *
438  * if there are accounts defined, but there is no default account,
439  * it will be defined.
440  * 
441  * Returns: TRUE if there was a default account already,
442  *  or one has been created or there are no accounts yet,
443  *  returns FALSE in case of error
444  */
445 static gboolean
446 init_default_account_maybe  (ModestAccountMgr *acc_mgr)
447 {
448         GSList *all_accounts = NULL;
449         gchar *default_account;
450         gboolean retval = TRUE;
451         
452         all_accounts = modest_account_mgr_account_names (acc_mgr, NULL);
453         if (all_accounts) { /* if there are any accounts, there should be a default one */
454                 default_account = 
455                         modest_account_mgr_get_default_account (acc_mgr);
456                 if (!default_account) {
457                         gchar *first_account;
458                         g_printerr ("modest: no default account defined\n");
459                         first_account = (gchar*)all_accounts->data;
460                         if ((retval = modest_account_mgr_set_default_account (acc_mgr, first_account)))
461                                 g_printerr ("modest: set '%s' as the default account\n",
462                                             first_account);
463                         else
464                                 g_printerr ("modest: failed to set '%s' as the default account\n",
465                                             first_account);
466                         g_free (default_account);
467                 }
468                 g_slist_foreach (all_accounts, free_element, NULL);
469                 g_slist_free    (all_accounts);
470         }
471         return retval;
472 }
473
474
475
476 static void
477 debug_g_type_init (void)
478 {
479         GTypeDebugFlags gflags;
480         ModestRuntimeDebugFlags mflags;
481         
482         gflags = 0;
483         mflags = modest_runtime_get_debug_flags ();
484
485         if (mflags & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS)
486                 gflags |= G_TYPE_DEBUG_OBJECTS;
487         if (mflags & MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS)
488                 gflags |= G_TYPE_DEBUG_SIGNALS;
489
490         g_type_init_with_debug_flags (gflags);
491 }
492
493 static void
494 debug_logging_init (void)
495 {
496         ModestRuntimeDebugFlags mflags;
497         mflags = modest_runtime_get_debug_flags ();
498         
499         if (mflags & MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING)
500                 g_log_set_always_fatal (G_LOG_LEVEL_ERROR |
501                                         G_LOG_LEVEL_CRITICAL |
502                                         G_LOG_LEVEL_WARNING);
503 }
504
505
506 static void
507 init_i18n (void)
508 {
509         bindtextdomain (GETTEXT_PACKAGE, MODEST_LOCALEDIR);
510         bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
511         textdomain (GETTEXT_PACKAGE);
512
513 }
514
515
516 #if MODEST_PLATFORM_ID==2 
517 static gboolean
518 hildon_init (void)
519 {
520         osso_context_t *osso_context =
521                 osso_initialize(PACKAGE, PACKAGE_VERSION,
522                                 TRUE, NULL);    
523         if (!osso_context) {
524                 g_printerr ("modest: failed to acquire osso context\n");
525                 return FALSE;
526         }
527 }
528 #endif /* MODEST_PLATFORM_ID==2 */