2007-05-14 Murray Cumming <murrayc@murrayc.com>
[modest] / src / modest-account-mgr-helpers.c
index 16b9506..7451b31 100644 (file)
@@ -47,79 +47,191 @@ modest_account_mgr_get_enabled (ModestAccountMgr *self, const gchar* name)
        return modest_account_mgr_get_bool (self, name, MODEST_ACCOUNT_ENABLED, FALSE);
 }
 
-#if 0 /* Not needed, but works. */
-static gint
-compare_option_strings_for_name (const gchar* a, const gchar* b)
-{
-       /* printf("  debug: compare_option_strings_for_name():a=%s, b=%s\n", a, b); */
-       const gchar* sep = strchr(a, '=');
-       if (!sep)
-               return -1;
+gboolean modest_account_mgr_set_signature (ModestAccountMgr *self, const gchar* name, 
+       const gchar* signature, gboolean use_signature)
+{
+       gboolean result = modest_account_mgr_set_bool (self, name, MODEST_ACCOUNT_USE_SIGNATURE, 
+               use_signature, FALSE);
+       result = result && modest_account_mgr_set_string (self, name, MODEST_ACCOUNT_SIGNATURE, 
+               signature, FALSE);
+       return result;
+}
+
+gchar* modest_account_mgr_get_display_name (ModestAccountMgr *self, 
+       const gchar* name)
+{
+       return modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_DISPLAY_NAME, FALSE);
+}
+
+
+
+gchar* modest_account_mgr_get_signature (ModestAccountMgr *self, const gchar* name, 
+       gboolean* use_signature)
+{
+       if (use_signature) {
+               *use_signature = 
+                       modest_account_mgr_get_bool (self, name, MODEST_ACCOUNT_USE_SIGNATURE, FALSE);
+       }
+       
+       return modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_SIGNATURE, FALSE);
+}
+       
+
+gboolean modest_account_mgr_set_connection_specific_smtp (ModestAccountMgr *self, 
+       const gchar* account_name,
+       const gchar* connection_name, const gchar* server_account_name)
+{
+       modest_account_mgr_remove_connection_specific_smtp (self, account_name, connection_name);
+       
+       GSList *list = modest_account_mgr_get_list (self, account_name, 
+                                                       MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
+                                                   MODEST_CONF_VALUE_STRING, TRUE);
                
-       gint len = sep - a;
-       if(len <= 0)
-               return -1;
+       /* The server account is in the item after the connection name: */
+       GSList *list_connection = g_slist_append (list, (gpointer)connection_name);
+       list_connection = g_slist_append (list_connection, (gpointer)server_account_name);
+       
+       /* Reset the changed list: */
+       modest_account_mgr_set_list (self, account_name, 
+                                                       MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST, list,
+                                                   MODEST_CONF_VALUE_STRING, TRUE);
+                               
+       /* TODO: Should we free the items too, or just the list? */
+       g_slist_free (list);
+       
+       return TRUE;
+}
+
+/**
+ * modest_account_mgr_remove_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
+ * @connection_name: A libconic IAP connection name
+ * 
+ * Disassacoiate a server account to use with the specific connection for this account.
+ *
+ * Returns: TRUE if it worked, FALSE otherwise
+ */                             
+gboolean modest_account_mgr_remove_connection_specific_smtp (ModestAccountMgr *self, 
+       const gchar* account_name, const gchar* connection_name)
+{
+       GSList *list = modest_account_mgr_get_list (self, account_name, 
+                                                       MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
+                                                   MODEST_CONF_VALUE_STRING, TRUE);
+       if (!list)
+               return FALSE;
                
-       /* Get the part of the string before the =.
-        * Note that this allocation is inefficient just so we can do a strcmp. */
-       gchar* name = g_malloc (len+1);
-       memcpy(name, a, len);
-       name[len] = 0; /* Null-termination. */
+       /* The server account is in the item after the connection name: */
+       GSList *list_connection = g_slist_find_custom (list, connection_name, (GCompareFunc)strcmp);
+       if (list_connection) {
+               /* remove both items: */
+               GSList *temp = g_slist_delete_link(list_connection, list_connection);
+               temp = g_slist_delete_link(temp, g_slist_next(temp));
+       }
+       
+       /* Reset the changed list: */
+       modest_account_mgr_set_list (self, account_name, 
+                                                       MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST, list,
+                                                   MODEST_CONF_VALUE_STRING, TRUE);
+                               
+       /* TODO: Should we free the items too, or just the list? */
+       g_slist_free (list);
        
-       /* printf("    debug: name=%s\n", name); */
+       return TRUE;
+}
 
