* some cleanups for debugging:
[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         if (_account_store) {
91                 MODEST_DEBUG_VERIFY_OBJECT_LAST_REF(_account_store,"");
92                 g_object_unref(_account_store);
93                 _account_store = NULL;
94         }
95         
96         MODEST_DEBUG_VERIFY_OBJECT_LAST_REF(_singletons,"");
97         g_object_unref(_singletons);
98         _singletons = NULL;
99
100         
101         if (_sig_handlers) {
102                 modest_signal_mgr_disconnect_all_and_destroy (_sig_handlers);
103                 _sig_handlers = NULL;
104         }
105         
106         return TRUE;
107 }
108 /*-----------------------------------------------------------------------------*/
109         
110
111 ModestAccountMgr*
112 modest_runtime_get_account_mgr   (void)
113 {
114         g_return_val_if_fail (_singletons, NULL);
115         return modest_singletons_get_account_mgr (_singletons);
116 }
117
118 ModestEmailClipboard*
119 modest_runtime_get_email_clipboard   (void)
120 {
121         g_return_val_if_fail (_singletons, NULL);
122         return modest_singletons_get_email_clipboard (_singletons);
123 }
124
125 ModestTnyAccountStore*
126 modest_runtime_get_account_store   (void)
127 {
128         // we get the account store here instead of in Singletons
129         // as it leads to various chicken & problems with initialization
130         g_return_val_if_fail (_singletons, NULL);       
131         if (!_account_store) {
132                 _account_store  = modest_tny_account_store_new (modest_runtime_get_account_mgr(),
133                                                                 modest_runtime_get_device());
134                 if (!_account_store) {
135                         g_printerr ("modest: cannot create modest tny account store instance\n");
136                         return NULL;
137                 }
138         }
139         return _account_store;
140 }
141
142 ModestConf*
143 modest_runtime_get_conf (void)
144 {
145         g_return_val_if_fail (_singletons, NULL);
146         return modest_singletons_get_conf (_singletons);
147 }
148
149
150 ModestCacheMgr*
151 modest_runtime_get_cache_mgr (void)
152 {
153         g_return_val_if_fail (_singletons, NULL);
154         return modest_singletons_get_cache_mgr (_singletons);
155 }
156
157
158 ModestMailOperationQueue*
159 modest_runtime_get_mail_operation_queue (void)
160 {
161         g_return_val_if_fail (_singletons, NULL);
162         return modest_singletons_get_mail_operation_queue (_singletons);
163 }
164
165
166
167 TnyDevice*
168 modest_runtime_get_device (void)
169 {
170         g_return_val_if_fail (_singletons, NULL);
171         return modest_singletons_get_device (_singletons);
172 }
173
174
175 TnyPlatformFactory*
176 modest_runtime_get_platform_factory  (void)
177 {
178         g_return_val_if_fail (_singletons, NULL);
179         return modest_singletons_get_platform_factory (_singletons);
180 }
181
182 ModestTnySendQueue*
183 modest_runtime_get_send_queue  (TnyTransportAccount *account)
184 {
185         ModestCacheMgr *cache_mgr;
186         GHashTable     *send_queue_cache;
187         gpointer       orig_key, send_queue;
188         
189         g_return_val_if_fail (_singletons, NULL);
190         g_return_val_if_fail (TNY_IS_TRANSPORT_ACCOUNT(account), NULL);
191
192         cache_mgr = modest_singletons_get_cache_mgr (_singletons);
193         send_queue_cache = modest_cache_mgr_get_cache (cache_mgr,
194                                                        MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
195
196         /* Each modest account has its own send queue.
197          * Note that each modest account will have its own outbox folder, 
198          * returned by TnySendQueue::get_outbox_func().
199          */
200         if (!g_hash_table_lookup_extended (send_queue_cache, account, &orig_key, &send_queue)) {
201                 /* Note that this send queue will start sending messages from its outbox 
202                  * as soon as it is instantiated: */
203                 send_queue = (gpointer)modest_tny_send_queue_new (TNY_CAMEL_TRANSPORT_ACCOUNT(account));
204
205                 _sig_handlers = 
206                         modest_signal_mgr_connect (_sig_handlers, 
207                                                    send_queue, 
208                                                    "error_happened",
209                                                    G_CALLBACK (modest_ui_actions_on_send_queue_error_happened), 
210                                                    NULL);
211
212                 _sig_handlers = 
213                         modest_signal_mgr_connect (_sig_handlers, 
214                                                    send_queue, 
215                                                    "status_changed",
216                                                    G_CALLBACK (modest_ui_actions_on_send_queue_status_changed), 
217                                                    NULL);
218
219
220                 g_hash_table_insert (send_queue_cache, 
221                                      g_object_ref (account), 
222                                      g_object_ref (send_queue));
223         }
224
225         return MODEST_TNY_SEND_QUEUE(send_queue);
226 }
227
228 void modest_runtime_remove_all_send_queues ()
229 {
230         ModestCacheMgr *cache_mgr = modest_singletons_get_cache_mgr (_singletons);
231         
232         modest_cache_mgr_flush (cache_mgr, MODEST_CACHE_MGR_CACHE_TYPE_SEND_QUEUE);
233 }
234
235 ModestWindowMgr *
236 modest_runtime_get_window_mgr (void)
237 {
238         g_return_val_if_fail (_singletons, NULL);
239         return modest_singletons_get_window_mgr (_singletons);
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_OBJECTS },
250                 { "debug-signals",      MODEST_RUNTIME_DEBUG_SIGNALS },
251                 { "factory-settings",   MODEST_RUNTIME_DEBUG_FACTORY_SETTINGS},
252                 { "debug-code",         MODEST_RUNTIME_DEBUG_CODE}
253         };
254         const gchar *str;
255         static ModestRuntimeDebugFlags debug_flags = -1;
256
257         if (debug_flags != -1)
258                 return debug_flags;
259         
260         str = g_getenv (MODEST_DEBUG);
261         
262         if (str != NULL)
263                 debug_flags = g_parse_debug_string (str, debug_keys, G_N_ELEMENTS (debug_keys));
264         else
265                 debug_flags = 0;
266         
267         return debug_flags;
268 }
269
270
271
272