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/gdkprivate-x11.h>
  33 #include <gdk/x11/gdkscreen-x11.h>
  34
  35 #include <gdkinternals.h>
  36
  37 #include <string.h>
  38
  39 #include <X11/Xlib.h>
  40 #include <X11/Xmd.h>            /* For CARD16 */
  41
  42 #include "gdksettings.c"
  43
  44 /* Types of settings possible. Enum values correspond to
  45  * protocol values.
  46  */
  47 typedef enum
  48 {
  49   XSETTINGS_TYPE_INT     = 0,
  50   XSETTINGS_TYPE_STRING  = 1,
  51   XSETTINGS_TYPE_COLOR   = 2
  52 } XSettingsType;
  53
  54 typedef struct _XSettingsBuffer  XSettingsBuffer;
  55
  56 struct _XSettingsBuffer
  57 {
  58   char byte_order;
  59   size_t len;
  60   unsigned char *data;
  61   unsigned char *pos;
  62 };
  63
  64 struct _XSettingsClient
  65 {
  66   GdkScreen *screen;
  67
  68   GdkWindow *manager_window;
  69
  70   GHashTable *settings; /* string of GDK settings name => XSettingsSetting */
  71 };
  72
  73 static void
  74 gdk_xsettings_notify (const char       *name,
  75                       GdkSettingAction  action,
  76                       GdkScreen        *screen)
  77 {
  78   GdkEvent new_event;
  79
  80   new_event.type = GDK_SETTING;
  81   new_event.setting.window = gdk_screen_get_root_window (screen);
  82   new_event.setting.send_event = FALSE;
  83   new_event.setting.action = action;
  84   new_event.setting.name = (char*) name;
  85
  86   gdk_event_put (&new_event);
  87 }
  88
  89 static gboolean
  90 value_equal (const GValue *value_a,
  91              const GValue *value_b)
  92 {
  93   if (G_VALUE_TYPE (value_a) != G_VALUE_TYPE (value_b))
  94     return FALSE;
  95
  96   switch (G_VALUE_TYPE (value_a))
  97     {
  98     case G_TYPE_INT:
  99       return g_value_get_int (value_a) == g_value_get_int (value_b);
 100     case XSETTINGS_TYPE_COLOR:
 101       return gdk_rgba_equal (g_value_get_boxed (value_a), g_value_get_boxed (value_b));
 102     case G_TYPE_STRING:
 103       return g_str_equal (g_value_get_string (value_a), g_value_get_string (value_b));
 104     default:
 105       g_warning ("unable to compare values of type %s", g_type_name (G_VALUE_TYPE (value_a)));
 106       return FALSE;
 107     }
 108 }
 109
 110 static void
 111 notify_changes (XSettingsClient *client,
 112                 GHashTable      *old_list)
 113 {
 114   GHashTableIter iter;
 115   GValue *setting, *old_setting;
 116   const char *name;
 117
 118   if (client->settings != NULL)
 119     {
 120       g_hash_table_iter_init (&iter, client->settings);
 121       while (g_hash_table_iter_next (&iter, (gpointer *) &name, (gpointer*) &setting))
 122         {
 123           old_setting = old_list ? g_hash_table_lookup (old_list, name) : NULL;
 124
 125           if (old_setting == NULL)
 126             gdk_xsettings_notify (name, GDK_SETTING_ACTION_NEW, client->screen);
 127           else if (!value_equal (setting, old_setting))
 128             gdk_xsettings_notify (name, GDK_SETTING_ACTION_CHANGED, client->screen);
 129
 130           /* remove setting from old_list */
 131           if (old_setting != NULL)
 132             g_hash_table_remove (old_list, name);
 133         }
 134     }
 135
 136   if (old_list != NULL)
 137     {
 138       /* old_list now contains only deleted settings */
 139       g_hash_table_iter_init (&iter, old_list);
 140       while (g_hash_table_iter_next (&iter, (gpointer *) &name, (gpointer*) &old_setting))
 141         gdk_xsettings_notify (name, GDK_SETTING_ACTION_DELETED, client->screen);
 142     }
 143 }
 144
 145 #define BYTES_LEFT(buffer) ((buffer)->data + (buffer)->len - (buffer)->pos)
 146
 147 #define return_if_fail_bytes(buffer, n_bytes) G_STMT_START{ \
 148   if (BYTES_LEFT (buffer) < (n_bytes)) \
 149     { \
 150       g_warning ("Invalid XSETTINGS property (read off end: Expected %u bytes, only %ld left", \
 151                  (n_bytes), BYTES_LEFT (buffer)); \
 152       return FALSE; \
 153     } \
 154 }G_STMT_END
 155
 156 static gboolean
 157 fetch_card16 (XSettingsBuffer *buffer,
 158               CARD16          *result)
 159 {
 160   CARD16 x;
 161
 162   return_if_fail_bytes (buffer, 2);
 163
 164   x = *(CARD16 *)buffer->pos;
 165   buffer->pos += 2;
 166
 167   if (buffer->byte_order == MSBFirst)
 168     *result = GUINT16_FROM_BE (x);
 169   else
 170     *result = GUINT16_FROM_LE (x);
 171
 172   return TRUE;
 173 }
 174
 175 static gboolean
 176 fetch_ushort (XSettingsBuffer *buffer,
 177               unsigned short  *result)
 178 {
 179   CARD16 x;
 180   gboolean r;
 181
 182   r = fetch_card16 (buffer, &x);
 183   if (r)
 184     *result = x;
 185
 186   return r;
 187 }
 188
 189 static gboolean
 190 fetch_card32 (XSettingsBuffer *buffer,
 191               CARD32          *result)
 192 {
 193   CARD32 x;
 194
 195   return_if_fail_bytes (buffer, 4);
 196
 197   x = *(CARD32 *)buffer->pos;
 198   buffer->pos += 4;
 199
 200   if (buffer->byte_order == MSBFirst)
 201     *result = GUINT32_FROM_BE (x);
 202   else
 203     *result = GUINT32_FROM_LE (x);
 204
 205   return TRUE;
 206 }
 207
 208 static gboolean
 209 fetch_card8 (XSettingsBuffer *buffer,
 210              CARD8           *result)
 211 {
 212   return_if_fail_bytes (buffer, 1);
 213
 214   *result = *(CARD8 *)buffer->pos;
 215   buffer->pos += 1;
 216
 217   return TRUE;
 218 }
 219
 220 #define XSETTINGS_PAD(n,m) ((n + m - 1) & (~(m-1)))
 221
 222 static gboolean
 223 fetch_string (XSettingsBuffer  *buffer,
 224               guint             length,
 225               char            **result)
 226 {
 227   guint pad_len;
 228
 229   pad_len = XSETTINGS_PAD (length, 4);
 230   if (pad_len < length) /* guard against overflow */
 231     {
 232       g_warning ("Invalid XSETTINGS property (overflow in string length)");
 233       return FALSE;
 234     }
 235
 236   return_if_fail_bytes (buffer, pad_len);
 237
 238   *result = g_strndup ((char *) buffer->pos, length);
 239   buffer->pos += pad_len;
 240
 241   return TRUE;
 242 }
 243
 244 static void
 245 free_value (gpointer data)
 246 {
 247   GValue *value = data;
 248
 249   g_value_unset (value);
 250   g_free (value);
 251 }
 252
 253 static GHashTable *
 254 parse_settings (unsigned char *data,
 255                 size_t         len)
 256 {
 257   XSettingsBuffer buffer;
 258   GHashTable *settings = NULL;
 259   CARD32 serial;
 260   CARD32 n_entries;
 261   CARD32 i;
 262   GValue *value = NULL;
 263   char *x_name = NULL;
 264   const char *gdk_name;
 265
 266   buffer.pos = buffer.data = data;
 267   buffer.len = len;
 268
 269   if (!fetch_card8 (&buffer, (unsigned char *)&buffer.byte_order))
 270     goto out;
 271
 272   if (buffer.byte_order != MSBFirst &&
 273       buffer.byte_order != LSBFirst)
 274     {
 275       g_warning ("Invalid XSETTINGS property (unknown byte order %u)", buffer.byte_order);
 276       goto out;
 277     }
 278
 279   buffer.pos += 3;
 280
 281   if (!fetch_card32 (&buffer, &serial) ||
 282       !fetch_card32 (&buffer, &n_entries))
 283     goto out;
 284
 285   GDK_NOTE(SETTINGS, g_print("reading %u settings (serial %u byte order %u)\n", n_entries, serial, buffer.byte_order));
 286
 287   for (i = 0; i < n_entries; i++)
 288     {
 289       CARD8 type;
 290       CARD16 name_len;
 291       CARD32 v_int;
 292
 293       if (!fetch_card8 (&buffer, &type))
 294         goto out;
 295
 296       buffer.pos += 1;
 297
 298       if (!fetch_card16 (&buffer, &name_len))
 299         goto out;
 300
 301       if (!fetch_string (&buffer, name_len, &x_name) ||
 302           /* last change serial (we ignore it) */
 303           !fetch_card32 (&buffer, &v_int))
 304         goto out;
 305
 306       switch (type)
 307         {
 308         case XSETTINGS_TYPE_INT:
 309           if (!fetch_card32 (&buffer, &v_int))
 310             goto out;
 311
 312           value = g_new0 (GValue, 1);
 313           g_value_init (value, G_TYPE_INT);
 314           g_value_set_int (value, (gint32) v_int);
 315
 316           GDK_NOTE(SETTINGS, g_print("  %s = %d\n", x_name, (gint32) v_int));
 317           break;
 318         case XSETTINGS_TYPE_STRING:
 319           {
 320             char *s;
 321
 322             if (!fetch_card32 (&buffer, &v_int) ||
 323                 !fetch_string (&buffer, v_int, &s))
 324               goto out;
 325
 326             value = g_new0 (GValue, 1);
 327             g_value_init (value, G_TYPE_STRING);
 328             g_value_take_string (value, s);
 329
 330             GDK_NOTE(SETTINGS, g_print("  %s = \"%s\"\n", x_name, s));
 331           }
 332           break;
 333         case XSETTINGS_TYPE_COLOR:
 334           {
 335             unsigned short red, green, blue, alpha;
 336             GdkRGBA rgba;
 337
 338             if (!fetch_ushort (&buffer, &red) ||
 339                 !fetch_ushort (&buffer, &green) ||
 340                 !fetch_ushort (&buffer, &blue) ||
 341                 !fetch_ushort (&buffer, &alpha))
 342               goto out;
 343
 344             rgba.red = red / 65535.0;
 345             rgba.green = green / 65535.0;
 346             rgba.blue = blue / 65535.0;
 347             rgba.alpha = alpha / 65535.0;
 348
 349             value = g_new0 (GValue, 1);
 350             g_value_init (value, G_TYPE_STRING);
 351             g_value_set_boxed (value, &rgba);
 352
 353             GDK_NOTE(SETTINGS, g_print("  %s = #%02X%02X%02X%02X\n", x_name, alpha,red, green, blue));
 354           }
 355           break;
 356         default:
 357           /* Quietly ignore unknown types */
 358           GDK_NOTE(SETTINGS, g_print("  %s = ignored (unknown type %u)\n", x_name, type));
 359           break;
 360         }
 361
 362       gdk_name = gdk_from_xsettings_name (x_name);
 363       g_free (x_name);
 364       x_name = NULL;
 365
 366       if (gdk_name == NULL)
 367         {
 368           GDK_NOTE(SETTINGS, g_print("    ==> unknown to GTK\n"));
 369         }
 370       else
 371         {
 372           GDK_NOTE(SETTINGS, g_print("    ==> storing as '%s'\n", gdk_name));
 373
 374           if (settings == NULL)
 375             settings = g_hash_table_new_full (g_str_hash, g_str_equal,
 376                                               NULL,
 377                                               free_value);
 378
 379           if (g_hash_table_lookup (settings, gdk_name) != NULL)
 380             {
 381               g_warning ("Invalid XSETTINGS property (Duplicate entry for '%s')", gdk_name);
 382               goto out;
 383             }
 384
 385           g_hash_table_insert (settings, (gpointer) gdk_name, value);
 386         }
 387
 388       value = NULL;
 389     }
 390
 391   return settings;
 392
 393  out:
 394
 395   if (value)
 396     free_value (value);
 397
 398   if (settings)
 399     g_hash_table_unref (settings);
 400
 401   g_free (x_name);
 402
 403   return NULL;
 404 }
 405
 406 static void
 407 read_settings (XSettingsClient *client,
 408                gboolean         do_notify)
 409 {
 410   Atom type;
 411   int format;
 412   unsigned long n_items;
 413   unsigned long bytes_after;
 414   unsigned char *data;
 415   int result;
 416
 417   GHashTable *old_list = client->settings;
 418
 419   client->settings = NULL;
 420
 421   if (client->manager_window)
 422     {
 423       GdkDisplay *display = gdk_screen_get_display (client->screen);
 424       Atom xsettings_atom = gdk_x11_get_xatom_by_name_for_display (display, "_XSETTINGS_SETTINGS");
 425
 426       gdk_x11_display_error_trap_push (display);
 427       result = XGetWindowProperty (gdk_x11_display_get_xdisplay (display),
 428                                    gdk_x11_window_get_xid (client->manager_window),
 429                                    xsettings_atom, 0, LONG_MAX,
 430                                    False, xsettings_atom,
 431                                    &type, &format, &n_items, &bytes_after, &data);
 432       gdk_x11_display_error_trap_pop_ignored (display);
 433
 434       if (result == Success && type != None)
 435         {
 436           if (type != xsettings_atom)
 437             {
 438               g_warning ("Invalid type for XSETTINGS property: %s", gdk_x11_get_xatom_name_for_display (display, type));
 439             }
 440           else if (format != 8)
 441             {
 442               g_warning ("Invalid format for XSETTINGS property: %d", format);
 443             }
 444           else
 445             client->settings = parse_settings (data, n_items);
 446
 447           XFree (data);
 448         }
 449     }
 450
 451   if (do_notify)
 452     notify_changes (client, old_list);
 453   if (old_list)
 454     g_hash_table_unref (old_list);
 455 }
 456
 457 static Atom
 458 get_selection_atom (GdkScreen *screen)
 459 {
 460   return _gdk_x11_get_xatom_for_display_printf (gdk_screen_get_display (screen), "_XSETTINGS_S%d", gdk_x11_screen_get_screen_number (screen));
 461 }
 462
 463 static GdkFilterReturn
 464 gdk_xsettings_manager_window_filter (GdkXEvent *xevent,
 465                                      GdkEvent  *event,
 466                                      gpointer   data);
 467
 468 static void
 469 check_manager_window (XSettingsClient *client,
 470                       gboolean         notify_changes)
 471 {
 472   GdkDisplay *display;
 473   Display *xdisplay;
 474   Window manager_window_xid;
 475
 476   display = gdk_screen_get_display (client->screen);
 477   xdisplay = gdk_x11_display_get_xdisplay (display);
 478
 479   if (client->manager_window)
 480     {
 481       gdk_window_remove_filter (client->manager_window, gdk_xsettings_manager_window_filter, client->screen);
 482       g_object_unref (client->manager_window);
 483     }
 484
 485   gdk_x11_display_grab (display);
 486
 487   manager_window_xid = XGetSelectionOwner (xdisplay, get_selection_atom (client->screen));
 488   client->manager_window = gdk_x11_window_foreign_new_for_display (display,
 489                                                                    manager_window_xid);
 490   /* XXX: Can't use gdk_window_set_events() here because the first call to this
 491    * function happens too early in gdk_init() */
 492   if (client->manager_window)
 493     XSelectInput (xdisplay,
 494                   gdk_x11_window_get_xid (client->manager_window),
 495                   PropertyChangeMask | StructureNotifyMask);
 496
 497   gdk_x11_display_ungrab (display);
 498
 499   gdk_display_flush (display);
 500
 501   if (client->manager_window)
 502     {
 503       gdk_window_add_filter (client->manager_window, gdk_xsettings_manager_window_filter, client->screen);
 504     }
 505
 506   read_settings (client, notify_changes);
 507 }
 508
 509 static GdkFilterReturn
 510 gdk_xsettings_root_window_filter (GdkXEvent *xevent,
 511                                   GdkEvent  *event,
 512                                   gpointer   data)
 513 {
 514   GdkScreen *screen = data;
 515   XSettingsClient *client = GDK_X11_SCREEN (screen)->xsettings_client;
 516   GdkDisplay *display = gdk_screen_get_display (screen);
 517   XEvent *xev = xevent;
 518
 519   /* The checks here will not unlikely cause us to reread
 520    * the properties from the manager window a number of
 521    * times when the manager changes from A->B. But manager changes
 522    * are going to be pretty rare.
 523    */
 524   if (xev->xany.type == ClientMessage &&
 525       xev->xclient.message_type == gdk_x11_get_xatom_by_name_for_display (display, "MANAGER") &&
 526       xev->xclient.data.l[1] == get_selection_atom (client->screen))
 527     {
 528       check_manager_window (client, TRUE);
 529       return GDK_FILTER_REMOVE;
 530     }
 531
 532   return GDK_FILTER_CONTINUE;
 533 }
 534
 535 static GdkFilterReturn
 536 gdk_xsettings_manager_window_filter (GdkXEvent *xevent,
 537                                      GdkEvent  *event,
 538                                      gpointer   data)
 539 {
 540   GdkScreen *screen = data;
 541   XSettingsClient *client = GDK_X11_SCREEN (screen)->xsettings_client;
 542   XEvent *xev = xevent;
 543
 544   if (xev->xany.type == DestroyNotify)
 545     {
 546       check_manager_window (client, TRUE);
 547       /* let GDK do its cleanup */
 548       return GDK_FILTER_CONTINUE;
 549     }
 550   else if (xev->xany.type == PropertyNotify)
 551     {
 552       read_settings (client, TRUE);
 553       return GDK_FILTER_REMOVE;
 554     }
 555
 556   return GDK_FILTER_CONTINUE;;
 557 }
 558
 559 XSettingsClient *
 560 _gdk_x11_xsettings_client_new (GdkScreen *screen)
 561 {
 562   XSettingsClient *client;
 563
 564   client = g_new (XSettingsClient, 1);
 565   if (!client)
 566     return NULL;
 567
 568   client->screen = screen;
 569   client->manager_window = None;
 570   client->settings = NULL;
 571
 572   gdk_window_add_filter (gdk_screen_get_root_window (screen), gdk_xsettings_root_window_filter, screen);
 573
 574   check_manager_window (client, FALSE);
 575
 576   return client;
 577 }
 578
 579 void
 580 _gdk_x11_xsettings_client_destroy (XSettingsClient *client)
 581 {
 582   gdk_window_remove_filter (gdk_screen_get_root_window (client->screen), gdk_xsettings_root_window_filter, client->screen);
 583   if (client->manager_window)
 584     {
 585       gdk_window_remove_filter (client->manager_window, gdk_xsettings_manager_window_filter, client->screen);
 586       g_object_unref (client->manager_window);
 587     }
 588
 589   if (client->settings)
 590     g_hash_table_unref (client->settings);
 591   g_free (client);
 592 }
 593
 594 const GValue *
 595 _gdk_x11_xsettings_client_get_setting (XSettingsClient   *client,
 596                                        const char        *name)
 597 {
 598   return g_hash_table_lookup (client->settings, name);
 599 }
 600