/*
* Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2002 Hiroyuki Yamamoto and the Sylpheed-Claws Team
+ * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws Team
*
* 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
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#include <stdio.h>
+#include "defs.h"
#include <glib.h>
+#ifdef ENABLE_NLS
+#include <glib/gi18n.h>
+#else
+#define _(a) (a)
+#define N_(a) (a)
+#endif
#include <gmodule.h>
-#include "intl.h"
-#include "defs.h"
#include "utils.h"
#include "plugin.h"
#include "prefs.h"
{
gchar *filename;
GModule *module;
- gchar *(*name) ();
- gchar *(*desc) ();
+ const gchar *(*name) (void);
+ const gchar *(*desc) (void);
+ const gchar *(*version) (void);
+ const gchar *(*type) (void);
+ const gchar *(*licence) (void);
+ GSList *rdeps;
};
/**
* List of all loaded plugins
*/
GSList *plugins = NULL;
+GSList *plugin_types = NULL;
-void plugin_save_list()
+static gint list_find_by_string(gconstpointer data, gconstpointer str)
{
- gchar *rcpath;
+ return strcmp((gchar *)data, (gchar *)str) ? TRUE : FALSE;
+}
+
+static gint list_find_by_plugin_filename(const Plugin *plugin, const gchar *filename)
+{
+ g_return_val_if_fail(plugin, 1);
+ g_return_val_if_fail(plugin->filename, 1);
+ g_return_val_if_fail(filename, 1);
+ return strcmp(filename, plugin->filename);
+}
+
+void plugin_save_list(void)
+{
+ gchar *rcpath, *block;
PrefFile *pfile;
- GSList *cur;
+ GSList *type_cur, *plugin_cur;
Plugin *plugin;
- rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
- if ((pfile = prefs_write_open(rcpath)) == NULL ||
- (prefs_set_block_label(pfile, "Plugins") < 0)) {
- g_warning("failed to write plugin list\n");
- g_free(rcpath);
- return;
+ for (type_cur = plugin_types; type_cur != NULL; type_cur = g_slist_next(type_cur)) {
+ rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
+#ifdef G_OS_WIN32
+ block = g_strconcat("PluginsWin32_", type_cur->data, NULL);
+#else
+ block = g_strconcat("Plugins_", type_cur->data, NULL);
+#endif
+ if ((pfile = prefs_write_open(rcpath)) == NULL ||
+ (prefs_set_block_label(pfile, block) < 0)) {
+ g_warning("failed to write plugin list\n");
+ g_free(rcpath);
+ return;
+ }
+ g_free(block);
+
+ for (plugin_cur = plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
+ plugin = (Plugin *) plugin_cur->data;
+
+ if (!strcmp(plugin->type(), type_cur->data))
+ fprintf(pfile->fp, "%s\n", plugin->filename);
+ }
+ fprintf(pfile->fp, "\n");
+
+ if (prefs_file_close(pfile) < 0)
+ g_warning("failed to write plugin list\n");
+
+ g_free(rcpath);
}
+}
- for (cur = plugins; cur != NULL; cur = g_slist_next(cur)) {
- plugin = (Plugin *)cur->data;
-
- fprintf(pfile->fp, "%s\n", plugin->filename);
+static gboolean plugin_is_loaded(const gchar *filename)
+{
+ return (g_slist_find_custom(plugins, filename,
+ (GCompareFunc)list_find_by_plugin_filename) != NULL);
+}
+
+static Plugin *plugin_get_by_filename(const gchar *filename)
+{
+ GSList *cur = plugins;
+ for(; cur; cur = cur->next) {
+ Plugin *p = (Plugin *)cur->data;
+ if (!strcmp(p->filename, filename)) {
+ return p;
+ }
}
- fprintf(pfile->fp, "\n");
+ return NULL;
+}
- if (prefs_file_close(pfile) < 0)
- g_warning("failed to write plugin list\n");
+/**
+ * Loads a plugin dependancies
+ *
+ * Plugin dependancies are, optionnaly, listed in a file in
+ * get_plugin_dir()/$pluginname.deps.
+ * \param filename The filename of the plugin for which we have to load deps
+ * \param error The location where an error string can be stored
+ * \return 0 on success, -1 otherwise
+ */
+static gint plugin_load_deps(const gchar *filename, gchar **error)
+{
+ gchar *tmp;
+ gchar *deps_file = NULL;
+ FILE *fp = NULL;
+ gchar buf[BUFFSIZE];
- g_free(rcpath);
+ tmp = g_strdup(filename);
+ *strrchr(tmp, '.') = '\0';
+ deps_file = g_strconcat(tmp, ".deps", NULL);
+ g_free(tmp);
+
+ fp = g_fopen(deps_file, "rb");
+ g_free(deps_file);
+
+ if (!fp)
+ return 0;
+
+ while (fgets(buf, sizeof(buf), fp) != NULL) {
+ Plugin *dep_plugin = NULL;
+ gchar *path = NULL;
+ buf[strlen(buf)-1]='\0'; /* chop off \n */
+ path = g_strconcat(get_plugin_dir(), buf,
+ ".", G_MODULE_SUFFIX, NULL);
+ if ((dep_plugin = plugin_get_by_filename(path)) == NULL) {
+ debug_print("trying to load %s\n", path);
+ dep_plugin = plugin_load(path, error);
+ if (dep_plugin == NULL) {
+ g_free(path);
+ return -1;
+ }
+ }
+ g_free(path);
+ if (!g_slist_find_custom(dep_plugin->rdeps,
+ (gpointer) filename, list_find_by_string)) {
+ debug_print("adding %s to %s rdeps\n",
+ filename,
+ dep_plugin->filename);
+ dep_plugin->rdeps =
+ g_slist_append(dep_plugin->rdeps,
+ g_strdup(filename));
+ }
+ }
+ fclose(fp);
+ return 0;
}
+static void plugin_unload_rdeps(Plugin *plugin)
+{
+ GSList *cur = plugin->rdeps;
+ debug_print("removing %s rdeps\n", plugin->filename);
+ while (cur) {
+ gchar *file = (gchar *)cur->data;
+ Plugin *rdep_plugin = file?plugin_get_by_filename(file):NULL;
+ debug_print(" rdep %s: %p\n", file, rdep_plugin);
+ if (rdep_plugin) {
+ plugin_unload(rdep_plugin);
+ }
+ g_free(file);
+ cur = cur->next;
+ }
+ g_slist_free(plugin->rdeps);
+ plugin->rdeps = NULL;
+}
/**
* Loads a plugin
*
* \param filename The filename of the plugin to load
* \param error The location where an error string can be stored
- * \return 0 on success, -1 otherwise
+ * \return the plugin on success, NULL otherwise
*/
-gint plugin_load(const gchar *filename, gchar **error)
+Plugin *plugin_load(const gchar *filename, gchar **error)
{
Plugin *plugin;
gint (*plugin_init) (gchar **error);
- gchar *plugin_name, *plugin_desc;
+ gpointer plugin_name, plugin_desc, plugin_version;
+ const gchar *(*plugin_type)(void);
+ const gchar *(*plugin_licence)(void);
gint ok;
- g_return_val_if_fail(filename != NULL, -1);
- g_return_val_if_fail(error != NULL, -1);
+ g_return_val_if_fail(filename != NULL, NULL);
+ g_return_val_if_fail(error != NULL, NULL);
+
+ /* check duplicate plugin path name */
+ if (plugin_is_loaded(filename)) {
+ *error = g_strdup(_("Plugin already loaded"));
+ return NULL;
+ }
+ if (plugin_load_deps(filename, error) < 0)
+ return NULL;
plugin = g_new0(Plugin, 1);
if (plugin == NULL) {
*error = g_strdup(_("Failed to allocate memory for Plugin"));
- return -1;
+ return NULL;
}
+ debug_print("trying to load `%s'\n", filename);
plugin->module = g_module_open(filename, 0);
if (plugin->module == NULL) {
*error = g_strdup(g_module_error());
g_free(plugin);
- return -1;
+ return NULL;
}
- if (!g_module_symbol(plugin->module, "plugin_name", (gpointer *)&plugin_name) ||
- !g_module_symbol(plugin->module, "plugin_desc", (gpointer *)&plugin_desc) ||
- !g_module_symbol(plugin->module, "plugin_init", (gpointer *)&plugin_init)) {
+ if (!g_module_symbol(plugin->module, "plugin_name", &plugin_name) ||
+ !g_module_symbol(plugin->module, "plugin_desc", &plugin_desc) ||
+ !g_module_symbol(plugin->module, "plugin_version", &plugin_version) ||
+ !g_module_symbol(plugin->module, "plugin_type", (gpointer)&plugin_type) ||
+ !g_module_symbol(plugin->module, "plugin_licence", (gpointer)&plugin_licence) ||
+ !g_module_symbol(plugin->module, "plugin_init", (gpointer)&plugin_init)) {
*error = g_strdup(g_module_error());
g_module_close(plugin->module);
g_free(plugin);
- return -1;
+ return NULL;
+ }
+
+ if (strcmp(plugin_licence(), "GPL")
+ && strncmp(plugin_licence(), "GPL-compatible", strlen("GPL-compatible"))) {
+ *error = g_strdup(_("This module is not licenced under a GPL compatible licence."));
+ g_module_close(plugin->module);
+ g_free(plugin);
+ return NULL;
+ }
+
+ if (!strcmp(plugin_type(), "GTK")) {
+ *error = g_strdup(_("This module is for Sylpheed-Claws GTK1."));
+ g_module_close(plugin->module);
+ g_free(plugin);
+ return NULL;
}
if ((ok = plugin_init(error)) < 0) {
g_module_close(plugin->module);
g_free(plugin);
- return ok;
+ return NULL;
}
plugin->name = plugin_name;
plugin->desc = plugin_desc;
+ plugin->version = plugin_version;
+ plugin->type = plugin_type;
+ plugin->licence = plugin_licence;
plugin->filename = g_strdup(filename);
plugins = g_slist_append(plugins, plugin);
debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
- return 0;
+ return plugin;
}
void plugin_unload(Plugin *plugin)
{
- void (*plugin_done) ();
+ void (*plugin_done) (void);
+
+ plugin_unload_rdeps(plugin);
- if (g_module_symbol(plugin->module, "plugin_done", (gpointer *)&plugin_done)) {
+ if (g_module_symbol(plugin->module, "plugin_done", (gpointer) &plugin_done)) {
plugin_done();
}
g_module_close(plugin->module);
plugins = g_slist_remove(plugins, plugin);
+ g_free(plugin->filename);
g_free(plugin);
}
-void plugin_load_all()
+void plugin_load_all(const gchar *type)
{
gchar *rcpath;
gchar buf[BUFFSIZE];
PrefFile *pfile;
- gchar *error;
+ gchar *error, *block;
+
+ plugin_types = g_slist_append(plugin_types, g_strdup(type));
rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
+#ifdef G_OS_WIN32
+ block = g_strconcat("PluginsWin32_", type, NULL);
+#else
+ block = g_strconcat("Plugins_", type, NULL);
+#endif
if ((pfile = prefs_read_open(rcpath)) == NULL ||
- (prefs_set_block_label(pfile, "Plugins") < 0)) {
+ (prefs_set_block_label(pfile, block) < 0)) {
g_free(rcpath);
return;
}
+ g_free(block);
while (fgets(buf, sizeof(buf), pfile->fp) != NULL) {
if (buf[0] == '[')
break;
g_strstrip(buf);
- if ((buf[0] != '\0') && (plugin_load(buf, &error) < 0)) {
+ if ((buf[0] != '\0') && (plugin_load(buf, &error) == NULL)) {
g_warning("plugin loading error: %s\n", error);
g_free(error);
}
g_free(rcpath);
}
-void plugin_unload_all()
+void plugin_unload_all(const gchar *type)
{
GSList *list, *cur;
for(cur = list; cur != NULL; cur = g_slist_next(cur)) {
Plugin *plugin = (Plugin *) cur->data;
- plugin_unload(plugin);
+ if (!strcmp(type, plugin->type()))
+ plugin_unload(plugin);
}
g_slist_free(list);
+
+ cur = g_slist_find_custom(plugin_types, (gpointer) type, list_find_by_string);
+ if (cur) {
+ g_free(cur->data);
+ g_slist_remove(plugin_types, cur);
+ }
}
-GSList *plugin_get_list()
+GSList *plugin_get_list(void)
{
return g_slist_copy(plugins);
}
{
return plugin->desc();
}
+
+const gchar *plugin_get_version(Plugin *plugin)
+{
+ return plugin->version();
+}
projects / claws.git / blobdiff