Hide singleton providers from wizard providers list if already set up
[modest] / src / modest-account-mgr.h
index 6e6bff4..56bfb8f 100644 (file)
@@ -33,8 +33,8 @@
 
 #include <glib-object.h>
 #include <modest-conf.h>
-#include <modest-defs.h>
-#include <modest-protocol-info.h>
+#include <modest-protocol-registry.h>
+#include <modest-account-settings.h>
 
 G_BEGIN_DECLS
 
@@ -49,7 +49,6 @@ G_BEGIN_DECLS
 typedef struct _ModestAccountMgr      ModestAccountMgr;
 typedef struct _ModestAccountMgrClass ModestAccountMgrClass;
 
-
 struct _ModestAccountMgr {
         GObject parent;
 };
@@ -57,11 +56,33 @@ struct _ModestAccountMgr {
 struct _ModestAccountMgrClass {
        GObjectClass parent_class;
 
-       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,
+       void (* account_inserted)  (ModestAccountMgr *obj, 
+                                   const gchar* account,
+                                   gpointer user_data);
+
+       void (* account_removed)   (ModestAccountMgr *obj, 
+                                   const gchar* account,
                                    gpointer user_data);
+       
+       void (* account_changed)   (ModestAccountMgr *obj, 
+                                   const gchar* account,
+                                   gpointer user_data);
+
+       void (* account_busy_changed)   (ModestAccountMgr *obj, 
+                                        const gchar* account,
+                                        gboolean busy,
+                                        gpointer user_data);   
+
+       void (* default_account_changed)(ModestAccountMgr *obj, 
+                                        gpointer user_data);
+
+       void (* display_name_changed)   (ModestAccountMgr *obj, 
+                                        const gchar *account,
+                                        gpointer user_data);
+       
+       void (* account_updated)   (ModestAccountMgr *obj, 
+                        const gchar *account,
+                        gpointer user_data);
 };
 
 /**
@@ -85,28 +106,46 @@ ModestAccountMgr*        modest_account_mgr_new            (ModestConf *modest_c
 
 
 /**
+ * modest_account_mgr_add_account_from_settings:
+ * @self: a #ModestAccountMgr instance
+ * @self: a #ModestSettings
+ * 
+ * Create a new account from a @settings instance.
+ *
+ * Returns: TRUE if the creation succeeded, FALSE otherwise,
+ */
+gboolean        modest_account_mgr_add_account_from_settings    (ModestAccountMgr *self,
+                                                                ModestAccountSettings *settings);
+
+/**
  * modest_account_mgr_add_account:
  * @self: a ModestAccountMgr instance
  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
  * @store_name: the store account (ie. POP/IMAP)
  * @transport_name: the transport account (ie. sendmail/SMTP)
- * @err: a GError ptr, or NULL to ignore.
+ * @enabled: Whether the account should be enabled initially.
  * 
- * create a new account. the account with @name should not already exist
+ * Create a new account. The account with @name should not already exist. The @name will 
+ * be used as the initial display name of the new account.
  *
  * Returns: TRUE if the creation succeeded, FALSE otherwise,
- * @err gives details in case of error
  */
 gboolean        modest_account_mgr_add_account    (ModestAccountMgr *self,
-                                                  const gchar* name,
+                                                  const gchar *name,
+                                                  const gchar *display_name,
+                                                  const gchar *user_fullname,
+                                                  const gchar *user_email,
+                                                  ModestAccountRetrieveType retrieve_type,
                                                   const gchar* store_name,
-                                                  const gchar* transport_name);
+                                                  const gchar* transport_name,
+                                                  gboolean enabled);
 
 /**
  * modest_account_mgr_add_server_account:
  * @self: a ModestAccountMgr instance
  * @name: name (id) of the account, which is a valid UTF8 string that does not contain '/'
  * @hostname: the hostname
+ * @portnumber: the portnumber, or 0 for default
  * @username: the username
  * @password: the password
  * @proto:    the protocol (imap, smtp, ...) used for this account
@@ -121,11 +160,12 @@ gboolean        modest_account_mgr_add_account    (ModestAccountMgr *self,
 gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
                                                   const gchar *name,
                                                   const gchar *hostname,
+                                                  const guint portnumber,
                                                   const gchar *username,
                                                   const gchar *password,
-                                                  ModestProtocol proto,
-                                                  ModestProtocol security,
-                                                  ModestProtocol auth);
+                                                  ModestProtocolType proto,
+                                                  ModestProtocolType security,
+                                                  ModestProtocolType auth);
 
 
 /**
@@ -141,55 +181,49 @@ gboolean modest_account_mgr_add_server_account    (ModestAccountMgr *self,
  */
 gboolean modest_account_mgr_add_server_account_uri    (ModestAccountMgr *self,
                                                       const gchar *name,
-                                                      ModestProtocol proto,
+                                                      ModestProtocolType proto,
                                                       const gchar* uri);
 
 /**
  * modest_account_mgr_remove_account:
  * @self: a ModestAccountMgr instance
  * @name: the name of the account to remove
- * @server_account: TRUE if the account to remove is a server account
  * @err: a #GError ptr, or NULL to ignore.
  * 
- * remove an existing account. the account with @name should already exist
+ * remove an existing account. the account with @name should already exist; note
+ * that when deleting an account, also the corresponding server accounts will
+ * be deleted
  *
  * 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,
-                                                          gboolean server_account);
-
+                                                          const gchar* name);
 
 /**
  * modest_account_mgr_account_names:
  * @self: a ModestAccountMgr instance
+ * @only_enabled: Whether only enabled accounts should be returned.
  * 
  * list all account names
  *
  * Returns: a newly allocated list of account names, or NULL in case of error or
- * if there are no accounts. The caller must free the returned GSList
+ * if there are no accounts. The caller must free the returned GSList.
+ *
  */
