0.8.8claws26
[claws.git] / 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  */
19
20 #include <stdio.h>
21
22 #include <glib.h>
23 #include <gmodule.h>
24
25 #include "intl.h"
26 #include "defs.h"
27 #include "utils.h"
28 #include "plugin.h"
29 #include "prefs.h"
30
31 struct _Plugin
32 {
33         gchar   *filename;
34         GModule *module;
35         gchar   *(*name) ();
36         gchar   *(*desc) ();
37 };
38
39 /**
40  * List of all loaded plugins
41  */
42 GSList *plugins = NULL;
43
44 void plugin_save_list()
45 {
46         gchar *rcpath;
47         PrefFile *pfile;
48         GSList *cur;
49         Plugin *plugin;
50
51         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, "pluginsrc", NULL);
52         if ((pfile = prefs_write_open(rcpath)) == NULL) {
53                 g_warning("failed to write plugin list\n");
54                 g_free(rcpath);
55                 return;
56         }
57
58         for (cur = plugins; cur != NULL; cur = g_slist_next(cur)) {
59                 plugin = (Plugin *)cur->data;
60                         
61                 fprintf(pfile->fp, "%s\n", plugin->filename);
62         }
63
64         if (prefs_write_close(pfile) < 0)
65                 g_warning("failed to write plugin list\n");
66
67         g_free(rcpath); 
68 }
69
70 /**
71  * Loads a plugin
72  *
73  * \param filename The filename of the plugin to load
74  * \param error The location where an error string can be stored
75  * \return 0 on success, -1 otherwise
76  */
77 gint plugin_load(const gchar *filename, gchar **error)
78 {
79         Plugin *plugin;
80         gint (*plugin_init) (gchar **error);
81         gchar *plugin_name, *plugin_desc;
82         gint ok;
83
84         g_return_val_if_fail(filename != NULL, -1);
85         g_return_val_if_fail(error != NULL, -1);
86         
87         plugin = g_new0(Plugin, 1);
88         if (plugin == NULL) {
89                 *error = g_strdup(_("Failed to allocate memory for Plugin"));
90                 return -1;
91         }
92
93         plugin->module = g_module_open(filename, 0);
94         if (plugin->module == NULL) {
95                 *error = g_strdup(g_module_error());
96                 g_free(plugin);
97                 return -1;
98         }
99
100         if (!g_module_symbol(plugin->module, "plugin_name", (gpointer *)&plugin_name) ||
101             !g_module_symbol(plugin->module, "plugin_desc", (gpointer *)&plugin_desc) ||
102             !g_module_symbol(plugin->module, "plugin_init", (gpointer *)&plugin_init)) {
103                 *error = g_strdup(g_module_error());
104                 g_module_close(plugin->module);
105                 g_free(plugin);
106                 return -1;
107         }
108
109         if ((ok = plugin_init(error)) < 0) {
110                 g_module_close(plugin->module);
111                 g_free(plugin);
112                 return ok;
113         }
114
115         plugin->name = plugin_name;
116         plugin->desc = plugin_desc;
117         plugin->filename = g_strdup(filename);
118
119         plugins = g_slist_append(plugins, plugin);
120
121         debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
122
123         return 0;
124 }
125
126 void plugin_unload(Plugin *plugin)
127 {
128         void (*plugin_done) ();
129
130         if (g_module_symbol(plugin->module, "plugin_done", (gpointer *)&plugin_done)) {
131                 plugin_done();
132         }
133
134         g_module_close(plugin->module);
135         g_free(plugin);
136 }
137
138 void plugin_load_all()
139 {
140         gchar *rcpath;
141         gchar buf[BUFFSIZE];
142         FILE *fp;
143
144         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, "pluginsrc", NULL);       
145         if ((fp = fopen(rcpath, "rb")) != NULL) {
146                 gchar *error;
147
148                 while(fgets(buf, sizeof(buf), fp) != NULL) {
149                         g_strstrip(buf);
150                         
151                         if (plugin_load(buf, &error) < 0) {
152                                 debug_print("plugin loading error: %s\n", error);
153                                 g_free(error);
154                         }
155                 }
156
157                 fclose(fp);
158         }
159
160         g_free(rcpath);
161 }
162
163 void plugin_unload_all()
164 {
165         GSList *cur;
166
167         for (cur = plugins; cur != NULL; cur = g_slist_next(cur)) {
168                 plugin_unload((Plugin *)cur->data);
169         }
170         g_slist_free(plugins);
171         plugins = NULL;
172 }
173
174 GSList *plugin_get_list()
175 {
176         return g_slist_copy(plugins);
177 }
178
179 const gchar *plugin_get_name(Plugin *plugin)
180 {
181         return plugin->name();
182 }
183
184 const gchar *plugin_get_desc(Plugin *plugin)
185 {
186         return plugin->desc();
187 }