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;
80 TnyAccount *local_folders;
83 #define MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
84 MODEST_TYPE_TNY_ACCOUNT_STORE, \
85 ModestTnyAccountStorePrivate))
87 static void on_password_requested (ModestTnyAccountStore *account_store,
88 const gchar* account_name,
94 static GObjectClass *parent_class = NULL;
96 static guint signals[LAST_SIGNAL] = {0};
99 modest_tny_account_store_get_type (void)
101 static GType my_type = 0;
104 static const GTypeInfo my_info = {
105 sizeof(ModestTnyAccountStoreClass),
106 NULL, /* base init */
107 NULL, /* base finalize */
108 (GClassInitFunc) modest_tny_account_store_class_init,
109 NULL, /* class finalize */
110 NULL, /* class data */
111 sizeof(ModestTnyAccountStore),
113 (GInstanceInitFunc) modest_tny_account_store_instance_init,
117 static const GInterfaceInfo iface_info = {
118 (GInterfaceInitFunc) modest_tny_account_store_init,
119 NULL, /* interface_finalize */
120 NULL /* interface_data */
123 my_type = g_type_register_static (G_TYPE_OBJECT,
124 "ModestTnyAccountStore",
126 g_type_add_interface_static (my_type, TNY_TYPE_ACCOUNT_STORE,
133 modest_tny_account_store_class_init (ModestTnyAccountStoreClass *klass)
135 GObjectClass *gobject_class;
136 gobject_class = (GObjectClass*) klass;
138 parent_class = g_type_class_peek_parent (klass);
139 gobject_class->finalize = modest_tny_account_store_finalize;
141 g_type_class_add_private (gobject_class,
142 sizeof(ModestTnyAccountStorePrivate));
144 signals[ACCOUNT_UPDATE_SIGNAL] =
145 g_signal_new ("account_update",
146 G_TYPE_FROM_CLASS (gobject_class),
148 G_STRUCT_OFFSET(ModestTnyAccountStoreClass, account_update),
150 g_cclosure_marshal_VOID__STRING,
151 G_TYPE_NONE, 1, G_TYPE_STRING);
157 modest_tny_account_store_instance_init (ModestTnyAccountStore *obj)
159 ModestTnyAccountStorePrivate *priv =
160 MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
162 priv->cache_dir = NULL;
164 priv->platform_fact = NULL;
165 priv->tny_session_camel = NULL;
168 priv->password_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
171 priv->local_folders = NULL;
177 /* create a pseudo-account for our local folders */
179 get_local_folders_account (ModestTnyAccountStore *self)
181 TnyStoreAccount *tny_account;
183 gchar *maildir, *url_string;
184 ModestTnyAccountStorePrivate *priv;
186 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
188 tny_account = tny_camel_store_account_new ();
190 g_printerr ("modest: cannot create account for local folders");
194 maildir = modest_local_folder_info_get_maildir_path ();
196 url = camel_url_new ("maildir:", NULL);
197 camel_url_set_path (url, maildir);
199 url_string = camel_url_to_string (url, 0);
200 tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
202 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account),
203 priv->tny_session_camel);
204 tny_account_set_name (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_NAME);
205 tny_account_set_id (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_NAME);
207 camel_url_free (url);
211 return TNY_ACCOUNT(tny_account);
217 on_account_removed (ModestAccountMgr *acc_mgr, const gchar *account, gboolean server_account,
220 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(user_data);
222 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_UPDATE_SIGNAL], 0,
229 on_account_changed (ModestAccountMgr *acc_mgr, const gchar *account, gboolean server_account,
230 const gchar *key, gpointer user_data)
232 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(user_data);
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), "account_store"));
248 set_account_store_for_account (TnyAccount *account, ModestTnyAccountStore *store)
250 g_object_set_data (G_OBJECT(account), "account_store", (gpointer)store);
254 on_password_requested (ModestTnyAccountStore *account_store,
255 const gchar* account_name,
261 GtkWidget *dialog, *entry, *remember_pass_check;
263 dialog = gtk_dialog_new_with_buttons (_("Password requested"),
272 txt = g_strdup_printf (_("Please enter your password for %s"), account_name);
273 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), gtk_label_new(txt),
277 entry = gtk_entry_new_with_max_length (40);
278 gtk_entry_set_visibility (GTK_ENTRY(entry), FALSE);
279 gtk_entry_set_invisible_char (GTK_ENTRY(entry), 0x2022); /* bullet unichar */
281 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), entry,
284 remember_pass_check = gtk_check_button_new_with_label (_("Remember password"));
285 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), remember_pass_check,
288 gtk_widget_show_all (GTK_WIDGET(GTK_DIALOG(dialog)->vbox));
290 if (gtk_dialog_run (GTK_DIALOG(dialog)) == GTK_RESPONSE_ACCEPT) {
291 *password = g_strdup (gtk_entry_get_text (GTK_ENTRY(entry)));
298 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (remember_pass_check)))
303 gtk_widget_destroy (dialog);
305 while (gtk_events_pending ())
306 gtk_main_iteration ();
310 get_password (TnyAccount *account, const gchar *prompt, gboolean *cancel)
313 ModestAccountMgr *account_mgr;
314 const TnyAccountStore *account_store;
315 ModestTnyAccountStore *self;
316 ModestTnyAccountStorePrivate *priv;
319 gboolean already_asked;
322 key = tny_account_get_id (account);
323 account_store = TNY_ACCOUNT_STORE(get_account_store_for_account (account));
325 self = MODEST_TNY_ACCOUNT_STORE (account_store);
326 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
328 account_mgr = modest_tny_platform_factory_get_account_mgr_instance
329 (MODEST_TNY_PLATFORM_FACTORY(priv->platform_fact));
331 /* is it in the hash? if it's already there, it must be wrong... */
332 pwd_ptr = (gpointer)&pwd; /* pwd_ptr so the compiler does not complained about
333 * type-punned ptrs...*/
334 already_asked = g_hash_table_lookup_extended (priv->password_hash,
337 (gpointer*)&pwd_ptr);
339 /* if the password is not already there, try ModestConf */
340 if (!already_asked) {
341 pwd = modest_account_mgr_get_string (account_mgr,
342 key, MODEST_ACCOUNT_PASSWORD,
344 g_hash_table_insert (priv->password_hash, g_strdup (key), g_strdup (pwd));
347 /* if it was already asked, it must have been wrong, so ask again */
348 if (already_asked || !pwd || strlen(pwd) == 0) {
350 /* we don't have it yet. Get the password from the user */
351 const gchar* name = tny_account_get_name (account);
355 on_password_requested (self, name, &pwd, cancel, &remember);
359 modest_account_mgr_set_string (account_mgr,
360 key, MODEST_ACCOUNT_PASSWORD,
363 /* We need to dup the string even knowing that
364 it's already a dup of the contents of an
365 entry, because it if it's wrong, then camel
367 g_hash_table_insert (priv->password_hash, g_strdup (key), g_strdup(pwd));
369 g_hash_table_remove (priv->password_hash, key);
381 forget_password (TnyAccount *account) {
383 ModestTnyAccountStore *self;
384 ModestTnyAccountStorePrivate *priv;
385 const TnyAccountStore *account_store;
388 ModestAccountMgr *account_mgr;
390 account_store = TNY_ACCOUNT_STORE(get_account_store_for_account (account));
391 self = MODEST_TNY_ACCOUNT_STORE (account_store);
392 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
393 key = tny_account_get_id (account);
395 /* Do not remove the key, this will allow us to detect that we
396 have already asked for it at least once */
397 pwd = g_hash_table_lookup (priv->password_hash, key);
399 memset (pwd, 0, strlen (pwd));
400 g_hash_table_insert (priv->password_hash, g_strdup (key), NULL);
403 account_mgr = modest_tny_platform_factory_get_account_mgr_instance
404 (MODEST_TNY_PLATFORM_FACTORY(priv->platform_fact));
406 /* Remove from configuration system */
407 modest_account_mgr_unset (account_mgr,
408 key, MODEST_ACCOUNT_PASSWORD,
414 /* instantiate the correct tny account subclass */
416 tny_account_for_proto (ModestProtocol proto)
418 ModestProtocolType type;
419 TnyAccount *tny_account = NULL;
421 type = modest_protocol_info_get_protocol_type (proto);
423 if (type == MODEST_PROTOCOL_TYPE_TRANSPORT)
424 tny_account = TNY_ACCOUNT(tny_camel_transport_account_new ());
425 else if (proto == MODEST_PROTOCOL_STORE_POP)
426 tny_account = TNY_ACCOUNT(tny_camel_pop_store_account_new ());
427 else if (proto == MODEST_PROTOCOL_STORE_IMAP)
428 tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ());
430 g_return_val_if_reached (NULL);
433 tny_account_set_proto (tny_account,
434 modest_protocol_info_get_protocol_name(proto));
436 g_printerr ("modest: could not get tny account for %d\n",
442 /* create a tnyaccount for the server account connected to the account with name 'key'
445 get_tny_account_from_server_account (ModestTnyAccountStore *self,
446 ModestServerAccountData *account_data,
447 ModestProtocolType modest_type)
449 TnyAccount *tny_account;
450 ModestTnyAccountStorePrivate *priv;
452 g_return_val_if_fail (self, NULL);
453 g_return_val_if_fail (account_data, NULL);
455 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
458 if (account_data->proto == MODEST_PROTOCOL_UNKNOWN) {
459 g_printerr ("modest: '%s' does not provide a protocol\n",
460 account_data->account_name);
464 tny_account = tny_account_for_proto (account_data->proto);
466 g_printerr ("modest: could not create tny account for '%s'\n",
467 account_data->account_name);
471 /* Set account store, session and id */
472 set_account_store_for_account (TNY_ACCOUNT(tny_account), self);
473 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), /* session */
474 priv->tny_session_camel);
475 tny_account_set_id (tny_account, account_data->account_name); /* id */
478 if (account_data->options) {
479 GSList *tmp = account_data->options;
481 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
483 tmp = g_slist_next (tmp);
486 /* Hostname & Username */
487 if (account_data->username)
488 tny_account_set_user (tny_account, account_data->username);
490 if (account_data->hostname)
491 tny_account_set_hostname (tny_account, account_data->hostname);
493 /* Password functions */
494 tny_account_set_pass_func (tny_account, get_password);
495 tny_account_set_forget_pass_func (tny_account, forget_password);
503 modest_tny_account_store_finalize (GObject *obj)
505 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(obj);
506 ModestTnyAccountStorePrivate *priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
508 if (priv->tny_session_camel) {
509 camel_object_unref (CAMEL_OBJECT(priv->tny_session_camel));
510 priv->tny_session_camel = NULL;
513 g_free (priv->cache_dir);
514 priv->cache_dir = NULL;
517 g_object_unref (priv->device);
521 if (priv->password_hash) {
522 g_hash_table_destroy (priv->password_hash);
523 priv->password_hash = NULL;
526 G_OBJECT_CLASS(parent_class)->finalize (obj);
530 ModestTnyAccountStore*
531 modest_tny_account_store_new (ModestAccountMgr *account_mgr) {
534 ModestTnyAccountStorePrivate *priv;
535 TnyPlatformFactory *pfact;
537 g_return_val_if_fail (account_mgr, NULL);
539 obj = G_OBJECT(g_object_new(MODEST_TYPE_TNY_ACCOUNT_STORE, NULL));
540 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
542 pfact = TNY_PLATFORM_FACTORY (modest_tny_platform_factory_get_instance());
544 g_printerr ("modest: cannot get platform factory instance\n");
545 g_object_unref (obj);
548 priv->platform_fact = pfact;
550 /* The session needs the platform factory */
551 priv->tny_session_camel = tny_session_camel_new (TNY_ACCOUNT_STORE(obj));
552 if (!priv->tny_session_camel) {
553 g_printerr ("modest: cannot create TnySessionCamel instance\n");
554 g_object_unref (obj);
557 tny_session_camel_set_ui_locker (priv->tny_session_camel, tny_gtk_lockable_new ());
558 priv->local_folders = get_local_folders_account (MODEST_TNY_ACCOUNT_STORE(obj));
559 /* FIXME: unref this in the end? */
561 /* Connect signals */
562 g_signal_connect (G_OBJECT(account_mgr), "account_changed",
563 G_CALLBACK (on_account_changed), obj);
564 g_signal_connect (G_OBJECT(account_mgr), "account_removed",
565 G_CALLBACK (on_account_removed), obj);
567 return MODEST_TNY_ACCOUNT_STORE(obj);
571 modest_tny_account_store_add_store_account (TnyAccountStore *self,
572 TnyStoreAccount *account)
574 /* we should not need this...*/
575 g_printerr ("modest: add_store_account_func not implemented\n");
580 modest_tny_account_store_add_transport_account (TnyAccountStore *self,
581 TnyTransportAccount *account)
583 /* we should not need this...*/
584 g_printerr ("modest: add_transport_account_func not implemented\n");
590 get_tny_account_from_account (ModestTnyAccountStore *self, ModestAccountData *account_data,
591 TnyGetAccountsRequestType type)
593 TnyAccount *tny_account = NULL;
594 ModestServerAccountData *server_account = NULL;
596 if (type == TNY_ACCOUNT_STORE_STORE_ACCOUNTS && account_data->store_account)
597 server_account = account_data->store_account;
598 else if (type == TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS && account_data->transport_account)
599 server_account = account_data->transport_account;
601 if (!server_account) {
602 g_printerr ("modest: no %s account defined for '%s'\n",
603 type == TNY_ACCOUNT_STORE_STORE_ACCOUNTS ? "store" : "transport",
604 account_data->display_name);
608 tny_account = get_tny_account_from_server_account (self, server_account, type);
610 g_printerr ("modest: failed to create tny account for %s\n",
611 account_data->account_name);
615 if (account_data->display_name)
616 tny_account_set_name (tny_account, account_data->display_name);
623 modest_tny_account_store_get_accounts (TnyAccountStore *account_store, TnyList *list,
624 TnyGetAccountsRequestType type)
626 ModestTnyAccountStore *self;
627 ModestTnyAccountStorePrivate *priv;
628 GSList *accounts, *cursor;
629 ModestAccountMgr *account_mgr;
631 g_return_if_fail (account_store);
632 g_return_if_fail (TNY_IS_LIST(list));
634 self = MODEST_TNY_ACCOUNT_STORE(account_store);
635 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
636 account_mgr = modest_tny_platform_factory_get_account_mgr_instance
637 (MODEST_TNY_PLATFORM_FACTORY(priv->platform_fact));
639 if (type == TNY_ACCOUNT_STORE_BOTH) {
640 modest_tny_account_store_get_accounts (account_store, list,
641 TNY_ACCOUNT_STORE_STORE_ACCOUNTS);
642 modest_tny_account_store_get_accounts (account_store, list,
643 TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
646 accounts = modest_account_mgr_account_names (account_mgr, NULL);
647 for (cursor = accounts; cursor; cursor = cursor->next) {
648 TnyAccount *tny_account = NULL;
649 ModestAccountData *account_data =
650 modest_account_mgr_get_account_data (account_mgr,
651 (gchar*)cursor->data);
652 if (account_data && account_data->enabled) {
653 tny_account = get_tny_account_from_account (self, account_data, type);
655 tny_list_prepend (list, G_OBJECT(tny_account));
657 g_free (cursor->data);
658 modest_account_mgr_free_account_data (account_mgr, account_data);
660 g_slist_free (accounts);
662 /* also, add the local folder pseudo-account */
663 if (type != TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS) {
664 if (!priv->local_folders)
665 g_printerr ("modest: no local folders account\n");
667 tny_list_prepend (list, G_OBJECT(priv->local_folders));
669 tny_session_camel_set_account_store (priv->tny_session_camel, account_store);
673 modest_tny_account_store_get_cache_dir (TnyAccountStore *self)
675 ModestTnyAccountStorePrivate *priv;
676 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
678 if (!priv->cache_dir)
679 priv->cache_dir = g_build_filename (g_get_home_dir(),
683 return priv->cache_dir;
688 * callers need to unref
691 modest_tny_account_store_get_device (TnyAccountStore *self)
693 ModestTnyAccountStorePrivate *priv;
695 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE (self);
698 priv->device = tny_platform_factory_new_device (priv->platform_fact);
700 return g_object_ref (G_OBJECT(priv->device));
706 modest_tny_account_store_alert (TnyAccountStore *self, TnyAlertType type,
709 g_printerr ("modest: alert_func not implemented (%d, %s)\n",
716 modest_tny_account_store_init (gpointer g, gpointer iface_data)
718 TnyAccountStoreIface *klass;
720 g_return_if_fail (g);
722 klass = (TnyAccountStoreIface *)g;
724 klass->get_accounts_func =
725 modest_tny_account_store_get_accounts;
726 klass->add_transport_account_func =
727 modest_tny_account_store_add_transport_account;
728 klass->add_store_account_func =
729 modest_tny_account_store_add_store_account;
730 klass->get_cache_dir_func =
731 modest_tny_account_store_get_cache_dir;
732 klass->get_device_func =
733 modest_tny_account_store_get_device;
735 modest_tny_account_store_alert;
739 modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *self,
740 ModestTnyGetPassFunc func)
742 /* not implemented, we use signals */
743 g_printerr ("modest: set_get_pass_func not implemented\n");
747 tny_account_store_get_session (TnyAccountStore *self)
749 g_return_val_if_fail (self, NULL);
750 return MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self)->tny_session_camel;
756 modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self)
758 g_return_val_if_fail (self, NULL);
760 return MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE (self)->local_folders;
764 /* for now, ignore the account ===> the special folders are the same,
765 * local folders for all accounts
766 * this might change, ie, IMAP might have server-side sent-items
769 modest_tny_account_store_get_special_folder (ModestTnyAccountStore*self, TnyAccount *account,
770 TnyFolderType special_type)
772 g_return_val_if_fail (self, NULL);
773 g_return_val_if_fail (account, NULL);
774 g_return_val_if_fail (0 <= special_type && special_type < TNY_FOLDER_TYPE_NUM,
776 //TnyAccount *local_account =
777 // tny_account_store_get_local_folders_account (self);
779 /* FIXME: implement this */