* Merged patch for bug 84605 from PE2 branch
[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-runtime-priv.h>
36 #include <modest-defs.h>
37 #include <modest-singletons.h>
38 #include <widgets/modest-header-view.h>
39 #include <widgets/modest-folder-view.h>
40 #include <modest-tny-platform-factory.h>
41 #include <modest-platform.h>
42 #include <modest-widget-memory.h>
43 #include <modest-widget-memory-priv.h>
44 #include <modest-local-folder-info.h>
45 #include <modest-account-mgr.h>
46 #include <modest-account-mgr-helpers.h>
47 #include <modest-icon-names.h>
48 #include <modest-ui-actions.h>
49 #include <modest-debug.h>
50
51 static ModestSingletons       *_singletons    = NULL;
52
53 // we get the account store here instead of in Singletons
54 // as it leads to various chicken & problems with initialization
55 static ModestTnyAccountStore  *_account_store  = NULL;
56
57 /* Signal handlers for the send queues */
58 static GSList *_sig_handlers = NULL;
59
60 /*
61  * private functions declared in modest-runtime-priv.h -
62  * only to be called from modest-init.c 
63  */
64 /*-----------------------------------------------------------------------------*/
65 gboolean
66 modest_runtime_init (void)
67 {
68         if (_singletons) {
69                 g_printerr ("modest: modest_runtime_init can only be run once\n");
70                 return FALSE;
71         }
72         
73         _singletons = modest_singletons_new ();
74         if (!_singletons) {
75                 g_printerr ("modest: failed to create singletons\n");
76                 return FALSE;
77         }
78         
79         return TRUE;
80 }
81
82 gboolean
83 modest_runtime_uninit (void)
84 {
85         if (!_singletons)
86                 return TRUE;    /* uninit maybe called if runtime_init failed */
87         
88         g_return_val_if_fail (MODEST_IS_SINGLETONS(_singletons), FALSE);
89         
90         g_debug ("%s: cleaning up", __FUNCTION__);
91
92         MODEST_DEBUG_VERIFY_OBJECT_LAST_REF(_singletons,"");
93         g_object_unref(_singletons);
94         _singletons = NULL;
95
96         g_debug ("%s: cleaned up singletons", __FUNCTION__);
97
98         if (_account_store) {
99                 MODEST_DEBUG_VERIFY_OBJECT_LAST_REF(_account_store,"");
100                 g_object_unref(_account_store);
101                 _account_store = NULL;
102         }
103
104         g_debug ("%s: cleaned up the account store", __FUNCTION__);
105
106         
107         if (_sig_handlers) {
108                 modest_signal_mgr_disconnect_all_and_destroy (_sig_handlers);
109                 _sig_handlers = NULL;
110         }
111
112         g_debug ("%s: all cleaned up", __FUNCTION__);
113
114         
115         return TRUE;
116 }
117 /*-----------------------------------------------------------------------------*/
118         
119
120 ModestAccountMgr*
121 modest_runtime_get_account_mgr   (void)
122 {
123         g_return_val_if_fail (_singletons, NULL);
124         return modest_singletons_get_account_mgr (_singletons);
125 }
126
127 ModestEmailClipboard*
128 modest_runtime_get_email_clipboard   (void)
129 {
130         g_return_val_if_fail (_singletons, NULL);
131         return modest_singletons_get_email_clipboard (_singletons);
132 }
133
134 ModestTnyAccountStore*
135 modest_runtime_get_account_store   (void)
136 {
137         // we get the account store here instead of in Singletons
138         // as it leads to various chicken & problems with initialization
139         g_return_val_if_fail (_singletons, NULL);       
140         if (!_account_store) {
141                 _account_store  = modest_tny_account_store_new (modest_runtime_get_account_mgr(),
142                                                                 modest_runtime_get_device());
143                 if (!_account_store) {
144                         g_printerr ("modest: cannot create modest tny account store instance\n");
145                         return NULL;
146                 }
147         }
148         return _account_store;
149 }
150
151 ModestConf*
152 modest_runtime_get_conf (void)
153 {
154         g_return_val_if_fail (_singletons, NULL);
155         return modest_singletons_get_conf (_singletons);
156 }
157
158
159 ModestCacheMgr*
160 modest_runtime_get_cache_mgr (void)
161 {
162         g_return_val_if_fail (_singletons, NULL);
163         return modest_singletons_get_cache_mgr (_singletons);
164 }
165
166
167 ModestMailOperationQueue*
168 modest_runtime_get_mail_operation_queue (void)
169 {
170         g_return_val_if_fail (_singletons, NULL);
171         return modest_singletons_get_mail_operation_queue (_singletons);
172 }
173
174
175
176 TnyDevice*
177 modest_runtime_get_device (void)
178 {
179         g_return_val_if_fail (_singletons, NULL);
180         return modest_singletons_get_device (_singletons);
181 }
182
183
184 TnyPlatformFactory*
185 modest_runtime_get_platform_factory  (void)
186 {
187         g_return_val_if_fail (_singletons, NULL);
188         return modest_singletons_get_platform_factory (_singletons);
189 }
190
191 ModestTnySendQueue*
192 modest_runtime_get_send_queue  (TnyTransportAccount *account,
193                                 gboolean create)
194 {
195         ModestCacheMgr *cache_mgr;
196         GHashTable     *send_queue_cache;
197         gpointer       orig_key = NULL, send_queue = NULL;
198         
199         g_return_val_if_fail (_singletons, NULL);
200         g_return_val_if_fail (TNY_IS_TRANSPORT_ACCOUNT(account), NULL);
201
202         cache_mgr = modest_singletons_get_cache_mgr (_singletons);
203         send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
204                                                        MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
205
206         /* Each modest account has its own send queue.
207          * Note that each modest account will have its own outbox folder, 
208          * returned by TnySendQueue::get_outbox_func().
209          */
210         if (!g_hash_table_lookup_extended (send_queue_cache, account, &orig_key, &send_queue) &&
211             create) {
212                 /* Note that this send queue will start sending messages from its outbox 
213                  * as soon as it is instantiated: */
214                 send_queue = modest_tny_send_queue_new (TNY_CAMEL_TRANSPORT_ACCOUNT(account));
215
216                 if (send_queue) {
217                         _sig_handlers = 
218                                 modest_signal_mgr_connect (_sig_handlers, 
219                                                            send_queue, 
220                                                            "error_happened",
221                                                            G_CALLBACK (modest_ui_actions_on_send_queue_error_happened), 
222                                                            NULL);
223
224                         _sig_handlers = 
225                                 modest_signal_mgr_connect (_sig_handlers, 
226                                                            send_queue, 
227                                                            "status_changed",
228                                                            G_CALLBACK (modest_ui_actions_on_send_queue_status_changed), 
229                                                            NULL);
230
231                         g_hash_table_insert (send_queue_cache, 
232                                              g_object_ref (account), 
233                                              g_object_ref (send_queue));
234                 }
235         }
236
237         return (send_queue) ? MODEST_TNY_SEND_QUEUE(send_queue) : NULL;
238 }
239
240 void modest_runtime_remove_all_send_queues ()
241 {
242         ModestCacheMgr *cache_mgr = modest_singletons_get_cache_mgr (_singletons);
243         
244         modest_cache_mgr_flush (cache_mgr, MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
245 }
246
247 void 
248 modest_runtime_remove_send_queue (TnyTransportAccount *account)
249 {
250
251         ModestCacheMgr *cache_mgr;
252         GHashTable     *send_queue_cache;
253
254         g_return_if_fail (TNY_IS_TRANSPORT_ACCOUNT (account));  
255         g_return_if_fail (_singletons);
256
257         cache_mgr = modest_singletons_get_cache_mgr (_singletons);
258         send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
259                                                        MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE); 
260
261         if (g_hash_table_lookup (send_queue_cache, account))
262                 g_hash_table_remove (send_queue_cache, account);
263 }
264
265 ModestWindowMgr *
266 modest_runtime_get_window_mgr (void)
267 {
268         g_return_val_if_fail (_singletons, NULL);
269         return modest_singletons_get_window_mgr (_singletons);
270 }
271
272 /* http://primates.ximian.com/~federico/news-2006-04.html#memory-debugging-infrastructure*/
273 ModestRuntimeDebugFlags
274 modest_runtime_get_debug_flags ()
275 {
276         static const GDebugKey debug_keys[] = {
277                 { "abort-on-warning",   MODEST_RUNTIME_DEBUG_ABORT_ON_WARNING },
278                 { "log-actions",        MODEST_RUNTIME_DEBUG_LOG_ACTIONS },
279                 { "debug-objects",      MODEST_RUNTIME_DEBUG_OBJECTS },
280                 { "debug-signals",      MODEST_RUNTIME_DEBUG_SIGNALS },
281                 { "factory-settings",   MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS},
282                 { "debug-code",         MODEST_RUNTIME_DEBUG_CODE}
283         };
284         const gchar *str;
285         static ModestRuntimeDebugFlags debug_flags = -1;
286
287         if (debug_flags != -1)
288                 return debug_flags;
289         
290         str = g_getenv (MODEST_DEBUG);
291         
292         if (str != NULL)
293                 debug_flags = g_parse_debug_string (str, debug_keys, G_N_ELEMENTS (debug_keys));
294         else
295                 debug_flags = 0;
296         
297         return debug_flags;
298 }
299
300
301
302