aboutsummaryrefslogtreecommitdiffstats
path: root/camel/camel-provider.c
diff options
context:
space:
mode:
authorDan Winship <danw@src.gnome.org>2000-04-30 23:36:16 +0800
committerDan Winship <danw@src.gnome.org>2000-04-30 23:36:16 +0800
commit0524f7c06a47544f26997da30317b35361c9d62b (patch)
treef682673b15a5b721325ba90d43fe84ce70074c83 /camel/camel-provider.c
parent3c358f3c18ccbe888b77ea5d6fe67c9a385a715f (diff)
downloadgsoc2013-evolution-0524f7c06a47544f26997da30317b35361c9d62b.tar
gsoc2013-evolution-0524f7c06a47544f26997da30317b35361c9d62b.tar.gz
gsoc2013-evolution-0524f7c06a47544f26997da30317b35361c9d62b.tar.bz2
gsoc2013-evolution-0524f7c06a47544f26997da30317b35361c9d62b.tar.lz
gsoc2013-evolution-0524f7c06a47544f26997da30317b35361c9d62b.tar.xz
gsoc2013-evolution-0524f7c06a47544f26997da30317b35361c9d62b.tar.zst
gsoc2013-evolution-0524f7c06a47544f26997da30317b35361c9d62b.zip
Tweak the definition of CamelProvider. Among other things, a provider may
* camel-provider.h: Tweak the definition of CamelProvider. Among other things, a provider may now be both a store and a transport. * camel-provider.c: Remove a lot of code we had no intention of using. This now only contains two functions: camel_provider_init to read the installed .urls files, and camel_provider_load to load and register a new provider. * camel-session.c: Remove more unused code and simplify some of the remaining code. The list of available provider modules is now stored in the session, and it handles calling camel_provider_load to load them as needed. Provider registration is now done by calling back from the module init routine, which allows a single module to register providers for multiple URL types. * providers/*: Update provider structures and init routines for the new stuff. Add a .urls file to each provider specifying what urls it handles, and install that with the library. * providers/nntp/camel-nntp-provider.c: Add hints towards supporting both news: and nntp: URLs, and using nntp as both a store and a transport. svn path=/trunk/; revision=2691
Diffstat (limited to 'camel/camel-provider.c')
-rw-r--r--camel/camel-provider.c250
1 files changed, 101 insertions, 149 deletions
diff --git a/camel/camel-provider.c b/camel/camel-provider.c
index 52cfea60a1..83a51c3579 100644
--- a/camel/camel-provider.c
+++ b/camel/camel-provider.c
@@ -1,15 +1,16 @@
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
-/* camel-provider.c : provider framework */
+/* camel-provider.c: provider framework */
-/*
+/*
*
- * Author :
+ * Authors:
* Bertrand Guiheneuf <bertrand@helixcode.com>
+ * Dan Winship <danw@helixcode.com>
*
* Copyright 1999, 2000 Helix Code, Inc. (http://www.helixcode.com)
*
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
*
@@ -25,177 +26,128 @@
*/
-/*
- A provider can be added "by hand" or by loading a module.
-
-
- Adding providers with modules.
- ------------------------------
-
- The modules are shared libraries which must contain the
- function
-
- CamelProvider *camel_provider_module_init ();
-
- returning the provider object defined in the module
-
-
-*/
-
/* FIXME: Shouldn't we add a version number to providers ? */
#include "config.h"
#include "camel-provider.h"
+#include "camel-exception.h"
+#include "hash-table-utils.h"
#include <dirent.h>
+#include <errno.h>
+#include <stdio.h>
#include <string.h>
-static GList *_provider_list = NULL;
+#include <gmodule.h>
-static gint
-_provider_name_cmp (gconstpointer a, gconstpointer b)
-{
- CamelProvider *provider_a = CAMEL_PROVIDER (a);
- CamelProvider *provider_b = CAMEL_PROVIDER (b);
+char *camel_provider_type_name[CAMEL_NUM_PROVIDER_TYPES] = {
+ "store",
+ "transport"
+};
- return strcmp ( provider_a->name, provider_b->name);
-}
-
-void
-camel_provider_register (CamelProvider *provider)
+/**
+ * camel_provider_init:
+ *
+ * Initialize the Camel provider system by reading in the .urls
+ * files in the provider directory and creating a hash table mapping
+ * URLs to module names.
+ *
+ * A .urls file has the same initial prefix as the shared library it
+ * correspond to, and consists of a series of lines containing the URL
+ * protocols that that library handles.
+ *
+ * Return value: a hash table mapping URLs to module names
+ **/
+GHashTable *
+camel_provider_init (void)
{
- GList *old_provider_node = NULL;
-
- g_assert (provider);
+ GHashTable *providers;
+ DIR *dir;
+ struct dirent *d;
+ char *p, *name, buf[80];
+ FILE *f;
- if (_provider_list)
- old_provider_node = g_list_find_custom (_provider_list, provider, _provider_name_cmp);
+ providers = g_hash_table_new (g_strcase_hash, g_strcase_equal);
- if (old_provider_node != NULL) {
- /* camel_provider_unref (CAMEL_PROVIDER (old_provider_node->data)); */
- old_provider_node->data = provider;
- } else {
- /* be careful, we use prepend here, so that last registered
- providers come first */
- _provider_list = g_list_prepend (_provider_list, provider);
+ dir = opendir (CAMEL_PROVIDERDIR);
+ if (!dir) {
+ g_error ("Could not open camel provider directory: %s",
+ g_strerror (errno));
+ return NULL;
}
- /* camel_provider_ref (provider); */
-}
+ while ((d = readdir (dir))) {
+ p = strchr (d->d_name, '.');
+ if (!p || strcmp (p, ".urls") != 0)
+ continue;
-const CamelProvider *
-camel_provider_register_as_module (const gchar *module_path)
-{
-
- CamelProvider *new_provider = NULL;
- GModule *new_module = NULL;
- CamelProvider * (*camel_provider_module_init) ();
- gboolean has_module_init;
-
- g_return_val_if_fail (module_path, NULL);
+ name = g_strdup_printf ("%s/%s", CAMEL_PROVIDERDIR, d->d_name);
+ f = fopen (name, "r");
+ if (!f) {
+ g_warning ("Could not read provider info file %s: %s",
+ name, g_strerror (errno));
+ g_free (name);
+ continue;
+ }
- if (!g_module_supported ()) {
- g_warning ("CamelProvider::register_as_module: module "
- "loading not supported on this system\n");
- return NULL;
- }
-
+ p = strrchr (name, '.');
+ strcpy (p, ".so");
+ while ((fgets (buf, sizeof (buf), f))) {
+ buf[sizeof (buf) - 1] = '\0';
+ p = strchr (buf, '\n');
+ if (p)
+ *p = '\0';
- new_module = g_module_open (module_path, 0);
- if (!new_module) {
- printf ("g_module_open reports: %s\n", g_module_error ());
- g_warning ("CamelProvider::register_as_module: Unable to "
- "load module %s\n", module_path);
- return NULL;
- }
-
- has_module_init = g_module_symbol (new_module, "camel_provider_module_init", (gpointer *)&camel_provider_module_init);
- if (!has_module_init){
- g_warning ("CamelProvider::register_as_module loading "
- "of module %s failed,\n\tSymbol "
- "camel_provider_module_init not defined in it\n",
- module_path);
- return NULL;
+ g_hash_table_insert (providers, g_strdup (buf), name);
+ }
+ fclose (f);
}
- new_provider = camel_provider_module_init();
- new_provider->gmodule = new_module;
- camel_provider_register (new_provider);
-
- return new_provider;
-}
+ closedir (dir);
+ return providers;
+}
/**
- * camel_provider_scan: Scan for available providers and return a list.
- *
- * Note that this function will cause all providers in the providerdir
- * to be loaded into memory.
+ * camel_provider_load:
+ * @session: the current session
+ * @path: the path to a shared library
+ * @ex: a CamelException
*
- * Return value: the list of CamelProviders. The caller must free this
- * list when it is done with it.
- **/
-GList *
-camel_provider_scan (void)
+ * Loads the provider at @path, and calls its initialization function,
+ * passing @session as an argument. The provider should then register
+ * itself with @session.
+ **/
+void
+camel_provider_load (CamelSession *session, const char *path,
+ CamelException *ex)
{
- DIR *dir;
- struct dirent *dent;
- char *p, *name;
+ GModule *module;
+ CamelProvider *(*camel_provider_module_init) ();
- dir = opendir (CAMEL_PROVIDERDIR);
- if (!dir)
- return NULL;
- while ((dent = readdir (dir))) {
- p = strstr (dent->d_name, ".so");
- if (!p || strcmp (p, ".so") != 0)
- continue;
-
- name = g_module_build_path (CAMEL_PROVIDERDIR, dent->d_name);
- camel_provider_register_as_module (name);
- g_free (name);
+ if (!g_module_supported ()) {
+ camel_exception_setv (ex, CAMEL_EXCEPTION_SYSTEM,
+ "Could not load %s: Module loading "
+ "not supported on this system.",
+ path);
+ return;
}
- closedir (dir);
- return g_list_copy (_provider_list);
-}
-
+ module = g_module_open (path, 0);
+ if (!module) {
+ camel_exception_setv (ex, CAMEL_EXCEPTION_SYSTEM,
+ "Could not load %s: %s",
+ path, g_module_error ());
+ return;
+ }
-/**
- * camel_provider_get_for_protocol: get a registered provider for a protocol
- * @protocol: protocol name (case insensitive)
- * @type: provider type (transport, store, ...)
- *
- * Look into the list of registered provider if
- * one correspond both to the protocol name
- * and to the protocol type. When several providers
- * exist for a same protocol, the last registered
- * is returned.
- *
- * Return value: Matching provider or NULL if none exists.
- **/
-const CamelProvider *
-camel_provider_get_for_protocol (const gchar *protocol, ProviderType type)
-{
- CamelProvider *current_provider = NULL;
- GList *current_provider_node;
- gboolean protocol_is_found;
- gboolean provider_is_found;
-
- g_assert (protocol);
- g_return_val_if_fail (_provider_list, NULL);
-
- current_provider_node = _provider_list;
- provider_is_found = FALSE;
-
- while ((!provider_is_found) && current_provider_node) {
- current_provider = (CamelProvider *)current_provider_node->data;
-
- protocol_is_found = (g_strcasecmp (protocol, current_provider->protocol) == 0);
- if (protocol_is_found)
- provider_is_found = (current_provider->provider_type == type);
-
- current_provider_node = current_provider_node->next;
- }
+ if (!g_module_symbol (module, "camel_provider_module_init",
+ (gpointer *)&camel_provider_module_init)) {
+ camel_exception_setv (ex, CAMEL_EXCEPTION_SYSTEM,
+ "Could not load %s: No initialization "
+ "routine in module.", path);
+ g_module_close (module);
+ return;
+ }
- if (provider_is_found) return current_provider;
- else return NULL;
+ camel_provider_module_init (session);
}