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   return FALSE;
 210 }
 211
 212 static void
 213 handle_method_call (GDBusConnection       *connection,
 214                     const gchar           *sender,
 215                     const gchar           *object_path,
 216                     const gchar           *interface_name,
 217                     const gchar           *method_name,
 218                     GVariant              *parameters,
 219                     GDBusMethodInvocation *invocation,
 220                     gpointer               user_data)
 221 {
 222   A11yBusLauncher *app = user_data;
 223
 224   if (g_strcmp0 (method_name, "GetAddress") == 0)
 225     {
 226       ensure_a11y_bus (app);
 227       if (app->a11y_bus_pid > 0)
 228         g_dbus_method_invocation_return_value (invocation,
 229                                                g_variant_new ("(s)", app->a11y_bus_address));
 230       else
 231         g_dbus_method_invocation_return_dbus_error (invocation,
 232                                                     "org.a11y.Bus.Error",
 233                                                     app->a11y_launch_error_message);
 234     }
 235 }
 236
 237 static GVariant *
 238 handle_get_property  (GDBusConnection       *connection,
 239                       const gchar           *sender,
 240                       const gchar           *object_path,
 241                       const gchar           *interface_name,
 242                       const gchar           *property_name,
 243                     GError **error,
 244                     gpointer               user_data)
 245 {
 246   A11yBusLauncher *app = user_data;
 247
 248   if (g_strcmp0 (property_name, "IsEnabled") == 0)
 249     {
 250       return g_variant_new ("(b)", app->a11y_enabled);
 251     }
 252   else
 253     return NULL;
 254 }
 255
 256 handle_a11y_enabled_change (A11yBusLauncher *app, gboolean enabled,
 257                                gboolean notify_gsettings)
 258 {
 259   GVariantBuilder *builder;
 260   GVariantBuilder *invalidated_builder;
 261
 262   if (enabled == app->a11y_enabled)
 263     return;
 264
 265   app->a11y_enabled = enabled;
 266
 267   if (notify_gsettings && app->desktop_schema)
 268     g_settings_set_boolean (app->desktop_schema, "toolkit-accessibility",
 269                             enabled);
 270
 271   builder = g_variant_builder_new (G_VARIANT_TYPE_ARRAY);
 272   invalidated_builder = g_variant_builder_new (G_VARIANT_TYPE ("as"));
 273   g_variant_builder_add (builder, "{sv}", "IsEnabled",
 274                          g_variant_new_boolean (enabled));
 275
 276   g_dbus_connection_emit_signal (app->session_bus, NULL, "/org/a11y/bus",
 277                                  "org.freedesktop.DBus", "PropertiesChanged",
 278                                  g_variant_new ("(sa{sv}as)", "org.a11y.Status",
 279                                                 builder,
 280                                                 invalidated_builder),
 281                                  NULL);
 282 }
 283
 284 static gboolean
 285 handle_set_property  (GDBusConnection       *connection,
 286                       const gchar           *sender,
 287                       const gchar           *object_path,
 288                       const gchar           *interface_name,
 289                       const gchar           *property_name,
 290                       GVariant *value,
 291                     GError **error,
 292                     gpointer               user_data)
 293 {
 294   A11yBusLauncher *app = user_data;
 295
 296   if (g_strcmp0 (property_name, "IsEnabled") == 0)
 297     {
 298       const gchar *type = g_variant_get_type_string (value);
 299       gboolean enabled;
 300       if (g_strcmp0 (type, "b") != 0)
 301         {
 302           g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS,
 303                        "org.a11y.Status.IsEnabled expects a boolean but got %s", type);
 304           return FALSE;
 305         }
 306       enabled = g_variant_get_boolean (value);
 307       handle_a11y_enabled_change (app, enabled, TRUE);
 308       return TRUE;
 309     }
 310   else
 311     {
 312       g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_INVALID_ARGS,
 313                        "Unknown property '%s'", property_name);
 314       return FALSE;
 315     }
 316 }
 317
 318 static const GDBusInterfaceVTable bus_vtable =
 319 {
 320   handle_method_call,
 321   NULL, /* handle_get_property, */
 322   NULL  /* handle_set_property */
 323 };
 324
 325 static const GDBusInterfaceVTable status_vtable =
 326 {
 327   NULL, /* handle_method_call */
 328   handle_get_property,
 329   handle_set_property
 330 };
 331
 332 static void
 333 on_bus_acquired (GDBusConnection *connection,
 334                  const gchar     *name,
 335                  gpointer         user_data)
 336 {
 337   A11yBusLauncher *app = user_data;
 338   GError *error;
 339   guint registration_id;
 340
 341   if (connection == NULL)
 342     {
 343       g_main_loop_quit (app->loop);
 344       return;
 345     }
 346   app->session_bus = connection;
 347
 348   if (app->launch_immediately)
 349     {
 350       ensure_a11y_bus (app);
 351       if (app->state == A11Y_BUS_STATE_ERROR)
 352         {
 353           g_main_loop_quit (app->loop);
 354           return;
 355         }
 356     }
 357
 358   error = NULL;
 359   registration_id = g_dbus_connection_register_object (connection,
 360                                                        "/org/a11y/bus",
 361                                                        introspection_data->interfaces[0],
 362                                                        &bus_vtable,
 363                                                        _global_app,
 364                                                        NULL,
 365                                                        &error);
 366   if (registration_id == 0)
 367     g_error ("%s", error->message);
 368
 369   g_dbus_connection_register_object (connection,
 370                                                        "/org/a11y/bus",
 371                                                        introspection_data->interfaces[1],
 372                                                        &status_vtable,
 373                                                        _global_app,
 374                                                        NULL,
 375                                                        &error);
 376 }
 377
 378 static void
 379 on_name_lost (GDBusConnection *connection,
 380               const gchar     *name,
 381               gpointer         user_data)
 382 {
 383   A11yBusLauncher *app = user_data;
 384   if (app->session_bus == NULL
 385       && connection == NULL
 386       && app->a11y_launch_error_message == NULL)
 387     app->a11y_launch_error_message = g_strdup ("Failed to connect to session bus");
 388   g_main_loop_quit (app->loop);
 389 }
 390
 391 static void
 392 on_name_acquired (GDBusConnection *connection,
 393                   const gchar     *name,
 394                   gpointer         user_data)
 395 {
 396   A11yBusLauncher *app = user_data;
 397   (void) app;
 398 }
 399
 400 static int sigterm_pipefd[2];
 401
 402 static void
 403 sigterm_handler (int signum)
 404 {
 405   write (sigterm_pipefd[1], "X", 1);
 406 }
 407
 408 static gboolean
 409 on_sigterm_pipe (GIOChannel  *channel,
 410                  GIOCondition condition,
 411                  gpointer     data)
 412 {
 413   A11yBusLauncher *app = data;
 414
 415   g_main_loop_quit (app->loop);
 416
 417   return FALSE;
 418 }
 419
 420 static void
 421 init_sigterm_handling (A11yBusLauncher *app)
 422 {
 423   GIOChannel *sigterm_channel;
 424
 425   if (pipe (sigterm_pipefd) < 0)
 426     g_error ("Failed to create pipe: %s", strerror (errno));
 427   signal (SIGTERM, sigterm_handler);
 428
 429   sigterm_channel = g_io_channel_unix_new (sigterm_pipefd[0]);
 430   g_io_add_watch (sigterm_channel,
 431                   G_IO_IN | G_IO_ERR | G_IO_HUP,
 432                   on_sigterm_pipe,
 433                   app);
 434 }
 435
 436 static gboolean
 437 already_running ()
 438 {
 439   Atom AT_SPI_BUS;
 440   Atom actual_type;
 441   Display *bridge_display;
 442   int actual_format;
 443   unsigned char *data = NULL;
 444   unsigned long nitems;
 445   unsigned long leftover;
 446   gboolean result = FALSE;
 447
 448   bridge_display = XOpenDisplay (NULL);
 449   if (!bridge_display)
 450               return FALSE;
 451
 452   AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
 453   XGetWindowProperty (bridge_display,
 454                       XDefaultRootWindow (bridge_display),
 455                       AT_SPI_BUS, 0L,
 456                       (long) BUFSIZ, False,
 457                       (Atom) 31, &actual_type, &actual_format,
 458                       &nitems, &leftover, &data);
 459
 460   if (data)
 461   {
 462     GDBusConnection *bus;
 463     GError *error = NULL;
 464     const gchar *old_session = g_getenv ("DBUS_SESSION_BUS_ADDRESS");
 465     /* TODO: Is there a better way to connect? This is really hacky */
 466     g_setenv ("DBUS_SESSION_BUS_ADDRESS", data, TRUE);
 467     bus = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error);
 468     g_setenv ("DBUS_SESSION_BUS_ADDRESS", old_session, TRUE);
 469     if (bus != NULL)
 470       {
 471         result = TRUE;
 472         g_object_unref (bus);
 473       }
 474   }
 475
 476   XCloseDisplay (bridge_display);
 477   return result;
 478 }
 479
 480 static GSettings *
 481 get_desktop_schema ()
 482 {
 483   const char * const *schemas = NULL;
 484   gint i;
 485
 486   schemas = g_settings_list_schemas ();
 487   for (i = 0; schemas[i]; i++)
 488   {
 489     if (!strcmp (schemas[i], "org.gnome.desktop.interface"))
 490       return g_settings_new (schemas[i]);
 491   }
 492
 493   return NULL;
 494 }
 495
 496 static void
 497 gsettings_key_changed (GSettings *gsettings, const gchar *key, void *user_data)
 498 {
 499   gboolean new_val = g_settings_get_boolean (gsettings, key);
 500   A11yBusLauncher *app = user_data;
 501
 502   if (strcmp (key, "toolkit-accessibility") != 0)
 503     return;
 504
 505   handle_a11y_enabled_change (_global_app, new_val, FALSE);
 506 }
 507
 508 int
 509 main (int    argc,
 510       char **argv)
 511 {
 512   GError *error = NULL;
 513   GMainLoop *loop;
 514   GDBusConnection *session_bus;
 515   int name_owner_id;
 516   gboolean a11y_set = FALSE;
 517   gint i;
 518
 519   g_type_init ();
 520
 521   if (already_running ())
 522     return 0;
 523
 524   _global_app = g_slice_new0 (A11yBusLauncher);
 525   _global_app->loop = g_main_loop_new (NULL, FALSE);
 526
 527   for (i = 1; i < argc; i++)
 528     {
 529       if (!strcmp (argv[i], "--launch-immediately"))
 530         _global_app->launch_immediately = TRUE;
 531       else if (sscanf (argv[i], "--a11y=%d", &_global_app->a11y_enabled) == 2)
 532         a11y_set = TRUE;
 533     else
 534       g_error ("usage: %s [--launch-immediately] [--a11y=0|1]", argv[0]);
 535     }
 536
 537   if (!a11y_set)
 538     _global_app->a11y_enabled = _global_app->launch_immediately;
 539
 540   _global_app->desktop_schema = get_desktop_schema ();
 541
 542   if (_global_app->desktop_schema)
 543     g_signal_connect (_global_app->desktop_schema,
 544                       "changed::toolkit-accessibility",
 545                       G_CALLBACK (gsettings_key_changed), _global_app);
 546
 547   init_sigterm_handling (_global_app);
 548
 549   introspection_data = g_dbus_node_info_new_for_xml (introspection_xml, NULL);
 550   g_assert (introspection_data != NULL);
 551
 552   name_owner_id = g_bus_own_name (G_BUS_TYPE_SESSION,
 553                                   "org.a11y.Bus",
 554                                   G_BUS_NAME_OWNER_FLAGS_ALLOW_REPLACEMENT,
 555                                   on_bus_acquired,
 556                                   on_name_acquired,
 557                                   on_name_lost,
 558                                   _global_app,
 559                                   NULL);
 560
 561   g_main_loop_run (_global_app->loop);
 562
 563   if (_global_app->a11y_bus_pid > 0)
 564     kill (_global_app->a11y_bus_pid, SIGTERM);
 565
 566   /* Clear the X property if our bus is gone; in the case where e.g.
 567    * GDM is launching a login on an X server it was using before,
 568    * we don't want early login processes to pick up the stale address.
 569    */
 570   {
 571     Display *display = XOpenDisplay (NULL);
 572     if (display)
 573       {
 574         Atom bus_address_atom = XInternAtom (display, "AT_SPI_BUS", False);
 575         XDeleteProperty (display,
 576                          XDefaultRootWindow (display),
 577                          bus_address_atom);
 578
 579         XFlush (display);
 580         XCloseDisplay (display);
 581       }
 582   }
 583
 584   if (_global_app->a11y_launch_error_message)
 585     {
 586       g_printerr ("Failed to launch bus: %s", _global_app->a11y_launch_error_message);
 587       return 1;
 588     }
 589   return 0;
 590 }