* only support 'enabled/disabled' for accounts, not server accounts
[modest] / src / modest-account-mgr.c
1 /* Copyright (c) 2006, Nokia Corporation
2  * All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
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.
16  *
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.
28  */
29
30 #include <string.h>
31 #include "modest-marshal.h"
32 #include "modest-account-keys.h"
33 #include "modest-account-mgr.h"
34
35 /* 'private'/'protected' functions */
36 static void modest_account_mgr_class_init (ModestAccountMgrClass * klass);
37 static void modest_account_mgr_init (ModestAccountMgr * obj);
38 static void modest_account_mgr_finalize (GObject * obj);
39
40 static gchar *get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account);
41
42 /* list my signals */
43 enum {
44         ACCOUNT_CHANGED_SIGNAL,
45         ACCOUNT_REMOVED_SIGNAL,
46         LAST_SIGNAL
47 };
48
49 typedef struct _ModestAccountMgrPrivate ModestAccountMgrPrivate;
50 struct _ModestAccountMgrPrivate {
51         ModestConf *modest_conf;
52         GSList *current_accounts;
53 };
54
55 #define MODEST_ACCOUNT_MGR_GET_PRIVATE(o)      (G_TYPE_INSTANCE_GET_PRIVATE((o), \
56                                                 MODEST_TYPE_ACCOUNT_MGR, \
57                                                 ModestAccountMgrPrivate))
58 /* globals */
59 static GObjectClass *parent_class = NULL;
60
61 static guint signals[LAST_SIGNAL] = {0};
62
63
64 static gchar*
65 account_from_key (const gchar *key, gboolean *is_account_key, gboolean *is_server_account)
66 {
67         const gchar* account_ns        = MODEST_ACCOUNT_NAMESPACE "/";
68         const gchar* server_account_ns = MODEST_SERVER_ACCOUNT_NAMESPACE "/";
69         gchar *cursor;
70         gchar *account = NULL;
71
72         /* determine if it's an account or a server account,
73          * based on the prefix */
74         if (g_str_has_prefix (key, account_ns)) {
75
76                 if (is_server_account)
77                         *is_server_account = FALSE;
78                 
79                 account = g_strdup (key + strlen (account_ns));
80
81         } else if (g_str_has_prefix (key, server_account_ns)) {
82
83                 if (is_server_account)
84                         *is_server_account = TRUE;
85                 
86                 account = g_strdup (key + strlen (server_account_ns));  
87         } else
88                 return NULL;
89
90         /* if there are any slashes left in the key, it's not
91          * the toplevel entry for an account
92          */
93         cursor = strstr(account, "/");
94         
95         if (is_account_key && cursor)
96                 *is_account_key = TRUE;
97
98         /* put a NULL where the first slash was */
99         if (cursor)
100                 *cursor = '\0';
101                 
102         return account;
103 }
104
105
106
107
108 static void
109 on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data)
110 {
111         ModestAccountMgr *self;
112         ModestAccountMgrPrivate *priv;
113
114         gchar *account;
115         gboolean is_account_key, is_server_account;
116         gboolean enabled;
117
118         self = MODEST_ACCOUNT_MGR (user_data);
119         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
120         
121         account = account_from_key (key, &is_account_key, &is_server_account);
122
123         /* if this is not an account-related key change, ignore */
124         if (!account)
125                 return;
126
127         /* account was removed -- emit this, even if the account was disabled */
128         if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) {
129                 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0,
130                                account, is_server_account);
131                 g_free (account);
132                 return;
133         }
134
135         /* is this account enabled? */
136         if (is_server_account)
137                 enabled = TRUE;
138         else 
139                 enabled = modest_account_mgr_account_get_enabled (self, account);
140
141         /* account was changed.
142          * and always notify when enabled/disabled changes
143          */
144         if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED)) 
145                 g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0,
146                                account, key, is_server_account);
147
148         g_free (account);
149 }
150
151
152 GType
153 modest_account_mgr_get_type (void)
154 {
155         static GType my_type = 0;
156
157         if (!my_type) {
158                 static const GTypeInfo my_info = {
159                         sizeof (ModestAccountMgrClass),
160                         NULL,   /* base init */
161                         NULL,   /* base finalize */
162                         (GClassInitFunc) modest_account_mgr_class_init,
163                         NULL,   /* class finalize */
164                         NULL,   /* class data */
165                         sizeof (ModestAccountMgr),
166                         1,      /* n_preallocs */
167                         (GInstanceInitFunc) modest_account_mgr_init,
168                 };
169
170                 my_type = g_type_register_static (G_TYPE_OBJECT,
171                                                   "ModestAccountMgr",
172                                                   &my_info, 0);
173         }
174         return my_type;
175 }
176
177 static void
178 modest_account_mgr_class_init (ModestAccountMgrClass * klass)
179 {
180         GObjectClass *gobject_class;
181         gobject_class = (GObjectClass *) klass;
182
183         parent_class = g_type_class_peek_parent (klass);
184         gobject_class->finalize = modest_account_mgr_finalize;
185
186         g_type_class_add_private (gobject_class,
187                                   sizeof (ModestAccountMgrPrivate));
188
189         /* signal definitions */
190         signals[ACCOUNT_REMOVED_SIGNAL] =
191                 g_signal_new ("account_removed",
192                               G_TYPE_FROM_CLASS (klass),
193                               G_SIGNAL_RUN_FIRST,
194                               G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed),
195                               NULL, NULL,
196                               modest_marshal_VOID__STRING_BOOLEAN,
197                               G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN);
198         signals[ACCOUNT_CHANGED_SIGNAL] =
199                 g_signal_new ("account_changed",
200                                G_TYPE_FROM_CLASS (klass),
201                               G_SIGNAL_RUN_FIRST,
202                               G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed),
203                               NULL, NULL,
204                               modest_marshal_VOID__STRING_STRING_BOOLEAN,
205                               G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN);
206 }
207
208
209 static void
210 modest_account_mgr_init (ModestAccountMgr * obj)
211 {
212         ModestAccountMgrPrivate *priv =
213                 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
214
215         priv->modest_conf = NULL;
216 }
217
218 static void
219 modest_account_mgr_finalize (GObject * obj)
220 {
221         ModestAccountMgrPrivate *priv =
222                 MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
223
224         if (priv->modest_conf) {
225                 g_object_unref (G_OBJECT(priv->modest_conf));
226                 priv->modest_conf = NULL;
227         }
228 }
229
230
231 ModestAccountMgr *
232 modest_account_mgr_new (ModestConf * conf)
233 {
234         GObject *obj;
235         ModestAccountMgrPrivate *priv;
236
237         g_return_val_if_fail (conf, NULL);
238
239         obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL));
240         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj);
241
242         g_object_ref (G_OBJECT(conf));
243         priv->modest_conf = conf;
244
245         g_signal_connect (G_OBJECT (conf), "key_changed",
246                           G_CALLBACK (on_key_change),
247                           obj);
248         
249         return MODEST_ACCOUNT_MGR (obj);
250 }
251
252
253 static const gchar *
254 null_means_empty (const gchar * str)
255 {
256         return str ? str : "";
257 }
258
259
260 gboolean
261 modest_account_mgr_account_set_enabled (ModestAccountMgr *self, const gchar* name,
262                                         gboolean enabled)
263 {
264         return modest_account_mgr_set_bool (self, name,
265                                             MODEST_ACCOUNT_ENABLED, enabled,
266                                             FALSE, NULL);
267 }
268
269
270 gboolean
271 modest_account_mgr_account_get_enabled (ModestAccountMgr *self, const gchar* name)
272 {
273         return modest_account_mgr_get_bool (self, name,
274                                             MODEST_ACCOUNT_ENABLED, FALSE,
275                                             NULL);
276 }
277
278
279 gboolean
280 modest_account_mgr_add_account (ModestAccountMgr *self,
281                                 const gchar *name,
282                                 const gchar *store_account,
283                                 const gchar *transport_account,
284                                 GError **err)
285 {
286         ModestAccountMgrPrivate *priv;
287         gchar *key;
288         gboolean ok;
289
290         g_return_val_if_fail (self, FALSE);
291         g_return_val_if_fail (name, FALSE);
292
293         if (modest_account_mgr_account_exists (self, name, FALSE, err)) {
294                 g_printerr ("modest: account already exists\n");
295                 return FALSE;
296         }
297         
298         /*
299          * we create the account by adding an account 'dir', with the name <name>,
300          * and in that the 'display_name' string key
301          */
302         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
303         
304         key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
305         ok = modest_conf_set_string (priv->modest_conf, key, name, err);
306         g_free (key);
307
308         if (!ok) {
309                 g_printerr ("modest: cannot set display name\n");
310                 return FALSE;
311         }
312         
313         if (store_account) {
314                 key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE);
315                 ok = modest_conf_set_string (priv->modest_conf, key, store_account, err);
316                 g_free (key);
317                 if (!ok) {
318                         g_printerr ("modest: failed to set store account '%s'\n",
319                                 store_account);
320                         return FALSE;
321                 }
322         }
323
324         if (transport_account) {
325                 key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE);
326                 ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err);
327                 g_free (key);
328                 if (!ok) {
329                         g_printerr ("modest: failed to set transport account '%s'\n",
330                                 transport_account);
331                         return FALSE;
332                 }
333         }
334
335         modest_account_mgr_account_set_enabled (self, name, TRUE);
336         
337         return TRUE;
338 }
339
340
341
342
343 gboolean
344 modest_account_mgr_add_server_account (ModestAccountMgr * self,
345                                        const gchar * name,
346                                        const gchar * hostname,
347                                        const gchar * username,
348                                        const gchar * password,
349                                        const gchar * proto)
350 {
351         ModestAccountMgrPrivate *priv;
352         gchar *key;
353
354         g_return_val_if_fail (self, FALSE);
355         g_return_val_if_fail (name, FALSE);
356
357         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
358
359         key = get_account_keyname (name, NULL, TRUE);
360         if (modest_conf_key_exists (priv->modest_conf, key, NULL)) {
361                 g_printerr ("modest: server account '%s' already exists", name);
362                 g_free (key);
363                 return FALSE;
364         }
365         g_free (key);
366         
367         /* hostname */
368         key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE);
369         modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL);
370         g_free (key);
371
372         /* username */
373         key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE);
374         modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL);
375         g_free (key);
376
377         /* password */
378         key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE);
379         modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL);
380         g_free (key);
381
382         /* proto */
383         key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE);
384         modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL);
385         g_free (key);
386         
387         return TRUE;
388 }
389
390
391
392 gboolean
393 modest_account_mgr_remove_account (ModestAccountMgr * self,
394                                    const gchar * name,
395                                    gboolean server_account,
396                                    GError ** err)
397 {
398         ModestAccountMgrPrivate *priv;
399         gchar *key;
400         gboolean retval;
401
402         g_return_val_if_fail (self, FALSE);
403         g_return_val_if_fail (name, FALSE);
404
405         if (!modest_account_mgr_account_exists (self, name, server_account, err)) {
406                 g_printerr ("modest: account '%s' does not exist\n", name);
407                 return FALSE;
408         }
409
410         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
411         key = get_account_keyname (name, NULL, server_account);
412
413         retval = modest_conf_remove_key (priv->modest_conf, key, NULL);
414
415         g_free (key);
416         return retval;
417 }
418
419
420
421 /* strip the first /n/ character from each element */
422 /* caller must make sure all elements are strings with
423  * length >= n, and also that data can be freed.
424  */
425 static GSList*
426 strip_prefix_from_elements (GSList * lst, guint n)
427 {
428         GSList *cursor = lst;
429
430         while (cursor) {
431                 gchar *str = (gchar *) cursor->data;
432                 cursor->data = g_strdup (str + n);
433                 g_free (str);
434                 cursor = cursor->next;
435         }
436         return lst;
437 }
438
439
440 GSList *
441 modest_account_mgr_search_server_accounts (ModestAccountMgr * self,
442                                            const gchar * account_name,
443                                            ModestProtoType type,
444                                            const gchar *proto)
445 {
446         GSList *accounts;
447         GSList *cursor;
448         ModestAccountMgrPrivate *priv;
449         gchar *key;
450         GError *err = NULL;
451         
452         g_return_val_if_fail (self, NULL);
453         
454         key      = get_account_keyname (account_name, NULL, TRUE);
455         priv     = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
456         
457         /* get the list of all server accounts */
458         accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err);
459         if (err) {
460                 g_error_free (err);
461                 g_printerr ("modest: failed to get subkeys for '%s'\n", key);
462                 return NULL;
463         }
464         
465         /* no restrictions, return everything */
466         if (type == MODEST_PROTO_TYPE_ANY && !proto)
467                 return strip_prefix_from_elements (accounts, strlen(key)+1);
468         /* +1 because we must remove the ending '/' as well */
469         
470         /* otherwise, filter out the none-matching ones */
471         cursor = accounts;
472         while (cursor) {
473                 gchar *account;
474                 gchar *acc_proto;
475                 
476                 account = account_from_key ((gchar*)cursor->data, NULL, NULL);
477                 acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO,
478                                                            TRUE, NULL);
479                 if ((!acc_proto) ||                                /* proto not defined? */
480                     (type != MODEST_PROTO_TYPE_ANY &&              /* proto type ...     */
481                      modest_proto_type (acc_proto) != type) ||     /* ... matches?       */
482                     (proto && strcmp (proto, acc_proto) != 0)) {  /* proto matches?     */
483                         /* match! remove from the list */
484                         GSList *nxt = cursor->next;
485                         accounts = g_slist_delete_link (accounts, cursor);
486                         cursor = nxt;
487                 } else
488                         cursor = cursor->next;
489
490                 g_free (account);
491                 g_free (acc_proto);
492         }
493
494         return strip_prefix_from_elements (accounts, strlen(key)+1);
495         /* +1 because we must remove the ending '/' as well */
496 }
497
498
499 GSList *
500 modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err)
501 {
502         GSList *accounts;
503         ModestAccountMgrPrivate *priv;
504         const size_t prefix_len = strlen (MODEST_ACCOUNT_NAMESPACE "/");
505
506         g_return_val_if_fail (self, NULL);
507
508         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
509
510         accounts = modest_conf_list_subkeys (priv->modest_conf,
511                                              MODEST_ACCOUNT_NAMESPACE, err);
512         
513         return strip_prefix_from_elements (accounts, prefix_len);
514 }
515
516
517 gchar *
518 modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name,
519                                const gchar *key, gboolean server_account, GError **err) {
520
521         ModestAccountMgrPrivate *priv;
522
523         gchar *keyname;
524         gchar *retval;
525
526         g_return_val_if_fail (self, NULL);
527         g_return_val_if_fail (name, NULL);
528         g_return_val_if_fail (key, NULL);
529
530         keyname = get_account_keyname (name, key, server_account);
531         
532         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
533         retval = modest_conf_get_string (priv->modest_conf, keyname, err);
534         g_free (keyname);
535
536         return retval;
537 }
538
539
540 gint
541 modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name,
542                             const gchar *key, gboolean server_account, GError **err)
543 {
544         ModestAccountMgrPrivate *priv;
545
546         gchar *keyname;
547         gint retval;
548
549         g_return_val_if_fail (self, -1);
550         g_return_val_if_fail (name, -1);
551         g_return_val_if_fail (key, -1);
552
553         keyname = get_account_keyname (name, key, server_account);
554
555         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
556         retval = modest_conf_get_int (priv->modest_conf, keyname, err);
557         g_free (keyname);
558
559         return retval;
560 }
561
562
563
564 gboolean
565 modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account,
566                              const gchar * key, gboolean server_account, GError ** err)
567 {
568         ModestAccountMgrPrivate *priv;
569
570         gchar *keyname;
571         gboolean retval;
572
573         g_return_val_if_fail (self, FALSE);
574         g_return_val_if_fail (account, FALSE);
575         g_return_val_if_fail (key, FALSE);
576
577         keyname = get_account_keyname (account, key, server_account);
578         
579         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
580         retval = modest_conf_get_bool (priv->modest_conf, keyname, err);
581                 
582         g_free (keyname);
583
584         return retval;
585 }
586
587
588 gboolean
589 modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name,
590                                const gchar * key, const gchar * val,
591                                gboolean server_account, GError ** err)
592 {
593         ModestAccountMgrPrivate *priv;
594
595         gchar *keyname;
596         gboolean retval;
597
598         g_return_val_if_fail (self, FALSE);
599         g_return_val_if_fail (name, FALSE);
600         g_return_val_if_fail (key, FALSE);
601
602         keyname = get_account_keyname (name, key, server_account);
603         
604         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
605
606         retval = modest_conf_set_string (priv->modest_conf, keyname, val,
607                                          err);
608
609         g_free (keyname);
610         return retval;
611 }
612
613
614 gboolean
615 modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name,
616                             const gchar * key, int val, gboolean server_account,
617                             GError ** err)
618 {
619         ModestAccountMgrPrivate *priv;
620
621         gchar *keyname;
622         gboolean retval;
623
624         g_return_val_if_fail (self, FALSE);
625         g_return_val_if_fail (name, FALSE);
626         g_return_val_if_fail (key, FALSE);
627
628         keyname = get_account_keyname (name, key, server_account);
629         
630         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
631
632         retval = modest_conf_set_int (priv->modest_conf, keyname, val, err);
633
634         g_free (keyname);
635         return retval;
636 }
637
638
639
640 gboolean
641 modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name,
642                              const gchar * key, gboolean val, gboolean server_account, 
643                              GError ** err)
644 {
645         ModestAccountMgrPrivate *priv;
646
647         gchar *keyname;
648         gboolean retval;
649
650         g_return_val_if_fail (self, FALSE);
651         g_return_val_if_fail (name, FALSE);
652         g_return_val_if_fail (key, FALSE);
653
654         keyname = get_account_keyname (name, key, server_account);
655
656         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
657
658         retval = modest_conf_set_bool (priv->modest_conf, keyname, val, err);
659
660         g_free (keyname);
661         return retval;
662 }
663
664
665 gboolean
666 modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name,
667                                    gboolean server_account, GError ** err)
668 {
669         ModestAccountMgrPrivate *priv;
670
671         gchar *keyname;
672         gboolean retval;
673
674         g_return_val_if_fail (self, FALSE);
675         g_return_val_if_fail (name, FALSE);
676
677         keyname = get_account_keyname (name, NULL, server_account);
678
679         priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self);
680         retval = modest_conf_key_exists (priv->modest_conf, keyname, err);
681
682         g_free (keyname);
683         return retval;
684 }
685
686
687 /* must be freed by caller */
688 static gchar *
689 get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account)
690 {
691         gchar *namespace, *account_name, *retval;
692         
693         namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE;
694
695         if (!accname)
696                 return g_strdup (namespace);
697
698         account_name = modest_conf_key_escape (NULL, accname);
699         
700         if (name)
701                 retval = g_strconcat (namespace, "/", accname, "/", name, NULL);
702         else
703                 retval = g_strconcat (namespace, "/", accname, NULL);
704
705         g_free (account_name);
706
707         return retval;
708 }