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