1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
|
/*
* Copyright (C) 2006-2008 Hong Jen Yee (PCMan) <pcman.tw@gmail.com>
* 2006-2008 Jim Huang <jserv.tw@gmail.com>
* 2008 Fred Chien <fred@lxde.org>
* 2009-2010 Marty Jack <martyj19@comcast.net>
* 2014-2016 Andriy Grytsenko <andrej@rep.kiev.ua>
*
* This file is a part of LXPanel project.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "private.h"
#include <gdk-pixbuf/gdk-pixbuf.h>
#include <gdk-pixbuf-xlib/gdk-pixbuf-xlib.h>
#include <gdk/gdk.h>
#include <string.h>
#include <stdlib.h>
#include "misc.h"
#include <glib-object.h>
#include <glib/gi18n.h>
#include <libfm/fm-gtk.h>
//#define DEBUG
#include "dbg.h"
#include "gtk-compat.h"
#if GTK_CHECK_VERSION(3, 0, 0)
#include <gtk/gtkx.h>
#endif
static void plugin_class_unref(PluginClass * pc);
GQuark lxpanel_plugin_qinit;
GQuark lxpanel_plugin_qconf;
GQuark lxpanel_plugin_qdata;
GQuark lxpanel_plugin_qsize;
static GHashTable *_all_types = NULL;
/* Dynamic parameter for static (built-in) plugins must be FALSE so we will not try to unload them */
#define REGISTER_STATIC_PLUGIN_CLASS(pc) \
do {\
extern PluginClass pc;\
register_plugin_class(&pc, FALSE);\
} while (0)
static inline const LXPanelPluginInit *_find_plugin(const char *name)
{
return g_hash_table_lookup(_all_types, name);
}
static GtkWidget *_old_plugin_config(LXPanel *panel, GtkWidget *instance)
{
const LXPanelPluginInit *init = PLUGIN_CLASS(instance);
Plugin * plugin;
g_return_val_if_fail(init != NULL && init->new_instance == NULL, NULL);
plugin = lxpanel_plugin_get_data(instance);
if (plugin->class->config)
plugin->class->config(plugin, GTK_WINDOW(panel));
return NULL;
}
static void _old_plugin_reconfigure(LXPanel *panel, GtkWidget *instance)
{
const LXPanelPluginInit *init = PLUGIN_CLASS(instance);
Plugin * plugin;
g_return_if_fail(init != NULL && init->new_instance == NULL);
plugin = lxpanel_plugin_get_data(instance);
if (plugin->class->panel_configuration_changed)
plugin->class->panel_configuration_changed(plugin);
}
/* Register a PluginClass. */
static void register_plugin_class(PluginClass * pc, gboolean dynamic)
{
LXPanelPluginInit *init = g_new0(LXPanelPluginInit, 1);
init->_reserved1 = pc;
init->name = pc->name;
init->description = pc->description;
if (pc->config)
init->config = _old_plugin_config;
if (pc->panel_configuration_changed)
init->reconfigure = _old_plugin_reconfigure;
init->one_per_system = pc->one_per_system;
init->expand_available = pc->expand_available;
init->expand_default = pc->expand_default;
pc->dynamic = dynamic;
g_hash_table_insert(_all_types, g_strdup(pc->type), init);
}
/* Load a dynamic plugin. */
static void plugin_load_dynamic(const char * type, const gchar * path)
{
PluginClass * pc = NULL;
/* Load the external module. */
GModule * m = g_module_open(path, G_MODULE_BIND_LAZY);
if (m != NULL)
{
/* Formulate the name of the expected external variable of type PluginClass. */
char class_name[128];
g_snprintf(class_name, sizeof(class_name), "%s_plugin_class", type);
/* Validate that the external variable is of type PluginClass. */
gpointer tmpsym;
if (( ! g_module_symbol(m, class_name, &tmpsym)) /* Ensure symbol is present */
|| ((pc = tmpsym) == NULL)
|| (pc->structure_size != sizeof(PluginClass)) /* Then check versioning information */
|| (pc->structure_version != PLUGINCLASS_VERSION)
|| (strcmp(type, pc->type) != 0)) /* Then and only then access other fields; check name */
{
g_module_close(m);
g_warning("%s.so is not a lxpanel plugin", type);
return;
}
/* Register the newly loaded and valid plugin. */
pc->gmodule = m;
register_plugin_class(pc, TRUE);
pc->count = 1;
}
}
/* Unreference a dynamic plugin. */
static void plugin_class_unref(PluginClass * pc)
{
pc->count -= 1;
/* If the reference count drops to zero, unload the plugin if it is dynamic and has declared itself unloadable. */
if ((pc->count == 0)
&& (pc->dynamic)
&& ( ! pc->not_unloadable))
{
g_module_close(pc->gmodule);
}
}
/* Loads all available old type plugins. Should be removed in future releases. */
static void plugin_get_available_classes(void)
{
#ifndef DISABLE_PLUGINS_LOADING
GDir * dir = g_dir_open(PACKAGE_LIB_DIR "/lxpanel/plugins", 0, NULL);
if (dir != NULL)
{
const char * file;
while ((file = g_dir_read_name(dir)) != NULL)
{
if (g_str_has_suffix(file, ".so"))
{
char * type = g_strndup(file, strlen(file) - 3);
if (_find_plugin(type) == NULL)
{
/* If it has not been loaded, do it. If successful, add it to the result. */
char * path = g_build_filename(PACKAGE_LIB_DIR "/lxpanel/plugins", file, NULL );
plugin_load_dynamic(type, path);
g_free(path);
}
g_free(type);
}
}
g_dir_close(dir);
}
#endif
}
/* Recursively set the background of all widgets on a panel background configuration change. */
void plugin_widget_set_background(GtkWidget * w, LXPanel * panel)
{
if (w != NULL)
{
if (gtk_widget_get_has_window(w))
{
Panel *p = panel->priv;
gtk_widget_set_app_paintable(w, ((p->background) || (p->transparent)));
if (gtk_widget_get_realized(w))
{
GdkWindow *window = gtk_widget_get_window(w);
#if GTK_CHECK_VERSION(3, 0, 0)
gdk_window_set_background_pattern(window, NULL);
#else
gdk_window_set_back_pixmap(window, NULL, TRUE);
#endif
if ((p->background) || (p->transparent))
/* Reset background for the child, using background of panel */
gdk_window_invalidate_rect(window, NULL, TRUE);
else
/* Set background according to the current GTK style. */
gtk_style_set_background(gtk_widget_get_style(w), window,
GTK_STATE_NORMAL);
}
}
/* Special handling to get tray icons redrawn. */
if (GTK_IS_SOCKET(w))
{
gtk_widget_hide(w);
gdk_window_process_all_updates();
gtk_widget_show(w);
gdk_window_process_all_updates();
}
/* Recursively process all children of a container. */
if (GTK_IS_CONTAINER(w))
gtk_container_foreach(GTK_CONTAINER(w), (GtkCallback) plugin_widget_set_background, panel);
}
}
/* Handler for "button_press_event" signal with Plugin as parameter.
* External so can be used from a plugin. */
static gboolean lxpanel_plugin_button_press_event(GtkWidget *plugin, GdkEventButton *event, LXPanel *panel)
{
if (event->button == 3 && /* right button */
(event->state & gtk_accelerator_get_default_mod_mask()) == 0) /* no key */
{
GtkMenu* popup = (GtkMenu*)lxpanel_get_plugin_menu(panel, plugin, FALSE);
gtk_menu_popup(popup, NULL, NULL, NULL, NULL, event->button, event->time);
return TRUE;
}
return FALSE;
}
/* for old plugins compatibility */
gboolean plugin_button_press_event(GtkWidget *widget, GdkEventButton *event, Plugin *plugin)
{
return lxpanel_plugin_button_press_event(plugin->pwid, event, PLUGIN_PANEL(plugin->pwid));
}
/* Helper for position-calculation callback for popup menus. */
void lxpanel_plugin_popup_set_position_helper(LXPanel * p, GtkWidget * near, GtkWidget * popup, gint * px, gint * py)
{
gint x, y;
GtkAllocation allocation;
GtkAllocation popup_req;
GdkScreen *screen = NULL;
gint monitor;
/* Get the allocation of the popup menu. */
gtk_widget_realize(popup);
gtk_widget_get_allocation(popup, &popup_req);
if (gtk_widget_is_toplevel(popup))
{
GdkRectangle extents;
/* FIXME: can we wait somehow for WM drawing decorations? */
gdk_window_process_all_updates();
gdk_window_get_frame_extents(gtk_widget_get_window(popup), &extents);
popup_req.width = extents.width;
popup_req.height = extents.height;
}
/* Get the origin of the requested-near widget in screen coordinates. */
gtk_widget_get_allocation(near, &allocation);
gdk_window_get_origin(gtk_widget_get_window(near), &x, &y);
if (!gtk_widget_get_has_window(near))
{
/* For non-window widgets allocation is given within the screen */
x += allocation.x;
y += allocation.y;
}
/* Dispatch on edge to lay out the popup menu with respect to the button.
* Also set "push-in" to avoid any case where it might flow off screen. */
switch (p->priv->edge)
{
case EDGE_TOP: y += allocation.height; break;
case EDGE_BOTTOM: y -= popup_req.height; break;
case EDGE_LEFT: x += allocation.width; break;
case EDGE_RIGHT: x -= popup_req.width; break;
}
/* Push onscreen. */
if (gtk_widget_has_screen(near))
screen = gtk_widget_get_screen(near);
else
/* panel as a GtkWindow always has a screen */
screen = gtk_widget_get_screen(GTK_WIDGET(p));
monitor = gdk_screen_get_monitor_at_point(screen, x, y);
#if GTK_CHECK_VERSION(3, 4, 0)
gdk_screen_get_monitor_workarea(screen, monitor, &allocation);
#else
gdk_screen_get_monitor_geometry(screen, monitor, &allocation);
#endif
x = CLAMP(x, allocation.x, allocation.x + allocation.width - popup_req.width);
y = CLAMP(y, allocation.y, allocation.y + allocation.height - popup_req.height);
*px = x;
*py = y;
}
/* for old plugins compatibility -- popup_req is ignored here */
void plugin_popup_set_position_helper(Plugin * p, GtkWidget * near, GtkWidget * popup, GtkRequisition * popup_req, gint * px, gint * py)
{
lxpanel_plugin_popup_set_position_helper(p->panel->topgwin, near, popup, px, py);
}
/* Adjust the position of a popup window to ensure that it is not hidden by the panel.
* It is observed that some window managers do not honor the strut that is set on the panel. */
void lxpanel_plugin_adjust_popup_position(GtkWidget * popup, GtkWidget * parent)
{
gint x, y;
/* Calculate desired position for the popup. */
lxpanel_plugin_popup_set_position_helper(PLUGIN_PANEL(parent), parent,
popup, &x, &y);
/* Move the popup to position. */
gdk_window_move(gtk_widget_get_window(popup), x, y);
}
/* for old plugins compatibility */
void plugin_adjust_popup_position(GtkWidget * popup, Plugin * plugin)
{
lxpanel_plugin_adjust_popup_position(popup, plugin->pwid);
}
/* Open a specified path in a file manager. */
static gboolean _open_dir_in_file_manager(GAppLaunchContext* ctx, GList* folder_infos,
gpointer user_data, GError** err)
{
FmFileInfo *fi = folder_infos->data; /* only first is used */
GAppInfo *app = g_app_info_get_default_for_type("inode/directory", TRUE);
GFile *gf;
gboolean ret;
if (app == NULL)
{
g_set_error_literal(err, G_SHELL_ERROR, G_SHELL_ERROR_EMPTY_STRING,
_("No file manager is configured."));
return FALSE;
}
gf = fm_path_to_gfile(fm_file_info_get_path(fi));
folder_infos = g_list_prepend(NULL, gf);
ret = fm_app_info_launch(app, folder_infos, ctx, err);
g_list_free(folder_infos);
g_object_unref(gf);
g_object_unref(app);
return ret;
}
gboolean lxpanel_launch_path(LXPanel *panel, FmPath *path)
{
return fm_launch_path_simple(NULL, NULL, path, _open_dir_in_file_manager, NULL);
}
void lxpanel_plugin_show_config_dialog(GtkWidget* plugin)
{
const LXPanelPluginInit *init = PLUGIN_CLASS(plugin);
LXPanel *panel = PLUGIN_PANEL(plugin);
GtkWidget *dlg = panel->priv->plugin_pref_dialog;
if (dlg && g_object_get_data(G_OBJECT(dlg), "generic-config-plugin") == plugin)
return; /* configuration dialog is already shown for this widget */
g_return_if_fail(panel != NULL);
dlg = init->config(panel, plugin);
if (dlg)
_panel_show_config_dialog(panel, plugin, dlg);
}
#if GLIB_CHECK_VERSION(2, 32, 0)
static GRecMutex _mutex;
#else
static GStaticRecMutex _mutex = G_STATIC_REC_MUTEX_INIT;
#endif
#ifndef DISABLE_PLUGINS_LOADING
FM_MODULE_DEFINE_TYPE(lxpanel_gtk, LXPanelPluginInit, 1)
static gboolean fm_module_callback_lxpanel_gtk(const char *name, gpointer init, int ver)
{
/* ignore ver for now, only 1 exists */
return lxpanel_register_plugin_type(name, init);
}
#endif
static gboolean old_plugins_loaded = FALSE;
void lxpanel_prepare_modules(void)
{
_all_types = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, NULL);
lxpanel_plugin_qdata = g_quark_from_static_string("LXPanel::plugin-data");
lxpanel_plugin_qinit = g_quark_from_static_string("LXPanel::plugin-init");
lxpanel_plugin_qconf = g_quark_from_static_string("LXPanel::plugin-conf");
lxpanel_plugin_qsize = g_quark_from_static_string("LXPanel::plugin-size");
#ifndef DISABLE_PLUGINS_LOADING
fm_modules_add_directory(PACKAGE_LIB_DIR "/lxpanel/plugins");
fm_module_register_lxpanel_gtk();
#endif
}
void lxpanel_unload_modules(void)
{
GHashTableIter iter;
gpointer key, val;
g_hash_table_iter_init(&iter, _all_types);
while(g_hash_table_iter_next(&iter, &key, &val))
{
register const LXPanelPluginInit *init = val;
if (init->new_instance == NULL) /* old type of plugin */
{
plugin_class_unref(init->_reserved1);
g_free(val);
}
}
g_hash_table_destroy(_all_types);
#ifndef DISABLE_PLUGINS_LOADING
fm_module_unregister_type("lxpanel_gtk");
#endif
old_plugins_loaded = FALSE;
}
gboolean lxpanel_register_plugin_type(const char *name, const LXPanelPluginInit *init)
{
const LXPanelPluginInit *data;
/* validate it */
if (init->new_instance == NULL || name == NULL || name[0] == '\0')
return FALSE;
#if GLIB_CHECK_VERSION(2, 32, 0)
g_rec_mutex_lock(&_mutex);
#else
g_static_rec_mutex_lock(&_mutex);
#endif
/* test if it's registered already */
data = _find_plugin(name);
if (data == NULL)
{
if (init->init)
init->init();
g_hash_table_insert(_all_types, g_strdup(name), (gpointer)init);
}
#if GLIB_CHECK_VERSION(2, 32, 0)
g_rec_mutex_unlock(&_mutex);
#else
g_static_rec_mutex_unlock(&_mutex);
#endif
return (data == NULL);
}
static void _old_plugin_save_hook(const config_setting_t * setting, FILE * f, gpointer user_data)
{
Plugin *pl = user_data;
PluginClass *pc = pl->class;
if (pc->save)
pc->save(pl, f);
}
/* This is called right before Plugin instance is destroyed */
static void _old_plugin_destroy(gpointer data)
{
Plugin *pl = data;
plugin_class_unref(pl->class);
/* Free the Plugin structure. */
g_free(pl);
}
static void _on_old_widget_destroy(GtkWidget *widget, Plugin *pl)
{
/* Never let run it again. */
g_signal_handlers_disconnect_by_func(widget, _on_old_widget_destroy, pl);
/* Run the destructor before destroying the top level widget.
* This prevents problems with the plugin destroying child widgets. */
pl->class->destructor(pl);
}
static void on_size_allocate(GtkWidget *widget, GdkRectangle *allocation, LXPanel *p)
{
GdkRectangle *alloc;
alloc = g_object_get_qdata(G_OBJECT(widget), lxpanel_plugin_qsize);
if (alloc->x == allocation->x && alloc->y == allocation->y &&
alloc->width == allocation->width && alloc->height == allocation->height)
return; /* not changed */
*alloc = *allocation;
/* g_debug("size-allocate on %s", PLUGIN_CLASS(widget)->name); */
plugin_widget_set_background(widget, p);
// _panel_queue_update_background(p);
// _queue_panel_calculate_size(p);
}
GtkWidget *lxpanel_add_plugin(LXPanel *p, const char *name, config_setting_t *cfg, gint at)
{
const LXPanelPluginInit *init;
GtkWidget *widget;
config_setting_t *s, *pconf;
gint expand, padding = 0, border = 0, i;
CHECK_MODULES();
if (!old_plugins_loaded)
plugin_get_available_classes();
old_plugins_loaded = TRUE;
init = _find_plugin(name);
if (init == NULL)
return NULL;
/* prepare widget settings */
if (!init->expand_available)
expand = 0;
else if ((s = config_setting_get_member(cfg, "expand")))
expand = config_setting_get_int(s);
else
expand = init->expand_default;
s = config_setting_get_member(cfg, "padding");
if (s)
padding = config_setting_get_int(s);
s = config_setting_get_member(cfg, "border");
/* FIXME: this is useless setting, it should be 0 or panel becomes weird */
if (s)
border = config_setting_get_int(s);
/* prepare config and create it if need */
s = config_setting_add(cfg, "", PANEL_CONF_TYPE_LIST);
for (i = 0; (pconf = config_setting_get_elem(s, i)); i++)
if (strcmp(config_setting_get_name(pconf), "Config") == 0)
break;
if (!pconf)
pconf = config_setting_add(s, "Config", PANEL_CONF_TYPE_GROUP);
/* If this plugin can only be instantiated once, count the instantiation.
* This causes the configuration system to avoid displaying the plugin as one that can be added. */
if (init->new_instance) /* new style of plugin */
{
widget = init->new_instance(p, pconf);
if (widget == NULL)
return widget;
/* always connect lxpanel_plugin_button_press_event() */
g_signal_connect(widget, "button-press-event",
G_CALLBACK(lxpanel_plugin_button_press_event), p);
if (init->button_press_event)
g_signal_connect(widget, "button-press-event",
G_CALLBACK(init->button_press_event), p);
}
else
{
Plugin *pl = g_new0(Plugin, 1);
PluginClass *pc = init->_reserved1;
char *conf = config_setting_to_string(pconf), *fp;
pl->class = pc;
pl->panel = p->priv;
widget = NULL;
fp = &conf[9]; /* skip "Config {\n" */
/* g_debug("created conf: %s",conf); */
/* Call the constructor.
* It is responsible for parsing the parameters, and setting "pwid" to the top level widget. */
if (pc->constructor(pl, &fp))
widget = pl->pwid;
g_free(conf);
if (widget == NULL) /* failed */
{
g_free(pl);
return widget;
}
pc->count += 1;
g_signal_connect(widget, "destroy", G_CALLBACK(_on_old_widget_destroy), pl);
config_setting_set_save_hook(pconf, _old_plugin_save_hook, pl);
lxpanel_plugin_set_data(widget, pl, _old_plugin_destroy);
}
gtk_widget_set_name(widget, name);
gtk_box_pack_start(GTK_BOX(p->priv->box), widget, expand, TRUE, padding);
if (at >= 0)
gtk_box_reorder_child(GTK_BOX(p->priv->box), widget, at);
gtk_container_set_border_width(GTK_CONTAINER(widget), border);
g_signal_connect(widget, "size-allocate", G_CALLBACK(on_size_allocate), p);
gtk_widget_show(widget);
g_object_set_qdata(G_OBJECT(widget), lxpanel_plugin_qconf, cfg);
g_object_set_qdata(G_OBJECT(widget), lxpanel_plugin_qinit, (gpointer)init);
g_object_set_qdata_full(G_OBJECT(widget), lxpanel_plugin_qsize,
g_new0(GdkRectangle, 1), g_free);
return widget;
}
/* transfer none - note that not all fields are valid there */
GHashTable *lxpanel_get_all_types(void)
{
return _all_types;
}
|