* all:
[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 #include <modest-icon-names.h>
46
47 #if MODEST_PLATFORM_ID==2 /* maemo/hildon */
48 #include <libosso.h>
49 static gboolean init_hildon (void);
50 #endif /* MODEST_PLATFORM_ID==2 */
51
52 static gboolean init_header_columns (ModestConf *conf, gboolean overwrite);
53 static gboolean init_local_folders  (void);
54 static gboolean init_default_account_maybe  (ModestAccountMgr *acc_mgr);
55 static void     init_i18n (void);
56 static void     init_stock_icons (void);
57 static void     init_debug_g_type (void);
58 static void     init_debug_logging (void);
59
60 static ModestSingletons *_singletons = NULL;
61
62 /*
63  * defaults for the column headers
64  */
65
66 typedef struct {
67         ModestHeaderViewColumn col;
68         guint                  width;
69 } FolderCols;
70
71 static const FolderCols INBOX_COLUMNS_DETAILS[] = {
72         {MODEST_HEADER_VIEW_COLUMN_MSGTYPE, 40},
73         {MODEST_HEADER_VIEW_COLUMN_ATTACH,  40},
74         {MODEST_HEADER_VIEW_COLUMN_FROM,    80},
75         {MODEST_HEADER_VIEW_COLUMN_SUBJECT, 80},
76         {MODEST_HEADER_VIEW_COLUMN_RECEIVED_DATE, 60},
77         {MODEST_HEADER_VIEW_COLUMN_SIZE, 50}
78 };
79 static const FolderCols INBOX_COLUMNS_TWOLINES[] = {
80         {MODEST_HEADER_VIEW_COLUMN_MSGTYPE, 40},
81         {MODEST_HEADER_VIEW_COLUMN_ATTACH,  40},
82         {MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_IN, 200}
83 };
84
85 static const FolderCols OUTBOX_COLUMNS_DETAILS[] = {
86          {MODEST_HEADER_VIEW_COLUMN_MSGTYPE, 40},
87          {MODEST_HEADER_VIEW_COLUMN_ATTACH,  40},
88          {MODEST_HEADER_VIEW_COLUMN_TO,    80},
89          {MODEST_HEADER_VIEW_COLUMN_SUBJECT, 80},
90          {MODEST_HEADER_VIEW_COLUMN_SENT_DATE, 80},
91          {MODEST_HEADER_VIEW_COLUMN_SIZE, 50}
92 };
93 static const FolderCols OUTBOX_COLUMNS_TWOLINES[] = {
94          {MODEST_HEADER_VIEW_COLUMN_MSGTYPE, 40},
95          {MODEST_HEADER_VIEW_COLUMN_ATTACH,  40},
96          {MODEST_HEADER_VIEW_COLUMN_COMPACT_HEADER_OUT,200},
97 };
98          
99 static const TnyFolderType LOCAL_FOLDERS[] = {
100         TNY_FOLDER_TYPE_OUTBOX,
101         TNY_FOLDER_TYPE_DRAFTS,
102         TNY_FOLDER_TYPE_SENT,
103         TNY_FOLDER_TYPE_TRASH,
104         TNY_FOLDER_TYPE_ARCHIVE 
105 };
106
107
108 gboolean
109 modest_runtime_init (void)
110 {
111         ModestSingletons *my_singletons;
112         gboolean reset;
113         
114         if (_singletons) {
115                 g_printerr ("modest: modest_runtime_init can only be called once\n");
116                 return FALSE;
117         }
118         
119         init_i18n();
120         init_debug_g_type();
121         init_debug_logging();
122
123         g_thread_init(NULL);
124         gdk_threads_init ();
125
126         my_singletons = modest_singletons_new ();
127         if (!my_singletons) {
128                 g_printerr ("modest: failed to initialize singletons\n");
129                 return FALSE;
130         }
131
132 #if MODEST_PLATFORM_ID==2 
133         if (!init_hildon ()) {
134                 modest_runtime_uninit ();
135                 g_printerr ("modest: failed to initialize hildon\n");
136                 return FALSE;
137         }
138 #endif /* MODEST_PLATFORM_ID==2 */
139
140         /* based on the debug settings, we decide whether to overwrite old settings */
141         reset = modest_runtime_get_debug_flags () & MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS;
142         if (!init_header_columns(modest_singletons_get_conf (my_singletons), reset)) {
143                 modest_runtime_uninit ();
144                 g_printerr ("modest: failed to init header columns\n");
145                 return FALSE;
146         }
147
148         if (!init_local_folders()) {
149                 modest_runtime_uninit ();
150                 g_printerr ("modest: failed to init local folders\n");
151                 return FALSE;
152         }
153         
154         if (!init_default_account_maybe(modest_singletons_get_account_mgr (my_singletons))) {
155                 modest_runtime_uninit ();
156                 g_printerr ("modest: failed to init default account\n");
157                 return FALSE;
158         }
159
160         /* don't initialize _singletons before all the other init stuff
161          * is done; thus, using any of the singleton stuff before
162          * runtime is fully init'ed  is avoided
163          */
164         _singletons = my_singletons;
165         
166         return TRUE;
167 }
168
169
170 gboolean
171 modest_runtime_init_ui (gint argc, gchar** argv)
172 {
173         if (!gtk_init_check(&argc, &argv)) {
174                 g_printerr ("modest: failed to initialize graphical ui\n");
175                 return FALSE;
176         }
177
178         init_stock_icons ();
179         return TRUE;
180 }
181
182
183 gboolean
184 modest_runtime_uninit (void)
185 {
186         if (_singletons) {
187                 g_object_unref (G_OBJECT(_singletons));
188                 _singletons = NULL;
189         }
190         if (G_IS_OBJECT(_singletons)) 
191                 g_warning ("BUG: _singletons is still alive\n");
192         
193         return TRUE;
194 }
195
196
197 ModestAccountMgr*
198 modest_runtime_get_account_mgr   (void)
199 {
200         g_return_val_if_fail (_singletons, NULL);
201         return modest_singletons_get_account_mgr (_singletons);
202 }
203
204 ModestTnyAccountStore*
205 modest_runtime_get_account_store   (void)
206 {
207         g_return_val_if_fail (_singletons, NULL);
208         return modest_singletons_get_account_store (_singletons);
209
210 }
211
212 ModestConf*
213 modest_runtime_get_conf (void)
214 {
215         g_return_val_if_fail (_singletons, NULL);
216         return modest_singletons_get_conf (_singletons);
217 }
218
219
220 ModestCacheMgr*
221 modest_runtime_get_cache_mgr (void)
222 {
223         g_return_val_if_fail (_singletons, NULL);
224         return modest_singletons_get_cache_mgr (_singletons);
225 }
226
227
228 ModestMailOperationQueue*
229 modest_runtime_get_mail_operation_queue (void)
230 {
231         g_return_val_if_fail (_singletons, NULL);
232         return modest_singletons_get_mail_operation_queue (_singletons);
233 }
234
235
236
237 TnyDevice*
238 modest_runtime_get_device (void)
239 {
240         g_return_val_if_fail (_singletons, NULL);
241         return modest_singletons_get_device (_singletons);
242 }
243
244
245 TnyPlatformFactory*
246 modest_runtime_get_platform_factory  (void)
247 {
248         g_return_val_if_fail (_singletons, NULL);
249         return modest_singletons_get_platform_factory (_singletons);
250 }
251
252
253
254
255 ModestTnySendQueue*
256 modest_runtime_get_send_queue  (TnyTransportAccount *account)
257 {
258         ModestCacheMgr *cache_mgr;
259         GHashTable     *send_queue_cache;
260         gpointer       orig_key, send_queue;
261         
262         g_return_val_if_fail (_singletons, NULL);
263         g_return_val_if_fail (TNY_IS_TRANSPORT_ACCOUNT(account), NULL);
264
265         cache_mgr = modest_singletons_get_cache_mgr (_singletons);
266         send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
267                                                        MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
268
269         if (!g_hash_table_lookup_extended (send_queue_cache, account, &orig_key, &send_queue)) {
270                 send_queue = (gpointer)modest_tny_send_queue_new (TNY_CAMEL_TRANSPORT_ACCOUNT(account));
271                 g_hash_table_insert (send_queue_cache, account, send_queue);
272         }
273
274         return MODEST_TNY_SEND_QUEUE(send_queue);
275 }
276
277
278
279
280 /* http://primates.ximian.com/~federico/news-2006-04.html#memory-debugging-infrastructure*/
281 ModestRuntimeDebugFlags
282 modest_runtime_get_debug_flags ()
283 {
284         static const GDebugKey debug_keys[] = {
285                 { "abort-on-warning", MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING },
286                 { "log-actions",      MODEST_RUNTIME_DEBUG_LOG_ACTIONS },
287                 { "debug-objects",    MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS },
288                 { "debug-signals",    MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS },
289                 { "factory-settings", MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS }
290         };
291         const gchar *str;
292         static ModestRuntimeDebugFlags debug_flags = -1;
293
294         if (debug_flags != -1)
295                 return debug_flags;
296         
297         str = g_getenv (MODEST_DEBUG);
298         
299         if (str != NULL)
300                 debug_flags = g_parse_debug_string (str, debug_keys, G_N_ELEMENTS (debug_keys));
301         else
302                 debug_flags = 0;
303         
304         return debug_flags;
305 }
306
307
308
309
310
311 /* NOTE: the exact details of this format are important, as they
312  * are also used in modest-widget-memory. FIXME: make a shared function
313  * for this with widget-memory
314  */
315 static gboolean
316 save_header_settings (ModestConf *conf, TnyFolderType type,
317                       ModestHeaderViewStyle style,  const FolderCols* cols,
318                       guint col_num, gboolean overwrite)
319 {
320         int i;
321         gchar *key;
322         GString *str;
323
324         g_return_val_if_fail (cols, FALSE);
325
326         key = _modest_widget_memory_get_keyname_with_double_type ("header-view",
327                                                                   type, style,
328                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_WIDTH);
329         /* if we're not in overwrite mode, only write stuff it
330          * there was nothing before */
331         if (!overwrite &&  modest_conf_key_exists(conf, key, NULL)) {
332                 g_free (key);
333                 return TRUE;
334         }
335
336         /* the format is necessarily the same as the one in modest-widget-memory */
337         str = g_string_new (NULL);
338         for (i = 0; i != col_num; ++i) 
339                 g_string_append_printf (str, "%d:%d ",
340                                         cols[i].col, cols[i].width); 
341
342         modest_conf_set_string (conf, key, str->str, NULL);
343         g_free (key);
344         g_string_free (str, TRUE);
345         
346         return TRUE;
347 }
348
349 /**
350  * modest_init_header_columns:
351  * @overwrite: write the setting, even if it already exists
352  * 
353  * will set defaults for the columns to show for folder,
354  * if there are no such settings yet (in ModestWidgetMemory)
355  * 
356  * Returns: TRUE if succeeded, FALSE in case of error
357  */
358 static gboolean
359 init_header_columns (ModestConf *conf, gboolean overwrite)
360 {
361         int folder_type;
362         
363         for (folder_type = TNY_FOLDER_TYPE_UNKNOWN;
364              folder_type <= TNY_FOLDER_TYPE_CALENDAR; ++folder_type) {          
365                 
366                 switch (folder_type) {
367                 case TNY_FOLDER_TYPE_OUTBOX:
368                 case TNY_FOLDER_TYPE_SENT:
369                 case TNY_FOLDER_TYPE_DRAFTS:
370                 save_header_settings (conf, folder_type,
371                                       MODEST_HEADER_VIEW_STYLE_DETAILS,
372                                       OUTBOX_COLUMNS_DETAILS,
373                                       G_N_ELEMENTS(OUTBOX_COLUMNS_DETAILS),
374                                       overwrite);
375                 save_header_settings (conf, folder_type,
376                                       MODEST_HEADER_VIEW_STYLE_TWOLINES,
377                                       OUTBOX_COLUMNS_TWOLINES,
378                                       G_N_ELEMENTS(OUTBOX_COLUMNS_TWOLINES),
379                                       overwrite);
380                 break;
381
382                 default:
383                 save_header_settings (conf, folder_type,
384                                       MODEST_HEADER_VIEW_STYLE_DETAILS,
385                                       INBOX_COLUMNS_DETAILS,
386                                       G_N_ELEMENTS(INBOX_COLUMNS_DETAILS),
387                                       overwrite);
388                 save_header_settings (conf, folder_type,
389                                       MODEST_HEADER_VIEW_STYLE_TWOLINES,
390                                       INBOX_COLUMNS_TWOLINES,
391                                       G_N_ELEMENTS(INBOX_COLUMNS_TWOLINES),
392                                       overwrite);
393                 };
394         }
395         return TRUE;
396 }
397
398 /**
399  * init_local_folders:
400  * 
401  * create the Local Folders folder under cache, if they
402  * do not exist yet.
403  * 
404  * Returns: TRUE if the folder were already there, or
405  * they were created, FALSE otherwise
406  */
407 static gboolean
408 init_local_folders  (void)
409 {
410         int i;
411         gchar *maildir_path;
412         static const gchar* maildirs[] = {
413                 "cur", "new", "tmp"
414         };
415         
416         maildir_path = modest_local_folder_info_get_maildir_path ();
417
418         for (i = 0; i != G_N_ELEMENTS(LOCAL_FOLDERS); ++i) {
419                 int j;
420                 for (j = 0; j != G_N_ELEMENTS(maildirs); ++j) {
421                         gchar *dir;
422                         dir = g_build_filename (maildir_path,
423                                                 modest_local_folder_info_get_type_name(LOCAL_FOLDERS[i]),
424                                                 maildirs[j],
425                                                 NULL);
426                         if (g_mkdir_with_parents (dir, 0755) < 0) {
427                                 g_printerr ("modest: failed to create %s\n", dir);
428                                 g_free (dir);
429                                 g_free (maildir_path);
430                                 return FALSE;
431                         }
432                         g_free(dir);
433                 }
434         }
435         
436         g_free (maildir_path);
437         return TRUE;
438 }
439
440
441
442 static void
443 free_element (gpointer data, gpointer user_data)
444 {
445         g_free (data);
446 }
447
448
449
450 /**
451  * init_default_account_maybe:
452  *
453  * if there are accounts defined, but there is no default account,
454  * it will be defined.
455  * 
456  * Returns: TRUE if there was a default account already,
457  *  or one has been created or there are no accounts yet,
458  *  returns FALSE in case of error
459  */
460 static gboolean
461 init_default_account_maybe  (ModestAccountMgr *acc_mgr)
462 {
463         GSList *all_accounts = NULL;
464         gchar *default_account;
465         gboolean retval = TRUE;
466         
467         all_accounts = modest_account_mgr_account_names (acc_mgr);
468         if (all_accounts) { /* if there are any accounts, there should be a default one */
469                 default_account = 
470                         modest_account_mgr_get_default_account (acc_mgr);
471                 if (!default_account) {
472                         gchar *first_account;
473                         g_printerr ("modest: no default account defined\n");
474                         first_account = (gchar*)all_accounts->data;
475                         if ((retval = modest_account_mgr_set_default_account (acc_mgr, first_account)))
476                                 g_printerr ("modest: set '%s' as the default account\n",
477                                             first_account);
478                         else
479                                 g_printerr ("modest: failed to set '%s' as the default account\n",
480                                             first_account);
481                         g_free (default_account);
482                 }
483                 g_slist_foreach (all_accounts, free_element, NULL);
484                 g_slist_free    (all_accounts);
485         }
486         return retval;
487 }
488
489
490
491 static void
492 init_debug_g_type (void)
493 {
494         GTypeDebugFlags gflags;
495         ModestRuntimeDebugFlags mflags;
496         
497         gflags = 0;
498         mflags = modest_runtime_get_debug_flags ();
499
500         if (mflags & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS)
501                 gflags |= G_TYPE_DEBUG_OBJECTS;
502         if (mflags & MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS)
503                 gflags |= G_TYPE_DEBUG_SIGNALS;
504
505         g_type_init_with_debug_flags (gflags);
506 }
507
508 static void
509 init_debug_logging (void)
510 {
511         ModestRuntimeDebugFlags mflags;
512         mflags = modest_runtime_get_debug_flags ();
513         
514         if (mflags & MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING)
515                 g_log_set_always_fatal (G_LOG_LEVEL_ERROR |
516                                         G_LOG_LEVEL_CRITICAL |
517                                         G_LOG_LEVEL_WARNING);
518 }
519
520
521 static void
522 init_i18n (void)
523 {
524         bindtextdomain (GETTEXT_PACKAGE, MODEST_LOCALEDIR);
525         bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
526         textdomain (GETTEXT_PACKAGE);
527
528 }
529
530
531 #if MODEST_PLATFORM_ID==2 
532 static gboolean
533 init_hildon (void)
534 {
535         osso_context_t *osso_context =
536                 osso_initialize(PACKAGE, PACKAGE_VERSION,
537                                 TRUE, NULL);    
538         if (!osso_context) {
539                 g_printerr ("modest: failed to acquire osso context\n");
540                 return FALSE;
541         }
542 }
543 #endif /* MODEST_PLATFORM_ID==2 */
544
545
546 /* 
547  *  This function registers our custom toolbar icons, so they can be
548  *  themed. The idea of this function was taken from the gtk-demo
549  */
550 static void
551 init_stock_icons (void)
552 {
553         static gboolean registered = FALSE;
554   
555         if (!registered) {
556                 GdkPixbuf *pixbuf;
557                 GtkIconFactory *factory;
558                 gint i;
559
560                 static GtkStockItem items[] = {
561                         { MODEST_STOCK_MAIL_SEND, "send mail", 0, 0, NULL },
562                         { MODEST_STOCK_NEW_MAIL, "new mail", 0, 0, NULL },
563                         { MODEST_STOCK_SEND_RECEIVE, "send receive", 0, 0, NULL },
564                         { MODEST_STOCK_REPLY, "reply", 0, 0, NULL },
565                         { MODEST_STOCK_REPLY_ALL, "reply all", 0, 0, NULL },
566                         { MODEST_STOCK_FORWARD, "forward", 0, 0, NULL },
567                         { MODEST_STOCK_DELETE, "delete", 0, 0, NULL },
568                         { MODEST_STOCK_NEXT, "next", 0, 0, NULL },
569                         { MODEST_STOCK_PREV, "prev", 0, 0, NULL },
570 /*                      { MODEST_STOCK_STOP, "stop", 0, 0, NULL } */
571                 };
572       
573                 static gchar *items_names [] = {
574                         MODEST_TOOLBAR_ICON_MAIL_SEND,
575                         MODEST_TOOLBAR_ICON_NEW_MAIL,           
576                         MODEST_TOOLBAR_ICON_SEND_RECEIVE,
577                         MODEST_TOOLBAR_ICON_REPLY,      
578                         MODEST_TOOLBAR_ICON_REPLY_ALL,
579                         MODEST_TOOLBAR_ICON_FORWARD,
580                         MODEST_TOOLBAR_ICON_DELETE,
581                         MODEST_TOOLBAR_ICON_NEXT,
582                         MODEST_TOOLBAR_ICON_PREV,
583 /*                      MODEST_TOOLBAR_ICON_STOP */
584                 };
585
586                 registered = TRUE;
587
588                 /* Register our stock items */
589                 gtk_stock_add (items, G_N_ELEMENTS (items));
590       
591                 /* Add our custom icon factory to the list of defaults */
592                 factory = gtk_icon_factory_new ();
593                 gtk_icon_factory_add_default (factory);
594
595                 /* Register icons to accompany stock items */
596                 for (i = 0; i < G_N_ELEMENTS (items); i++) {
597                         pixbuf = NULL;
598                         pixbuf = gdk_pixbuf_new_from_file (items_names[i], NULL);
599
600                         if (pixbuf != NULL) {
601                                 GtkIconSet *icon_set;
602                                 GdkPixbuf *transparent;
603
604                                 transparent = gdk_pixbuf_add_alpha (pixbuf, TRUE, 0xff, 0xff, 0xff);
605
606                                 icon_set = gtk_icon_set_new_from_pixbuf (transparent);
607                                 gtk_icon_factory_add (factory, items[i].stock_id, icon_set);
608                                 gtk_icon_set_unref (icon_set);
609                                 g_object_unref (pixbuf);
610                                 g_object_unref (transparent);
611                         }
612                         else
613                                 g_warning ("failed to load %s icon", items_names[i]);
614                 }
615                 /* Drop our reference to the factory, GTK will hold a reference. */
616                 g_object_unref (factory);
617         }
618 }