bus/at-spi-bus-launcher.c

   1 /* -*- mode: c; c-basic-offset: 2; indent-tabs-mode: nil; -*-
   2  *
   3  * at-spi-bus-launcher: Manage the a11y bus as a child process
   4  *
   5  * Copyright 2011 Red Hat, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #include "config.h"
  24
  25 #include <unistd.h>
  26 #include <string.h>
  27 #include <signal.h>
  28 #include <sys/wait.h>
  29 #include <errno.h>
  30 #include <stdio.h>
  31
  32 #include <gio/gio.h>
  33 #include <X11/Xlib.h>
  34 #include <X11/Xatom.h>
  35
  36 typedef enum {
  37   A11Y_BUS_STATE_IDLE = 0,
  38   A11Y_BUS_STATE_READING_ADDRESS,
  39   A11Y_BUS_STATE_RUNNING,
  40   A11Y_BUS_STATE_ERROR
  41 } A11yBusState;
  42
  43 typedef struct {
  44   GMainLoop *loop;
  45   gboolean launch_immediately;
  46   gboolean a11y_enabled;
  47   GDBusConnection *session_bus;
  48   GSettings *desktop_schema;
  49
  50   A11yBusState state;
  51   /* -1 == error, 0 == pending, > 0 == running */
  52   int a11y_bus_pid;
  53   char *a11y_bus_address;
  54   int pipefd[2];
  55   char *a11y_launch_error_message;
  56 } A11yBusLauncher;
  57
  58 static A11yBusLauncher *_global_app = NULL;
  59
  60 static const gchar introspection_xml[] =
  61   "<node>"
  62   "  <interface name='org.a11y.Bus'>"
  63   "    <method name='GetAddress'>"
  64   "      <arg type='s' name='address' direction='out'/>"
  65   "    </method>"
  66   "  </interface>"
  67   "<interface name='org.a11y.Status'>"
  68   "<property name='IsEnabled' type='b' access='readwrite'/>"
  69   "</interface>"
  70   "</node>";
  71 static GDBusNodeInfo *introspection_data = NULL;
  72
  73 static void
  74 setup_bus_child (gpointer data)
  75 {
  76   A11yBusLauncher *app = data;
  77   (void) app;
  78
  79   close (app->pipefd[0]);
  80   dup2 (app->pipefd[1], 3);
  81   close (app->pipefd[1]);
  82
  83   /* On Linux, tell the bus process to exit if this process goes away */
  84 #ifdef __linux
  85 #include <sys/prctl.h>
  86   prctl (PR_SET_PDEATHSIG, 15);
  87 #endif
  88 }
  89
  90 /**
  91  * unix_read_all_fd_to_string:
  92  *
  93  * Read all data from a file descriptor to a C string buffer.
  94  */
  95 static gboolean
  96 unix_read_all_fd_to_string (int      fd,
  97                             char    *buf,
  98                             ssize_t  max_bytes)
  99 {
 100   ssize_t bytes_read;
 101
 102   while (max_bytes > 1 && (bytes_read = read (fd, buf, MAX (4096, max_bytes - 1))))
 103     {
 104       if (bytes_read < 0)
 105         return FALSE;
 106       buf += bytes_read;
 107       max_bytes -= bytes_read;
 108     }
 109   *buf = '\0';
 110   return TRUE;
 111 }
 112
 113 static void
 114 on_bus_exited (GPid     pid,
 115                gint     status,
 116                gpointer data)
 117 {
 118   A11yBusLauncher *app = data;
 119
 120   app->a11y_bus_pid = -1;
 121   app->state = A11Y_BUS_STATE_ERROR;
 122   if (app->a11y_launch_error_message == NULL)
 123     {
 124       if (WIFEXITED (status))
 125         app->a11y_launch_error_message = g_strdup_printf ("Bus exited with code %d", WEXITSTATUS (status));
 126       else if (WIFSIGNALED (status))
 127         app->a11y_launch_error_message = g_strdup_printf ("Bus killed by signal %d", WTERMSIG (status));
 128       else if (WIFSTOPPED (status))
 129         app->a11y_launch_error_message = g_strdup_printf ("Bus stopped by signal %d", WSTOPSIG (status));
 130     }
 131   g_main_loop_quit (app->loop);
 132 }
 133
 134 static gboolean
 135 ensure_a11y_bus (A11yBusLauncher *app)
 136 {
 137   GPid pid;
 138   char *argv[] = { DBUS_DAEMON, NULL, "--nofork", "--print-address", "3", NULL };
 139   char addr_buf[2048];
 140   GError *error = NULL;
 141
 142   if (app->a11y_bus_pid != 0)
 143     return FALSE;
 144
 145   argv[1] = g_strdup_printf ("--config-file=%s/at-spi2/accessibility.conf", SYSCONFDIR);
 146
 147   if (pipe (app->pipefd) < 0)
 148     g_error ("Failed to create pipe: %s", strerror (errno));
 149
 150   if (!g_spawn_async (NULL,
 151                       argv,
 152                       NULL,
 153                       G_SPAWN_SEARCH_PATH | G_SPAWN_DO_NOT_REAP_CHILD,
 154                       setup_bus_child,
 155                       app,
 156                       &pid,
 157                       &error))
 158     {
 159       app->a11y_bus_pid = -1;
 160       app->a11y_launch_error_message = g_strdup (error->message);
 161       g_clear_error (&error);
 162       goto error;
 163     }
 164
 165   close (app->pipefd[1]);
 166   app->pipefd[1] = -1;
 167
 168   g_child_watch_add (pid, on_bus_exited, app);
 169
 170   app->state = A11Y_BUS_STATE_READING_ADDRESS;
 171   app->a11y_bus_pid = pid;
 172   g_debug ("Launched a11y bus, child is %ld", (long) pid);
 173   if (!unix_read_all_fd_to_string (app->pipefd[0], addr_buf, sizeof (addr_buf)))
 174     {
 175       app->a11y_launch_error_message = g_strdup_printf ("Failed to read address: %s", strerror (errno));
 176       kill (app->a11y_bus_pid, SIGTERM);
 177       goto error;
 178     }
 179   close (app->pipefd[0]);
 180   app->pipefd[0] = -1;
 181   app->state = A11Y_BUS_STATE_RUNNING;
 182
 183   /* Trim the trailing newline */
 184   app->a11y_bus_address = g_strchomp (g_strdup (addr_buf));
 185   g_debug ("a11y bus address: %s", app->a11y_bus_address);
 186
 187   {
 188     Display *display = XOpenDisplay (NULL);
 189     if (display)
 190       {
 191         Atom bus_address_atom = XInternAtom (display, "AT_SPI_BUS", False);
 192         XChangeProperty (display,
 193                          XDefaultRootWindow (display),
 194                          bus_address_atom,
 195                          XA_STRING, 8, PropModeReplace,
 196                          (guchar *) app->a11y_bus_address, strlen (app->a11y_bus_address));
 197         XFlush (display);
 198         XCloseDisplay (display);
 199       }
 200   }
 201
 202   return TRUE;
 203
 204  error:
 205   close (app->pipefd[0]);
 206   close (app->pipefd[1]);
 207   app->state = A11Y_BUS_STATE_ERROR;
 208 }
 209
 210 static void
 211 handle_method_call (GDBusConnection       *connection,
 212                     const gchar           *sender,
 213                     const gchar           *object_path,
 214                     const gchar           *interface_name,
 215                     const gchar           *method_name,
 216                     GVariant              *parameters,
 217                     GDBusMethodInvocation *invocation,
 218                     gpointer               user_data)
 219 {
 220   A11yBusLauncher *app = user_data;
 221
 222   if (g_strcmp0 (method_name, "GetAddress") == 0)
 223     {
 224       ensure_a11y_bus (app);
 225       if (app->a11y_bus_pid > 0)
 226         g_dbus_method_invocation_return_value (invocation,
 227                                                g_variant_new ("(s)", app->a11y_bus_address));
 228       else
 229         g_dbus_method_invocation_return_dbus_error (invocation,
 230                                                     "org.a11y.Bus.Error",
 231                                                     app->a11y_launch_error_message);
 232     }
 233 }
 234
 235 static GVariant *
 236 handle_get_property  (GDBusConnection       *connection,
 237                       const gchar           *sender,
 238                       const gchar           *object_path,
 239                       const gchar           *interface_name,
 240                       const gchar           *property_name,
 241                     GError **error,
 242                     gpointer               user_data)
 243 {
 244   A11yBusLauncher *app = user_data;
 245
 246   if (g_strcmp0 (property_name, "IsEnabled") == 0)
 247     {
 248       return g_variant_new ("(b)", app->a11y_enabled);
 249     }
 250   else
 251     return NULL;
 252 }
 253
 254 handle_a11y_enabled_change (A11yBusLauncher *app, gboolean enabled,
 255                                gboolean notify_gsettings)
 256 {
 257   GVariantBuilder *builder;
 258   GVariantBuilder *invalidated_builder;
 259
 260   if (enabled == app->a11y_enabled)
 261     return;
 262
 263   app->a11y_enabled = enabled;
 264
 265   if (notify_gsettings && app->desktop_schema)
 266     g_settings_set_boolean (app->desktop_schema, "toolkit-accessibility",
 267                             enabled);
 268
 269   builder = g_variant_builder_new (G_VARIANT_TYPE_ARRAY);
 270   invalidated_builder = g_variant_builder_new (G_VARIANT_TYPE ("as"));
 271   g_variant_builder_add (builder, "{sv}", "IsEnabled",
 272                          g_variant_new_boolean (enabled));
 273
 274   g_dbus_connection_emit_signal (app->session_bus, NULL, "/org/a11y/bus",
 275                                  "org.freedesktop.DBus", "PropertiesChanged",
 276                                  g_variant_new ("(sa{sv}as)", "org.a11y.Status",
 277                                                 builder,
 278                                                 invalidated_builder),
 279                                  NULL);
 280 }
 281
 282 static gboolean
 283 handle_set_property  (GDBusConnection       *connection,
 284                       const gchar           *sender,
 285                       const gchar           *object_path,
 286                       const gchar           *interface_name,
 287                       const gchar           *property_name,
 288                       GVariant *value,
 289                     GError **error,
 290                     gpointer               user_data)
 291 {
 292   A11yBusLauncher *app = user_data;
 293
 294   if (g_strcmp0 (property_name, "IsEnabled") == 0)
 295     {
 296       const gchar *type = g_variant_get_type_string (value);
 297       gboolean enabled;
 298       if (g_strcmp0 (type, "b") != 0)
 299         {
 300           g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS,
 301                        "org.a11y.Status.IsEnabled expects a boolean but got %s", type);
 302           return FALSE;
 303         }
 304       enabled = g_variant_get_boolean (value);
 305       handle_a11y_enabled_change (app, enabled, TRUE);
 306       return TRUE;
 307     }
 308   else
 309     {
 310       g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS,
 311                        "Unknown property '%s'", property_name);
 312       return FALSE;
 313     }
 314 }
 315
 316 static const GDBusInterfaceVTable bus_vtable =
 317 {
 318   handle_method_call,
 319   NULL, /* handle_get_property, */
 320   NULL  /* handle_set_property */
 321 };
 322
 323 static const GDBusInterfaceVTable status_vtable =
 324 {
 325   NULL, /* handle_method_call */
 326   handle_get_property,
 327   handle_set_property
 328 };
 329
 330 static void
 331 on_bus_acquired (GDBusConnection *connection,
 332                  const gchar     *name,
 333                  gpointer         user_data)
 334 {
 335   A11yBusLauncher *app = user_data;
 336   GError *error;
 337   guint registration_id;
 338
 339   if (connection == NULL)
 340     {
 341       g_main_loop_quit (app->loop);
 342       return;
 343     }
 344   app->session_bus = connection;
 345
 346   if (app->launch_immediately)
 347     {
 348       ensure_a11y_bus (app);
 349       if (app->state == A11Y_BUS_STATE_ERROR)
 350         {
 351           g_main_loop_quit (app->loop);
 352           return;
 353         }
 354     }
 355
 356   error = NULL;
 357   registration_id = g_dbus_connection_register_object (connection,
 358                                                        "/org/a11y/bus",
 359                                                        introspection_data->interfaces[0],
 360                                                        &bus_vtable,
 361                                                        _global_app,
 362                                                        NULL,
 363                                                        &error);
 364   if (registration_id == 0)
 365     g_error ("%s", error->message);
 366
 367   g_dbus_connection_register_object (connection,
 368                                                        "/org/a11y/bus",
 369                                                        introspection_data->interfaces[1],
 370                                                        &status_vtable,
 371                                                        _global_app,
 372                                                        NULL,
 373                                                        &error);
 374 }
 375
 376 static void
 377 on_name_lost (GDBusConnection *connection,
 378               const gchar     *name,
 379               gpointer         user_data)
 380 {
 381   A11yBusLauncher *app = user_data;
 382   if (app->session_bus == NULL
 383       && connection == NULL
 384       && app->a11y_launch_error_message == NULL)
 385     app->a11y_launch_error_message = g_strdup ("Failed to connect to session bus");
 386   g_main_loop_quit (app->loop);
 387 }
 388
 389 static void
 390 on_name_acquired (GDBusConnection *connection,
 391                   const gchar     *name,
 392                   gpointer         user_data)
 393 {
 394   A11yBusLauncher *app = user_data;
 395   (void) app;
 396 }
 397
 398 static int sigterm_pipefd[2];
 399
 400 static void
 401 sigterm_handler (int signum)
 402 {
 403   write (sigterm_pipefd[1], "X", 1);
 404 }
 405
 406 static gboolean
 407 on_sigterm_pipe (GIOChannel  *channel,
 408                  GIOCondition condition,
 409                  gpointer     data)
 410 {
 411   A11yBusLauncher *app = data;
 412
 413   g_main_loop_quit (app->loop);
 414
 415   return FALSE;
 416 }
 417
 418 static void
 419 init_sigterm_handling (A11yBusLauncher *app)
 420 {
 421   GIOChannel *sigterm_channel;
 422
 423   if (pipe (sigterm_pipefd) < 0)
 424     g_error ("Failed to create pipe: %s", strerror (errno));
 425   signal (SIGTERM, sigterm_handler);
 426
 427   sigterm_channel = g_io_channel_unix_new (sigterm_pipefd[0]);
 428   g_io_add_watch (sigterm_channel,
 429                   G_IO_IN | G_IO_ERR | G_IO_HUP,
 430                   on_sigterm_pipe,
 431                   app);
 432 }
 433
 434 static gboolean
 435 already_running ()
 436 {
 437   Atom AT_SPI_BUS;
 438   Atom actual_type;
 439   Display *bridge_display;
 440   int actual_format;
 441   unsigned char *data = NULL;
 442   unsigned long nitems;
 443   unsigned long leftover;
 444   gboolean result = FALSE;
 445
 446   bridge_display = XOpenDisplay (NULL);
 447   if (!bridge_display)
 448               return FALSE;
 449
 450   AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
 451   XGetWindowProperty (bridge_display,
 452                       XDefaultRootWindow (bridge_display),
 453                       AT_SPI_BUS, 0L,
 454                       (long) BUFSIZ, False,
 455                       (Atom) 31, &actual_type, &actual_format,
 456                       &nitems, &leftover, &data);
 457
 458   if (data)
 459   {
 460     GDBusConnection *bus;
 461     GError *error = NULL;
 462     const gchar *old_session = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
 463     /* TODO: Is there a better way to connect? This is really hacky */
 464     g_setenv ("DBUS_SESSION_BUS_ADDRESS", data, TRUE);
 465     bus = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error);
 466     g_setenv ("DBUS_SESSION_BUS_ADDRESS", old_session, TRUE);
 467     if (bus != NULL)
 468       {
 469         result = TRUE;
 470         g_object_unref (bus);
 471       }
 472   }
 473
 474   XCloseDisplay (bridge_display);
 475   return result;
 476 }
 477
 478 static GSettings *
 479 get_desktop_schema ()
 480 {
 481   const char * const *schemas = NULL;
 482   gint i;
 483
 484   schemas = g_settings_list_schemas ();
 485   for (i = 0; schemas[i]; i++)
 486   {
 487     if (!strcmp (schemas[i], "org.gnome.desktop.interface"))
 488       return g_settings_new (schemas[i]);
 489   }
 490 }
 491
 492 static void
 493 gsettings_key_changed (GSettings *gsettings, const gchar *key, void *user_data)
 494 {
 495   gboolean new_val = g_settings_get_boolean (gsettings, key);
 496   A11yBusLauncher *app = user_data;
 497
 498   if (strcmp (key, "toolkit-accessibility") != 0)
 499     return;
 500
 501   handle_a11y_enabled_change (_global_app, new_val, FALSE);
 502 }
 503
 504 int
 505 main (int    argc,
 506       char **argv)
 507 {
 508   GError *error = NULL;
 509   GMainLoop *loop;
 510   GDBusConnection *session_bus;
 511   int name_owner_id;
 512   gboolean a11y_set = FALSE;
 513   gint i;
 514
 515   g_type_init ();
 516
 517   if (already_running ())
 518     return 0;
 519
 520   _global_app = g_slice_new0 (A11yBusLauncher);
 521   _global_app->loop = g_main_loop_new (NULL, FALSE);
 522
 523   for (i = 1; i < argc; i++)
 524     {
 525       if (!strcmp (argv[i], "--launch-immediately"))
 526         _global_app->launch_immediately = TRUE;
 527       else if (sscanf (argv[i], "--a11y=%d", &_global_app->a11y_enabled) == 2)
 528         a11y_set = TRUE;
 529     else
 530       g_error ("usage: %s [--launch-immediately] [--a11y=0|1]", argv[0]);
 531     }
 532
 533   if (!a11y_set)
 534     _global_app->a11y_enabled = _global_app->launch_immediately;
 535
 536   _global_app->desktop_schema = get_desktop_schema ();
 537
 538   if (_global_app->desktop_schema)
 539     g_signal_connect (_global_app->desktop_schema,
 540                       "changed::toolkit-accessibility",
 541                       G_CALLBACK (gsettings_key_changed), _global_app);
 542
 543   init_sigterm_handling (_global_app);
 544
 545   introspection_data = g_dbus_node_info_new_for_xml (introspection_xml, NULL);
 546   g_assert (introspection_data != NULL);
 547
 548   name_owner_id = g_bus_own_name (G_BUS_TYPE_SESSION,
 549                                   "org.a11y.Bus",
 550                                   G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT,
 551                                   on_bus_acquired,
 552                                   on_name_acquired,
 553                                   on_name_lost,
 554                                   _global_app,
 555                                   NULL);
 556
 557   g_main_loop_run (_global_app->loop);
 558
 559   if (_global_app->a11y_bus_pid > 0)
 560     kill (_global_app->a11y_bus_pid, SIGTERM);
 561
 562   /* Clear the X property if our bus is gone; in the case where e.g.
 563    * GDM is launching a login on an X server it was using before,
 564    * we don't want early login processes to pick up the stale address.
 565    */
 566   {
 567     Display *display = XOpenDisplay (NULL);
 568     if (display)
 569       {
 570         Atom bus_address_atom = XInternAtom (display, "AT_SPI_BUS", False);
 571         XDeleteProperty (display,
 572                          XDefaultRootWindow (display),
 573                          bus_address_atom);
 574
 575         XFlush (display);
 576         XCloseDisplay (display);
 577       }
 578   }
 579
 580   if (_global_app->a11y_launch_error_message)
 581     {
 582       g_printerr ("Failed to launch bus: %s", _global_app->a11y_launch_error_message);
 583       return 1;
 584     }
 585   return 0;
 586 }