-       gint result = strcmp (name, b);
+/**
+ * modest_account_mgr_get_connection_specific_smtp
+ * @self: a ModestAccountMgr instance
+ * @name: the account name
+ * @connection_name: A libconic IAP connection name
+ * 
+ * Retrieve a server account to use with this specific connection for this account.
+ *
+ * Returns: a server account name to use for this connection, or NULL if none is specified.
+ */                     
+gchar* modest_account_mgr_get_connection_specific_smtp (ModestAccountMgr *self, const gchar* account_name,
+                                        const gchar* connection_name)
+{
+       gchar *result = NULL;
        
-       g_free (name);
+       GSList *list = modest_account_mgr_get_list (self, account_name, 
+                                                       MODEST_ACCOUNT_CONNECTION_SPECIFIC_SMTP_LIST,
+                                                   MODEST_CONF_VALUE_STRING, TRUE);
+       if (!list)
+               return NULL;
+               
+       /* The server account is in the item after the connection name: */
+       GSList *list_connection = g_slist_find_custom (list, connection_name, (GCompareFunc)strcmp);
+       if (list_connection) {
+               GSList * list_server_account = g_slist_next(list_connection);
+               if (list_server_account)
+                       result = g_strdup ((gchar*)(list_server_account->data));
+       }
+                               
+       /* TODO: Should we free the items too, or just the list? */
+       g_slist_free (list);
        
        return result;
 }
-           
+                                        
 gchar*
-modest_server_account_data_get_option_string (GSList* options_list, const gchar* option_name)
+modest_server_account_get_username (ModestAccountMgr *self, const gchar* account_name)
 {
-       if (!options_list)
-               return NULL;
+       return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_USERNAME, 
+               TRUE /* server account */);
+}
+
+void
+modest_server_account_set_username (ModestAccountMgr *self, const gchar* account_name, 
+       const gchar* username)
+{
+       /* Note that this won't work properly as long as the gconf cache is broken 
+        * in Maemo Bora: */
+       gchar *existing_username = modest_server_account_get_username(self, 
+               account_name);
        
-       gchar *result = NULL;
-       GSList* option = g_slist_find_custom(options_list, option_name, (GCompareFunc)compare_option_strings_for_name);
-       if(option) {
-               /* Get the value part of the key=value pair: */
-               const gchar* pair = (const gchar*)option->data;
+       modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_USERNAME, 
+               username, TRUE /* server account */);
                
-               const gchar* sep = strchr(pair, '=');
-               if (sep) {
-                       gint len = sep - pair;
-                       if(len > 0) {
-                               result = g_strdup(sep+1);
-                               
-                               /* Avoid returning an empty string instead of NULL. */
-                               if(result && strlen(result) == 0) {
-                                       g_free(result);
-                                       result = NULL;
-                               }
-                       }
-               }
-       }
+       /* We don't know anything about new usernames: */
+       if (strcmp (existing_username, username) != 0)
+               modest_server_account_set_username_has_succeeded (self, 
+               account_name, FALSE);
                
-       return result;
+       g_free (existing_username);
 }
 
 gboolean
-modest_server_account_data_get_option_bool (GSList* options_list, const gchar* option_name)
+modest_server_account_get_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name)
 {
-       if (!options_list)
-               return FALSE;
+       return modest_account_mgr_get_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED, 
+               TRUE /* server account */);
+}
+
+void
+modest_server_account_set_username_has_succeeded (ModestAccountMgr *self, const gchar* account_name, 
+       gboolean succeeded)
+{
+       modest_account_mgr_set_bool (self, account_name, MODEST_ACCOUNT_USERNAME_HAS_SUCCEEDED, 
+               succeeded, TRUE /* server account */);
+}
+
+void
+modest_server_account_set_password (ModestAccountMgr *self, const gchar* account_name, 
+       const gchar* password)
+{
+       modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_PASSWORD, 
+               password, TRUE /* server account */);
+}
        
