/*
- * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
- * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Claws Mail Team
+ * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
+ * Copyright (C) 2002-2015 the Claws Mail 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
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation; either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* GNU General Public License for more details.
*
* 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#include "claws-features.h"
+#endif
+
#include <stdio.h>
+#ifdef HAVE_VALGRIND
+#include <valgrind.h>
+#endif
#include "defs.h"
#include <glib.h>
#include "plugin.h"
#include "prefs.h"
#include "claws.h"
+#include "timing.h"
struct _Plugin
{
const gchar *(*version) (void);
const gchar *(*type) (void);
const gchar *(*licence) (void);
+ void (*master_passphrase_change) (const gchar *oldp, const gchar *newp);
struct PluginFeature *(*provides) (void);
GSList *rdeps;
gchar *error;
+ gboolean unloaded_hidden;
+ gboolean in_prefix_dir;
};
const gchar *plugin_feature_names[] =
{ N_("Nothing"),
N_("a viewer"),
+ N_("a MIME parser"),
N_("folders"),
N_("filtering"),
N_("a privacy interface"),
N_("things"),
NULL };
+/* The plugin must be at least under one of these licences and have
+ the corresponding token returned by the plugin_licence function.
+ */
+const gchar const *plugin_licence_tokens[] = {
+ "LGPL2.1+", "LGPLv2.1+", "LGPL2.1", "LGPLv2.1",
+ "LGPL3+", "LGPLv3+", "LGPL3", "LGPLv3",
+ "GPL3+", "GPLv3+", "GPL3", "GPLv3",
+ "GPL2+", "GPLv2+",
+ "Apache2.0", "Apache 2.0", "Apache v2.0",
+ "2-clause BSD", "Simplified BSD", "FreeBSD",
+ "3-clause BSD", "New BSD", "Modified BSD",
+ NULL
+};
+
+/* Dual (or more) licences are allowed, must be separated by one of these.
+ */
+#define IS_LICENCE_SEP(a) ((a) == ',' || (a) == ';' || (a) == '|' || (a) == '/' || (a) == '\0')
+
/**
* List of all loaded plugins
*/
different directory. I think it would be better to compare
only the basename of the filename here (case-insensitive on
W32). */
- g_return_val_if_fail(plugin, 1);
- g_return_val_if_fail(plugin->filename, 1);
- g_return_val_if_fail(filename, 1);
+ cm_return_val_if_fail(plugin, 1);
+ cm_return_val_if_fail(plugin->filename, 1);
+ cm_return_val_if_fail(filename, 1);
return strcmp(filename, plugin->filename);
}
+static gboolean plugin_filename_is_standard_dir(const gchar *filename) {
+ return strncmp(filename, get_plugin_dir(), strlen(get_plugin_dir())) == 0;
+}
+
+static gchar * plugin_canonical_name(const Plugin *plugin)
+{
+ if (plugin->in_prefix_dir == TRUE) {
+ if (plugin_filename_is_standard_dir(plugin->filename) == TRUE) {
+ gchar *plugin_name = g_path_get_basename(plugin->filename);
+ return plugin_name;
+ }
+ }
+ return g_strdup(plugin->filename);
+}
+
void plugin_save_list(void)
{
gchar *rcpath, *block;
PrefFile *pfile;
GSList *type_cur, *plugin_cur;
Plugin *plugin;
-
+
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
#endif
if ((pfile = prefs_write_open(rcpath)) == NULL ||
(prefs_set_block_label(pfile, block) < 0)) {
- g_warning("failed to write plugin list\n");
+ g_warning("failed to write plugin list");
g_free(rcpath);
return;
}
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);
+ if (plugin->unloaded_hidden)
+ continue;
+
+ if (!strcmp(plugin->type(), type_cur->data)) {
+ gchar * name = plugin_canonical_name(plugin);
+ int err = fprintf(pfile->fp, "%s\n", name);
+ g_free(name);
+ if (err < 0)
+ goto revert;
+ }
}
for (plugin_cur = unloaded_plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
plugin = (Plugin *) plugin_cur->data;
+
+ if (plugin->unloaded_hidden)
+ continue;
- if (!strcmp(plugin->type(), type_cur->data))
- fprintf(pfile->fp, "%s\n", plugin->filename);
+ if (!strcmp(plugin->type(), type_cur->data)) {
+ gchar * name = plugin_canonical_name(plugin);
+ int err = fprintf(pfile->fp, "%s\n", name);
+ g_free(name);
+ if (err < 0)
+ goto revert;
+ }
}
- fprintf(pfile->fp, "\n");
+ if (fprintf(pfile->fp, "\n") < 0)
+ goto revert;
if (prefs_file_close(pfile) < 0)
- g_warning("failed to write plugin list\n");
+ g_warning("failed to write plugin list");
+
+ g_free(rcpath);
+
+ continue;
+
+revert:
+ g_warning("failed to write plugin list");
+ if (prefs_file_close_revert(pfile) < 0)
+ g_warning("failed to revert plugin list");
g_free(rcpath);
}
dep_plugin = plugin_load(path, error);
if (dep_plugin == NULL) {
g_free(path);
+ fclose(fp);
return -1;
}
+ dep_plugin->in_prefix_dir = TRUE;
}
g_free(path);
if (!g_slist_find_custom(dep_plugin->rdeps,
for(; cur; cur = cur->next) {
Plugin *p = (Plugin *)cur->data;
struct PluginFeature *cur_features = p->provides();
+ if (p->unloaded_hidden)
+ continue;
for (j = 0; cur_features[j].type != PLUGIN_NOTHING; j++) {
for (i = 0; features[i].type != PLUGIN_NOTHING; i++) {
if (cur_features[j].type == features[i].type &&
return NULL;
}
+
+static gboolean plugin_licence_check(const gchar *licence) {
+ gint i = 0;
+ gint len = 0;
+
+ if (licence != NULL) {
+ len = strlen(licence);
+ }
+ if (len == 0) {
+ g_warning("plugin licence check failed: empty licence");
+ return FALSE;
+ }
+ while (plugin_licence_tokens[i] != NULL) {
+ gchar *found = g_strstr_len(licence, len, plugin_licence_tokens[i]);
+ if (found != NULL) {
+ gint tlen = strlen(plugin_licence_tokens[i]);
+ if (len != tlen) { /* not a single license */
+ if (((found == licence) && (!IS_LICENCE_SEP(licence[tlen])))
+ || (!IS_LICENCE_SEP(*(found - 1)))
+ || (!IS_LICENCE_SEP(*(found + tlen)))) {
+ debug_print("plugin licence check failed: invalid separator\n");
+ return FALSE;
+ }
+ }
+ debug_print("plugin licence check passed: %s found\n", plugin_licence_tokens[i]);
+ return TRUE;
+ }
+ ++i;
+ }
+ debug_print("plugin licence check failed: %s is not a valid licence\n", licence);
+ return FALSE;
+}
+
+static Plugin *plugin_load_in_default_dir(const gchar *filename, gchar **error)
+{
+ Plugin *plugin = NULL;
+ gchar *filename_default_dir = NULL;
+ gchar *default_error = NULL;
+ gchar *plugin_name = g_path_get_basename(filename);
+
+ filename_default_dir = g_strconcat(get_plugin_dir(), plugin_name, NULL);
+
+ debug_print("trying to load %s in default plugin directory %s\n",
+ plugin_name, get_plugin_dir());
+
+ g_free(plugin_name);
+
+ plugin = plugin_load(filename_default_dir, &default_error);
+
+ g_free(filename_default_dir);
+
+ if (plugin) {
+ g_free(*error);
+ *error = NULL;
+ plugin->in_prefix_dir = TRUE;
+
+ } else {
+ g_free(default_error);
+ }
+
+ return plugin;
+}
+
/**
* Loads a plugin
*
struct PluginFeature *(*plugin_provides)(void);
gint ok;
-
- g_return_val_if_fail(filename != NULL, NULL);
- g_return_val_if_fail(error != NULL, NULL);
+ START_TIMING((filename?filename:"NULL plugin"));
+ cm_return_val_if_fail(filename != NULL, NULL);
+ cm_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;
+ plugin = plugin_get_by_filename(filename);
+ if (plugin->unloaded_hidden) {
+ /* reshow it */
+ goto init_plugin;
+ } else {
+ *error = g_strdup(_("Plugin already loaded"));
+ return NULL;
+ }
}
plugin_remove_from_unloaded_list(filename);
if (plugin->module == NULL) {
*error = g_strdup(g_module_error());
g_free(plugin);
- return NULL;
- }
-
+ if (!plugin_filename_is_standard_dir(filename))
+ return plugin_load_in_default_dir(filename, error);
+ else
+ return NULL;
+ } else {
+ plugin->in_prefix_dir = FALSE;
+ }
+
+init_plugin:
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_provides", (gpointer)&plugin_provides) ||
!g_module_symbol(plugin->module, "plugin_init", (gpointer)&plugin_init)) {
*error = g_strdup(g_module_error());
+ if (plugin->unloaded_hidden)
+ return NULL;
g_module_close(plugin->module);
g_free(plugin);
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."));
+
+ if (plugin_licence_check(plugin_licence()) != TRUE) {
+ *error = g_strdup(_("This module is not licensed under a GPL v3 or later compatible license."));
+ if (plugin->unloaded_hidden)
+ return NULL;
g_module_close(plugin->module);
g_free(plugin);
return NULL;
if (!strcmp(plugin_type(), "GTK")) {
*error = g_strdup(_("This module is for Claws Mail GTK1."));
+ if (plugin->unloaded_hidden)
+ return NULL;
g_module_close(plugin->module);
g_free(plugin);
return NULL;
}
if ((*error = plugin_check_features(plugin_provides())) != NULL) {
+ if (plugin->unloaded_hidden)
+ return NULL;
g_module_close(plugin->module);
g_free(plugin);
return NULL;
plugin->provides = plugin_provides;
plugin->filename = g_strdup(filename);
plugin->error = NULL;
+
if ((ok = plugin_init(error)) < 0) {
if (*error)
plugin->error = g_strdup(*error);
return NULL;
}
- plugins = g_slist_append(plugins, plugin);
+ if (!plugin->unloaded_hidden)
+ plugins = g_slist_append(plugins, plugin);
+ plugin->unloaded_hidden = FALSE;
debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
-
+ END_TIMING();
return plugin;
}
void plugin_unload(Plugin *plugin)
{
- void (*plugin_done) (void);
+ gboolean (*plugin_done) (void);
+ gboolean can_unload = TRUE;
plugin_unload_rdeps(plugin);
+ if (plugin->unloaded_hidden)
+ return;
+
if (plugin->error) {
plugin_remove_from_unloaded_list(plugin->filename);
return;
}
if (g_module_symbol(plugin->module, "plugin_done", (gpointer) &plugin_done)) {
- plugin_done();
+ can_unload = plugin_done();
+ }
+
+ if (can_unload) {
+#ifdef HAVE_VALGRIND
+ if (!RUNNING_ON_VALGRIND) {
+ g_module_close(plugin->module);
+ }
+#else
+ g_module_close(plugin->module);
+#endif
+ plugins = g_slist_remove(plugins, plugin);
+ g_free(plugin->filename);
+ g_free(plugin);
+ } else {
+ plugin->unloaded_hidden = TRUE;
}
- g_module_close(plugin->module);
- plugins = g_slist_remove(plugins, plugin);
- g_free(plugin->filename);
- g_free(plugin);
+}
+
+static void replace_old_plugin_name(gchar *plugin_name)
+{
+ gchar *old_name_end = g_strconcat("_plugin.", G_MODULE_SUFFIX, NULL);
+ gchar *matches = strstr(plugin_name, old_name_end);
+
+ if (!matches) {
+ g_free(old_name_end);
+ return;
+ } else if (plugin_name + strlen(plugin_name) != matches + strlen(matches)) {
+ g_free(old_name_end);
+ return;
+ } else {
+ gchar *new_name_end = g_strconcat(".", G_MODULE_SUFFIX, NULL);
+ int offset = strlen(plugin_name) - strlen(old_name_end);
+
+ debug_print("Replacing old plugin name %s\n", plugin_name);
+
+ strncpy(plugin_name + offset, new_name_end, strlen(old_name_end) - 1);
+ debug_print(" to %s\n", plugin_name);
+ }
}
void plugin_load_all(const gchar *type)
if ((pfile = prefs_read_open(rcpath)) == NULL ||
(prefs_set_block_label(pfile, block) < 0)) {
g_free(rcpath);
+ if (pfile)
+ prefs_file_close(pfile);
return;
}
g_free(block);
break;
g_strstrip(buf);
+ replace_old_plugin_name(buf);
+
if ((buf[0] != '\0') && (plugin_load(buf, &error) == NULL)) {
- g_warning("plugin loading error: %s\n", error);
+ g_warning("plugin loading error: %s", error);
g_free(error);
}
}
GSList *plugin_get_list(void)
{
- return g_slist_copy(plugins);
+ GSList *new = NULL;
+ GSList *cur = plugins;
+ for (; cur; cur = cur->next) {
+ Plugin *p = (Plugin *)cur->data;
+ if (!p->unloaded_hidden)
+ new = g_slist_prepend(new, p);
+ }
+ new = g_slist_reverse(new);
+ return new;
+}
+
+Plugin *plugin_get_loaded_by_name(const gchar *name)
+{
+ Plugin *plugin = NULL;
+ GSList *new, *cur;
+ new = plugin_get_list();
+ for (cur = new; cur; cur = g_slist_next(cur)) {
+ plugin = (Plugin *)cur->data;
+ if (!g_ascii_strcasecmp(plugin->name(), name))
+ break;
+ else
+ plugin = NULL;
+ }
+ g_slist_free(new);
+ return plugin;
}
GSList *plugin_get_unloaded_list(void)
projects / claws.git / blobdiff