atk-adaptor/bridge.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2008, 2009 Codethink Ltd.
   6  * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
   7  * Copyright 2001, 2002, 2003 Ximian, Inc.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  22  * Boston, MA 02111-1307, USA.
  23  */
  24
  25 #include "config.h"
  26 #include "dbus/dbus-glib-lowlevel.h"
  27
  28 #include <X11/Xlib.h>
  29 #include <X11/Xatom.h>
  30 #include <unistd.h>
  31 #include <stdlib.h>
  32 #include <stdio.h>
  33 #include <stdarg.h>
  34 #include <string.h>
  35 #include <atk/atk.h>
  36
  37 #include <droute/droute.h>
  38
  39 #include "bridge.h"
  40 #include "event.h"
  41 #include "adaptors.h"
  42 #include "object.h"
  43
  44 #include "accessible-register.h"
  45 #include "accessible-leasing.h"
  46 #include "accessible-cache.h"
  47
  48 #include "common/spi-dbus.h"
  49
  50 /*---------------------------------------------------------------------------*/
  51
  52 SpiBridge *spi_global_app_data = NULL;
  53
  54 static const AtkMisc *atk_misc = NULL;
  55
  56 /*static Display *bridge_display = NULL;*/
  57
  58 /*---------------------------------------------------------------------------*/
  59
  60 /*
  61  * Returns a 'canonicalized' value for DISPLAY,
  62  * with the screen number stripped off if present.
  63  *
  64  */
  65 static const gchar *
  66 spi_display_name (void)
  67 {
  68   static const char *canonical_display_name = NULL;
  69   if (!canonical_display_name)
  70     {
  71       const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
  72       if (!display_env)
  73         {
  74           display_env = g_getenv ("DISPLAY");
  75           if (!display_env || !display_env[0])
  76             canonical_display_name = ":0";
  77           else
  78             {
  79               gchar *display_p, *screen_p;
  80               canonical_display_name = g_strdup (display_env);
  81               display_p = strrchr (canonical_display_name, ':');
  82               screen_p = strrchr (canonical_display_name, '.');
  83               if (screen_p && display_p && (screen_p > display_p))
  84                 {
  85                   *screen_p = '\0';
  86                 }
  87             }
  88         }
  89       else
  90         {
  91           canonical_display_name = display_env;
  92         }
  93     }
  94   return canonical_display_name;
  95 }
  96
  97 /*---------------------------------------------------------------------------*/
  98
  99 /*
 100  * Gets the IOR from the XDisplay.
 101  * Not currently used in D-Bus version, but something similar
 102  * may be employed in the future for accessing the registry daemon
 103  * bus name.
 104  */
 105
 106 static DBusConnection *
 107 spi_atk_bridge_get_bus (void)
 108 {
 109   Atom AT_SPI_BUS;
 110   Atom actual_type;
 111   Display *bridge_display;
 112   int actual_format;
 113   unsigned char *data = NULL;
 114   unsigned long nitems;
 115   unsigned long leftover;
 116
 117   DBusConnection *bus = NULL;
 118   DBusError error;
 119
 120   bridge_display = XOpenDisplay (spi_display_name ());
 121   if (!bridge_display)
 122     g_error ("AT_SPI: Could not get the display\n");
 123
 124   AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
 125   XGetWindowProperty (bridge_display,
 126                       XDefaultRootWindow (bridge_display),
 127                       AT_SPI_BUS, 0L,
 128                       (long) BUFSIZ, False,
 129                       (Atom) 31, &actual_type, &actual_format,
 130                       &nitems, &leftover, &data);
 131
 132   dbus_error_init (&error);
 133
 134   if (data == NULL)
 135     {
 136       g_warning
 137         ("AT-SPI: Accessibility bus not found - Using session bus.\n");
 138       bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
 139       if (!bus)
 140         g_error ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
 141     }
 142   else
 143     {
 144       bus = dbus_connection_open (data, &error);
 145       if (!bus)
 146         {
 147           g_error ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
 148         }
 149       else
 150         {
 151           if (!dbus_bus_register (bus, &error))
 152             g_error ("AT-SPI: Couldn't register with bus: %s\n", error.message);
 153         }
 154     }
 155
 156   return bus;
 157 }
 158
 159 static void
 160 set_reply (DBusPendingCall *pending, void *user_data)
 161 {
 162     void **replyptr = (void **)user_data;
 163
 164     *replyptr = dbus_pending_call_steal_reply (pending);
 165 }
 166
 167 static DBusMessage *
 168 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, DBusError *error)
 169 {
 170     DBusPendingCall *pending;
 171     DBusMessage *reply = NULL;
 172
 173     if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
 174     {
 175         return NULL;
 176     }
 177     dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
 178     while (!reply)
 179     {
 180       if (!dbus_connection_read_write_dispatch (bus, -1)) return NULL;
 181     }
 182     return reply;
 183 }
 184 /*---------------------------------------------------------------------------*/
 185
 186 static void
 187 register_reply (DBusPendingCall *pending, void *user_data)
 188 {
 189   DBusMessage *reply;
 190   SpiBridge *app = user_data;
 191
 192     reply = dbus_pending_call_steal_reply (pending);
 193   if (reply)
 194     {
 195       DBusMessageIter iter, iter_struct;
 196       gchar *app_name, *obj_path;
 197
 198       if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
 199         {
 200           g_warning ("AT-SPI: Could not obtain desktop path or name\n");
 201           dbus_message_unref (reply);
 202           return;
 203         }
 204
 205       dbus_message_iter_init (reply, &iter);
 206       dbus_message_iter_recurse (&iter, &iter_struct);
 207       dbus_message_iter_get_basic (&iter_struct, &app_name);
 208       dbus_message_iter_next (&iter_struct);
 209       dbus_message_iter_get_basic (&iter_struct, &obj_path);
 210
 211       app->desktop_name = g_strdup (app_name);
 212       app->desktop_path = g_strdup (obj_path);
 213     }
 214   else
 215     {
 216       g_warning ("AT-SPI: Could not embed inside desktop");
 217       return;
 218     }
 219   dbus_message_unref (reply);
 220 }
 221
 222 static gboolean
 223 register_application (SpiBridge * app)
 224 {
 225   DBusMessage *message, *reply;
 226   DBusMessageIter iter;
 227   DBusError error;
 228   DBusPendingCall *pending;
 229
 230   dbus_error_init (&error);
 231
 232   /* These will be overridden when we get a reply, but in practice these
 233      defaults should always be correct */
 234   app->desktop_name = SPI_DBUS_NAME_REGISTRY;
 235   app->desktop_path = SPI_DBUS_PATH_ROOT;
 236
 237   message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
 238                                           SPI_DBUS_PATH_ROOT,
 239                                           SPI_DBUS_INTERFACE_SOCKET,
 240                                           "Embed");
 241
 242   dbus_message_iter_init_append (message, &iter);
 243   spi_object_append_reference (&iter, app->root);
 244
 245     if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1))
 246     {
 247         return FALSE;
 248     }
 249
 250     dbus_pending_call_set_notify (pending, register_reply, app, NULL);
 251
 252   if (message)
 253     dbus_message_unref (message);
 254
 255   return TRUE;
 256 }
 257
 258 /*---------------------------------------------------------------------------*/
 259
 260 static void
 261 deregister_application (SpiBridge * app)
 262 {
 263   DBusMessage *message;
 264   DBusMessageIter iter;
 265   DBusError error;
 266   const char *uname;
 267
 268   dbus_error_init (&error);
 269
 270   message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
 271                                           SPI_DBUS_PATH_REGISTRY,
 272                                           SPI_DBUS_INTERFACE_REGISTRY,
 273                                           "DeregisterApplication");
 274   dbus_message_set_no_reply (message, TRUE);
 275
 276   uname = dbus_bus_get_unique_name (app->bus);
 277
 278   dbus_message_iter_init_append (message, &iter);
 279   dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
 280   dbus_connection_send (app->bus, message, NULL);
 281   if (message)
 282     dbus_message_unref (message);
 283 }
 284
 285 /*---------------------------------------------------------------------------*/
 286
 287 static void
 288 exit_func (void)
 289 {
 290   if (!spi_global_app_data)
 291     {
 292       return;
 293     }
 294
 295   spi_atk_tidy_windows ();
 296   spi_atk_deregister_event_listeners ();
 297   deregister_application (spi_global_app_data);
 298
 299   g_free (spi_global_app_data);
 300   spi_global_app_data = NULL;
 301
 302   /* Not currently creating an XDisplay */
 303 #if 0
 304   if (bridge_display)
 305     XCloseDisplay (bridge_display);
 306 #endif
 307 }
 308
 309 /*---------------------------------------------------------------------------*/
 310
 311 static AtkPlugClass *plug_class;
 312 static AtkSocketClass *socket_class;
 313
 314 static gchar *
 315 get_plug_id (AtkPlug * plug)
 316 {
 317   const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
 318   gchar *path;
 319   GString *str = g_string_new (NULL);
 320
 321   path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
 322   g_string_printf (str, "%s:%s", uname, path);
 323   g_free (path);
 324   return g_string_free (str, FALSE);
 325 }
 326
 327 AtkStateSet *
 328 socket_ref_state_set (AtkObject *accessible)
 329 {
 330   char *child_name, *child_path;
 331   AtkSocket *socket = ATK_SOCKET (accessible);
 332   int count = 0;
 333   int j;
 334   int v;
 335   DBusMessage *message, *reply;
 336   DBusMessageIter iter, iter_array;
 337   AtkStateSet *set;
 338
 339   if (!socket->embedded_plug_id)
 340     return NULL;
 341
 342   child_name = g_strdup (socket->embedded_plug_id);
 343   if (!child_name)
 344     return NULL;
 345   child_path = g_utf8_strchr (child_name + 1, -1, ':');
 346   if (!child_path)
 347     {
 348       g_free (child_name);
 349       return NULL;
 350     }
 351   *(child_path++) = '\0';
 352   message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
 353   g_free (child_name);
 354   reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
 355   dbus_message_unref (message);
 356   if (reply == NULL)
 357     return NULL;
 358   if (strcmp (dbus_message_get_signature (reply), "au") != 0)
 359     {
 360       dbus_message_unref (reply);
 361       return NULL;
 362     }
 363   set = atk_state_set_new ();
 364   if (!set)
 365     return  NULL;
 366   dbus_message_iter_init (reply, &iter);
 367   dbus_message_iter_recurse (&iter, &iter_array);
 368   do
 369     {
 370       dbus_message_iter_get_basic (&iter_array, &v);
 371       for (j = 0; j < 32; j++)
 372         {
 373           if (v & (1 << j))
 374             {
 375               AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
 376               atk_state_set_add_state (set, state);
 377             }
 378         }
 379       count++;
 380     }
 381   while (dbus_message_iter_next (&iter_array));
 382   dbus_message_unref (reply);
 383   return set;
 384 }
 385
 386 static void
 387 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
 388 {
 389   AtkObject *accessible = ATK_OBJECT(socket);
 390   gchar *plug_name, *plug_path;
 391   AtkObjectClass *klass;
 392
 393   /* Force registration */
 394   gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
 395   /* Let the plug know that it has been embedded */
 396   plug_name = g_strdup (plug_id);
 397   if (!plug_name)
 398     {
 399       g_free (path);
 400       return;
 401     }
 402   plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
 403   if (plug_path)
 404     {
 405       DBusMessage *message;
 406       *(plug_path++) = '\0';
 407       message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
 408       dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
 409       dbus_connection_send (spi_global_app_data->bus, message, NULL);
 410     }
 411   g_free (plug_name);
 412   g_free (path);
 413
 414   klass = ATK_OBJECT_GET_CLASS (accessible);
 415   klass->ref_state_set = socket_ref_state_set;
 416 }
 417
 418 static void
 419 install_plug_hooks ()
 420 {
 421   gpointer data;
 422
 423   data = g_type_class_ref (ATK_TYPE_PLUG);
 424   plug_class = ATK_PLUG_CLASS (data);
 425   data = g_type_class_ref (ATK_TYPE_SOCKET);
 426   socket_class = ATK_SOCKET_CLASS (data);
 427   plug_class->get_object_id = get_plug_id;
 428   socket_class->embed = socket_embed_hook;
 429 }
 430
 431 gchar *atspi_dbus_name = NULL;
 432 static gboolean atspi_no_register = FALSE;
 433
 434 static GOptionEntry atspi_option_entries[] = {
 435   {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
 436    "D-Bus bus name to register as", NULL},
 437   {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
 438    "Do not register with Registry Daemon", NULL},
 439   {NULL}
 440 };
 441
 442 static gchar *
 443 introspect_children_cb (const char *path, void *data)
 444 {
 445   if (!strcmp (path, "/org/a11y/atspi/accessible"))
 446     {
 447       return g_strdup ("<node name=\"root\"/>\n");
 448       /* TODO: Should we place the whole hierarchy here? */
 449     }
 450   return NULL;
 451 }
 452
 453 /*
 454  * spi_app_init
 455  *
 456  * The following needs to be initialized.
 457  *
 458  * - DRoute for routing message to their accessible objects.
 459  * - Event handlers for emmitting signals on specific ATK events.
 460  * - Application registration with the AT-SPI registry.
 461  *
 462  */
 463 static int
 464 adaptor_init (gint * argc, gchar ** argv[])
 465 {
 466   GOptionContext *opt;
 467   GError *err = NULL;
 468   DBusError error;
 469   DBusConnection *bus;
 470   AtkObject *root;
 471   gchar *introspection_directory;
 472   static gboolean inited = FALSE;
 473
 474   if (inited)
 475     return 0;
 476
 477   inited = TRUE;
 478
 479   DRoutePath *treepath, *accpath;
 480
 481   root = atk_get_root ();
 482   g_return_val_if_fail (root, 0);
 483
 484   /* Parse command line options */
 485   opt = g_option_context_new (NULL);
 486   g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
 487   g_option_context_set_ignore_unknown_options (opt, TRUE);
 488   if (!g_option_context_parse (opt, argc, argv, &err))
 489     g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
 490
 491   /* Allocate global data and do ATK initializations */
 492   spi_global_app_data = g_new0 (SpiBridge, 1);
 493   atk_misc = atk_misc_get_instance ();
 494   spi_global_app_data->root = g_object_ref (root);
 495
 496   /* Set up D-Bus connection and register bus name */
 497   dbus_error_init (&error);
 498   spi_global_app_data->bus = spi_atk_bridge_get_bus ();
 499   if (!spi_global_app_data->bus)
 500     {
 501       g_free (spi_global_app_data);
 502       spi_global_app_data = NULL;
 503       return 0;
 504     }
 505
 506   if (atspi_dbus_name != NULL)
 507     {
 508       if (dbus_bus_request_name
 509           (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
 510         {
 511           g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
 512         }
 513       else
 514         {
 515           g_print
 516             ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
 517              atspi_dbus_name);
 518         }
 519     }
 520
 521   dbus_connection_setup_with_g_main (spi_global_app_data->bus,
 522                                      g_main_context_default ());
 523
 524   /* Hook our plug-and socket functions */
 525   install_plug_hooks ();
 526
 527   /*
 528    * Create the leasing, register and cache objects.
 529    * The order is important here, the cache depends on the
 530    * register object.
 531    */
 532   spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
 533   spi_global_leasing  = g_object_new (SPI_LEASING_TYPE, NULL);
 534   spi_global_cache    = g_object_new (SPI_CACHE_TYPE, NULL);
 535
 536   /* Register droute for routing AT-SPI messages */
 537   spi_global_app_data->droute =
 538     droute_new (spi_global_app_data->bus);
 539
 540   treepath = droute_add_one (spi_global_app_data->droute,
 541                              "/org/a11y/atspi/cache", spi_global_cache);
 542
 543   if (!treepath)
 544     {
 545       g_warning ("atk-bridge: Error in droute_add_one().  Already running?");
 546       return 0;
 547     }
 548
 549   accpath = droute_add_many (spi_global_app_data->droute,
 550                              "/org/a11y/atspi/accessible",
 551                              NULL,
 552                              introspect_children_cb,
 553                              NULL,
 554                              (DRouteGetDatumFunction)
 555                              spi_global_register_path_to_object);
 556
 557
 558   /* Register all interfaces with droute and set up application accessible db */
 559   spi_initialize_cache (treepath);
 560   spi_initialize_accessible (accpath);
 561   spi_initialize_application (accpath);
 562   spi_initialize_action (accpath);
 563   spi_initialize_collection (accpath);
 564   spi_initialize_component (accpath);
 565   spi_initialize_document (accpath);
 566   spi_initialize_editabletext (accpath);
 567   spi_initialize_hyperlink (accpath);
 568   spi_initialize_hypertext (accpath);
 569   spi_initialize_image (accpath);
 570   spi_initialize_selection (accpath);
 571   spi_initialize_socket (accpath);
 572   spi_initialize_table (accpath);
 573   spi_initialize_text (accpath);
 574   spi_initialize_value (accpath);
 575
 576   /* Register methods to send D-Bus signals on certain ATK events */
 577   spi_atk_register_event_listeners ();
 578
 579   /* Register this app by sending a signal out to AT-SPI registry daemon */
 580   if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
 581     register_application (spi_global_app_data);
 582
 583   g_atexit (exit_func);
 584
 585   return 0;
 586 }
 587
 588 /*---------------------------------------------------------------------------*/
 589
 590 int
 591 gtk_module_init (gint * argc, gchar ** argv[])
 592 {
 593   const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
 594
 595   if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
 596     {
 597       return adaptor_init (argc, argv);
 598     }
 599   return 0;
 600 }
 601
 602 void
 603 gnome_accessibility_module_init (void)
 604 {
 605   const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
 606
 607   if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
 608     {
 609       adaptor_init (NULL, NULL);
 610
 611       if (g_getenv ("AT_SPI_DEBUG"))
 612         {
 613           g_print ("Atk Accessibility bridge initialized\n");
 614         }
 615     }
 616 }
 617
 618 void
 619 gnome_accessibility_module_shutdown (void)
 620 {
 621   spi_atk_deregister_event_listeners ();
 622   exit_func ();
 623 }
 624
 625 /*END------------------------------------------------------------------------*/