atspi/atspi-misc.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Library General Public
  19  * License along with this library; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 02111-1307, USA.
  22  */
  23
  24 /*
  25  *
  26  * Basic SPI initialization and event loop function prototypes
  27  *
  28  */
  29
  30 #include "atspi-private.h"
  31 #include "X11/Xlib.h"
  32 #include <stdio.h>
  33 #include <string.h>
  34
  35 static void handle_get_items (DBusPendingCall *pending, void *user_data);
  36
  37 static DBusConnection *bus = NULL;
  38 static GHashTable *apps = NULL;
  39 static GHashTable *live_refs = NULL;
  40 static GQueue *exception_handlers = NULL;
  41 static DBusError exception;
  42
  43 const char *atspi_path_dec = ATSPI_DBUS_PATH_DEC;
  44 const char *atspi_path_registry = ATSPI_DBUS_PATH_REGISTRY;
  45 const char *atspi_path_root = ATSPI_DBUS_PATH_ROOT;
  46 const char *atspi_bus_registry = ATSPI_DBUS_NAME_REGISTRY;
  47 const char *atspi_interface_accessible = ATSPI_DBUS_INTERFACE_ACCESSIBLE;
  48 const char *atspi_interface_action = ATSPI_DBUS_INTERFACE_ACTION;
  49 const char *atspi_interface_application = ATSPI_DBUS_INTERFACE_APPLICATION;
  50 const char *atspi_interface_collection = ATSPI_DBUS_INTERFACE_COLLECTION;
  51 const char *atspi_interface_component = ATSPI_DBUS_INTERFACE_COMPONENT;
  52 const char *atspi_interface_dec = ATSPI_DBUS_INTERFACE_DEC;
  53 const char *atspi_interface_device_event_listener = ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER;
  54 const char *atspi_interface_document = ATSPI_DBUS_INTERFACE_DOCUMENT;
  55 const char *atspi_interface_editable_text = ATSPI_DBUS_INTERFACE_EDITABLE_TEXT;
  56 const char *atspi_interface_event_object = ATSPI_DBUS_INTERFACE_EVENT_OBJECT;
  57 const char *atspi_interface_hyperlink = ATSPI_DBUS_INTERFACE_HYPERLINK;
  58 const char *atspi_interface_hypertext = ATSPI_DBUS_INTERFACE_HYPERTEXT;
  59 const char *atspi_interface_image = ATSPI_DBUS_INTERFACE_IMAGE;
  60 const char *atspi_interface_registry = ATSPI_DBUS_INTERFACE_REGISTRY;
  61 const char *atspi_interface_selection = ATSPI_DBUS_INTERFACE_SELECTION;
  62 const char *atspi_interface_table = ATSPI_DBUS_INTERFACE_TABLE;
  63 const char *atspi_interface_text = ATSPI_DBUS_INTERFACE_TEXT;
  64 const char *atspi_interface_cache = ATSPI_DBUS_INTERFACE_CACHE;
  65 const char *atspi_interface_value = ATSPI_DBUS_INTERFACE_VALUE;
  66
  67 static const char *interfaces[] =
  68 {
  69   ATSPI_DBUS_INTERFACE_ACCESSIBLE,
  70   ATSPI_DBUS_INTERFACE_ACTION,
  71   ATSPI_DBUS_INTERFACE_APPLICATION,
  72   ATSPI_DBUS_INTERFACE_COLLECTION,
  73   ATSPI_DBUS_INTERFACE_COMPONENT,
  74   ATSPI_DBUS_INTERFACE_DOCUMENT,
  75   ATSPI_DBUS_INTERFACE_EDITABLE_TEXT,
  76   ATSPI_DBUS_INTERFACE_HYPERLINK,
  77   ATSPI_DBUS_INTERFACE_HYPERTEXT,
  78   ATSPI_DBUS_INTERFACE_IMAGE,
  79   "org.a11y.atspi.LoginHelper",
  80   ATSPI_DBUS_INTERFACE_SELECTION,
  81   ATSPI_DBUS_INTERFACE_TABLE,
  82   ATSPI_DBUS_INTERFACE_TEXT,
  83   ATSPI_DBUS_INTERFACE_VALUE,
  84   NULL
  85 };
  86
  87 gint
  88 _atspi_get_iface_num (const char *iface)
  89 {
  90   /* TODO: Use a binary search or hash to improve performance */
  91   int i;
  92
  93   for (i = 0; interfaces[i]; i++)
  94   {
  95     if (!strcmp(iface, interfaces[i])) return i;
  96   }
  97   return -1;
  98 }
  99
 100 static GHashTable *
 101 get_live_refs (void)
 102 {
 103   if (!live_refs)
 104     {
 105       live_refs = g_hash_table_new (g_direct_hash, g_direct_equal);
 106     }
 107   return live_refs;
 108 }
 109
 110 /* TODO: Add an application parameter */
 111 DBusConnection *
 112 _atspi_bus ()
 113 {
 114   if (!bus)
 115     atspi_init ();
 116   return bus;
 117 }
 118
 119 #define APP_IS_REGISTRY(app) (!strcmp (app->bus_name, atspi_bus_registry))
 120
 121 static void
 122 cleanup ()
 123 {
 124   GHashTable *refs;
 125
 126   refs = live_refs;
 127   live_refs = NULL;
 128   if (refs)
 129     {
 130       g_hash_table_destroy (refs);
 131     }
 132 }
 133
 134 static gboolean atspi_inited = FALSE;
 135
 136 static GHashTable *app_hash = NULL;
 137
 138 static void
 139 handle_get_bus_address (DBusPendingCall *pending, void *user_data)
 140 {
 141   AtspiApplication *app = user_data;
 142   DBusMessage *reply = dbus_pending_call_steal_reply (pending);
 143   DBusMessage *message;
 144   const char *address;
 145   DBusPendingCall *new_pending;
 146
 147   if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_METHOD_RETURN)
 148   {
 149     if (dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &address,
 150                                DBUS_TYPE_INVALID))
 151     {
 152       DBusError error;
 153       dbus_error_init (&error);
 154       DBusConnection *bus = dbus_connection_open (address, &error);
 155       if (bus)
 156       {
 157         if (app->bus)
 158           dbus_connection_unref (app->bus);
 159         app->bus = bus;
 160       }
 161     }
 162   }
 163
 164   message = dbus_message_new_method_call (app->bus_name,
 165                                           "/org/a11y/atspi/cache",
 166                                           atspi_interface_cache, "GetItems");
 167
 168    dbus_connection_send_with_reply (app->bus, message, &new_pending, 2000);
 169   dbus_pending_call_set_notify (new_pending, handle_get_items, app, NULL);
 170 }
 171
 172 static AtspiApplication *
 173 get_application (const char *bus_name)
 174 {
 175   AtspiApplication *app = NULL;
 176   char *bus_name_dup;
 177   DBusMessage *message;
 178   DBusError error;
 179   DBusPendingCall *pending = NULL;
 180
 181   if (!app_hash)
 182   {
 183     app_hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)g_hash_table_unref);
 184     if (!app_hash) return NULL;
 185   }
 186   app = g_hash_table_lookup (app_hash, bus_name);
 187   if (app) return app;
 188   bus_name_dup = g_strdup (bus_name);
 189   if (!bus_name_dup) return NULL;
 190   // TODO: change below to something that will send state-change:defunct notification if necessary */
 191   app = _atspi_application_new (bus_name);
 192   if (!app) return NULL;
 193   app->bus_name = bus_name_dup;
 194   app->hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, g_object_unref);
 195   app->bus = _atspi_bus ();
 196   g_hash_table_insert (app_hash, bus_name_dup, app);
 197   dbus_error_init (&error);
 198   message = dbus_message_new_method_call (bus_name, atspi_path_root,
 199                                           atspi_interface_application, "GetApplicationBusAddress");
 200
 201    dbus_connection_send_with_reply (app->bus, message, &pending, 2000);
 202   dbus_pending_call_set_notify (pending, handle_get_bus_address, app, NULL);
 203   return app;
 204 }
 205
 206 static AtspiAccessible *
 207 ref_accessible (const char *app_name, const char *path)
 208 {
 209   AtspiApplication *app;
 210   AtspiAccessible *a;
 211
 212   if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
 213     return NULL;
 214
 215   app = get_application (app_name);
 216
 217   if (!strcmp (path, "/org/a11y/atspi/accessible/root"))
 218   {
 219     if (!app->root)
 220     {
 221       app->root = atspi_accessible_new (app, atspi_path_root);
 222       app->root->accessible_parent = atspi_get_desktop (0);
 223     }
 224     return g_object_ref (app->root);
 225   }
 226
 227   a = g_hash_table_lookup (app->hash, path);
 228   if (a)
 229   {
 230     return g_object_ref (a);
 231   }
 232   a = atspi_accessible_new (app, path);
 233   if (!a)
 234     return NULL;
 235   g_hash_table_insert (app->hash, a->parent.path, a);
 236   g_object_ref (a);     /* for the hash */
 237   return a;
 238 }
 239
 240 static AtspiHyperlink *
 241 ref_hyperlink (const char *app_name, const char *path)
 242 {
 243   AtspiApplication *app = get_application (app_name);
 244   AtspiHyperlink *hyperlink;
 245
 246   if (!strcmp (path, ATSPI_DBUS_PATH_NULL))
 247     return NULL;
 248
 249   hyperlink = g_hash_table_lookup (app->hash, path);
 250   if (hyperlink)
 251   {
 252     return g_object_ref (hyperlink);
 253   }
 254   hyperlink = atspi_hyperlink_new (app, path);
 255   if (!hyperlink)
 256     return NULL;
 257   g_hash_table_insert (app->hash, hyperlink->parent.path, hyperlink);
 258   /* TODO: This should be a weak ref */
 259   g_object_ref (hyperlink);     /* for the hash */
 260   return hyperlink;
 261 }
 262
 263 typedef struct
 264 {
 265   char *path;
 266   char *parent;
 267   GArray *children;
 268   GArray *interfaces;
 269   char *name;
 270   dbus_uint32_t role;
 271   char *description;
 272   GArray *state_bitflags;
 273 } CACHE_ADDITION;
 274
 275 static DBusHandlerResult
 276 handle_remove_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
 277 {
 278   const char *sender = dbus_message_get_sender (message);
 279   AtspiApplication *app;
 280   const char *path;
 281   DBusMessageIter iter, iter_struct;
 282   const char *signature = dbus_message_get_signature (message);
 283   AtspiAccessible *a;
 284   int id;
 285
 286   if (strcmp (signature, "(so)") != 0)
 287   {
 288     g_warning ("at-spi: Unknown signature %s for RemoveAccessible", signature);
 289     return DBUS_HANDLER_RESULT_HANDLED;
 290   }
 291
 292   dbus_message_iter_init (message, &iter);
 293   dbus_message_iter_recurse (&iter, &iter_struct);
 294   dbus_message_iter_get_basic (&iter_struct, &sender);
 295   dbus_message_iter_get_basic (&iter_struct, &path);
 296   app = get_application (sender);
 297   a = ref_accessible (sender, path);
 298   if (!a)
 299     return DBUS_HANDLER_RESULT_HANDLED;
 300   if (a->accessible_parent && g_list_find (a->accessible_parent->children, a))
 301   {
 302     a->accessible_parent->children = g_list_remove (a->accessible_parent->children, a);
 303     g_object_unref (a);
 304   }
 305   g_hash_table_remove (app->hash, app->bus_name);
 306   g_object_unref (a);   /* unref our own ref */
 307   return DBUS_HANDLER_RESULT_HANDLED;
 308 }
 309
 310 static gboolean
 311 add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
 312 {
 313   DBusError error;
 314   char *root_path;
 315
 316   dbus_error_init (&error);
 317   AtspiAccessible *obj = ref_accessible (bus_name, atspi_path_root);
 318   if (obj)
 319   {
 320     GList *new_list = g_list_append (a->children, obj);
 321     if (new_list)
 322     {
 323       a->children = new_list;
 324       return TRUE;
 325     }
 326   }
 327   else
 328   {
 329     g_warning ("Error calling getRoot for %s: %s", bus_name, error.message);
 330   }
 331   return FALSE;
 332 }
 333
 334 static void
 335 send_children_changed (AtspiAccessible *parent, AtspiAccessible *child, gboolean add)
 336 {
 337   AtspiEvent e;
 338
 339   memset (&e, 0, sizeof (e));
 340   e.type = (add? "object:children-changed:add": "object:children-changed:remove");
 341   e.source = parent;
 342   e.detail1 = g_list_index (parent->children, child);
 343   e.detail2 = 0;
 344   _atspi_send_event (&e);
 345 }
 346
 347 static void
 348 unref_object_and_descendants (AtspiAccessible *obj)
 349 {
 350   GList *l;
 351
 352   for (l = obj->children; l; l = l->next)
 353   {
 354     unref_object_and_descendants (l->data);
 355   }
 356   g_object_unref (obj);
 357 }
 358
 359 static gboolean
 360 remove_app_from_desktop (AtspiAccessible *a, const char *bus_name)
 361 {
 362   GList *l;
 363   AtspiAccessible *child;
 364
 365   for (l = a->children; l; l = l->next)
 366   {
 367     child = l->data;
 368     if (!strcmp (bus_name, child->parent.app->bus_name)) break;
 369   }
 370   if (!l)
 371   {
 372     g_warning ("Removing unregistered app %s; doing nothing\n", bus_name);
 373     return FALSE;
 374   }
 375   send_children_changed (a, child, FALSE);
 376   a->children = g_list_remove (a->children, child);
 377   unref_object_and_descendants (child);
 378   return TRUE;
 379 }
 380
 381 static AtspiAccessible *desktop;
 382
 383 void
 384 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
 385 {
 386   DBusMessageIter iter_struct;
 387
 388   dbus_message_iter_recurse (iter, &iter_struct);
 389   dbus_message_iter_get_basic (&iter_struct, app_name);
 390   dbus_message_iter_next (&iter_struct);
 391   dbus_message_iter_get_basic (&iter_struct, path);
 392   dbus_message_iter_next (iter);
 393 }
 394
 395 static void
 396 add_accessible_from_iter (DBusMessageIter *iter)
 397 {
 398   gint i;
 399   GList *new_list;
 400   DBusMessageIter iter_struct, iter_array;
 401   const char *app_name, *path;
 402   AtspiApplication *app;
 403   AtspiAccessible *accessible;
 404   const char *name, *description;
 405   dbus_uint32_t role;
 406
 407   dbus_message_iter_recurse (iter, &iter_struct);
 408
 409   /* get accessible */
 410   get_reference_from_iter (&iter_struct, &app_name, &path);
 411   accessible = ref_accessible (app_name, path);
 412   if (!accessible)
 413     return;
 414
 415   /* Get application: TODO */
 416   dbus_message_iter_next (&iter_struct);
 417
 418   /* get parent */
 419   get_reference_from_iter (&iter_struct, &app_name, &path);
 420   if (accessible->accessible_parent)
 421     g_object_unref (accessible->accessible_parent);
 422   accessible->accessible_parent = ref_accessible (app_name, path);
 423
 424   /* Get children */
 425   while (accessible->children)
 426   {
 427     g_object_unref (accessible->children->data);
 428     accessible->children = g_list_remove (accessible->children, accessible->children->data);
 429   }
 430   dbus_message_iter_recurse (&iter_struct, &iter_array);
 431   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
 432   {
 433     AtspiAccessible *child;
 434     get_reference_from_iter (&iter_array, &app_name, &path);
 435     child = ref_accessible (app_name, path);
 436     new_list = g_list_append (accessible->children, child);
 437     if (new_list) accessible->children = new_list;
 438   }
 439
 440   /* interfaces */
 441   dbus_message_iter_next (&iter_struct);
 442   _atspi_dbus_set_interfaces (accessible, &iter_struct);
 443   dbus_message_iter_next (&iter_struct);
 444
 445   /* name */
 446   if (accessible->name)
 447     g_free (accessible->name);
 448   dbus_message_iter_get_basic (&iter_struct, &name);
 449   accessible->name = g_strdup (name);
 450   dbus_message_iter_next (&iter_struct);
 451
 452   /* role */
 453   dbus_message_iter_get_basic (&iter_struct, &role);
 454   accessible->role = role;
 455   dbus_message_iter_next (&iter_struct);
 456
 457   /* description */
 458   if (accessible->description)
 459     g_free (accessible->description);
 460   dbus_message_iter_get_basic (&iter_struct, &description);
 461   accessible->description = g_strdup (description);
 462   dbus_message_iter_next (&iter_struct);
 463
 464   _atspi_dbus_set_state (accessible, &iter_struct);
 465   dbus_message_iter_next (&iter_struct);
 466
 467   accessible->cached_properties |= ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE | ATSPI_CACHE_PARENT;
 468   if (!atspi_state_set_contains (accessible->states,
 469                                        ATSPI_STATE_MANAGES_DESCENDANTS))
 470     accessible->cached_properties |= ATSPI_CACHE_CHILDREN;
 471
 472   /* This is a bit of a hack since the cache holds a ref, so we don't need
 473    * the one provided for us anymore */
 474   g_object_unref (accessible);
 475 }
 476
 477 static void
 478 handle_get_items (DBusPendingCall *pending, void *user_data)
 479 {
 480   AtspiApplication *app = user_data;
 481   DBusMessage *reply = dbus_pending_call_steal_reply (pending);
 482   DBusMessageIter iter, iter_array;
 483
 484   if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
 485   {
 486     dbus_message_unref (reply);
 487     g_warning ("Atspi: Error in GetItems");
 488     return;
 489   }
 490
 491   dbus_message_iter_init (reply, &iter);
 492   dbus_message_iter_recurse (&iter, &iter_array);
 493   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
 494   {
 495     add_accessible_from_iter (&iter_array);
 496     dbus_message_iter_next (&iter_array);
 497   }
 498   dbus_message_unref (reply);
 499 }
 500
 501 /* TODO: Do we stil need this function? */
 502 static AtspiAccessible *
 503 ref_accessible_desktop (AtspiApplication *app)
 504 {
 505   DBusError error;
 506   GArray *apps = NULL;
 507   GArray *additions;
 508   gint i;
 509   DBusMessage *message, *reply;
 510   DBusMessageIter iter, iter_array;
 511
 512   if (desktop)
 513   {
 514     g_object_ref (desktop);
 515     return desktop;
 516   }
 517   desktop = atspi_accessible_new (app, atspi_path_root);
 518   if (!desktop)
 519   {
 520     return NULL;
 521   }
 522   g_hash_table_insert (app->hash, desktop->parent.path, desktop);
 523   g_object_ref (desktop);       /* for the hash */
 524   desktop->name = g_strdup ("main");
 525   dbus_error_init (&error);
 526   message = dbus_message_new_method_call (atspi_bus_registry,
 527         atspi_path_root,
 528         atspi_interface_accessible,
 529         "GetChildren");
 530   if (!message)
 531     return;
 532   reply = _atspi_dbus_send_with_reply_and_block (message);
 533   if (!reply || strcmp (dbus_message_get_signature (reply), "a(so)") != 0)
 534   {
 535     g_error ("Couldn't get application list: %s", error.message);
 536     if (reply)
 537       dbus_message_unref (reply);
 538     return;
 539   }
 540   dbus_message_iter_init (reply, &iter);
 541   dbus_message_iter_recurse (&iter, &iter_array);
 542   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
 543   {
 544     const char *app_name, *path;
 545     get_reference_from_iter (&iter_array, &app_name, &path);
 546     add_app_to_desktop (desktop, app_name);
 547   }
 548   dbus_message_unref (reply);
 549   return desktop;
 550 }
 551
 552 AtspiAccessible *
 553 _atspi_ref_accessible (const char *app, const char *path)
 554 {
 555   AtspiApplication *a = get_application (app);
 556   if (!a) return NULL;
 557   if ( APP_IS_REGISTRY(a))
 558   {
 559     return ref_accessible_desktop (a);
 560   }
 561   return ref_accessible (app, path);
 562 }
 563
 564 AtspiAccessible *
 565 _atspi_dbus_return_accessible_from_message (DBusMessage *message)
 566 {
 567   DBusMessageIter iter;
 568   AtspiAccessible *retval = NULL;
 569   const char *signature = dbus_message_get_signature (message);
 570
 571   if (!strcmp (signature, "(so)"))
 572   {
 573     dbus_message_iter_init (message, &iter);
 574     retval =  _atspi_dbus_return_accessible_from_iter (&iter);
 575   }
 576   else
 577   {
 578     g_warning ("Atspi: Called _atspi_dbus_return_accessible_from_message with strange signature %s", signature);
 579   }
 580   dbus_message_unref (message);
 581   return retval;
 582 }
 583
 584 AtspiAccessible *
 585 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
 586 {
 587   const char *app_name, *path;
 588
 589   get_reference_from_iter (iter, &app_name, &path);
 590   return ref_accessible (app_name, path);
 591 }
 592
 593 AtspiHyperlink *
 594 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
 595 {
 596   DBusMessageIter iter;
 597   AtspiHyperlink *retval = NULL;
 598   const char *signature = dbus_message_get_signature (message);
 599
 600   if (!strcmp (signature, "(so)"))
 601   {
 602     dbus_message_iter_init (message, &iter);
 603     retval =  _atspi_dbus_return_hyperlink_from_iter (&iter);
 604   }
 605   else
 606   {
 607     g_warning ("Atspi: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s", signature);
 608   }
 609   dbus_message_unref (message);
 610   return retval;
 611 }
 612
 613 AtspiHyperlink *
 614 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
 615 {
 616   const char *app_name, *path;
 617
 618   get_reference_from_iter (iter, &app_name, &path);
 619   return ref_hyperlink (app_name, path);
 620 }
 621
 622 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
 623
 624 static DBusHandlerResult
 625 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
 626 {
 627   DBusMessageIter iter;
 628   const char *sender = dbus_message_get_sender (message);
 629   AtspiApplication *app = get_application (sender);
 630   const char *type = cache_signal_type;
 631
 632   if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
 633   {
 634     g_warning ("atspi: AddAccessible with unknown signature %s\n", dbus_message_get_signature (message));
 635     return;
 636   }
 637
 638   dbus_message_iter_init (message, &iter);
 639   add_accessible_from_iter (&iter);
 640 }
 641
 642 typedef struct
 643 {
 644   DBusConnection *bus;
 645   DBusMessage *message;
 646   void *data;
 647 } BusDataClosure;
 648
 649 static guint process_deferred_messages_id = -1;
 650
 651 static void
 652 process_deferred_message (BusDataClosure *closure)
 653 {
 654   int type = dbus_message_get_type (closure->message);
 655   const char *interface = dbus_message_get_interface (closure->message);
 656   const char *member = dbus_message_get_member (closure->message);
 657   dbus_uint32_t v;
 658   char *bus_name;
 659
 660   if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
 661       !strncmp (interface, "org.a11y.atspi.Event.", 21))
 662   {
 663     atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
 664   }
 665   if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
 666   {
 667     atspi_dbus_handle_DeviceEvent (closure->bus,
 668                                    closure->message, closure->data);
 669   }
 670   if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
 671   {
 672     handle_add_accessible (closure->bus, closure->message, closure->data);
 673   }
 674   if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
 675   {
 676     handle_remove_accessible (closure->bus, closure->message, closure->data);
 677   }
 678 }
 679
 680 static GList *deferred_messages = NULL;
 681
 682 gboolean
 683 _atspi_process_deferred_messages (gpointer data)
 684 {
 685   static int in_process_deferred_messages = 0;
 686
 687   if (in_process_deferred_messages)
 688     return;
 689   in_process_deferred_messages = 1;
 690   while (deferred_messages != NULL)
 691   {
 692     BusDataClosure *closure = deferred_messages->data;
 693     process_deferred_message (closure);
 694     deferred_messages = g_list_remove (deferred_messages, closure);
 695     dbus_message_unref (closure->message);
 696     dbus_connection_unref (closure->bus);
 697     g_free (closure);
 698   }
 699   /* If data is NULL, assume that we were called from GLib */
 700   if (!data)
 701     process_deferred_messages_id = -1;
 702   in_process_deferred_messages = 0;
 703   return FALSE;
 704 }
 705
 706 static DBusHandlerResult
 707 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
 708 {
 709   BusDataClosure *closure = g_new (BusDataClosure, 1);
 710   GList *new_list;
 711
 712   if (!closure)
 713     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 714   closure->bus = dbus_connection_ref (bus);
 715   closure->message = dbus_message_ref (message);
 716   closure->data = user_data;
 717
 718   new_list = g_list_append (deferred_messages, closure);
 719   if (new_list)
 720     deferred_messages = new_list;
 721
 722   if (process_deferred_messages_id == -1)
 723     process_deferred_messages_id = g_idle_add (_atspi_process_deferred_messages, NULL);
 724   return DBUS_HANDLER_RESULT_HANDLED;
 725 }
 726
 727 static DBusHandlerResult
 728 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
 729 {
 730   int type = dbus_message_get_type (message);
 731   const char *interface = dbus_message_get_interface (message);
 732   const char *member = dbus_message_get_member (message);
 733   dbus_uint32_t v;
 734   char *bus_name;
 735
 736   if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
 737       !strncmp (interface, "org.a11y.atspi.Event.", 21))
 738   {
 739     return defer_message (bus, message, data);
 740   }
 741   if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
 742   {
 743     return defer_message (bus, message, data);
 744   }
 745   if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
 746   {
 747     return defer_message (bus, message, data);
 748   }
 749   if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
 750   {
 751     return defer_message (bus, message, data);
 752   }
 753   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 754 }
 755
 756 static const char *signal_interfaces[] =
 757 {
 758   "org.a11y.atspi.Event.Object",
 759   "org.a11y.atspi.Event.Window",
 760   "org.a11y.atspi.Event.Mouse",
 761   "org.a11y.atspi.Event.Terminal",
 762   "org.a11y.atspi.Event.Document",
 763   "org.a11y.atspi.Event.Focus",
 764   NULL
 765 };
 766
 767 /*
 768  * Returns a 'canonicalized' value for DISPLAY,
 769  * with the screen number stripped off if present.
 770  *
 771  * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
 772  */
 773 static const gchar *
 774 spi_display_name (void)
 775 {
 776   static const char *canonical_display_name = NULL;
 777   if (!canonical_display_name)
 778     {
 779       const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
 780       if (!display_env)
 781         {
 782           display_env = g_getenv ("DISPLAY");
 783           if (!display_env || !display_env[0])
 784             canonical_display_name = ":0";
 785           else
 786             {
 787               gchar *display_p, *screen_p;
 788               canonical_display_name = g_strdup (display_env);
 789               display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
 790               screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
 791               if (screen_p && display_p && (screen_p > display_p))
 792                 {
 793                   *screen_p = '\0';
 794                 }
 795             }
 796         }
 797       else
 798         {
 799           canonical_display_name = display_env;
 800         }
 801     }
 802   return canonical_display_name;
 803 }
 804
 805 /* TODO: Avoid having duplicate functions for this here and in at-spi2-atk */
 806 static DBusConnection *
 807 get_accessibility_bus ()
 808 {
 809   Atom AT_SPI_BUS;
 810   Atom actual_type;
 811   Display *bridge_display;
 812   int actual_format;
 813   unsigned char *data = NULL;
 814   unsigned long nitems;
 815   unsigned long leftover;
 816
 817   DBusConnection *bus = NULL;
 818   DBusError error;
 819
 820   bridge_display = XOpenDisplay (spi_display_name ());
 821   if (!bridge_display)
 822     {
 823       g_warning ("AT_SPI: Could not get the display\n");
 824       return NULL;
 825     }
 826
 827   AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
 828   XGetWindowProperty (bridge_display,
 829                       XDefaultRootWindow (bridge_display),
 830                       AT_SPI_BUS, 0L,
 831                       (long) BUFSIZ, False,
 832                       (Atom) 31, &actual_type, &actual_format,
 833                       &nitems, &leftover, &data);
 834
 835   dbus_error_init (&error);
 836
 837   if (data == NULL)
 838     {
 839       g_warning
 840         ("AT-SPI: Accessibility bus not found - Using session bus.\n");
 841       bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
 842       if (!bus)
 843         {
 844           g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
 845           return NULL;
 846         }
 847     }
 848   else
 849     {
 850       bus = dbus_connection_open (data, &error);
 851       if (!bus)
 852         {
 853           g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
 854           return NULL;
 855         }
 856       else
 857         {
 858           if (!dbus_bus_register (bus, &error))
 859             {
 860               g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
 861               return NULL;
 862             }
 863         }
 864     }
 865
 866   return bus;
 867 }
 868
 869 /**
 870  * atspi_init:
 871  *
 872  * Connects to the accessibility registry and initializes the SPI.
 873  *
 874  * Returns: 0 on success, otherwise an integer error code.
 875  **/
 876 int
 877 atspi_init (void)
 878 {
 879   DBusError error;
 880   char *match;
 881   int i;
 882
 883   if (atspi_inited)
 884     {
 885       return 1;
 886     }
 887
 888   atspi_inited = TRUE;
 889
 890   g_type_init ();
 891
 892   get_live_refs();
 893
 894   dbus_error_init (&error);
 895   bus = get_accessibility_bus ();
 896   if (!bus)
 897   {
 898     g_error ("Couldn't get session bus");
 899     return 2;
 900   }
 901   dbus_bus_register (bus, &error);
 902   dbus_connection_setup_with_g_main(bus, g_main_context_default());
 903   dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
 904   dbind_set_timeout (1000);
 905   match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
 906   dbus_error_init (&error);
 907   dbus_bus_add_match (bus, match, &error);
 908   g_free (match);
 909   match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
 910   dbus_bus_add_match (bus, match, &error);
 911   g_free (match);
 912   match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
 913   dbus_bus_add_match (bus, match, &error);
 914   g_free (match);
 915   match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
 916   dbus_bus_add_match (bus, match, &error);
 917   g_free (match);
 918   match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
 919   dbus_bus_add_match (bus, match, &error);
 920   g_free (match);
 921   return 0;
 922 }
 923
 924   static GMainLoop *mainloop;
 925
 926 /**
 927  * atspi_event_main:
 928  *
 929  * Starts/enters the main event loop for the AT-SPI services.
 930  *
 931  * (NOTE: This method does not return control, it is exited via a call to
 932  *  atspi_event_quit () from within an event handler).
 933  *
 934  **/
 935 void
 936 atspi_event_main (void)
 937 {
 938   mainloop = g_main_loop_new (NULL, FALSE);
 939   g_main_loop_run (mainloop);
 940 }
 941
 942 /**
 943  * atspi_event_quit:
 944  *
 945  * Quits the last main event loop for the SPI services,
 946  * see atspi_event_main
 947  **/
 948 void
 949 atspi_event_quit (void)
 950 {
 951   g_main_loop_quit (mainloop);
 952 }
 953
 954 /**
 955  * atspi_exit:
 956  *
 957  * Disconnects from the Accessibility Registry and releases
 958  * any floating resources. Call only once at exit.
 959  *
 960  * Returns: 0 if there were no leaks, otherwise non zero.
 961  **/
 962 int
 963 atspi_exit (void)
 964 {
 965   int leaked;
 966
 967   if (!atspi_inited)
 968     {
 969       return 0;
 970     }
 971
 972   atspi_inited = FALSE;
 973
 974   if (live_refs)
 975     {
 976       leaked = g_hash_table_size (live_refs);
 977     }
 978   else
 979     {
 980       leaked = 0;
 981     }
 982
 983   cleanup ();
 984
 985   return leaked;
 986 }
 987
 988 dbus_bool_t
 989 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
 990 {
 991   va_list args;
 992   dbus_bool_t retval;
 993   DBusError err;
 994   AtspiObject *aobj = ATSPI_OBJECT (obj);
 995
 996   va_start (args, type);
 997   dbus_error_init (&err);
 998   retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
 999                                            aobj->path, interface, method, &err,
1000                                            type, args);
1001   va_end (args);
1002   _atspi_process_deferred_messages ((gpointer)TRUE);
1003   if (dbus_error_is_set (&err))
1004   {
1005     /* TODO: Set gerror */
1006     dbus_error_free (&err);
1007   }
1008   return retval;
1009 }
1010
1011 DBusMessage *
1012 _atspi_dbus_call_partial (gpointer obj,
1013                           const char *interface,
1014                           const char *method,
1015                           GError **error,
1016                           const char *type, ...)
1017 {
1018   va_list args;
1019
1020   va_start (args, type);
1021   return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
1022 }
1023
1024 DBusMessage *
1025 _atspi_dbus_call_partial_va (gpointer obj,
1026                           const char *interface,
1027                           const char *method,
1028                           GError **error,
1029                           const char *type,
1030                           va_list args)
1031 {
1032   AtspiObject *aobj = ATSPI_OBJECT (obj);
1033   dbus_bool_t retval;
1034   DBusError err;
1035     DBusMessage *msg = NULL, *reply = NULL;
1036     DBusMessageIter iter;
1037     const char *p;
1038
1039   dbus_error_init (&err);
1040
1041     msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
1042     if (!msg)
1043         goto out;
1044
1045     p = type;
1046     dbus_message_iter_init_append (msg, &iter);
1047     dbind_any_marshal_va (&iter, &p, args);
1048
1049     reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1050 out:
1051   va_end (args);
1052   _atspi_process_deferred_messages ((gpointer)TRUE);
1053   if (dbus_error_is_set (&err))
1054   {
1055     /* TODO: Set gerror */
1056     dbus_error_free (&err);
1057   }
1058   return reply;
1059 }
1060
1061 dbus_bool_t
1062 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1063 {
1064   DBusMessage *message, *reply;
1065   DBusMessageIter iter, iter_variant;
1066   DBusError err;
1067   dbus_bool_t retval = FALSE;
1068   AtspiObject *aobj = ATSPI_OBJECT (obj);
1069
1070   if (!aobj)
1071     return FALSE;
1072
1073   message = dbus_message_new_method_call (aobj->app->bus_name,
1074                                           aobj->path,
1075                                           "org.freedesktop.DBus.Properties",
1076                                           "Get");
1077   if (!message)
1078   {
1079     // TODO: throw exception
1080     goto done;
1081   }
1082   dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1083   dbus_error_init (&err);
1084   reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1085   dbus_message_unref (message);
1086   _atspi_process_deferred_messages ((gpointer)TRUE);
1087   if (!reply)
1088   {
1089     // TODO: throw exception
1090     goto done;
1091   }
1092   dbus_message_iter_init (reply, &iter);
1093   if (dbus_message_iter_get_arg_type (&iter) != 'v')
1094   {
1095     g_warning ("at-spi: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
1096     goto done;
1097   }
1098   dbus_message_iter_recurse (&iter, &iter_variant);
1099   if (dbus_message_iter_get_arg_type (&iter_variant) != type[0])
1100   {
1101     g_warning ("atspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1102     goto done;
1103   }
1104   if (!strcmp (type, "(so)"))
1105   {
1106     *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1107   }
1108   else
1109   {
1110     dbus_message_iter_get_basic (&iter_variant, data);
1111     dbus_message_unref (reply);
1112     if (type [0] == 's')
1113       *(char **)data = g_strdup (*(char **)data);
1114   }
1115   retval = TRUE;
1116 done:
1117   return retval;
1118 }
1119
1120 DBusMessage *
1121 _atspi_dbus_send_with_reply_and_block (DBusMessage *message)
1122 {
1123   DBusMessage *reply;
1124   DBusError err;
1125   AtspiApplication *app;
1126   DBusConnection *bus;
1127
1128   app = get_application (dbus_message_get_destination (message));
1129   bus = (app ? app->bus : _atspi_bus());
1130   dbus_error_init (&err);
1131   reply = dbind_send_and_allow_reentry (bus, message, &err);
1132   _atspi_process_deferred_messages ((gpointer)TRUE);
1133   dbus_message_unref (message);
1134   if (err.message)
1135     g_warning ("Atspi: Got error: %s\n", err.message);
1136   return reply;
1137 }
1138
1139 GHashTable *
1140 _atspi_dbus_hash_from_message (DBusMessage *message)
1141 {
1142   DBusMessageIter iter;
1143
1144   _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL);
1145
1146   dbus_message_iter_init (message, &iter);
1147   return _atspi_dbus_hash_from_iter (&iter);
1148 }
1149
1150 GHashTable *
1151 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1152 {
1153   GHashTable *hash = g_hash_table_new (g_str_hash, g_str_equal);
1154   DBusMessageIter iter_array, iter_dict;
1155
1156   dbus_message_iter_recurse (iter, &iter_array);
1157   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1158   {
1159     const char *name, *value;
1160     dbus_message_iter_recurse (&iter_array, &iter_dict);
1161     dbus_message_iter_get_basic (&iter_dict, &name);
1162     dbus_message_iter_next (&iter_dict);
1163     dbus_message_iter_get_basic (&iter_dict, &value);
1164     g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1165     dbus_message_iter_next (&iter_array);
1166   }
1167   return hash;
1168 }
1169
1170 GArray *
1171 _atspi_dbus_attribute_array_from_message (DBusMessage *message)
1172 {
1173   DBusMessageIter iter;
1174
1175   _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL);
1176
1177   dbus_message_iter_init (message, &iter);
1178
1179   return _atspi_dbus_attribute_array_from_iter (&iter);
1180 }
1181
1182 GArray *
1183 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1184 {
1185   DBusMessageIter iter_array, iter_dict;
1186   GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1187   gint count = 0;
1188
1189   dbus_message_iter_recurse (iter, &iter_array);
1190   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1191   {
1192     const char *name, *value;
1193     gchar *str;
1194     GArray *new_array;
1195     dbus_message_iter_recurse (&iter_array, &iter_dict);
1196     dbus_message_iter_get_basic (&iter_dict, &name);
1197     dbus_message_iter_next (&iter_dict);
1198     dbus_message_iter_get_basic (&iter_dict, &value);
1199     str = g_strdup_printf ("%s:%s", name, value);
1200     new_array = g_array_append_val (array, str);
1201     if (new_array)
1202       array = new_array;
1203     dbus_message_iter_next (&iter_array);;
1204   }
1205   return array;
1206 }
1207
1208 void
1209 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1210 {
1211   DBusMessageIter iter_array;
1212
1213   accessible->interfaces = 0;
1214   dbus_message_iter_recurse (iter, &iter_array);
1215   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1216   {
1217     const char *iface;
1218     gint n;
1219     dbus_message_iter_get_basic (&iter_array, &iface);
1220     if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1221     n = _atspi_get_iface_num (iface);
1222     if (n == -1)
1223     {
1224       g_warning ("at-spi: Unknown interface %s", iface);
1225     }
1226     else
1227       accessible->interfaces |= (1 << n);
1228     dbus_message_iter_next (&iter_array);
1229   }
1230   accessible->cached_properties |= ATSPI_CACHE_INTERFACES;
1231 }
1232
1233 void
1234 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1235 {
1236   DBusMessageIter iter_array;
1237   gint count;
1238   dbus_uint32_t *states;
1239
1240   dbus_message_iter_recurse (iter, &iter_array);
1241   dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1242   if (count != 2)
1243   {
1244     g_warning ("at-spi: expected 2 values in states array; got %d\n", count);
1245     if (!accessible->states)
1246       accessible->states = _atspi_state_set_new_internal (accessible, 0);
1247   }
1248   else
1249   {
1250     guint64 val = ((guint64)states [1]) << 32;
1251     val += states [0];
1252     if (!accessible->states)
1253       accessible->states = _atspi_state_set_new_internal (accessible, val);
1254     else
1255       accessible->states->states = val;
1256   }
1257   accessible->cached_properties |= ATSPI_CACHE_STATES;
1258 }