-GSList*                modest_account_mgr_account_names    (ModestAccountMgr *self);
-
+GSList*                modest_account_mgr_account_names    (ModestAccountMgr *self,
+                                                    gboolean only_enabled);
 
 /**
- * modest_account_mgr_server_account_names:
- * @self: a ModestAccountMgr instance
- * @account_name: get only server accounts for @account_name, or NULL for any
- * @type: get only server accounts from protocol type @type, or MODEST_PROTO_TYPE_ANY
- * @proto: get only server account with protocol @proto, or NULL for any
- * @only_enabled: get only enabled server accounts if TRUE
+ * modest_account_mgr_free_account_names:
+ * @account_name: a gslist of account names
  * 
- * list all the server account names
+ * list all account names
  *
- * 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
+ * free the list of account names
  */
-GSList*  modest_account_mgr_search_server_accounts  (ModestAccountMgr *self,
-                                                    const gchar*       account_name,
-                                                    ModestProtocolType type,
-                                                    ModestProtocol     proto);
+void           modest_account_mgr_free_account_names    (GSList *account_names);
+                                                         
 
 /**
  * modest_account_mgr_account_exists:
@@ -197,7 +231,7 @@ GSList*  modest_account_mgr_search_server_accounts  (ModestAccountMgr *self,
  * @name: the account name to check
  * @server_account: if TRUE, this is a server account
  * 
- * check whether account @name exists
+ * check whether account @name exists. Note that this does not check the display name.
  *
  * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
  */
@@ -205,201 +239,127 @@ gboolean        modest_account_mgr_account_exists         (ModestAccountMgr *self,
                                                           const gchar *name,
                                                           gboolean server_account);
 
-
 /**
- * modest_account_mgr_get_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
+ * modest_account_mgr_account_exists:
+ * @self: a ModestAccountMgr instance
+ * @name: the account name to check
  * 
- * get a config string from an account
+ * check whether a non-server account with the @display_name exists.
  *
- * Returns: a newly allocated string with the value for the key,
- * or NULL in case of error. 
+ * Returns: TRUE if the account with name @name exists, FALSE otherwise (or in case of error)
  */
