From 203c13a878a174540019a9d558ef867b797805e1 Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Tue, 11 Jul 2006 16:25:30 +0000 Subject: [PATCH] * many changes: - merge separate account_ and server_account functions into one - fixed signals when changes take place in the backend (modest conf) - removed internal cache of account names, but always use modest-conf - cleaned up 'check_change' - implemented enabling/disabling of accounts, and signals understand this, as well as the 'search' function - simplified a lot of code, refactoring, cosmetics pmo-trunk-r359 --- src/modest-account-mgr.c | 731 +++++++++++++++++++--------------------------- src/modest-account-mgr.h | 192 ++++++------ 2 files changed, 398 insertions(+), 525 deletions(-) diff --git a/src/modest-account-mgr.c b/src/modest-account-mgr.c index 04d2b58..76d042b 100644 --- a/src/modest-account-mgr.c +++ b/src/modest-account-mgr.c @@ -27,9 +27,6 @@ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ -/* modest-account-mgr.c */ - - #include #include "modest-marshal.h" #include "modest-account-keys.h" @@ -40,15 +37,12 @@ static void modest_account_mgr_class_init (ModestAccountMgrClass * klass); static void modest_account_mgr_init (ModestAccountMgr * obj); static void modest_account_mgr_finalize (GObject * obj); -static gchar *get_account_keyname (const gchar * accname, const gchar * name); -static gchar *get_server_account_keyname (const gchar * accname, - const gchar * name); +static gchar *get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account); /* list my signals */ enum { - ACCOUNT_CHANGE_SIGNAL, - ACCOUNT_REMOVE_SIGNAL, - ACCOUNT_ADD_SIGNAL, + ACCOUNT_CHANGED_SIGNAL, + ACCOUNT_REMOVED_SIGNAL, LAST_SIGNAL }; @@ -67,84 +61,85 @@ static GObjectClass *parent_class = NULL; static guint signals[LAST_SIGNAL] = {0}; -static GSList * -delete_account_from_list (GSList *list, const gchar *name) +static gchar* +account_from_key (const gchar *key, gboolean *is_account_key, gboolean *is_server_account) { - GSList *iter, *result; - - iter = list; - result = list; - while (iter) { - if (!strcmp (name, iter->data)) { - result = g_slist_delete_link (list, iter); - break; - } + const gchar* account_ns = MODEST_ACCOUNT_NAMESPACE "/"; + const gchar* server_account_ns = MODEST_SERVER_ACCOUNT_NAMESPACE "/"; + gchar *cursor; + gchar *account = NULL; - iter = g_slist_next (iter); - } - return result; -} + /* determine if it's an account or a server account, + * based on the prefix */ + if (g_str_has_prefix (key, account_ns)) { -static GSList * -find_account_in_list (GSList *list, const gchar *name) -{ - GSList *iter, *result; - - iter = list; - result = list; - while (iter) { - if (!strcmp (name, iter->data)) { - return iter; - break; - } + if (is_server_account) + *is_server_account = FALSE; + + account = g_strdup (key + strlen (account_ns)); - iter = g_slist_next (iter); - } - return NULL; -} + } else if (g_str_has_prefix (key, server_account_ns)) { -/* Map configuration changes to account changes. - * Doing this here makes sure all changes are available and external changes - * are covered as well. */ + if (is_server_account) + *is_server_account = TRUE; + + account = g_strdup (key + strlen (server_account_ns)); + } else + return NULL; -static void -modest_account_mgr_check_change (ModestConf *conf, const gchar *key, - const gchar *new_value, gpointer user_data) -{ - ModestAccountMgr *amgr = user_data; - ModestAccountMgrPrivate *priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (amgr); + /* if there are any slashes left in the key, it's not + * the toplevel entry for an account + */ + cursor = strstr(account, "/"); + + if (is_account_key && cursor) + *is_account_key = TRUE; - if ((strlen (key) > strlen (MODEST_SERVER_ACCOUNT_NAMESPACE "/") - && g_str_has_prefix (key, MODEST_SERVER_ACCOUNT_NAMESPACE))) { - gchar *subkey = g_strdup(key + strlen (MODEST_SERVER_ACCOUNT_NAMESPACE "/")); + /* put a NULL where the first slash was */ + if (cursor) + *cursor = '\0'; + + return account; +} - if (! strstr (subkey, "/")) { /* no more '/' means an account was modified */ - if (!new_value) { - priv->current_accounts = - delete_account_from_list (priv->current_accounts, subkey); - g_signal_emit (amgr, signals[ACCOUNT_REMOVE_SIGNAL], 0, subkey); - } - } - else { - gchar *param; - param = strstr (subkey, "/"); - param [0] = 0; - param++; - /* that's the second case for a new account */ - if (!find_account_in_list (priv->current_accounts, subkey) && strstr (param, MODEST_ACCOUNT_PROTO)) { - priv->current_accounts = - g_slist_prepend (priv->current_accounts, g_strdup (subkey)); - g_signal_emit (amgr, signals[ACCOUNT_ADD_SIGNAL], 0, subkey); - } +static void +on_key_change (ModestConf *conf, const gchar *key, ModestConfEvent event, gpointer user_data) +{ + ModestAccountMgr *self; + ModestAccountMgrPrivate *priv; - g_signal_emit (amgr, signals[ACCOUNT_CHANGE_SIGNAL], 0, subkey, param, new_value); - } + gchar *account; + gboolean is_account_key, is_server_account; + gboolean enabled; - g_free (subkey); + self = MODEST_ACCOUNT_MGR (user_data); + priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); + + account = account_from_key (key, &is_account_key, &is_server_account); + + /* account was removed -- emit this, even if the account was disabled */ + if (is_account_key && event == MODEST_CONF_EVENT_KEY_UNSET) { + g_signal_emit (G_OBJECT(self), signals[ACCOUNT_REMOVED_SIGNAL], 0, + account, is_server_account); + g_free (account); + return; } + + /* is this account enabled? */ + enabled = modest_account_mgr_account_is_enabled (self, account, + is_server_account); + + /* account was changed. + * and always notify when enabled/disabled changes + */ + if (enabled || g_str_has_suffix (key, MODEST_ACCOUNT_ENABLED)) + g_signal_emit (G_OBJECT(self), signals[ACCOUNT_CHANGED_SIGNAL], 0, + account, key, is_server_account); + + g_free (account); } @@ -188,32 +183,30 @@ modest_account_mgr_class_init (ModestAccountMgrClass * klass) sizeof (ModestAccountMgrPrivate)); /* signal definitions */ - signals[ACCOUNT_ADD_SIGNAL] = - g_signal_newv ("account-add", - G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, - NULL, NULL, NULL, - g_cclosure_marshal_VOID__POINTER, - G_TYPE_NONE, 1, paramtypes); - - signals[ACCOUNT_REMOVE_SIGNAL] = - g_signal_newv ("account-remove", - G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, - NULL, NULL, NULL, - g_cclosure_marshal_VOID__POINTER, - G_TYPE_NONE, 1, paramtypes); - signals[ACCOUNT_CHANGE_SIGNAL] = - g_signal_newv ("account-change", - G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST, - NULL, NULL, NULL, - modest_marshal_VOID__POINTER_POINTER_POINTER, - G_TYPE_NONE, 3, paramtypes); + signals[ACCOUNT_REMOVED_SIGNAL] = + g_signal_new ("account_removed", + G_TYPE_FROM_CLASS (klass), + G_SIGNAL_RUN_FIRST, + G_STRUCT_OFFSET(ModestAccountMgrClass,account_removed), + NULL, NULL, + modest_marshal_VOID__STRING_BOOLEAN, + G_TYPE_NONE, 2, G_TYPE_STRING, G_TYPE_BOOLEAN); + signals[ACCOUNT_CHANGED_SIGNAL] = + g_signal_new ("account_changed", + G_TYPE_FROM_CLASS (klass), + G_SIGNAL_RUN_FIRST, + G_STRUCT_OFFSET(ModestAccountMgrClass,account_changed), + NULL, NULL, + modest_marshal_VOID__STRING_STRING_BOOLEAN, + G_TYPE_NONE, 3, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_BOOLEAN); } static void modest_account_mgr_init (ModestAccountMgr * obj) { - ModestAccountMgrPrivate *priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj); + ModestAccountMgrPrivate *priv = + MODEST_ACCOUNT_MGR_GET_PRIVATE (obj); priv->modest_conf = NULL; } @@ -221,13 +214,10 @@ modest_account_mgr_init (ModestAccountMgr * obj) static void modest_account_mgr_finalize (GObject * obj) { - ModestAccountMgr *self = MODEST_ACCOUNT_MGR (obj); - ModestAccountMgrPrivate *priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); - - if (priv->modest_conf) { - g_object_unref (G_OBJECT(priv->modest_conf)); - priv->modest_conf = NULL; - } + ModestAccountMgrPrivate *priv = + MODEST_ACCOUNT_MGR_GET_PRIVATE (obj); + + priv->modest_conf = NULL; } GObject * @@ -241,97 +231,115 @@ modest_account_mgr_new (ModestConf * conf) obj = G_OBJECT (g_object_new (MODEST_TYPE_ACCOUNT_MGR, NULL)); priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (obj); - /* - * increase the ref count on the modest_conf. Normally, the - * ModestConf should outlive the ModestAccountMgr though - */ - g_object_ref (G_OBJECT (priv->modest_conf = conf)); - - priv->current_accounts = modest_account_mgr_account_names (MODEST_ACCOUNT_MGR(obj), NULL); + priv->modest_conf = conf; - g_signal_connect (G_OBJECT (conf), "key-changed", - G_CALLBACK (modest_account_mgr_check_change), obj); + g_signal_connect (G_OBJECT (conf), "key_changed", + G_CALLBACK (on_key_change), + obj); return obj; } +static const gchar * +null_means_empty (const gchar * str) +{ + return str ? str : ""; +} + + + +gboolean +modest_account_mgr_disable_account (ModestAccountMgr *self, const gchar* name, + gboolean is_server_account) +{ + return modest_account_mgr_set_bool (self, name, + MODEST_ACCOUNT_ENABLED, FALSE, + is_server_account, NULL); +} + + +gboolean +modest_account_mgr_enable_account (ModestAccountMgr *self, const gchar* name, + gboolean is_server_account) +{ + return modest_account_mgr_set_bool (self, name, + MODEST_ACCOUNT_ENABLED, TRUE, + is_server_account, NULL); +} + + gboolean -modest_account_mgr_add_account (ModestAccountMgr * self, const gchar * name, - const gchar * store_account, - const gchar * transport_account, - GError ** err) +modest_account_mgr_account_is_enabled (ModestAccountMgr *self, const gchar* name, + gboolean is_server_account) +{ + return modest_account_mgr_get_bool (self, name, + MODEST_ACCOUNT_ENABLED, is_server_account, + NULL); +} + + +gboolean +modest_account_mgr_add_account (ModestAccountMgr *self, + const gchar *name, + const gchar *store_account, + const gchar *transport_account, + GError **err) { ModestAccountMgrPrivate *priv; gchar *key; + gboolean ok; g_return_val_if_fail (self, FALSE); g_return_val_if_fail (name, FALSE); - if (modest_account_mgr_account_exists (self, name, err)) { - g_warning ("account already exists"); - //return FALSE; + if (modest_account_mgr_account_exists (self, name, FALSE, err)) { + g_printerr ("modest: account already exists\n"); + return FALSE; } + /* * we create the account by adding an account 'dir', with the name , * and in that the 'display_name' string key */ priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); - - key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME); - modest_conf_set_string (priv->modest_conf, key, name, err); + + key = get_account_keyname (name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE); + ok = modest_conf_set_string (priv->modest_conf, key, name, err); g_free (key); + if (!ok) { + g_printerr ("modest: cannot set display name\n"); + return FALSE; + } + if (store_account) { - key = get_account_keyname (name, - MODEST_ACCOUNT_STORE_ACCOUNT); - modest_conf_set_string (priv->modest_conf, key, store_account, - err); + key = get_account_keyname (name, MODEST_ACCOUNT_STORE_ACCOUNT, FALSE); + ok = modest_conf_set_string (priv->modest_conf, key, store_account, err); g_free (key); + if (!ok) { + g_printerr ("modest: failed to set store account '%s'\n", + store_account); + return FALSE; + } } if (transport_account) { - key = get_account_keyname (name, - MODEST_ACCOUNT_TRANSPORT_ACCOUNT); - modest_conf_set_string (priv->modest_conf, key, - transport_account, err); + key = get_account_keyname (name, MODEST_ACCOUNT_TRANSPORT_ACCOUNT, FALSE); + ok = modest_conf_set_string (priv->modest_conf, key, transport_account, err); g_free (key); + if (!ok) { + g_printerr ("modest: failed to set transport account '%s'\n", + transport_account); + return FALSE; + } } - return TRUE; /* TODO: error handling */ -} - - -gboolean -modest_account_mgr_remove_account (ModestAccountMgr * self, - const gchar * name, GError ** err) -{ - ModestAccountMgrPrivate *priv; - gchar *key; - gboolean retval; - - g_return_val_if_fail (self, FALSE); - g_return_val_if_fail (name, FALSE); - - if (!modest_account_mgr_account_exists (self, name, err)) { - g_warning ("account doest not exist"); - return FALSE; - } - - priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); - key = get_account_keyname (name, NULL); - - retval = modest_conf_remove_key (priv->modest_conf, key, NULL); - - g_free (key); - return retval; + modest_account_mgr_enable_account (self, name, FALSE); + + return TRUE; } -static const gchar * -null_means_empty (const gchar * str) -{ - return str ? str : ""; -} gboolean @@ -343,95 +351,89 @@ modest_account_mgr_add_server_account (ModestAccountMgr * self, const gchar * proto) { ModestAccountMgrPrivate *priv; - gchar *acckey, *key; + gchar *key; g_return_val_if_fail (self, FALSE); g_return_val_if_fail (name, FALSE); - /* TODO: check already exists */ - priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); - acckey = g_strconcat (MODEST_SERVER_ACCOUNT_NAMESPACE, "/", - name, NULL); - if (modest_conf_key_exists (priv->modest_conf, acckey, NULL)) { - g_warning ("server account %s already exists", name); - //g_free (acckey); - //return FALSE; + key = get_account_keyname (name, NULL, TRUE); + if (modest_conf_key_exists (priv->modest_conf, key, NULL)) { + g_printerr ("modest: server account '%s' already exists", name); + g_free (key); + return FALSE; } - + g_free (key); + /* hostname */ - key = g_strconcat (acckey, "/", MODEST_ACCOUNT_HOSTNAME, NULL); - modest_conf_set_string (priv->modest_conf, key, - null_means_empty (hostname), NULL); + key = get_account_keyname (name, MODEST_ACCOUNT_HOSTNAME, TRUE); + modest_conf_set_string (priv->modest_conf, key, null_means_empty(hostname), NULL); g_free (key); /* username */ - key = g_strconcat (acckey, "/", MODEST_ACCOUNT_USERNAME, NULL); - modest_conf_set_string (priv->modest_conf, key, - null_means_empty (username), NULL); + key = get_account_keyname (name, MODEST_ACCOUNT_USERNAME, TRUE); + modest_conf_set_string (priv->modest_conf, key, null_means_empty (username), NULL); g_free (key); /* password */ - if (password) { - key = g_strconcat (acckey, "/", MODEST_ACCOUNT_PASSWORD, - NULL); - modest_conf_set_string (priv->modest_conf, key, - null_means_empty (password), NULL); - g_free (key); - } + key = get_account_keyname (name, MODEST_ACCOUNT_PASSWORD, TRUE); + modest_conf_set_string (priv->modest_conf, key, null_means_empty (password), NULL); + g_free (key); /* proto */ - key = g_strconcat (acckey, "/", MODEST_ACCOUNT_PROTO, NULL); - modest_conf_set_string (priv->modest_conf, key, - null_means_empty (proto), NULL); + key = get_account_keyname (name, MODEST_ACCOUNT_PROTO, TRUE); + modest_conf_set_string (priv->modest_conf, key, null_means_empty (proto), NULL); g_free (key); - g_free (acckey); - return TRUE; /* FIXME: better error checking */ + /* enable it */ + modest_account_mgr_enable_account (self, name, TRUE); + + return TRUE; } + + gboolean -modest_account_mgr_remove_server_account (ModestAccountMgr * self, - const gchar * name, GError ** err) +modest_account_mgr_remove_account (ModestAccountMgr * self, + const gchar * name, + gboolean server_account, + GError ** err) { ModestAccountMgrPrivate *priv; - gchar *acckey; + gchar *key; gboolean retval; g_return_val_if_fail (self, FALSE); g_return_val_if_fail (name, FALSE); - priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); - - acckey = g_strconcat (MODEST_SERVER_ACCOUNT_NAMESPACE, "/", - name, NULL); - - if (!modest_conf_key_exists (priv->modest_conf, acckey, NULL)) { - g_warning ("server account %s does not exist exist", name); - g_free (acckey); + if (!modest_account_mgr_account_exists (self, name, server_account, err)) { + g_printerr ("modest: account '%s' does not exist\n", name); return FALSE; } - retval = modest_conf_remove_key (priv->modest_conf, acckey, NULL); - g_free (acckey); + priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); + key = get_account_keyname (name, NULL, server_account); + + retval = modest_conf_remove_key (priv->modest_conf, key, NULL); + g_free (key); return retval; } + /* strip the first /n/ character from each element */ /* caller must make sure all elements are strings with * length >= n, and also that data can be freed. */ -static GSList * +static GSList* strip_prefix_from_elements (GSList * lst, guint n) { GSList *cursor = lst; while (cursor) { gchar *str = (gchar *) cursor->data; - cursor->data = g_strdup (str + n); g_free (str); cursor = cursor->next; @@ -441,58 +443,66 @@ strip_prefix_from_elements (GSList * lst, guint n) GSList * -modest_account_mgr_server_account_names (ModestAccountMgr * self, - const gchar * account_name, - ModestProtoType type, - const gchar * proto, - gboolean only_enabled) +modest_account_mgr_search_server_accounts (ModestAccountMgr * self, + const gchar * account_name, + ModestProtoType type, + const gchar *proto, + gboolean only_enabled) { GSList *accounts; GSList *cursor; ModestAccountMgrPrivate *priv; - const size_t prefix_len = - strlen (MODEST_SERVER_ACCOUNT_NAMESPACE "/"); - + gchar *key; + GError *err = NULL; + g_return_val_if_fail (self, NULL); - - priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); - accounts = modest_conf_list_subkeys (priv->modest_conf, - MODEST_SERVER_ACCOUNT_NAMESPACE, - NULL); - + + key = get_account_keyname (account_name, NULL, TRUE); + priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); + + /* get the list of all server accounts */ + accounts = modest_conf_list_subkeys (priv->modest_conf, key, &err); + if (err) { + g_error_free (err); + g_printerr ("modest: failed to get subkeys for '%s'\n", key); + return NULL; + } + /* no restrictions, return everything */ if (type == MODEST_PROTO_TYPE_ANY && !proto) - return strip_prefix_from_elements (accounts, prefix_len); - + return strip_prefix_from_elements (accounts, strlen(key)+1); + /* +1 because we must remove the ending '/' as well */ + /* otherwise, filter out the none-matching ones */ cursor = accounts; while (cursor) { - gchar *keyspace, *proto_key, *acc_proto; - - keyspace = (gchar *) cursor->data; - proto_key = - g_strconcat (keyspace, "/", MODEST_ACCOUNT_PROTO, - NULL); - acc_proto = - modest_conf_get_string (priv->modest_conf, proto_key, - NULL); - g_free (proto_key); - - if ((!acc_proto) || /* proto not defined? */ - (type != MODEST_PROTO_TYPE_ANY && /* proto type ... */ - modest_proto_type (acc_proto) != type) || /* ... matches? */ - (proto && strcmp (proto, acc_proto) != 0)) { /* proto matches? */ - /* no match: remove from the list */ + gchar *account; + gchar *acc_proto; + gboolean enabled; + + account = account_from_key ((gchar*)cursor->data, NULL, NULL); + + enabled = modest_account_mgr_account_is_enabled (self, account, TRUE); + acc_proto = modest_account_mgr_get_string (self, account, MODEST_ACCOUNT_PROTO, + TRUE, NULL); + if ((!acc_proto) || /* proto not defined? */ + (type != MODEST_PROTO_TYPE_ANY && /* proto type ... */ + modest_proto_type (acc_proto) != type) || /* ... matches? */ + (proto && strcmp (proto, acc_proto) != 0) || /* proto matches? */ + (!enabled && only_enabled)) { /* account enabled? */ + /* match! remove from the list */ GSList *nxt = cursor->next; - - g_free (acc_proto); accounts = g_slist_delete_link (accounts, cursor); cursor = nxt; } else cursor = cursor->next; + + g_free (account); + g_free (acc_proto); } - return strip_prefix_from_elements (accounts, prefix_len); + return strip_prefix_from_elements (accounts, strlen(key)+1); + /* +1 because we must remove the ending '/' as well */ } @@ -514,9 +524,9 @@ modest_account_mgr_account_names (ModestAccountMgr * self, GError ** err) } -static gchar * -get_account_string (ModestAccountMgr * self, const gchar * name, - const gchar * key, gboolean server_account, GError ** err) { +gchar * +modest_account_mgr_get_string (ModestAccountMgr *self, const gchar *name, + const gchar *key, gboolean server_account, GError **err) { ModestAccountMgrPrivate *priv; @@ -527,11 +537,8 @@ get_account_string (ModestAccountMgr * self, const gchar * name, g_return_val_if_fail (name, NULL); g_return_val_if_fail (key, NULL); - if (server_account) - keyname = get_server_account_keyname (name, key); - else - keyname = get_account_keyname (name, key); - + keyname = get_account_keyname (name, key, server_account); + priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); retval = modest_conf_get_string (priv->modest_conf, keyname, err); g_free (keyname); @@ -540,28 +547,9 @@ get_account_string (ModestAccountMgr * self, const gchar * name, } -gchar * -modest_account_mgr_get_server_account_string (ModestAccountMgr * self, - const gchar * name, - const gchar * key, - GError ** err) -{ - return get_account_string (self, name, key, TRUE, err); -} - - -gchar * -modest_account_mgr_get_account_string (ModestAccountMgr * self, - const gchar * name, const gchar * key, - GError ** err) -{ - return get_account_string (self, name, key, FALSE, err); -} - - -static gint -get_account_int (ModestAccountMgr * self, const gchar * name, - const gchar * key, gboolean server_account, GError ** err) +gint +modest_account_mgr_get_int (ModestAccountMgr *self, const gchar *name, + const gchar *key, gboolean server_account, GError **err) { ModestAccountMgrPrivate *priv; @@ -572,10 +560,7 @@ get_account_int (ModestAccountMgr * self, const gchar * name, g_return_val_if_fail (name, -1); g_return_val_if_fail (key, -1); - if (server_account) - keyname = get_server_account_keyname (name, key); - else - keyname = get_account_keyname (name, key); + keyname = get_account_keyname (name, key, server_account); priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); retval = modest_conf_get_int (priv->modest_conf, keyname, err); @@ -585,27 +570,10 @@ get_account_int (ModestAccountMgr * self, const gchar * name, } -gint -modest_account_mgr_get_server_account_int (ModestAccountMgr * self, - const gchar * name, - const gchar * key, GError ** err) -{ - return get_account_int (self, name, key, TRUE, err); -} - -gint -modest_account_mgr_get_account_int (ModestAccountMgr * self, - const gchar * name, const gchar * key, - GError ** err) -{ - return get_account_int (self, name, key, FALSE, err); -} - - -static gboolean -get_account_bool (ModestAccountMgr * self, const gchar * name, - const gchar * key, gboolean server_account, GError ** err) +gboolean +modest_account_mgr_get_bool (ModestAccountMgr * self, const gchar *account, + const gchar * key, gboolean server_account, GError ** err) { ModestAccountMgrPrivate *priv; @@ -613,44 +581,24 @@ get_account_bool (ModestAccountMgr * self, const gchar * name, gboolean retval; g_return_val_if_fail (self, FALSE); - g_return_val_if_fail (name, FALSE); + g_return_val_if_fail (account, FALSE); g_return_val_if_fail (key, FALSE); - if (server_account) - keyname = get_server_account_keyname (name, key); - else - keyname = get_account_keyname (name, key); - + keyname = get_account_keyname (account, key, server_account); + priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); retval = modest_conf_get_bool (priv->modest_conf, keyname, err); + g_free (keyname); return retval; } -gint -modest_account_mgr_get_server_account_bool (ModestAccountMgr * self, - const gchar * name, - const gchar * key, GError ** err) -{ - return get_account_bool (self, name, key, TRUE, err); -} - - -gint -modest_account_mgr_get_account_bool (ModestAccountMgr * self, - const gchar * name, const gchar * key, - GError ** err) -{ - return get_account_bool (self, name, key, FALSE, err); -} - - -static gboolean -set_account_string (ModestAccountMgr * self, const gchar * name, - const gchar * key, const gchar * val, - gboolean server_account, GError ** err) +gboolean +modest_account_mgr_set_string (ModestAccountMgr * self, const gchar * name, + const gchar * key, const gchar * val, + gboolean server_account, GError ** err) { ModestAccountMgrPrivate *priv; @@ -661,11 +609,8 @@ set_account_string (ModestAccountMgr * self, const gchar * name, g_return_val_if_fail (name, FALSE); g_return_val_if_fail (key, FALSE); - if (server_account) - keyname = get_server_account_keyname (name, key); - else - keyname = get_account_keyname (name, key); - + keyname = get_account_keyname (name, key, server_account); + priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); retval = modest_conf_set_string (priv->modest_conf, keyname, val, @@ -677,29 +622,9 @@ set_account_string (ModestAccountMgr * self, const gchar * name, gboolean -modest_account_mgr_set_server_account_string (ModestAccountMgr * self, - const gchar * name, - const gchar * key, - const gchar * val, - GError ** err) -{ - return set_account_string (self, name, key, val, TRUE, err); -} - - -gboolean -modest_account_mgr_set_account_string (ModestAccountMgr * self, - const gchar * name, const gchar * key, - const gchar * val, GError ** err) -{ - return set_account_string (self, name, key, val, FALSE, err); -} - - -static gboolean -set_account_int (ModestAccountMgr * self, const gchar * name, - const gchar * key, gboolean server_account, int val, - GError ** err) +modest_account_mgr_set_int (ModestAccountMgr * self, const gchar * name, + const gchar * key, int val, gboolean server_account, + GError ** err) { ModestAccountMgrPrivate *priv; @@ -710,11 +635,8 @@ set_account_int (ModestAccountMgr * self, const gchar * name, g_return_val_if_fail (name, FALSE); g_return_val_if_fail (key, FALSE); - if (server_account) - keyname = get_server_account_keyname (name, key); - else - keyname = get_account_keyname (name, key); - + keyname = get_account_keyname (name, key, server_account); + priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); retval = modest_conf_set_int (priv->modest_conf, keyname, val, err); @@ -724,29 +646,11 @@ set_account_int (ModestAccountMgr * self, const gchar * name, } -gboolean -modest_account_mgr_set_server_account_int (ModestAccountMgr * self, - const gchar * name, - const gchar * key, int val, - GError ** err) -{ - return set_account_int (self, name, key, val, TRUE, err); -} - gboolean -modest_account_mgr_set_account_int (ModestAccountMgr * self, - const gchar * name, const gchar * key, - int val, GError ** err) -{ - return set_account_int (self, name, key, val, FALSE, err); -} - - -static gboolean -set_account_bool (ModestAccountMgr * self, const gchar * name, - const gchar * key, gboolean server_account, gboolean val, - GError ** err) +modest_account_mgr_set_bool (ModestAccountMgr * self, const gchar * name, + const gchar * key, gboolean val, gboolean server_account, + GError ** err) { ModestAccountMgrPrivate *priv; @@ -757,10 +661,7 @@ set_account_bool (ModestAccountMgr * self, const gchar * name, g_return_val_if_fail (name, FALSE); g_return_val_if_fail (key, FALSE); - if (server_account) - keyname = get_server_account_keyname (name, key); - else - keyname = get_account_keyname (name, key); + keyname = get_account_keyname (name, key, server_account); priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); @@ -772,27 +673,8 @@ set_account_bool (ModestAccountMgr * self, const gchar * name, gboolean -modest_account_mgr_set_server_account_bool (ModestAccountMgr * self, - const gchar * name, - const gchar * key, gboolean val, - GError ** err) -{ - return set_account_bool (self, name, key, val, TRUE, err); -} - - -gboolean -modest_account_mgr_set_account_bool (ModestAccountMgr * self, - const gchar * name, const gchar * key, - gboolean val, GError ** err) -{ - return set_account_bool (self, name, key, val, FALSE, err); -} - - -gboolean -account_exists (ModestAccountMgr * self, const gchar * name, - gboolean server_account, GError ** err) +modest_account_mgr_account_exists (ModestAccountMgr * self, const gchar * name, + gboolean server_account, GError ** err) { ModestAccountMgrPrivate *priv; @@ -802,10 +684,7 @@ account_exists (ModestAccountMgr * self, const gchar * name, g_return_val_if_fail (self, FALSE); g_return_val_if_fail (name, FALSE); - if (server_account) - keyname = get_server_account_keyname (name, NULL); - else - keyname = get_account_keyname (name, NULL); + keyname = get_account_keyname (name, NULL, server_account); priv = MODEST_ACCOUNT_MGR_GET_PRIVATE (self); retval = modest_conf_key_exists (priv->modest_conf, keyname, err); @@ -815,45 +694,25 @@ account_exists (ModestAccountMgr * self, const gchar * name, } -gboolean -modest_account_mgr_server_account_exists (ModestAccountMgr * self, - const gchar * name, GError ** err) -{ - return account_exists (self, name, TRUE, err); -} - - -gboolean -modest_account_mgr_account_exists (ModestAccountMgr * self, - const gchar * name, GError ** err) -{ - return account_exists (self, name, FALSE, err); -} - - /* must be freed by caller */ static gchar * -get_account_keyname (const gchar * accname, const gchar * name) +get_account_keyname (const gchar * accname, const gchar * name, gboolean server_account) { - if (name) - return g_strconcat - (MODEST_ACCOUNT_NAMESPACE, "/", - accname, "/", name, NULL); - else - return g_strconcat - (MODEST_ACCOUNT_NAMESPACE, "/", accname, NULL); -} + gchar *namespace, *account_name, *retval; + + namespace = server_account ? MODEST_SERVER_ACCOUNT_NAMESPACE : MODEST_ACCOUNT_NAMESPACE; + if (!accname) + return g_strdup (namespace); -/* must be freed by caller */ -static gchar * -get_server_account_keyname (const gchar * accname, const gchar * name) -{ + account_name = modest_conf_key_escape (NULL, accname); + if (name) - return g_strconcat - (MODEST_SERVER_ACCOUNT_NAMESPACE, "/", - accname, "/", name, NULL); + retval = g_strconcat (namespace, "/", accname, "/", name, NULL); else - return g_strconcat - (MODEST_SERVER_ACCOUNT_NAMESPACE, "/", accname, NULL); + retval = g_strconcat (namespace, "/", accname, NULL); + + g_free (account_name); + + return retval; } diff --git a/src/modest-account-mgr.h b/src/modest-account-mgr.h index 912bbb8..e6cba5b 100644 --- a/src/modest-account-mgr.h +++ b/src/modest-account-mgr.h @@ -28,8 +28,6 @@ */ -/* modest-account-mgr.h */ - #ifndef __MODEST_ACCOUNT_MGR_H__ #define __MODEST_ACCOUNT_MGR_H__ @@ -43,7 +41,7 @@ G_BEGIN_DECLS /* convenience macros */ #define MODEST_TYPE_ACCOUNT_MGR (modest_account_mgr_get_type()) #define MODEST_ACCOUNT_MGR(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgr)) -#define MODEST_ACCOUNT_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_MGR,GObject)) +#define MODEST_ACCOUNT_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass)) #define MODEST_IS_ACCOUNT_MGR(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj),MODEST_TYPE_ACCOUNT_MGR)) #define MODEST_IS_ACCOUNT_MGR_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass),MODEST_TYPE_ACCOUNT_MGR)) #define MODEST_ACCOUNT_MGR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj),MODEST_TYPE_ACCOUNT_MGR,ModestAccountMgrClass)) @@ -52,16 +50,16 @@ typedef struct _ModestAccountMgr ModestAccountMgr; typedef struct _ModestAccountMgrClass ModestAccountMgrClass; - struct _ModestAccountMgr { GObject parent; - /* insert public members, if any */ }; struct _ModestAccountMgrClass { GObjectClass parent_class; - /* insert signal callback declarations, eg. */ - /* void (* my_event) (ModestAccountMgr* obj); */ + + void (* account_removed) (ModestAccountMgr *obj, const gchar* account, gboolean server_account, gpointer user_data); + void (* account_changed) (ModestAccountMgr *obj, const gchar* account, const gchar* key, gboolean server_account, + gpointer user_data); }; @@ -103,20 +101,6 @@ gboolean modest_account_mgr_add_account (ModestAccountMgr *self, const gchar* store_name, const gchar* transport_name, GError **err); -/** - * modest_account_mgr_remove_account: - * @self: a ModestAccountMgr instance - * @name: the name of the account to remove - * @err: a GError ptr, or NULL to ignore. - * - * remove an existing account. the account with @name should already exist - * - * Returns: TRUE if the creation succeeded, FALSE otherwise, - * @err gives details in case of error - */ -gboolean modest_account_mgr_remove_account (ModestAccountMgr *self, - const gchar* name, - GError **err); /** @@ -141,20 +125,21 @@ gboolean modest_account_mgr_add_server_account (ModestAccountMgr *self, const gchar *proto); /** - * modest_account_mgr_remove_server_account: + * modest_account_mgr_remove_account: * @self: a ModestAccountMgr instance - * @name: the name for the server account to remove + * @name: the name of the account to remove * @err: a GError ptr, or NULL to ignore. * - * remove a server account from the configuration - * the server account with @name should exist + * remove an existing account. the account with @name should already exist * - * Returns: TRUE if the removal succeeded, FALSE otherwise, + * Returns: TRUE if the creation succeeded, FALSE otherwise, * @err gives details in case of error */ -gboolean modest_account_mgr_remove_server_account (ModestAccountMgr *self, - const gchar *name, - GError **err); +gboolean modest_account_mgr_remove_account (ModestAccountMgr *self, + const gchar* name, + gboolean server_account, + GError **err); + /** * modest_account_mgr_account_names: @@ -183,16 +168,17 @@ GSList* modest_account_mgr_account_names (ModestAccountMgr *self, GEr * Returns: a newly allocated list of server account names, or NULL in case of * error or if there are no server accounts. The caller must free the returned GSList */ -GSList* modest_account_mgr_server_account_names (ModestAccountMgr *self, - const gchar* account_name, - ModestProtoType type, - const gchar* proto, - gboolean only_enabled); +GSList* modest_account_mgr_search_server_accounts (ModestAccountMgr *self, + const gchar* account_name, + ModestProtoType type, + const gchar* proto, + gboolean only_enabled); /** * modest_account_mgr_account_exists: * @self: a ModestAccountMgr instance * @name: the account name to check + * @server_account: if TRUE, this is a server account * @err: a GError ptr, or NULL to ignore. * * check whether account @name exists @@ -202,21 +188,64 @@ GSList* modest_account_mgr_server_account_names (ModestAccountMgr *self, */ gboolean modest_account_mgr_account_exists (ModestAccountMgr *self, const gchar *name, + gboolean server_account, GError **err); - -gboolean modest_account_mgr_server_account_exists (ModestAccountMgr *self, - const gchar *name, - GError **err); + + +/** + * modest_account_mgr_enable_account: + * @self: a ModestAccountMgr instance + * @name: the account name to disable + * @server_account: if TRUE, this is a server account + * + * enable an account that has been disabled with 'modest_account_mgr_disable_account' + * + * Returns: TRUE if it worked, FALSE otherwise + */ +gboolean modest_account_mgr_enable_account (ModestAccountMgr *self, const gchar* name, + gboolean is_server_account); + + + +/** + * modest_account_mgr_disable_account: + * @self: a ModestAccountMgr instance + * @name: the account name to disable + * @server_account: if TRUE, this is a server account + * + * disable an account. this will also stop change notification until + * modest_account_mgr_enable_account is called. However, in case of removal, the + * appropriate signal will still be emitted. + * + * Returns: TRUE if it worked, FALSE otherwise + */ +gboolean modest_account_mgr_disable_account (ModestAccountMgr *self, const gchar* name, + gboolean is_server_account); + + + +/** + * modest_account_mgr_account_is_enabled: + * @self: a ModestAccountMgr instance + * @name: the account name to check + * @server_account: if TRUE, this is a server account + * + * check whether a certain account is enabled + * + * Returns: TRUE if it is enabled, FALSE otherwise + */ +gboolean modest_account_mgr_account_is_enabled (ModestAccountMgr *self, const gchar* name, + gboolean is_server_account); -/* account specific functions */ /** * modest_account_mgr_get_account_string: * @self: self a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to retrieve + * @server_account: if TRUE, this is a server account * @err: a GError ptr, or NULL to ignore. * * get a config string from an account @@ -224,19 +253,19 @@ gboolean modest_account_mgr_server_account_exists (ModestAccountMgr *self, * Returns: a newly allocated string with the value for the key, * or NULL in case of error. @err gives details in case of error */ -gchar* modest_account_mgr_get_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); +gchar* modest_account_mgr_get_string (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account, + GError **err); -gchar* modest_account_mgr_get_server_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); /** * modest_account_mgr_get_account_int: * @self: a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to retrieve + * @server_account: if TRUE, this is a server account * @err: a GError ptr, or NULL to ignore. * * get a config int from an account @@ -245,20 +274,18 @@ gchar* modest_account_mgr_get_server_account_string (ModestAccountMg * error (but of course -1 does not necessarily imply an error) * @err gives details in case of error */ -gint modest_account_mgr_get_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); - -gint modest_account_mgr_get_server_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); - +gint modest_account_mgr_get_int (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account, + GError **err); /** * modest_account_mgr_get_account_bool: * @self: a ModestAccountMgr instance * @name: the name of the account * @key: the key of the value to retrieve + * @server_account: if TRUE, this is a server account * @err: a GError ptr, or NULL to ignore. * * get a config boolean from an account @@ -267,13 +294,11 @@ gint modest_account_mgr_get_server_account_int (ModestAccountMgr * error (but of course FALSE does not necessarily imply an error) * @err gives details in case of error */ -gboolean modest_account_mgr_get_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); - -gboolean modest_account_mgr_get_server_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, GError **err); +gboolean modest_account_mgr_get_bool (ModestAccountMgr *self, + const gchar *name, + const gchar *key, + gboolean server_account, + GError **err); /** * modest_account_mgr_set_account_string: @@ -281,6 +306,7 @@ gboolean modest_account_mgr_get_server_account_bool (ModestAccountMgr *sel * @name: the name of the account * @key: the key of the value to set * @val: the value to set + * @server_account: if TRUE, this is a server account * @err: a GError ptr, or NULL to ignore. * * set a config string for an account @@ -288,16 +314,11 @@ gboolean modest_account_mgr_get_server_account_bool (ModestAccountMgr *sel * Returns: TRUE if setting the value succeeded, or FALSE in case of error. * @err gives details in case of error */ -gboolean modest_account_mgr_set_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, const gchar* val, - GError **err); - -gboolean modest_account_mgr_set_server_account_string (ModestAccountMgr *self, - const gchar *name, - const gchar *key, const gchar* val, - GError **err); - +gboolean modest_account_mgr_set_string (ModestAccountMgr *self, + const gchar *name, + const gchar *key, const gchar* val, + gboolean server_account, + GError **err); /** * modest_account_mgr_set_account_int: @@ -305,6 +326,7 @@ gboolean modest_account_mgr_set_server_account_string (ModestAccountMgr *sel * @name: the name of the account * @key: the key of the value to set * @val: the value to set + * @server_account: if TRUE, this is a server account * @err: a GError ptr, or NULL to ignore. * * set a config int for an account @@ -312,15 +334,11 @@ gboolean modest_account_mgr_set_server_account_string (ModestAccountMgr *sel * Returns: TRUE if setting the value succeeded, or FALSE in case of error. * @err gives details in case of error */ -gboolean modest_account_mgr_set_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gint val, - GError **err); - -gboolean modest_account_mgr_set_server_account_int (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gint val, - GError **err); +gboolean modest_account_mgr_set_int (ModestAccountMgr *self, + const gchar *name, + const gchar *key, gint val, + gboolean server_account, + GError **err); /** @@ -329,6 +347,7 @@ gboolean modest_account_mgr_set_server_account_int (ModestAccountMgr *sel * @name: the name of the account * @key: the key of the value to set * @val: the value to set + * @server_account: if TRUE, this is a server account * @err: a GError ptr, or NULL to ignore. * * set a config bool for an account @@ -336,16 +355,11 @@ gboolean modest_account_mgr_set_server_account_int (ModestAccountMgr *sel * Returns: TRUE if setting the value succeeded, or FALSE in case of error. * @err gives details in case of error */ -gboolean modest_account_mgr_set_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gboolean val, - GError **err); - -gboolean modest_account_mgr_set_server_account_bool (ModestAccountMgr *self, - const gchar *name, - const gchar *key, gboolean val, - GError **err); - +gboolean modest_account_mgr_set_bool (ModestAccountMgr *self, + const gchar *name, + const gchar *key, gboolean val, + gboolean server_account, + GError **err); G_END_DECLS -- 1.7.9.5