2 * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 2002-2015 the Claws Mail Team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 #include "claws-features.h"
32 #include <glib/gi18n.h>
49 const gchar *(*name) (void);
50 const gchar *(*desc) (void);
51 const gchar *(*version) (void);
52 const gchar *(*type) (void);
53 const gchar *(*licence) (void);
54 struct PluginFeature *(*provides) (void);
58 gboolean unloaded_hidden;
59 gboolean in_prefix_dir;
62 const gchar *plugin_feature_names[] =
68 N_("a privacy interface"),
74 /* The plugin must be at least under one of these licences and have
75 the corresponding token returned by the plugin_licence function.
77 const gchar const *plugin_licence_tokens[] = {
78 "LGPL2.1+", "LGPLv2.1+", "LGPL2.1", "LGPLv2.1",
79 "LGPL3+", "LGPLv3+", "LGPL3", "LGPLv3",
80 "GPL3+", "GPLv3+", "GPL3", "GPLv3",
82 "Apache2.0", "Apache 2.0", "Apache v2.0",
83 "2-clause BSD", "Simplified BSD", "FreeBSD",
84 "3-clause BSD", "New BSD", "Modified BSD",
88 /* Dual (or more) licences are allowed, must be separated by one of these.
90 #define IS_LICENCE_SEP(a) ((a) == ',' || (a) == ';' || (a) == '|' || (a) == '/' || (a) == '\0')
93 * List of all loaded plugins
95 GSList *plugins = NULL;
96 GSList *plugin_types = NULL;
99 * List of plugins unloaded for some fixable reason
101 static GSList *unloaded_plugins = NULL;
103 static gint list_find_by_string(gconstpointer data, gconstpointer str)
105 return strcmp((gchar *)data, (gchar *)str) ? TRUE : FALSE;
108 static gint list_find_by_plugin_filename(const Plugin *plugin, const gchar *filename)
110 /* FIXME: There is a problem in case of symlinks or when a
111 user tries to load a plugin with the same name from a
112 different directory. I think it would be better to compare
113 only the basename of the filename here (case-insensitive on
115 cm_return_val_if_fail(plugin, 1);
116 cm_return_val_if_fail(plugin->filename, 1);
117 cm_return_val_if_fail(filename, 1);
118 return strcmp(filename, plugin->filename);
121 static gboolean plugin_filename_is_standard_dir(const gchar *filename) {
122 return strncmp(filename, get_plugin_dir(), strlen(get_plugin_dir())) == 0;
125 static gchar * plugin_canonical_name(const Plugin *plugin)
127 if (plugin->in_prefix_dir == TRUE) {
128 if (plugin_filename_is_standard_dir(plugin->filename) == TRUE) {
129 gchar *plugin_name = g_path_get_basename(plugin->filename);
133 return g_strdup(plugin->filename);
136 void plugin_save_list(void)
138 gchar *rcpath, *block;
140 GSList *type_cur, *plugin_cur;
143 for (type_cur = plugin_types; type_cur != NULL; type_cur = g_slist_next(type_cur)) {
144 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
146 block = g_strconcat("PluginsWin32_", type_cur->data, NULL);
148 block = g_strconcat("Plugins_", type_cur->data, NULL);
150 if ((pfile = prefs_write_open(rcpath)) == NULL ||
151 (prefs_set_block_label(pfile, block) < 0)) {
152 g_warning("failed to write plugin list");
158 for (plugin_cur = plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
159 plugin = (Plugin *) plugin_cur->data;
161 if (plugin->unloaded_hidden)
164 if (!strcmp(plugin->type(), type_cur->data)) {
165 gchar * name = plugin_canonical_name(plugin);
166 int err = fprintf(pfile->fp, "%s\n", name);
172 for (plugin_cur = unloaded_plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
173 plugin = (Plugin *) plugin_cur->data;
175 if (plugin->unloaded_hidden)
178 if (!strcmp(plugin->type(), type_cur->data)) {
179 gchar * name = plugin_canonical_name(plugin);
180 int err = fprintf(pfile->fp, "%s\n", name);
186 if (fprintf(pfile->fp, "\n") < 0)
189 if (prefs_file_close(pfile) < 0)
190 g_warning("failed to write plugin list");
197 g_warning("failed to write plugin list");
198 if (prefs_file_close_revert(pfile) < 0)
199 g_warning("failed to revert plugin list");
205 static gboolean plugin_is_loaded(const gchar *filename)
207 return (g_slist_find_custom(plugins, filename,
208 (GCompareFunc)list_find_by_plugin_filename) != NULL);
211 static Plugin *plugin_get_by_filename(const gchar *filename)
213 GSList *cur = plugins;
214 for(; cur; cur = cur->next) {
215 Plugin *p = (Plugin *)cur->data;
216 if (!strcmp(p->filename, filename)) {
224 * Loads a plugin dependancies
226 * Plugin dependancies are, optionnaly, listed in a file in
227 * get_plugin_dir()/$pluginname.deps.
228 * \param filename The filename of the plugin for which we have to load deps
229 * \param error The location where an error string can be stored
230 * \return 0 on success, -1 otherwise
232 static gint plugin_load_deps(const gchar *filename, gchar **error)
235 gchar *deps_file = NULL;
240 tmp = g_strdup(filename);
241 if( (p = strrchr(tmp, '.')) )
243 deps_file = g_strconcat(tmp, ".deps", NULL);
246 fp = g_fopen(deps_file, "rb");
252 while (fgets(buf, sizeof(buf), fp) != NULL) {
253 Plugin *dep_plugin = NULL;
255 buf[strlen(buf)-1]='\0'; /* chop off \n */
256 path = g_strconcat(get_plugin_dir(), buf,
257 ".", G_MODULE_SUFFIX, NULL);
258 if ((dep_plugin = plugin_get_by_filename(path)) == NULL) {
259 debug_print("trying to load %s\n", path);
260 dep_plugin = plugin_load(path, error);
261 if (dep_plugin == NULL) {
266 dep_plugin->in_prefix_dir = TRUE;
269 if (!g_slist_find_custom(dep_plugin->rdeps,
270 (gpointer) filename, list_find_by_string)) {
271 debug_print("adding %s to %s rdeps\n",
273 dep_plugin->filename);
275 g_slist_append(dep_plugin->rdeps,
283 static void plugin_unload_rdeps(Plugin *plugin)
285 GSList *cur = plugin->rdeps;
286 debug_print("removing %s rdeps\n", plugin->filename);
288 gchar *file = (gchar *)cur->data;
289 Plugin *rdep_plugin = file?plugin_get_by_filename(file):NULL;
290 debug_print(" rdep %s: %p\n", file, rdep_plugin);
292 plugin_unload(rdep_plugin);
297 g_slist_free(plugin->rdeps);
298 plugin->rdeps = NULL;
301 static void plugin_remove_from_unloaded_list (const gchar *filename)
303 GSList *item = g_slist_find_custom(unloaded_plugins,
304 (gpointer) filename, (GCompareFunc)list_find_by_plugin_filename);
305 Plugin *unloaded_plugin = item ? ((Plugin *)item->data):NULL;
306 if (unloaded_plugin != NULL) {
307 debug_print("removing %s from unloaded list\n", unloaded_plugin->filename);
308 unloaded_plugins = g_slist_remove(unloaded_plugins, unloaded_plugin);
309 g_module_close(unloaded_plugin->module);
310 g_free(unloaded_plugin->filename);
311 g_free(unloaded_plugin->error);
312 g_free(unloaded_plugin);
316 static gchar *plugin_check_features(struct PluginFeature *features) {
318 GSList *cur = plugins;
320 if (features == NULL)
322 for(; cur; cur = cur->next) {
323 Plugin *p = (Plugin *)cur->data;
324 struct PluginFeature *cur_features = p->provides();
325 if (p->unloaded_hidden)
327 for (j = 0; cur_features[j].type != PLUGIN_NOTHING; j++) {
328 for (i = 0; features[i].type != PLUGIN_NOTHING; i++) {
329 if (cur_features[j].type == features[i].type &&
330 !strcmp(cur_features[j].subtype, features[i].subtype)) {
331 return g_strdup_printf(_(
332 "This plugin provides %s (%s), which is "
333 "already provided by the %s plugin."),
334 _(plugin_feature_names[features[i].type]),
335 _(features[i].subtype),
345 static gboolean plugin_licence_check(const gchar *licence) {
349 if (licence != NULL) {
350 len = strlen(licence);
353 g_warning("plugin licence check failed: empty licence");
356 while (plugin_licence_tokens[i] != NULL) {
357 gchar *found = g_strstr_len(licence, len, plugin_licence_tokens[i]);
359 gint tlen = strlen(plugin_licence_tokens[i]);
360 if (len != tlen) { /* not a single license */
361 if (((found == licence) && (!IS_LICENCE_SEP(licence[tlen])))
362 || (!IS_LICENCE_SEP(*(found - 1)))
363 || (!IS_LICENCE_SEP(*(found + tlen)))) {
364 debug_print("plugin licence check failed: invalid separator\n");
368 debug_print("plugin licence check passed: %s found\n", plugin_licence_tokens[i]);
373 debug_print("plugin licence check failed: %s is not a valid licence\n", licence);
377 static Plugin *plugin_load_in_default_dir(const gchar *filename, gchar **error)
379 Plugin *plugin = NULL;
380 gchar *filename_default_dir = NULL;
381 gchar *default_error = NULL;
382 gchar *plugin_name = g_path_get_basename(filename);
384 filename_default_dir = g_strconcat(get_plugin_dir(), plugin_name, NULL);
386 debug_print("trying to load %s in default plugin directory %s\n",
387 plugin_name, get_plugin_dir());
391 plugin = plugin_load(filename_default_dir, &default_error);
393 g_free(filename_default_dir);
398 plugin->in_prefix_dir = TRUE;
401 g_free(default_error);
410 * \param filename The filename of the plugin to load
411 * \param error The location where an error string can be stored
412 * \return the plugin on success, NULL otherwise
414 Plugin *plugin_load(const gchar *filename, gchar **error)
417 gint (*plugin_init) (gchar **error);
418 gpointer plugin_name, plugin_desc, plugin_version;
419 const gchar *(*plugin_type)(void);
420 const gchar *(*plugin_licence)(void);
421 struct PluginFeature *(*plugin_provides)(void);
423 START_TIMING((filename?filename:"NULL plugin"));
424 cm_return_val_if_fail(filename != NULL, NULL);
425 cm_return_val_if_fail(error != NULL, NULL);
427 /* check duplicate plugin path name */
428 if (plugin_is_loaded(filename)) {
429 plugin = plugin_get_by_filename(filename);
430 if (plugin->unloaded_hidden) {
434 *error = g_strdup(_("Plugin already loaded"));
439 plugin_remove_from_unloaded_list(filename);
441 if (plugin_load_deps(filename, error) < 0)
443 plugin = g_new0(Plugin, 1);
444 if (plugin == NULL) {
445 *error = g_strdup(_("Failed to allocate memory for Plugin"));
449 debug_print("trying to load `%s'\n", filename);
450 plugin->module = g_module_open(filename, 0);
451 if (plugin->module == NULL) {
452 *error = g_strdup(g_module_error());
454 if (!plugin_filename_is_standard_dir(filename))
455 return plugin_load_in_default_dir(filename, error);
459 plugin->in_prefix_dir = FALSE;
463 if (!g_module_symbol(plugin->module, "plugin_name", &plugin_name) ||
464 !g_module_symbol(plugin->module, "plugin_desc", &plugin_desc) ||
465 !g_module_symbol(plugin->module, "plugin_version", &plugin_version) ||
466 !g_module_symbol(plugin->module, "plugin_type", (gpointer)&plugin_type) ||
467 !g_module_symbol(plugin->module, "plugin_licence", (gpointer)&plugin_licence) ||
468 !g_module_symbol(plugin->module, "plugin_provides", (gpointer)&plugin_provides) ||
469 !g_module_symbol(plugin->module, "plugin_init", (gpointer)&plugin_init)) {
470 *error = g_strdup(g_module_error());
471 if (plugin->unloaded_hidden)
473 g_module_close(plugin->module);
478 if (plugin_licence_check(plugin_licence()) != TRUE) {
479 *error = g_strdup(_("This module is not licensed under a GPL v3 or later compatible license."));
480 if (plugin->unloaded_hidden)
482 g_module_close(plugin->module);
487 if (!strcmp(plugin_type(), "GTK")) {
488 *error = g_strdup(_("This module is for Claws Mail GTK1."));
489 if (plugin->unloaded_hidden)
491 g_module_close(plugin->module);
496 if ((*error = plugin_check_features(plugin_provides())) != NULL) {
497 if (plugin->unloaded_hidden)
499 g_module_close(plugin->module);
503 plugin->name = plugin_name;
504 plugin->desc = plugin_desc;
505 plugin->version = plugin_version;
506 plugin->type = plugin_type;
507 plugin->licence = plugin_licence;
508 plugin->provides = plugin_provides;
509 plugin->filename = g_strdup(filename);
510 plugin->error = NULL;
512 if ((ok = plugin_init(error)) < 0) {
514 plugin->error = g_strdup(*error);
515 unloaded_plugins = g_slist_append(unloaded_plugins, plugin);
519 if (!plugin->unloaded_hidden)
520 plugins = g_slist_append(plugins, plugin);
521 plugin->unloaded_hidden = FALSE;
523 debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
528 void plugin_unload(Plugin *plugin)
530 gboolean (*plugin_done) (void);
531 gboolean can_unload = TRUE;
533 plugin_unload_rdeps(plugin);
535 if (plugin->unloaded_hidden)
539 plugin_remove_from_unloaded_list(plugin->filename);
542 if (g_module_symbol(plugin->module, "plugin_done", (gpointer) &plugin_done)) {
543 can_unload = plugin_done();
548 if (!RUNNING_ON_VALGRIND) {
549 g_module_close(plugin->module);
552 g_module_close(plugin->module);
554 plugins = g_slist_remove(plugins, plugin);
555 g_free(plugin->filename);
558 plugin->unloaded_hidden = TRUE;
563 static void replace_old_plugin_name(gchar *plugin_name)
565 gchar *old_name_end = g_strconcat("_plugin.", G_MODULE_SUFFIX, NULL);
566 gchar *matches = strstr(plugin_name, old_name_end);
569 g_free(old_name_end);
571 } else if (plugin_name + strlen(plugin_name) != matches + strlen(matches)) {
572 g_free(old_name_end);
575 gchar *new_name_end = g_strconcat(".", G_MODULE_SUFFIX, NULL);
576 int offset = strlen(plugin_name) - strlen(old_name_end);
578 debug_print("Replacing old plugin name %s\n", plugin_name);
580 strncpy(plugin_name + offset, new_name_end, strlen(old_name_end) - 1);
581 debug_print(" to %s\n", plugin_name);
585 void plugin_load_all(const gchar *type)
590 gchar *error = NULL, *block;
592 plugin_types = g_slist_append(plugin_types, g_strdup(type));
594 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
596 block = g_strconcat("PluginsWin32_", type, NULL);
598 block = g_strconcat("Plugins_", type, NULL);
600 if ((pfile = prefs_read_open(rcpath)) == NULL ||
601 (prefs_set_block_label(pfile, block) < 0)) {
604 prefs_file_close(pfile);
609 while (fgets(buf, sizeof(buf), pfile->fp) != NULL) {
614 replace_old_plugin_name(buf);
616 if ((buf[0] != '\0') && (plugin_load(buf, &error) == NULL)) {
617 g_warning("plugin loading error: %s", error);
621 prefs_file_close(pfile);
626 void plugin_unload_all(const gchar *type)
630 list = g_slist_copy(plugins);
631 list = g_slist_reverse(list);
633 for(cur = list; cur != NULL; cur = g_slist_next(cur)) {
634 Plugin *plugin = (Plugin *) cur->data;
636 if (!strcmp(type, plugin->type()))
637 plugin_unload(plugin);
641 cur = g_slist_find_custom(plugin_types, (gpointer) type, list_find_by_string);
644 plugin_types = g_slist_remove(plugin_types, cur);
649 /* Load those plugins we always want to use. No error output; just
651 void plugin_load_standard_plugins (void)
653 static const char *names[] = {
664 gchar *error, *filename;
666 for (i=0; names[i]; i++) {
667 /* Simple hack to check whether the plugin has already
668 * been loaded but checking only for the basename. */
669 GSList *cur = plugins;
670 for(; cur; cur = cur->next) {
671 Plugin *p = (Plugin *)cur->data;
672 if (strstr(p->filename, names[i]))
675 if (!cur) { /* Not yet loaded. */
676 /* FIXME: get_plugin_dir () returns with a trailing
677 * (back)slash; this should be fixed so that we can use
678 * g_module_build_path here. */
680 filename = g_strconcat (get_plugin_dir(),
683 filename = g_strconcat (get_plugin_dir(),
684 names[i], ".", G_MODULE_SUFFIX, NULL);
687 plugin_load(filename, &error);
694 GSList *plugin_get_list(void)
697 GSList *cur = plugins;
698 for (; cur; cur = cur->next) {
699 Plugin *p = (Plugin *)cur->data;
700 if (!p->unloaded_hidden)
701 new = g_slist_prepend(new, p);
703 new = g_slist_reverse(new);
707 Plugin *plugin_get_loaded_by_name(const gchar *name)
709 Plugin *plugin = NULL;
711 new = plugin_get_list();
712 for (cur = new; cur; cur = g_slist_next(cur)) {
713 plugin = (Plugin *)cur->data;
714 if (!g_ascii_strcasecmp(plugin->name(), name))
723 GSList *plugin_get_unloaded_list(void)
725 return g_slist_copy(unloaded_plugins);
728 const gchar *plugin_get_name(Plugin *plugin)
730 return plugin->name();
733 const gchar *plugin_get_desc(Plugin *plugin)
735 return plugin->desc();
738 const gchar *plugin_get_version(Plugin *plugin)
740 return plugin->version();
743 const gchar *plugin_get_error(Plugin *plugin)
745 return plugin->error;
748 /* Generally called in plugin_init() function of each plugin. It check the
749 * minimal and compiled version of claws binary required by the plugin.
750 * If (@minimum_claws_version == 0 || @compiled_claws_version == 0), don't
751 * check the corresponding version.
753 * If an error occurs {
754 * If @error == NULL { don't allocate error string. }
755 * If @error != NULL { error string is allocated and must be freed after
758 * Returns: FALSE if an error occurs, TRUE if all is OK.
760 gint check_plugin_version(guint32 minimum_claws_version,
761 guint32 compiled_claws_version,
762 const gchar *plugin_name,
765 guint32 claws_version = claws_get_version();
767 if (compiled_claws_version != 0 && claws_version > compiled_claws_version) {
769 *error = (plugin_name && *plugin_name)
770 ? g_strdup_printf(_("Your version of Claws Mail is newer than the "
771 "version the '%s' plugin was built with."),
773 : g_strdup(_("Your version of Claws Mail is newer than the "
774 "version the plugin was built with."));
779 if (minimum_claws_version != 0 && claws_version < minimum_claws_version) {
781 *error = (plugin_name && *plugin_name)
782 ? g_strdup_printf(_("Your version of Claws Mail is too old for "
783 "the '%s' plugin."), plugin_name)
784 : g_strdup(_("Your version of Claws Mail is too old for the plugin."));