0.8.8claws42
[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, COMMON_RC, NULL);
52         if ((pfile = prefs_write_open(rcpath)) == NULL ||
53             (prefs_set_block_label(pfile, "Plugins") < 0)) {
54                 g_warning("failed to write plugin list\n");
55                 g_free(rcpath);
56                 return;
57         }
58
59         for (cur = plugins; cur != NULL; cur = g_slist_next(cur)) {
60                 plugin = (Plugin *)cur->data;
61                         
62                 fprintf(pfile->fp, "%s\n", plugin->filename);
63         }
64         fprintf(pfile->fp, "\n");
65
66         if (prefs_file_close(pfile) < 0)
67                 g_warning("failed to write plugin list\n");
68
69         g_free(rcpath); 
70 }
71
72 /**
73  * Loads a plugin
74  *
75  * \param filename The filename of the plugin to load
76  * \param error The location where an error string can be stored
77  * \return 0 on success, -1 otherwise
78  */
79 gint plugin_load(const gchar *filename, gchar **error)
80 {
81         Plugin *plugin;
82         gint (*plugin_init) (gchar **error);
83         gchar *plugin_name, *plugin_desc;
84         gint ok;
85
86         g_return_val_if_fail(filename != NULL, -1);
87         g_return_val_if_fail(error != NULL, -1);
88         
89         plugin = g_new0(Plugin, 1);
90         if (plugin == NULL) {
91                 *error = g_strdup(_("Failed to allocate memory for Plugin"));
92                 return -1;
93         }
94
95         plugin->module = g_module_open(filename, 0);
96         if (plugin->module == NULL) {
97                 *error = g_strdup(g_module_error());
98                 g_free(plugin);
99                 return -1;
100         }
101
102         if (!g_module_symbol(plugin->module, "plugin_name", (gpointer *)&plugin_name) ||
103             !g_module_symbol(plugin->module, "plugin_desc", (gpointer *)&plugin_desc) ||
104             !g_module_symbol(plugin->module, "plugin_init", (gpointer *)&plugin_init)) {
105                 *error = g_strdup(g_module_error());
106                 g_module_close(plugin->module);
107                 g_free(plugin);
108                 return -1;
109         }
110
111         if ((ok = plugin_init(error)) < 0) {
112                 g_module_close(plugin->module);
113                 g_free(plugin);
114                 return ok;
115         }
116
117         plugin->name = plugin_name;
118         plugin->desc = plugin_desc;
119         plugin->filename = g_strdup(filename);
120
121         plugins = g_slist_append(plugins, plugin);
122
123         debug_print("Plugin %s (from file %s) loaded\n", plugin->name(), filename);
124
125         return 0;
126 }
127
128 void plugin_unload(Plugin *plugin)
129 {
130         void (*plugin_done) ();
131
132         if (g_module_symbol(plugin->module, "plugin_done", (gpointer *)&plugin_done)) {
133                 plugin_done();
134         }
135
136         g_module_close(plugin->module);
137         plugins = g_slist_remove(plugins, plugin);
138         g_free(plugin);
139 }
140
141 void plugin_load_all()
142 {
143         gchar *rcpath;
144         gchar buf[BUFFSIZE];
145         PrefFile *pfile;
146         gchar *error;
147
148         rcpath = g_strconcat(get_rc_dir(), G_DIR_SEPARATOR_S, COMMON_RC, NULL); 
149         if ((pfile = prefs_read_open(rcpath)) == NULL ||
150             (prefs_set_block_label(pfile, "Plugins") < 0)) {
151                 g_free(rcpath);
152                 return;
153         }
154
155         while (fgets(buf, sizeof(buf), pfile->fp) != NULL) {
156                 if (buf[0] == '[')
157                         break;
158
159                 g_strstrip(buf);
160                 if ((buf[0] != '\0') && (plugin_load(buf, &error) < 0)) {
161                         g_warning("plugin loading error: %s\n", error);
162                         g_free(error);
163                 }                                                       
164         }
165         prefs_file_close(pfile);
166
167         g_free(rcpath);
168 }
169
170 void plugin_unload_all()
171 {
172         GSList *list, *cur;
173
174         list = g_slist_copy(plugins);
175         list = g_slist_reverse(list);
176
177         for(cur = list; cur != NULL; cur = g_slist_next(cur)) {
178                 Plugin *plugin = (Plugin *) cur->data;
179                 
180                 plugin_unload(plugin);
181         }
182         g_slist_free(list);
183 }
184
185 GSList *plugin_get_list()
186 {
187         return g_slist_copy(plugins);
188 }
189
190 const gchar *plugin_get_name(Plugin *plugin)
191 {
192         return plugin->name();
193 }
194
195 const gchar *plugin_get_desc(Plugin *plugin)
196 {
197         return plugin->desc();
198 }