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 gboolean
 187 register_application (SpiBridge * app)
 188 {
 189   DBusMessage *message, *reply;
 190   DBusMessageIter iter;
 191   DBusError error;
 192
 193   dbus_error_init (&error);
 194
 195   message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
 196                                           SPI_DBUS_PATH_ROOT,
 197                                           SPI_DBUS_INTERFACE_SOCKET,
 198                                           "Embed");
 199
 200   dbus_message_iter_init_append (message, &iter);
 201   spi_object_append_reference (&iter, app->root);
 202
 203   reply = send_and_allow_reentry (app->bus, message, &error);
 204
 205   if (message)
 206     dbus_message_unref (message);
 207
 208   if (reply)
 209     {
 210       DBusMessageIter iter, iter_struct;
 211       gchar *app_name, *obj_path;
 212
 213       if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
 214         {
 215           g_warning ("AT-SPI: Could not obtain desktop path or name\n");
 216           return FALSE;
 217         }
 218
 219       dbus_message_iter_init (reply, &iter);
 220       dbus_message_iter_recurse (&iter, &iter_struct);
 221       dbus_message_iter_get_basic (&iter_struct, &app_name);
 222       dbus_message_iter_next (&iter_struct);
 223       dbus_message_iter_get_basic (&iter_struct, &obj_path);
 224
 225       app->desktop_name = g_strdup (app_name);
 226       app->desktop_path = g_strdup (obj_path);
 227     }
 228   else
 229     {
 230       g_warning ("AT-SPI: Could not embed inside desktop: %s\n", error.message);
 231       return FALSE;
 232     }
 233   return TRUE;
 234 }
 235
 236 /*---------------------------------------------------------------------------*/
 237
 238 static void
 239 deregister_application (SpiBridge * app)
 240 {
 241   DBusMessage *message;
 242   DBusMessageIter iter;
 243   DBusError error;
 244   const char *uname;
 245
 246   dbus_error_init (&error);
 247
 248   message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
 249                                           SPI_DBUS_PATH_REGISTRY,
 250                                           SPI_DBUS_INTERFACE_REGISTRY,
 251                                           "DeregisterApplication");
 252   dbus_message_set_no_reply (message, TRUE);
 253
 254   uname = dbus_bus_get_unique_name (app->bus);
 255
 256   dbus_message_iter_init_append (message, &iter);
 257   dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
 258   dbus_connection_send (app->bus, message, NULL);
 259   if (message)
 260     dbus_message_unref (message);
 261 }
 262
 263 /*---------------------------------------------------------------------------*/
 264
 265 static void
 266 exit_func (void)
 267 {
 268   if (!spi_global_app_data)
 269     {
 270       return;
 271     }
 272
 273   spi_atk_tidy_windows ();
 274   spi_atk_deregister_event_listeners ();
 275   deregister_application (spi_global_app_data);
 276
 277   g_free (spi_global_app_data);
 278   spi_global_app_data = NULL;
 279
 280   /* Not currently creating an XDisplay */
 281 #if 0
 282   if (bridge_display)
 283     XCloseDisplay (bridge_display);
 284 #endif
 285 }
 286
 287 /*---------------------------------------------------------------------------*/
 288
 289 static AtkPlugClass *plug_class;
 290 static AtkSocketClass *socket_class;
 291
 292 static gchar *
 293 get_plug_id (AtkPlug * plug)
 294 {
 295   const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
 296   gchar *path;
 297   GString *str = g_string_new (NULL);
 298
 299   path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
 300   g_string_printf (str, "%s:%s", uname, path);
 301   g_free (path);
 302   return g_string_free (str, FALSE);
 303 }
 304
 305 AtkStateSet *
 306 socket_ref_state_set (AtkObject *accessible)
 307 {
 308   char *child_name, *child_path;
 309   AtkSocket *socket = ATK_SOCKET (accessible);
 310   int count = 0;
 311   int j;
 312   int v;
 313   DBusMessage *message, *reply;
 314   DBusMessageIter iter, iter_array;
 315   AtkStateSet *set;
 316
 317   if (!socket->embedded_plug_id)
 318     return NULL;
 319
 320   child_name = g_strdup (socket->embedded_plug_id);
 321   if (!child_name)
 322     return NULL;
 323   child_path = g_utf8_strchr (child_name + 1, -1, ':');
 324   if (!child_path)
 325     {
 326       g_free (child_name);
 327       return NULL;
 328     }
 329   *(child_path++) = '\0';
 330   message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
 331   g_free (child_name);
 332   reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
 333   dbus_message_unref (message);
 334   if (reply == NULL)
 335     return NULL;
 336   if (strcmp (dbus_message_get_signature (reply), "au") != 0)
 337     {
 338       dbus_message_unref (reply);
 339       return NULL;
 340     }
 341   set = atk_state_set_new ();
 342   if (!set)
 343     return  NULL;
 344   dbus_message_iter_init (reply, &iter);
 345   dbus_message_iter_recurse (&iter, &iter_array);
 346   do
 347     {
 348       dbus_message_iter_get_basic (&iter_array, &v);
 349       for (j = 0; j < 32; j++)
 350         {
 351           if (v & (1 << j))
 352             {
 353               AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
 354               atk_state_set_add_state (set, state);
 355             }
 356         }
 357       count++;
 358     }
 359   while (dbus_message_iter_next (&iter_array));
 360   dbus_message_unref (reply);
 361   return set;
 362 }
 363
 364 static void
 365 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
 366 {
 367   AtkObject *accessible = ATK_OBJECT(socket);
 368   gchar *plug_name, *plug_path;
 369   AtkObjectClass *klass;
 370
 371   /* Force registration */
 372   gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
 373   /* Let the plug know that it has been embedded */
 374   plug_name = g_strdup (plug_id);
 375   if (!plug_name)
 376     {
 377       g_free (path);
 378       return;
 379     }
 380   plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
 381   if (plug_path)
 382     {
 383       DBusMessage *message;
 384       *(plug_path++) = '\0';
 385       message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
 386       dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
 387       dbus_connection_send (spi_global_app_data->bus, message, NULL);
 388     }
 389   g_free (plug_name);
 390   g_free (path);
 391
 392   klass = ATK_OBJECT_GET_CLASS (accessible);
 393   klass->ref_state_set = socket_ref_state_set;
 394 }
 395
 396 static void
 397 install_plug_hooks ()
 398 {
 399   gpointer data;
 400
 401   data = g_type_class_ref (ATK_TYPE_PLUG);
 402   plug_class = ATK_PLUG_CLASS (data);
 403   data = g_type_class_ref (ATK_TYPE_SOCKET);
 404   socket_class = ATK_SOCKET_CLASS (data);
 405   plug_class->get_object_id = get_plug_id;
 406   socket_class->embed = socket_embed_hook;
 407 }
 408
 409 gchar *atspi_dbus_name = NULL;
 410 static gboolean atspi_no_register = FALSE;
 411
 412 static GOptionEntry atspi_option_entries[] = {
 413   {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
 414    "D-Bus bus name to register as", NULL},
 415   {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
 416    "Do not register with Registry Daemon", NULL},
 417   {NULL}
 418 };
 419
 420 /*
 421  * spi_app_init
 422  *
 423  * The following needs to be initialized.
 424  *
 425  * - DRoute for routing message to their accessible objects.
 426  * - Event handlers for emmitting signals on specific ATK events.
 427  * - Application registration with the AT-SPI registry.
 428  *
 429  */
 430 static int
 431 adaptor_init (gint * argc, gchar ** argv[])
 432 {
 433   GOptionContext *opt;
 434   GError *err = NULL;
 435   DBusError error;
 436   DBusConnection *bus;
 437   AtkObject *root;
 438   gchar *introspection_directory;
 439   static gboolean inited = FALSE;
 440
 441   if (inited)
 442     return 0;
 443
 444   inited = TRUE;
 445
 446   DRoutePath *treepath, *accpath;
 447
 448   root = atk_get_root ();
 449   g_return_val_if_fail (root, 0);
 450
 451   /* Parse command line options */
 452   opt = g_option_context_new (NULL);
 453   g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
 454   g_option_context_set_ignore_unknown_options (opt, TRUE);
 455   if (!g_option_context_parse (opt, argc, argv, &err))
 456     g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
 457
 458   /* Allocate global data and do ATK initializations */
 459   spi_global_app_data = g_new0 (SpiBridge, 1);
 460   atk_misc = atk_misc_get_instance ();
 461   spi_global_app_data->root = g_object_ref (root);
 462
 463   /* Set up D-Bus connection and register bus name */
 464   dbus_error_init (&error);
 465   spi_global_app_data->bus = spi_atk_bridge_get_bus ();
 466   if (!spi_global_app_data->bus)
 467     {
 468       g_free (spi_global_app_data);
 469       spi_global_app_data = NULL;
 470       return 0;
 471     }
 472
 473   if (atspi_dbus_name != NULL)
 474     {
 475       if (dbus_bus_request_name
 476           (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
 477         {
 478           g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
 479         }
 480       else
 481         {
 482           g_print
 483             ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
 484              atspi_dbus_name);
 485         }
 486     }
 487
 488   dbus_connection_setup_with_g_main (spi_global_app_data->bus,
 489                                      g_main_context_default ());
 490
 491   /* Hook our plug-and socket functions */
 492   install_plug_hooks ();
 493
 494   /*
 495    * Create the leasing, register and cache objects.
 496    * The order is important here, the cache depends on the
 497    * register object.
 498    */
 499   spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
 500   spi_global_leasing  = g_object_new (SPI_LEASING_TYPE, NULL);
 501   spi_global_cache    = g_object_new (SPI_CACHE_TYPE, NULL);
 502
 503   /* Register droute for routing AT-SPI messages */
 504   spi_global_app_data->droute =
 505     droute_new (spi_global_app_data->bus);
 506
 507   treepath = droute_add_one (spi_global_app_data->droute,
 508                              "/org/a11y/atspi/cache", spi_global_cache);
 509
 510   if (!treepath)
 511     {
 512       g_warning ("atk-bridge: Error in droute_add_one().  Already running?");
 513       return 0;
 514     }
 515
 516   accpath = droute_add_many (spi_global_app_data->droute,
 517                              "/org/a11y/atspi/accessible",
 518                              NULL,
 519                              (DRouteGetDatumFunction)
 520                              spi_global_register_path_to_object);
 521
 522
 523   /* Register all interfaces with droute and set up application accessible db */
 524   spi_initialize_cache (treepath);
 525   spi_initialize_accessible (accpath);
 526   spi_initialize_application (accpath);
 527   spi_initialize_action (accpath);
 528   spi_initialize_collection (accpath);
 529   spi_initialize_component (accpath);
 530   spi_initialize_document (accpath);
 531   spi_initialize_editabletext (accpath);
 532   spi_initialize_hyperlink (accpath);
 533   spi_initialize_hypertext (accpath);
 534   spi_initialize_image (accpath);
 535   spi_initialize_selection (accpath);
 536   spi_initialize_socket (accpath);
 537   spi_initialize_table (accpath);
 538   spi_initialize_text (accpath);
 539   spi_initialize_value (accpath);
 540
 541   /* Register methods to send D-Bus signals on certain ATK events */
 542   spi_atk_register_event_listeners ();
 543
 544   /* Register this app by sending a signal out to AT-SPI registry daemon */
 545   if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
 546     register_application (spi_global_app_data);
 547
 548   g_atexit (exit_func);
 549
 550   return 0;
 551 }
 552
 553 /*---------------------------------------------------------------------------*/
 554
 555 int
 556 gtk_module_init (gint * argc, gchar ** argv[])
 557 {
 558   const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
 559
 560   if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
 561     {
 562       return adaptor_init (argc, argv);
 563     }
 564   return 0;
 565 }
 566
 567 void
 568 gnome_accessibility_module_init (void)
 569 {
 570   const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
 571
 572   if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
 573     {
 574       adaptor_init (NULL, NULL);
 575
 576       if (g_getenv ("AT_SPI_DEBUG"))
 577         {
 578           g_print ("Atk Accessibility bridge initialized\n");
 579         }
 580     }
 581 }
 582
 583 void
 584 gnome_accessibility_module_shutdown (void)
 585 {
 586   spi_atk_deregister_event_listeners ();
 587   exit_func ();
 588 }
 589
 590 /*END------------------------------------------------------------------------*/