src/common/plugin.c

   1 /*
   2  * Claws Mail -- a GTK based, lightweight, and fast e-mail client
   3  * Copyright (C) 2002-2022 the Claws Mail 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 3 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, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifdef HAVE_CONFIG_H
  20 #  include "config.h"
  21 #include "claws-features.h"
  22 #endif
  23
  24 #include <stdio.h>
  25 #ifdef HAVE_VALGRIND
  26 #include <valgrind.h>
  27 #endif
  28
  29 #include "defs.h"
  30 #include <glib.h>
  31 #ifdef ENABLE_NLS
  32 #include <glib/gi18n.h>
  33 #else
  34 #define _(a) (a)
  35 #define N_(a) (a)
  36 #endif
  37 #include <gmodule.h>
  38
  39 #include "utils.h"
  40 #include "plugin.h"
  41 #include "prefs.h"
  42 #include "claws.h"
  43 #include "timing.h"
  44 #include "file-utils.h"
  45
  46 #ifdef G_OS_WIN32
  47 #define PLUGINS_BLOCK_PREFIX "PluginsWin32_"
  48 #else
  49 #define PLUGINS_BLOCK_PREFIX "Plugins_"
  50 #endif
  51
  52 struct _Plugin
  53 {
  54         gchar   *filename;
  55         GModule *module;
  56         const gchar *(*name) (void);
  57         const gchar *(*desc) (void);
  58         const gchar *(*version) (void);
  59         const gchar *(*type) (void);
  60         const gchar *(*licence) (void);
  61         struct PluginFeature *(*provides) (void);
  62
  63         GSList *rdeps;
  64         gchar *error;
  65         gboolean unloaded_hidden;
  66         gboolean in_prefix_dir;
  67 };
  68
  69 const gchar *plugin_feature_names[] =
  70         { N_("Nothing"),
  71           N_("a viewer"),
  72           N_("a MIME parser"),
  73           N_("folders"),
  74           N_("filtering"),
  75           N_("a privacy interface"),
  76           N_("a notifier"),
  77           N_("a utility"),
  78           N_("things"),
  79           NULL };
  80
  81 /* The plugin must be at least under one of these licences and have
  82    the corresponding token returned by the plugin_licence function.
  83  */
  84 const gchar *plugin_licence_tokens[] = {
  85   "LGPL2.1+", "LGPLv2.1+", "LGPL2.1", "LGPLv2.1",
  86   "LGPL3+", "LGPLv3+", "LGPL3", "LGPLv3",
  87   "GPL3+", "GPLv3+", "GPL3", "GPLv3",
  88   "GPL2+", "GPLv2+",
  89   "Apache2.0", "Apache 2.0", "Apache v2.0",
  90   "2-clause BSD", "Simplified BSD", "FreeBSD",
  91   "3-clause BSD", "New BSD", "Modified BSD",
  92   NULL
  93 };
  94
  95 /* Dual (or more) licences are allowed, must be separated by one of these.
  96  */
  97 #define IS_LICENCE_SEP(a) ((a) == ',' || (a) == ';' || (a) == '|' || (a) == '/' || (a) == '\0')
  98
  99 /**
 100  * List of all loaded plugins
 101  */
 102 GSList *plugins = NULL;
 103 GSList *plugin_types = NULL;
 104
 105 /*
 106  * List of plugins unloaded for some fixable reason
 107  */
 108 static GSList *unloaded_plugins = NULL;
 109
 110 static gint list_find_by_string(gconstpointer data, gconstpointer str)
 111 {
 112         return strcmp((gchar *)data, (gchar *)str) ? TRUE : FALSE;
 113 }
 114
 115 static gint list_find_by_plugin_filename(const Plugin *plugin, const gchar *filename)
 116 {
 117         /* FIXME: There is a problem in case of symlinks or when a
 118            user tries to load a plugin with the same name from a
 119            different directory.  I think it would be better to compare
 120            only the basename of the filename here (case-insensitive on
 121            W32). */
 122         cm_return_val_if_fail(plugin, 1);
 123         cm_return_val_if_fail(plugin->filename, 1);
 124         cm_return_val_if_fail(filename, 1);
 125         return strcmp(filename, plugin->filename);
 126 }
 127
 128 static gboolean plugin_filename_is_standard_dir(const gchar *filename) {
 129         return strncmp(filename, get_plugin_dir(), strlen(get_plugin_dir())) == 0;
 130 }
 131
 132 static gchar * plugin_canonical_name(const Plugin *plugin)
 133 {
 134         if (plugin->in_prefix_dir == TRUE) {
 135                 if (plugin_filename_is_standard_dir(plugin->filename) == TRUE) {
 136                         gchar *plugin_name = g_path_get_basename(plugin->filename);
 137                         return plugin_name;
 138                 }
 139         }
 140         return g_strdup(plugin->filename);
 141 }
 142
 143 void plugin_save_list(void)
 144 {
 145         gchar *rcpath, *block;
 146         PrefFile *pfile;
 147         GSList *type_cur, *plugin_cur;
 148         Plugin *plugin;
 149
 150         for (type_cur = plugin_types; type_cur != NULL; type_cur = g_slist_next(type_cur)) {
 151                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
 152                 block = g_strconcat(PLUGINS_BLOCK_PREFIX, type_cur->data, NULL);
 153                 if ((pfile = prefs_write_open(rcpath)) == NULL ||
 154                     (prefs_set_block_label(pfile, block) < 0)) {
 155                         g_warning("failed to write plugin list");
 156                         g_free(rcpath);
 157                         g_free(block);
 158                         return;
 159                 }
 160                 g_free(block);
 161
 162                 for (plugin_cur = plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
 163                         plugin = (Plugin *) plugin_cur->data;
 164
 165                         if (plugin->unloaded_hidden)
 166                                 continue;
 167
 168                         if (!strcmp(plugin->type(), type_cur->data)) {
 169                                 gchar * name = plugin_canonical_name(plugin);
 170                                 int err = fprintf(pfile->fp, "%s\n", name);
 171                                 g_free(name);
 172                                 if (err < 0)
 173                                         goto revert;
 174                         }
 175                 }
 176                 for (plugin_cur = unloaded_plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
 177                         plugin = (Plugin *) plugin_cur->data;
 178
 179                         if (plugin->unloaded_hidden)
 180                                 continue;
 181
 182                         if (!strcmp(plugin->type(), type_cur->data)) {
 183                                 gchar * name = plugin_canonical_name(plugin);
 184                                 int err = fprintf(pfile->fp, "%s\n", name);
 185                                 g_free(name);
 186                                 if (err < 0)
 187                                         goto revert;
 188                         }
 189                 }
 190                 if (fprintf(pfile->fp, "\n") < 0)
 191                         goto revert;
 192
 193                 if (prefs_file_close(pfile) < 0)
 194                         g_warning("failed to write plugin list");
 195
 196                 g_free(rcpath);
 197
 198                 continue;
 199
 200 revert:
 201                 g_warning("failed to write plugin list");
 202                 if (prefs_file_close_revert(pfile) < 0)
 203                         g_warning("failed to revert plugin list");
 204
 205                 g_free(rcpath);
 206         }
 207 }
 208
 209 static gboolean plugin_is_loaded(const gchar *filename)
 210 {
 211         return (g_slist_find_custom(plugins, filename,
 212                   (GCompareFunc)list_find_by_plugin_filename) != NULL);
 213 }
 214
 215 static Plugin *plugin_get_by_filename(const gchar *filename)
 216 {
 217         GSList *cur = plugins;
 218         for(; cur; cur = cur->next) {
 219                 Plugin *p = (Plugin *)cur->data;
 220                 if (!strcmp(p->filename, filename)) {
 221                         return p;
 222                 }
 223         }
 224         return NULL;
 225 }
 226
 227 /**
 228  * Loads a plugin dependancies
 229  *
 230  * Plugin dependancies are, optionnaly, listed in a file in
 231  * get_plugin_dir()/$pluginname.deps.
 232  * \param filename The filename of the plugin for which we have to load deps
 233  * \param error The location where an error string can be stored
 234  * \return 0 on success, -1 otherwise
 235  */
 236 static gint plugin_load_deps(const gchar *filename, gchar **error)
 237 {
 238         gchar *tmp;
 239         gchar *deps_file = NULL;
 240         FILE *fp = NULL;
 241         gchar buf[BUFFSIZE];
 242         gchar *p;
 243
 244         tmp = g_strdup(filename);
 245         if( (p = strrchr(tmp, '.')) )
 246           *p = '\0';
 247         deps_file = g_strconcat(tmp, ".deps", NULL);
 248         g_free(tmp);
 249
 250         fp = claws_fopen(deps_file, "rb");
 251         g_free(deps_file);
 252
 253         if (!fp)
 254                 return 0;
 255
 256         while (claws_fgets(buf, sizeof(buf), fp) != NULL) {
 257                 Plugin *dep_plugin = NULL;
 258                 gchar *path = NULL;
 259                 buf[strlen(buf)-1]='\0'; /* chop off \n */
 260                 path = g_strconcat(get_plugin_dir(), buf,
 261                                 ".", G_MODULE_SUFFIX, NULL);
 262                 if ((dep_plugin = plugin_get_by_filename(path)) == NULL) {
 263                         debug_print("trying to load %s\n", path);
 264                         dep_plugin = plugin_load(path, error);
 265                         if (dep_plugin == NULL) {
 266                                 g_free(path);
 267                                 claws_fclose(fp);
 268                                 return -1;
 269                         }
 270                         dep_plugin->in_prefix_dir = TRUE;
 271                 }
 272                 g_free(path);
 273                 if (!g_slist_find_custom(dep_plugin->rdeps,
 274                                 (gpointer) filename, list_find_by_string)) {
 275                         debug_print("adding %s to %s rdeps\n",
 276                                 filename,
 277                                 dep_plugin->filename);
 278                         dep_plugin->rdeps =
 279                                 g_slist_append(dep_plugin->rdeps,
 280                                         g_strdup(filename));
 281                 }
 282         }
 283         claws_fclose(fp);
 284         return 0;
 285 }
 286
 287 static void plugin_unload_rdeps(Plugin *plugin)
 288 {
 289         GSList *cur = plugin->rdeps;
 290         debug_print("removing %s rdeps\n", plugin->filename);
 291         while (cur) {
 292                 gchar *file = (gchar *)cur->data;
 293                 Plugin *rdep_plugin = file?plugin_get_by_filename(file):NULL;
 294                 debug_print(" rdep %s: %p\n", file, rdep_plugin);
 295                 if (rdep_plugin) {
 296                         plugin_unload(rdep_plugin);
 297                 }
 298                 g_free(file);
 299                 cur = cur->next;
 300         }
 301         g_slist_free(plugin->rdeps);
 302         plugin->rdeps = NULL;
 303 }
 304
 305 static void plugin_remove_from_unloaded_list (const gchar *filename)
 306 {
 307         GSList *item = g_slist_find_custom(unloaded_plugins,
 308                                 (gpointer) filename, (GCompareFunc)list_find_by_plugin_filename);
 309         Plugin *unloaded_plugin = item ? ((Plugin *)item->data):NULL;
 310         if (unloaded_plugin != NULL) {
 311                 debug_print("removing %s from unloaded list\n", unloaded_plugin->filename);
 312                 unloaded_plugins = g_slist_remove(unloaded_plugins, unloaded_plugin);
 313                 g_module_close(unloaded_plugin->module);
 314                 g_free(unloaded_plugin->filename);
 315                 g_free(unloaded_plugin->error);
 316                 g_free(unloaded_plugin);
 317         }
 318 }
 319
 320 static gchar *plugin_check_features(struct PluginFeature *features) {
 321         int i = 0, j = 0;
 322         GSList *cur = plugins;
 323
 324         if (features == NULL)
 325                 return NULL;
 326         for(; cur; cur = cur->next) {
 327                 Plugin *p = (Plugin *)cur->data;
 328                 struct PluginFeature *cur_features = p->provides();
 329                 if (p->unloaded_hidden)
 330                         continue;
 331                 for (j = 0; cur_features[j].type != PLUGIN_NOTHING; j++) {
 332                         for (i = 0; features[i].type != PLUGIN_NOTHING; i++) {
 333                                 if (cur_features[j].type == features[i].type &&
 334                                     !strcmp(cur_features[j].subtype, features[i].subtype)) {
 335                                         return g_strdup_printf(_(
 336                                                 "This plugin provides %s (%s), which is "
 337                                                 "already provided by the %s plugin."),
 338                                                 _(plugin_feature_names[features[i].type]),
 339                                                 _(features[i].subtype),
 340                                                 p->name());
 341                                 }
 342                         }
 343                 }
 344         }
 345
 346         return NULL;
 347 }
 348
 349 static gboolean plugin_licence_check(const gchar *licence) {
 350         gint i = 0;
 351         gint len = 0;
 352
 353         if (licence != NULL) {
 354                 len = strlen(licence);
 355         }
 356         if (len == 0) {
 357                 g_warning("plugin licence check failed: empty licence");
 358                 return FALSE;
 359         }
 360         while (plugin_licence_tokens[i] != NULL) {
 361                 gchar *found = g_strstr_len(licence, len, plugin_licence_tokens[i]);
 362                 if (found != NULL) {
 363                         gint tlen = strlen(plugin_licence_tokens[i]);
 364                         if (len != tlen) { /* not a single license */
 365                                 if (((found == licence) &&  (!IS_LICENCE_SEP(licence[tlen])))
 366                                                 || (!IS_LICENCE_SEP(*(found - 1)))
 367                                                 || (!IS_LICENCE_SEP(*(found + tlen)))) {
 368                                         debug_print("plugin licence check failed: invalid separator\n");
 369                                         return FALSE;
 370                                 }
 371                         }
 372                         debug_print("plugin licence check passed: %s found\n", plugin_licence_tokens[i]);
 373                         return TRUE;
 374                 }
 375                 ++i;
 376         }
 377         debug_print("plugin licence check failed: %s is not a valid licence\n", licence);
 378         return FALSE;
 379 }
 380
 381 static Plugin *plugin_load_in_default_dir(const gchar *filename, gchar **error)
 382 {
 383         Plugin *plugin = NULL;
 384         gchar *filename_default_dir = NULL;
 385         gchar *default_error = NULL;
 386         gchar *plugin_name = g_path_get_basename(filename);
 387
 388         filename_default_dir = g_strconcat(get_plugin_dir(), plugin_name, NULL);
 389
 390         debug_print("trying to load %s in default plugin directory %s\n",
 391                     plugin_name, get_plugin_dir());
 392
 393         g_free(plugin_name);
 394
 395         plugin = plugin_load(filename_default_dir, &default_error);
 396
 397         g_free(filename_default_dir);
 398
 399         if (plugin) {
 400                 g_free(*error);
 401                 *error = NULL;
 402                 plugin->in_prefix_dir = TRUE;
 403
 404         } else {
 405                 g_free(default_error);
 406         }
 407
 408         return plugin;
 409 }
 410
 411 /**
 412  * Loads a plugin
 413  *
 414  * \param filename The filename of the plugin to load
 415  * \param error The location where an error string can be stored
 416  * \return the plugin on success, NULL otherwise
 417  */
 418 Plugin *plugin_load(const gchar *filename, gchar **error)
 419 {
 420         Plugin *plugin;
 421         gint (*plugin_init) (gchar **error);
 422         gpointer plugin_name, plugin_desc, plugin_version;
 423         const gchar *(*plugin_type)(void);
 424         const gchar *(*plugin_licence)(void);
 425         struct PluginFeature *(*plugin_provides)(void);
 426
 427         gint ok;
 428         START_TIMING((filename?filename:"NULL plugin"));
 429         cm_return_val_if_fail(filename != NULL, NULL);
 430         cm_return_val_if_fail(error != NULL, NULL);
 431
 432         /* check duplicate plugin path name */
 433         if (plugin_is_loaded(filename)) {
 434                 plugin = plugin_get_by_filename(filename);
 435                 if (plugin->unloaded_hidden) {
 436                         /* reshow it */
 437                         goto init_plugin;
 438                 } else {
 439                         *error = g_strdup(_("Plugin already loaded"));
 440                         return NULL;
 441                 }
 442         }
 443
 444         plugin_remove_from_unloaded_list(filename);
 445
 446         if (plugin_load_deps(filename, error) < 0)
 447                 return NULL;
 448         plugin = g_new0(Plugin, 1);
 449         if (plugin == NULL) {
 450                 *error = g_strdup(_("Failed to allocate memory for Plugin"));
 451                 return NULL;
 452         }
 453
 454         debug_print("trying to load `%s'\n", filename);
 455         plugin->module = g_module_open(filename, 0);
 456         if (plugin->module == NULL) {
 457                 *error = g_strdup(g_module_error());
 458                 g_free(plugin);
 459                 if (!plugin_filename_is_standard_dir(filename))
 460                         return plugin_load_in_default_dir(filename, error);
 461                 else
 462                         return NULL;
 463         } else {
 464                 plugin->in_prefix_dir = FALSE;
 465         }
 466
 467 init_plugin:
 468         if (!g_module_symbol(plugin->module, "plugin_name", &plugin_name) ||
 469             !g_module_symbol(plugin->module, "plugin_desc", &plugin_desc) ||
 470             !g_module_symbol(plugin->module, "plugin_version", &plugin_version) ||
 471             !g_module_symbol(plugin->module, "plugin_type", (gpointer)&plugin_type) ||
 472             !g_module_symbol(plugin->module, "plugin_licence", (gpointer)&plugin_licence) ||
 473             !g_module_symbol(plugin->module, "plugin_provides", (gpointer)&plugin_provides) ||
 474             !g_module_symbol(plugin->module, "plugin_init", (gpointer)&plugin_init)) {
 475                 *error = g_strdup(g_module_error());
 476                 if (plugin->unloaded_hidden)
 477                         return NULL;
 478                 g_module_close(plugin->module);
 479                 g_free(plugin);
 480                 return NULL;
 481         }
 482
 483         if (plugin_licence_check(plugin_licence()) != TRUE) {
 484                 *error = g_strdup(_("This module is not licensed under a GPL v3 or later compatible license."));
 485                 if (plugin->unloaded_hidden)
 486                         return NULL;
 487                 g_module_close(plugin->module);
 488                 g_free(plugin);
 489                 return NULL;
 490         }
 491
 492         if (!strcmp(plugin_type(), "GTK")) {
 493                 *error = g_strdup(_("This module is for Claws Mail GTK1."));
 494                 if (plugin->unloaded_hidden)
 495                         return NULL;
 496                 g_module_close(plugin->module);
 497                 g_free(plugin);
 498                 return NULL;
 499         }
 500
 501         if ((*error = plugin_check_features(plugin_provides())) != NULL) {
 502                 if (plugin->unloaded_hidden)
 503                         return NULL;
 504                 g_module_close(plugin->module);
 505                 g_free(plugin);
 506                 return NULL;
 507         }
 508         plugin->name = plugin_name;
 509         plugin->desc = plugin_desc;
 510         plugin->version = plugin_version;
 511         plugin->type = plugin_type;
 512         plugin->licence = plugin_licence;
 513         plugin->provides = plugin_provides;
 514         plugin->filename = g_strdup(filename);
 515         plugin->error = NULL;
 516
 517         if ((ok = plugin_init(error)) < 0) {
 518                 if (*error)
 519                         plugin->error = g_strdup(*error);
 520                 unloaded_plugins = g_slist_append(unloaded_plugins, plugin);
 521                 return NULL;
 522         }
 523
 524         if (!plugin->unloaded_hidden)
 525                 plugins = g_slist_append(plugins, plugin);
 526         plugin->unloaded_hidden = FALSE;
 527
 528         debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
 529         END_TIMING();
 530         return plugin;
 531 }
 532
 533 void plugin_unload(Plugin *plugin)
 534 {
 535         gboolean (*plugin_done) (void);
 536         gboolean can_unload = TRUE;
 537
 538         plugin_unload_rdeps(plugin);
 539
 540         if (plugin->unloaded_hidden)
 541                 return;
 542
 543         if (plugin->error) {
 544                 plugin_remove_from_unloaded_list(plugin->filename);
 545                 return;
 546         }
 547         if (g_module_symbol(plugin->module, "plugin_done", (gpointer) &plugin_done)) {
 548                 can_unload = plugin_done();
 549         }
 550
 551         if (can_unload) {
 552 #ifdef HAVE_VALGRIND
 553                 if (!RUNNING_ON_VALGRIND) {
 554                         g_module_close(plugin->module);
 555                 }
 556 #else
 557                 g_module_close(plugin->module);
 558 #endif
 559                 plugins = g_slist_remove(plugins, plugin);
 560                 g_free(plugin->filename);
 561                 g_free(plugin);
 562         } else {
 563                 plugin->unloaded_hidden = TRUE;
 564         }
 565
 566 }
 567
 568 static void replace_old_plugin_name(gchar *plugin_name)
 569 {
 570         gchar *old_name_end = g_strconcat("_plugin.", G_MODULE_SUFFIX, NULL);
 571         gchar *matches = strstr(plugin_name, old_name_end);
 572
 573         if (!matches) {
 574                 g_free(old_name_end);
 575                 return;
 576         } else if (plugin_name + strlen(plugin_name) != matches + strlen(matches)) {
 577                 g_free(old_name_end);
 578                 return;
 579         } else {
 580                 gchar *new_name_end = g_strconcat(".", G_MODULE_SUFFIX, NULL);
 581                 int offset = strlen(plugin_name) - strlen(old_name_end);
 582
 583                 debug_print("Replacing old plugin name %s\n", plugin_name);
 584
 585                 strncpy(plugin_name + offset, new_name_end, strlen(old_name_end) - 1);
 586                 debug_print(" to %s\n", plugin_name);
 587                 g_free(new_name_end);
 588         }
 589         g_free(old_name_end);
 590 }
 591
 592 void plugin_load_all(const gchar *type)
 593 {
 594         gchar *rcpath;
 595         gchar buf[BUFFSIZE];
 596         PrefFile *pfile;
 597         gchar *error = NULL, *block;
 598
 599         plugin_types = g_slist_append(plugin_types, g_strdup(type));
 600
 601         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
 602         block = g_strconcat(PLUGINS_BLOCK_PREFIX, type, NULL);
 603         if ((pfile = prefs_read_open(rcpath)) == NULL ||
 604             (prefs_set_block_label(pfile, block) < 0)) {
 605                 g_free(rcpath);
 606                 g_free(block);
 607                 if (pfile)
 608                         prefs_file_close(pfile);
 609                 return;
 610         }
 611         g_free(block);
 612
 613         while (claws_fgets(buf, sizeof(buf), pfile->fp) != NULL) {
 614                 if (buf[0] == '[')
 615                         break;
 616
 617                 g_strstrip(buf);
 618                 replace_old_plugin_name(buf);
 619
 620                 if ((buf[0] != '\0') && (plugin_load(buf, &error) == NULL)) {
 621                         g_warning("plugin loading error: %s", error);
 622                         g_free(error);
 623                 }
 624         }
 625         prefs_file_close(pfile);
 626
 627         g_free(rcpath);
 628 }
 629
 630 void plugin_unload_all(const gchar *type)
 631 {
 632         GSList *list, *cur;
 633
 634         list = g_slist_copy(plugins);
 635         list = g_slist_reverse(list);
 636
 637         for(cur = list; cur != NULL; cur = g_slist_next(cur)) {
 638                 Plugin *plugin = (Plugin *) cur->data;
 639
 640                 if (!strcmp(type, plugin->type()))
 641                         plugin_unload(plugin);
 642         }
 643         g_slist_free(list);
 644
 645         cur = g_slist_find_custom(plugin_types, (gpointer) type, list_find_by_string);
 646         if (cur) {
 647                 g_free(cur->data);
 648                 plugin_types = g_slist_remove(plugin_types, cur);
 649         }
 650 }
 651
 652
 653 /* Load those plugins we always want to use.  No error output; just
 654  * try. */
 655 void plugin_load_standard_plugins (void)
 656 {
 657         static const char *names[] = {
 658 #ifdef G_OS_WIN32
 659                 "pgpmime",
 660                 "pgpinline",
 661 #else
 662                 /* post-2.5 maybe
 663                 "bogofilter", */
 664 #endif
 665                 NULL
 666         };
 667         int i;
 668         gchar *error, *filename;
 669
 670         for (i=0; names[i]; i++) {
 671                 /* Simple hack to check whether the plugin has already
 672                  * been loaded but checking only for the basename. */
 673                 GSList *cur = plugins;
 674                 for(; cur; cur = cur->next) {
 675                         Plugin *p = (Plugin *)cur->data;
 676                         if (strstr(p->filename, names[i]))
 677                                 break;
 678                 }
 679                 if (!cur) { /* Not yet loaded. */
 680                         /* FIXME: get_plugin_dir () returns with a trailing
 681                          * (back)slash; this should be fixed so that we can use
 682                          * g_module_build_path here. */
 683 #ifdef G_OS_WIN32
 684                         filename = g_strconcat (get_plugin_dir(),
 685                                                 names[i], NULL);
 686 #else
 687                         filename = g_strconcat (get_plugin_dir(),
 688                                                 names[i], ".", G_MODULE_SUFFIX, NULL);
 689 #endif
 690                         error = NULL;
 691                         plugin_load(filename, &error);
 692                         g_free (error);
 693                         g_free(filename);
 694                 }
 695         }
 696 }
 697
 698 GSList *plugin_get_list(void)
 699 {
 700         GSList *new = NULL;
 701         GSList *cur = plugins;
 702         for (; cur; cur = cur->next) {
 703                 Plugin *p = (Plugin *)cur->data;
 704                 if (!p->unloaded_hidden)
 705                         new = g_slist_prepend(new, p);
 706         }
 707         new = g_slist_reverse(new);
 708         return new;
 709 }
 710
 711 Plugin *plugin_get_loaded_by_name(const gchar *name)
 712 {
 713         Plugin *plugin = NULL;
 714         GSList *new, *cur;
 715         new = plugin_get_list();
 716         for (cur = new; cur; cur = g_slist_next(cur)) {
 717                 plugin = (Plugin *)cur->data;
 718                 if (!g_ascii_strcasecmp(plugin->name(), name))
 719                         break;
 720                 else
 721                         plugin = NULL;
 722         }
 723         g_slist_free(new);
 724         return plugin;
 725 }
 726
 727 GSList *plugin_get_unloaded_list(void)
 728 {
 729         return g_slist_copy(unloaded_plugins);
 730 }
 731
 732 const gchar *plugin_get_name(Plugin *plugin)
 733 {
 734         return plugin->name();
 735 }
 736
 737 const gchar *plugin_get_desc(Plugin *plugin)
 738 {
 739         return plugin->desc();
 740 }
 741
 742 const gchar *plugin_get_version(Plugin *plugin)
 743 {
 744         return plugin->version();
 745 }
 746
 747 const gchar *plugin_get_error(Plugin *plugin)
 748 {
 749         return plugin->error;
 750 }
 751
 752 /* Generally called in plugin_init() function of each plugin. It check the
 753  * minimal and compiled version of claws binary required by the plugin.
 754  * If (@minimum_claws_version == 0 || @compiled_claws_version == 0), don't
 755  * check the corresponding version.
 756  *
 757  * If an error occurs {
 758  *      If @error == NULL { don't allocate error string. }
 759  *      If @error != NULL { error string is allocated and must be freed after
 760  *                              call function. }
 761  * }
 762  * Returns: FALSE if an error occurs, TRUE if all is OK.
 763  */
 764 gint check_plugin_version(guint32 minimum_claws_version,
 765                          guint32 compiled_claws_version,
 766                          const gchar *plugin_name,
 767                          gchar **error)
 768 {
 769         guint32 claws_version = claws_get_version();
 770
 771         if (compiled_claws_version != 0 && claws_version > compiled_claws_version) {
 772                 if (error != NULL) {
 773                         *error = (plugin_name && *plugin_name)
 774                                 ? g_strdup_printf(_("Your version of Claws Mail is newer than the "
 775                                                         "version the '%s' plugin was built with."),
 776                                                 plugin_name)
 777                                 : g_strdup(_("Your version of Claws Mail is newer than the "
 778                                                         "version the plugin was built with."));
 779                 }
 780                 return FALSE;
 781         }
 782
 783         if (minimum_claws_version != 0 && claws_version < minimum_claws_version) {
 784                 if (error != NULL) {
 785                         *error = (plugin_name && *plugin_name)
 786                                 ? g_strdup_printf(_("Your version of Claws Mail is too old for "
 787                                                         "the '%s' plugin."), plugin_name)
 788                                 : g_strdup(_("Your version of Claws Mail is too old for the plugin."));
 789                 }
 790                 return FALSE;
 791         }
 792         return TRUE;
 793 }