diff options
Diffstat (limited to 'e-util/e-plugin.c')
| -rw-r--r-- | e-util/e-plugin.c | 1283 |
1 files changed, 0 insertions, 1283 deletions
diff --git a/e-util/e-plugin.c b/e-util/e-plugin.c deleted file mode 100644 index a60aa7bafd..0000000000 --- a/e-util/e-plugin.c +++ /dev/null @@ -1,1283 +0,0 @@ - -#ifdef HAVE_CONFIG_H -#include <config.h> -#endif - -#include <sys/types.h> -#include <dirent.h> -#include <string.h> - -#include <glib/gi18n.h> -#include <gconf/gconf-client.h> - -#include "e-plugin.h" -#include "libedataserver/e-msgport.h" - -/* plugin debug */ -#define pd(x) -/* plugin hook debug */ -#define phd(x) - -/* -<camel-plugin - class="org.gnome.camel.plugin.provider:1.0" - id="org.gnome.camel.provider.imap:1.0" - type="shlib" - location="/opt/gnome2/lib/camel/1.0/libcamelimap.so" - factory="camel_imap_provider_new"> - <name>imap</name> - <description>IMAP4 and IMAP4v1 mail store</description> - <class-data class="org.gnome.camel.plugin.provider:1.0" - protocol="imap" - domain="mail" - flags="remote,source,storage,ssl"/> -</camel-plugin> - -<camel-plugin - class="org.gnome.camel.plugin.sasl:1.0" - id="org.gnome.camel.sasl.plain:1.0" - type="shlib" - location="/opt/gnome2/lib/camel/1.0/libcamelsasl.so" - factory="camel_sasl_plain_new"> - <name>PLAIN</name> - <description>SASL PLAIN authentication mechanism</description> -</camel-plugin> -*/ - -/* EPlugin stuff */ -static GObjectClass *ep_parent_class; - -/* global table of plugin types by pluginclass.type */ -static GHashTable *ep_types; -/* plugin load path */ -static GSList *ep_path; -/* global table of plugins by plugin.id */ -static GHashTable *ep_plugins; -/* a table of GSLists of plugins by hook class for hooks not loadable yet */ -static GHashTable *ep_plugins_pending_hooks; -/* list of all cached xml docs:struct _plugin_doc's */ -static EDList ep_plugin_docs = E_DLIST_INITIALISER(ep_plugin_docs); -/* gconf client */ -static GConfClient *ep_gconf; -/* the list of disabled plugins from gconf */ -static GSList *ep_disabled; - -/* EPluginHook stuff */ -static void *eph_parent_class; -/* All classes which implement EPluginHooks, by class.id */ -static GHashTable *eph_types; - -struct _plugin_doc { - struct _plugin_doc *next; - struct _plugin_doc *prev; - - char *filename; - xmlDocPtr doc; - - GSList *plugin_hooks; /* EPlugin objects with pending hooks */ - GSList *plugins; /* xmlNodePtr's of plugins with unknown type (mono,etc) */ -}; - -static gboolean -ep_check_enabled(const char *id) -{ - GSList *l = ep_disabled; - - for (;l;l = g_slist_next(l)) - if (!strcmp((char *)l->data, id)) - return FALSE; - - return TRUE; -} - -static void -ep_set_enabled(const char *id, int state) -{ - if ((state == 0) == ep_check_enabled(id) == 0) - return; - - if (state) { - GSList *l = ep_disabled; - - while (l) { - GSList *n = l->next; - - if (!strcmp((char *)l->data, id)) { - g_free(l->data); - ep_disabled = g_slist_remove_link(ep_disabled, l); - } - l = n; - } - } else { - ep_disabled = g_slist_prepend(ep_disabled, g_strdup(id)); - } - - gconf_client_set_list(ep_gconf, "/apps/evolution/eplugin/disabled", GCONF_VALUE_STRING, ep_disabled, NULL); -} - -static int -ep_construct(EPlugin *ep, xmlNodePtr root) -{ - xmlNodePtr node; - int res = -1; - char *localedir; - - ep->domain = e_plugin_xml_prop(root, "domain"); - if (ep->domain - && (localedir = e_plugin_xml_prop(root, "localedir"))) { - bindtextdomain(ep->domain, localedir); - g_free(localedir); - } - - ep->name = e_plugin_xml_prop_domain(root, "name", ep->domain); - - pd(printf("creating plugin '%s' '%s'\n", ep->name?ep->name:"un-named", ep->id)); - - node = root->children; - while (node) { - if (strcmp(node->name, "hook") == 0) { - struct _EPluginHook *hook; - EPluginHookClass *type; - char *class = e_plugin_xml_prop(node, "class"); - - if (class == NULL) { - g_warning("Plugin '%s' load failed in '%s', missing class property for hook", ep->id, ep->path); - goto fail; - } - - if (ep->enabled - && eph_types != NULL - && (type = g_hash_table_lookup(eph_types, class)) != NULL) { - g_free(class); - hook = g_object_new(G_OBJECT_CLASS_TYPE(type), NULL); - res = type->construct(hook, ep, node); - if (res == -1) { - g_warning("Plugin '%s' failed to load hook", ep->name); - g_object_unref(hook); - goto fail; - } else { - ep->hooks = g_slist_append(ep->hooks, hook); - } - } else { - GSList *l; - char *oldclass; - - if (ep_plugins_pending_hooks == NULL) - ep_plugins_pending_hooks = g_hash_table_new(g_str_hash, g_str_equal); - if (!g_hash_table_lookup_extended(ep_plugins_pending_hooks, class, (void **)&oldclass, (void **)&l)) { - oldclass = class; - l = NULL; - } - l = g_slist_prepend(l, ep); - g_hash_table_insert(ep_plugins_pending_hooks, oldclass, l); - ep->hooks_pending = g_slist_prepend(ep->hooks_pending, node); - } - } else if (strcmp(node->name, "description") == 0) { - ep->description = e_plugin_xml_content_domain(node, ep->domain); - } else if (strcmp(node->name, "author") == 0) { - char *name = e_plugin_xml_prop(node, "name"); - char *email = e_plugin_xml_prop(node, "email"); - - if (name || email) { - EPluginAuthor *epa = g_malloc0(sizeof(*epa)); - - epa->name = name; - epa->email = email; - ep->authors = g_slist_append(ep->authors, epa); - } - } - node = node->next; - } - res = 0; -fail: - return res; -} - -static void -ep_enable(EPlugin *ep, int state) -{ - GSList *l; - - ep->enabled = state; - for (l=ep->hooks;l;l = g_slist_next(l)) - e_plugin_hook_enable((EPluginHook *)l->data, state); - - ep_set_enabled(ep->id, state); -} - -static void -ep_finalise(GObject *o) -{ - EPlugin *ep = (EPlugin *)o; - - g_free(ep->id); - g_free(ep->description); - g_free(ep->name); - g_free(ep->domain); - g_slist_free(ep->hooks_pending); - - g_slist_foreach(ep->hooks, (GFunc)g_object_unref, NULL); - g_slist_free(ep->hooks); - - ((GObjectClass *)ep_parent_class)->finalize(o); -} - -static void -ep_init(GObject *o) -{ - EPlugin *ep = (EPlugin *)o; - - ep->enabled = TRUE; -} - -static void -ep_class_init(EPluginClass *klass) -{ - ((GObjectClass *)klass)->finalize = ep_finalise; - klass->construct = ep_construct; - klass->enable = ep_enable; -} - -/** - * e_plugin_get_type: - * - * Standard GObject type function. This is only an abstract class, so - * you can only use this to subclass EPlugin. - * - * Return value: The type. - **/ -GType -e_plugin_get_type(void) -{ - static GType type = 0; - - if (!type) { - char *path, *col, *p; - - static const GTypeInfo info = { - sizeof(EPluginClass), NULL, NULL, (GClassInitFunc)ep_class_init, NULL, NULL, - sizeof(EPlugin), 0, (GInstanceInitFunc)ep_init, - }; - - ep_parent_class = g_type_class_ref(G_TYPE_OBJECT); - type = g_type_register_static(G_TYPE_OBJECT, "EPlugin", &info, 0); - - /* Add paths in the environment variable or default global and user specific paths */ - path = g_strdup(getenv("EVOLUTION_PLUGIN_PATH")); - if (path == NULL) { - /* Add the global path */ - e_plugin_add_load_path(EVOLUTION_PLUGINDIR); - - path = g_build_filename(g_get_home_dir(), ".eplugins", NULL); - } - - p = path; - while ((col = strchr(p, ':'))) { - *col++ = 0; - e_plugin_add_load_path(p); - p = col; - } - e_plugin_add_load_path(p); - g_free(path); - } - - return type; -} - -static EPlugin * -ep_load_plugin(xmlNodePtr root, struct _plugin_doc *pdoc) -{ - char *prop, *id; - EPluginClass *klass; - EPlugin *ep; - - id = e_plugin_xml_prop(root, "id"); - if (id == NULL) { - g_warning("Invalid e-plugin entry in '%s': no id", pdoc->filename); - return NULL; - } - - if (g_hash_table_lookup(ep_plugins, id)) { - g_warning("Plugin '%s' already defined", id); - g_free(id); - return NULL; - } - - prop = xmlGetProp(root, "type"); - if (prop == NULL) { - g_free(id); - g_warning("Invalid e-plugin entry in '%s': no type", pdoc->filename); - return NULL; - } - - /* If we can't find a plugin, add it to a pending list which is checked when a new type is registered */ - klass = g_hash_table_lookup(ep_types, prop); - if (klass == NULL) { - pd(printf("Delaying loading of plugin '%s' unknown type '%s'\n", id, prop)); - g_free(id); - xmlFree(prop); - pdoc->plugins = g_slist_prepend(pdoc->plugins, root); - return NULL; - } - xmlFree(prop); - - ep = g_object_new(G_TYPE_FROM_CLASS(klass), NULL); - ep->id = id; - ep->path = g_strdup(pdoc->filename); - ep->enabled = ep_check_enabled(id); - if (e_plugin_construct(ep, root) == -1) - e_plugin_enable(ep, FALSE); - g_hash_table_insert(ep_plugins, ep->id, ep); - - return ep; -} - -static int -ep_load(const char *filename) -{ - xmlDocPtr doc; - xmlNodePtr root; - int res = -1; - EPlugin *ep; - int cache = FALSE; - struct _plugin_doc *pdoc; - - doc = xmlParseFile(filename); - if (doc == NULL) { - return -1; - } - - root = xmlDocGetRootElement(doc); - if (strcmp(root->name, "e-plugin-list") != 0) { - g_warning("No <e-plugin-list> root element: %s", filename); - xmlFreeDoc(doc); - return -1; - } - - pdoc = g_malloc0(sizeof(*pdoc)); - pdoc->doc = doc; - pdoc->filename = g_strdup(filename); - - for (root = root->children; root ; root = root->next) { - if (strcmp(root->name, "e-plugin") == 0) { - ep = ep_load_plugin(root, pdoc); - if (ep) { - pdoc->plugin_hooks = g_slist_prepend(pdoc->plugin_hooks, ep); - cache |= (ep->hooks_pending != NULL); - } - cache |= pdoc->plugins != NULL; - } - } - - res = 0; - - if (cache) { - pd(printf("Caching plugin description '%s' for unknown future hooks\n", filename)); - e_dlist_addtail(&ep_plugin_docs, (EDListNode *)pdoc); - } else { - pd(printf("freeing plugin description '%s', nothing uses it\n", filename)); - xmlFreeDoc(pdoc->doc); - g_free(pdoc->filename); - g_free(pdoc); - } - - return res; -} - -/* This loads a hook that was pending on a given plugin but the type wasn't registered yet */ -/* This works in conjunction with ep_construct and e_plugin_hook_register_type to make sure - everything works nicely together. Apparently. */ -static int -ep_load_pending(EPlugin *ep, EPluginHookClass *type) -{ - int res = 0; - GSList *l, *p; - - phd(printf("New hook type registered '%s', loading pending hooks on plugin '%s'\n", type->id, ep->id)); - - l = ep->hooks_pending; - p = NULL; - while (l) { - GSList *n = l->next; - xmlNodePtr node = l->data; - char *class = xmlGetProp(node, "class"); - EPluginHook *hook; - - phd(printf(" checking pending hook '%s'\n", class?class:"<unknown>")); - - if (class) { - if (strcmp(class, type->id) == 0) { - hook = g_object_new(G_OBJECT_CLASS_TYPE(type), NULL); - res = type->construct(hook, ep, node); - if (res == -1) { - g_warning("Plugin '%s' failed to load hook '%s'", ep->name, type->id); - g_object_unref(hook); - } else { - ep->hooks = g_slist_append(ep->hooks, hook); - } - - if (p) - p->next = n; - else - ep->hooks_pending = n; - g_slist_free_1(l); - l = p; - } - - xmlFree(class); - } - - p = l; - l = n; - } - - return res; -} - -/** - * e_plugin_add_load_path: - * @path: The path to add to search for plugins. - * - * Add a path to be searched when e_plugin_load_plugins() is called. - * By default the system plugin directory and ~/.eplugins is used as - * the search path unless overriden by the environmental variable - * %EVOLUTION_PLUGIN_PATH. - * - * %EVOLUTION_PLUGIN_PATH is a : separated list of paths to search for - * plugin definitions in order. - * - * Plugin definitions are XML files ending in the extension ".eplug". - **/ -void -e_plugin_add_load_path(const char *path) -{ - ep_path = g_slist_append(ep_path, g_strdup(path)); -} - -/** - * e_plugin_load_plugins: - * - * Scan the search path, looking for plugin definitions, and load them - * into memory. - * - * Return value: Returns -1 if an error occured. - **/ -int -e_plugin_load_plugins(void) -{ - GSList *l; - - if (ep_types == NULL) { - g_warning("no plugin types defined"); - return 0; - } - - for (l = ep_path;l;l = g_slist_next(l)) { - DIR *dir; - struct dirent *d; - char *path = l->data; - - pd(printf("scanning plugin dir '%s'\n", path)); - - dir = opendir(path); - if (dir == NULL) { - /*g_warning("Could not find plugin path: %s", path);*/ - continue; - } - - while ( (d = readdir(dir)) ) { - if (strlen(d->d_name) > 6 - && !strcmp(d->d_name + strlen(d->d_name) - 6, ".eplug")) { - char * name = g_build_filename(path, d->d_name, NULL); - - ep_load(name); - g_free(name); - } - } - - closedir(dir); - } - - return 0; -} - -/** - * e_plugin_register_type: - * @type: The GObject type of the plugin loader. - * - * Register a new plugin type with the plugin system. Each type must - * subclass EPlugin and must override the type member of the - * EPluginClass with a unique name. - **/ -void -e_plugin_register_type(GType type) -{ - EPluginClass *klass; - struct _plugin_doc *pdoc, *ndoc; - - if (ep_types == NULL) { - ep_types = g_hash_table_new(g_str_hash, g_str_equal); - ep_plugins = g_hash_table_new(g_str_hash, g_str_equal); - /* TODO: notify listening */ - ep_gconf = gconf_client_get_default(); - ep_disabled = gconf_client_get_list(ep_gconf, "/apps/evolution/eplugin/disabled", GCONF_VALUE_STRING, NULL); - } - - klass = g_type_class_ref(type); - - pd(printf("register plugin type '%s'\n", klass->type)); - - g_hash_table_insert(ep_types, (void *)klass->type, klass); - - /* check for pending plugins */ - pdoc = (struct _plugin_doc *)ep_plugin_docs.head; - ndoc = pdoc->next; - while (ndoc) { - if (pdoc->plugins) { - GSList *l, *add = NULL; - - for (l=pdoc->plugins;l;l=g_slist_next(l)) { - xmlNodePtr root = l->data; - char *type; - - type = xmlGetProp(root, "type"); - if (!strcmp(type, klass->type)) - add = g_slist_append(add, l->data); - xmlFree(type); - } - - for (l=add;l;l=g_slist_next(l)) { - xmlNodePtr root = l->data; - EPlugin *ep; - - pdoc->plugins = g_slist_remove(pdoc->plugins, root); - ep = ep_load_plugin(root, pdoc); - if (ep) - pdoc->plugin_hooks = g_slist_prepend(pdoc->plugin_hooks, ep); - /* TODO: garbage collect plugin doc? */ - } - - g_slist_free(add); - } - - pdoc = ndoc; - ndoc = ndoc->next; - } -} - -static void -ep_list_plugin(void *key, void *val, void *dat) -{ - GSList **l = (GSList **)dat; - - *l = g_slist_prepend(*l, g_object_ref(val)); -} - -/** - * e_plugin_list_plugins: List all plugins. - * - * Static class method to retrieve a list of all current plugins. They - * are listed in no particular order. - * - * Return value: A GSList of all plugins, they must be - * g_object_unref'd and the list freed. - **/ -GSList * -e_plugin_list_plugins(void) -{ - GSList *l = NULL; - - if (ep_plugins) - g_hash_table_foreach(ep_plugins, ep_list_plugin, &l); - - return l; -} - -/** - * e_plugin_construct: - * @ep: An EPlugin derived object. - * @root: The XML root node of the sub-tree containing the plugin - * definition. - * - * Helper to invoke the construct virtual method. - * - * Return value: The return from the construct virtual method. - **/ -int -e_plugin_construct(EPlugin *ep, xmlNodePtr root) -{ - return ((EPluginClass *)G_OBJECT_GET_CLASS(ep))->construct(ep, root); -} - -/** - * e_plugin_invoke: - * @ep: - * @name: The name of the function to invoke. The format of this name - * will depend on the EPlugin type and its language conventions. - * @data: The argument to the function. Its actual type depends on - * the hook on which the function resides. It is up to the called - * function to get this right. - * - * Helper to invoke the invoke virtual method. - * - * Return value: The return of the plugin invocation. - **/ -void * -e_plugin_invoke(EPlugin *ep, const char *name, void *data) -{ - if (!ep->enabled) { - g_warning("Invoking method on disabled plugin, ignored"); - return NULL; - } - - return ((EPluginClass *)G_OBJECT_GET_CLASS(ep))->invoke(ep, name, data); -} - -/** - * e_plugin_enable: - * @ep: - * @state: - * - * Set the enable state of a plugin. - * - * THIS IS NOT FULLY IMPLEMENTED YET - **/ -void -e_plugin_enable(EPlugin *ep, int state) -{ - if ((ep->enabled == 0) == (state == 0)) - return; - - ((EPluginClass *)G_OBJECT_GET_CLASS(ep))->enable(ep, state); -} - -/** - * e_plugin_xml_prop: - * @node: An XML node. - * @id: The name of the property to retrieve. - * - * A static helper function to look up a property on an XML node, and - * ensure it is allocated in GLib system memory. If GLib isn't using - * the system malloc then it must copy the property value. - * - * Return value: The property, allocated in GLib memory, or NULL if no - * such property exists. - **/ -char * -e_plugin_xml_prop(xmlNodePtr node, const char *id) -{ - char *p = xmlGetProp(node, id); - - if (g_mem_is_system_malloc()) { - return p; - } else { - char * out = g_strdup(p); - - if (p) - xmlFree(p); - return out; - } -} - -/** - * e_plugin_xml_prop_domain: - * @node: An XML node. - * @id: The name of the property to retrieve. - * @domain: The translation domain for this string. - * - * A static helper function to look up a property on an XML node, and - * translate it based on @domain. - * - * Return value: The property, allocated in GLib memory, or NULL if no - * such property exists. - **/ -char * -e_plugin_xml_prop_domain(xmlNodePtr node, const char *id, const char *domain) -{ - char *p, *out; - - p = xmlGetProp(node, id); - if (p == NULL) - return NULL; - - out = g_strdup(dgettext(domain, p)); - xmlFree(p); - - return out; -} - -/** - * e_plugin_xml_int: - * @node: An XML node. - * @id: The name of the property to retrieve. - * @def: A default value if the property doesn't exist. Can be used - * to determine if the property isn't set. - * - * A static helper function to look up a property on an XML node as an - * integer. If the property doesn't exist, then @def is returned as a - * default value instead. - * - * Return value: The value if set, or @def if not. - **/ -int -e_plugin_xml_int(xmlNodePtr node, const char *id, int def) -{ - char *p = xmlGetProp(node, id); - - if (p) - return atoi(p); - else - return def; -} - -/** - * e_plugin_xml_content: - * @node: - * - * A static helper function to retrieve the entire textual content of - * an XML node, and ensure it is allocated in GLib system memory. If - * GLib isn't using the system malloc them it must copy the content. - * - * Return value: The node content, allocated in GLib memory. - **/ -char * -e_plugin_xml_content(xmlNodePtr node) -{ - char *p = xmlNodeGetContent(node); - - if (g_mem_is_system_malloc()) { - return p; - } else { - char * out = g_strdup(p); - - if (p) - xmlFree(p); - return out; - } -} - -/** - * e_plugin_xml_content_domain: - * @node: - * @domain: - * - * A static helper function to retrieve the entire textual content of - * an XML node, and ensure it is allocated in GLib system memory. If - * GLib isn't using the system malloc them it must copy the content. - * - * Return value: The node content, allocated in GLib memory. - **/ -char * -e_plugin_xml_content_domain(xmlNodePtr node, const char *domain) -{ - char *p, *out; - - p = xmlNodeGetContent(node); - if (p == NULL) - return NULL; - - out = g_strdup(dgettext(domain, p)); - xmlFree(p); - - return out; -} - -/* ********************************************************************** */ -static void *epl_parent_class; - -/* this looks weird, but it saves a lot of typing */ -#define epl ((EPluginLib *)ep) - -/* TODO: - We need some way to manage lifecycle. - We need some way to manage state. - - Maybe just the g module init method will do, or we could add - another which returns context. - - There is also the question of per-instance context, e.g. for config - pages. -*/ - -static int -epl_loadmodule(EPlugin *ep) -{ - if (epl->module == NULL) { - EPluginLibEnableFunc enable; - - if ((epl->module = g_module_open(epl->location, 0)) == NULL) { - g_warning("can't load plugin '%s'", g_module_error()); - return -1; - } - - if (g_module_symbol(epl->module, "e_plugin_lib_enable", (void *)&enable)) { - if (enable(epl, TRUE) != 0) { - ep->enabled = FALSE; - g_module_close(epl->module); - epl->module = NULL; - return -1; - } - } - } - - return 0; -} - -static void * -epl_invoke(EPlugin *ep, const char *name, void *data) -{ - EPluginLibFunc cb; - - if (!ep->enabled) { - g_warning("trying to invoke '%s' on disabled plugin '%s'", name, ep->id); - return NULL; - } - - if (epl_loadmodule(ep) != 0) - return NULL; - - if (!g_module_symbol(epl->module, name, (void *)&cb)) { - g_warning("Cannot resolve symbol '%s' in plugin '%s' (not exported?)", name, epl->location); - return NULL; - } - - return cb(epl, data); -} - -static int -epl_construct(EPlugin *ep, xmlNodePtr root) -{ - if (((EPluginClass *)epl_parent_class)->construct(ep, root) == -1) - return -1; - - epl->location = e_plugin_xml_prop(root, "location"); - - if (epl->location == NULL) { - g_warning("Library plugin '%s' has no location", ep->id); - return -1; - } - - /* If we're enabled, check for the load-on-startup property */ - if (ep->enabled) { - xmlChar *tmp; - - tmp = xmlGetProp(root, "load-on-startup"); - if (tmp) { - xmlFree(tmp); - if (epl_loadmodule(ep) != 0) - return -1; - } - } - - return 0; -} - -static void -epl_enable(EPlugin *ep, int state) -{ - EPluginLibEnableFunc enable; - - ((EPluginClass *)epl_parent_class)->enable(ep, state); - - /* if we're disabling and it isn't loaded, nothing to do */ - if (!state && epl->module == NULL) - return; - - /* this will noop if we're disabling since we tested it above */ - if (epl_loadmodule(ep) != 0) - return; - - if (g_module_symbol(epl->module, "e_plugin_lib_enable", (void *)&enable)) { - if (enable(epl, state) != 0) - return; - } -#if 0 - if (!state) { - g_module_close(epl->module); - epl->module = NULL; - } -#endif -} - -static void -epl_finalise(GObject *o) -{ - EPlugin *ep = (EPlugin *)o; - - g_free(epl->location); - - if (epl->module) - g_module_close(epl->module); - - ((GObjectClass *)epl_parent_class)->finalize(o); -} - -static void -epl_class_init(EPluginClass *klass) -{ - ((GObjectClass *)klass)->finalize = epl_finalise; - klass->construct = epl_construct; - klass->invoke = epl_invoke; - klass->enable = epl_enable; - klass->type = "shlib"; -} - -/** - * e_plugin_lib_get_type: - * - * Standard GObject function to retrieve the EPluginLib type. Use to - * register the type with the plugin system if you want to use shared - * library plugins. - * - * Return value: The EPluginLib type. - **/ -GType -e_plugin_lib_get_type(void) -{ - static GType type = 0; - - if (!type) { - static const GTypeInfo info = { - sizeof(EPluginLibClass), NULL, NULL, (GClassInitFunc) epl_class_init, NULL, NULL, - sizeof(EPluginLib), 0, (GInstanceInitFunc) NULL, - }; - - epl_parent_class = g_type_class_ref(e_plugin_get_type()); - type = g_type_register_static(e_plugin_get_type(), "EPluginLib", &info, 0); - } - - return type; -} - -/* ********************************************************************** */ - -static int -eph_construct(EPluginHook *eph, EPlugin *ep, xmlNodePtr root) -{ - eph->plugin = ep; - - return 0; -} - -static void -eph_enable(EPluginHook *eph, int state) -{ - /* NOOP */ -} - -static void -eph_finalise(GObject *o) -{ - ((GObjectClass *)eph_parent_class)->finalize((GObject *)o); -} - -static void -eph_class_init(EPluginHookClass *klass) -{ - ((GObjectClass *)klass)->finalize = eph_finalise; - klass->construct = eph_construct; - klass->enable = eph_enable; -} - -/** - * e_plugin_hook_get_type: - * - * Standard GObject function to retrieve the EPluginHook type. Since - * EPluginHook is an abstract class, this is only used to subclass it. - * - * Return value: The EPluginHook type. - **/ -GType -e_plugin_hook_get_type(void) -{ - static GType type = 0; - - if (!type) { - static const GTypeInfo info = { - sizeof(EPluginHookClass), NULL, NULL, (GClassInitFunc) eph_class_init, NULL, NULL, - sizeof(EPluginHook), 0, (GInstanceInitFunc) NULL, - }; - - eph_parent_class = g_type_class_ref(G_TYPE_OBJECT); - type = g_type_register_static(G_TYPE_OBJECT, "EPluginHook", &info, 0); - } - - return type; -} - -/** - * e_plugin_hook_enable: Set hook enabled state. - * @eph: - * @state: - * - * Set the enabled state of the plugin hook. This is called by the - * plugin code. - * - * THIS IS NOT FULY IMEPLEMENTED YET - **/ -void -e_plugin_hook_enable(EPluginHook *eph, int state) -{ - ((EPluginHookClass *)G_OBJECT_GET_CLASS(eph))->enable(eph, state); -} - -/** - * e_plugin_hook_register_type: - * @type: - * - * Register a new plugin hook type with the plugin system. Each type - * must subclass EPluginHook and must override the id member of the - * EPluginHookClass with a unique identification string. - **/ -void -e_plugin_hook_register_type(GType type) -{ - EPluginHookClass *klass, *oldklass; - GSList *l, *plugins; - char *class; - - if (eph_types == NULL) - eph_types = g_hash_table_new(g_str_hash, g_str_equal); - - klass = g_type_class_ref(type); - - oldklass = g_hash_table_lookup(eph_types, (void *)klass->id); - if (oldklass == klass) { - g_type_class_unref(klass); - return; - } else if (oldklass != NULL) { - g_warning("Trying to re-register hook type '%s'", klass->id); - return; - } - - phd(printf("register plugin hook type '%s'\n", klass->id)); - g_hash_table_insert(eph_types, (void *)klass->id, klass); - - /* if we've already loaded a plugin that needed this hook but it didn't exist, re-load it now */ - - if (ep_plugins_pending_hooks - && g_hash_table_lookup_extended(ep_plugins_pending_hooks, klass->id, (void **)&class, (void **)&plugins)) { - struct _plugin_doc *pdoc, *ndoc; - - g_hash_table_remove(ep_plugins_pending_hooks, class); - g_free(class); - for (l = plugins; l; l = g_slist_next(l)) { - EPlugin *ep = l->data; - - ep_load_pending(ep, klass); - } - g_slist_free(plugins); - - /* See if we can now garbage collect the xml definition since its been fully loaded */ - - /* This is all because libxml doesn't refcount! */ - - pdoc = (struct _plugin_doc *)ep_plugin_docs.head; - ndoc = pdoc->next; - while (ndoc) { - if (pdoc->doc) { - int cache = pdoc->plugins != NULL; - - for (l=pdoc->plugin_hooks;!cache && l;l=g_slist_next(l)) - cache |= (((EPlugin *)l->data)->hooks_pending != NULL); - - if (!cache) { - pd(printf("Gargabe collecting plugin description '%s'\n", pdoc->filename)); - e_dlist_remove((EDListNode *)pdoc); - xmlFreeDoc(pdoc->doc); - g_free(pdoc->filename); - g_free(pdoc); - } - } - - pdoc = ndoc; - ndoc = ndoc->next; - } - } -} - -/** - * e_plugin_hook_mask: - * @root: An XML node. - * @map: A zero-fill terminated array of EPluginHookTargeKeys used to - * map a string with a bit value. - * @prop: The property name. - * - * This is a static helper function which looks up a property @prop on - * the XML node @root, and then uses the @map table to convert it into - * a bitmask. The property value is a comma separated list of - * enumeration strings which are indexed into the @map table. - * - * Return value: A bitmask representing the inclusive-or of all of the - * integer values of the corresponding string id's stored in the @map. - **/ -guint32 -e_plugin_hook_mask(xmlNodePtr root, const struct _EPluginHookTargetKey *map, const char *prop) -{ - char *val, *p, *start, c; - guint32 mask = 0; - - val = xmlGetProp(root, prop); - if (val == NULL) - return 0; - - p = val; - do { - start = p; - while (*p && *p != ',') - p++; - c = *p; - *p = 0; - if (start != p) { - int i; - - for (i=0;map[i].key;i++) { - if (!strcmp(map[i].key, start)) { - mask |= map[i].value; - break; - } - } - } - *p++ = c; - } while (c); - - xmlFree(val); - - return mask; -} - -/** - * e_plugin_hook_id: - * @root: - * @map: - * @prop: - * - * This is a static helper function which looks up a property @prop on - * the XML node @root, and then uses the @map table to convert it into - * an integer. - * - * This is used as a helper wherever you need to represent an - * enumerated value in the XML. - * - * Return value: If the @prop value is in @map, then the corresponding - * integer value, if not, then ~0. - **/ -guint32 -e_plugin_hook_id(xmlNodePtr root, const struct _EPluginHookTargetKey *map, const char *prop) -{ - char *val; - int i; - - val = xmlGetProp(root, prop); - if (val == NULL) - return ~0; - - for (i=0;map[i].key;i++) { - if (!strcmp(map[i].key, val)) { - xmlFree(val); - return map[i].value; - } - } - - xmlFree(val); - - return ~0; -} - -/* ********************************************************************** */ -/* Plugin plugin */ - -static void *epth_parent_class; -#define epth ((EPluginTypeHook *)eph) - -static int -epth_load_plugin(void *d) -{ - EPluginHook *eph = d; - GType type; - - epth->idle = 0; - - type = GPOINTER_TO_UINT(e_plugin_invoke(eph->plugin, epth->get_type, eph->plugin)); - if (type != 0) - e_plugin_register_type(type); - - return FALSE; -} - -static int -epth_construct(EPluginHook *eph, EPlugin *ep, xmlNodePtr root) -{ - xmlNodePtr node; - - phd(printf("loading plugin hook\n")); - - if (((EPluginHookClass *)epth_parent_class)->construct(eph, ep, root) == -1) - return -1; - - node = root->children; - while (node) { - if (strcmp(node->name, "plugin-type") == 0) { - epth->get_type = e_plugin_xml_prop(node, "get-type"); - /* We need to run this in an idle handler, - * since at this point the parent EPlugin wont - * be fully initialised ... darn */ - if (epth->get_type) - epth->idle = g_idle_add(epth_load_plugin, epth); - else - g_warning("Plugin type plugin missing get-type callback"); - } - node = node->next; - } - - eph->plugin = ep; - - return 0; -} - -static void -epth_finalise(GObject *o) -{ - EPluginHook *eph = (EPluginHook *)o; - - if (epth->idle != 0) - g_source_remove(epth->idle); - - g_free(epth->get_type); - - ((GObjectClass *)eph_parent_class)->finalize((GObject *)o); -} - -static void -epth_class_init(EPluginHookClass *klass) -{ - ((GObjectClass *)klass)->finalize = epth_finalise; - klass->construct = epth_construct; - - klass->id = "org.gnome.evolution.plugin.type:1.0"; -} - -/** - * e_plugin_type_hook_get_type: - * - * Get the type for the plugin plugin hook. - * - * Return value: The type of the plugin type hook. - **/ -GType -e_plugin_type_hook_get_type(void) -{ - static GType type = 0; - - if (!type) { - static const GTypeInfo info = { - sizeof(EPluginTypeHookClass), NULL, NULL, (GClassInitFunc) epth_class_init, NULL, NULL, - sizeof(EPluginTypeHook), 0, (GInstanceInitFunc) NULL, - }; - - epth_parent_class = g_type_class_ref(e_plugin_hook_get_type()); - type = g_type_register_static(e_plugin_hook_get_type(), "EPluginTypeHook", &info, 0); - } - - return type; -} |