Add keyboard shortcuts to pluginwindow Load.../Unload buttons.
[claws.git] / src / gtk / pluginwindow.c
1 /*
2  * Claws Mail -- a GTK+ based, lightweight, and fast e-mail client
3  * Copyright (C) 1999-2015 Hiroyuki Yamamoto and the Claws Mail 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 3 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, see <http://www.gnu.org/licenses/>.
17  */
18
19 #ifdef HAVE_CONFIG_H
20 #  include "config.h"
21 #include "claws-features.h"
22 #endif
23
24 #include <glib.h>
25 #include <glib/gi18n.h>
26 #include <string.h>
27
28 #include <gtk/gtk.h>
29 #include <gdk/gdkkeysyms.h>
30
31 #include "defs.h"
32 #include "plugin.h"
33
34 #include "filesel.h"
35 #include "alertpanel.h"
36 #include "prefs_common.h"
37 #include "../inc.h"
38 #include "manual.h"
39 #include "manage_window.h"
40
41 enum {
42         PLUGINWINDOW_NAME,              /*<! plugin name */
43         PLUGINWINDOW_DATA,              /*<! Plugin pointer */
44         PLUGINWINDOW_STYLE,             /*<! italic if error */
45         N_PLUGINWINDOW_COLUMNS
46 };
47
48 typedef struct _PluginWindow
49 {
50         GtkWidget *window;
51         GtkWidget *plugin_list_view;
52         GtkWidget *plugin_desc;
53         GtkWidget *unload_btn;
54
55         Plugin *selected_plugin;
56         
57         gboolean loading;
58 } PluginWindow;
59
60 static GtkListStore* pluginwindow_create_data_store     (void);
61 static GtkWidget *pluginwindow_list_view_create         (PluginWindow *pluginwindow);
62 static void pluginwindow_create_list_view_columns       (GtkWidget *list_view);
63 static gboolean pluginwindow_selected                   (GtkTreeSelection *selector,
64                                                          GtkTreeModel *model, 
65                                                          GtkTreePath *path,
66                                                          gboolean currently_selected,
67                                                          gpointer data);
68
69 static void close_cb(GtkButton *button, PluginWindow *pluginwindow)
70 {
71         if (pluginwindow->loading)
72                 return;
73         gtk_widget_destroy(pluginwindow->window);
74         g_free(pluginwindow);
75         plugin_save_list();
76         inc_unlock();
77 }
78
79 static gint pluginwindow_delete_cb(GtkWidget *widget, GdkEventAny *event,
80                                   PluginWindow *pluginwindow)
81 {
82         if (pluginwindow->loading)
83                 return FALSE;
84         close_cb(NULL,pluginwindow);
85         return TRUE;
86 }
87
88 static void set_plugin_list(PluginWindow *pluginwindow)
89 {
90         GSList *plugins, *cur, *unloaded;
91         const gchar *text;
92         GtkListStore *store;
93         GtkTreeIter iter;
94         GtkTextBuffer *textbuf;
95         GtkTextIter start_iter, end_iter;
96         GtkTreeSelection *selection;
97
98         plugins = plugin_get_list();
99         unloaded = plugin_get_unloaded_list();
100
101         store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW
102                                 (pluginwindow->plugin_list_view)));
103         gtk_tree_sortable_set_sort_column_id(GTK_TREE_SORTABLE(store),
104                                              0, GTK_SORT_ASCENDING);
105         gtk_list_store_clear(store);
106         
107         textbuf = gtk_text_view_get_buffer(GTK_TEXT_VIEW(pluginwindow->plugin_desc));
108         gtk_text_view_set_cursor_visible(GTK_TEXT_VIEW(pluginwindow->plugin_desc), FALSE);
109         gtk_text_view_set_editable(GTK_TEXT_VIEW(pluginwindow->plugin_desc), FALSE);
110         gtk_text_buffer_get_start_iter(textbuf, &start_iter);
111         gtk_text_buffer_get_end_iter(textbuf, &end_iter);
112         gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
113         gtk_widget_set_sensitive(pluginwindow->unload_btn, FALSE);
114
115         for(cur = plugins; cur != NULL; cur = g_slist_next(cur)) {
116                 Plugin *plugin = (Plugin *) cur->data;
117
118                 gtk_list_store_append(store, &iter);
119                 text = plugin_get_name(plugin); 
120                 gtk_list_store_set(store, &iter,
121                                    PLUGINWINDOW_NAME, text,
122                                    PLUGINWINDOW_DATA, plugin,
123                                    PLUGINWINDOW_STYLE, PANGO_STYLE_NORMAL,
124                                    -1);
125         }
126
127         for(cur = unloaded; cur != NULL; cur = g_slist_next(cur)) {
128                 Plugin *plugin = (Plugin *) cur->data;
129
130                 gtk_list_store_append(store, &iter);
131                 text = plugin_get_name(plugin);
132                 gtk_list_store_set(store, &iter,
133                                    PLUGINWINDOW_NAME, text,
134                                    PLUGINWINDOW_DATA, plugin,
135                                    PLUGINWINDOW_STYLE, PANGO_STYLE_ITALIC,
136                                    -1);
137         }
138
139         selection = gtk_tree_view_get_selection(GTK_TREE_VIEW(pluginwindow->plugin_list_view));
140         if (gtk_tree_model_get_iter_first(GTK_TREE_MODEL(store), &iter))
141                 gtk_tree_selection_select_iter(selection, &iter);
142                 
143         g_slist_free(plugins);
144 }
145
146 static void select_row_cb(Plugin *plugin, PluginWindow *pluginwindow)
147 {
148         GtkTextView *plugin_desc = GTK_TEXT_VIEW(pluginwindow->plugin_desc);
149         GtkTextBuffer *textbuf = gtk_text_view_get_buffer(plugin_desc);
150         GtkTextIter start_iter, end_iter;
151         gchar *text;
152
153         pluginwindow->selected_plugin = plugin;
154
155         if (pluginwindow->selected_plugin != NULL) {
156                 const gchar *desc = plugin_get_desc(plugin);
157                 const gchar *err = plugin_get_error(plugin);
158                 gtk_text_buffer_get_start_iter(textbuf, &start_iter);
159                 gtk_text_buffer_get_end_iter(textbuf, &end_iter);
160                 gtk_text_buffer_delete(textbuf, &start_iter, &end_iter);
161                 
162                 if (err == NULL)
163                         text = g_strconcat(desc, _("\n\nVersion: "),
164                                    plugin_get_version(plugin), "\n", NULL);
165                 else
166                         text = g_strconcat(_("Error: "),
167                                    err, "\n", _("Plugin is not functional."), 
168                                    "\n\n", desc, _("\n\nVersion: "),
169                                    plugin_get_version(plugin), "\n", NULL);
170                 gtk_text_buffer_insert(textbuf, &start_iter, text, strlen(text));
171                 g_free(text);
172                 gtk_widget_set_sensitive(pluginwindow->unload_btn, TRUE);
173         } else {
174                 gtk_widget_set_sensitive(pluginwindow->unload_btn, FALSE);
175         }
176 }
177
178 static void unselect_row_cb(Plugin *plugin, PluginWindow *pluginwindow)
179 {
180         gtk_widget_set_sensitive(pluginwindow->unload_btn, FALSE);      
181 }
182
183 static void unload_cb(GtkButton *button, PluginWindow *pluginwindow)
184 {
185         Plugin *plugin = pluginwindow->selected_plugin;
186
187         cm_return_if_fail(plugin != NULL);
188         pluginwindow->loading = TRUE;
189         plugin_unload(plugin);
190         pluginwindow->loading = FALSE;
191         pluginwindow->selected_plugin = NULL;
192         set_plugin_list(pluginwindow);
193 }
194
195 static void load_cb(GtkButton *button, PluginWindow *pluginwindow)
196 {
197         GList *file_list;
198
199         file_list = filesel_select_multiple_files_open_with_filter(
200                         _("Select the Plugins to load"), get_plugin_dir(), 
201                         "*." G_MODULE_SUFFIX);
202
203         if (file_list) {
204                 GList *tmp;
205                 pluginwindow->loading = TRUE;
206                 for ( tmp = file_list; tmp; tmp = tmp->next) {
207                         gchar *file, *error = NULL;
208
209                         file = (gchar *) tmp->data;
210                         if (!file) continue;
211                         plugin_load(file, &error);
212                         if (error != NULL) {
213                                 gchar *basename = g_path_get_basename(file);
214                                 alertpanel_error(
215                                 _("The following error occurred while loading %s:\n\n%s\n"),
216                                 basename, error);
217                                 g_free(basename);
218                                 g_free(error);
219                         }
220
221                         /* FIXME: globally or atom-ly : ? */
222                         set_plugin_list(pluginwindow);
223                         g_free(file);
224                 }
225                 pluginwindow->loading = FALSE;
226                 g_list_free(file_list);
227         }               
228 }
229
230 static gboolean pluginwindow_key_pressed(GtkWidget *widget, GdkEventKey *event,
231                                      PluginWindow *pluginwindow)
232 {
233         if (event) {
234                 switch (event->keyval) {
235                         case GDK_KEY_Escape : 
236                         case GDK_KEY_Return : 
237                         case GDK_KEY_KP_Enter :
238                                 close_cb(NULL, pluginwindow);
239                                 break;
240                         case GDK_KEY_Insert : 
241                         case GDK_KEY_KP_Insert :
242                         case GDK_KEY_KP_Add : 
243                         case GDK_KEY_plus :
244                                 load_cb(NULL, pluginwindow);
245                                 break;
246                         case GDK_KEY_Delete : 
247                         case GDK_KEY_KP_Delete :
248                         case GDK_KEY_KP_Subtract : 
249                         case GDK_KEY_minus :
250                                 unload_cb(NULL, pluginwindow);
251                                 break;
252                         default :
253                                 break;
254                 }
255         }
256         return FALSE;
257 }
258
259 /*!
260  *\brief        Save Gtk object size to prefs dataset
261  */
262 static void pluginwindow_size_allocate_cb(GtkWidget *widget,
263                                          GtkAllocation *allocation)
264 {
265         cm_return_if_fail(allocation != NULL);
266
267         prefs_common.pluginswin_width = allocation->width;
268         prefs_common.pluginswin_height = allocation->height;
269 }
270
271
272 void pluginwindow_create()
273 {
274         PluginWindow *pluginwindow;
275         GtkWidget *window;
276         GtkWidget *vbox1;
277         GtkWidget *hbox2;
278         GtkWidget *scrolledwindow2;
279         GtkWidget *plugin_list_view;
280         GtkWidget *vbox2;
281         GtkWidget *frame2;
282         GtkWidget *label13;
283         GtkWidget *scrolledwindow3;
284         GtkWidget *plugin_desc;
285         GtkWidget *hbuttonbox1;
286         GtkWidget *hbuttonbox2;
287         GtkWidget *help_btn;
288         GtkWidget *load_btn;
289         GtkWidget *unload_btn;
290         GtkWidget *close_btn;
291         gchar *markup, *span;
292         GtkWidget *desc_lbl;
293         GtkWidget *vbox3;
294         GtkWidget *hbox_info;
295         static GdkGeometry geometry;
296
297         debug_print("Creating plugins window...\n");
298
299         pluginwindow = g_new0(PluginWindow, 1);
300
301         window = gtkut_window_new(GTK_WINDOW_TOPLEVEL, "pluginwindow");
302         gtk_container_set_border_width(GTK_CONTAINER(window), 8);
303         gtk_window_set_title(GTK_WINDOW(window), _("Plugins"));
304         gtk_window_set_modal(GTK_WINDOW(window), TRUE);
305         manage_window_set_transient(GTK_WINDOW(window));
306
307         vbox1 = gtk_vbox_new(FALSE, 4);
308         gtk_widget_show(vbox1);
309         gtk_container_add(GTK_CONTAINER(window), vbox1);
310         gtk_box_set_homogeneous(GTK_BOX(vbox1), FALSE);
311         gtk_widget_realize(window);
312
313         hbox2 = gtk_hbox_new(FALSE, 8);
314         gtk_widget_show(hbox2);
315         gtk_box_pack_start(GTK_BOX(vbox1), hbox2, TRUE, TRUE, 0);
316
317         vbox3 = gtk_vbox_new(FALSE, 4);
318         gtk_widget_show(vbox3);
319         gtk_box_pack_start(GTK_BOX(hbox2), vbox3, FALSE, FALSE, 0);
320
321         scrolledwindow2 = gtk_scrolled_window_new(NULL, NULL);
322         gtk_widget_show(scrolledwindow2);
323         gtk_box_pack_start(GTK_BOX(vbox3), scrolledwindow2, TRUE, TRUE, 0);
324         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolledwindow2),
325                                         GTK_SHADOW_ETCHED_IN);
326         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW
327                                        (scrolledwindow2), GTK_POLICY_NEVER,
328                                        GTK_POLICY_AUTOMATIC);
329
330         plugin_list_view = pluginwindow_list_view_create(pluginwindow);
331         gtk_widget_show(plugin_list_view);
332         gtk_container_add(GTK_CONTAINER(scrolledwindow2), plugin_list_view);
333         gtk_widget_grab_focus(GTK_WIDGET(plugin_list_view));
334
335         gtkut_stock_button_set_create(&hbuttonbox1,
336                                 &load_btn, _("_Load..."),
337                                 &unload_btn, _("_Unload"),
338                                 NULL, NULL);
339         gtk_widget_show(hbuttonbox1);
340         gtk_box_pack_start(GTK_BOX(vbox3), hbuttonbox1, FALSE, FALSE, 0);
341         
342         vbox2 = gtk_vbox_new(FALSE, 0);
343         gtk_widget_show(vbox2);
344         gtk_box_pack_start(GTK_BOX(hbox2), vbox2, TRUE, TRUE, 0);
345
346         frame2 = gtk_frame_new(NULL);
347         gtk_widget_show(frame2);
348         gtk_box_pack_start(GTK_BOX(vbox2), frame2, FALSE, TRUE, 0);
349
350         label13 = gtk_label_new(_("Description"));
351         gtk_widget_show(label13);
352         gtk_container_add(GTK_CONTAINER(frame2), label13);
353         gtk_misc_set_alignment(GTK_MISC(label13), 0, 0.5);
354         gtk_misc_set_padding(GTK_MISC(label13), 2, 2);
355
356         scrolledwindow3 = gtk_scrolled_window_new(NULL, NULL);
357         gtk_widget_show(scrolledwindow3);
358         gtk_box_pack_start(GTK_BOX(vbox2), scrolledwindow3, TRUE, TRUE, 0);
359         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolledwindow3),
360                                         GTK_SHADOW_ETCHED_IN);
361         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW
362                                        (scrolledwindow3), GTK_POLICY_NEVER,
363                                        GTK_POLICY_ALWAYS);
364
365         plugin_desc = gtk_text_view_new();
366         gtk_widget_show(plugin_desc);
367         gtk_container_add(GTK_CONTAINER(scrolledwindow3), plugin_desc);
368
369         hbox_info = gtk_hbox_new(FALSE, 5);
370         gtk_widget_show(hbox_info);
371         
372         desc_lbl = gtk_label_new("");
373         span = g_strdup_printf("<a href=\"%s\"><span underline=\"none\">", PLUGINS_URI);
374         markup = g_strdup_printf(_("For more information about plugins see the "
375                                            "%sClaws Mail website%s."), span, "</span></a>");
376         gtk_label_set_markup(GTK_LABEL(desc_lbl), markup);
377         g_free(markup);
378         g_free(span);
379         gtk_misc_set_alignment(GTK_MISC(desc_lbl), 0, 0.5);
380         gtk_widget_show(desc_lbl);
381         gtk_box_pack_start(GTK_BOX(hbox_info), desc_lbl, FALSE, FALSE, 0);
382
383         gtk_box_pack_start(GTK_BOX(hbox_info), gtk_label_new(""), TRUE, TRUE, 0);
384         gtk_box_pack_start(GTK_BOX(vbox1), hbox_info, FALSE, FALSE, 0);
385
386         gtkut_stock_button_set_create_with_help(&hbuttonbox2, &help_btn,
387                         &close_btn, GTK_STOCK_CLOSE,
388                         NULL, NULL, NULL, NULL);
389
390         gtk_box_set_spacing(GTK_BOX(hbuttonbox2), 6);
391         gtk_widget_show(hbuttonbox2);
392         gtk_box_pack_end(GTK_BOX(vbox1), hbuttonbox2, FALSE, FALSE, 0);
393
394         gtk_text_view_set_wrap_mode(GTK_TEXT_VIEW(plugin_desc), GTK_WRAP_WORD);
395         gtk_widget_set_sensitive(GTK_WIDGET(unload_btn), FALSE);
396
397         g_signal_connect(G_OBJECT(help_btn), "clicked",
398                          G_CALLBACK(manual_open_with_anchor_cb),
399                          MANUAL_ANCHOR_PLUGINS);
400         g_signal_connect(G_OBJECT(load_btn), "clicked",
401                          G_CALLBACK(load_cb), pluginwindow);
402         g_signal_connect(G_OBJECT(unload_btn), "clicked",
403                          G_CALLBACK(unload_cb), pluginwindow);
404         g_signal_connect(G_OBJECT(close_btn), "clicked",
405                          G_CALLBACK(close_cb), pluginwindow);
406         g_signal_connect(G_OBJECT(window), "size_allocate",
407                          G_CALLBACK(pluginwindow_size_allocate_cb), NULL);
408         g_signal_connect(G_OBJECT(window), "key_press_event",
409                            G_CALLBACK(pluginwindow_key_pressed), pluginwindow);
410         g_signal_connect(G_OBJECT(window), "delete_event",
411                          G_CALLBACK(pluginwindow_delete_cb), pluginwindow);
412         MANAGE_WINDOW_SIGNALS_CONNECT(window);
413
414         CLAWS_SET_TIP(load_btn,
415                         _("Click here to load one or more plugins"));
416
417         CLAWS_SET_TIP(unload_btn,
418                         _("Unload the selected plugin"));
419
420         pluginwindow->window = window;
421         pluginwindow->plugin_list_view = plugin_list_view;
422         pluginwindow->plugin_desc = plugin_desc;
423         pluginwindow->unload_btn = unload_btn;
424         pluginwindow->selected_plugin = NULL;
425
426         set_plugin_list(pluginwindow);
427
428         inc_lock();
429
430         if (!geometry.min_height) {
431                 geometry.min_width = -1;
432                 geometry.min_height = 300;
433         }
434
435         gtk_window_set_geometry_hints(GTK_WINDOW(window), NULL, &geometry,
436                                       GDK_HINT_MIN_SIZE);
437         gtk_window_set_default_size(GTK_WINDOW(window), prefs_common.pluginswin_width,
438                                     prefs_common.pluginswin_height);
439
440         gtk_widget_show(window);
441 }
442
443 static GtkListStore* pluginwindow_create_data_store(void)
444 {
445         return gtk_list_store_new(N_PLUGINWINDOW_COLUMNS,
446                                   G_TYPE_STRING,        
447                                   G_TYPE_POINTER,
448                                   PANGO_TYPE_STYLE,
449                                   -1);
450 }
451
452 static GtkWidget *pluginwindow_list_view_create(PluginWindow *pluginwindow)
453 {
454         GtkTreeView *list_view;
455         GtkTreeSelection *selector;
456         GtkTreeModel *model;
457
458         model = GTK_TREE_MODEL(pluginwindow_create_data_store());
459         list_view = GTK_TREE_VIEW(gtk_tree_view_new_with_model(model));
460         g_object_unref(model);  
461
462         gtk_tree_view_set_rules_hint(list_view, prefs_common.use_stripes_everywhere);
463         gtk_tree_view_set_search_column (list_view, 0);
464
465         selector = gtk_tree_view_get_selection(list_view);
466         gtk_tree_selection_set_mode(selector, GTK_SELECTION_BROWSE);
467         gtk_tree_selection_set_select_function(selector, pluginwindow_selected,
468                                                pluginwindow, NULL);
469
470         /* create the columns */
471         pluginwindow_create_list_view_columns(GTK_WIDGET(list_view));
472
473         return GTK_WIDGET(list_view);
474 }
475
476 static void pluginwindow_create_list_view_columns(GtkWidget *list_view)
477 {
478         GtkTreeViewColumn *column;
479         GtkCellRenderer *renderer;
480
481         renderer = gtk_cell_renderer_text_new();
482         column = gtk_tree_view_column_new_with_attributes
483                 (_("Loaded plugins"),
484                  renderer,
485                  "text", PLUGINWINDOW_NAME,
486                  "style", PLUGINWINDOW_STYLE,
487                  NULL);
488         gtk_tree_view_append_column(GTK_TREE_VIEW(list_view), column);          
489 }
490
491 static gboolean pluginwindow_selected(GtkTreeSelection *selector,
492                                       GtkTreeModel *model, 
493                                       GtkTreePath *path,
494                                       gboolean currently_selected,
495                                       gpointer data)
496 {
497         GtkTreeIter iter;
498         Plugin *plugin;
499         
500         if (!gtk_tree_model_get_iter(model, &iter, path))
501                 return TRUE;
502
503         gtk_tree_model_get(model, &iter, 
504                            PLUGINWINDOW_DATA, &plugin,
505                            -1);
506
507         if (currently_selected) 
508                 unselect_row_cb(plugin, data);
509         else
510                 select_row_cb(plugin, data);
511
512         return TRUE;
513 }
514