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