1 /* Copyright (c) 2006, Nokia Corporation
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
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.
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.
31 #include <glib/gi18n.h>
33 #include <tny-account.h>
34 #include <tny-account-store.h>
35 #include <tny-store-account.h>
36 #include <tny-transport-account.h>
37 #include <tny-simple-list.h>
38 #include <tny-account-store.h>
39 #include <tny-camel-transport-account.h>
40 #include <tny-camel-imap-store-account.h>
41 #include <tny-camel-pop-store-account.h>
42 #include <modest-runtime.h>
43 #include <modest-marshal.h>
44 #include <modest-protocol-info.h>
45 #include <modest-local-folder-info.h>
46 #include <modest-tny-account.h>
47 #include <modest-account-mgr.h>
48 #include <modest-account-mgr-helpers.h>
50 #include "modest-tny-account-store.h"
51 #include "modest-tny-platform-factory.h"
52 #include <tny-gtk-lockable.h>
53 #include <camel/camel.h>
55 /* 'private'/'protected' functions */
56 static void modest_tny_account_store_class_init (ModestTnyAccountStoreClass *klass);
57 //static void modest_tny_account_store_init (ModestTnyAccountStore *obj);
58 static void modest_tny_account_store_finalize (GObject *obj);
60 /* implementations for tny-account-store-iface */
61 static void modest_tny_account_store_instance_init (ModestTnyAccountStore *obj);
62 static void modest_tny_account_store_init (gpointer g, gpointer iface_data);
67 ACCOUNT_UPDATE_SIGNAL,
68 PASSWORD_REQUESTED_SIGNAL,
72 typedef struct _ModestTnyAccountStorePrivate ModestTnyAccountStorePrivate;
73 struct _ModestTnyAccountStorePrivate {
75 GHashTable *password_hash;
76 ModestAccountMgr *account_mgr;
77 TnySessionCamel *session;
80 /* we cache them here */
81 GSList *store_accounts;
82 GSList *transport_accounts;
85 #define MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
86 MODEST_TYPE_TNY_ACCOUNT_STORE, \
87 ModestTnyAccountStorePrivate))
90 static GObjectClass *parent_class = NULL;
92 static guint signals[LAST_SIGNAL] = {0};
95 modest_tny_account_store_get_type (void)
97 static GType my_type = 0;
100 static const GTypeInfo my_info = {
101 sizeof(ModestTnyAccountStoreClass),
102 NULL, /* base init */
103 NULL, /* base finalize */
104 (GClassInitFunc) modest_tny_account_store_class_init,
105 NULL, /* class finalize */
106 NULL, /* class data */
107 sizeof(ModestTnyAccountStore),
109 (GInstanceInitFunc) modest_tny_account_store_instance_init,
113 static const GInterfaceInfo iface_info = {
114 (GInterfaceInitFunc) modest_tny_account_store_init,
115 NULL, /* interface_finalize */
116 NULL /* interface_data */
119 my_type = g_type_register_static (G_TYPE_OBJECT,
120 "ModestTnyAccountStore",
122 g_type_add_interface_static (my_type, TNY_TYPE_ACCOUNT_STORE,
129 modest_tny_account_store_class_init (ModestTnyAccountStoreClass *klass)
131 GObjectClass *gobject_class;
132 gobject_class = (GObjectClass*) klass;
134 parent_class = g_type_class_peek_parent (klass);
135 gobject_class->finalize = modest_tny_account_store_finalize;
137 g_type_class_add_private (gobject_class,
138 sizeof(ModestTnyAccountStorePrivate));
140 signals[ACCOUNT_UPDATE_SIGNAL] =
141 g_signal_new ("account_update",
142 G_TYPE_FROM_CLASS (gobject_class),
144 G_STRUCT_OFFSET(ModestTnyAccountStoreClass, account_update),
146 g_cclosure_marshal_VOID__STRING,
147 G_TYPE_NONE, 1, G_TYPE_STRING);
149 signals[PASSWORD_REQUESTED_SIGNAL] =
150 g_signal_new ("password_requested",
151 G_TYPE_FROM_CLASS (gobject_class),
153 G_STRUCT_OFFSET(ModestTnyAccountStoreClass, password_requested),
155 modest_marshal_VOID__STRING_POINTER_POINTER_POINTER,
156 G_TYPE_NONE, 4, G_TYPE_STRING, G_TYPE_POINTER, G_TYPE_POINTER,
162 modest_tny_account_store_instance_init (ModestTnyAccountStore *obj)
164 ModestTnyAccountStorePrivate *priv =
165 MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
167 priv->cache_dir = NULL;
168 priv->account_mgr = NULL;
169 priv->session = NULL;
172 priv->password_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
179 account_list_free (GSList *accounts)
181 GSList *cursor = accounts;
184 g_object_unref (G_OBJECT(cursor->data));
185 if (G_IS_OBJECT(cursor->data)) { /* check twice... */
186 const gchar *id = tny_account_get_id(TNY_ACCOUNT(cursor->data));
187 modest_runtime_verify_object_death(cursor->data,id);
189 cursor = cursor->next;
191 g_slist_free (accounts);
196 on_account_removed (ModestAccountMgr *acc_mgr, const gchar *account, gboolean server_account,
199 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(user_data);
200 ModestTnyAccountStorePrivate *priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
202 /* FIXME: make this more finegrained; changes do not really affect _all_
203 * accounts, and some do not affect tny accounts at all (such as 'last_update')
207 account_list_free (priv->store_accounts);
208 priv->store_accounts = NULL;
210 account_list_free (priv->transport_accounts);
211 priv->transport_accounts = NULL;
213 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_UPDATE_SIGNAL], 0,
219 on_account_changed (ModestAccountMgr *acc_mgr, const gchar *account, gboolean server_account,
220 const gchar *key, gpointer user_data)
222 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(user_data);
223 ModestTnyAccountStorePrivate *priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
225 /* FIXME: make this more finegrained; changes do not really affect _all_
226 * accounts, and some do not affect tny accounts at all (such as 'last_update')
228 account_list_free (priv->store_accounts);
229 priv->store_accounts = NULL;
231 account_list_free (priv->transport_accounts);
232 priv->transport_accounts = NULL;
234 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_UPDATE_SIGNAL], 0,
239 static ModestTnyAccountStore*
240 get_account_store_for_account (TnyAccount *account)
242 return MODEST_TNY_ACCOUNT_STORE(g_object_get_data (G_OBJECT(account),
247 get_password (TnyAccount *account, const gchar *prompt, gboolean *cancel)
250 const TnyAccountStore *account_store;
251 ModestTnyAccountStore *self;
252 ModestTnyAccountStorePrivate *priv;
255 gboolean already_asked;
257 key = tny_account_get_id (account);
258 account_store = TNY_ACCOUNT_STORE(get_account_store_for_account (account));
260 self = MODEST_TNY_ACCOUNT_STORE (account_store);
261 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
263 /* is it in the hash? if it's already there, it must be wrong... */
264 pwd_ptr = (gpointer)&pwd; /* pwd_ptr so the compiler does not complained about
265 * type-punned ptrs...*/
266 already_asked = g_hash_table_lookup_extended (priv->password_hash,
269 (gpointer*)&pwd_ptr);
271 /* if the password is not already there, try ModestConf */
272 if (!already_asked) {
273 pwd = modest_account_mgr_get_string (priv->account_mgr,
274 key, MODEST_ACCOUNT_PASSWORD,TRUE);
275 g_hash_table_insert (priv->password_hash, g_strdup (key), g_strdup (pwd));
278 /* if it was already asked, it must have been wrong, so ask again */
279 if (already_asked || !pwd || strlen(pwd) == 0) {
281 /* we don't have it yet. Get the password from the user */
282 const gchar* name = tny_account_get_name (account);
283 gboolean remember = FALSE;
286 g_signal_emit (G_OBJECT(self), signals[PASSWORD_REQUESTED_SIGNAL], 0,
287 name, &pwd, cancel, &remember);
291 modest_account_mgr_set_string (priv->account_mgr,key,
292 MODEST_ACCOUNT_PASSWORD,
294 /* We need to dup the string even knowing that
295 it's already a dup of the contents of an
296 entry, because it if it's wrong, then camel
298 g_hash_table_insert (priv->password_hash, g_strdup (key), g_strdup(pwd));
300 g_hash_table_remove (priv->password_hash, key);
312 forget_password (TnyAccount *account)
314 ModestTnyAccountStore *self;
315 ModestTnyAccountStorePrivate *priv;
316 const TnyAccountStore *account_store;
320 account_store = TNY_ACCOUNT_STORE(get_account_store_for_account (account));
321 self = MODEST_TNY_ACCOUNT_STORE (account_store);
322 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
323 key = tny_account_get_id (account);
325 /* Do not remove the key, this will allow us to detect that we
326 have already asked for it at least once */
327 pwd = g_hash_table_lookup (priv->password_hash, key);
329 memset (pwd, 0, strlen (pwd));
330 g_hash_table_insert (priv->password_hash, g_strdup (key), NULL);
333 /* Remove from configuration system */
334 modest_account_mgr_unset (priv->account_mgr,
335 key, MODEST_ACCOUNT_PASSWORD, TRUE);
340 modest_tny_account_store_finalize (GObject *obj)
342 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(obj);
343 ModestTnyAccountStorePrivate *priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
345 gboolean debug = modest_runtime_get_debug_flags() & MODEST_RUNTIME_DEBUG_DEBUG_OBJECTS;
347 g_free (priv->cache_dir);
348 priv->cache_dir = NULL;
350 if (priv->password_hash) {
351 g_hash_table_destroy (priv->password_hash);
352 priv->password_hash = NULL;
355 if (priv->account_mgr) {
356 g_object_unref (G_OBJECT(priv->account_mgr));
357 priv->account_mgr = NULL;
361 g_object_unref (G_OBJECT(priv->device));
365 /* this includes the local folder */
366 account_list_free (priv->store_accounts);
367 priv->store_accounts = NULL;
369 account_list_free (priv->transport_accounts);
370 priv->transport_accounts = NULL;
373 camel_object_unref (CAMEL_OBJECT(priv->session));
374 if (debug && CAMEL_IS_OBJECT(priv->session))
375 g_warning ("%s:%d: TnyCamelSession still holds a refcount of %d",
376 __FILE__,__LINE__,CAMEL_OBJECT(priv->session)->ref_count);
377 priv->session = NULL;
380 G_OBJECT_CLASS(parent_class)->finalize (obj);
384 ModestTnyAccountStore*
385 modest_tny_account_store_new (ModestAccountMgr *account_mgr, TnyDevice *device) {
388 ModestTnyAccountStorePrivate *priv;
391 g_return_val_if_fail (account_mgr, NULL);
392 g_return_val_if_fail (device, NULL);
394 obj = G_OBJECT(g_object_new(MODEST_TYPE_TNY_ACCOUNT_STORE, NULL));
395 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
397 priv->account_mgr = account_mgr;
398 g_object_ref (G_OBJECT(priv->account_mgr));
400 priv->device = device;
401 g_object_ref (priv->device);
403 priv->session = tny_session_camel_new (TNY_ACCOUNT_STORE(obj));
405 tny_session_camel_set_ui_locker (priv->session, tny_gtk_lockable_new ());
406 /* FIXME: unref this in the end? */
407 tny_session_camel_set_async_connecting (priv->session, TRUE);
409 /* force a cache fill... ugly */
410 list = TNY_LIST(tny_simple_list_new());
411 tny_account_store_get_accounts (TNY_ACCOUNT_STORE(obj), list,
412 TNY_ACCOUNT_STORE_BOTH);
413 g_object_unref(list);
415 /* Connect signals */
416 g_signal_connect (G_OBJECT(account_mgr), "account_changed",
417 G_CALLBACK (on_account_changed), obj);
418 g_signal_connect (G_OBJECT(account_mgr), "account_removed",
419 G_CALLBACK (on_account_removed), obj);
421 return MODEST_TNY_ACCOUNT_STORE(obj);
426 get_cached_accounts (TnyAccountStore *self, TnyList *list, TnyAccountType type)
428 ModestTnyAccountStorePrivate *priv;
429 GSList *accounts, *cursor;
431 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
432 accounts = (type == TNY_ACCOUNT_TYPE_STORE ? priv->store_accounts : priv->transport_accounts);
436 tny_list_prepend (list, G_OBJECT(cursor->data));
437 cursor = cursor->next;
443 /* this function fills the TnyList, and also returns a GSList of the accounts,
444 * for caching purposes
447 get_accounts (TnyAccountStore *self, TnyList *list, TnyAccountType type)
449 ModestTnyAccountStorePrivate *priv;
450 GSList *account_names, *cursor;
451 GSList *accounts = NULL;
453 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
455 account_names = modest_account_mgr_account_names (priv->account_mgr);
457 for (cursor = account_names; cursor; cursor = cursor->next) {
459 gchar *account_name = (gchar*)cursor->data;
461 /* only return enabled accounts */
462 if (modest_account_mgr_get_enabled(priv->account_mgr, account_name)) {
463 TnyAccount *tny_account =
464 modest_tny_account_new_from_account (priv->account_mgr,
469 if (tny_account) { /* something went wrong */
470 g_object_set_data (G_OBJECT(tny_account), "account_store",
472 tny_list_prepend (list, G_OBJECT(tny_account));
473 accounts = g_slist_append (accounts, tny_account); /* cache it */
475 g_printerr ("modest: failed to create account for %s\n",
478 g_free (account_name);
480 g_slist_free (account_names);
482 /* also, add the local folder pseudo-account */
483 if (type == TNY_ACCOUNT_TYPE_STORE) {
484 TnyAccount *tny_account =
485 modest_tny_account_new_for_local_folders (priv->account_mgr, priv->session);
486 tny_list_prepend (list, G_OBJECT(tny_account));
487 accounts = g_slist_append (accounts, tny_account); /* cache it */
494 modest_tny_account_store_get_accounts (TnyAccountStore *self, TnyList *list,
495 TnyGetAccountsRequestType request_type)
497 ModestTnyAccountStorePrivate *priv;
499 g_return_if_fail (self);
500 g_return_if_fail (TNY_IS_LIST(list));
502 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
504 if (request_type == TNY_ACCOUNT_STORE_BOTH) {
505 modest_tny_account_store_get_accounts (self, list,
506 TNY_ACCOUNT_STORE_STORE_ACCOUNTS);
507 modest_tny_account_store_get_accounts (self, list,
508 TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
512 if (request_type == TNY_ACCOUNT_STORE_STORE_ACCOUNTS) {
514 if (!priv->store_accounts)
515 priv->store_accounts = get_accounts (self, list, TNY_ACCOUNT_TYPE_STORE);
517 get_cached_accounts (self, list, TNY_ACCOUNT_TYPE_STORE);
519 } else if (request_type == TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS) {
521 if (!priv->transport_accounts)
522 priv->transport_accounts =
523 get_accounts (self, list, TNY_ACCOUNT_TYPE_TRANSPORT);
525 get_cached_accounts (self, list, TNY_ACCOUNT_TYPE_TRANSPORT);
527 g_return_if_reached (); /* incorrect req type */
532 modest_tny_account_store_get_cache_dir (TnyAccountStore *self)
534 ModestTnyAccountStorePrivate *priv;
535 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
537 if (!priv->cache_dir)
538 priv->cache_dir = g_build_filename (g_get_home_dir(),
539 MODEST_DIR, MODEST_CACHE_DIR, NULL);
540 return priv->cache_dir;
545 * callers need to unref
548 modest_tny_account_store_get_device (TnyAccountStore *self)
550 ModestTnyAccountStorePrivate *priv;
552 g_return_val_if_fail (self, NULL);
554 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
557 return g_object_ref (G_OBJECT(priv->device));
565 modest_tny_account_store_alert (TnyAccountStore *self, TnyAlertType type,
568 GtkMessageType gtktype;
569 gboolean retval = FALSE;
574 case TNY_ALERT_TYPE_INFO:
575 gtktype = GTK_MESSAGE_INFO;
577 case TNY_ALERT_TYPE_WARNING:
578 gtktype = GTK_MESSAGE_WARNING;
580 case TNY_ALERT_TYPE_ERROR:
582 gtktype = GTK_MESSAGE_ERROR;
586 dialog = gtk_message_dialog_new (NULL, GTK_DIALOG_MODAL,
587 gtktype, GTK_BUTTONS_YES_NO, prompt);
589 if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_YES)
592 gtk_widget_destroy (dialog);
600 modest_tny_account_store_add_store_account (TnyAccountStore *self,
601 TnyStoreAccount *account)
603 /* we should not need this...*/
604 g_printerr ("modest: add_store_account_func not implemented\n");
609 modest_tny_account_store_add_transport_account (TnyAccountStore *self,
610 TnyTransportAccount *account)
612 /* we should not need this...*/
613 g_printerr ("modest: add_transport_account_func not implemented\n");
619 modest_tny_account_store_init (gpointer g, gpointer iface_data)
621 TnyAccountStoreIface *klass;
623 g_return_if_fail (g);
625 klass = (TnyAccountStoreIface *)g;
627 klass->get_accounts_func =
628 modest_tny_account_store_get_accounts;
629 klass->add_transport_account_func =
630 modest_tny_account_store_add_transport_account;
631 klass->add_store_account_func =
632 modest_tny_account_store_add_store_account;
633 klass->get_cache_dir_func =
634 modest_tny_account_store_get_cache_dir;
635 klass->get_device_func =
636 modest_tny_account_store_get_device;
638 modest_tny_account_store_alert;
642 modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *self,
643 ModestTnyGetPassFunc func)
645 /* not implemented, we use signals */
646 g_printerr ("modest: set_get_pass_func not implemented\n");
650 tny_account_store_get_session (TnyAccountStore *self)
652 g_return_val_if_fail (self, NULL);
653 return MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE (self)->session;
658 modest_tny_account_store_get_tny_account_by_id (ModestTnyAccountStore *self, const gchar *id)
660 TnyAccount *account = NULL;
661 ModestTnyAccountStorePrivate *priv;
664 g_return_val_if_fail (self, NULL);
665 g_return_val_if_fail (id, NULL);
667 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
669 for (cursor = priv->store_accounts; cursor ; cursor = cursor->next) {
670 const gchar *acc_id = tny_account_get_id (TNY_ACCOUNT(cursor->data));
671 if (acc_id && strcmp (acc_id, id) == 0) {
672 account = TNY_ACCOUNT(cursor->data);
677 /* if we already found something, no need to search the transport accounts */
678 for (cursor = priv->transport_accounts; !account && cursor ; cursor = cursor->next) {
679 const gchar *acc_id = tny_account_get_id (TNY_ACCOUNT(cursor->data));
680 if (acc_id && strcmp (acc_id, id) == 0) {
681 account = TNY_ACCOUNT(cursor->data);
687 g_object_ref (G_OBJECT(account));
694 modest_tny_account_store_get_tny_account_by_account (ModestTnyAccountStore *self,
695 const gchar *account_name,
698 TnyAccount *account = NULL;
699 ModestAccountData *account_data;
700 const gchar *id = NULL;
701 ModestTnyAccountStorePrivate *priv;
703 g_return_val_if_fail (self, NULL);
704 g_return_val_if_fail (account_name, NULL);
705 g_return_val_if_fail (type == TNY_ACCOUNT_TYPE_STORE || type == TNY_ACCOUNT_TYPE_TRANSPORT,
708 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
710 account_data = modest_account_mgr_get_account_data (priv->account_mgr, account_name);
712 g_printerr ("modest: cannot get account data for account '%s'\n", account_name);
716 if (type == TNY_ACCOUNT_TYPE_STORE && account_data->store_account)
717 id = account_data->store_account->account_name;
718 else if (account_data->transport_account)
719 id = account_data->transport_account->account_name;
722 account = modest_tny_account_store_get_tny_account_by_id (self, id);
724 g_printerr ("modest: could not get tny %s account for %s (id=%s)\n",
725 type == TNY_ACCOUNT_TYPE_STORE? "store" : "transport",
726 account_name, id ? id : "<none>");
728 modest_account_mgr_free_account_data (priv->account_mgr, account_data);