Platform icon changes
[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 /*
64  * defaults for the column headers
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         modest_runtime_verify_object_death (_singletons, "_singletons");
191         
192         return TRUE;
193 }
194
195
196 ModestAccountMgr*
197 modest_runtime_get_account_mgr   (void)
198 {
199         g_return_val_if_fail (_singletons, NULL);
200         return modest_singletons_get_account_mgr (_singletons);
201 }
202
203 ModestTnyAccountStore*
204 modest_runtime_get_account_store   (void)
205 {
206         g_return_val_if_fail (_singletons, NULL);
207         return modest_singletons_get_account_store (_singletons);
208
209 }
210
211 ModestConf*
212 modest_runtime_get_conf (void)
213 {
214         g_return_val_if_fail (_singletons, NULL);
215         return modest_singletons_get_conf (_singletons);
216 }
217
218
219 ModestCacheMgr*
220 modest_runtime_get_cache_mgr (void)
221 {
222         g_return_val_if_fail (_singletons, NULL);
223         return modest_singletons_get_cache_mgr (_singletons);
224 }
225
226
227 ModestMailOperationQueue*
228 modest_runtime_get_mail_operation_queue (void)
229 {
230         g_return_val_if_fail (_singletons, NULL);
231         return modest_singletons_get_mail_operation_queue (_singletons);
232 }
233
234
235
236 TnyDevice*
237 modest_runtime_get_device (void)
238 {
239         g_return_val_if_fail (_singletons, NULL);
240         return modest_singletons_get_device (_singletons);
241 }
242
243
244 TnyPlatformFactory*
245 modest_runtime_get_platform_factory  (void)
246 {
247         g_return_val_if_fail (_singletons, NULL);
248         return modest_singletons_get_platform_factory (_singletons);
249 }
250
251
252
253
254 ModestTnySendQueue*
255 modest_runtime_get_send_queue  (TnyTransportAccount *account)
256 {
257         ModestCacheMgr *cache_mgr;
258         GHashTable     *send_queue_cache;
259         gpointer       orig_key, send_queue;
260         
261         g_return_val_if_fail (_singletons, NULL);
262         g_return_val_if_fail (TNY_IS_TRANSPORT_ACCOUNT(account), NULL);
263
264         cache_mgr = modest_singletons_get_cache_mgr (_singletons);
265         send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
266                                                        MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
267
268         if (!g_hash_table_lookup_extended (send_queue_cache, account, &orig_key, &send_queue)) {
269                 send_queue = (gpointer)modest_tny_send_queue_new (TNY_CAMEL_TRANSPORT_ACCOUNT(account));
270                 g_hash_table_insert (send_queue_cache, account, send_queue);
271         }
272
273         return MODEST_TNY_SEND_QUEUE(send_queue);
274 }
275
276
277
278
279 /* http://primates.ximian.com/~federico/news-2006-04.html#memory-debugging-infrastructure*/
280 ModestRuntimeDebugFlags
281 modest_runtime_get_debug_flags ()
282 {
283         static const GDebugKey debug_keys[] = {
284                 { "abort-on-warning", MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING },
285                 { "log-actions",      MODEST_RUNTIME_DEBUG_LOG_ACTIONS },
286                 { "debug-objects",    MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS },
287                 { "debug-signals",    MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS },
288                 { "factory-settings", MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS }
289         };
290         const gchar *str;
291         static ModestRuntimeDebugFlags debug_flags = -1;
292
293         if (debug_flags != -1)
294                 return debug_flags;
295         
296         str = g_getenv (MODEST_DEBUG);
297         
298         if (str != NULL)
299                 debug_flags = g_parse_debug_string (str, debug_keys, G_N_ELEMENTS (debug_keys));
300         else
301                 debug_flags = 0;
302         
303         return debug_flags;
304 }
305
306
307
308
309
310 /* NOTE: the exact details of this format are important, as they
311  * are also used in modest-widget-memory. FIXME: make a shared function
312  * for this with widget-memory
313  */
314 static gboolean
315 save_header_settings (ModestConf *conf, TnyFolderType type,
316                       ModestHeaderViewStyle style,  const FolderCols* cols,
317                       guint col_num, gboolean overwrite)
318 {
319         int i;
320         gchar *key;
321         GString *str;
322
323         g_return_val_if_fail (cols, FALSE);
324
325         key = _modest_widget_memory_get_keyname_with_double_type ("header-view",
326                                                                   type, style,
327                                                                   MODEST_WIDGET_MEMORY_PARAM_COLUMN_WIDTH);
328         /* if we're not in overwrite mode, only write stuff it
329          * there was nothing before */
330         if (!overwrite &&  modest_conf_key_exists(conf, key, NULL)) {
331                 g_free (key);
332                 return TRUE;
333         }
334
335         /* the format is necessarily the same as the one in modest-widget-memory */
336         str = g_string_new (NULL);
337         for (i = 0; i != col_num; ++i) 
338                 g_string_append_printf (str, "%d:%d ",
339                                         cols[i].col, cols[i].width); 
340
341         modest_conf_set_string (conf, key, str->str, NULL);
342         g_free (key);
343         g_string_free (str, TRUE);
344         
345         return TRUE;
346 }
347
348 /**
349  * modest_init_header_columns:
350  * @overwrite: write the setting, even if it already exists
351  * 
352  * will set defaults for the columns to show for folder,
353  * if there are no such settings yet (in ModestWidgetMemory)
354  * 
355  * Returns: TRUE if succeeded, FALSE in case of error
356  */
357 static gboolean
358 init_header_columns (ModestConf *conf, gboolean overwrite)
359 {
360         int folder_type;
361         
362         for (folder_type = TNY_FOLDER_TYPE_UNKNOWN;
363              folder_type <= TNY_FOLDER_TYPE_CALENDAR; ++folder_type) {          
364                 
365                 switch (folder_type) {
366                 case TNY_FOLDER_TYPE_OUTBOX:
367                 case TNY_FOLDER_TYPE_SENT:
368                 case TNY_FOLDER_TYPE_DRAFTS:
369                 save_header_settings (conf, folder_type,
370                                       MODEST_HEADER_VIEW_STYLE_DETAILS,
371                                       OUTBOX_COLUMNS_DETAILS,
372                                       G_N_ELEMENTS(OUTBOX_COLUMNS_DETAILS),
373                                       overwrite);
374                 save_header_settings (conf, folder_type,
375                                       MODEST_HEADER_VIEW_STYLE_TWOLINES,
376                                       OUTBOX_COLUMNS_TWOLINES,
377                                       G_N_ELEMENTS(OUTBOX_COLUMNS_TWOLINES),
378                                       overwrite);
379                 break;
380
381                 default:
382                 save_header_settings (conf, folder_type,
383                                       MODEST_HEADER_VIEW_STYLE_DETAILS,
384                                       INBOX_COLUMNS_DETAILS,
385                                       G_N_ELEMENTS(INBOX_COLUMNS_DETAILS),
386                                       overwrite);
387                 save_header_settings (conf, folder_type,
388                                       MODEST_HEADER_VIEW_STYLE_TWOLINES,
389                                       INBOX_COLUMNS_TWOLINES,
390                                       G_N_ELEMENTS(INBOX_COLUMNS_TWOLINES),
391                                       overwrite);
392                 };
393         }
394         return TRUE;
395 }
396
397 /**
398  * init_local_folders:
399  * 
400  * create the Local Folders folder under cache, if they
401  * do not exist yet.
402  * 
403  * Returns: TRUE if the folder were already there, or
404  * they were created, FALSE otherwise
405  */
406 static gboolean
407 init_local_folders  (void)
408 {
409         int i;
410         gchar *maildir_path;
411         static const gchar* maildirs[] = {
412                 "cur", "new", "tmp"
413         };
414         
415         maildir_path = modest_local_folder_info_get_maildir_path ();
416
417         for (i = 0; i != G_N_ELEMENTS(LOCAL_FOLDERS); ++i) {
418                 int j;
419                 for (j = 0; j != G_N_ELEMENTS(maildirs); ++j) {
420                         gchar *dir;
421                         dir = g_build_filename (maildir_path,
422                                                 modest_local_folder_info_get_type_name(LOCAL_FOLDERS[i]),
423                                                 maildirs[j],
424                                                 NULL);
425                         if (g_mkdir_with_parents (dir, 0755) < 0) {
426                                 g_printerr ("modest: failed to create %s\n", dir);
427                                 g_free (dir);
428                                 g_free (maildir_path);
429                                 return FALSE;
430                         }
431                         g_free(dir);
432                 }
433         }
434         
435         g_free (maildir_path);
436         return TRUE;
437 }
438
439
440
441 static void
442 free_element (gpointer data, gpointer user_data)
443 {
444         g_free (data);
445 }
446
447
448
449 /**
450  * init_default_account_maybe:
451  *
452  * if there are accounts defined, but there is no default account,
453  * it will be defined.
454  * 
455  * Returns: TRUE if there was a default account already,
456  *  or one has been created or there are no accounts yet,
457  *  returns FALSE in case of error
458  */
459 static gboolean
460 init_default_account_maybe  (ModestAccountMgr *acc_mgr)
461 {
462         GSList *all_accounts = NULL;
463         gchar *default_account;
464         gboolean retval = TRUE;
465         
466         all_accounts = modest_account_mgr_account_names (acc_mgr);
467         if (all_accounts) { /* if there are any accounts, there should be a default one */
468                 default_account = 
469                         modest_account_mgr_get_default_account (acc_mgr);
470                 if (!default_account) {
471                         gchar *first_account;
472                         g_printerr ("modest: no default account defined\n");
473                         first_account = (gchar*)all_accounts->data;
474                         if ((retval = modest_account_mgr_set_default_account (acc_mgr, first_account)))
475                                 g_printerr ("modest: set '%s' as the default account\n",
476                                             first_account);
477                         else
478                                 g_printerr ("modest: failed to set '%s' as the default account\n",
479                                             first_account);
480                         g_free (default_account);
481                 }
482                 g_slist_foreach (all_accounts, free_element, NULL);
483                 g_slist_free    (all_accounts);
484         }
485         return retval;
486 }
487
488
489
490 static void
491 init_debug_g_type (void)
492 {
493         GTypeDebugFlags gflags;
494         ModestRuntimeDebugFlags mflags;
495         
496         gflags = 0;
497         mflags = modest_runtime_get_debug_flags ();
498
499         if (mflags & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS)
500                 gflags |= G_TYPE_DEBUG_OBJECTS;
501         if (mflags & MODEST_RUNTIME_DEBUG_DEBUG_SIGNALS)
502                 gflags |= G_TYPE_DEBUG_SIGNALS;
503
504         g_type_init_with_debug_flags (gflags);
505 }
506
507 static void
508 init_debug_logging (void)
509 {
510         ModestRuntimeDebugFlags mflags;
511         mflags = modest_runtime_get_debug_flags ();
512         
513         if (mflags & MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING)
514                 g_log_set_always_fatal (G_LOG_LEVEL_ERROR |
515                                         G_LOG_LEVEL_CRITICAL |
516                                         G_LOG_LEVEL_WARNING);
517 }
518
519
520 static void
521 init_i18n (void)
522 {
523         bindtextdomain (GETTEXT_PACKAGE, MODEST_LOCALEDIR);
524         bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
525         textdomain (GETTEXT_PACKAGE);
526
527 }
528
529
530 #if MODEST_PLATFORM_ID==2 
531 static gboolean
532 init_hildon (void)
533 {
534         osso_context_t *osso_context =
535                 osso_initialize(PACKAGE, PACKAGE_VERSION,
536                                 TRUE, NULL);    
537         if (!osso_context) {
538                 g_printerr ("modest: failed to acquire osso context\n");
539                 return FALSE;
540         }
541 }
542 #endif /* MODEST_PLATFORM_ID==2 */
543
544
545 /* 
546  *  This function registers our custom toolbar icons, so they can be
547  *  themed. The idea of this function was taken from the gtk-demo
548  */
549 static void
550 init_stock_icons (void)
551 {
552         static gboolean registered = FALSE;
553   
554         if (!registered) {
555                 GdkPixbuf *pixbuf;
556                 GtkIconFactory *factory;
557                 gint i;
558
559                 static GtkStockItem items[] = {
560                         { MODEST_STOCK_MAIL_SEND, "send mail", 0, 0, NULL },
561                         { MODEST_STOCK_NEW_MAIL, "new mail", 0, 0, NULL },
562 /*                      { MODEST_STOCK_SEND_RECEIVE, "send receive", 0, 0, NULL }, */
563                         { MODEST_STOCK_REPLY, "reply", 0, 0, NULL },
564                         { MODEST_STOCK_REPLY_ALL, "reply all", 0, 0, NULL },
565                         { MODEST_STOCK_FORWARD, "forward", 0, 0, NULL },
566 /*                      { MODEST_STOCK_DELETE, "delete", 0, 0, NULL }, */
567 /*                      { MODEST_STOCK_NEXT, "next", 0, 0, NULL }, */
568 /*                      { MODEST_STOCK_PREV, "prev", 0, 0, NULL }, */
569 /*                      { MODEST_STOCK_STOP, "stop", 0, 0, NULL } */
570                 };
571       
572                 static gchar *items_names [] = {
573                         MODEST_TOOLBAR_ICON_MAIL_SEND,
574                         MODEST_TOOLBAR_ICON_NEW_MAIL,
575 /*                      MODEST_TOOLBAR_ICON_SEND_RECEIVE, */
576                         MODEST_TOOLBAR_ICON_REPLY,      
577                         MODEST_TOOLBAR_ICON_REPLY_ALL,
578                         MODEST_TOOLBAR_ICON_FORWARD,
579 /*                      MODEST_TOOLBAR_ICON_DELETE, */
580 /*                      MODEST_TOOLBAR_ICON_NEXT, */
581 /*                      MODEST_TOOLBAR_ICON_PREV, */
582 /*                      MODEST_TOOLBAR_ICON_STOP */
583                 };
584
585                 registered = TRUE;
586
587                 /* Register our stock items */
588                 gtk_stock_add (items, G_N_ELEMENTS (items));
589       
590                 /* Add our custom icon factory to the list of defaults */
591                 factory = gtk_icon_factory_new ();
592                 gtk_icon_factory_add_default (factory);
593
594                 /* Register icons to accompany stock items */
595                 for (i = 0; i < G_N_ELEMENTS (items); i++) {
596                         pixbuf = NULL;
597                         pixbuf = gdk_pixbuf_new_from_file (items_names[i], NULL);
598
599                         if (pixbuf != NULL) {
600                                 GtkIconSet *icon_set;
601                                 GdkPixbuf *transparent;
602
603                                 transparent = gdk_pixbuf_add_alpha (pixbuf, TRUE, 0xff, 0xff, 0xff);
604
605                                 icon_set = gtk_icon_set_new_from_pixbuf (transparent);
606                                 gtk_icon_factory_add (factory, items[i].stock_id, icon_set);
607                                 gtk_icon_set_unref (icon_set);
608                                 g_object_unref (pixbuf);
609                                 g_object_unref (transparent);
610                         }
611                         else
612                                 g_warning ("failed to load %s icon", items_names[i]);
613                 }
614                 /* Drop our reference to the factory, GTK will hold a reference. */
615                 g_object_unref (factory);
616         }
617 }