1 /**
2 * @file gntplugin.c GNT Plugins API
3 * @ingroup finch
4 */
5
6 /* finch
7 *
8 * Finch is the legal property of its developers, whose names are too numerous
9 * to list here. Please refer to the COPYRIGHT file distributed with this
10 * source distribution.
11 *
12 * This program is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
25 */
26 #include <internal.h>
27
28 #include <gnt.h>
29 #include <gntbox.h>
30 #include <gntbutton.h>
31 #include <gntlabel.h>
32 #include <gntline.h>
33 #include <gnttree.h>
34 #include <gntutils.h>
35
36 #include "finch.h"
37
38 #include "debug.h"
39 #include "notify.h"
40 #include "request.h"
41
42 #include "gntplugin.h"
43 #include "gntrequest.h"
44
45 static struct
46 {
47 GntWidget *tree;
48 GntWidget *window;
49 GntWidget *aboot;
50 GntWidget *conf;
51 } plugins;
52
53 static GHashTable *confwins;
54
55 static GntWidget *process_pref_frame(PurplePluginPrefFrame *frame);
56
57 static void
free_stringlist(GList * list)58 free_stringlist(GList *list)
59 {
60 g_list_foreach(list, (GFunc)g_free, NULL);
61 g_list_free(list);
62 }
63
64 static void
decide_conf_button(PurplePlugin * plugin)65 decide_conf_button(PurplePlugin *plugin)
66 {
67 if (purple_plugin_is_loaded(plugin) &&
68 ((PURPLE_IS_GNT_PLUGIN(plugin) &&
69 FINCH_PLUGIN_UI_INFO(plugin) != NULL) ||
70 (plugin->info->prefs_info &&
71 plugin->info->prefs_info->get_plugin_pref_frame)))
72 gnt_widget_set_visible(plugins.conf, TRUE);
73 else
74 gnt_widget_set_visible(plugins.conf, FALSE);
75
76 gnt_box_readjust(GNT_BOX(plugins.window));
77 gnt_widget_draw(plugins.window);
78 }
79
80 static void
plugin_toggled_cb(GntWidget * tree,PurplePlugin * plugin,gpointer null)81 plugin_toggled_cb(GntWidget *tree, PurplePlugin *plugin, gpointer null)
82 {
83 if (gnt_tree_get_choice(GNT_TREE(tree), plugin))
84 {
85 if (!purple_plugin_load(plugin)) {
86 purple_notify_error(NULL, _("ERROR"), _("loading plugin failed"), NULL);
87 gnt_tree_set_choice(GNT_TREE(tree), plugin, FALSE);
88 }
89 }
90 else
91 {
92 GntWidget *win;
93
94 if (!purple_plugin_unload(plugin)) {
95 purple_notify_error(NULL, _("ERROR"), _("unloading plugin failed"), NULL);
96 purple_plugin_disable(plugin);
97 gnt_tree_set_choice(GNT_TREE(tree), plugin, TRUE);
98 }
99
100 if (confwins && (win = g_hash_table_lookup(confwins, plugin)) != NULL)
101 {
102 gnt_widget_destroy(win);
103 }
104 }
105 decide_conf_button(plugin);
106 finch_plugins_save_loaded();
107 }
108
109 /* Xerox */
110 void
finch_plugins_save_loaded(void)111 finch_plugins_save_loaded(void)
112 {
113 purple_plugins_save_loaded("/finch/plugins/loaded");
114 }
115
116 static void
selection_changed(GntWidget * widget,gpointer old,gpointer current,gpointer null)117 selection_changed(GntWidget *widget, gpointer old, gpointer current, gpointer null)
118 {
119 PurplePlugin *plugin = current;
120 char *text;
121 GList *list = NULL, *iter = NULL;
122
123 if (!plugin)
124 return;
125
126 /* If the selected plugin was unseen before, mark it as seen. But save the list
127 * only when the plugin list is closed. So if the user enables a plugin, and it
128 * crashes, it won't get marked as seen so the user can fix the bug and still
129 * quickly find the plugin in the list.
130 * I probably mean 'plugin developers' by 'users' here. */
131 list = g_object_get_data(G_OBJECT(widget), "seen-list");
132 if (list)
133 iter = g_list_find_custom(list, plugin->path, (GCompareFunc)strcmp);
134 if (!iter) {
135 list = g_list_prepend(list, g_strdup(plugin->path));
136 g_object_set_data(G_OBJECT(widget), "seen-list", list);
137 }
138
139 /* XXX: Use formatting and stuff */
140 gnt_text_view_clear(GNT_TEXT_VIEW(plugins.aboot));
141 text = g_strdup_printf(_("Name: %s\nVersion: %s\nDescription: %s\nAuthor: %s\nWebsite: %s\nFilename: %s\n"),
142 SAFE(_(plugin->info->name)), SAFE(_(plugin->info->version)), SAFE(_(plugin->info->description)),
143 SAFE(_(plugin->info->author)), SAFE(_(plugin->info->homepage)), SAFE(plugin->path));
144 gnt_text_view_append_text_with_flags(GNT_TEXT_VIEW(plugins.aboot),
145 text, GNT_TEXT_FLAG_NORMAL);
146 gnt_text_view_scroll(GNT_TEXT_VIEW(plugins.aboot), 0);
147 g_free(text);
148 decide_conf_button(plugin);
149 }
150
151 static void
reset_plugin_window(GntWidget * window,gpointer null)152 reset_plugin_window(GntWidget *window, gpointer null)
153 {
154 GList *list = g_object_get_data(G_OBJECT(plugins.tree), "seen-list");
155 purple_prefs_set_path_list("/finch/plugins/seen", list);
156 g_list_foreach(list, (GFunc)g_free, NULL);
157 g_list_free(list);
158
159 plugins.window = NULL;
160 plugins.tree = NULL;
161 plugins.aboot = NULL;
162 }
163
164 static int
plugin_compare(PurplePlugin * p1,PurplePlugin * p2)165 plugin_compare(PurplePlugin *p1, PurplePlugin *p2)
166 {
167 char *s1 = g_utf8_strup(p1->info->name, -1);
168 char *s2 = g_utf8_strup(p2->info->name, -1);
169 int ret = g_utf8_collate(s1, s2);
170 g_free(s1);
171 g_free(s2);
172 return ret;
173 }
174
175 static void
confwin_init(void)176 confwin_init(void)
177 {
178 confwins = g_hash_table_new(g_direct_hash, g_direct_equal);
179 }
180
181 static void
remove_confwin(GntWidget * window,gpointer plugin)182 remove_confwin(GntWidget *window, gpointer plugin)
183 {
184 g_hash_table_remove(confwins, plugin);
185 }
186
187 static void
configure_plugin_cb(GntWidget * button,gpointer null)188 configure_plugin_cb(GntWidget *button, gpointer null)
189 {
190 PurplePlugin *plugin;
191 FinchPluginFrame callback;
192
193 g_return_if_fail(plugins.tree != NULL);
194
195 plugin = gnt_tree_get_selection_data(GNT_TREE(plugins.tree));
196 if (!purple_plugin_is_loaded(plugin))
197 {
198 purple_notify_error(plugin, _("Error"),
199 _("Plugin need to be loaded before you can configure it."), NULL);
200 return;
201 }
202
203 if (confwins && g_hash_table_lookup(confwins, plugin))
204 return;
205
206 if (PURPLE_IS_GNT_PLUGIN(plugin) &&
207 (callback = FINCH_PLUGIN_UI_INFO(plugin)) != NULL)
208 {
209 GntWidget *window = gnt_vbox_new(FALSE);
210 GntWidget *box, *button;
211
212 gnt_box_set_toplevel(GNT_BOX(window), TRUE);
213 gnt_box_set_title(GNT_BOX(window), plugin->info->name);
214 gnt_box_set_alignment(GNT_BOX(window), GNT_ALIGN_MID);
215
216 box = callback();
217 gnt_box_add_widget(GNT_BOX(window), box);
218
219 box = gnt_hbox_new(FALSE);
220 gnt_box_add_widget(GNT_BOX(window), box);
221
222 button = gnt_button_new(_("Close"));
223 gnt_box_add_widget(GNT_BOX(box), button);
224 g_signal_connect_swapped(G_OBJECT(button), "activate",
225 G_CALLBACK(gnt_widget_destroy), window);
226 g_signal_connect(G_OBJECT(window), "destroy", G_CALLBACK(remove_confwin), plugin);
227
228 gnt_widget_show(window);
229
230 if (confwins == NULL)
231 confwin_init();
232 g_hash_table_insert(confwins, plugin, window);
233 }
234 else if (plugin->info->prefs_info &&
235 plugin->info->prefs_info->get_plugin_pref_frame)
236 {
237 GntWidget *win = process_pref_frame(plugin->info->prefs_info->get_plugin_pref_frame(plugin));
238 if (confwins == NULL)
239 confwin_init();
240 g_signal_connect(G_OBJECT(win), "destroy", G_CALLBACK(remove_confwin), plugin);
241 g_hash_table_insert(confwins, plugin, win);
242 return;
243 }
244 else
245 {
246 purple_notify_info(plugin, _("Error"),
247 _("No configuration options for this plugin."), NULL);
248 return;
249 }
250 }
251
252 static void
install_selected_file_cb(gpointer handle,const char * filename)253 install_selected_file_cb(gpointer handle, const char *filename)
254 {
255 /* Try to init the selected file.
256 * If it succeeds, try to make a copy of the file in $USERDIR/plugins/.
257 * If the copy succeeds, unload and destroy the plugin in the original
258 * location and init+load the new one.
259 * Select the plugin in the plugin list.
260 */
261 char *path;
262 PurplePlugin *plugin;
263
264 g_return_if_fail(plugins.window);
265
266 plugin = purple_plugin_probe(filename);
267 if (!plugin) {
268 purple_notify_error(handle, _("Error loading plugin"),
269 _("The selected file is not a valid plugin."),
270 _("Please open the debug window and try again to see the exact error message."));
271 return;
272 }
273 if (g_list_find(gnt_tree_get_rows(GNT_TREE(plugins.tree)), plugin)) {
274 purple_plugin_load(plugin);
275 gnt_tree_set_choice(GNT_TREE(plugins.tree), plugin, purple_plugin_is_loaded(plugin));
276 gnt_tree_set_selected(GNT_TREE(plugins.tree), plugin);
277 return;
278 }
279
280 path = g_build_filename(purple_user_dir(), "plugins", NULL);
281 if (purple_build_dir(path, S_IRUSR | S_IWUSR | S_IXUSR) == 0) {
282 char *content = NULL;
283 gsize length = 0;
284
285 if (g_file_get_contents(filename, &content, &length, NULL)) {
286 char *file = g_path_get_basename(filename);
287 g_free(path);
288 path = g_build_filename(purple_user_dir(), "plugins", file, NULL);
289 if (purple_util_write_data_to_file_absolute(path, content, length)) {
290 purple_plugin_destroy(plugin);
291 plugin = purple_plugin_probe(path);
292 if (!plugin) {
293 purple_debug_warning("gntplugin", "This is really strange. %s can be loaded, but %s can't!\n",
294 filename, path);
295 g_unlink(path);
296 plugin = purple_plugin_probe(filename);
297 }
298 } else {
299 }
300 }
301 g_free(content);
302 }
303 g_free(path);
304
305 purple_plugin_load(plugin);
306
307 if (plugin->info->type == PURPLE_PLUGIN_LOADER) {
308 GList *cur;
309 for (cur = PURPLE_PLUGIN_LOADER_INFO(plugin)->exts; cur != NULL;
310 cur = cur->next)
311 purple_plugins_probe(cur->data);
312 return;
313 }
314
315 if (plugin->info->type != PURPLE_PLUGIN_STANDARD ||
316 (plugin->info->flags & PURPLE_PLUGIN_FLAG_INVISIBLE) ||
317 plugin->error)
318 return;
319
320 gnt_tree_add_choice(GNT_TREE(plugins.tree), plugin,
321 gnt_tree_create_row(GNT_TREE(plugins.tree), plugin->info->name), NULL, NULL);
322 gnt_tree_set_choice(GNT_TREE(plugins.tree), plugin, purple_plugin_is_loaded(plugin));
323 gnt_tree_set_row_flags(GNT_TREE(plugins.tree), plugin, GNT_TEXT_FLAG_BOLD);
324 gnt_tree_set_selected(GNT_TREE(plugins.tree), plugin);
325 }
326
327 static void
install_plugin_cb(GntWidget * w,gpointer null)328 install_plugin_cb(GntWidget *w, gpointer null)
329 {
330 static int handle;
331
332 purple_request_close_with_handle(&handle);
333 purple_request_file(&handle, _("Select plugin to install"), NULL,
334 FALSE, G_CALLBACK(install_selected_file_cb), NULL,
335 NULL, NULL, NULL, &handle);
336 g_signal_connect_swapped(G_OBJECT(w), "destroy", G_CALLBACK(purple_request_close_with_handle), &handle);
337 }
338
finch_plugins_show_all()339 void finch_plugins_show_all()
340 {
341 GntWidget *window, *tree, *box, *aboot, *button;
342 GList *iter;
343 GList *seen;
344
345 if (plugins.window) {
346 gnt_window_present(plugins.window);
347 return;
348 }
349
350 purple_plugins_probe(G_MODULE_SUFFIX);
351
352 plugins.window = window = gnt_vbox_new(FALSE);
353 gnt_box_set_toplevel(GNT_BOX(window), TRUE);
354 gnt_box_set_title(GNT_BOX(window), _("Plugins"));
355 gnt_box_set_pad(GNT_BOX(window), 0);
356 gnt_box_set_alignment(GNT_BOX(window), GNT_ALIGN_MID);
357
358 gnt_box_add_widget(GNT_BOX(window),
359 gnt_label_new(_("You can (un)load plugins from the following list.")));
360 gnt_box_add_widget(GNT_BOX(window), gnt_hline_new());
361
362 box = gnt_hbox_new(FALSE);
363 gnt_box_add_widget(GNT_BOX(window), box);
364 gnt_box_add_widget(GNT_BOX(window), gnt_hline_new());
365
366 gnt_box_set_pad(GNT_BOX(box), 0);
367 plugins.tree = tree = gnt_tree_new();
368 gnt_tree_set_compare_func(GNT_TREE(tree), (GCompareFunc)plugin_compare);
369 gnt_widget_set_has_border(tree, FALSE);
370 gnt_box_add_widget(GNT_BOX(box), tree);
371 gnt_box_add_widget(GNT_BOX(box), gnt_vline_new());
372
373 plugins.aboot = aboot = gnt_text_view_new();
374 gnt_text_view_set_flag(GNT_TEXT_VIEW(aboot), GNT_TEXT_VIEW_TOP_ALIGN);
375 gnt_widget_set_size(aboot, 40, 20);
376 gnt_box_add_widget(GNT_BOX(box), aboot);
377
378 seen = purple_prefs_get_path_list("/finch/plugins/seen");
379 for (iter = purple_plugins_get_all(); iter; iter = iter->next)
380 {
381 PurplePlugin *plug = iter->data;
382
383 if (plug->info->type == PURPLE_PLUGIN_LOADER) {
384 GList *cur;
385 for (cur = PURPLE_PLUGIN_LOADER_INFO(plug)->exts; cur != NULL;
386 cur = cur->next)
387 purple_plugins_probe(cur->data);
388 continue;
389 }
390
391 if (plug->info->type != PURPLE_PLUGIN_STANDARD ||
392 (plug->info->flags & PURPLE_PLUGIN_FLAG_INVISIBLE) ||
393 plug->error)
394 continue;
395
396 gnt_tree_add_choice(GNT_TREE(tree), plug,
397 gnt_tree_create_row(GNT_TREE(tree), plug->info->name), NULL, NULL);
398 gnt_tree_set_choice(GNT_TREE(tree), plug, purple_plugin_is_loaded(plug));
399 if (!g_list_find_custom(seen, plug->path, (GCompareFunc)strcmp))
400 gnt_tree_set_row_flags(GNT_TREE(tree), plug, GNT_TEXT_FLAG_BOLD);
401 }
402 gnt_tree_set_col_width(GNT_TREE(tree), 0, 30);
403 g_signal_connect(G_OBJECT(tree), "toggled", G_CALLBACK(plugin_toggled_cb), NULL);
404 g_signal_connect(G_OBJECT(tree), "selection_changed", G_CALLBACK(selection_changed), NULL);
405 g_object_set_data(G_OBJECT(tree), "seen-list", seen);
406
407 box = gnt_hbox_new(FALSE);
408 gnt_box_add_widget(GNT_BOX(window), box);
409
410 button = gnt_button_new(_("Install Plugin..."));
411 gnt_box_add_widget(GNT_BOX(box), button);
412 gnt_util_set_trigger_widget(GNT_WIDGET(tree), GNT_KEY_INS, button);
413 g_signal_connect(G_OBJECT(button), "activate", G_CALLBACK(install_plugin_cb), NULL);
414
415 button = gnt_button_new(_("Close"));
416 gnt_box_add_widget(GNT_BOX(box), button);
417 g_signal_connect_swapped(G_OBJECT(button), "activate",
418 G_CALLBACK(gnt_widget_destroy), window);
419
420 plugins.conf = button = gnt_button_new(_("Configure Plugin"));
421 gnt_box_add_widget(GNT_BOX(box), button);
422 g_signal_connect(G_OBJECT(button), "activate", G_CALLBACK(configure_plugin_cb), NULL);
423
424 g_signal_connect(G_OBJECT(window), "destroy", G_CALLBACK(reset_plugin_window), NULL);
425
426 gnt_widget_show(window);
427
428 decide_conf_button(gnt_tree_get_selection_data(GNT_TREE(tree)));
429 }
430
431 static GntWidget*
process_pref_frame(PurplePluginPrefFrame * frame)432 process_pref_frame(PurplePluginPrefFrame *frame)
433 {
434 PurpleRequestField *field;
435 PurpleRequestFields *fields;
436 PurpleRequestFieldGroup *group = NULL;
437 GList *prefs;
438 GList *stringlist = NULL;
439 GntWidget *ret = NULL;
440
441 fields = purple_request_fields_new();
442
443 for (prefs = purple_plugin_pref_frame_get_prefs(frame); prefs; prefs = prefs->next) {
444 PurplePluginPref *pref = prefs->data;
445 PurplePrefType type;
446 const char *name = purple_plugin_pref_get_name(pref);
447 const char *label = purple_plugin_pref_get_label(pref);
448 if(name == NULL) {
449 if(label == NULL)
450 continue;
451
452 if(purple_plugin_pref_get_type(pref) == PURPLE_PLUGIN_PREF_INFO) {
453 field = purple_request_field_label_new("*", purple_plugin_pref_get_label(pref));
454 purple_request_field_group_add_field(group, field);
455 } else {
456 group = purple_request_field_group_new(label);
457 purple_request_fields_add_group(fields, group);
458 }
459 continue;
460 }
461
462 field = NULL;
463 type = purple_prefs_get_type(name);
464 if(purple_plugin_pref_get_type(pref) == PURPLE_PLUGIN_PREF_CHOICE) {
465 GList *list = purple_plugin_pref_get_choices(pref);
466 gpointer current_value = NULL;
467
468 switch(type) {
469 case PURPLE_PREF_BOOLEAN:
470 current_value = g_strdup_printf("%d", (int)purple_prefs_get_bool(name));
471 break;
472 case PURPLE_PREF_INT:
473 current_value = g_strdup_printf("%d", (int)purple_prefs_get_int(name));
474 break;
475 case PURPLE_PREF_STRING:
476 current_value = g_strdup(purple_prefs_get_string(name));
477 break;
478 default:
479 continue;
480 }
481
482 field = purple_request_field_list_new(name, label);
483 purple_request_field_list_set_multi_select(field, FALSE);
484 while (list && list->next) {
485 const char *label = list->data;
486 char *value = NULL;
487 switch(type) {
488 case PURPLE_PREF_BOOLEAN:
489 value = g_strdup_printf("%d", GPOINTER_TO_INT(list->next->data));
490 break;
491 case PURPLE_PREF_INT:
492 value = g_strdup_printf("%d", GPOINTER_TO_INT(list->next->data));
493 break;
494 case PURPLE_PREF_STRING:
495 value = g_strdup(list->next->data);
496 break;
497 default:
498 break;
499 }
500 stringlist = g_list_prepend(stringlist, value);
501 purple_request_field_list_add_icon(field, label, NULL, value);
502 if (purple_strequal(value, current_value))
503 purple_request_field_list_add_selected(field, label);
504 list = list->next->next;
505 }
506 g_free(current_value);
507 } else {
508 switch(type) {
509 case PURPLE_PREF_BOOLEAN:
510 field = purple_request_field_bool_new(name, label, purple_prefs_get_bool(name));
511 break;
512 case PURPLE_PREF_INT:
513 field = purple_request_field_int_new(name, label, purple_prefs_get_int(name));
514 break;
515 case PURPLE_PREF_STRING:
516 field = purple_request_field_string_new(name, label, purple_prefs_get_string(name),
517 purple_plugin_pref_get_format_type(pref) & PURPLE_STRING_FORMAT_TYPE_MULTILINE);
518 break;
519 default:
520 break;
521 }
522 }
523
524 if (field) {
525 if (group == NULL) {
526 group = purple_request_field_group_new(_("Preferences"));
527 purple_request_fields_add_group(fields, group);
528 }
529 purple_request_field_group_add_field(group, field);
530 }
531 }
532
533 ret = purple_request_fields(NULL, _("Preferences"), NULL, NULL, fields,
534 _("Save"), G_CALLBACK(finch_request_save_in_prefs), _("Cancel"), NULL,
535 NULL, NULL, NULL,
536 NULL);
537 g_signal_connect_swapped(G_OBJECT(ret), "destroy", G_CALLBACK(free_stringlist), stringlist);
538 return ret;
539 }
540
541