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-simple-list.h>
39 #include <tny-account-store.h>
40 #include <tny-camel-transport-account.h>
41 #include <tny-camel-imap-store-account.h>
42 #include <tny-camel-pop-store-account.h>
43 #include <modest-marshal.h>
44 #include <modest-protocol-info.h>
45 #include <modest-local-folder-info.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,
71 typedef struct _ModestTnyAccountStorePrivate ModestTnyAccountStorePrivate;
72 struct _ModestTnyAccountStorePrivate {
76 GHashTable *password_hash;
78 TnySessionCamel *tny_session_camel;
80 ModestAccountMgr *account_mgr;
81 TnyAccount *local_folders;
84 #define MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE((o), \
85 MODEST_TYPE_TNY_ACCOUNT_STORE, \
86 ModestTnyAccountStorePrivate))
88 static void on_password_requested (ModestTnyAccountStore *account_store,
89 const gchar* account_name,
95 static GObjectClass *parent_class = NULL;
97 static guint signals[LAST_SIGNAL] = {0};
100 modest_tny_account_store_get_type (void)
102 static GType my_type = 0;
105 static const GTypeInfo my_info = {
106 sizeof(ModestTnyAccountStoreClass),
107 NULL, /* base init */
108 NULL, /* base finalize */
109 (GClassInitFunc) modest_tny_account_store_class_init,
110 NULL, /* class finalize */
111 NULL, /* class data */
112 sizeof(ModestTnyAccountStore),
114 (GInstanceInitFunc) modest_tny_account_store_instance_init,
118 static const GInterfaceInfo iface_info = {
119 (GInterfaceInitFunc) modest_tny_account_store_init,
120 NULL, /* interface_finalize */
121 NULL /* interface_data */
124 my_type = g_type_register_static (G_TYPE_OBJECT,
125 "ModestTnyAccountStore",
127 g_type_add_interface_static (my_type, TNY_TYPE_ACCOUNT_STORE,
134 modest_tny_account_store_class_init (ModestTnyAccountStoreClass *klass)
136 GObjectClass *gobject_class;
137 gobject_class = (GObjectClass*) klass;
139 parent_class = g_type_class_peek_parent (klass);
140 gobject_class->finalize = modest_tny_account_store_finalize;
142 g_type_class_add_private (gobject_class,
143 sizeof(ModestTnyAccountStorePrivate));
145 signals[ACCOUNT_UPDATE_SIGNAL] =
146 g_signal_new ("account_update",
147 G_TYPE_FROM_CLASS (gobject_class),
149 G_STRUCT_OFFSET(ModestTnyAccountStoreClass, account_update),
151 g_cclosure_marshal_VOID__STRING,
152 G_TYPE_NONE, 1, G_TYPE_STRING);
158 modest_tny_account_store_instance_init (ModestTnyAccountStore *obj)
160 ModestTnyAccountStorePrivate *priv =
161 MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
163 priv->cache_dir = NULL;
164 priv->account_mgr = 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;
175 /* we need these dummy functions, or tinymail will complain */
177 get_password_dummy (TnyAccount *account, const gchar *prompt, gboolean *cancel)
182 forget_password_dummy (TnyAccount *account)
187 /* create a pseudo-account for our local folders */
189 get_local_folders_account (ModestTnyAccountStore *self)
191 TnyStoreAccount *tny_account;
193 gchar *maildir, *url_string;
194 ModestTnyAccountStorePrivate *priv;
196 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
198 tny_account = tny_camel_store_account_new ();
200 g_printerr ("modest: cannot create account for local folders");
204 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account),priv->tny_session_camel);
206 maildir = modest_local_folder_info_get_maildir_path ();
207 url = camel_url_new ("maildir:", NULL);
208 camel_url_set_path (url, maildir);
209 url_string = camel_url_to_string (url, 0);
211 tny_account_set_url_string (TNY_ACCOUNT(tny_account), url_string);
212 tny_account_set_name (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_NAME);
213 tny_account_set_id (TNY_ACCOUNT(tny_account), MODEST_LOCAL_FOLDERS_ACCOUNT_NAME);
214 tny_account_set_forget_pass_func (TNY_ACCOUNT(tny_account), forget_password_dummy);
215 tny_account_set_pass_func (TNY_ACCOUNT(tny_account), get_password_dummy);
217 camel_url_free (url);
221 return TNY_ACCOUNT(tny_account);
227 on_account_removed (ModestAccountMgr *acc_mgr, const gchar *account, gboolean server_account,
230 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(user_data);
232 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_UPDATE_SIGNAL], 0,
239 on_account_changed (ModestAccountMgr *acc_mgr, const gchar *account, gboolean server_account,
240 const gchar *key, gpointer user_data)
242 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(user_data);
244 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_UPDATE_SIGNAL], 0,
249 static ModestTnyAccountStore*
250 get_account_store_for_account (TnyAccount *account)
252 return MODEST_TNY_ACCOUNT_STORE(g_object_get_data (G_OBJECT(account),
258 on_password_requested (ModestTnyAccountStore *account_store,
259 const gchar* account_name,
265 GtkWidget *dialog, *entry, *remember_pass_check;
267 dialog = gtk_dialog_new_with_buttons (_("Password requested"),
276 txt = g_strdup_printf (_("Please enter your password for %s"), account_name);
277 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), gtk_label_new(txt),
281 entry = gtk_entry_new_with_max_length (40);
282 gtk_entry_set_visibility (GTK_ENTRY(entry), FALSE);
283 gtk_entry_set_invisible_char (GTK_ENTRY(entry), 0x2022); /* bullet unichar */
285 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), entry,
288 remember_pass_check = gtk_check_button_new_with_label (_("Remember password"));
289 gtk_box_pack_start (GTK_BOX(GTK_DIALOG(dialog)->vbox), remember_pass_check,
292 gtk_widget_show_all (GTK_WIDGET(GTK_DIALOG(dialog)->vbox));
294 if (gtk_dialog_run (GTK_DIALOG(dialog)) == GTK_RESPONSE_ACCEPT) {
295 *password = g_strdup (gtk_entry_get_text (GTK_ENTRY(entry)));
302 if (gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (remember_pass_check)))
307 gtk_widget_destroy (dialog);
311 get_password (TnyAccount *account, const gchar *prompt, gboolean *cancel)
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 /* is it in the hash? if it's already there, it must be wrong... */
329 pwd_ptr = (gpointer)&pwd; /* pwd_ptr so the compiler does not complained about
330 * type-punned ptrs...*/
331 already_asked = g_hash_table_lookup_extended (priv->password_hash,
334 (gpointer*)&pwd_ptr);
336 /* if the password is not already there, try ModestConf */
337 if (!already_asked) {
338 pwd = modest_account_mgr_get_string (priv->account_mgr,
339 key, MODEST_ACCOUNT_PASSWORD,
341 g_hash_table_insert (priv->password_hash, g_strdup (key), g_strdup (pwd));
344 /* if it was already asked, it must have been wrong, so ask again */
345 if (already_asked || !pwd || strlen(pwd) == 0) {
347 /* we don't have it yet. Get the password from the user */
348 const gchar* name = tny_account_get_name (account);
352 on_password_requested (self, name, &pwd, cancel, &remember);
356 modest_account_mgr_set_string (priv->account_mgr,
357 key, MODEST_ACCOUNT_PASSWORD,
360 /* We need to dup the string even knowing that
361 it's already a dup of the contents of an
362 entry, because it if it's wrong, then camel
364 g_hash_table_insert (priv->password_hash, g_strdup (key), g_strdup(pwd));
366 g_hash_table_remove (priv->password_hash, key);
378 forget_password (TnyAccount *account)
380 ModestTnyAccountStore *self;
381 ModestTnyAccountStorePrivate *priv;
382 const TnyAccountStore *account_store;
386 account_store = TNY_ACCOUNT_STORE(get_account_store_for_account (account));
387 self = MODEST_TNY_ACCOUNT_STORE (account_store);
388 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
389 key = tny_account_get_id (account);
391 /* Do not remove the key, this will allow us to detect that we
392 have already asked for it at least once */
393 pwd = g_hash_table_lookup (priv->password_hash, key);
395 memset (pwd, 0, strlen (pwd));
396 g_hash_table_insert (priv->password_hash, g_strdup (key), NULL);
399 /* Remove from configuration system */
400 modest_account_mgr_unset (priv->account_mgr,
401 key, MODEST_ACCOUNT_PASSWORD,
407 /* instantiate the correct tny account subclass */
409 tny_account_for_proto (ModestProtocol proto)
411 ModestProtocolType type;
412 TnyAccount *tny_account = NULL;
414 type = modest_protocol_info_get_protocol_type (proto);
416 if (type == MODEST_PROTOCOL_TYPE_TRANSPORT)
417 tny_account = TNY_ACCOUNT(tny_camel_transport_account_new ());
418 else if (proto == MODEST_PROTOCOL_STORE_POP)
419 tny_account = TNY_ACCOUNT(tny_camel_pop_store_account_new ());
420 else if (proto == MODEST_PROTOCOL_STORE_IMAP)
421 tny_account = TNY_ACCOUNT(tny_camel_imap_store_account_new ());
423 g_return_val_if_reached (NULL);
429 /* create a tnyaccount for the server account connected to the account with name 'key'
432 get_tny_account_from_server_account (ModestTnyAccountStore *self,
433 ModestServerAccountData *account_data,
434 ModestProtocolType modest_type)
436 TnyAccount *tny_account;
437 ModestTnyAccountStorePrivate *priv;
439 g_return_val_if_fail (self, NULL);
440 g_return_val_if_fail (account_data, NULL);
442 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
445 if (account_data->proto == MODEST_PROTOCOL_UNKNOWN) {
446 g_printerr ("modest: '%s' does not provide a protocol\n",
447 account_data->account_name);
451 tny_account = tny_account_for_proto (account_data->proto);
453 g_printerr ("modest: could not create tny account for '%s'\n",
454 account_data->account_name);
458 /* Set account store, session and id */
459 tny_camel_account_set_session (TNY_CAMEL_ACCOUNT(tny_account), /* session */
460 priv->tny_session_camel);
463 tny_account_set_proto (tny_account,
464 modest_protocol_info_get_protocol_name(account_data->proto));
466 g_object_set_data (G_OBJECT(tny_account), "account_store", (gpointer)self);
469 if (account_data->options) {
470 GSList *tmp = account_data->options;
472 tny_camel_account_add_option (TNY_CAMEL_ACCOUNT (tny_account),
474 tmp = g_slist_next (tmp);
478 tny_account_set_id (tny_account, account_data->account_name);
480 /* Hostname & Username */
481 if (account_data->username)
482 tny_account_set_user (tny_account, account_data->username);
484 if (account_data->hostname)
485 tny_account_set_hostname (tny_account, account_data->hostname);
487 /* Password functions */
488 tny_account_set_forget_pass_func (tny_account, forget_password);
489 tny_account_set_pass_func (tny_account, get_password);
497 modest_tny_account_store_finalize (GObject *obj)
499 ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(obj);
500 ModestTnyAccountStorePrivate *priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
502 if (priv->tny_session_camel) {
503 camel_object_unref (CAMEL_OBJECT(priv->tny_session_camel));
504 priv->tny_session_camel = NULL;
507 g_free (priv->cache_dir);
508 priv->cache_dir = NULL;
511 g_object_unref (priv->device);
515 if (priv->password_hash) {
516 g_hash_table_destroy (priv->password_hash);
517 priv->password_hash = NULL;
520 if (priv->account_mgr) {
521 g_object_unref (priv->account_mgr);
522 priv->account_mgr = NULL;
525 G_OBJECT_CLASS(parent_class)->finalize (obj);
529 ModestTnyAccountStore*
530 modest_tny_account_store_new (ModestAccountMgr *account_mgr) {
533 ModestTnyAccountStorePrivate *priv;
535 g_return_val_if_fail (account_mgr, NULL);
537 obj = G_OBJECT(g_object_new(MODEST_TYPE_TNY_ACCOUNT_STORE, NULL));
538 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
540 priv->account_mgr = account_mgr;
541 g_object_ref (G_OBJECT(priv->account_mgr));
543 /* The session needs the platform factory */
544 priv->tny_session_camel = tny_session_camel_new (TNY_ACCOUNT_STORE(obj));
545 if (!priv->tny_session_camel) {
546 g_printerr ("modest: cannot create TnySessionCamel instance\n");
547 g_object_unref (obj);
551 tny_session_camel_set_ui_locker (priv->tny_session_camel, tny_gtk_lockable_new ());
552 /* FIXME: unref this in the end? */
554 /* Connect signals */
555 g_signal_connect (G_OBJECT(account_mgr), "account_changed",
556 G_CALLBACK (on_account_changed), obj);
557 g_signal_connect (G_OBJECT(account_mgr), "account_removed",
558 G_CALLBACK (on_account_removed), obj);
560 return MODEST_TNY_ACCOUNT_STORE(obj);
564 modest_tny_account_store_add_store_account (TnyAccountStore *self,
565 TnyStoreAccount *account)
567 /* we should not need this...*/
568 g_printerr ("modest: add_store_account_func not implemented\n");
573 modest_tny_account_store_add_transport_account (TnyAccountStore *self,
574 TnyTransportAccount *account)
576 /* we should not need this...*/
577 g_printerr ("modest: add_transport_account_func not implemented\n");
583 get_tny_account_from_account (ModestTnyAccountStore *self, ModestAccountData *account_data,
584 TnyGetAccountsRequestType type)
586 TnyAccount *tny_account = NULL;
587 ModestServerAccountData *server_account = NULL;
589 if (type == TNY_ACCOUNT_STORE_STORE_ACCOUNTS && account_data->store_account)
590 server_account = account_data->store_account;
591 else if (type == TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS && account_data->transport_account)
592 server_account = account_data->transport_account;
594 if (!server_account) {
595 g_printerr ("modest: no %s account defined for '%s'\n",
596 type == TNY_ACCOUNT_STORE_STORE_ACCOUNTS ? "store" : "transport",
597 account_data->display_name);
601 tny_account = get_tny_account_from_server_account (self, server_account, type);
603 g_printerr ("modest: failed to create tny account for %s\n",
604 account_data->account_name);
608 if (account_data->display_name)
609 tny_account_set_name (tny_account, account_data->display_name);
616 modest_tny_account_store_get_accounts (TnyAccountStore *account_store, TnyList *list,
617 TnyGetAccountsRequestType type)
619 ModestTnyAccountStore *self;
620 ModestTnyAccountStorePrivate *priv;
621 GSList *accounts, *cursor;
623 g_return_if_fail (account_store);
624 g_return_if_fail (TNY_IS_LIST(list));
626 self = MODEST_TNY_ACCOUNT_STORE(account_store);
627 priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
629 if (type == TNY_ACCOUNT_STORE_BOTH) {
630 modest_tny_account_store_get_accounts (account_store, list,
631 TNY_ACCOUNT_STORE_STORE_ACCOUNTS);
632 modest_tny_account_store_get_accounts (account_store, list,
633 TNY_ACCOUNT_STORE_TRANSPORT_ACCOUNTS);
637 accounts = modest_account_mgr_account_names (priv->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 (priv->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 (priv->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 if (!priv->local_folders)
656 priv->local_folders = get_local_folders_account (self);
657 if (!priv->local_folders)
658 g_printerr ("modest: no local folders account\n");
660 tny_list_prepend (list, G_OBJECT(priv->local_folders));
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
691 (modest_tny_platform_factory_get_instance());
693 return g_object_ref (G_OBJECT(priv->device));
699 modest_tny_account_store_alert (TnyAccountStore *self, TnyAlertType type,
702 GtkMessageType gtktype;
703 gboolean retval = FALSE;
708 case TNY_ALERT_TYPE_INFO:
709 gtktype = GTK_MESSAGE_INFO;
711 case TNY_ALERT_TYPE_WARNING:
712 gtktype = GTK_MESSAGE_WARNING;
714 case TNY_ALERT_TYPE_ERROR:
716 gtktype = GTK_MESSAGE_ERROR;
720 dialog = gtk_message_dialog_new (NULL, GTK_DIALOG_MODAL,
721 gtktype, GTK_BUTTONS_YES_NO, prompt);
723 if (gtk_dialog_run (GTK_DIALOG (dialog)) == GTK_RESPONSE_YES)
726 gtk_widget_destroy (dialog);
733 modest_tny_account_store_init (gpointer g, gpointer iface_data)
735 TnyAccountStoreIface *klass;
737 g_return_if_fail (g);
739 klass = (TnyAccountStoreIface *)g;
741 klass->get_accounts_func =
742 modest_tny_account_store_get_accounts;
743 klass->add_transport_account_func =
744 modest_tny_account_store_add_transport_account;
745 klass->add_store_account_func =
746 modest_tny_account_store_add_store_account;
747 klass->get_cache_dir_func =
748 modest_tny_account_store_get_cache_dir;
749 klass->get_device_func =
750 modest_tny_account_store_get_device;
752 modest_tny_account_store_alert;
756 modest_tny_account_store_set_get_pass_func (ModestTnyAccountStore *self,
757 ModestTnyGetPassFunc func)
759 /* not implemented, we use signals */
760 g_printerr ("modest: set_get_pass_func not implemented\n");
764 tny_account_store_get_session (TnyAccountStore *self)
766 g_return_val_if_fail (self, NULL);
767 return MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self)->tny_session_camel;
772 modest_tny_account_store_get_local_folders_account (ModestTnyAccountStore *self)
774 g_return_val_if_fail (self, NULL);
776 return MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE (self)->local_folders;