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