src/common/plugin.c

   1 /*
   2  * Sylpheed -- a GTK+ based, lightweight, and fast e-mail client
   3  * Copyright (C) 1999-2006 Hiroyuki Yamamoto and the Sylpheed-Claws Team
   4  *
   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 2 of the License, or
   8  * (at your option) any later version.
   9  *
  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.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  */
  19
  20 #include <stdio.h>
  21
  22 #include "defs.h"
  23 #include <glib.h>
  24 #ifdef ENABLE_NLS
  25 #include <glib/gi18n.h>
  26 #else
  27 #define _(a) (a)
  28 #define N_(a) (a)
  29 #endif
  30 #include <gmodule.h>
  31
  32 #include "utils.h"
  33 #include "plugin.h"
  34 #include "prefs.h"
  35
  36 struct _Plugin
  37 {
  38         gchar   *filename;
  39         GModule *module;
  40         const gchar *(*name) (void);
  41         const gchar *(*desc) (void);
  42         const gchar *(*version) (void);
  43         const gchar *(*type) (void);
  44         const gchar *(*licence) (void);
  45         GSList *rdeps;
  46 };
  47
  48 /**
  49  * List of all loaded plugins
  50  */
  51 GSList *plugins = NULL;
  52 GSList *plugin_types = NULL;
  53
  54 static gint list_find_by_string(gconstpointer data, gconstpointer str)
  55 {
  56         return strcmp((gchar *)data, (gchar *)str) ? TRUE : FALSE;
  57 }
  58
  59 static gint list_find_by_plugin_filename(const Plugin *plugin, const gchar *filename)
  60 {
  61         g_return_val_if_fail(plugin, 1);
  62         g_return_val_if_fail(plugin->filename, 1);
  63         g_return_val_if_fail(filename, 1);
  64         return strcmp(filename, plugin->filename);
  65 }
  66
  67 void plugin_save_list(void)
  68 {
  69         gchar *rcpath, *block;
  70         PrefFile *pfile;
  71         GSList *type_cur, *plugin_cur;
  72         Plugin *plugin;
  73
  74         for (type_cur = plugin_types; type_cur != NULL; type_cur = g_slist_next(type_cur)) {
  75                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
  76 #ifdef G_OS_WIN32
  77                 block = g_strconcat("PluginsWin32_", type_cur->data, NULL);
  78 #else
  79                 block = g_strconcat("Plugins_", type_cur->data, NULL);
  80 #endif
  81                 if ((pfile = prefs_write_open(rcpath)) == NULL ||
  82                     (prefs_set_block_label(pfile, block) < 0)) {
  83                         g_warning("failed to write plugin list\n");
  84                         g_free(rcpath);
  85                         return;
  86                 }
  87                 g_free(block);
  88
  89                 for (plugin_cur = plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
  90                         plugin = (Plugin *) plugin_cur->data;
  91
  92                         if (!strcmp(plugin->type(), type_cur->data))
  93                                 fprintf(pfile->fp, "%s\n", plugin->filename);
  94                 }
  95                 fprintf(pfile->fp, "\n");
  96
  97                 if (prefs_file_close(pfile) < 0)
  98                         g_warning("failed to write plugin list\n");
  99
 100                 g_free(rcpath);
 101         }
 102 }
 103
 104 static gboolean plugin_is_loaded(const gchar *filename)
 105 {
 106         return (g_slist_find_custom(plugins, filename,
 107                   (GCompareFunc)list_find_by_plugin_filename) != NULL);
 108 }
 109
 110 static Plugin *plugin_get_by_filename(const gchar *filename)
 111 {
 112         GSList *cur = plugins;
 113         for(; cur; cur = cur->next) {
 114                 Plugin *p = (Plugin *)cur->data;
 115                 if (!strcmp(p->filename, filename)) {
 116                         return p;
 117                 }
 118         }
 119         return NULL;
 120 }
 121
 122 /**
 123  * Loads a plugin dependancies
 124  *
 125  * Plugin dependancies are, optionnaly, listed in a file in
 126  * get_plugin_dir()/$pluginname.deps.
 127  * \param filename The filename of the plugin for which we have to load deps
 128  * \param error The location where an error string can be stored
 129  * \return 0 on success, -1 otherwise
 130  */
 131 static gint plugin_load_deps(const gchar *filename, gchar **error)
 132 {
 133         gchar *tmp;
 134         gchar *deps_file = NULL;
 135         FILE *fp = NULL;
 136         gchar buf[BUFFSIZE];
 137
 138         tmp = g_strdup(filename);
 139         *strrchr(tmp, '.') = '\0';
 140         deps_file = g_strconcat(tmp, ".deps", NULL);
 141         g_free(tmp);
 142
 143         fp = g_fopen(deps_file, "rb");
 144         g_free(deps_file);
 145
 146         if (!fp)
 147                 return 0;
 148
 149         while (fgets(buf, sizeof(buf), fp) != NULL) {
 150                 Plugin *dep_plugin = NULL;
 151                 gchar *path = NULL;
 152                 buf[strlen(buf)-1]='\0'; /* chop off \n */
 153                 path = g_strconcat(get_plugin_dir(), buf,
 154                                 ".", G_MODULE_SUFFIX, NULL);
 155                 if ((dep_plugin = plugin_get_by_filename(path)) == NULL) {
 156                         debug_print("trying to load %s\n", path);
 157                         dep_plugin = plugin_load(path, error);
 158                         if (dep_plugin == NULL) {
 159                                 g_free(path);
 160                                 return -1;
 161                         }
 162                 }
 163                 g_free(path);
 164                 if (!g_slist_find_custom(dep_plugin->rdeps,
 165                                 (gpointer) filename, list_find_by_string)) {
 166                         debug_print("adding %s to %s rdeps\n",
 167                                 filename,
 168                                 dep_plugin->filename);
 169                         dep_plugin->rdeps =
 170                                 g_slist_append(dep_plugin->rdeps,
 171                                         g_strdup(filename));
 172                 }
 173         }
 174         fclose(fp);
 175         return 0;
 176 }
 177
 178 static void plugin_unload_rdeps(Plugin *plugin)
 179 {
 180         GSList *cur = plugin->rdeps;
 181         debug_print("removing %s rdeps\n", plugin->filename);
 182         while (cur) {
 183                 gchar *file = (gchar *)cur->data;
 184                 Plugin *rdep_plugin = file?plugin_get_by_filename(file):NULL;
 185                 debug_print(" rdep %s: %p\n", file, rdep_plugin);
 186                 if (rdep_plugin) {
 187                         plugin_unload(rdep_plugin);
 188                 }
 189                 g_free(file);
 190                 cur = cur->next;
 191         }
 192         g_slist_free(plugin->rdeps);
 193         plugin->rdeps = NULL;
 194 }
 195 /**
 196  * Loads a plugin
 197  *
 198  * \param filename The filename of the plugin to load
 199  * \param error The location where an error string can be stored
 200  * \return the plugin on success, NULL otherwise
 201  */
 202 Plugin *plugin_load(const gchar *filename, gchar **error)
 203 {
 204         Plugin *plugin;
 205         gint (*plugin_init) (gchar **error);
 206         gpointer plugin_name, plugin_desc, plugin_version;
 207         const gchar *(*plugin_type)(void);
 208         const gchar *(*plugin_licence)(void);
 209         gint ok;
 210
 211         g_return_val_if_fail(filename != NULL, NULL);
 212         g_return_val_if_fail(error != NULL, NULL);
 213
 214         /* check duplicate plugin path name */
 215         if (plugin_is_loaded(filename)) {
 216                 *error = g_strdup(_("Plugin already loaded"));
 217                 return NULL;
 218         }
 219
 220         if (plugin_load_deps(filename, error) < 0)
 221                 return NULL;
 222         plugin = g_new0(Plugin, 1);
 223         if (plugin == NULL) {
 224                 *error = g_strdup(_("Failed to allocate memory for Plugin"));
 225                 return NULL;
 226         }
 227
 228         debug_print("trying to load `%s'\n", filename);
 229         plugin->module = g_module_open(filename, 0);
 230         if (plugin->module == NULL) {
 231                 *error = g_strdup(g_module_error());
 232                 g_free(plugin);
 233                 return NULL;
 234         }
 235
 236         if (!g_module_symbol(plugin->module, "plugin_name", &plugin_name) ||
 237             !g_module_symbol(plugin->module, "plugin_desc", &plugin_desc) ||
 238             !g_module_symbol(plugin->module, "plugin_version", &plugin_version) ||
 239             !g_module_symbol(plugin->module, "plugin_type", (gpointer)&plugin_type) ||
 240             !g_module_symbol(plugin->module, "plugin_licence", (gpointer)&plugin_licence) ||
 241             !g_module_symbol(plugin->module, "plugin_init", (gpointer)&plugin_init)) {
 242                 *error = g_strdup(g_module_error());
 243                 g_module_close(plugin->module);
 244                 g_free(plugin);
 245                 return NULL;
 246         }
 247
 248         if (strcmp(plugin_licence(), "GPL")
 249         &&  strncmp(plugin_licence(), "GPL-compatible", strlen("GPL-compatible"))) {
 250                 *error = g_strdup(_("This module is not licenced under a GPL compatible licence."));
 251                 g_module_close(plugin->module);
 252                 g_free(plugin);
 253                 return NULL;
 254         }
 255
 256         if (!strcmp(plugin_type(), "GTK")) {
 257                 *error = g_strdup(_("This module is for Sylpheed-Claws GTK1."));
 258                 g_module_close(plugin->module);
 259                 g_free(plugin);
 260                 return NULL;
 261         }
 262
 263         if ((ok = plugin_init(error)) < 0) {
 264                 g_module_close(plugin->module);
 265                 g_free(plugin);
 266                 return NULL;
 267         }
 268
 269         plugin->name = plugin_name;
 270         plugin->desc = plugin_desc;
 271         plugin->version = plugin_version;
 272         plugin->type = plugin_type;
 273         plugin->licence = plugin_licence;
 274         plugin->filename = g_strdup(filename);
 275
 276         plugins = g_slist_append(plugins, plugin);
 277
 278         debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
 279
 280         return plugin;
 281 }
 282
 283 void plugin_unload(Plugin *plugin)
 284 {
 285         void (*plugin_done) (void);
 286
 287         plugin_unload_rdeps(plugin);
 288
 289         if (g_module_symbol(plugin->module, "plugin_done", (gpointer) &plugin_done)) {
 290                 plugin_done();
 291         }
 292
 293         g_module_close(plugin->module);
 294         plugins = g_slist_remove(plugins, plugin);
 295         g_free(plugin->filename);
 296         g_free(plugin);
 297 }
 298
 299 void plugin_load_all(const gchar *type)
 300 {
 301         gchar *rcpath;
 302         gchar buf[BUFFSIZE];
 303         PrefFile *pfile;
 304         gchar *error, *block;
 305
 306         plugin_types = g_slist_append(plugin_types, g_strdup(type));
 307
 308         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
 309 #ifdef G_OS_WIN32
 310         block = g_strconcat("PluginsWin32_", type, NULL);
 311 #else
 312         block = g_strconcat("Plugins_", type, NULL);
 313 #endif
 314         if ((pfile = prefs_read_open(rcpath)) == NULL ||
 315             (prefs_set_block_label(pfile, block) < 0)) {
 316                 g_free(rcpath);
 317                 return;
 318         }
 319         g_free(block);
 320
 321         while (fgets(buf, sizeof(buf), pfile->fp) != NULL) {
 322                 if (buf[0] == '[')
 323                         break;
 324
 325                 g_strstrip(buf);
 326                 if ((buf[0] != '\0') && (plugin_load(buf, &error) == NULL)) {
 327                         g_warning("plugin loading error: %s\n", error);
 328                         g_free(error);
 329                 }
 330         }
 331         prefs_file_close(pfile);
 332
 333         g_free(rcpath);
 334 }
 335
 336 void plugin_unload_all(const gchar *type)
 337 {
 338         GSList *list, *cur;
 339
 340         list = g_slist_copy(plugins);
 341         list = g_slist_reverse(list);
 342
 343         for(cur = list; cur != NULL; cur = g_slist_next(cur)) {
 344                 Plugin *plugin = (Plugin *) cur->data;
 345
 346                 if (!strcmp(type, plugin->type()))
 347                         plugin_unload(plugin);
 348         }
 349         g_slist_free(list);
 350
 351         cur = g_slist_find_custom(plugin_types, (gpointer) type, list_find_by_string);
 352         if (cur) {
 353                 g_free(cur->data);
 354                 g_slist_remove(plugin_types, cur);
 355         }
 356 }
 357
 358 GSList *plugin_get_list(void)
 359 {
 360         return g_slist_copy(plugins);
 361 }
 362
 363 const gchar *plugin_get_name(Plugin *plugin)
 364 {
 365         return plugin->name();
 366 }
 367
 368 const gchar *plugin_get_desc(Plugin *plugin)
 369 {
 370         return plugin->desc();
 371 }
 372
 373 const gchar *plugin_get_version(Plugin *plugin)
 374 {
 375         return plugin->version();
 376 }