2006-03-03 [colin] 2.0.0cvs102
[claws.git] / 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         gchar *error;
47 };
48
49 /**
50  * List of all loaded plugins
51  */
52 GSList *plugins = NULL;
53 GSList *plugin_types = NULL;
54
55 /* 
56  * List of plugins unloaded for some fixable reason
57  */
58 static GSList *unloaded_plugins = NULL;
59
60 static gint list_find_by_string(gconstpointer data, gconstpointer str)
61 {
62         return strcmp((gchar *)data, (gchar *)str) ? TRUE : FALSE;
63 }
64
65 static gint list_find_by_plugin_filename(const Plugin *plugin, const gchar *filename)
66 {
67         g_return_val_if_fail(plugin, 1);
68         g_return_val_if_fail(plugin->filename, 1);
69         g_return_val_if_fail(filename, 1);
70         return strcmp(filename, plugin->filename);
71 }
72
73 void plugin_save_list(void)
74 {
75         gchar *rcpath, *block;
76         PrefFile *pfile;
77         GSList *type_cur, *plugin_cur;
78         Plugin *plugin;
79
80         for (type_cur = plugin_types; type_cur != NULL; type_cur = g_slist_next(type_cur)) {
81                 rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL);
82 #ifdef G_OS_WIN32
83                 block = g_strconcat("PluginsWin32_", type_cur->data, NULL);
84 #else
85                 block = g_strconcat("Plugins_", type_cur->data, NULL);
86 #endif
87                 if ((pfile = prefs_write_open(rcpath)) == NULL ||
88                     (prefs_set_block_label(pfile, block) < 0)) {
89                         g_warning("failed to write plugin list\n");
90                         g_free(rcpath);
91                         return;
92                 }
93                 g_free(block);
94
95                 for (plugin_cur = plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
96                         plugin = (Plugin *) plugin_cur->data;
97                         
98                         if (!strcmp(plugin->type(), type_cur->data))
99                                 fprintf(pfile->fp, "%s\n", plugin->filename);
100                 }
101                 for (plugin_cur = unloaded_plugins; plugin_cur != NULL; plugin_cur = g_slist_next(plugin_cur)) {
102                         plugin = (Plugin *) plugin_cur->data;
103                         
104                         if (!strcmp(plugin->type(), type_cur->data))
105                                 fprintf(pfile->fp, "%s\n", plugin->filename);
106                 }
107                 fprintf(pfile->fp, "\n");
108
109                 if (prefs_file_close(pfile) < 0)
110                         g_warning("failed to write plugin list\n");
111
112                 g_free(rcpath); 
113         }
114 }
115
116 static gboolean plugin_is_loaded(const gchar *filename)
117 {
118         return (g_slist_find_custom(plugins, filename, 
119                   (GCompareFunc)list_find_by_plugin_filename) != NULL);
120 }
121
122 static Plugin *plugin_get_by_filename(const gchar *filename)
123 {
124         GSList *cur = plugins;
125         for(; cur; cur = cur->next) {
126                 Plugin *p = (Plugin *)cur->data;
127                 if (!strcmp(p->filename, filename)) {
128                         return p;
129                 } 
130         }
131         return NULL;
132 }
133
134 /** 
135  * Loads a plugin dependancies
136  * 
137  * Plugin dependancies are, optionnaly, listed in a file in
138  * get_plugin_dir()/$pluginname.deps.
139  * \param filename The filename of the plugin for which we have to load deps
140  * \param error The location where an error string can be stored
141  * \return 0 on success, -1 otherwise
142  */
143 static gint plugin_load_deps(const gchar *filename, gchar **error)
144 {
145         gchar *tmp;
146         gchar *deps_file = NULL;
147         FILE *fp = NULL;
148         gchar buf[BUFFSIZE];
149
150         tmp = g_strdup(filename);
151         *strrchr(tmp, '.') = '\0';
152         deps_file = g_strconcat(tmp, ".deps", NULL);
153         g_free(tmp);
154         
155         fp = g_fopen(deps_file, "rb");
156         g_free(deps_file);
157         
158         if (!fp)
159                 return 0;
160         
161         while (fgets(buf, sizeof(buf), fp) != NULL) {
162                 Plugin *dep_plugin = NULL;
163                 gchar *path = NULL;
164                 buf[strlen(buf)-1]='\0'; /* chop off \n */
165                 path = g_strconcat(get_plugin_dir(), buf,
166                                 ".", G_MODULE_SUFFIX, NULL);
167                 if ((dep_plugin = plugin_get_by_filename(path)) == NULL) {
168                         debug_print("trying to load %s\n", path);
169                         dep_plugin = plugin_load(path, error);
170                         if (dep_plugin == NULL) {
171                                 g_free(path);
172                                 return -1;
173                         }
174                 }
175                 g_free(path);
176                 if (!g_slist_find_custom(dep_plugin->rdeps, 
177                                 (gpointer) filename, list_find_by_string)) {
178                         debug_print("adding %s to %s rdeps\n",
179                                 filename,
180                                 dep_plugin->filename);
181                         dep_plugin->rdeps = 
182                                 g_slist_append(dep_plugin->rdeps, 
183                                         g_strdup(filename));
184                 }
185         }
186         fclose(fp);
187         return 0;
188 }
189
190 static void plugin_unload_rdeps(Plugin *plugin)
191 {
192         GSList *cur = plugin->rdeps;
193         debug_print("removing %s rdeps\n", plugin->filename);
194         while (cur) {
195                 gchar *file = (gchar *)cur->data;
196                 Plugin *rdep_plugin = file?plugin_get_by_filename(file):NULL;
197                 debug_print(" rdep %s: %p\n", file, rdep_plugin);
198                 if (rdep_plugin) {
199                         plugin_unload(rdep_plugin);
200                 }
201                 g_free(file);
202                 cur = cur->next;
203         }
204         g_slist_free(plugin->rdeps);
205         plugin->rdeps = NULL;
206 }
207
208 static void plugin_remove_from_unloaded_list (const gchar *filename)
209 {
210         GSList *item = g_slist_find_custom(unloaded_plugins, 
211                                 (gpointer) filename, (GCompareFunc)list_find_by_plugin_filename);
212         Plugin *unloaded_plugin = item ? ((Plugin *)item->data):NULL;
213         if (unloaded_plugin != NULL) {
214                 debug_print("removing %s from unloaded list\n", unloaded_plugin->filename);
215                 unloaded_plugins = g_slist_remove(unloaded_plugins, unloaded_plugin);
216                 g_module_close(unloaded_plugin->module);
217                 g_free(unloaded_plugin->filename);
218                 g_free(unloaded_plugin->error);
219                 g_free(unloaded_plugin);
220         }
221 }
222
223 /**
224  * Loads a plugin
225  *
226  * \param filename The filename of the plugin to load
227  * \param error The location where an error string can be stored
228  * \return the plugin on success, NULL otherwise
229  */
230 Plugin *plugin_load(const gchar *filename, gchar **error)
231 {
232         Plugin *plugin;
233         gint (*plugin_init) (gchar **error);
234         gpointer plugin_name, plugin_desc, plugin_version;
235         const gchar *(*plugin_type)(void);
236         const gchar *(*plugin_licence)(void);
237         gint ok;
238
239         g_return_val_if_fail(filename != NULL, NULL);
240         g_return_val_if_fail(error != NULL, NULL);
241
242         /* check duplicate plugin path name */
243         if (plugin_is_loaded(filename)) {
244                 *error = g_strdup(_("Plugin already loaded"));
245                 return NULL;                
246         }                               
247         
248         plugin_remove_from_unloaded_list(filename);
249         
250         if (plugin_load_deps(filename, error) < 0)
251                 return NULL;
252         plugin = g_new0(Plugin, 1);
253         if (plugin == NULL) {
254                 *error = g_strdup(_("Failed to allocate memory for Plugin"));
255                 return NULL;
256         }
257
258         debug_print("trying to load `%s'\n", filename);
259         plugin->module = g_module_open(filename, 0);
260         if (plugin->module == NULL) {
261                 *error = g_strdup(g_module_error());
262                 g_free(plugin);
263                 return NULL;
264         }
265
266         if (!g_module_symbol(plugin->module, "plugin_name", &plugin_name) ||
267             !g_module_symbol(plugin->module, "plugin_desc", &plugin_desc) ||
268             !g_module_symbol(plugin->module, "plugin_version", &plugin_version) ||
269             !g_module_symbol(plugin->module, "plugin_type", (gpointer)&plugin_type) ||
270             !g_module_symbol(plugin->module, "plugin_licence", (gpointer)&plugin_licence) ||
271             !g_module_symbol(plugin->module, "plugin_init", (gpointer)&plugin_init)) {
272                 *error = g_strdup(g_module_error());
273                 g_module_close(plugin->module);
274                 g_free(plugin);
275                 return NULL;
276         }
277         
278         if (strcmp(plugin_licence(), "GPL")
279         &&  strncmp(plugin_licence(), "GPL-compatible", strlen("GPL-compatible"))) {
280                 *error = g_strdup(_("This module is not licenced under a GPL compatible licence."));
281                 g_module_close(plugin->module);
282                 g_free(plugin);
283                 return NULL;
284         }
285
286         if (!strcmp(plugin_type(), "GTK")) {
287                 *error = g_strdup(_("This module is for Sylpheed-Claws GTK1."));
288                 g_module_close(plugin->module);
289                 g_free(plugin);
290                 return NULL;
291         }
292
293         plugin->name = plugin_name;
294         plugin->desc = plugin_desc;
295         plugin->version = plugin_version;
296         plugin->type = plugin_type;
297         plugin->licence = plugin_licence;
298         plugin->filename = g_strdup(filename);
299         plugin->error = NULL;
300         if ((ok = plugin_init(error)) < 0) {
301                 if (*error)
302                         plugin->error = g_strdup(*error);
303                 unloaded_plugins = g_slist_append(unloaded_plugins, plugin);
304                 return NULL;
305         }
306
307         plugins = g_slist_append(plugins, plugin);
308
309         debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
310
311         return plugin;
312 }
313
314 void plugin_unload(Plugin *plugin)
315 {
316         void (*plugin_done) (void);
317
318         plugin_unload_rdeps(plugin);
319
320         if (plugin->error) {
321                 plugin_remove_from_unloaded_list(plugin->filename);
322                 return;
323         }
324         if (g_module_symbol(plugin->module, "plugin_done", (gpointer) &plugin_done)) {
325                 plugin_done();
326         }
327
328         g_module_close(plugin->module);
329         plugins = g_slist_remove(plugins, plugin);
330         g_free(plugin->filename);
331         g_free(plugin);
332 }
333
334 void plugin_load_all(const gchar *type)
335 {
336         gchar *rcpath;
337         gchar buf[BUFFSIZE];
338         PrefFile *pfile;
339         gchar *error = NULL, *block;
340
341         plugin_types = g_slist_append(plugin_types, g_strdup(type));
342
343         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL); 
344 #ifdef G_OS_WIN32
345         block = g_strconcat("PluginsWin32_", type, NULL);
346 #else
347         block = g_strconcat("Plugins_", type, NULL);
348 #endif
349         if ((pfile = prefs_read_open(rcpath)) == NULL ||
350             (prefs_set_block_label(pfile, block) < 0)) {
351                 g_free(rcpath);
352                 return;
353         }
354         g_free(block);
355
356         while (fgets(buf, sizeof(buf), pfile->fp) != NULL) {
357                 if (buf[0] == '[')
358                         break;
359
360                 g_strstrip(buf);
361                 if ((buf[0] != '\0') && (plugin_load(buf, &error) == NULL)) {
362                         g_warning("plugin loading error: %s\n", error);
363                         g_free(error);
364                 }                                                       
365         }
366         prefs_file_close(pfile);
367
368         g_free(rcpath);
369 }
370
371 void plugin_unload_all(const gchar *type)
372 {
373         GSList *list, *cur;
374
375         list = g_slist_copy(plugins);
376         list = g_slist_reverse(list);
377
378         for(cur = list; cur != NULL; cur = g_slist_next(cur)) {
379                 Plugin *plugin = (Plugin *) cur->data;
380                 
381                 if (!strcmp(type, plugin->type()))
382                         plugin_unload(plugin);
383         }
384         g_slist_free(list);
385
386         cur = g_slist_find_custom(plugin_types, (gpointer) type, list_find_by_string);
387         if (cur) {
388                 g_free(cur->data);
389                 plugin_types = g_slist_remove(plugin_types, cur);
390         }
391 }
392
393 GSList *plugin_get_list(void)
394 {
395         return g_slist_copy(plugins);
396 }
397
398 GSList *plugin_get_unloaded_list(void)
399 {
400         return g_slist_copy(unloaded_plugins);
401 }
402
403 const gchar *plugin_get_name(Plugin *plugin)
404 {
405         return plugin->name();
406 }
407
408 const gchar *plugin_get_desc(Plugin *plugin)
409 {
410         return plugin->desc();
411 }
412
413 const gchar *plugin_get_version(Plugin *plugin)
414 {
415         return plugin->version();
416 }
417
418 const gchar *plugin_get_error(Plugin *plugin)
419 {
420         return plugin->error;
421 }