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 static void
 306 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
 307 {
 308   AtkObject *accessible = ATK_OBJECT(socket);
 309   gchar *plug_name, *plug_path;
 310
 311   /* Force registration */
 312   gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
 313   /* Let the plug know that it has been embedded */
 314   plug_name = g_strdup (plug_id);
 315   if (!plug_name)
 316     {
 317       g_free (path);
 318       return;
 319     }
 320   plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
 321   if (plug_path)
 322     {
 323       DBusMessage *message;
 324       *(plug_path++) = '\0';
 325       message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
 326       dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
 327       dbus_connection_send (spi_global_app_data->bus, message, NULL);
 328     }
 329   g_free (plug_name);
 330   g_free (path);
 331 }
 332
 333 static void
 334 install_plug_hooks ()
 335 {
 336   gpointer data;
 337
 338   data = g_type_class_ref (ATK_TYPE_PLUG);
 339   plug_class = ATK_PLUG_CLASS (data);
 340   data = g_type_class_ref (ATK_TYPE_SOCKET);
 341   socket_class = ATK_SOCKET_CLASS (data);
 342   plug_class->get_object_id = get_plug_id;
 343   socket_class->embed = socket_embed_hook;
 344 }
 345
 346 gchar *atspi_dbus_name = NULL;
 347 static gboolean atspi_no_register = FALSE;
 348
 349 static GOptionEntry atspi_option_entries[] = {
 350   {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
 351    "D-Bus bus name to register as", NULL},
 352   {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
 353    "Do not register with Registry Daemon", NULL},
 354   {NULL}
 355 };
 356
 357 /*
 358  * spi_app_init
 359  *
 360  * The following needs to be initialized.
 361  *
 362  * - DRoute for routing message to their accessible objects.
 363  * - Event handlers for emmitting signals on specific ATK events.
 364  * - Application registration with the AT-SPI registry.
 365  *
 366  */
 367 static int
 368 adaptor_init (gint * argc, gchar ** argv[])
 369 {
 370   GOptionContext *opt;
 371   GError *err = NULL;
 372   DBusError error;
 373   DBusConnection *bus;
 374   AtkObject *root;
 375   gchar *introspection_directory;
 376   static gboolean inited = FALSE;
 377
 378   if (inited)
 379     return 0;
 380
 381   inited = TRUE;
 382
 383   DRoutePath *treepath, *accpath;
 384
 385   root = atk_get_root ();
 386   g_return_val_if_fail (root, 0);
 387
 388   /* Parse command line options */
 389   opt = g_option_context_new (NULL);
 390   g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
 391   g_option_context_set_ignore_unknown_options (opt, TRUE);
 392   if (!g_option_context_parse (opt, argc, argv, &err))
 393     g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
 394
 395   /* Allocate global data and do ATK initializations */
 396   spi_global_app_data = g_new0 (SpiBridge, 1);
 397   atk_misc = atk_misc_get_instance ();
 398   spi_global_app_data->root = g_object_ref (root);
 399
 400   /* Set up D-Bus connection and register bus name */
 401   dbus_error_init (&error);
 402   spi_global_app_data->bus = spi_atk_bridge_get_bus ();
 403   if (!spi_global_app_data->bus)
 404     {
 405       g_free (spi_global_app_data);
 406       spi_global_app_data = NULL;
 407       return 0;
 408     }
 409
 410   if (atspi_dbus_name != NULL)
 411     {
 412       if (dbus_bus_request_name
 413           (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
 414         {
 415           g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
 416         }
 417       else
 418         {
 419           g_print
 420             ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
 421              atspi_dbus_name);
 422         }
 423     }
 424
 425   dbus_connection_setup_with_g_main (spi_global_app_data->bus,
 426                                      g_main_context_default ());
 427
 428   /* Hook our plug-and socket functions */
 429   install_plug_hooks ();
 430
 431   /*
 432    * Create the leasing, register and cache objects.
 433    * The order is important here, the cache depends on the
 434    * register object.
 435    */
 436   spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
 437   spi_global_leasing  = g_object_new (SPI_LEASING_TYPE, NULL);
 438   spi_global_cache    = g_object_new (SPI_CACHE_TYPE, NULL);
 439
 440   /* Register droute for routing AT-SPI messages */
 441   spi_global_app_data->droute =
 442     droute_new (spi_global_app_data->bus);
 443
 444   treepath = droute_add_one (spi_global_app_data->droute,
 445                              "/org/a11y/atspi/cache", spi_global_cache);
 446
 447   if (!treepath)
 448     {
 449       g_warning ("atk-bridge: Error in droute_add_one().  Already running?");
 450       return 0;
 451     }
 452
 453   accpath = droute_add_many (spi_global_app_data->droute,
 454                              "/org/a11y/atspi/accessible",
 455                              NULL,
 456                              (DRouteGetDatumFunction)
 457                              spi_global_register_path_to_object);
 458
 459
 460   /* Register all interfaces with droute and set up application accessible db */
 461   spi_initialize_cache (treepath);
 462   spi_initialize_accessible (accpath);
 463   spi_initialize_application (accpath);
 464   spi_initialize_action (accpath);
 465   spi_initialize_collection (accpath);
 466   spi_initialize_component (accpath);
 467   spi_initialize_document (accpath);
 468   spi_initialize_editabletext (accpath);
 469   spi_initialize_hyperlink (accpath);
 470   spi_initialize_hypertext (accpath);
 471   spi_initialize_image (accpath);
 472   spi_initialize_selection (accpath);
 473   spi_initialize_socket (accpath);
 474   spi_initialize_table (accpath);
 475   spi_initialize_text (accpath);
 476   spi_initialize_value (accpath);
 477
 478   /* Register methods to send D-Bus signals on certain ATK events */
 479   spi_atk_register_event_listeners ();
 480
 481   /* Register this app by sending a signal out to AT-SPI registry daemon */
 482   if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
 483     register_application (spi_global_app_data);
 484
 485   g_atexit (exit_func);
 486
 487   return 0;
 488 }
 489
 490 /*---------------------------------------------------------------------------*/
 491
 492 int
 493 gtk_module_init (gint * argc, gchar ** argv[])
 494 {
 495   const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
 496
 497   if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
 498     {
 499       return adaptor_init (argc, argv);
 500     }
 501   return 0;
 502 }
 503
 504 void
 505 gnome_accessibility_module_init (void)
 506 {
 507   const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
 508
 509   if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
 510     {
 511       adaptor_init (NULL, NULL);
 512
 513       if (g_getenv ("AT_SPI_DEBUG"))
 514         {
 515           g_print ("Atk Accessibility bridge initialized\n");
 516         }
 517     }
 518 }
 519
 520 void
 521 gnome_accessibility_module_shutdown (void)
 522 {
 523   spi_atk_deregister_event_listeners ();
 524   exit_func ();
 525 }
 526
 527 /*END------------------------------------------------------------------------*/