src/common/plugin.c

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