2 * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
3 * Copyright (C) 1999-2007 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/>.
25 #include <glib/gi18n.h>
45 const gchar *(*name) (void);
46 const gchar *(*desc) (void);
47 const gchar *(*version) (void);
48 const gchar *(*type) (void);
49 const gchar *(*licence) (void);
50 struct PluginFeature *(*provides) (void);
54 gboolean unloaded_hidden;
57 const gchar *plugin_feature_names[] =
63 N_("a privacy interface"),
70 * List of all loaded plugins
72 GSList *plugins = NULL;
73 GSList *plugin_types = NULL;
76 * List of plugins unloaded for some fixable reason
78 static GSList *unloaded_plugins = NULL;
80 static gint list_find_by_string(gconstpointer data, gconstpointer str)
82 return strcmp((gchar *)data, (gchar *)str) ? TRUE : FALSE;
85 static gint list_find_by_plugin_filename(const Plugin *plugin, const gchar *filename)
87 /* FIXME: There is a problem in case of symlinks or when a
88 user tries to load a plugin with the same name from a
89 different directory. I think it would be better to compare
90 only the basename of the filename here (case-insensitive on
92 g_return_val_if_fail(plugin, 1);
93 g_return_val_if_fail(plugin->filename, 1);
94 g_return_val_if_fail(filename, 1);
95 return strcmp(filename, plugin->filename);
98 void plugin_save_list(void)
100 gchar *rcpath, *block;
102 GSList *type_cur, *plugin_cur;
105 for (type_cur = plugin_types; type_cur != NULL; type_cur = g_slist_next(type_cur)) {
106 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
108 block = g_strconcat("PluginsWin32_", type_cur->data, NULL);
110 block = g_strconcat("Plugins_", type_cur->data, NULL);
112 if ((pfile = prefs_write_open(rcpath)) == NULL ||
113 (prefs_set_block_label(pfile, block) < 0)) {
114 g_warning("failed to write plugin list\n");
120 for (plugin_cur = plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
121 plugin = (Plugin *) plugin_cur->data;
123 if (plugin->unloaded_hidden)
126 if (!strcmp(plugin->type(), type_cur->data))
127 if (fprintf(pfile->fp, "%s\n", plugin->filename) < 0)
130 for (plugin_cur = unloaded_plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
131 plugin = (Plugin *) plugin_cur->data;
133 if (plugin->unloaded_hidden)
136 if (!strcmp(plugin->type(), type_cur->data))
137 if (fprintf(pfile->fp, "%s\n", plugin->filename) < 0)
140 if (fprintf(pfile->fp, "\n") < 0)
143 if (prefs_file_close(pfile) < 0)
144 g_warning("failed to write plugin list\n");
151 g_warning("failed to write plugin list\n");
152 if (prefs_file_close_revert(pfile) < 0)
153 g_warning("failed to revert plugin list\n");
159 static gboolean plugin_is_loaded(const gchar *filename)
161 return (g_slist_find_custom(plugins, filename,
162 (GCompareFunc)list_find_by_plugin_filename) != NULL);
165 static Plugin *plugin_get_by_filename(const gchar *filename)
167 GSList *cur = plugins;
168 for(; cur; cur = cur->next) {
169 Plugin *p = (Plugin *)cur->data;
170 if (!strcmp(p->filename, filename)) {
178 * Loads a plugin dependancies
180 * Plugin dependancies are, optionnaly, listed in a file in
181 * get_plugin_dir()/$pluginname.deps.
182 * \param filename The filename of the plugin for which we have to load deps
183 * \param error The location where an error string can be stored
184 * \return 0 on success, -1 otherwise
186 static gint plugin_load_deps(const gchar *filename, gchar **error)
189 gchar *deps_file = NULL;
194 tmp = g_strdup(filename);
195 if( (p = strrchr(tmp, '.')) )
197 deps_file = g_strconcat(tmp, ".deps", NULL);
200 fp = g_fopen(deps_file, "rb");
206 while (fgets(buf, sizeof(buf), fp) != NULL) {
207 Plugin *dep_plugin = NULL;
209 buf[strlen(buf)-1]='\0'; /* chop off \n */
210 path = g_strconcat(get_plugin_dir(), buf,
211 ".", G_MODULE_SUFFIX, NULL);
212 if ((dep_plugin = plugin_get_by_filename(path)) == NULL) {
213 debug_print("trying to load %s\n", path);
214 dep_plugin = plugin_load(path, error);
215 if (dep_plugin == NULL) {
222 if (!g_slist_find_custom(dep_plugin->rdeps,
223 (gpointer) filename, list_find_by_string)) {
224 debug_print("adding %s to %s rdeps\n",
226 dep_plugin->filename);
228 g_slist_append(dep_plugin->rdeps,
236 static void plugin_unload_rdeps(Plugin *plugin)
238 GSList *cur = plugin->rdeps;
239 debug_print("removing %s rdeps\n", plugin->filename);
241 gchar *file = (gchar *)cur->data;
242 Plugin *rdep_plugin = file?plugin_get_by_filename(file):NULL;
243 debug_print(" rdep %s: %p\n", file, rdep_plugin);
245 plugin_unload(rdep_plugin);
250 g_slist_free(plugin->rdeps);
251 plugin->rdeps = NULL;
254 static void plugin_remove_from_unloaded_list (const gchar *filename)
256 GSList *item = g_slist_find_custom(unloaded_plugins,
257 (gpointer) filename, (GCompareFunc)list_find_by_plugin_filename);
258 Plugin *unloaded_plugin = item ? ((Plugin *)item->data):NULL;
259 if (unloaded_plugin != NULL) {
260 debug_print("removing %s from unloaded list\n", unloaded_plugin->filename);
261 unloaded_plugins = g_slist_remove(unloaded_plugins, unloaded_plugin);
262 g_module_close(unloaded_plugin->module);
263 g_free(unloaded_plugin->filename);
264 g_free(unloaded_plugin->error);
265 g_free(unloaded_plugin);
269 static gchar *plugin_check_features(struct PluginFeature *features) {
271 GSList *cur = plugins;
273 if (features == NULL)
275 for(; cur; cur = cur->next) {
276 Plugin *p = (Plugin *)cur->data;
277 struct PluginFeature *cur_features = p->provides();
278 if (p->unloaded_hidden)
280 for (j = 0; cur_features[j].type != PLUGIN_NOTHING; j++) {
281 for (i = 0; features[i].type != PLUGIN_NOTHING; i++) {
282 if (cur_features[j].type == features[i].type &&
283 !strcmp(cur_features[j].subtype, features[i].subtype)) {
284 return g_strdup_printf(_(
285 "This plugin provides %s (%s), which is "
286 "already provided by the %s plugin."),
287 _(plugin_feature_names[features[i].type]),
288 _(features[i].subtype),
300 * \param filename The filename of the plugin to load
301 * \param error The location where an error string can be stored
302 * \return the plugin on success, NULL otherwise
304 Plugin *plugin_load(const gchar *filename, gchar **error)
307 gint (*plugin_init) (gchar **error);
308 gpointer plugin_name, plugin_desc, plugin_version;
309 const gchar *(*plugin_type)(void);
310 const gchar *(*plugin_licence)(void);
311 struct PluginFeature *(*plugin_provides)(void);
313 START_TIMING((filename?filename:"NULL plugin"));
314 g_return_val_if_fail(filename != NULL, NULL);
315 g_return_val_if_fail(error != NULL, NULL);
317 /* check duplicate plugin path name */
318 if (plugin_is_loaded(filename)) {
319 plugin = plugin_get_by_filename(filename);
320 if (plugin->unloaded_hidden) {
324 *error = g_strdup(_("Plugin already loaded"));
329 plugin_remove_from_unloaded_list(filename);
331 if (plugin_load_deps(filename, error) < 0)
333 plugin = g_new0(Plugin, 1);
334 if (plugin == NULL) {
335 *error = g_strdup(_("Failed to allocate memory for Plugin"));
339 debug_print("trying to load `%s'\n", filename);
340 plugin->module = g_module_open(filename, 0);
341 if (plugin->module == NULL) {
342 *error = g_strdup(g_module_error());
348 if (!g_module_symbol(plugin->module, "plugin_name", &plugin_name) ||
349 !g_module_symbol(plugin->module, "plugin_desc", &plugin_desc) ||
350 !g_module_symbol(plugin->module, "plugin_version", &plugin_version) ||
351 !g_module_symbol(plugin->module, "plugin_type", (gpointer)&plugin_type) ||
352 !g_module_symbol(plugin->module, "plugin_licence", (gpointer)&plugin_licence) ||
353 !g_module_symbol(plugin->module, "plugin_provides", (gpointer)&plugin_provides) ||
354 !g_module_symbol(plugin->module, "plugin_init", (gpointer)&plugin_init)) {
355 *error = g_strdup(g_module_error());
356 if (plugin->unloaded_hidden)
358 g_module_close(plugin->module);
363 if (strcmp(plugin_licence(), "GPL2+") && strncmp(plugin_licence(), "GPL3", strlen("GPL3"))
364 && strncmp(plugin_licence(), "GPL2+-compatible", strlen("GPL2+-compatible"))) {
365 *error = g_strdup(_("This module is not licensed under a GPL v2 or later compatible license."));
366 if (plugin->unloaded_hidden)
368 g_module_close(plugin->module);
373 if (!strcmp(plugin_type(), "GTK")) {
374 *error = g_strdup(_("This module is for Claws Mail GTK1."));
375 if (plugin->unloaded_hidden)
377 g_module_close(plugin->module);
382 if ((*error = plugin_check_features(plugin_provides())) != NULL) {
383 if (plugin->unloaded_hidden)
385 g_module_close(plugin->module);
389 plugin->name = plugin_name;
390 plugin->desc = plugin_desc;
391 plugin->version = plugin_version;
392 plugin->type = plugin_type;
393 plugin->licence = plugin_licence;
394 plugin->provides = plugin_provides;
395 plugin->filename = g_strdup(filename);
396 plugin->error = NULL;
398 if ((ok = plugin_init(error)) < 0) {
400 plugin->error = g_strdup(*error);
401 unloaded_plugins = g_slist_append(unloaded_plugins, plugin);
405 if (!plugin->unloaded_hidden)
406 plugins = g_slist_append(plugins, plugin);
407 plugin->unloaded_hidden = FALSE;
409 debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
414 void plugin_unload(Plugin *plugin)
416 gboolean (*plugin_done) (void);
417 gboolean can_unload = TRUE;
419 plugin_unload_rdeps(plugin);
421 if (plugin->unloaded_hidden)
425 plugin_remove_from_unloaded_list(plugin->filename);
428 if (g_module_symbol(plugin->module, "plugin_done", (gpointer) &plugin_done)) {
429 can_unload = plugin_done();
434 if (!RUNNING_ON_VALGRIND) {
435 g_module_close(plugin->module);
438 g_module_close(plugin->module);
440 plugins = g_slist_remove(plugins, plugin);
441 g_free(plugin->filename);
444 plugin->unloaded_hidden = TRUE;
449 void plugin_load_all(const gchar *type)
454 gchar *error = NULL, *block;
456 plugin_types = g_slist_append(plugin_types, g_strdup(type));
458 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
460 block = g_strconcat("PluginsWin32_", type, NULL);
462 block = g_strconcat("Plugins_", type, NULL);
464 if ((pfile = prefs_read_open(rcpath)) == NULL ||
465 (prefs_set_block_label(pfile, block) < 0)) {
468 prefs_file_close(pfile);
473 while (fgets(buf, sizeof(buf), pfile->fp) != NULL) {
478 if ((buf[0] != '\0') && (plugin_load(buf, &error) == NULL)) {
479 g_warning("plugin loading error: %s\n", error);
483 prefs_file_close(pfile);
488 void plugin_unload_all(const gchar *type)
492 list = g_slist_copy(plugins);
493 list = g_slist_reverse(list);
495 for(cur = list; cur != NULL; cur = g_slist_next(cur)) {
496 Plugin *plugin = (Plugin *) cur->data;
498 if (!strcmp(type, plugin->type()))
499 plugin_unload(plugin);
503 cur = g_slist_find_custom(plugin_types, (gpointer) type, list_find_by_string);
506 plugin_types = g_slist_remove(plugin_types, cur);
511 /* Load those plugins we always want to use. No error output; just
513 void plugin_load_standard_plugins (void)
515 static const char *names[] = {
526 gchar *error, *filename;
528 for (i=0; names[i]; i++) {
529 /* Simple hack to check whether the plugin has already
530 * been loaded but checking only for the basename. */
531 GSList *cur = plugins;
532 for(; cur; cur = cur->next) {
533 Plugin *p = (Plugin *)cur->data;
534 if (strstr(p->filename, names[i]))
537 if (!cur) { /* Not yet loaded. */
538 /* FIXME: get_plugin_dir () returns with a trailing
539 * (back)slash; this should be fixed so that we can use
540 * g_module_build_path here. */
542 filename = g_strconcat (get_plugin_dir(),
545 filename = g_strconcat (get_plugin_dir(),
546 names[i], ".", G_MODULE_SUFFIX, NULL);
549 plugin_load(filename, &error);
556 GSList *plugin_get_list(void)
559 GSList *cur = plugins;
560 for (; cur; cur = cur->next) {
561 Plugin *p = (Plugin *)cur->data;
562 if (!p->unloaded_hidden)
563 new = g_slist_prepend(new, p);
565 new = g_slist_reverse(new);
569 GSList *plugin_get_unloaded_list(void)
571 return g_slist_copy(unloaded_plugins);
574 const gchar *plugin_get_name(Plugin *plugin)
576 return plugin->name();
579 const gchar *plugin_get_desc(Plugin *plugin)
581 return plugin->desc();
584 const gchar *plugin_get_version(Plugin *plugin)
586 return plugin->version();
589 const gchar *plugin_get_error(Plugin *plugin)
591 return plugin->error;
594 /* Generally called in plugin_init() function of each plugin. It check the
595 * minimal and compiled version of claws binary required by the plugin.
596 * If (@minimum_claws_version == 0 || @compiled_claws_version == 0), don't
597 * check the corresponding version.
599 * If an error occurs {
600 * If @error == NULL { don't allocate error string. }
601 * If @error != NULL { error string is allocated and must be freed after
604 * Returns: FALSE if an error occurs, TRUE if all is OK.
606 gint check_plugin_version(guint32 minimum_claws_version,
607 guint32 compiled_claws_version,
608 const gchar *plugin_name,
611 guint32 claws_version = claws_get_version();
613 if (compiled_claws_version != 0 && claws_version > compiled_claws_version) {
615 *error = (plugin_name && *plugin_name)
616 ? g_strdup_printf(_("Your version of Claws Mail is newer than the "
617 "version the '%s' plugin was built with."),
619 : g_strdup(_("Your version of Claws Mail is newer than the "
620 "version the plugin was built with."));
625 if (minimum_claws_version != 0 && claws_version < minimum_claws_version) {
627 *error = (plugin_name && *plugin_name)
628 ? g_strdup_printf(_("Your version of Claws Mail is too old for "
629 "the '%s' plugin."), plugin_name)
630 : g_strdup(_("Your version of Claws Mail is too old for the plugin."));