src/plugins.c

   1 /*
   2  * gaim
   3  *
   4  * Copyright (C) 1998-1999, Mark Spencer <markster@marko.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * ----------------
  21  * The Plug-in plug
  22  *
  23  * Plugin support is currently being maintained by Mike Saraf
  24  * msaraf@dwc.edu
  25  *
  26  * Well, I didn't see any work done on it for a while, so I'm going to try
  27  * my hand at it. - Eric warmenhoven@yahoo.com
  28  *
  29  * Mike is my roomate.  I can assure you that he's lazy :-P  -- Rob rob@marko.net
  30  *
  31  */
  32
  33 #ifdef HAVE_CONFIG_H
  34 #include <config.h>
  35 #endif
  36
  37 #ifdef GAIM_PLUGINS
  38
  39 #include <string.h>
  40 #include <sys/time.h>
  41
  42 #include <sys/types.h>
  43 #include <sys/stat.h>
  44
  45 #include <unistd.h>
  46 #include <stdio.h>
  47 #include <stdlib.h>
  48 #include <gtk/gtk.h>
  49 #include "gaim.h"
  50
  51 #include "pixmaps/gnome_add.xpm"
  52 #include "pixmaps/gnome_remove.xpm"
  53 #include "pixmaps/gnome_preferences.xpm"
  54 #include "pixmaps/refresh.xpm"
  55 #include "pixmaps/cancel.xpm"
  56
  57 #define PATHSIZE 1024   /* XXX: stolen from dialogs.c */
  58
  59
  60 /* ------------------ Local Variables ------------------------ */
  61
  62 static GtkWidget *plugin_dialog = NULL;
  63
  64 static GtkWidget *pluglist = NULL;
  65 static GtkWidget *plugtext = NULL;
  66 static GtkWidget *plugwindow = NULL;
  67 static GtkWidget *plugentry = NULL;
  68
  69 static GtkTooltips *tooltips = NULL;
  70
  71 static GtkWidget *config = NULL;
  72 static guint confighandle = 0;
  73 static GtkWidget *reload = NULL;
  74 static GtkWidget *unload = NULL;
  75 extern char *last_dir;
  76
  77 /* --------------- Function Declarations --------------------- */
  78
  79 void show_plugins(GtkWidget *, gpointer);
  80
  81 /* UI button callbacks */
  82 static void unload_plugin_cb(GtkWidget *, gpointer);
  83 static void plugin_reload_cb(GtkWidget *, gpointer);
  84
  85 static const gchar *plugin_makelistname(GModule *);
  86
  87 static void destroy_plugins(GtkWidget *, gpointer);
  88 static void load_file(GtkWidget *, gpointer);
  89 static void load_which_plugin(GtkWidget *, gpointer);
  90 static void list_clicked(GtkWidget *, struct gaim_plugin *);
  91 void update_show_plugins();
  92 static void hide_plugins(GtkWidget *, gpointer);
  93
  94 /* ------------------ Code Below ---------------------------- */
  95
  96 static void destroy_plugins(GtkWidget *w, gpointer data)
  97 {
  98         if (plugin_dialog)
  99                 gtk_widget_destroy(plugin_dialog);
 100         plugin_dialog = NULL;
 101 }
 102
 103 static void load_file(GtkWidget *w, gpointer data)
 104 {
 105         gchar *buf;
 106
 107         if (plugin_dialog) {
 108                 gtk_widget_show(plugin_dialog);
 109                 gdk_window_raise(plugin_dialog->window);
 110                 return;
 111         }
 112
 113         plugin_dialog = gtk_file_selection_new(_("Gaim - Plugin List"));
 114
 115         gtk_file_selection_hide_fileop_buttons(GTK_FILE_SELECTION(plugin_dialog));
 116
 117         if (!last_dir)
 118                 buf = g_strdup(LIBDIR);
 119         else
 120                 buf = g_strconcat(last_dir, G_DIR_SEPARATOR_S, NULL);
 121
 122         gtk_file_selection_set_filename(GTK_FILE_SELECTION(plugin_dialog), buf);
 123         gtk_file_selection_complete(GTK_FILE_SELECTION(plugin_dialog), "*.so");
 124         gtk_signal_connect(GTK_OBJECT(plugin_dialog), "destroy",
 125                            GTK_SIGNAL_FUNC(destroy_plugins), plugin_dialog);
 126
 127         gtk_signal_connect(GTK_OBJECT(GTK_FILE_SELECTION(plugin_dialog)->ok_button),
 128                            "clicked", GTK_SIGNAL_FUNC(load_which_plugin), NULL);
 129
 130         gtk_signal_connect(GTK_OBJECT(GTK_FILE_SELECTION(plugin_dialog)->cancel_button),
 131                            "clicked", GTK_SIGNAL_FUNC(destroy_plugins), NULL);
 132
 133         g_free(buf);
 134         gtk_widget_show(plugin_dialog);
 135         gdk_window_raise(plugin_dialog->window);
 136 }
 137
 138 static void load_which_plugin(GtkWidget *w, gpointer data)
 139 {
 140         char *file;
 141
 142         file = gtk_file_selection_get_filename(GTK_FILE_SELECTION(plugin_dialog));
 143         if (file_is_dir(file, plugin_dialog)) {
 144                 return;
 145         }
 146
 147         if (file)
 148                 load_plugin(file);
 149
 150         if (plugin_dialog)
 151                 gtk_widget_destroy(plugin_dialog);
 152         plugin_dialog = NULL;
 153
 154         update_show_plugins();
 155 }
 156
 157 void show_plugins(GtkWidget *w, gpointer data)
 158 {
 159         /* most of this code was shamelessly stolen from Glade */
 160         GtkWidget *mainvbox;
 161         GtkWidget *tophbox;
 162         GtkWidget *bothbox;
 163         GtkWidget *hbox;
 164         GtkWidget *vbox;
 165         GtkWidget *frame;
 166         GtkWidget *scrolledwindow;
 167         GtkWidget *label;
 168         GtkWidget *add;
 169         GtkWidget *close;
 170
 171         if (plugwindow)
 172                 return;
 173
 174         GAIM_DIALOG(plugwindow);
 175         gtk_window_set_wmclass(GTK_WINDOW(plugwindow), "plugins", "Gaim");
 176         gtk_widget_realize(plugwindow);
 177         aol_icon(plugwindow->window);
 178         gtk_window_set_title(GTK_WINDOW(plugwindow), _("Gaim - Plugins"));
 179         gtk_widget_set_usize(plugwindow, 515, 300);
 180         gtk_signal_connect(GTK_OBJECT(plugwindow), "destroy", GTK_SIGNAL_FUNC(hide_plugins), NULL);
 181
 182         mainvbox = gtk_vbox_new(FALSE, 0);
 183         gtk_container_add(GTK_CONTAINER(plugwindow), mainvbox);
 184         gtk_widget_show(mainvbox);
 185
 186         /* Build the top */
 187         tophbox = gtk_hbox_new(FALSE, 0);
 188         gtk_box_pack_start(GTK_BOX(mainvbox), tophbox, TRUE, TRUE, 0);
 189         gtk_widget_show(tophbox);
 190
 191         /* Left side: frame with list of plugin file names */
 192         frame = gtk_frame_new(_("Loaded Plugins"));
 193         gtk_box_pack_start(GTK_BOX(tophbox), frame, FALSE, FALSE, 0);
 194         gtk_widget_set_usize(frame, 140, -1);
 195         gtk_container_set_border_width(GTK_CONTAINER(frame), 6);
 196         gtk_frame_set_label_align(GTK_FRAME(frame), 0.05, 0.5);
 197         gtk_widget_show(frame);
 198
 199         scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
 200         gtk_container_add(GTK_CONTAINER(frame), scrolledwindow);
 201         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwindow),
 202                                         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 203         gtk_widget_show(scrolledwindow);
 204
 205         pluglist = gtk_list_new();
 206         gtk_list_set_selection_mode(GTK_LIST(pluglist), GTK_SELECTION_BROWSE);
 207         gtk_scrolled_window_add_with_viewport(GTK_SCROLLED_WINDOW(scrolledwindow), pluglist);
 208         gtk_widget_show(pluglist);
 209
 210         /* Right side: frame with description and the filepath of plugin */
 211         frame = gtk_frame_new(_("Description"));
 212         gtk_box_pack_start(GTK_BOX(tophbox), frame, TRUE, TRUE, 0);
 213         gtk_container_set_border_width(GTK_CONTAINER(frame), 6);
 214         gtk_frame_set_label_align(GTK_FRAME(frame), 0.05, 0.5);
 215         gtk_widget_show(frame);
 216
 217         vbox = gtk_vbox_new(FALSE, 0);
 218         gtk_container_add(GTK_CONTAINER(frame), vbox);
 219         gtk_widget_show(vbox);
 220
 221         scrolledwindow = gtk_scrolled_window_new(NULL, NULL);
 222         gtk_box_pack_start(GTK_BOX(vbox), scrolledwindow, TRUE, TRUE, 0);
 223         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolledwindow),
 224                                         GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 225         gtk_widget_show(scrolledwindow);
 226
 227         plugtext = gtk_text_new(NULL, NULL);
 228         gtk_scrolled_window_add_with_viewport(GTK_SCROLLED_WINDOW(scrolledwindow), plugtext);
 229         gtk_text_set_word_wrap(GTK_TEXT(plugtext), TRUE);
 230         gtk_text_set_editable(GTK_TEXT(plugtext), FALSE);
 231         gtk_widget_show(plugtext);
 232
 233         hbox = gtk_hbox_new(FALSE, 5);
 234         gtk_box_pack_start(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 235         gtk_container_set_border_width(GTK_CONTAINER(hbox), 6);
 236         gtk_widget_show(hbox);
 237
 238         label = gtk_label_new(_("Filepath:"));
 239         gtk_box_pack_start(GTK_BOX(hbox), label, FALSE, FALSE, 0);
 240         gtk_widget_show(label);
 241
 242         plugentry = gtk_entry_new();
 243         gtk_box_pack_start(GTK_BOX(hbox), plugentry, TRUE, TRUE, 0);
 244         gtk_entry_set_editable(GTK_ENTRY(plugentry), FALSE);
 245         gtk_widget_show(plugentry);
 246
 247         /* Build the bottom button bar */
 248         bothbox = gtk_hbox_new(TRUE, 10);
 249         gtk_box_pack_start(GTK_BOX(mainvbox), bothbox, FALSE, FALSE, 0);
 250         gtk_container_set_border_width(GTK_CONTAINER(hbox), 5);
 251         gtk_widget_show(bothbox);
 252
 253         if (!tooltips)
 254                 tooltips = gtk_tooltips_new();
 255
 256         add = picture_button(plugwindow, _("Load"), gnome_add_xpm);
 257         gtk_signal_connect(GTK_OBJECT(add), "clicked", GTK_SIGNAL_FUNC(load_file), NULL);
 258         gtk_box_pack_start(GTK_BOX(bothbox), add, TRUE, TRUE, 0);
 259         gtk_tooltips_set_tip(tooltips, add, _("Load a plugin from a file"), "");
 260
 261         config = picture_button(plugwindow, _("Configure"), gnome_preferences_xpm);
 262         gtk_widget_set_sensitive(config, FALSE);
 263         gtk_box_pack_start(GTK_BOX(bothbox), config, TRUE, TRUE, 0);
 264         gtk_tooltips_set_tip(tooltips, config, _("Configure settings of the selected plugin"), "");
 265
 266         reload = picture_button(plugwindow, _("Reload"), refresh_xpm);
 267         gtk_widget_set_sensitive(reload, FALSE);
 268         gtk_signal_connect(GTK_OBJECT(reload), "clicked", GTK_SIGNAL_FUNC(plugin_reload_cb), NULL);
 269         gtk_box_pack_start(GTK_BOX(bothbox), reload, TRUE, TRUE, 0);
 270         gtk_tooltips_set_tip(tooltips, reload, _("Reload the selected plugin"), "");
 271
 272         unload = picture_button(plugwindow, _("Unload"), gnome_remove_xpm);
 273         gtk_signal_connect(GTK_OBJECT(unload), "clicked", GTK_SIGNAL_FUNC(unload_plugin_cb), pluglist);
 274         gtk_box_pack_start(GTK_BOX(bothbox), unload, TRUE, TRUE, 0);
 275         gtk_tooltips_set_tip(tooltips, unload, _("Unload the selected plugin"), "");
 276
 277         close = picture_button(plugwindow, _("Close"), cancel_xpm);
 278         gtk_signal_connect(GTK_OBJECT(close), "clicked", GTK_SIGNAL_FUNC(hide_plugins), NULL);
 279         gtk_box_pack_start(GTK_BOX(bothbox), close, TRUE, TRUE, 0);
 280         gtk_tooltips_set_tip(tooltips, close, _("Close this window"), "");
 281
 282         update_show_plugins();
 283         gtk_widget_show(plugwindow);
 284 }
 285
 286 void update_show_plugins()
 287 {
 288         GList *plugs = plugins;
 289         struct gaim_plugin *p;
 290         GtkWidget *label;
 291         GtkWidget *list_item;
 292         GtkWidget *hbox;
 293
 294         if (plugwindow == NULL)
 295                 return;
 296
 297         gtk_list_clear_items(GTK_LIST(pluglist), 0, -1);
 298         while (plugs) {
 299                 p = (struct gaim_plugin *)plugs->data;
 300                 label = gtk_label_new(plugin_makelistname(p->handle));
 301                 hbox = gtk_hbox_new(FALSE, 0);  /* for left justification */
 302                 gtk_box_pack_start(GTK_BOX(hbox), label, FALSE, FALSE, 0);
 303
 304                 list_item = gtk_list_item_new();
 305                 gtk_container_add(GTK_CONTAINER(list_item), hbox);
 306                 gtk_signal_connect(GTK_OBJECT(list_item), "select", GTK_SIGNAL_FUNC(list_clicked), p);
 307                 gtk_object_set_user_data(GTK_OBJECT(list_item), p);
 308
 309                 gtk_widget_show(hbox);
 310                 gtk_widget_show(label);
 311                 gtk_container_add(GTK_CONTAINER(pluglist), list_item);
 312                 gtk_widget_show(list_item);
 313
 314                 plugs = g_list_next(plugs);
 315         }
 316
 317         /* Clear the display if nothing's selected */
 318         if (GTK_LIST(pluglist)->selection == NULL) {
 319                 guint text_len = gtk_text_get_length(GTK_TEXT(plugtext));
 320                 gtk_text_set_point(GTK_TEXT(plugtext), 0);
 321                 gtk_text_forward_delete(GTK_TEXT(plugtext), text_len);
 322                 gtk_entry_set_text(GTK_ENTRY(plugentry), "");
 323
 324                 gtk_widget_set_sensitive(config, FALSE);
 325                 gtk_widget_set_sensitive(reload, FALSE);
 326                 gtk_widget_set_sensitive(unload, FALSE);
 327         }
 328 }
 329
 330 static void unload_plugin_cb(GtkWidget *w, gpointer data)
 331 {
 332         GList *i;
 333         struct gaim_plugin *p;
 334
 335         i = GTK_LIST(pluglist)->selection;
 336
 337         if (i == NULL)
 338                 return;
 339
 340         p = gtk_object_get_user_data(GTK_OBJECT(i->data));
 341
 342         unload_plugin(p);
 343         update_show_plugins();
 344 }
 345
 346 static void plugin_reload_cb(GtkWidget *w, gpointer data)
 347 {
 348         GList *i;
 349         struct gaim_plugin *p;
 350
 351         i = GTK_LIST(pluglist)->selection;
 352         if (i == NULL)
 353                 return;
 354
 355         /* Just pass off plugin to the actual function */
 356         p = reload_plugin(gtk_object_get_user_data(GTK_OBJECT(i->data)));
 357
 358         update_show_plugins();
 359
 360         /* Try and reselect the plugin in list */
 361         if (!pluglist)
 362                 return;
 363         gtk_list_select_item(GTK_LIST(pluglist), g_list_index(plugins, p));
 364 }
 365
 366 static void list_clicked(GtkWidget *w, struct gaim_plugin *p)
 367 {
 368         gchar *temp;
 369         guint text_len;
 370         void (*gaim_plugin_config)();
 371
 372         if (confighandle != 0)
 373                 gtk_signal_disconnect(GTK_OBJECT(config), confighandle);
 374
 375         text_len = gtk_text_get_length(GTK_TEXT(plugtext));
 376         gtk_text_set_point(GTK_TEXT(plugtext), 0);
 377         gtk_text_forward_delete(GTK_TEXT(plugtext), text_len);
 378
 379         temp = g_strdup_printf("Name:   %s\n\nDescription:\n%s",
 380                                (p->name != NULL) ? p->name : "",
 381                                (p->description != NULL) ? p->description : "");
 382         gtk_text_insert(GTK_TEXT(plugtext), NULL, NULL, NULL, temp, -1);
 383         g_free(temp);
 384         gtk_entry_set_text(GTK_ENTRY(plugentry), g_module_name(p->handle));
 385
 386         /* Find out if this plug-in has a configuration function */
 387         if (g_module_symbol(p->handle, "gaim_plugin_config", (gpointer *)&gaim_plugin_config)) {
 388                 confighandle = gtk_signal_connect(GTK_OBJECT(config), "clicked",
 389                                                   GTK_SIGNAL_FUNC(gaim_plugin_config), NULL);
 390                 gtk_widget_set_sensitive(config, TRUE);
 391         } else {
 392                 confighandle = 0;
 393                 gtk_widget_set_sensitive(config, FALSE);
 394         }
 395
 396         gtk_widget_set_sensitive(reload, TRUE);
 397         gtk_widget_set_sensitive(unload, TRUE);
 398 }
 399
 400 static void hide_plugins(GtkWidget *w, gpointer data)
 401 {
 402         if (plugwindow)
 403                 gtk_widget_destroy(plugwindow);
 404         plugwindow = NULL;
 405         config = NULL;
 406         confighandle = 0;
 407 }
 408
 409 static const gchar *plugin_makelistname(GModule *module)
 410 {
 411         static gchar filename[PATHSIZE];
 412         gchar *filepath = g_module_name(module);
 413         char *cp;
 414
 415         if (filepath == NULL || strlen(filepath) == 0)
 416                 return NULL;
 417
 418         if ((cp = strrchr(filepath, '/')) == NULL || *++cp == '\0')
 419                 cp = filepath;
 420
 421         strncpy(filename, cp, sizeof(filename));
 422         filename[sizeof(filename) - 1] = '\0';
 423
 424         /* Try to pretty name by removing any trailing ".so" */
 425         if (strlen(filename) > 3 &&
 426             strncmp(filename + strlen(filename) - 3, ".so", 3) == 0)
 427                 filename[strlen(filename) - 3] = '\0';
 428
 429         return filename;
 430 }
 431
 432 #endif