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  * Provides the path for the introspection directory.
  52  */
  53 #if !defined ATSPI_INTROSPECTION_PATH
  54 #error "No introspection XML directory defined"
  55 #endif
  56
  57 /*---------------------------------------------------------------------------*/
  58
  59 SpiBridge *spi_global_app_data = NULL;
  60
  61 static const AtkMisc *atk_misc = NULL;
  62
  63 /*static Display *bridge_display = NULL;*/
  64
  65 /*---------------------------------------------------------------------------*/
  66
  67 /*
  68  * Returns a 'canonicalized' value for DISPLAY,
  69  * with the screen number stripped off if present.
  70  *
  71  */
  72 static const gchar *
  73 spi_display_name (void)
  74 {
  75   static const char *canonical_display_name = NULL;
  76   if (!canonical_display_name)
  77     {
  78       const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
  79       if (!display_env)
  80         {
  81           display_env = g_getenv ("DISPLAY");
  82           if (!display_env || !display_env[0])
  83             canonical_display_name = ":0";
  84           else
  85             {
  86               gchar *display_p, *screen_p;
  87               canonical_display_name = g_strdup (display_env);
  88               display_p = strrchr (canonical_display_name, ':');
  89               screen_p = strrchr (canonical_display_name, '.');
  90               if (screen_p && display_p && (screen_p > display_p))
  91                 {
  92                   *screen_p = '\0';
  93                 }
  94             }
  95         }
  96       else
  97         {
  98           canonical_display_name = display_env;
  99         }
 100     }
 101   return canonical_display_name;
 102 }
 103
 104 /*---------------------------------------------------------------------------*/
 105
 106 /*
 107  * Gets the IOR from the XDisplay.
 108  * Not currently used in D-Bus version, but something similar
 109  * may be employed in the future for accessing the registry daemon
 110  * bus name.
 111  */
 112
 113 static DBusConnection *
 114 spi_atk_bridge_get_bus (void)
 115 {
 116   Atom AT_SPI_BUS;
 117   Atom actual_type;
 118   Display *bridge_display;
 119   int actual_format;
 120   unsigned char *data = NULL;
 121   unsigned long nitems;
 122   unsigned long leftover;
 123
 124   DBusConnection *bus = NULL;
 125   DBusError error;
 126
 127   bridge_display = XOpenDisplay (spi_display_name ());
 128   if (!bridge_display)
 129     g_error ("AT_SPI: Could not get the display\n");
 130
 131   AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
 132   XGetWindowProperty (bridge_display,
 133                       XDefaultRootWindow (bridge_display),
 134                       AT_SPI_BUS, 0L,
 135                       (long) BUFSIZ, False,
 136                       (Atom) 31, &actual_type, &actual_format,
 137                       &nitems, &leftover, &data);
 138
 139   dbus_error_init (&error);
 140
 141   if (data == NULL)
 142     {
 143       g_warning
 144         ("AT-SPI: Accessibility bus not found - Using session bus.\n");
 145       bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
 146       if (!bus)
 147         g_error ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
 148     }
 149   else
 150     {
 151 g_print("dbg: data=%s\n", data);
 152       bus = dbus_connection_open (data, &error);
 153       if (!bus)
 154         {
 155           g_error ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
 156         }
 157       else
 158         {
 159           if (!dbus_bus_register (bus, &error))
 160             g_error ("AT-SPI: Couldn't register with bus: %s\n", error.message);
 161         }
 162     }
 163
 164   return bus;
 165 }
 166
 167 /*---------------------------------------------------------------------------*/
 168
 169 static void
 170 register_application (SpiBridge * app)
 171 {
 172   DBusMessage *message, *reply;
 173   DBusMessageIter iter;
 174   DBusError error;
 175
 176   dbus_error_init (&error);
 177
 178   message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
 179                                           SPI_DBUS_PATH_ROOT,
 180                                           SPI_DBUS_INTERFACE_SOCKET,
 181                                           "Embed");
 182
 183   dbus_message_iter_init_append (message, &iter);
 184   spi_object_append_reference (&iter, app->root);
 185
 186   reply = dbus_connection_send_with_reply_and_block (app->bus, message, -1, &error);
 187
 188   if (message)
 189     dbus_message_unref (message);
 190
 191   if (reply)
 192     {
 193       DBusMessageIter iter, iter_struct;
 194       gchar *app_name, *obj_path;
 195
 196       dbus_message_iter_init (reply, &iter);
 197       dbus_message_iter_recurse (&iter, &iter_struct);
 198       if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_STRING))
 199             g_error ("AT-SPI: Could not obtain desktop path or name\n");
 200       dbus_message_iter_get_basic (&iter_struct, &app_name);
 201       if (!dbus_message_iter_next (&iter_struct))
 202             g_error ("AT-SPI: Could not obtain desktop name");
 203       if (!(dbus_message_iter_get_arg_type (&iter_struct) == DBUS_TYPE_OBJECT_PATH))
 204             g_error ("AT-SPI: Could not obtain desktop path");
 205       dbus_message_iter_get_basic (&iter_struct, &obj_path);
 206
 207       app->desktop_name = g_strdup (app_name);
 208       app->desktop_path = g_strdup (obj_path);
 209     }
 210   else
 211     {
 212       g_error ("AT-SPI: Could not embed inside desktop: %s\n", error.message);
 213     }
 214
 215 }
 216
 217 /*---------------------------------------------------------------------------*/
 218
 219 static void
 220 deregister_application (SpiBridge * app)
 221 {
 222   DBusMessage *message;
 223   DBusMessageIter iter;
 224   DBusError error;
 225   const char *uname;
 226
 227   dbus_error_init (&error);
 228
 229   message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
 230                                           SPI_DBUS_PATH_REGISTRY,
 231                                           SPI_DBUS_INTERFACE_REGISTRY,
 232                                           "DeregisterApplication");
 233   dbus_message_set_no_reply (message, TRUE);
 234
 235   uname = dbus_bus_get_unique_name (app->bus);
 236
 237   dbus_message_iter_init_append (message, &iter);
 238   dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
 239   dbus_connection_send (app->bus, message, NULL);
 240   if (message)
 241     dbus_message_unref (message);
 242 }
 243
 244 /*---------------------------------------------------------------------------*/
 245
 246 static void
 247 exit_func (void)
 248 {
 249   if (!spi_global_app_data)
 250     {
 251       return;
 252     }
 253
 254   spi_atk_tidy_windows ();
 255   spi_atk_deregister_event_listeners ();
 256   deregister_application (spi_global_app_data);
 257
 258   g_free (spi_global_app_data);
 259   spi_global_app_data = NULL;
 260
 261   /* Not currently creating an XDisplay */
 262 #if 0
 263   if (bridge_display)
 264     XCloseDisplay (bridge_display);
 265 #endif
 266 }
 267
 268 /*---------------------------------------------------------------------------*/
 269
 270 #ifdef SPI_ATK_PLUG_SOCKET
 271 static AtkPlugClass *plug_class;
 272 static AtkSocketClass *socket_class;
 273
 274 static gchar *
 275 get_plug_id (AtkPlug * plug)
 276 {
 277   const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
 278   gchar *path;
 279   GString *str = g_string_new (NULL);
 280
 281   path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
 282   g_string_printf (str, "%s:%s", uname, path);
 283   g_free (path);
 284   return g_string_free (str, FALSE);
 285 }
 286
 287 static void
 288 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
 289 {
 290   AtkObject *accessible = ATK_OBJECT(socket);
 291   gchar *plug_name, *plug_path;
 292
 293   /* Force registration */
 294   gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
 295   /* Let the plug know that it has been embedded */
 296   plug_name = g_strdup (plug_id);
 297   if (!plug_name)
 298     {
 299       g_free (path);
 300       return;
 301     }
 302   plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
 303   if (plug_path)
 304     {
 305       DBusMessage *message;
 306       *(plug_path++) = '\0';
 307       message = dbus_message_new_method_call (plug_name, plug_path, "org.freedesktop.atspi.Accessible", "Embedded");
 308       dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
 309       dbus_connection_send (spi_global_app_data->bus, message, NULL);
 310     }
 311   g_free (plug_name);
 312   g_free (path);
 313 }
 314
 315 static void
 316 install_plug_hooks ()
 317 {
 318   gpointer data;
 319
 320   data = g_type_class_ref (ATK_TYPE_PLUG);
 321   plug_class = ATK_PLUG_CLASS (data);
 322   data = g_type_class_ref (ATK_TYPE_SOCKET);
 323   socket_class = ATK_SOCKET_CLASS (data);
 324   plug_class->get_object_id = get_plug_id;
 325   socket_class->embed = socket_embed_hook;
 326 }
 327 #endif
 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   /* Get D-Bus introspection directory */
 421   introspection_directory = (char *) g_getenv ("ATSPI_INTROSPECTION_PATH");
 422   if (introspection_directory == NULL)
 423     introspection_directory = ATSPI_INTROSPECTION_PATH;
 424
 425   /* Register droute for routing AT-SPI messages */
 426   spi_global_app_data->droute =
 427     droute_new (spi_global_app_data->bus, introspection_directory);
 428
 429   treepath = droute_add_one (spi_global_app_data->droute,
 430                              "/org/at_spi/cache", spi_global_cache);
 431
 432   accpath = droute_add_many (spi_global_app_data->droute,
 433                              "/org/freedesktop/atspi/accessible",
 434                              NULL,
 435                              (DRouteGetDatumFunction)
 436                              spi_global_register_path_to_object);
 437
 438
 439   /* Register all interfaces with droute and set up application accessible db */
 440   spi_initialize_cache (treepath);
 441   spi_initialize_accessible (accpath);
 442   spi_initialize_application (accpath);
 443   spi_initialize_action (accpath);
 444   spi_initialize_collection (accpath);
 445   spi_initialize_component (accpath);
 446   spi_initialize_document (accpath);
 447   spi_initialize_editabletext (accpath);
 448   spi_initialize_hyperlink (accpath);
 449   spi_initialize_hypertext (accpath);
 450   spi_initialize_image (accpath);
 451   spi_initialize_selection (accpath);
 452   spi_initialize_table (accpath);
 453   spi_initialize_text (accpath);
 454   spi_initialize_value (accpath);
 455
 456   /* Register methods to send D-Bus signals on certain ATK events */
 457   spi_atk_register_event_listeners ();
 458
 459 #ifdef SPI_ATK_PLUG_SOCKET
 460   /* Hook our plug-and socket functions */
 461   install_plug_hooks ();
 462 #endif
 463
 464   /* Register this app by sending a signal out to AT-SPI registry daemon */
 465   if (!atspi_no_register)
 466     register_application (spi_global_app_data);
 467
 468   g_atexit (exit_func);
 469
 470   return 0;
 471 }
 472
 473 /*---------------------------------------------------------------------------*/
 474
 475 int
 476 gtk_module_init (gint * argc, gchar ** argv[])
 477 {
 478   const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
 479
 480   if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
 481     {
 482       return adaptor_init (argc, argv);
 483     }
 484   return 0;
 485 }
 486
 487 void
 488 gnome_accessibility_module_init (void)
 489 {
 490   const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
 491
 492   if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
 493     {
 494       adaptor_init (NULL, NULL);
 495
 496       if (g_getenv ("AT_SPI_DEBUG"))
 497         {
 498           g_print ("Atk Accessibility bridge initialized\n");
 499         }
 500     }
 501 }
 502
 503 void
 504 gnome_accessibility_module_shutdown (void)
 505 {
 506   spi_atk_deregister_event_listeners ();
 507   exit_func ();
 508 }
 509
 510 /*END------------------------------------------------------------------------*/