-gchar*         modest_account_mgr_get_string     (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key,
-                                                  gboolean server_account);
-
+gboolean       modest_account_mgr_account_with_display_name_exists (ModestAccountMgr *self,
+                                                                    const gchar *display_name);
 
 /**
- * modest_account_mgr_get_password:
- * @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
- * 
- * get a password from an account
+ * modest_account_mgr_check_already_configured_account:
+ * @self: a #ModestAccountMgr
+ * @settings: a #ModestAccountSettings *settings
  *
- * Returns: a newly allocated string with the value for the key,
- * or NULL in case of error.
- */
-gchar*         modest_account_mgr_get_password     (ModestAccountMgr *self,
-                                                    const gchar *name,
-                                                    const gchar *key,
-                                                    gboolean server_account);
-
-/**
- * modest_account_mgr_get_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
- * 
- * get a config int from an account
+ * Checks if there's already an active store account with the same settings
  *
- * Returns: an integer with the value for the key, or -1 in case of
- * error (but of course -1 does not necessarily imply an error)
+ * Returns: %TRUE if account setup exists
  */
-gint           modest_account_mgr_get_int        (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key,
-                                                  gboolean server_account);
+gboolean        modest_account_mgr_check_already_configured_account (ModestAccountMgr * self,
+                                                                    ModestAccountSettings *settings);
 
 /**
- * modest_account_mgr_get_bool:
+ * modest_account_mgr_unset:
  * @self: a ModestAccountMgr instance
  * @name: the name of the account
- * @key: the key of the value to retrieve
+ * @key: the key of the value to unset
  * @server_account: if TRUE, this is a server account
+ * @err: a GError ptr, or NULL to ignore.
  * 
- * get a config boolean from an account
+ * unsets the config value of an account and all their children keys
  *
- * Returns: an boolean with the value for the key, or FALSE in case of
- * error (but of course FALSE does not necessarily imply an error)
+ * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
+ * @err gives details in case of error
  */
-gboolean       modest_account_mgr_get_bool       (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key,
-                                                  gboolean server_account);
+gboolean        modest_account_mgr_unset           (ModestAccountMgr *self,
+                                                   const gchar *name,
+                                                   const gchar *key,
+                                                   gboolean server_account);
 
 /**
- * modest_account_mgr_get_list:
+ * modest_account_mgr_has_accounts:
  * @self: a ModestAccountMgr instance
- * @name: the name of the account
- * @key: the key of the value to get
- * @list_type: the type of the members of the list
- * @server_account: if TRUE, this is a server account
+ * @enabled: TRUE to search for enabled accounts only
  * 
- * get a config list of values of type @list_type of an account
+ * Checks if any accounts exist
  *
- * Returns: a newly allocated list of elements
+ * Returns: TRUE if accounts exist, FALSE otherwise
  */
-GSList*                modest_account_mgr_get_list       (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key,
-                                                  ModestConfValueType list_type,
-                                                  gboolean server_account);
+
+gboolean modest_account_mgr_has_accounts (ModestAccountMgr* self, gboolean enabled);
 
 /**
- * modest_account_mgr_set_string:
+ * modest_account_mgr_set_account_busy
  * @self: a ModestAccountMgr instance
- * @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
+ * @account_name: name of the account
+ * @busy: whether to set busy or not busy
  * 
- * set a config string for an account.
+ * Changes the busy flag of an account
  *
- * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
  */
-gboolean       modest_account_mgr_set_string     (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key, const gchar* val,
-                                                  gboolean server_account);
 
