2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2012 Hiroyuki Yamamoto and 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/>.
23 #include "claws-features.h"
34 #include <glib/gi18n.h>
51 const gchar *(*name) (void);
52 const gchar *(*desc) (void);
53 const gchar *(*version) (void);
54 const gchar *(*type) (void);
55 const gchar *(*licence) (void);
56 struct PluginFeature *(*provides) (void);
60 gboolean unloaded_hidden;
61 gboolean in_prefix_dir;
64 const gchar *plugin_feature_names[] =
70 N_("a privacy interface"),
76 /* The plugin must be at least under one of these licences and have
77 the corresponding token returned by the plugin_licence function.
79 const gchar const *plugin_licence_tokens[] = {
80 "LGPL2.1+", "LGPLv2.1+", "LGPL2.1", "LGPLv2.1",
81 "LGPL3+", "LGPLv3+", "LGPL3", "LGPLv3",
82 "GPL3+", "GPLv3+", "GPL3", "GPLv3",
84 "Apache2.0", "Apache 2.0", "Apache v2.0",
85 "2-clause BSD", "Simplified BSD", "FreeBSD",
86 "3-clause BSD", "New BSD", "Modified BSD",
90 /* Dual (or more) licences are allowed, must be separated by one of these.
92 #define IS_LICENCE_SEP(a) ((a) == ',' || (a) == ';' || (a) == '|' || (a) == '/' || (a) == '\0')
95 * List of all loaded plugins
97 GSList *plugins = NULL;
98 GSList *plugin_types = NULL;
101 * List of plugins unloaded for some fixable reason
103 static GSList *unloaded_plugins = NULL;
105 static gint list_find_by_string(gconstpointer data, gconstpointer str)
107 return strcmp((gchar *)data, (gchar *)str) ? TRUE : FALSE;
110 static gint list_find_by_plugin_filename(const Plugin *plugin, const gchar *filename)
112 /* FIXME: There is a problem in case of symlinks or when a
113 user tries to load a plugin with the same name from a
114 different directory. I think it would be better to compare
115 only the basename of the filename here (case-insensitive on
117 cm_return_val_if_fail(plugin, 1);
118 cm_return_val_if_fail(plugin->filename, 1);
119 cm_return_val_if_fail(filename, 1);
120 return strcmp(filename, plugin->filename);
123 static gboolean plugin_filename_is_standard_dir(const gchar *filename) {
124 return strncmp(filename, get_plugin_dir(), strlen(get_plugin_dir())) == 0;
127 static gchar * plugin_canonical_name(const Plugin *plugin)
129 if (plugin->in_prefix_dir == TRUE) {
130 if (plugin_filename_is_standard_dir(plugin->filename) == TRUE) {
131 gchar *plugin_name = g_path_get_basename(plugin->filename);
135 return g_strdup(plugin->filename);
138 void plugin_save_list(void)
140 gchar *rcpath, *block;
142 GSList *type_cur, *plugin_cur;
145 for (type_cur = plugin_types; type_cur != NULL; type_cur = g_slist_next(type_cur)) {
146 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
148 block = g_strconcat("PluginsWin32_", type_cur->data, NULL);
150 block = g_strconcat("Plugins_", type_cur->data, NULL);
152 if ((pfile = prefs_write_open(rcpath)) == NULL ||
153 (prefs_set_block_label(pfile, block) < 0)) {
154 g_warning("failed to write plugin list");
160 for (plugin_cur = plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
161 plugin = (Plugin *) plugin_cur->data;
163 if (plugin->unloaded_hidden)
166 if (!strcmp(plugin->type(), type_cur->data)) {
167 gchar * name = plugin_canonical_name(plugin);
168 int err = fprintf(pfile->fp, "%s\n", name);
174 for (plugin_cur = unloaded_plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
175 plugin = (Plugin *) plugin_cur->data;
177 if (plugin->unloaded_hidden)
180 if (!strcmp(plugin->type(), type_cur->data)) {
181 gchar * name = plugin_canonical_name(plugin);
182 int err = fprintf(pfile->fp, "%s\n", name);
188 if (fprintf(pfile->fp, "\n") < 0)
191 if (prefs_file_close(pfile) < 0)
192 g_warning("failed to write plugin list");
199 g_warning("failed to write plugin list");
200 if (prefs_file_close_revert(pfile) < 0)
201 g_warning("failed to revert plugin list");
207 static gboolean plugin_is_loaded(const gchar *filename)
209 return (g_slist_find_custom(plugins, filename,
210 (GCompareFunc)list_find_by_plugin_filename) != NULL);
213 static Plugin *plugin_get_by_filename(const gchar *filename)
215 GSList *cur = plugins;
216 for(; cur; cur = cur->next) {
217 Plugin *p = (Plugin *)cur->data;
218 if (!strcmp(p->filename, filename)) {
226 * Loads a plugin dependancies
228 * Plugin dependancies are, optionnaly, listed in a file in
229 * get_plugin_dir()/$pluginname.deps.
230 * \param filename The filename of the plugin for which we have to load deps
231 * \param error The location where an error string can be stored
232 * \return 0 on success, -1 otherwise
234 static gint plugin_load_deps(const gchar *filename, gchar **error)
237 gchar *deps_file = NULL;
242 tmp = g_strdup(filename);
243 if( (p = strrchr(tmp, '.')) )
245 deps_file = g_strconcat(tmp, ".deps", NULL);
248 fp = g_fopen(deps_file, "rb");
254 while (fgets(buf, sizeof(buf), fp) != NULL) {
255 Plugin *dep_plugin = NULL;
257 buf[strlen(buf)-1]='\0'; /* chop off \n */
258 path = g_strconcat(get_plugin_dir(), buf,
259 ".", G_MODULE_SUFFIX, NULL);
260 if ((dep_plugin = plugin_get_by_filename(path)) == NULL) {
261 debug_print("trying to load %s\n", path);
262 dep_plugin = plugin_load(path, error);
263 if (dep_plugin == NULL) {
268 dep_plugin->in_prefix_dir = TRUE;
271 if (!g_slist_find_custom(dep_plugin->rdeps,
272 (gpointer) filename, list_find_by_string)) {
273 debug_print("adding %s to %s rdeps\n",
275 dep_plugin->filename);
277 g_slist_append(dep_plugin->rdeps,
285 static void plugin_unload_rdeps(Plugin *plugin)
287 GSList *cur = plugin->rdeps;
288 debug_print("removing %s rdeps\n", plugin->filename);
290 gchar *file = (gchar *)cur->data;
291 Plugin *rdep_plugin = file?plugin_get_by_filename(file):NULL;
292 debug_print(" rdep %s: %p\n", file, rdep_plugin);
294 plugin_unload(rdep_plugin);
299 g_slist_free(plugin->rdeps);
300 plugin->rdeps = NULL;
303 static void plugin_remove_from_unloaded_list (const gchar *filename)
305 GSList *item = g_slist_find_custom(unloaded_plugins,
306 (gpointer) filename, (GCompareFunc)list_find_by_plugin_filename);
307 Plugin *unloaded_plugin = item ? ((Plugin *)item->data):NULL;
308 if (unloaded_plugin != NULL) {
309 debug_print("removing %s from unloaded list\n", unloaded_plugin->filename);
310 unloaded_plugins = g_slist_remove(unloaded_plugins, unloaded_plugin);
311 g_module_close(unloaded_plugin->module);
312 g_free(unloaded_plugin->filename);
313 g_free(unloaded_plugin->error);
314 g_free(unloaded_plugin);
318 static gchar *plugin_check_features(struct PluginFeature *features) {
320 GSList *cur = plugins;
322 if (features == NULL)
324 for(; cur; cur = cur->next) {
325 Plugin *p = (Plugin *)cur->data;
326 struct PluginFeature *cur_features = p->provides();
327 if (p->unloaded_hidden)
329 for (j = 0; cur_features[j].type != PLUGIN_NOTHING; j++) {
330 for (i = 0; features[i].type != PLUGIN_NOTHING; i++) {
331 if (cur_features[j].type == features[i].type &&
332 !strcmp(cur_features[j].subtype, features[i].subtype)) {
333 return g_strdup_printf(_(
334 "This plugin provides %s (%s), which is "
335 "already provided by the %s plugin."),
336 _(plugin_feature_names[features[i].type]),
337 _(features[i].subtype),
347 static gboolean plugin_licence_check(const gchar *licence) {
351 if (licence != NULL) {
352 len = strlen(licence);
355 g_warning("plugin licence check failed: empty licence");
358 while (plugin_licence_tokens[i] != NULL) {
359 gchar *found = g_strstr_len(licence, len, plugin_licence_tokens[i]);
361 gint tlen = strlen(plugin_licence_tokens[i]);
362 if (len != tlen) { /* not a single license */
363 if (((found == licence) && (!IS_LICENCE_SEP(licence[tlen])))
364 || (!IS_LICENCE_SEP(*(found - 1)))
365 || (!IS_LICENCE_SEP(*(found + tlen)))) {
366 debug_print("plugin licence check failed: invalid separator\n");
370 debug_print("plugin licence check passed: %s found\n", plugin_licence_tokens[i]);
375 debug_print("plugin licence check failed: %s is not a valid licence\n", licence);
379 static Plugin *plugin_load_in_default_dir(const gchar *filename, gchar **error)
381 Plugin *plugin = NULL;
382 gchar *filename_default_dir = NULL;
383 gchar *default_error = NULL;
384 gchar *plugin_name = g_path_get_basename(filename);
386 filename_default_dir = g_strconcat(get_plugin_dir(), plugin_name, NULL);
388 debug_print("trying to load %s in default plugin directory %s\n",
389 plugin_name, get_plugin_dir());
393 plugin = plugin_load(filename_default_dir, &default_error);
395 g_free(filename_default_dir);
400 plugin->in_prefix_dir = TRUE;
403 g_free(default_error);
412 * \param filename The filename of the plugin to load
413 * \param error The location where an error string can be stored
414 * \return the plugin on success, NULL otherwise
416 Plugin *plugin_load(const gchar *filename, gchar **error)
419 gint (*plugin_init) (gchar **error);
420 gpointer plugin_name, plugin_desc, plugin_version;
421 const gchar *(*plugin_type)(void);
422 const gchar *(*plugin_licence)(void);
423 struct PluginFeature *(*plugin_provides)(void);
425 START_TIMING((filename?filename:"NULL plugin"));
426 cm_return_val_if_fail(filename != NULL, NULL);
427 cm_return_val_if_fail(error != NULL, NULL);
429 /* check duplicate plugin path name */
430 if (plugin_is_loaded(filename)) {
431 plugin = plugin_get_by_filename(filename);
432 if (plugin->unloaded_hidden) {
436 *error = g_strdup(_("Plugin already loaded"));
441 plugin_remove_from_unloaded_list(filename);
443 if (plugin_load_deps(filename, error) < 0)
445 plugin = g_new0(Plugin, 1);
446 if (plugin == NULL) {
447 *error = g_strdup(_("Failed to allocate memory for Plugin"));
451 debug_print("trying to load `%s'\n", filename);
452 plugin->module = g_module_open(filename, 0);
453 if (plugin->module == NULL) {
454 *error = g_strdup(g_module_error());
456 if (!plugin_filename_is_standard_dir(filename))
457 return plugin_load_in_default_dir(filename, error);
461 plugin->in_prefix_dir = FALSE;
465 if (!g_module_symbol(plugin->module, "plugin_name", &plugin_name) ||
466 !g_module_symbol(plugin->module, "plugin_desc", &plugin_desc) ||
467 !g_module_symbol(plugin->module, "plugin_version", &plugin_version) ||
468 !g_module_symbol(plugin->module, "plugin_type", (gpointer)&plugin_type) ||
469 !g_module_symbol(plugin->module, "plugin_licence", (gpointer)&plugin_licence) ||
470 !g_module_symbol(plugin->module, "plugin_provides", (gpointer)&plugin_provides) ||
471 !g_module_symbol(plugin->module, "plugin_init", (gpointer)&plugin_init)) {
472 *error = g_strdup(g_module_error());
473 if (plugin->unloaded_hidden)
475 g_module_close(plugin->module);
480 if (plugin_licence_check(plugin_licence()) != TRUE) {
481 *error = g_strdup(_("This module is not licensed under a GPL v3 or later compatible license."));
482 if (plugin->unloaded_hidden)
484 g_module_close(plugin->module);
489 if (!strcmp(plugin_type(), "GTK")) {
490 *error = g_strdup(_("This module is for Claws Mail GTK1."));
491 if (plugin->unloaded_hidden)
493 g_module_close(plugin->module);
498 if ((*error = plugin_check_features(plugin_provides())) != NULL) {
499 if (plugin->unloaded_hidden)
501 g_module_close(plugin->module);
505 plugin->name = plugin_name;
506 plugin->desc = plugin_desc;
507 plugin->version = plugin_version;
508 plugin->type = plugin_type;
509 plugin->licence = plugin_licence;
510 plugin->provides = plugin_provides;
511 plugin->filename = g_strdup(filename);
512 plugin->error = NULL;
514 if ((ok = plugin_init(error)) < 0) {
516 plugin->error = g_strdup(*error);
517 unloaded_plugins = g_slist_append(unloaded_plugins, plugin);
521 if (!plugin->unloaded_hidden)
522 plugins = g_slist_append(plugins, plugin);
523 plugin->unloaded_hidden = FALSE;
525 debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
530 void plugin_unload(Plugin *plugin)
532 gboolean (*plugin_done) (void);
533 gboolean can_unload = TRUE;
535 plugin_unload_rdeps(plugin);
537 if (plugin->unloaded_hidden)
541 plugin_remove_from_unloaded_list(plugin->filename);
544 if (g_module_symbol(plugin->module, "plugin_done", (gpointer) &plugin_done)) {
545 can_unload = plugin_done();
550 if (!RUNNING_ON_VALGRIND) {
551 g_module_close(plugin->module);
554 g_module_close(plugin->module);
556 plugins = g_slist_remove(plugins, plugin);
557 g_free(plugin->filename);
560 plugin->unloaded_hidden = TRUE;
565 static void replace_old_plugin_name(gchar *plugin_name)
567 gchar *old_name_end = g_strconcat("_plugin.", G_MODULE_SUFFIX, NULL);
568 gchar *matches = strstr(plugin_name, old_name_end);
571 g_free(old_name_end);
573 } else if (plugin_name + strlen(plugin_name) != matches + strlen(matches)) {
574 g_free(old_name_end);
577 gchar *new_name_end = g_strconcat(".", G_MODULE_SUFFIX, NULL);
578 int offset = strlen(plugin_name) - strlen(old_name_end);
580 debug_print("Replacing old plugin name %s\n", plugin_name);
582 strncpy(plugin_name + offset, new_name_end, strlen(old_name_end) - 1);
583 debug_print(" to %s\n", plugin_name);
587 void plugin_load_all(const gchar *type)
592 gchar *error = NULL, *block;
594 plugin_types = g_slist_append(plugin_types, g_strdup(type));
596 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
598 block = g_strconcat("PluginsWin32_", type, NULL);
600 block = g_strconcat("Plugins_", type, NULL);
602 if ((pfile = prefs_read_open(rcpath)) == NULL ||
603 (prefs_set_block_label(pfile, block) < 0)) {
606 prefs_file_close(pfile);
611 while (fgets(buf, sizeof(buf), pfile->fp) != NULL) {
616 replace_old_plugin_name(buf);
618 if ((buf[0] != '\0') && (plugin_load(buf, &error) == NULL)) {
619 g_warning("plugin loading error: %s", error);
623 prefs_file_close(pfile);
628 void plugin_unload_all(const gchar *type)
632 list = g_slist_copy(plugins);
633 list = g_slist_reverse(list);
635 for(cur = list; cur != NULL; cur = g_slist_next(cur)) {
636 Plugin *plugin = (Plugin *) cur->data;
638 if (!strcmp(type, plugin->type()))
639 plugin_unload(plugin);
643 cur = g_slist_find_custom(plugin_types, (gpointer) type, list_find_by_string);
646 plugin_types = g_slist_remove(plugin_types, cur);
651 /* Load those plugins we always want to use. No error output; just
653 void plugin_load_standard_plugins (void)
655 static const char *names[] = {
666 gchar *error, *filename;
668 for (i=0; names[i]; i++) {
669 /* Simple hack to check whether the plugin has already
670 * been loaded but checking only for the basename. */
671 GSList *cur = plugins;
672 for(; cur; cur = cur->next) {
673 Plugin *p = (Plugin *)cur->data;
674 if (strstr(p->filename, names[i]))
677 if (!cur) { /* Not yet loaded. */
678 /* FIXME: get_plugin_dir () returns with a trailing
679 * (back)slash; this should be fixed so that we can use
680 * g_module_build_path here. */
682 filename = g_strconcat (get_plugin_dir(),
685 filename = g_strconcat (get_plugin_dir(),
686 names[i], ".", G_MODULE_SUFFIX, NULL);
689 plugin_load(filename, &error);
696 GSList *plugin_get_list(void)
699 GSList *cur = plugins;
700 for (; cur; cur = cur->next) {
701 Plugin *p = (Plugin *)cur->data;
702 if (!p->unloaded_hidden)
703 new = g_slist_prepend(new, p);
705 new = g_slist_reverse(new);
709 Plugin *plugin_get_loaded_by_name(const gchar *name)
711 Plugin *plugin = NULL;
713 new = plugin_get_list();
714 for (cur = new; cur; cur = g_slist_next(cur)) {
715 plugin = (Plugin *)cur->data;
716 if (!g_ascii_strcasecmp(plugin->name(), name))
725 GSList *plugin_get_unloaded_list(void)
727 return g_slist_copy(unloaded_plugins);
730 const gchar *plugin_get_name(Plugin *plugin)
732 return plugin->name();
735 const gchar *plugin_get_desc(Plugin *plugin)
737 return plugin->desc();
740 const gchar *plugin_get_version(Plugin *plugin)
742 return plugin->version();
745 const gchar *plugin_get_error(Plugin *plugin)
747 return plugin->error;
750 /* Generally called in plugin_init() function of each plugin. It check the
751 * minimal and compiled version of claws binary required by the plugin.
752 * If (@minimum_claws_version == 0 || @compiled_claws_version == 0), don't
753 * check the corresponding version.
755 * If an error occurs {
756 * If @error == NULL { don't allocate error string. }
757 * If @error != NULL { error string is allocated and must be freed after
760 * Returns: FALSE if an error occurs, TRUE if all is OK.
762 gint check_plugin_version(guint32 minimum_claws_version,
763 guint32 compiled_claws_version,
764 const gchar *plugin_name,
767 guint32 claws_version = claws_get_version();
769 if (compiled_claws_version != 0 && claws_version > compiled_claws_version) {
771 *error = (plugin_name && *plugin_name)
772 ? g_strdup_printf(_("Your version of Claws Mail is newer than the "
773 "version the '%s' plugin was built with."),
775 : g_strdup(_("Your version of Claws Mail is newer than the "
776 "version the plugin was built with."));
781 if (minimum_claws_version != 0 && claws_version < minimum_claws_version) {
783 *error = (plugin_name && *plugin_name)
784 ? g_strdup_printf(_("Your version of Claws Mail is too old for "
785 "the '%s' plugin."), plugin_name)
786 : g_strdup(_("Your version of Claws Mail is too old for the plugin."));