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-device.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-marshal.h>
43 #include <modest-protocol-info.h>
44 #include <modest-local-folder-info.h>
46 #include <modest-account-mgr.h>
47 #include <modest-account-mgr-helpers.h>
49 #include "modest-tny-account-store.h"
50 #include "modest-tny-platform-factory.h"
51 #include <tny-gtk-lockable.h>
52 #include <camel/camel.h>
54 /* 'private'/'protected' functions */
55 static void modest_tny_account_store_class_init (ModestTnyAccountStoreClass *klass);
56 //static void modest_tny_account_store_init (ModestTnyAccountStore *obj);
57 static void modest_tny_account_store_finalize (GObject *obj);
59 /* implementations for tny-account-store-iface */
60 static void modest_tny_account_store_instance_init (ModestTnyAccountStore *obj);
61 static void modest_tny_account_store_init (gpointer g, gpointer iface_data);
66 ACCOUNT_UPDATE_SIGNAL,
70 typedef struct _ModestTnyAccountStorePrivate ModestTnyAccountStorePrivate;
71 struct _ModestTnyAccountStorePrivate {
75 GHashTable *password_hash;
77 TnyPlatformFactory *platform_fact;
78 TnySessionCamel *tny_session_camel;
81 #define MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
82 MODEST_TYPE_TNY_ACCOUNT_STORE, \
83 ModestTnyAccountStorePrivate))
85 static void on_password_requested (ModestTnyAccountStore *account_store,
86 const gchar* account_name,
92 static GObjectClass *parent_class = NULL;
94 static guint signals[LAST_SIGNAL] = {0};
97 modest_tny_account_store_get_type (void)
99 static GType my_type = 0;
102 static const GTypeInfo my_info = {
103 sizeof(ModestTnyAccountStoreClass),
104 NULL, /* base init */
105 NULL, /* base finalize */
106 (GClassInitFunc) modest_tny_account_store_class_init,
107 NULL, /* class finalize */
108 NULL, /* class data */
109 sizeof(ModestTnyAccountStore),
111 (GInstanceInitFunc) modest_tny_account_store_instance_init,
115 static const GInterfaceInfo iface_info = {
116 (GInterfaceInitFunc) modest_tny_account_store_init,
117 NULL, /* interface_finalize */
118 NULL /* interface_data */
121 my_type = g_type_register_static (G_TYPE_OBJECT,
122 "ModestTnyAccountStore",
124 g_type_add_interface_static (my_type, TNY_TYPE_ACCOUNT_STORE,
131 modest_tny_account_store_class_init (ModestTnyAccountStoreClass *klass)
133 GObjectClass *gobject_class;
134 gobject_class = (GObjectClass*) klass;
136 parent_class = g_type_class_peek_parent (klass);
137 gobject_class->finalize = modest_tny_account_store_finalize;
139 g_type_class_add_private (gobject_class,
140 sizeof(ModestTnyAccountStorePrivate));
142 signals[ACCOUNT_UPDATE_SIGNAL] =
143 g_signal_new ("account_update",
144 G_TYPE_FROM_CLASS (gobject_class),
146 G_STRUCT_OFFSET(ModestTnyAccountStoreClass, account_update),
148 g_cclosure_marshal_VOID__STRING,
149 G_TYPE_NONE, 1, G_TYPE_STRING);
154 modest_tny_account_store_instance_init (ModestTnyAccountStore *obj)
156 ModestTnyAccountStorePrivate *priv =
157 MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
159 priv->cache_dir = NULL;
161 priv->platform_fact = NULL;
162 priv->tny_session_camel = NULL;
165 priv->password_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
171 on_account_removed (ModestAccountMgr *acc_mgr, const gchar *account, gboolean server_account,
174 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(user_data);
176 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_UPDATE_SIGNAL], 0,
183 on_account_changed (ModestAccountMgr *acc_mgr, const gchar *account, gboolean server_account,
184 const gchar *key, gpointer user_data)
186 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(user_data);
188 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_UPDATE_SIGNAL], 0,
193 static ModestTnyAccountStore*
194 get_account_store_for_account (TnyAccount *account)
196 return MODEST_TNY_ACCOUNT_STORE(g_object_get_data (G_OBJECT(account), "account_store"));
202 set_account_store_for_account (TnyAccount *account, ModestTnyAccountStore *store)
204 g_object_set_data (G_OBJECT(account), "account_store", (gpointer)store);
208 on_password_requested (ModestTnyAccountStore *account_store,
209 const gchar* account_name,
215 GtkWidget *dialog, *entry, *remember_pass_check;
217 dialog = gtk_dialog_new_with_buttons (_("Password requested"),
226 txt = g_strdup_printf (_("Please enter your password for %s"), account_name);
227 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), gtk_label_new(txt),
231 entry = gtk_entry_new_with_max_length (40);
232 gtk_entry_set_visibility (GTK_ENTRY(entry), FALSE);
233 gtk_entry_set_invisible_char (GTK_ENTRY(entry), 0x2022); /* bullet unichar */
235 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), entry,
238 remember_pass_check = gtk_check_button_new_with_label (_("Remember password"));
239 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), remember_pass_check,
242 gtk_widget_show_all (GTK_WIDGET(GTK_DIALOG(dialog)->vbox));
244 if (gtk_dialog_run (GTK_DIALOG(dialog)) == GTK_RESPONSE_ACCEPT) {
245 *password = g_strdup (gtk_entry_get_text (GTK_ENTRY(entry)));
252 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (remember_pass_check)))
257 gtk_widget_destroy (dialog);
259 while (gtk_events_pending ())
260 gtk_main_iteration ();
264 get_password (TnyAccount *account, const gchar *prompt, gboolean *cancel)
267 ModestAccountMgr *account_mgr;
268 const TnyAccountStore *account_store;
269 ModestTnyAccountStore *self;
270 ModestTnyAccountStorePrivate *priv;
273 gboolean already_asked;
276 key = tny_account_get_id (account);
277 account_store = TNY_ACCOUNT_STORE(get_account_store_for_account (account));
279 self = MODEST_TNY_ACCOUNT_STORE (account_store);
280 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
282 account_mgr = modest_tny_platform_factory_get_account_mgr_instance
283 (MODEST_TNY_PLATFORM_FACTORY(priv->platform_fact));
285 /* is it in the hash? if it's already there, it must be wrong... */
286 pwd_ptr = (gpointer)&pwd; /* pwd_ptr so the compiler does not complained about
287 * type-punned ptrs...*/
288 already_asked = g_hash_table_lookup_extended (priv->password_hash,
291 (gpointer*)&pwd_ptr);
293 /* if the password is not already there, try ModestConf */
294 if (!already_asked) {
295 pwd = modest_account_mgr_get_string (account_mgr,
296 key, MODEST_ACCOUNT_PASSWORD,
298 g_hash_table_insert (priv->password_hash, g_strdup (key), g_strdup (pwd));
301 /* if it was already asked, it must have been wrong, so ask again */
302 if (already_asked || !pwd || strlen(pwd) == 0) {
304 /* we don't have it yet. Get the password from the user */
305 const gchar* name = tny_account_get_name (account);
309 on_password_requested (self, name, &pwd, cancel, &remember);
313 modest_account_mgr_set_string (account_mgr,
314 key, MODEST_ACCOUNT_PASSWORD,
317 /* We need to dup the string even knowing that
318 it's already a dup of the contents of an
319 entry, because it if it's wrong, then camel
321 g_hash_table_insert (priv->password_hash, g_strdup (key), g_strdup(pwd));
323 g_hash_table_remove (priv->password_hash, key);
335 forget_password (TnyAccount *account) {
337 ModestTnyAccountStore *self;
338 ModestTnyAccountStorePrivate *priv;
339 const TnyAccountStore *account_store;
342 ModestAccountMgr *account_mgr;
344 account_store = TNY_ACCOUNT_STORE(get_account_store_for_account (account));
345 self = MODEST_TNY_ACCOUNT_STORE (account_store);
346 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
347 key = tny_account_get_id (account);
349 /* Do not remove the key, this will allow us to detect that we
350 have already asked for it at least once */
351 pwd = g_hash_table_lookup (priv->password_hash, key);
353 memset (pwd, 0, strlen (pwd));
354 g_hash_table_insert (priv->password_hash, g_strdup (key), NULL);
357 account_mgr = modest_tny_platform_factory_get_account_mgr_instance
358 (MODEST_TNY_PLATFORM_FACTORY(priv->platform_fact));
360 /* Remove from configuration system */
361 modest_account_mgr_unset (account_mgr,
362 key, MODEST_ACCOUNT_PASSWORD,
368 /* instantiate the correct tny account subclass */
370 tny_account_for_proto (ModestProtocol proto)
372 ModestProtocolType type;
373 TnyAccount *tny_account = NULL;
375 type = modest_protocol_info_get_protocol_type (proto);
377 if (type == MODEST_PROTOCOL_TYPE_TRANSPORT)
378 tny_account = TNY_ACCOUNT(tny_camel_transport_account_new ());
379 else if (proto == MODEST_PROTOCOL_STORE_POP)
380 tny_account = TNY_ACCOUNT(tny_camel_pop_store_account_new ());
381 else if (proto == MODEST_PROTOCOL_STORE_IMAP)
382 tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ());
384 g_return_val_if_reached (NULL);
387 tny_account_set_proto (tny_account,
388 modest_protocol_info_get_protocol_name(proto));
390 g_printerr ("modest: could not get tny account for %d\n",
396 /* create a tnyaccount for the server account connected to the account with name 'key'
399 get_tny_account_from_server_account (ModestTnyAccountStore *self,
400 ModestServerAccountData *account_data,
401 ModestProtocolType modest_type)
403 TnyAccount *tny_account;
404 ModestTnyAccountStorePrivate *priv;
406 g_return_val_if_fail (self, NULL);
407 g_return_val_if_fail (account_data, NULL);
409 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
412 if (account_data->proto == MODEST_PROTOCOL_UNKNOWN) {
413 g_printerr ("modest: '%s' does not provide a protocol\n",
414 account_data->account_name);
418 tny_account = tny_account_for_proto (account_data->proto);
420 g_printerr ("modest: could not create tny account for '%s'\n",
421 account_data->account_name);
425 /* Set account store, session and id */
426 set_account_store_for_account (TNY_ACCOUNT(tny_account), self);
427 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), /* session */
428 priv->tny_session_camel);
429 tny_account_set_id (tny_account, account_data->account_name); /* id */
432 if (account_data->options) {
433 GSList *tmp = account_data->options;
435 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
437 tmp = g_slist_next (tmp);
440 /* Hostname & Username */
441 if (account_data->username)
442 tny_account_set_user (tny_account, account_data->username);
444 if (account_data->hostname)
445 tny_account_set_hostname (tny_account, account_data->hostname);
447 /* Password functions */
448 tny_account_set_pass_func (tny_account, get_password);
449 tny_account_set_forget_pass_func (tny_account, forget_password);
457 modest_tny_account_store_finalize (GObject *obj)
459 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(obj);
460 ModestTnyAccountStorePrivate *priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
462 if (priv->tny_session_camel) {
463 camel_object_unref (CAMEL_OBJECT(priv->tny_session_camel));
464 priv->tny_session_camel = NULL;
467 g_free (priv->cache_dir);
468 priv->cache_dir = NULL;
471 g_object_unref (priv->device);
475 if (priv->password_hash) {
476 g_hash_table_destroy (priv->password_hash);
477 priv->password_hash = NULL;
480 G_OBJECT_CLASS(parent_class)->finalize (obj);
484 ModestTnyAccountStore*
485 modest_tny_account_store_new (ModestAccountMgr *account_mgr) {
488 ModestTnyAccountStorePrivate *priv;
489 TnyPlatformFactory *pfact;
491 g_return_val_if_fail (account_mgr, NULL);
493 obj = G_OBJECT(g_object_new(MODEST_TYPE_TNY_ACCOUNT_STORE, NULL));
494 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
496 pfact = TNY_PLATFORM_FACTORY (modest_tny_platform_factory_get_instance());
498 g_printerr ("modest: cannot get platform factory instance\n");
499 g_object_unref (obj);
502 priv->platform_fact = pfact;
504 /* The session needs the platform factory */
505 priv->tny_session_camel = tny_session_camel_new (TNY_ACCOUNT_STORE(obj));
506 if (!priv->tny_session_camel) {
507 g_printerr ("modest: cannot create TnySessionCamel instance\n");
508 g_object_unref (obj);
511 tny_session_camel_set_ui_locker (priv->tny_session_camel, tny_gtk_lockable_new ());
514 /* Connect signals */
515 g_signal_connect (G_OBJECT(account_mgr), "account_changed",
516 G_CALLBACK (on_account_changed), obj);
517 g_signal_connect (G_OBJECT(account_mgr), "account_removed",
518 G_CALLBACK (on_account_removed), obj);
520 return MODEST_TNY_ACCOUNT_STORE(obj);
524 modest_tny_account_store_add_store_account (TnyAccountStore *self,
525 TnyStoreAccount *account)
527 /* we should not need this...*/
528 g_printerr ("modest: add_store_account_func not implemented\n");
533 modest_tny_account_store_add_transport_account (TnyAccountStore *self,
534 TnyTransportAccount *account)
536 /* we should not need this...*/
537 g_printerr ("modest: add_transport_account_func not implemented\n");
541 /* create a pseudo-account for our local folders */
543 get_local_folder_account (ModestTnyAccountStore *self)
545 TnyStoreAccount *tny_account;
547 gchar *maildir, *url_string;
548 ModestTnyAccountStorePrivate *priv;
550 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
552 tny_account = tny_camel_store_account_new ();
554 g_printerr ("modest: cannot create account for local folders");
558 maildir = modest_local_folder_info_get_maildir_path ();
560 url = camel_url_new ("maildir:", NULL);
561 camel_url_set_path (url, maildir);
563 url_string = camel_url_to_string (url, 0);
564 tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
566 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account),
567 priv->tny_session_camel);
568 tny_account_set_name (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_NAME);
569 tny_account_set_id (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_NAME);
571 camel_url_free (url);
575 return TNY_ACCOUNT(tny_account);
580 get_tny_account_from_account (ModestTnyAccountStore *self, ModestAccountData *account_data,
581 TnyGetAccountsRequestType type)
583 TnyAccount *tny_account = NULL;
584 ModestServerAccountData *server_account = NULL;
586 if (type == TNY_ACCOUNT_STORE_STORE_ACCOUNTS && account_data->store_account)
587 server_account = account_data->store_account;
588 else if (type == TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS && account_data->transport_account)
589 server_account = account_data->transport_account;
591 if (!server_account) {
592 g_printerr ("modest: no %s account defined for '%s'\n",
593 type == TNY_ACCOUNT_STORE_STORE_ACCOUNTS ? "store" : "transport",
594 account_data->display_name);
598 tny_account = get_tny_account_from_server_account (self, server_account, type);
600 g_printerr ("modest: failed to create tny account for %s\n",
601 account_data->account_name);
605 if (account_data->display_name)
606 tny_account_set_name (tny_account, account_data->display_name);
613 modest_tny_account_store_get_accounts (TnyAccountStore *account_store, TnyList *list,
614 TnyGetAccountsRequestType type)
616 ModestTnyAccountStore *self;
617 ModestTnyAccountStorePrivate *priv;
618 GSList *accounts, *cursor;
619 ModestAccountMgr *account_mgr;
620 TnyAccount *local_folder_account;
622 g_return_if_fail (account_store);
623 g_return_if_fail (TNY_IS_LIST(list));
625 self = MODEST_TNY_ACCOUNT_STORE(account_store);
626 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
627 account_mgr = modest_tny_platform_factory_get_account_mgr_instance
628 (MODEST_TNY_PLATFORM_FACTORY(priv->platform_fact));
630 if (type == TNY_ACCOUNT_STORE_BOTH) {
631 modest_tny_account_store_get_accounts (account_store, list,
632 TNY_ACCOUNT_STORE_STORE_ACCOUNTS);
633 modest_tny_account_store_get_accounts (account_store, list,
634 TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
637 accounts = modest_account_mgr_account_names (account_mgr, NULL);
638 for (cursor = accounts; cursor; cursor = cursor->next) {
639 TnyAccount *tny_account = NULL;
640 ModestAccountData *account_data =
641 modest_account_mgr_get_account_data (account_mgr,
642 (gchar*)cursor->data);
643 if (account_data && account_data->enabled) {
644 tny_account = get_tny_account_from_account (self, account_data, type);
646 tny_list_prepend (list, G_OBJECT(tny_account));
648 g_free (cursor->data);
649 modest_account_mgr_free_account_data (account_mgr, account_data);
651 g_slist_free (accounts);
653 /* also, add the local folder pseudo-account */
654 if (type != TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS) {
655 local_folder_account = get_local_folder_account (MODEST_TNY_ACCOUNT_STORE(self));
656 if (!local_folder_account)
657 g_printerr ("modest: failed to add local folders account\n");
659 tny_list_prepend (list, G_OBJECT(local_folder_account));
661 tny_session_camel_set_account_store (priv->tny_session_camel, account_store);
665 modest_tny_account_store_get_cache_dir (TnyAccountStore *self)
667 ModestTnyAccountStorePrivate *priv;
668 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
670 if (!priv->cache_dir)
671 priv->cache_dir = g_build_filename (g_get_home_dir(),
675 return priv->cache_dir;
680 * callers need to unref
683 modest_tny_account_store_get_device (TnyAccountStore *self)
685 ModestTnyAccountStorePrivate *priv;
687 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE (self);
690 priv->device = tny_platform_factory_new_device (priv->platform_fact);
692 return g_object_ref (G_OBJECT(priv->device));
698 modest_tny_account_store_alert (TnyAccountStore *self, TnyAlertType type,
701 g_printerr ("modest: alert_func not implemented (%d, %s)\n",
708 modest_tny_account_store_init (gpointer g, gpointer iface_data)
710 TnyAccountStoreIface *klass;
712 g_return_if_fail (g);
714 klass = (TnyAccountStoreIface *)g;
716 klass->get_accounts_func =
717 modest_tny_account_store_get_accounts;
718 klass->add_transport_account_func =
719 modest_tny_account_store_add_transport_account;
720 klass->add_store_account_func =
721 modest_tny_account_store_add_store_account;
722 klass->get_cache_dir_func =
723 modest_tny_account_store_get_cache_dir;
724 klass->get_device_func =
725 modest_tny_account_store_get_device;
727 modest_tny_account_store_alert;
731 modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *self,
732 ModestTnyGetPassFunc func)
734 /* not implemented, we use signals */
735 g_printerr ("modest: set_get_pass_func not implemented\n");
739 tny_account_store_get_session (TnyAccountStore *self)
741 g_return_val_if_fail (self, NULL);
742 return MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self)->tny_session_camel;