-       gboolean result = FALSE;
-       GSList* option = g_slist_find_custom(options_list, option_name, (GCompareFunc)strcmp);
-       if(option) {
-               return TRUE;
-       }
-               
-       return result;
+gchar*
+modest_server_account_get_hostname (ModestAccountMgr *self, const gchar* account_name)
+{
+       return modest_account_mgr_get_string (self, account_name, MODEST_ACCOUNT_HOSTNAME, 
+               TRUE /* server account */);
 }
-#endif
 
 static ModestProtocol
 get_secure_auth_for_conf_string(const gchar* value)
@@ -219,27 +331,8 @@ modest_server_account_set_security (ModestAccountMgr *self,
        /* Set it in the configuration: */
        modest_account_mgr_set_string (self, account_name, MODEST_ACCOUNT_SECURITY, str_value, TRUE);
 }
-                    
-#if 0                     
-gchar*
-modest_account_mgr_get_server_account_option (ModestAccountMgr *self, 
-       const gchar* account_name, const gchar* option_name)
-{
-       GSList *option_list = modest_account_mgr_get_list (self, account_name, MODEST_ACCOUNT_OPTIONS,
-                                                    MODEST_CONF_VALUE_STRING, TRUE);
-       if (!option_list)
-               return NULL;
-               
-       gchar *result = modest_server_account_data_get_option_value (option_list, option_name);
-       
-       /* TODO: Should we free the items too, or just the list? */
-       g_slist_free (option_list);
-               
-       return result;
-}
-#endif
 
-static ModestServerAccountData*
+ModestServerAccountData*
 modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar* name)
 {
        ModestServerAccountData *data;
@@ -267,17 +360,13 @@ modest_account_mgr_get_server_account_data (ModestAccountMgr *self, const gchar*
        
        data->last_updated = modest_account_mgr_get_int    (self, name, MODEST_ACCOUNT_LAST_UPDATED,TRUE);
        
-       data->password     = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PASSWORD, TRUE);
-       data->uri          = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_URI,TRUE);
-       data->options = modest_account_mgr_get_list (self, name, MODEST_ACCOUNT_OPTIONS,
-                                                    MODEST_CONF_VALUE_STRING, TRUE);
-                                                  
+       data->password     = modest_account_mgr_get_string (self, name, MODEST_ACCOUNT_PASSWORD, TRUE);            
        
        return data;
 }
 
 
