aboutsummaryrefslogtreecommitdiffstats
path: root/camel
diff options
context:
space:
mode:
authorDan Winship <danw@src.gnome.org>2001-04-28 05:08:08 +0800
committerDan Winship <danw@src.gnome.org>2001-04-28 05:08:08 +0800
commit63e96e100291b330e75cc3b3b49795c720e5ffa0 (patch)
treee87946a64b23a35dacb190c43676f14691187b98 /camel
parentd06ca412e46d6b4fc2ecd3e1e956b1e8970c8867 (diff)
downloadgsoc2013-evolution-63e96e100291b330e75cc3b3b49795c720e5ffa0.tar
gsoc2013-evolution-63e96e100291b330e75cc3b3b49795c720e5ffa0.tar.gz
gsoc2013-evolution-63e96e100291b330e75cc3b3b49795c720e5ffa0.tar.bz2
gsoc2013-evolution-63e96e100291b330e75cc3b3b49795c720e5ffa0.tar.lz
gsoc2013-evolution-63e96e100291b330e75cc3b3b49795c720e5ffa0.tar.xz
gsoc2013-evolution-63e96e100291b330e75cc3b3b49795c720e5ffa0.tar.zst
gsoc2013-evolution-63e96e100291b330e75cc3b3b49795c720e5ffa0.zip
Redo this a lot so that instead of having a class full of callbacks, we
* camel-session.c: Redo this a lot so that instead of having a class full of callbacks, we have a subclassable class. Also, replace the increasingly horrifying camel_session_query_authenticator with three new routines, camel_session_get_password, camel_session_forget_password, and camel_session_alert_user. * camel-pgp-context.c: * camel-pkcs7-context.c: * camel-smime-context.c: * providers/imap/camel-imap-store.c: * providers/pop3/camel-pop3-store.c: * providers/smtp/camel-smtp-transport.c: Use camel_session_get_password / camel_session_forget_password. * camel-tcp-stream-ssl.c (ssl_bad_cert): Use camel_session_alert_user. svn path=/trunk/; revision=9617
Diffstat (limited to 'camel')
-rw-r--r--camel/ChangeLog20
-rw-r--r--camel/camel-pgp-context.c10
-rw-r--r--camel/camel-pkcs7-context.c5
-rw-r--r--camel/camel-session.c382
-rw-r--r--camel/camel-session.h143
-rw-r--r--camel/camel-smime-context.c5
-rw-r--r--camel/camel-tcp-stream-ssl.c8
-rw-r--r--camel/providers/imap/camel-imap-store.c11
-rw-r--r--camel/providers/pop3/camel-pop3-store.c10
-rw-r--r--camel/providers/smtp/camel-smtp-transport.c11
10 files changed, 361 insertions, 244 deletions
diff --git a/camel/ChangeLog b/camel/ChangeLog
index e0e98844b8..2a5d9a0149 100644
--- a/camel/ChangeLog
+++ b/camel/ChangeLog
@@ -1,3 +1,23 @@
+2001-04-27 Dan Winship <danw@ximian.com>
+
+ * camel-session.c: Redo this a lot so that instead of having a
+ class full of callbacks, we have a subclassable class. Also,
+ replace the increasingly horrifying
+ camel_session_query_authenticator with three new routines,
+ camel_session_get_password, camel_session_forget_password, and
+ camel_session_alert_user.
+
+ * camel-pgp-context.c:
+ * camel-pkcs7-context.c:
+ * camel-smime-context.c:
+ * providers/imap/camel-imap-store.c:
+ * providers/pop3/camel-pop3-store.c:
+ * providers/smtp/camel-smtp-transport.c:
+ Use camel_session_get_password / camel_session_forget_password.
+
+ * camel-tcp-stream-ssl.c (ssl_bad_cert): Use
+ camel_session_alert_user.
+
2001-04-26 Jeffrey Stedfast <fejj@ximian.com>
* camel.c (camel_init): Automagically call camel_shutdown()
diff --git a/camel/camel-pgp-context.c b/camel/camel-pgp-context.c
index f34d5f8c27..c2e361ce40 100644
--- a/camel/camel-pgp-context.c
+++ b/camel/camel-pgp-context.c
@@ -192,9 +192,9 @@ pgp_get_passphrase (CamelSession *session, CamelPgpType pgp_type, char *userid)
type);
/* Use the userid as a key if possible, else be generic and use the type */
- passphrase = camel_session_query_authenticator (session, CAMEL_AUTHENTICATOR_ASK,
- prompt, TRUE, NULL, userid ? userid : (char *) type,
- NULL);
+ passphrase = camel_session_get_password (session, prompt, TRUE,
+ NULL, userid ? userid : type,
+ NULL);
g_free (prompt);
return passphrase;
@@ -208,9 +208,7 @@ pgp_forget_passphrase (CamelSession *session, CamelPgpType pgp_type, char *useri
if (!userid)
type = pgp_get_type_as_string (pgp_type);
- camel_session_query_authenticator (session, CAMEL_AUTHENTICATOR_TELL,
- NULL, FALSE, NULL, userid ? userid : (char *) type,
- NULL);
+ camel_session_forget_password (session, NULL, userid ? userid : type, NULL);
}
static int
diff --git a/camel/camel-pkcs7-context.c b/camel/camel-pkcs7-context.c
index fee277e079..185ae09ccc 100644
--- a/camel/camel-pkcs7-context.c
+++ b/camel/camel-pkcs7-context.c
@@ -195,9 +195,8 @@ get_password (void *arg, SECKEYKeyDBHandle *handle)
return pwitem;
prompt = g_strdup_printf (_("Please enter your password for %s"), userid);
- passwd = camel_session_query_authenticator (session, CAMEL_AUTHENTICATOR_ASK,
- prompt, TRUE, NULL, userid,
- NULL);
+ passwd = camel_session_get_password (session, prompt, TRUE,
+ NULL, userid, NULL);
g_free (prompt);
/* hash the password */
diff --git a/camel/camel-session.c b/camel/camel-session.c
index 9399364bde..a6e308693f 100644
--- a/camel/camel-session.c
+++ b/camel/camel-session.c
@@ -2,13 +2,12 @@
/* camel-session.c : Abstract class for an email session */
/*
- *
- * Author:
+ * Authors:
+ * Dan Winship <danw@ximian.com>
+ * Jeffrey Stedfast <fejj@ximian.com>
* Bertrand Guiheneuf <bertrand@helixcode.com>
- * Dan Winship <danw@helixcode.com>
- * Jeffrey Stedfast <fejj@helixcode.com>
*
- * Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
+ * Copyright 1999 - 2001 Ximian, Inc.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
@@ -46,9 +45,22 @@
#include "camel-private.h"
-#define d(x)
+#define CS_CLASS(so) CAMEL_SESSION_CLASS (CAMEL_OBJECT_GET_CLASS (so))
+
+static void register_provider (CamelSession *session, CamelProvider *provider);
+static GList *list_providers (CamelSession *session, gboolean load);
+static CamelProvider *get_provider (CamelSession *session,
+ const char *url_string,
+ CamelException *ex);
+
+static CamelService *get_service (CamelSession *session,
+ const char *url_string,
+ CamelProviderType type,
+ CamelException *ex);
+static char *get_storage_path (CamelSession *session,
+ CamelService *service,
+ CamelException *ex);
-static CamelObjectClass *parent_class;
/* The vfolder provider is always avilable */
static CamelProvider vee_provider = {
@@ -107,7 +119,15 @@ camel_session_finalise (CamelObject *o)
static void
camel_session_class_init (CamelSessionClass *camel_session_class)
{
- parent_class = camel_type_get_global_classfuncs (camel_object_get_type ());
+ /* virtual method definition */
+ camel_session_class->register_provider = register_provider;
+ camel_session_class->list_providers = list_providers;
+ camel_session_class->get_provider = get_provider;
+ camel_session_class->get_service = get_service;
+ camel_session_class->get_storage_path = get_storage_path;
+
+ vee_provider.object_types[CAMEL_PROVIDER_STORE] = camel_vee_store_get_type ();
+ vee_provider.service_cache = g_hash_table_new (camel_url_hash, camel_url_equal);
}
CamelType
@@ -116,50 +136,39 @@ camel_session_get_type (void)
static CamelType camel_session_type = CAMEL_INVALID_TYPE;
if (camel_session_type == CAMEL_INVALID_TYPE) {
- camel_session_type = camel_type_register (camel_object_get_type (), "CamelSession",
- sizeof (CamelSession),
- sizeof (CamelSessionClass),
- (CamelObjectClassInitFunc) camel_session_class_init,
- NULL,
- (CamelObjectInitFunc) camel_session_init,
- (CamelObjectFinalizeFunc) camel_session_finalise);
+ camel_session_type = camel_type_register (
+ camel_object_get_type (), "CamelSession",
+ sizeof (CamelSession),
+ sizeof (CamelSessionClass),
+ (CamelObjectClassInitFunc) camel_session_class_init,
+ NULL,
+ (CamelObjectInitFunc) camel_session_init,
+ (CamelObjectFinalizeFunc) camel_session_finalise);
}
return camel_session_type;
}
/**
- * camel_session_new:
- * @storage_path: Path to a directory Camel can use for persistent storage.
- * (This directory must already exist.)
- * @authenticator: A callback for discussing authentication information
- * @registrar: A callback for registering timeout callbacks
- * @remove: A callback for removing timeout callbacks
+ * camel_session_construct:
+ * @session: a session object to construct
+ * @storage_path: path to a directory the session can use for
+ * persistent storage. (This directory must already exist.)
*
- * This creates a new CamelSession object, which represents global state
- * for the Camel library, and contains callbacks that can be used to
- * interact with the main application.
- *
- * Return value: the new CamelSession
+ * Constructs @session.
**/
-CamelSession *
-camel_session_new (const char *storage_path,
- CamelAuthCallback authenticator,
- CamelTimeoutRegisterCallback registrar,
- CamelTimeoutRemoveCallback remover)
+void
+camel_session_construct (CamelSession *session, const char *storage_path)
{
- CamelSession *session = CAMEL_SESSION (camel_object_new (CAMEL_SESSION_TYPE));
-
session->storage_path = g_strdup (storage_path);
- session->authenticator = authenticator;
- session->registrar = registrar;
- session->remover = remover;
-
- vee_provider.object_types[CAMEL_PROVIDER_STORE] = camel_vee_store_get_type();
- vee_provider.service_cache = g_hash_table_new(camel_url_hash, camel_url_equal);
camel_session_register_provider(session, &vee_provider);
+}
+
- return session;
+static void
+register_provider (CamelSession *session, CamelProvider *provider)
+{
+ g_hash_table_insert (session->providers, provider->protocol, provider);
}
/**
@@ -180,9 +189,10 @@ camel_session_register_provider (CamelSession *session,
g_return_if_fail (CAMEL_IS_SESSION (session));
g_return_if_fail (provider != NULL);
- g_hash_table_insert (session->providers, provider->protocol, provider);
+ CS_CLASS (session)->register_provider (session, provider);
}
+
static void
ensure_loaded (gpointer key, gpointer value, gpointer user_data)
{
@@ -217,6 +227,18 @@ add_to_list (gpointer key, gpointer value, gpointer user_data)
*list = g_list_insert_sorted (*list, prov, provider_compare);
}
+static GList *
+list_providers (CamelSession *session, gboolean load)
+{
+ GList *list = NULL;
+
+ if (load)
+ g_hash_table_foreach (session->modules, ensure_loaded, session);
+
+ g_hash_table_foreach (session->providers, add_to_list, &list);
+ return list;
+}
+
/**
* camel_session_list_providers:
* @session: the session
@@ -235,24 +257,21 @@ camel_session_list_providers (CamelSession *session, gboolean load)
g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);
- CAMEL_SESSION_LOCK(session, lock);
-
- if (load)
- g_hash_table_foreach (session->modules, ensure_loaded, session);
-
- list = NULL;
- g_hash_table_foreach (session->providers, add_to_list, &list);
-
- CAMEL_SESSION_UNLOCK(session, lock);
+ CAMEL_SESSION_LOCK (session, lock);
+ list = CS_CLASS (session)->list_providers (session, load);
+ CAMEL_SESSION_UNLOCK (session, lock);
return list;
}
+
static CamelProvider *
-get_provider_locked (CamelSession *session, const char *protocol,
- CamelException *ex)
+get_provider (CamelSession *session, const char *url_string, CamelException *ex)
{
CamelProvider *provider;
+ char *protocol;
+
+ protocol = g_strndup (url_string, strcspn (url_string, ":"));
provider = g_hash_table_lookup (session->providers, protocol);
if (!provider) {
@@ -262,8 +281,10 @@ get_provider_locked (CamelSession *session, const char *protocol,
path = g_hash_table_lookup (session->modules, protocol);
if (path) {
camel_provider_load (session, path, ex);
- if (camel_exception_is_set (ex))
+ if (camel_exception_is_set (ex)) {
+ g_free (protocol);
return NULL;
+ }
}
provider = g_hash_table_lookup (session->providers, protocol);
}
@@ -273,6 +294,7 @@ get_provider_locked (CamelSession *session, const char *protocol,
_("No provider available for protocol `%s'"),
protocol);
}
+ g_free (protocol);
return provider;
}
@@ -293,13 +315,10 @@ camel_session_get_provider (CamelSession *session, const char *url_string,
CamelException *ex)
{
CamelProvider *provider;
- char *protocol;
- protocol = g_strndup (url_string, strcspn (url_string, ":"));
- CAMEL_SESSION_LOCK(session, lock);
- provider = get_provider_locked (session, protocol, ex);
- CAMEL_SESSION_UNLOCK(session, lock);
- g_free (protocol);
+ CAMEL_SESSION_LOCK (session, lock);
+ provider = CS_CLASS (session)->get_provider (session, url_string, ex);
+ CAMEL_SESSION_UNLOCK (session, lock);
return provider;
}
@@ -323,28 +342,10 @@ service_cache_remove (CamelService *service, gpointer event_data, gpointer user_
CAMEL_SESSION_UNLOCK(session, lock);
}
-/**
- * camel_session_get_service:
- * @session: the CamelSession
- * @url_string: a Camel URL describing the service to get
- * @type: the provider type (%CAMEL_PROVIDER_STORE or
- * %CAMEL_PROVIDER_TRANSPORT) to get, since some URLs may be able
- * to specify either type.
- * @ex: a CamelException
- *
- * This resolves a CamelURL into a CamelService, including loading the
- * provider library for that service if it has not already been loaded.
- *
- * Services are cached, and asking for "the same" @url_string multiple
- * times will return the same CamelService (with its reference count
- * incremented by one each time). What constitutes "the same" URL
- * depends in part on the provider.
- *
- * Return value: the requested CamelService, or %NULL
- **/
-CamelService *
-camel_session_get_service (CamelSession *session, const char *url_string,
- CamelProviderType type, CamelException *ex)
+
+static CamelService *
+get_service (CamelSession *session, const char *url_string,
+ CamelProviderType type, CamelException *ex)
{
CamelURL *url;
CamelProvider *provider;
@@ -356,8 +357,7 @@ camel_session_get_service (CamelSession *session, const char *url_string,
/* We need to look up the provider so we can then lookup
the service in the provider's cache */
- CAMEL_SESSION_LOCK(session, lock);
- provider = get_provider_locked (session, url->protocol, ex);
+ provider = CS_CLASS (session)->get_provider (session, url->protocol, ex);
if (provider && !provider->object_types[type]) {
camel_exception_setv (ex, CAMEL_EXCEPTION_SERVICE_URL_INVALID,
_("No provider available for protocol `%s'"),
@@ -366,7 +366,6 @@ camel_session_get_service (CamelSession *session, const char *url_string,
}
if (!provider) {
camel_url_free (url);
- CAMEL_SESSION_UNLOCK(session, lock);
return NULL;
}
@@ -375,7 +374,6 @@ camel_session_get_service (CamelSession *session, const char *url_string,
if (service != NULL) {
camel_url_free (url);
camel_object_ref (CAMEL_OBJECT (service));
- CAMEL_SESSION_UNLOCK(session, lock);
return service;
}
@@ -388,7 +386,41 @@ camel_session_get_service (CamelSession *session, const char *url_string,
g_hash_table_insert (provider->service_cache, url, service);
camel_object_hook_event (CAMEL_OBJECT (service), "finalize", (CamelObjectEventHookFunc) service_cache_remove, session);
}
- CAMEL_SESSION_UNLOCK(session, lock);
+
+ return service;
+}
+
+/**
+ * camel_session_get_service:
+ * @session: the CamelSession
+ * @url_string: a Camel URL describing the service to get
+ * @type: the provider type (%CAMEL_PROVIDER_STORE or
+ * %CAMEL_PROVIDER_TRANSPORT) to get, since some URLs may be able
+ * to specify either type.
+ * @ex: a CamelException
+ *
+ * This resolves a CamelURL into a CamelService, including loading the
+ * provider library for that service if it has not already been loaded.
+ *
+ * Services are cached, and asking for "the same" @url_string multiple
+ * times will return the same CamelService (with its reference count
+ * incremented by one each time). What constitutes "the same" URL
+ * depends in part on the provider.
+ *
+ * Return value: the requested CamelService, or %NULL
+ **/
+CamelService *
+camel_session_get_service (CamelSession *session, const char *url_string,
+ CamelProviderType type, CamelException *ex)
+{
+ CamelService *service;
+
+ g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);
+ g_return_val_if_fail (url_string != NULL, NULL);
+
+ CAMEL_SESSION_LOCK (session, lock);
+ service = CS_CLASS (session)->get_service (session, url_string, type, ex);
+ CAMEL_SESSION_UNLOCK (session, lock);
return service;
}
@@ -429,6 +461,29 @@ camel_session_get_service_connected (CamelSession *session,
}
+static char *
+get_storage_path (CamelSession *session, CamelService *service, CamelException *ex)
+{
+ char *path, *p;
+
+ p = camel_service_get_path (service);
+ path = g_strdup_printf ("%s/%s", session->storage_path, p);
+ g_free (p);
+
+ if (access (path, F_OK) == 0)
+ return path;
+
+ if (camel_mkdir_hier (path, S_IRWXU) == -1) {
+ camel_exception_setv (ex, CAMEL_EXCEPTION_SYSTEM,
+ _("Could not create directory %s:\n%s"),
+ path, g_strerror (errno));
+ g_free (path);
+ return NULL;
+ }
+
+ return path;
+}
+
/**
* camel_session_get_storage_path:
* @session: session object
@@ -448,91 +503,115 @@ char *
camel_session_get_storage_path (CamelSession *session, CamelService *service,
CamelException *ex)
{
- char *path, *p;
-
- p = camel_service_get_path (service);
- path = g_strdup_printf ("%s/%s", session->storage_path, p);
- g_free (p);
-
- if (access (path, F_OK) == 0)
- return path;
-
- if (camel_mkdir_hier (path, S_IRWXU) == -1) {
- camel_exception_setv (ex, CAMEL_EXCEPTION_SYSTEM,
- _("Could not create directory %s:\n%s"),
- path, g_strerror (errno));
- g_free (path);
- return NULL;
- }
-
- return path;
+ g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);
+ g_return_val_if_fail (CAMEL_IS_SERVICE (service), NULL);
+
+ return CS_CLASS (session)->get_storage_path (session, service, ex);
}
+
/**
- * camel_session_query_authenticator: query the session authenticator
+ * camel_session_get_password:
* @session: session object
- * @mode: %CAMEL_AUTHENTICATOR_ASK, %CAMEL_AUTHENTICATOR_TELL or CAMEL_AUTHENTICATOR_ACCEPT
- * @data: prompt to query user with, or data to cache
- * @secret: whether or not the data is secret (eg, a password)
+ * @prompt: prompt to provide to user
+ * @secret: whether or not the data is secret (eg, a password, as opposed
+ * to a smartcard response)
* @service: the service this query is being made by
* @item: an identifier, unique within this service, for the information
* @ex: a CamelException
*
- * This function is used by a CamelService to discuss authentication
- * information with the application.
+ * This function is used by a CamelService to ask the application and
+ * the user for a password or other authentication data.
*
* @service and @item together uniquely identify the piece of data the
* caller is concerned with.
*
- * If @mode is %CAMEL_AUTHENTICATOR_ASK, then @data is a question to
- * ask the user (if the application doesn't already have the answer
- * cached). If @secret is set, the user's input should not be echoed
- * back. The authenticator should set @ex to
- * %CAMEL_EXCEPTION_USER_CANCEL if the user did not provide the
+ * @prompt is a question to ask the user (if the application doesn't
+ * already have the answer cached). If @secret is set, the user's
+ * input will not be echoed back. The authenticator should set @ex
+ * to %CAMEL_EXCEPTION_USER_CANCEL if the user did not provide the
* information. The caller must g_free() the information returned when
* it is done with it.
*
- * If @mode is %CAMEL_AUTHENTICATOR_TELL, then @data is information
- * that the application should cache, or %NULL if it should stop
- * caching anything about that datum (eg, because the data is a
- * password that turned out to be incorrect).
- *
- * If @mode is %CAMEL_AUTHENTICATOR_ACCEPT, then @data is a YES/NO
- * question to ask the user (if the application doesn't already have
- * the answer cached). Return GINT_TO_POINTER(TRUE) on accept, or
- * GINT_TO_POINTER(FALSE) to decline.
- *
* Return value: the authentication information or %NULL.
**/
-gpointer
-camel_session_query_authenticator (CamelSession *session,
- CamelAuthCallbackMode mode,
- char *prompt, gboolean secret,
- CamelService *service, char *item,
- CamelException *ex)
+char *
+camel_session_get_password (CamelSession *session, const char *prompt,
+ gboolean secret, CamelService *service,
+ const char *item, CamelException *ex)
{
- return session->authenticator (mode, prompt, secret,
- service, item, ex);
+ g_return_val_if_fail (CAMEL_IS_SESSION (session), NULL);
+ g_return_val_if_fail (CAMEL_IS_SERVICE (service), NULL);
+ g_return_val_if_fail (prompt != NULL, NULL);
+ g_return_val_if_fail (item != NULL, NULL);
+
+ return CS_CLASS (session)->get_password (session, prompt, secret, service, item, ex);
}
+/**
+ * camel_session_forget_password:
+ * @session: session object
+ * @service: the service rejecting the password
+ * @item: an identifier, unique within this service, for the information
+ * @ex: a CamelException
+ *
+ * This function is used by a CamelService to tell the application
+ * that the authentication information it provided via
+ * camel_session_get_password was rejected by the service. If the
+ * application was caching this information, it should stop,
+ * and if the service asks for it again, it should ask the user.
+ *
+ * @service and @item identify the rejected authentication information,
+ * as with camel_session_get_password.
+ **/
+void
+camel_session_forget_password (CamelSession *session, CamelService *service,
+ const char *item, CamelException *ex)
+{
+ g_return_if_fail (CAMEL_IS_SESSION (session));
+ g_return_if_fail (CAMEL_IS_SERVICE (service));
+ g_return_if_fail (item != NULL);
+
+ CS_CLASS (session)->forget_password (session, service, item, ex);
+}
/**
- * camel_session_register_timeout: Register a timeout to be called
- * periodically.
+ * camel_session_alert_user:
+ * @session: session object
+ * @type: the type of alert (info, warning, or error)
+ * @prompt: the message for the user
+ * @cancel: whether or not to provide a "Cancel" option in addition to
+ * an "OK" option.
+ *
+ * Presents the given @prompt to the user, in the style indicated by
+ * @type. If @cancel is %TRUE, the user will be able to accept or
+ * cancel. Otherwise, the message is purely informational.
*
+ * Return value: %TRUE if the user accepts, %FALSE if they cancel.
+ */
+gboolean
+camel_session_alert_user (CamelSession *session, CamelSessionAlertType type,
+ const char *prompt, gboolean cancel)
+{
+ g_return_val_if_fail (CAMEL_IS_SESSION (session), FALSE);
+ g_return_val_if_fail (prompt != NULL, FALSE);
+
+ return CS_CLASS (session)->alert_user (session, type, prompt, cancel);
+}
+
+/**
+ * camel_session_register_timeout:
* @session: the CamelSession
* @interval: the number of milliseconds interval between calls
* @callback: the function to call
* @user_data: extra data to be passed to the callback
*
- * This function will use the registrar callback provided upon
- * camel_session_new to register the timeout. The callback will
- * be called every @interval milliseconds until it returns @FALSE.
- * It will be passed one argument, @user_data.
+ * Registers the given timeout. @callback will be called every
+ * @interval milliseconds with one argument, @user_data, until it
+ * returns %FALSE.
*
- * Returns a nonzero handle that can be used with
- * camel_session_remove_timeout on success, and 0 on failure to
- * register the timeout.
+ * Return value: On success, a non-zero handle that can be used with
+ * camel_session_remove_timeout(). On failure, 0.
**/
guint
camel_session_register_timeout (CamelSession *session,
@@ -540,25 +619,24 @@ camel_session_register_timeout (CamelSession *session,
CamelTimeoutCallback callback,
gpointer user_data)
{
- g_return_val_if_fail (CAMEL_IS_SESSION (session), FALSE);
+ g_return_val_if_fail (CAMEL_IS_SESSION (session), 0);
- return session->registrar (interval, callback, user_data);
+ return CS_CLASS (session)->register_timeout (session, interval, callback, user_data);
}
/**
- * camel_session_remove_timeout: Remove a previously registered
- * timeout.
- *
+ * camel_session_remove_timeout:
* @session: the CamelSession
- * @handle: a value returned from camel_session_register_timeout
+ * @handle: a value returned from camel_session_register_timeout()
*
- * This function will use the remover callback provided upon
- * camel_session_new to remove the timeout.
+ * Removes the indicated timeout.
*
- * Returns TRUE on success and FALSE on failure.
+ * Return value: %TRUE on success, %FALSE on failure.
**/
gboolean
camel_session_remove_timeout (CamelSession *session, guint handle)
{
- return session->remover (handle);
+ g_return_val_if_fail (CAMEL_IS_SESSION (session), FALSE);
+
+ return CS_CLASS (session)->remove_timeout (session, handle);
}
diff --git a/camel/camel-session.h b/camel/camel-session.h
index c73fa853ce..e777bdcb6c 100644
--- a/camel/camel-session.h
+++ b/camel/camel-session.h
@@ -43,22 +43,12 @@ extern "C" {
#define CAMEL_IS_SESSION(o) (CAMEL_CHECK_TYPE((o), CAMEL_SESSION_TYPE))
-typedef enum {
- CAMEL_AUTHENTICATOR_ASK,
- CAMEL_AUTHENTICATOR_TELL,
- CAMEL_AUTHENTICATOR_ACCEPT
-} CamelAuthCallbackMode;
-
-typedef gpointer (*CamelAuthCallback) (CamelAuthCallbackMode mode,
- char *data, gboolean secret,
- CamelService *service, char *item,
- CamelException *ex);
-
typedef gboolean (*CamelTimeoutCallback) (gpointer data);
-typedef guint (*CamelTimeoutRegisterCallback) (guint32 interval,
- CamelTimeoutCallback cb,
- gpointer camel_data);
-typedef gboolean (*CamelTimeoutRemoveCallback) (guint id);
+typedef enum {
+ CAMEL_SESSION_ALERT_INFO,
+ CAMEL_SESSION_ALERT_WARNING,
+ CAMEL_SESSION_ALERT_ERROR
+} CamelSessionAlertType;
struct _CamelSession
{
@@ -66,16 +56,50 @@ struct _CamelSession
struct _CamelSessionPrivate *priv;
char *storage_path;
- CamelAuthCallback authenticator;
- CamelTimeoutRegisterCallback registrar;
- CamelTimeoutRemoveCallback remover;
-
GHashTable *providers, *modules;
};
typedef struct {
CamelObjectClass parent_class;
+ void (*register_provider) (CamelSession *session,
+ CamelProvider *provider);
+ GList * (*list_providers) (CamelSession *session,
+ gboolean load);
+ CamelProvider * (*get_provider) (CamelSession *session,
+ const char *url_string,
+ CamelException *ex);
+
+ CamelService * (*get_service) (CamelSession *session,
+ const char *url_string,
+ CamelProviderType type,
+ CamelException *ex);
+ char * (*get_storage_path) (CamelSession *session,
+ CamelService *service,
+ CamelException *ex);
+
+ char * (*get_password) (CamelSession *session,
+ const char *prompt,
+ gboolean secret,
+ CamelService *service,
+ const char *item,
+ CamelException *ex);
+ void (*forget_password) (CamelSession *session,
+ CamelService *service,
+ const char *item,
+ CamelException *ex);
+ gboolean (*alert_user) (CamelSession *session,
+ CamelSessionAlertType type,
+ const char *prompt,
+ gboolean cancel);
+
+ guint (*register_timeout) (CamelSession *session,
+ guint32 interval,
+ CamelTimeoutCallback callback,
+ gpointer user_data);
+ gboolean (*remove_timeout) (CamelSession *session,
+ guint handle);
+
} CamelSessionClass;
@@ -85,53 +109,58 @@ typedef struct {
CamelType camel_session_get_type (void);
-CamelSession * camel_session_new (const char *storage_path,
- CamelAuthCallback authenticator,
- CamelTimeoutRegisterCallback registrar,
- CamelTimeoutRemoveCallback remover);
+void camel_session_construct (CamelSession *session,
+ const char *storage_path);
-void camel_session_register_provider (CamelSession *session,
- CamelProvider *provider);
-GList * camel_session_list_providers (CamelSession *session,
- gboolean load);
+void camel_session_register_provider (CamelSession *session,
+ CamelProvider *provider);
+GList * camel_session_list_providers (CamelSession *session,
+ gboolean load);
-CamelProvider * camel_session_get_provider (CamelSession *session,
- const char *url_string,
- CamelException *ex);
+CamelProvider * camel_session_get_provider (CamelSession *session,
+ const char *url_string,
+ CamelException *ex);
-CamelService * camel_session_get_service (CamelSession *session,
- const char *url_string,
- CamelProviderType type,
- CamelException *ex);
-CamelService * camel_session_get_service_connected (CamelSession *session,
- const char *url_string,
- CamelProviderType type,
- CamelException *ex);
+CamelService * camel_session_get_service (CamelSession *session,
+ const char *url_string,
+ CamelProviderType type,
+ CamelException *ex);
+CamelService * camel_session_get_service_connected (CamelSession *session,
+ const char *url_string,
+ CamelProviderType type,
+ CamelException *ex);
#define camel_session_get_store(session, url_string, ex) \
((CamelStore *) camel_session_get_service_connected (session, url_string, CAMEL_PROVIDER_STORE, ex))
#define camel_session_get_transport(session, url_string, ex) \
((CamelTransport *) camel_session_get_service_connected (session, url_string, CAMEL_PROVIDER_TRANSPORT, ex))
-char * camel_session_get_storage_path (CamelSession *session,
- CamelService *service,
- CamelException *ex);
-
-gpointer camel_session_query_authenticator (CamelSession *session,
- CamelAuthCallbackMode mode,
- char *prompt,
- gboolean secret,
- CamelService *service,
- char *item,
- CamelException *ex);
-
-guint camel_session_register_timeout (CamelSession *session,
- guint32 interval,
- CamelTimeoutCallback callback,
- gpointer user_data);
-
-gboolean camel_session_remove_timeout (CamelSession *session,
- guint handle);
+char * camel_session_get_storage_path (CamelSession *session,
+ CamelService *service,
+ CamelException *ex);
+
+char * camel_session_get_password (CamelSession *session,
+ const char *prompt,
+ gboolean secret,
+ CamelService *service,
+ const char *item,
+ CamelException *ex);
+void camel_session_forget_password (CamelSession *session,
+ CamelService *service,
+ const char *item,
+ CamelException *ex);
+gboolean camel_session_alert_user (CamelSession *session,
+ CamelSessionAlertType type,
+ const char *prompt,
+ gboolean cancel);
+
+guint camel_session_register_timeout (CamelSession *session,
+ guint32 interval,
+ CamelTimeoutCallback callback,
+ gpointer user_data);
+
+gboolean camel_session_remove_timeout (CamelSession *session,
+ guint handle);
#ifdef __cplusplus
}
diff --git a/camel/camel-smime-context.c b/camel/camel-smime-context.c
index 1f0f81e86c..bbe311385b 100644
--- a/camel/camel-smime-context.c
+++ b/camel/camel-smime-context.c
@@ -197,9 +197,8 @@ get_password (void *arg, SECKEYKeyDBHandle *handle)
return pwitem;
prompt = g_strdup_printf (_("Please enter your password for %s"), userid);
- passwd = camel_session_query_authenticator (session, CAMEL_AUTHENTICATOR_ASK,
- prompt, TRUE, NULL, userid,
- NULL);
+ passwd = camel_session_get_password (session, prompt, TRUE,
+ NULL, userid, NULL);
g_free (prompt);
/* hash the password */
diff --git a/camel/camel-tcp-stream-ssl.c b/camel/camel-tcp-stream-ssl.c
index 7e521b0a4d..7fa81484da 100644
--- a/camel/camel-tcp-stream-ssl.c
+++ b/camel/camel-tcp-stream-ssl.c
@@ -336,7 +336,7 @@ ssl_bad_cert (void *data, PRFileDesc *sockfd)
CERTCertificate *cert;
CamelService *service;
char *prompt, *cert_str;
- gpointer accept;
+ gboolean accept;
g_return_val_if_fail (data != NULL, SECFailure);
g_return_val_if_fail (CAMEL_IS_SERVICE (data), SECFailure);
@@ -366,12 +366,10 @@ ssl_bad_cert (void *data, PRFileDesc *sockfd)
g_free (cert_str);
/* query the user to find out if we want to accept this certificate */
- accept = camel_session_query_authenticator (service->session, CAMEL_AUTHENTICATOR_ACCEPT,
- prompt, FALSE, service, NULL, NULL);
-
+ accept = camel_session_alert_user (service->session, CAMEL_SESSION_ALERT_WARNING, prompt, TRUE, NULL);
g_free (prompt);
- if (GPOINTER_TO_INT (accept))
+ if (accept)
return SECSuccess;
return SECFailure;
diff --git a/camel/providers/imap/camel-imap-store.c b/camel/providers/imap/camel-imap-store.c
index 38f585d6e7..9921de90c5 100644
--- a/camel/providers/imap/camel-imap-store.c
+++ b/camel/providers/imap/camel-imap-store.c
@@ -466,9 +466,8 @@ imap_auth_loop (CamelService *service, CamelException *ex)
while (!authenticated) {
if (errbuf) {
/* We need to un-cache the password before prompting again */
- camel_session_query_authenticator (
- session, CAMEL_AUTHENTICATOR_TELL, NULL,
- TRUE, service, "password", ex);
+ camel_session_forget_password (
+ session, service, "password", ex);
g_free (service->url->passwd);
service->url->passwd = NULL;
}
@@ -482,9 +481,9 @@ imap_auth_loop (CamelService *service, CamelException *ex)
service->url->user,
service->url->host);
service->url->passwd =
- camel_session_query_authenticator (
- session, CAMEL_AUTHENTICATOR_ASK,
- prompt, TRUE, service, "password", ex);
+ camel_session_get_password (
+ session, prompt, TRUE,
+ service, "password", ex);
g_free (prompt);
g_free (errbuf);
errbuf = NULL;
diff --git a/camel/providers/pop3/camel-pop3-store.c b/camel/providers/pop3/camel-pop3-store.c
index c163e844c9..2703f4b0fb 100644
--- a/camel/providers/pop3/camel-pop3-store.c
+++ b/camel/providers/pop3/camel-pop3-store.c
@@ -369,10 +369,9 @@ pop3_try_authenticate (CamelService *service, gboolean kpop,
"for %s@%s"), errmsg ? errmsg : "",
service->url->user,
service->url->host);
- service->url->passwd = camel_session_query_authenticator (
+ service->url->passwd = camel_session_get_password (
camel_service_get_session (service),
- CAMEL_AUTHENTICATOR_ASK, prompt, TRUE,
- service, "password", ex);
+ prompt, TRUE, service, "password", ex);
g_free (prompt);
if (!service->url->passwd)
return FALSE;
@@ -449,10 +448,9 @@ pop3_connect (CamelService *service, CamelException *ex)
camel_exception_clear (ex);
/* Uncache the password before prompting again. */
- camel_session_query_authenticator (
+ camel_session_forget_password (
camel_service_get_session (service),
- CAMEL_AUTHENTICATOR_TELL, NULL, TRUE, service,
- "password", ex);
+ service, "password", ex);
g_free (service->url->passwd);
service->url->passwd = NULL;
}
diff --git a/camel/providers/smtp/camel-smtp-transport.c b/camel/providers/smtp/camel-smtp-transport.c
index 5241394058..e6f0b8cafa 100644
--- a/camel/providers/smtp/camel-smtp-transport.c
+++ b/camel/providers/smtp/camel-smtp-transport.c
@@ -375,9 +375,8 @@ smtp_connect (CamelService *service, CamelException *ex)
while (!authenticated) {
if (errbuf) {
/* We need to un-cache the password before prompting again */
- camel_session_query_authenticator (
- session, CAMEL_AUTHENTICATOR_TELL, NULL,
- TRUE, service, "password", ex);
+ camel_session_forget_password (
+ session, service, "password", ex);
g_free (service->url->passwd);
service->url->passwd = NULL;
}
@@ -390,9 +389,9 @@ smtp_connect (CamelService *service, CamelException *ex)
service->url->host);
service->url->passwd =
- camel_session_query_authenticator (
- session, CAMEL_AUTHENTICATOR_ASK,
- prompt, TRUE, service, "password", ex);
+ camel_session_get_password (
+ session, prompt, TRUE,
+ service, "password", ex);
g_free (prompt);
g_free (errbuf);