Pileus Git - ~andy/gtk/blob - gdk/x11/xsettings-client.c

   1 /*
   2  * Copyright © 2001, 2007 Red Hat, Inc.
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that
   7  * copyright notice and this permission notice appear in supporting
   8  * documentation, and that the name of Red Hat not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  Red Hat makes no representations about the
  11  * suitability of this software for any purpose.  It is provided "as is"
  12  * without express or implied warranty.
  13  *
  14  * RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL RED HAT
  16  * BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  17  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
  18  * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
  19  * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  20  *
  21  * Author:  Owen Taylor, Red Hat, Inc.
  22  */
  23
  24 #include "config.h"
  25
  26 #include "xsettings-client.h"
  27
  28 #include <gdk/x11/gdkx11display.h>
  29 #include <gdk/x11/gdkx11property.h>
  30 #include <gdk/x11/gdkx11screen.h>
  31 #include <gdk/x11/gdkx11window.h>
  32 #include <gdk/x11/gdkscreen-x11.h>
  33
  34 #include <gdkinternals.h>
  35
  36 #include <string.h>
  37
  38 #include <X11/Xlib.h>
  39 #include <X11/Xmd.h>            /* For CARD16 */
  40
  41 #include "gdksettings.c"
  42
  43 typedef struct _XSettingsBuffer  XSettingsBuffer;
  44
  45 struct _XSettingsBuffer
  46 {
  47   char byte_order;
  48   size_t len;
  49   unsigned char *data;
  50   unsigned char *pos;
  51 };
  52
  53 struct _XSettingsClient
  54 {
  55   GdkScreen *screen;
  56
  57   GdkWindow *manager_window;
  58   Atom selection_atom;
  59
  60   GHashTable *settings; /* string of GDK settings name => XSettingsSetting */
  61 };
  62
  63 static void
  64 gdk_xsettings_notify (const char       *name,
  65                       GdkSettingAction  action,
  66                       XSettingsSetting *setting,
  67                       GdkScreen        *screen)
  68 {
  69   GdkEvent new_event;
  70   GdkX11Screen *x11_screen = GDK_X11_SCREEN (screen);
  71
  72   if (x11_screen->xsettings_in_init)
  73     return;
  74
  75   new_event.type = GDK_SETTING;
  76   new_event.setting.window = gdk_screen_get_root_window (screen);
  77   new_event.setting.send_event = FALSE;
  78   new_event.setting.action = action;
  79   new_event.setting.name = (char*) name;
  80
  81   gdk_event_put (&new_event);
  82 }
  83
  84 static void
  85 notify_changes (XSettingsClient *client,
  86                 GHashTable      *old_list)
  87 {
  88   GHashTableIter iter;
  89   XSettingsSetting *setting, *old_setting;
  90   const char *name;
  91
  92   if (client->settings != NULL)
  93     {
  94       g_hash_table_iter_init (&iter, client->settings);
  95       while (g_hash_table_iter_next (&iter, (gpointer *) &name, (gpointer*) &setting))
  96         {
  97           old_setting = old_list ? g_hash_table_lookup (old_list, name) : NULL;
  98
  99           if (old_setting == NULL)
 100             gdk_xsettings_notify (name, GDK_SETTING_ACTION_NEW, setting, client->screen);
 101           else if (!xsettings_setting_equal (setting, old_setting))
 102             gdk_xsettings_notify (name, GDK_SETTING_ACTION_CHANGED, setting, client->screen);
 103
 104           /* remove setting from old_list */
 105           if (old_setting != NULL)
 106             g_hash_table_remove (old_list, name);
 107         }
 108     }
 109
 110   if (old_list != NULL)
 111     {
 112       /* old_list now contains only deleted settings */
 113       g_hash_table_iter_init (&iter, old_list);
 114       while (g_hash_table_iter_next (&iter, (gpointer *) &name, (gpointer*) &old_setting))
 115         gdk_xsettings_notify (name, GDK_SETTING_ACTION_DELETED, NULL, client->screen);
 116     }
 117 }
 118
 119 #define BYTES_LEFT(buffer) ((buffer)->data + (buffer)->len - (buffer)->pos)
 120
 121 #define return_if_fail_bytes(buffer, n_bytes) G_STMT_START{ \
 122   if (BYTES_LEFT (buffer) < (n_bytes)) \
 123     { \
 124       g_warning ("Invalid XSETTINGS property (read off end: Expected %u bytes, only %ld left", \
 125                  (n_bytes), BYTES_LEFT (buffer)); \
 126       return FALSE; \
 127     } \
 128 }G_STMT_END
 129
 130 static gboolean
 131 fetch_card16 (XSettingsBuffer *buffer,
 132               CARD16          *result)
 133 {
 134   CARD16 x;
 135
 136   return_if_fail_bytes (buffer, 2);
 137
 138   x = *(CARD16 *)buffer->pos;
 139   buffer->pos += 2;
 140
 141   if (buffer->byte_order == MSBFirst)
 142     *result = GUINT16_FROM_BE (x);
 143   else
 144     *result = GUINT16_FROM_LE (x);
 145
 146   return TRUE;
 147 }
 148
 149 static gboolean
 150 fetch_ushort (XSettingsBuffer *buffer,
 151               unsigned short  *result)
 152 {
 153   CARD16 x;
 154   gboolean r;
 155
 156   r = fetch_card16 (buffer, &x);
 157   if (r)
 158     *result = x;
 159
 160   return r;
 161 }
 162
 163 static gboolean
 164 fetch_card32 (XSettingsBuffer *buffer,
 165               CARD32          *result)
 166 {
 167   CARD32 x;
 168
 169   return_if_fail_bytes (buffer, 4);
 170
 171   x = *(CARD32 *)buffer->pos;
 172   buffer->pos += 4;
 173
 174   if (buffer->byte_order == MSBFirst)
 175     *result = GUINT32_FROM_BE (x);
 176   else
 177     *result = GUINT32_FROM_LE (x);
 178
 179   return TRUE;
 180 }
 181
 182 static gboolean
 183 fetch_card8 (XSettingsBuffer *buffer,
 184              CARD8           *result)
 185 {
 186   return_if_fail_bytes (buffer, 1);
 187
 188   *result = *(CARD8 *)buffer->pos;
 189   buffer->pos += 1;
 190
 191   return TRUE;
 192 }
 193
 194 #define XSETTINGS_PAD(n,m) ((n + m - 1) & (~(m-1)))
 195
 196 static gboolean
 197 fetch_string (XSettingsBuffer  *buffer,
 198               guint             length,
 199               char            **result)
 200 {
 201   guint pad_len;
 202
 203   pad_len = XSETTINGS_PAD (length, 4);
 204   if (pad_len < length) /* guard against overflow */
 205     {
 206       g_warning ("Invalid XSETTINGS property (overflow in string length)");
 207       return FALSE;
 208     }
 209
 210   return_if_fail_bytes (buffer, pad_len);
 211
 212   *result = g_strndup ((char *) buffer->pos, length);
 213   buffer->pos += pad_len;
 214
 215   return TRUE;
 216 }
 217
 218 static GHashTable *
 219 parse_settings (unsigned char *data,
 220                 size_t         len)
 221 {
 222   XSettingsBuffer buffer;
 223   GHashTable *settings = NULL;
 224   CARD32 serial;
 225   CARD32 n_entries;
 226   CARD32 i;
 227   XSettingsSetting *setting = NULL;
 228   char *x_name = NULL;
 229   const char *gdk_name;
 230
 231   buffer.pos = buffer.data = data;
 232   buffer.len = len;
 233
 234   if (!fetch_card8 (&buffer, (unsigned char *)&buffer.byte_order))
 235     goto out;
 236
 237   if (buffer.byte_order != MSBFirst &&
 238       buffer.byte_order != LSBFirst)
 239     {
 240       g_warning ("Invalid XSETTINGS property (unknown byte order %u)", buffer.byte_order);
 241       goto out;
 242     }
 243
 244   buffer.pos += 3;
 245
 246   if (!fetch_card32 (&buffer, &serial) ||
 247       !fetch_card32 (&buffer, &n_entries))
 248     goto out;
 249
 250   GDK_NOTE(SETTINGS, g_print("reading %u settings (serial %u byte order %u)\n", n_entries, serial, buffer.byte_order));
 251
 252   for (i = 0; i < n_entries; i++)
 253     {
 254       CARD8 type;
 255       CARD16 name_len;
 256       CARD32 v_int;
 257
 258       if (!fetch_card8 (&buffer, &type))
 259         goto out;
 260
 261       buffer.pos += 1;
 262
 263       if (!fetch_card16 (&buffer, &name_len))
 264         goto out;
 265
 266       setting = g_new (XSettingsSetting, 1);
 267       setting->type = XSETTINGS_TYPE_INT; /* No allocated memory */
 268
 269       if (!fetch_string (&buffer, name_len, &x_name) ||
 270           /* last change serial (we ignore it) */
 271           !fetch_card32 (&buffer, &v_int))
 272         goto out;
 273
 274       switch (type)
 275         {
 276         case XSETTINGS_TYPE_INT:
 277           if (!fetch_card32 (&buffer, &v_int))
 278             goto out;
 279
 280           setting->data.v_int = (INT32)v_int;
 281           GDK_NOTE(SETTINGS, g_print("  %s = %d\n", x_name, (gint) setting->data.v_int));
 282           break;
 283         case XSETTINGS_TYPE_STRING:
 284           if (!fetch_card32 (&buffer, &v_int) ||
 285               !fetch_string (&buffer, v_int, &setting->data.v_string))
 286             goto out;
 287
 288           GDK_NOTE(SETTINGS, g_print("  %s = \"%s\"\n", x_name, setting->data.v_string));
 289           break;
 290         case XSETTINGS_TYPE_COLOR:
 291           if (!fetch_ushort (&buffer, &setting->data.v_color.red) ||
 292               !fetch_ushort (&buffer, &setting->data.v_color.green) ||
 293               !fetch_ushort (&buffer, &setting->data.v_color.blue) ||
 294               !fetch_ushort (&buffer, &setting->data.v_color.alpha))
 295             goto out;
 296
 297           GDK_NOTE(SETTINGS, g_print("  %s = #%02X%02X%02X%02X\n", x_name,
 298                                  setting->data.v_color.alpha, setting->data.v_color.red,
 299                                  setting->data.v_color.green, setting->data.v_color.blue));
 300           break;
 301         default:
 302           /* Quietly ignore unknown types */
 303           GDK_NOTE(SETTINGS, g_print("  %s = ignored (unknown type %u)\n", x_name, type));
 304           break;
 305         }
 306
 307       setting->type = type;
 308
 309       gdk_name = gdk_from_xsettings_name (x_name);
 310       g_free (x_name);
 311       x_name = NULL;
 312
 313       if (gdk_name == NULL)
 314         {
 315           GDK_NOTE(SETTINGS, g_print("    ==> unknown to GTK\n"));
 316         }
 317       else
 318         {
 319           GDK_NOTE(SETTINGS, g_print("    ==> storing as '%s'\n", gdk_name));
 320
 321           if (settings == NULL)
 322             settings = g_hash_table_new_full (g_str_hash, g_str_equal,
 323                                               NULL,
 324                                               (GDestroyNotify) xsettings_setting_free);
 325
 326           if (g_hash_table_lookup (settings, gdk_name) != NULL)
 327             {
 328               g_warning ("Invalid XSETTINGS property (Duplicate entry for '%s')", gdk_name);
 329               goto out;
 330             }
 331
 332           g_hash_table_insert (settings, (gpointer) gdk_name, setting);
 333         }
 334
 335       setting = NULL;
 336     }
 337
 338   return settings;
 339
 340  out:
 341
 342   if (setting)
 343     xsettings_setting_free (setting);
 344
 345   if (settings)
 346     g_hash_table_unref (settings);
 347
 348   g_free (x_name);
 349
 350   return NULL;
 351 }
 352
 353 static void
 354 read_settings (XSettingsClient *client)
 355 {
 356   Atom type;
 357   int format;
 358   unsigned long n_items;
 359   unsigned long bytes_after;
 360   unsigned char *data;
 361   int result;
 362
 363   GHashTable *old_list = client->settings;
 364
 365   client->settings = NULL;
 366
 367   if (client->manager_window)
 368     {
 369       GdkDisplay *display = gdk_screen_get_display (client->screen);
 370       Atom xsettings_atom = gdk_x11_get_xatom_by_name_for_display (display, "_XSETTINGS_SETTINGS");
 371
 372       gdk_x11_display_error_trap_push (display);
 373       result = XGetWindowProperty (gdk_x11_display_get_xdisplay (display),
 374                                    gdk_x11_window_get_xid (client->manager_window),
 375                                    xsettings_atom, 0, LONG_MAX,
 376                                    False, xsettings_atom,
 377                                    &type, &format, &n_items, &bytes_after, &data);
 378       gdk_x11_display_error_trap_pop_ignored (display);
 379
 380       if (result == Success && type != None)
 381         {
 382           if (type != xsettings_atom)
 383             {
 384               g_warning ("Invalid type for XSETTINGS property: %s", gdk_x11_get_xatom_name_for_display (display, type));
 385             }
 386           else if (format != 8)
 387             {
 388               g_warning ("Invalid format for XSETTINGS property: %d", format);
 389             }
 390           else
 391             client->settings = parse_settings (data, n_items);
 392
 393           XFree (data);
 394         }
 395     }
 396
 397   notify_changes (client, old_list);
 398   if (old_list)
 399     g_hash_table_unref (old_list);
 400 }
 401
 402 static GdkFilterReturn
 403 gdk_xsettings_manager_window_filter (GdkXEvent *xevent,
 404                                      GdkEvent  *event,
 405                                      gpointer   data);
 406
 407 static void
 408 check_manager_window (XSettingsClient *client)
 409 {
 410   GdkDisplay *display;
 411   Display *xdisplay;
 412   Window manager_window_xid;
 413
 414   display = gdk_screen_get_display (client->screen);
 415   xdisplay = gdk_x11_display_get_xdisplay (display);
 416
 417   if (client->manager_window)
 418     {
 419       gdk_window_remove_filter (client->manager_window, gdk_xsettings_manager_window_filter, client->screen);
 420       g_object_unref (client->manager_window);
 421     }
 422
 423   gdk_x11_display_grab (display);
 424
 425   manager_window_xid = XGetSelectionOwner (xdisplay,
 426                                            client->selection_atom);
 427   client->manager_window = gdk_x11_window_foreign_new_for_display (display,
 428                                                                    manager_window_xid);
 429   /* XXX: Can't use gdk_window_set_events() here because the first call to this
 430    * function happens too early in gdk_init() */
 431   if (client->manager_window)
 432     XSelectInput (xdisplay,
 433                   gdk_x11_window_get_xid (client->manager_window),
 434                   PropertyChangeMask | StructureNotifyMask);
 435
 436   gdk_x11_display_ungrab (display);
 437
 438   gdk_display_flush (display);
 439
 440   if (client->manager_window)
 441     {
 442       gdk_window_add_filter (client->manager_window, gdk_xsettings_manager_window_filter, client->screen);
 443     }
 444
 445   read_settings (client);
 446 }
 447
 448 static GdkFilterReturn
 449 gdk_xsettings_root_window_filter (GdkXEvent *xevent,
 450                                   GdkEvent  *event,
 451                                   gpointer   data)
 452 {
 453   GdkScreen *screen = data;
 454   XSettingsClient *client = GDK_X11_SCREEN (screen)->xsettings_client;
 455   GdkDisplay *display = gdk_screen_get_display (screen);
 456   XEvent *xev = xevent;
 457
 458   /* The checks here will not unlikely cause us to reread
 459    * the properties from the manager window a number of
 460    * times when the manager changes from A->B. But manager changes
 461    * are going to be pretty rare.
 462    */
 463   if (xev->xany.type == ClientMessage &&
 464       xev->xclient.message_type == gdk_x11_get_xatom_by_name_for_display (display, "MANAGER") &&
 465       xev->xclient.data.l[1] == client->selection_atom)
 466     {
 467       check_manager_window (client);
 468       return GDK_FILTER_REMOVE;
 469     }
 470
 471   return GDK_FILTER_CONTINUE;
 472 }
 473
 474 static GdkFilterReturn
 475 gdk_xsettings_manager_window_filter (GdkXEvent *xevent,
 476                                      GdkEvent  *event,
 477                                      gpointer   data)
 478 {
 479   GdkScreen *screen = data;
 480   XSettingsClient *client = GDK_X11_SCREEN (screen)->xsettings_client;
 481   XEvent *xev = xevent;
 482
 483   if (xev->xany.type == DestroyNotify)
 484     {
 485       check_manager_window (client);
 486       /* let GDK do its cleanup */
 487       return GDK_FILTER_CONTINUE;
 488     }
 489   else if (xev->xany.type == PropertyNotify)
 490     {
 491       read_settings (client);
 492       return GDK_FILTER_REMOVE;
 493     }
 494
 495   return GDK_FILTER_CONTINUE;;
 496 }
 497
 498 XSettingsClient *
 499 xsettings_client_new (GdkScreen *screen)
 500 {
 501   XSettingsClient *client;
 502   char *selection_atom_name;
 503
 504   client = g_new (XSettingsClient, 1);
 505   if (!client)
 506     return NULL;
 507
 508   client->screen = screen;
 509   client->manager_window = None;
 510   client->settings = NULL;
 511
 512   selection_atom_name = g_strdup_printf ("_XSETTINGS_S%d", gdk_x11_screen_get_screen_number (screen));
 513   client->selection_atom = gdk_x11_get_xatom_by_name_for_display (gdk_screen_get_display (screen), selection_atom_name);
 514   g_free (selection_atom_name);
 515
 516   gdk_window_add_filter (gdk_screen_get_root_window (screen), gdk_xsettings_root_window_filter, screen);
 517
 518   check_manager_window (client);
 519
 520   return client;
 521 }
 522
 523 void
 524 xsettings_client_destroy (XSettingsClient *client)
 525 {
 526   gdk_window_remove_filter (gdk_screen_get_root_window (client->screen), gdk_xsettings_root_window_filter, client->screen);
 527   if (client->manager_window)
 528     {
 529       gdk_window_remove_filter (client->manager_window, gdk_xsettings_manager_window_filter, client->screen);
 530       g_object_unref (client->manager_window);
 531     }
 532
 533   if (client->settings)
 534     g_hash_table_unref (client->settings);
 535   g_free (client);
 536 }
 537
 538 const XSettingsSetting *
 539 xsettings_client_get_setting (XSettingsClient   *client,
 540                               const char        *name)
 541 {
 542   return g_hash_table_lookup (client->settings, name);
 543 }
 544
 545 int
 546 xsettings_setting_equal (XSettingsSetting *setting_a,
 547                          XSettingsSetting *setting_b)
 548 {
 549   if (setting_a->type != setting_b->type)
 550     return 0;
 551
 552   switch (setting_a->type)
 553     {
 554     case XSETTINGS_TYPE_INT:
 555       return setting_a->data.v_int == setting_b->data.v_int;
 556     case XSETTINGS_TYPE_COLOR:
 557       return (setting_a->data.v_color.red == setting_b->data.v_color.red &&
 558               setting_a->data.v_color.green == setting_b->data.v_color.green &&
 559               setting_a->data.v_color.blue == setting_b->data.v_color.blue &&
 560               setting_a->data.v_color.alpha == setting_b->data.v_color.alpha);
 561     case XSETTINGS_TYPE_STRING:
 562       return strcmp (setting_a->data.v_string, setting_b->data.v_string) == 0;
 563     }
 564
 565   return 0;
 566 }
 567
 568 void
 569 xsettings_setting_free (XSettingsSetting *setting)
 570 {
 571   if (setting->type == XSETTINGS_TYPE_STRING)
 572     g_free (setting->data.v_string);
 573
 574   g_free (setting);
 575 }
 576