-static void
+void
 modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
                                             ModestServerAccountData* data)
 {
@@ -297,15 +386,6 @@ modest_account_mgr_free_server_account_data (ModestAccountMgr *self,
 
        g_free (data->password);
        data->password = NULL;
-       
-       if (data->options) {
-               GSList *tmp = data->options;
-               while (tmp) {
-                       g_free (tmp->data);
-                       tmp = g_slist_next (tmp);
-               }
-               g_slist_free (data->options);
-       }
 
        g_slice_free (ModestServerAccountData, data);
 }
@@ -321,7 +401,13 @@ modest_account_mgr_get_account_data     (ModestAccountMgr *self, const gchar* na
        
        g_return_val_if_fail (self, NULL);
        g_return_val_if_fail (name, NULL);
-       g_return_val_if_fail (modest_account_mgr_account_exists (self, name,FALSE), NULL);      
+       
+       if (!modest_account_mgr_account_exists (self, name, FALSE)) {
+               /* For instance, maybe you are mistakenly checking for a server account name? */
+               g_warning ("%s: Account %s does not exist.", __FUNCTION__, name);
+               return NULL;
+       }
+       
        data = g_slice_new0 (ModestAccountData);
        
        data->account_name = g_strdup (name);
@@ -437,6 +523,46 @@ modest_account_mgr_set_default_account  (ModestAccountMgr *self, const gchar* ac
 
 }
 
+gboolean
+modest_account_mgr_unset_default_account  (ModestAccountMgr *self)
+{
+       ModestConf *conf;
+       
+       g_return_val_if_fail (self,    FALSE);
+
+       conf = MODEST_ACCOUNT_MGR_GET_PRIVATE (self)->modest_conf;
+               
+       return modest_conf_remove_key (conf, MODEST_CONF_DEFAULT_ACCOUNT, NULL /* err */);
+
+}
+
+gint on_accounts_list_sort_by_title(gconstpointer a, gconstpointer b)
+{
+       return g_utf8_collate((const gchar*)a, (const gchar*)b);
+}
+
+gboolean
+modest_account_mgr_set_first_account_as_default  (ModestAccountMgr *self)
+{
+       gboolean result = FALSE;
+       GSList *account_names = modest_account_mgr_account_names (self, TRUE /* only enabled */);
+       
+       /* Get the first one, alphabetically, by title: */
+       GSList* list_sorted = g_slist_sort (account_names, 
+               on_accounts_list_sort_by_title);
+       if(list_sorted)
+       {
+               const gchar* account_name = (const gchar*)list_sorted->data;
+               if (account_name)
+                       result = modest_account_mgr_set_default_account (self, account_name);
+       }
+       
+       /* TODO: Free the strings too? */
+       g_slist_free (account_names);
+       
+       return result;
+}
+
 gchar*
 modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name)
 {
@@ -457,3 +583,91 @@ modest_account_mgr_get_from_string (ModestAccountMgr *self, const gchar* name)
 
        return from;
 }
+
+/* Add a number to the end of the text, or increment a number that is already there.
+ */
+static gchar*
+util_increment_name (const gchar* text)
+{
+       /* Get the end character,
+        * also doing a UTF-8 validation which is required for using g_utf8_prev_char().
+        */
+       const gchar* end = NULL;
+       if (!g_utf8_validate (text, -1, &end))
+               return NULL;
+  
+       if (!end)
+               return NULL;
+               
+       --end; /* Go to before the null-termination. */
+               
+       /* Look at each UTF-8 characer, starting at the end: */
+       const gchar* p = end;
+       const gchar* alpha_end = NULL;
+       while (p)
+       {       
+               /* Stop when we reach the first character that is not a numeric digit: */
+               const gunichar ch = g_utf8_get_char (p);
+               if (!g_unichar_isdigit (ch)) {
+                       alpha_end = p;
+                       break;
+               }
+               
+               p = g_utf8_prev_char (p);       
+       }
+       
+       if(!alpha_end) {
+               /* The text must consist completely of numeric digits. */
+               alpha_end = text;
+       }
+       else
+               ++alpha_end;
+       
+       /* Intepret and increment the number, if any: */
+       gint num = atol (alpha_end);
+       ++num;
+       
+       /* Get the name part: */
+       gint name_len = alpha_end - text;
+       gchar *name_without_number = g_malloc(name_len + 1);
+       memcpy (name_without_number, text, name_len);
+       name_without_number[name_len] = 0;\
+       
+    /* Concatenate the text part and the new number: */        
+       gchar *result = g_strdup_printf("%s%d", name_without_number, num);
+       g_free (name_without_number);
+       
+       return result;  
+}
+
+gchar*
+modest_account_mgr_get_unused_account_name (ModestAccountMgr *self, const gchar* starting_name,
+       gboolean server_account)
+{
+       gchar *account_name = g_strdup (starting_name);
+
+       while (modest_account_mgr_account_exists (self, 
+               account_name, server_account /*  server_account */)) {
+                       
+               gchar * account_name2 = util_increment_name (account_name);
+               g_free (account_name);
+               account_name = account_name2;
+       }
+       
+       return account_name;
+}
+
+gchar*
+modest_account_mgr_get_unused_account_display_name (ModestAccountMgr *self, const gchar* starting_name)
+{
+       gchar *account_name = g_strdup (starting_name);
+
+       while (modest_account_mgr_account_with_display_name_exists (self, account_name)) {
+                       
+               gchar * account_name2 = util_increment_name (account_name);
+               g_free (account_name);
+               account_name = account_name2;
+       }
+       
+       return account_name;
+}