549a7c650d9ca645e592619b6ce822793f1df612
[modest] / src / modest-tny-account-store.c
1 /* modest-tny-account-store.c */
2
3 /* insert (c)/licensing information) */
4
5 #include <string.h>
6
7 #include <tny-account-iface.h>
8 #include <tny-account-store-iface.h>
9 #include <tny-store-account-iface.h>
10 #include <tny-transport-account-iface.h>
11 #include <tny-device-iface.h>
12 #include <tny-device.h>
13 #include <tny-account-store.h>
14
15 #include <tny-store-account.h>
16 #include <tny-transport-account.h>
17
18 #include "modest-account-mgr.h"
19 #include "modest-tny-account-store.h"
20
21 /* 'private'/'protected' functions */
22 static void modest_tny_account_store_class_init   (ModestTnyAccountStoreClass *klass);
23 static void modest_tny_account_store_init         (ModestTnyAccountStore *obj);
24 static void modest_tny_account_store_finalize     (GObject *obj);
25
26 /* implementations for tny-account-store-iface */
27 static void    modest_tny_account_store_iface_init              (gpointer g_iface, gpointer iface_data);
28
29 static void    modest_tny_account_store_add_store_account       (TnyAccountStoreIface *self,
30                                                                TnyStoreAccountIface *account);
31 static void    modest_tny_account_store_add_transport_account   (TnyAccountStoreIface *self,
32                                                                        TnyTransportAccountIface *account);
33 static const GList*  modest_tny_account_store_get_store_accounts      (TnyAccountStoreIface *iface);
34 static const GList*  modest_tny_account_store_get_transport_accounts  (TnyAccountStoreIface *iface);
35
36 /* list my signals */
37 enum {
38         PASSWORD_REQUESTED_SIGNAL,
39         LAST_SIGNAL
40 };
41
42 typedef struct _ModestTnyAccountStorePrivate ModestTnyAccountStorePrivate;
43 struct _ModestTnyAccountStorePrivate {
44
45         GList *store_accounts;
46         GList *transport_accounts;
47         gchar *cache_dir;
48
49         TnySessionCamel *tny_session_camel;
50         TnyDeviceIface  *device;
51
52         ModestAccountMgr *modest_acc_mgr;
53 };
54 #define MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
55                                                       MODEST_TYPE_TNY_ACCOUNT_STORE, \
56                                                       ModestTnyAccountStorePrivate))
57 /* globals */
58 static GObjectClass *parent_class = NULL;
59
60 static guint signals[LAST_SIGNAL] = {0};
61
62 GType
63 modest_tny_account_store_get_type (void)
64 {
65         static GType my_type = 0;
66         if (!my_type) {
67                 static const GTypeInfo my_info = {
68                         sizeof(ModestTnyAccountStoreClass),
69                         NULL,           /* base init */
70                         NULL,           /* base finalize */
71                         (GClassInitFunc) modest_tny_account_store_class_init,
72                         NULL,           /* class finalize */
73                         NULL,           /* class data */
74                         sizeof(ModestTnyAccountStore),
75                         1,              /* n_preallocs */
76                         (GInstanceInitFunc) modest_tny_account_store_init,
77                 };
78
79                 static const GInterfaceInfo iface_info = {
80                         (GInterfaceInitFunc) modest_tny_account_store_iface_init,
81                         NULL,         /* interface_finalize */
82                         NULL          /* interface_data */
83                 };
84                 /* hack hack */
85                 my_type = g_type_register_static (TNY_TYPE_ACCOUNT_STORE,
86                                                   "ModestTnyAccountStore", &my_info, 0);
87
88                 g_type_add_interface_static (my_type, TNY_TYPE_ACCOUNT_STORE_IFACE,
89                                              &iface_info);
90         }
91         return my_type;
92 }
93
94 static void
95 modest_tny_account_store_class_init (ModestTnyAccountStoreClass *klass)
96 {
97         GObjectClass *gobject_class;
98         gobject_class = (GObjectClass*) klass;
99
100         parent_class            = g_type_class_peek_parent (klass);
101         gobject_class->finalize = modest_tny_account_store_finalize;
102
103         g_type_class_add_private (gobject_class,
104                                   sizeof(ModestTnyAccountStorePrivate));
105
106         signals[PASSWORD_REQUESTED_SIGNAL] =
107                 g_signal_new ("password_requested",
108                               G_TYPE_FROM_CLASS (gobject_class),
109                               G_SIGNAL_RUN_FIRST,
110                               G_STRUCT_OFFSET(ModestTnyAccountStoreClass,password_requested),
111                               NULL, NULL,
112                               g_cclosure_marshal_VOID__POINTER,
113                               G_TYPE_NONE, 1, G_TYPE_POINTER);
114 }
115
116 static void
117 modest_tny_account_store_init (ModestTnyAccountStore *obj)
118 {
119         ModestTnyAccountStorePrivate *priv =
120                 MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
121
122         priv->modest_acc_mgr         = NULL;
123         priv->device                 = NULL;
124
125         priv->store_accounts         = NULL;
126         priv->transport_accounts     = NULL;
127         priv->cache_dir              = NULL;
128
129         priv->tny_session_camel      = NULL;
130 }
131
132
133 static void
134 free_gobject (GObject *obj, gpointer user_data)
135 {
136         if (obj)
137                 g_object_unref (obj);
138 }
139
140
141 static GList*
142 free_gobject_list (GList *list)
143 {
144         if (list) {
145                 g_list_foreach (list, (GFunc)free_gobject, NULL);
146                 g_list_free (list);
147         }
148         return NULL;
149 }
150
151
152 static void
153 modest_tny_account_store_finalize (GObject *obj)
154 {
155         ModestTnyAccountStore *self = MODEST_TNY_ACCOUNT_STORE(obj);
156         ModestTnyAccountStorePrivate *priv =
157                 MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
158
159         if (priv->modest_acc_mgr) {
160                 g_object_unref (G_OBJECT(priv->modest_acc_mgr));
161                 priv->modest_acc_mgr = NULL;
162         }
163
164         if (priv->tny_session_camel) {
165                 g_object_unref (G_OBJECT(priv->tny_session_camel));
166                 priv->tny_session_camel = NULL;
167         }
168
169         if (priv->device) {
170                 g_object_unref (G_OBJECT(priv->device));
171                 priv->device = NULL;
172         }
173
174         priv->store_accounts     = free_gobject_list (priv->store_accounts);
175         priv->transport_accounts = free_gobject_list (priv->store_accounts);
176
177         g_free (priv->cache_dir);
178         priv->cache_dir = NULL;
179
180
181
182 }
183
184 GObject*
185 modest_tny_account_store_new (ModestAccountMgr *modest_acc_mgr)
186 {
187         GObject *obj;
188         ModestTnyAccountStorePrivate *priv;
189
190         g_return_val_if_fail (modest_acc_mgr, NULL);
191
192         obj  = G_OBJECT(g_object_new(MODEST_TYPE_TNY_ACCOUNT_STORE, NULL));
193
194         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(obj);
195         g_object_ref(G_OBJECT(priv->modest_acc_mgr = modest_acc_mgr));
196
197         priv->device = (TnyDeviceIface*)tny_device_new();
198         if (!priv->device) {
199                 g_warning ("Cannot create Device instance");
200                 g_object_unref (obj);
201                 return NULL;
202         }
203         priv->tny_session_camel = tny_session_camel_new
204                 (TNY_ACCOUNT_STORE_IFACE(obj));
205         if (!priv->tny_session_camel) {
206                 g_warning ("Cannot create TnySessionCamel instance");
207                 g_object_unref (obj);
208                 return NULL;
209         }
210
211         return obj;
212 }
213
214
215 static gchar*
216 get_password (TnyAccountIface *account, const gchar *prompt, gboolean *cancel)
217 {
218         const gchar *key;
219         const TnyAccountStoreIface *account_store;
220         ModestTnyAccountStore *self;
221         ModestTnyAccountStorePrivate *priv;
222         gchar *val;
223
224         g_return_val_if_fail (account, NULL);
225
226         key = tny_account_iface_get_id (account);
227         account_store = tny_account_iface_get_account_store(account);
228
229         self = MODEST_TNY_ACCOUNT_STORE (account_store);
230         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
231
232         val = modest_account_mgr_get_server_account_string (priv->modest_acc_mgr, key,
233                                                                                                 MODEST_ACCOUNT_PASSWORD, NULL);
234         if (!val) {
235                 /* FIXME:
236                  * append the prompt to the emitted signal,
237                  * so the password dialog shows the prompt supplied by the caller of this function.
238                  */
239                 g_signal_emit (G_OBJECT(self), signals[PASSWORD_REQUESTED_SIGNAL], 0, key);
240         }
241
242         return val;
243 }
244
245
246 static void
247 forget_password (TnyAccountIface *account)
248 {
249         g_warning (__FUNCTION__);
250 }
251
252
253
254 static gboolean
255 add_account  (TnyAccountStoreIface *self, TnyAccountIface *account)
256 {
257         TnyAccountIface       *account_iface;
258         ModestTnyAccountStore *account_store;
259         ModestTnyAccountStorePrivate *priv;
260
261         const gchar* account_name;
262         const gchar *hostname, *username, *proto;
263
264         g_return_val_if_fail (self, FALSE);
265         g_return_val_if_fail (account, FALSE);
266
267         account_iface  = TNY_ACCOUNT_IFACE(account);
268         account_store  = MODEST_TNY_ACCOUNT_STORE(self);
269         priv           = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
270
271         account_name   = tny_account_iface_get_id(account_iface);
272         if (!account_name) {
273                 g_warning ("failed to retrieve account name");
274                 return FALSE;
275         }
276
277         hostname =  tny_account_iface_get_hostname(account_iface);
278         username =  tny_account_iface_get_user(account_iface);
279         proto    =  tny_account_iface_get_proto(account_iface);
280
281         return modest_account_mgr_add_server_account (priv->modest_acc_mgr,
282                                                       account_name,
283                                                       hostname, username, NULL,
284                                                       proto);
285 }
286
287
288 static void
289 modest_tny_account_store_add_store_account  (TnyAccountStoreIface *self,
290                                              TnyStoreAccountIface *account)
291 {
292         if (!add_account (self, TNY_ACCOUNT_IFACE(account)))
293                 g_warning ("failed to add store account");
294 }
295
296
297 static void
298 modest_tny_account_store_add_transport_account  (TnyAccountStoreIface *self,
299                                                  TnyTransportAccountIface *account)
300 {
301         if (!add_account (self, TNY_ACCOUNT_IFACE(account)))
302                 g_warning ("failed to add transport account");
303 }
304
305
306 static TnyAccountIface*
307 tny_account_from_key (ModestTnyAccountStore *self, const gchar *key,
308                       gboolean is_store)
309 {
310         TnyAccountIface *tny_account;
311         ModestTnyAccountStorePrivate *priv;
312         gchar *val;
313
314         g_return_val_if_fail (self, NULL);
315         g_return_val_if_fail (key, NULL);
316
317         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
318
319         /* is it a store or a transport? */
320         if (is_store)
321                 tny_account = TNY_ACCOUNT_IFACE(tny_store_account_new ());
322         else
323                 tny_account = TNY_ACCOUNT_IFACE(tny_transport_account_new ());
324
325         if (!tny_account) {
326                 g_warning ("failed to create new tny %s account",
327                            is_store ? "store" : "transport");
328                 return NULL;
329         }
330
331         tny_account_iface_set_account_store (TNY_ACCOUNT_IFACE(tny_account),
332                                              TNY_ACCOUNT_STORE_IFACE(self));
333         /* id */
334         tny_account_iface_set_id (tny_account, key);
335         tny_account_iface_set_name (tny_account, key);
336         
337         /* proto */
338         val = modest_account_mgr_get_server_account_string (priv->modest_acc_mgr, key,
339                                                             MODEST_ACCOUNT_PROTO, NULL);
340         if (val) {
341                 tny_account_iface_set_proto (tny_account, val);
342                 g_free (val);
343         } else {
344                 g_warning ("protocol not defined for %s", key);
345                 g_object_unref (G_OBJECT(tny_account));
346                 return NULL;
347         }
348
349         /* hostname */
350         val = modest_account_mgr_get_server_account_string (priv->modest_acc_mgr, key,
351                                                             MODEST_ACCOUNT_HOSTNAME,
352                                                             NULL);
353         if (val) {
354                 tny_account_iface_set_hostname (tny_account, val);
355                 g_free (val);
356         }
357
358
359         /* username */
360         val = modest_account_mgr_get_server_account_string (priv->modest_acc_mgr, key,
361                                                             MODEST_ACCOUNT_USERNAME,
362                                                             NULL);
363         if (val) {
364                 tny_account_iface_set_user (tny_account, val);
365                 g_free (val);
366         }
367
368         tny_account_iface_set_pass_func (tny_account, get_password);
369         tny_account_iface_set_forget_pass_func (tny_account, forget_password);
370
371         return tny_account;
372 }
373
374
375 static GList*
376 tny_accounts_from_server_accounts (ModestTnyAccountStore *self, GSList *accounts,
377                                    gboolean is_store)
378 {
379         GSList *cursor = accounts;
380         GList *tny_accounts = NULL;
381
382         g_return_val_if_fail (self, NULL);
383
384         while (cursor) {
385                 TnyAccountIface *tny_account;
386                 tny_account = tny_account_from_key (self, (gchar*)cursor->data,
387                                                     is_store);
388                 if (!tny_account) {
389                         g_warning ("could not create tnyaccount for %s",
390                                    (gchar*)cursor->data);
391                 } else {
392                         tny_accounts =
393                                 g_list_append (tny_accounts, tny_account);
394                 }
395                 cursor = cursor->next;
396         }
397
398         return tny_accounts;
399 }
400
401
402 static const GList*
403 modest_tny_account_store_get_store_accounts  (TnyAccountStoreIface *iface)
404 {
405         ModestTnyAccountStore        *self;
406         ModestTnyAccountStorePrivate *priv;
407         GSList                       *accounts;
408         GList                        *tny_accounts;
409
410         g_return_val_if_fail (iface, NULL);
411
412         self = MODEST_TNY_ACCOUNT_STORE(iface);
413         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
414
415         accounts =
416                 modest_account_mgr_server_account_names (priv->modest_acc_mgr,
417                                                          NULL,
418                                                          MODEST_PROTO_TYPE_STORE,
419                                                          NULL, FALSE);
420
421         tny_accounts = tny_accounts_from_server_accounts (self, accounts, TRUE);
422         g_slist_free (accounts);
423         
424         /*
425          * FIXME: after gconf notification support is added,
426          * we can simply return priv->store_account
427          */
428         priv->store_accounts = free_gobject_list (priv->store_accounts);
429         priv->store_accounts = tny_accounts;
430
431         return tny_accounts;
432 }
433
434
435 static const GList*
436 modest_tny_account_store_get_transport_accounts (TnyAccountStoreIface *iface)
437 {
438         ModestTnyAccountStore        *self;
439         ModestTnyAccountStorePrivate *priv;
440         GSList                       *accounts;
441         GList                        *tny_accounts;
442
443         g_return_val_if_fail (iface, NULL);
444
445         self = MODEST_TNY_ACCOUNT_STORE(iface);
446         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
447
448         accounts =
449                 modest_account_mgr_server_account_names (priv->modest_acc_mgr,
450                                                          NULL,
451                                                          MODEST_PROTO_TYPE_TRANSPORT,
452                                                          NULL, FALSE);
453         tny_accounts = tny_accounts_from_server_accounts (self, accounts, FALSE);
454         g_warning ("transport accounts: %d", g_list_length (tny_accounts));
455
456         g_slist_free (accounts);
457
458         /*
459          * FIXME: after gconf notification support is added,
460          * we can simply return priv->store_account
461          */
462         priv->transport_accounts = free_gobject_list (priv->transport_accounts);
463         priv->transport_accounts = tny_accounts;
464
465         return tny_accounts; /* FIXME: who will free this? */
466 }
467
468
469 ModestAccountMgr
470 *modest_tny_account_store_get_accout_mgr(ModestTnyAccountStore *self)
471 {
472         ModestTnyAccountStorePrivate *priv;
473         g_return_val_if_fail (self, NULL);
474
475         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
476
477         return priv->modest_acc_mgr;
478 }
479
480
481 TnySessionCamel*
482 tny_account_store_get_session (TnyAccountStore *self)
483 {
484         ModestTnyAccountStorePrivate *priv;
485         g_return_val_if_fail (self, NULL);
486
487         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
488
489         return priv->tny_session_camel;
490 }
491
492
493 /**
494  * modest_tny_account_store_get_cache_dir:
495  * @self: self a TnyAccountStoreIface instance
496  *
497  * returns the pathname of the cache directory
498  *
499  * Returns: a string with the value of the pathname
500  * to the cache directory or NULL if the environment variable $HOME is
501  * not set. string should _not_ be freed by caller
502  */
503 static const gchar*
504 modest_tny_account_store_get_cache_dir (TnyAccountStoreIface *self)
505 {
506         ModestTnyAccountStorePrivate *priv;
507         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE(self);
508
509         if (!priv->cache_dir) {
510                 if (g_getenv("HOME") != NULL)
511                         priv->cache_dir = g_strconcat(g_getenv("HOME"),
512                                                       "/.modest/cache/", NULL);
513         }
514         return priv->cache_dir;
515 }
516
517
518 static const TnyDeviceIface*
519 modest_tny_account_store_get_device (TnyAccountStoreIface *self)
520 {
521         ModestTnyAccountStorePrivate *priv;
522
523         priv = MODEST_TNY_ACCOUNT_STORE_GET_PRIVATE (self);
524
525         return priv->device;
526 }
527
528
529 static void
530 modest_tny_account_store_iface_init (gpointer g_iface, gpointer iface_data)
531 {
532         TnyAccountStoreIfaceClass *klass;
533
534         g_return_if_fail (g_iface);
535
536         klass = (TnyAccountStoreIfaceClass *)g_iface;
537
538         klass->add_store_account_func      =
539                 modest_tny_account_store_add_store_account;
540         klass->get_store_accounts_func     =
541                 modest_tny_account_store_get_store_accounts;
542         klass->add_transport_account_func  =
543                 modest_tny_account_store_add_transport_account;
544         klass->get_transport_accounts_func =
545                 modest_tny_account_store_get_transport_accounts;
546         klass->get_cache_dir_func =
547                 modest_tny_account_store_get_cache_dir;
548         klass->get_device_func =
549                 modest_tny_account_store_get_device;
550 }