+void modest_account_mgr_set_account_busy(ModestAccountMgr* self, const gchar* account_name, 
+                                                                                                                                               gboolean busy);
 
 /**
- * modest_account_mgr_set_password:
+ * modest_account_mgr_account_is_busy
  * @self: a ModestAccountMgr instance
- * @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
+ * @account_name: name of the account
  * 
- * set a password for an account.
+ * Returns: If the account is currently busy or not
  *
- * 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_password     (ModestAccountMgr *self,
-                                                    const gchar *name,
-                                                    const gchar *key, const gchar* val,
-                                                    gboolean server_account);
+gboolean modest_account_mgr_account_is_busy (ModestAccountMgr* self, 
+                                            const gchar* account_name);
+
+
+void modest_account_mgr_notify_account_update (ModestAccountMgr* self, 
+                                              const gchar *server_account_name);
 
 /**
- * modest_account_mgr_set_int:
+ * modest_account_mgr_set_default_account:
  * @self: a ModestAccountMgr instance
- * @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
+ * @account: the name of an existing account
  * 
- * set a config int for an account
+ * set the default account name (which must be valid account)
  *
- * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
+ * Returns: TRUE if succeeded, FALSE otherwise
  */
-gboolean       modest_account_mgr_set_int        (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key, gint val,
-                                                  gboolean server_account);
+gboolean modest_account_mgr_set_default_account  (ModestAccountMgr *self,
+                                                 const gchar* account);
 
 /**
- * modest_account_mgr_set_bool:
+ * modest_account_mgr_get_default_account:
  * @self: a ModestAccountMgr instance
- * @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
  * 
- * set a config bool for an account
+ * get the default account name, or NULL if none is found
  *
- * Returns: TRUE if setting the value succeeded, or FALSE in case of error.
+ * Returns: the default account name (as newly allocated string, which
+ * must be g_free'd), or NULL
  */
-gboolean       modest_account_mgr_set_bool       (ModestAccountMgr *self,
-                                                  const gchar *name,
-                                                  const gchar *key, gboolean val,
-                                                  gboolean server_account);
+gchar* modest_account_mgr_get_default_account  (ModestAccountMgr *self);
 
 /**
- * modest_account_mgr_set_list:
+ * modest_account_mgr_get_display_name:
  * @self: a ModestAccountMgr instance
- * @name: the name of the account
- * @key: the key of the value to set
- * @val: the list with the values to set
- * @list_type: the type of the members of the list
- * @server_account: if TRUE, this is a server account
+ * @name: the account name to check
  *
- * * set a config list of values of type @list_type of an account
- * 
- * returns TRUE if this succeeded, FALSE otherwise 
+ * Return the human-readable account title for this account, or NULL.
  */
-gboolean               modest_account_mgr_set_list       (ModestAccountMgr *self,
-                                                          const gchar *name,
-                                                          const gchar *key,
-                                                          GSList *val,
-                                                          ModestConfValueType list_type,
-                                                          gboolean server_account);
+gchar* modest_account_mgr_get_display_name (ModestAccountMgr *self, 
+                                           const gchar* name);
 
-/**
- * modest_account_mgr_unset:
- * @self: a ModestAccountMgr instance
- * @name: the name of the account
- * @key: the key of the value to unset
- * @server_account: if TRUE, this is a server account
- * @err: a GError ptr, or NULL to ignore.
- * 
- * unsets the config value of an account and all their children keys
- *
- * Returns: TRUE if unsetting the value succeeded, or FALSE in case of error.
- * @err gives details in case of error
- */
-gboolean        modest_account_mgr_unset           (ModestAccountMgr *self,
-                                                   const gchar *name,
-                                                   const gchar *key,
-                                                   gboolean server_account);
+void  modest_account_mgr_set_display_name (ModestAccountMgr *self, 
+                                          const gchar *account_name,
+                                          const gchar *display_name);
+
+gboolean modest_account_mgr_singleton_protocol_exists (ModestAccountMgr *mgr,
+                                                      ModestProtocolType protocol_type);
 
 G_END_DECLS