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, g_strdup (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_next (&iter_struct);
 296   dbus_message_iter_get_basic (&iter_struct, &path);
 297   app = get_application (sender);
 298   a = ref_accessible (sender, path);
 299   if (!a)
 300     return DBUS_HANDLER_RESULT_HANDLED;
 301   g_object_run_dispose (G_OBJECT (a));
 302   g_hash_table_remove (app->hash, a->parent.path);
 303   g_object_unref (a);   /* unref our own ref */
 304   return DBUS_HANDLER_RESULT_HANDLED;
 305 }
 306
 307 static gboolean
 308 add_app_to_desktop (AtspiAccessible *a, const char *bus_name)
 309 {
 310   DBusError error;
 311   char *root_path;
 312
 313   dbus_error_init (&error);
 314   AtspiAccessible *obj = ref_accessible (bus_name, atspi_path_root);
 315   if (obj)
 316   {
 317     GList *new_list = g_list_append (a->children, obj);
 318     if (new_list)
 319     {
 320       a->children = new_list;
 321       return TRUE;
 322     }
 323   }
 324   else
 325   {
 326     g_warning (_("AT-SPI: Error calling getRoot for %s: %s"), bus_name, error.message);
 327   }
 328   return FALSE;
 329 }
 330
 331 static void
 332 send_children_changed (AtspiAccessible *parent, AtspiAccessible *child, gboolean add)
 333 {
 334   AtspiEvent e;
 335
 336   memset (&e, 0, sizeof (e));
 337   e.type = (add? "object:children-changed:add": "object:children-changed:remove");
 338   e.source = parent;
 339   e.detail1 = g_list_index (parent->children, child);
 340   e.detail2 = 0;
 341   _atspi_send_event (&e);
 342 }
 343
 344 static void
 345 unref_object_and_descendants (AtspiAccessible *obj)
 346 {
 347   GList *l;
 348
 349   for (l = obj->children; l; l = l->next)
 350   {
 351     unref_object_and_descendants (l->data);
 352   }
 353   g_object_unref (obj);
 354 }
 355
 356 static gboolean
 357 remove_app_from_desktop (AtspiAccessible *a, const char *bus_name)
 358 {
 359   GList *l;
 360   AtspiAccessible *child;
 361
 362   for (l = a->children; l; l = l->next)
 363   {
 364     child = l->data;
 365     if (!strcmp (bus_name, child->parent.app->bus_name)) break;
 366   }
 367   if (!l)
 368   {
 369     return FALSE;
 370   }
 371   send_children_changed (a, child, FALSE);
 372   a->children = g_list_remove (a->children, child);
 373   unref_object_and_descendants (child);
 374   return TRUE;
 375 }
 376
 377 static AtspiAccessible *desktop;
 378
 379 void
 380 get_reference_from_iter (DBusMessageIter *iter, const char **app_name, const char **path)
 381 {
 382   DBusMessageIter iter_struct;
 383
 384   dbus_message_iter_recurse (iter, &iter_struct);
 385   dbus_message_iter_get_basic (&iter_struct, app_name);
 386   dbus_message_iter_next (&iter_struct);
 387   dbus_message_iter_get_basic (&iter_struct, path);
 388   dbus_message_iter_next (iter);
 389 }
 390
 391 static void
 392 add_accessible_from_iter (DBusMessageIter *iter)
 393 {
 394   gint i;
 395   GList *new_list;
 396   DBusMessageIter iter_struct, iter_array;
 397   const char *app_name, *path;
 398   AtspiApplication *app;
 399   AtspiAccessible *accessible;
 400   const char *name, *description;
 401   dbus_uint32_t role;
 402
 403   dbus_message_iter_recurse (iter, &iter_struct);
 404
 405   /* get accessible */
 406   get_reference_from_iter (&iter_struct, &app_name, &path);
 407   accessible = ref_accessible (app_name, path);
 408   if (!accessible)
 409     return;
 410
 411   /* Get application: TODO */
 412   dbus_message_iter_next (&iter_struct);
 413
 414   /* get parent */
 415   get_reference_from_iter (&iter_struct, &app_name, &path);
 416   if (accessible->accessible_parent)
 417     g_object_unref (accessible->accessible_parent);
 418   accessible->accessible_parent = ref_accessible (app_name, path);
 419
 420   /* Get children */
 421   while (accessible->children)
 422   {
 423     g_object_unref (accessible->children->data);
 424     accessible->children = g_list_remove (accessible->children, accessible->children->data);
 425   }
 426   dbus_message_iter_recurse (&iter_struct, &iter_array);
 427   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
 428   {
 429     AtspiAccessible *child;
 430     get_reference_from_iter (&iter_array, &app_name, &path);
 431     child = ref_accessible (app_name, path);
 432     new_list = g_list_append (accessible->children, child);
 433     if (new_list) accessible->children = new_list;
 434   }
 435
 436   /* interfaces */
 437   dbus_message_iter_next (&iter_struct);
 438   _atspi_dbus_set_interfaces (accessible, &iter_struct);
 439   dbus_message_iter_next (&iter_struct);
 440
 441   /* name */
 442   if (accessible->name)
 443     g_free (accessible->name);
 444   dbus_message_iter_get_basic (&iter_struct, &name);
 445   accessible->name = g_strdup (name);
 446   dbus_message_iter_next (&iter_struct);
 447
 448   /* role */
 449   dbus_message_iter_get_basic (&iter_struct, &role);
 450   accessible->role = role;
 451   dbus_message_iter_next (&iter_struct);
 452
 453   /* description */
 454   if (accessible->description)
 455     g_free (accessible->description);
 456   dbus_message_iter_get_basic (&iter_struct, &description);
 457   accessible->description = g_strdup (description);
 458   dbus_message_iter_next (&iter_struct);
 459
 460   _atspi_dbus_set_state (accessible, &iter_struct);
 461   dbus_message_iter_next (&iter_struct);
 462
 463   accessible->cached_properties |= ATSPI_CACHE_NAME | ATSPI_CACHE_ROLE | ATSPI_CACHE_PARENT;
 464   if (!atspi_state_set_contains (accessible->states,
 465                                        ATSPI_STATE_MANAGES_DESCENDANTS))
 466     accessible->cached_properties |= ATSPI_CACHE_CHILDREN;
 467
 468   /* This is a bit of a hack since the cache holds a ref, so we don't need
 469    * the one provided for us anymore */
 470   g_object_unref (accessible);
 471 }
 472
 473 static void
 474 handle_get_items (DBusPendingCall *pending, void *user_data)
 475 {
 476   AtspiApplication *app = user_data;
 477   DBusMessage *reply = dbus_pending_call_steal_reply (pending);
 478   DBusMessageIter iter, iter_array;
 479
 480   if (dbus_message_get_type (reply) == DBUS_MESSAGE_TYPE_ERROR)
 481   {
 482     const char *sender = dbus_message_get_sender (reply);
 483     const char *error = NULL;
 484     dbus_message_get_args (reply, NULL, DBUS_TYPE_STRING, &error,
 485                            DBUS_TYPE_INVALID);
 486     g_warning (_("AT-SPI: Error in GetItems, sender=%s, error=%s"), sender, error);
 487     dbus_message_unref (reply);
 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   gchar *bus_name_dup;
 512
 513   if (desktop)
 514   {
 515     g_object_ref (desktop);
 516     return desktop;
 517   }
 518   desktop = atspi_accessible_new (app, atspi_path_root);
 519   if (!desktop)
 520   {
 521     return NULL;
 522   }
 523   g_hash_table_insert (app->hash, desktop->parent.path, desktop);
 524   g_object_ref (desktop);       /* for the hash */
 525   desktop->name = g_strdup ("main");
 526   dbus_error_init (&error);
 527   message = dbus_message_new_method_call (atspi_bus_registry,
 528         atspi_path_root,
 529         atspi_interface_accessible,
 530         "GetChildren");
 531   if (!message)
 532     return;
 533   reply = _atspi_dbus_send_with_reply_and_block (message);
 534   if (!reply || strcmp (dbus_message_get_signature (reply), "a(so)") != 0)
 535   {
 536     g_error ("Couldn't get application list: %s", error.message);
 537     if (reply)
 538       dbus_message_unref (reply);
 539     return;
 540   }
 541   dbus_message_iter_init (reply, &iter);
 542   dbus_message_iter_recurse (&iter, &iter_array);
 543   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
 544   {
 545     const char *app_name, *path;
 546     get_reference_from_iter (&iter_array, &app_name, &path);
 547     add_app_to_desktop (desktop, app_name);
 548   }
 549   dbus_message_unref (reply);
 550
 551   /* Record the alternate name as an alias for org.a11y.atspi.Registry */
 552   bus_name_dup = g_strdup (dbus_message_get_sender (reply));
 553   if (bus_name_dup)
 554     g_hash_table_insert (app_hash, bus_name_dup, app);
 555
 556   return desktop;
 557 }
 558
 559 AtspiAccessible *
 560 _atspi_ref_accessible (const char *app, const char *path)
 561 {
 562   AtspiApplication *a = get_application (app);
 563   if (!a) return NULL;
 564   if ( APP_IS_REGISTRY(a))
 565   {
 566     return ref_accessible_desktop (a);
 567   }
 568   return ref_accessible (app, path);
 569 }
 570
 571 AtspiAccessible *
 572 _atspi_dbus_return_accessible_from_message (DBusMessage *message)
 573 {
 574   DBusMessageIter iter;
 575   AtspiAccessible *retval = NULL;
 576   const char *signature;
 577
 578   if (!message)
 579     return NULL;
 580
 581   signature = dbus_message_get_signature (message);
 582   if (!strcmp (signature, "(so)"))
 583   {
 584     dbus_message_iter_init (message, &iter);
 585     retval =  _atspi_dbus_return_accessible_from_iter (&iter);
 586   }
 587   else
 588   {
 589     g_warning (_("AT-SPI: Called _atspi_dbus_return_accessible_from_message with strange signature %s"), signature);
 590   }
 591   dbus_message_unref (message);
 592   return retval;
 593 }
 594
 595 AtspiAccessible *
 596 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
 597 {
 598   const char *app_name, *path;
 599
 600   get_reference_from_iter (iter, &app_name, &path);
 601   return ref_accessible (app_name, path);
 602 }
 603
 604 AtspiHyperlink *
 605 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
 606 {
 607   DBusMessageIter iter;
 608   AtspiHyperlink *retval = NULL;
 609   const char *signature = dbus_message_get_signature (message);
 610
 611   if (!strcmp (signature, "(so)"))
 612   {
 613     dbus_message_iter_init (message, &iter);
 614     retval =  _atspi_dbus_return_hyperlink_from_iter (&iter);
 615   }
 616   else
 617   {
 618     g_warning (_("AT-SPI: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s"), signature);
 619   }
 620   dbus_message_unref (message);
 621   return retval;
 622 }
 623
 624 AtspiHyperlink *
 625 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
 626 {
 627   const char *app_name, *path;
 628
 629   get_reference_from_iter (iter, &app_name, &path);
 630   return ref_hyperlink (app_name, path);
 631 }
 632
 633 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
 634
 635 static DBusHandlerResult
 636 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
 637 {
 638   DBusMessageIter iter;
 639   const char *sender = dbus_message_get_sender (message);
 640   AtspiApplication *app = get_application (sender);
 641   const char *type = cache_signal_type;
 642
 643   if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
 644   {
 645     g_warning (_("AT-SPI: AddAccessible with unknown signature %s\n"),
 646                dbus_message_get_signature (message));
 647     return;
 648   }
 649
 650   dbus_message_iter_init (message, &iter);
 651   add_accessible_from_iter (&iter);
 652 }
 653
 654 typedef struct
 655 {
 656   DBusConnection *bus;
 657   DBusMessage *message;
 658   void *data;
 659 } BusDataClosure;
 660
 661 static guint process_deferred_messages_id = -1;
 662
 663 static void
 664 process_deferred_message (BusDataClosure *closure)
 665 {
 666   int type = dbus_message_get_type (closure->message);
 667   const char *interface = dbus_message_get_interface (closure->message);
 668   const char *member = dbus_message_get_member (closure->message);
 669   dbus_uint32_t v;
 670   char *bus_name;
 671
 672   if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
 673       !strncmp (interface, "org.a11y.atspi.Event.", 21))
 674   {
 675     atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
 676   }
 677   if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
 678   {
 679     atspi_dbus_handle_DeviceEvent (closure->bus,
 680                                    closure->message, closure->data);
 681   }
 682   if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
 683   {
 684     handle_add_accessible (closure->bus, closure->message, closure->data);
 685   }
 686   if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
 687   {
 688     handle_remove_accessible (closure->bus, closure->message, closure->data);
 689   }
 690 }
 691
 692 static GList *deferred_messages = NULL;
 693
 694 gboolean
 695 _atspi_process_deferred_messages (gpointer data)
 696 {
 697   static int in_process_deferred_messages = 0;
 698
 699   if (in_process_deferred_messages)
 700     return;
 701   in_process_deferred_messages = 1;
 702   while (deferred_messages != NULL)
 703   {
 704     BusDataClosure *closure = deferred_messages->data;
 705     process_deferred_message (closure);
 706     deferred_messages = g_list_remove (deferred_messages, closure);
 707     dbus_message_unref (closure->message);
 708     dbus_connection_unref (closure->bus);
 709     g_free (closure);
 710   }
 711   /* If data is NULL, assume that we were called from GLib */
 712   if (!data)
 713     process_deferred_messages_id = -1;
 714   in_process_deferred_messages = 0;
 715   return FALSE;
 716 }
 717
 718 static DBusHandlerResult
 719 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
 720 {
 721   BusDataClosure *closure = g_new (BusDataClosure, 1);
 722   GList *new_list;
 723
 724   if (!closure)
 725     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 726   closure->bus = dbus_connection_ref (bus);
 727   closure->message = dbus_message_ref (message);
 728   closure->data = user_data;
 729
 730   new_list = g_list_append (deferred_messages, closure);
 731   if (new_list)
 732     deferred_messages = new_list;
 733
 734   if (process_deferred_messages_id == -1)
 735     process_deferred_messages_id = g_idle_add (_atspi_process_deferred_messages, NULL);
 736   return DBUS_HANDLER_RESULT_HANDLED;
 737 }
 738
 739 static DBusHandlerResult
 740 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
 741 {
 742   int type = dbus_message_get_type (message);
 743   const char *interface = dbus_message_get_interface (message);
 744   const char *member = dbus_message_get_member (message);
 745   dbus_uint32_t v;
 746   char *bus_name;
 747
 748   if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
 749       !strncmp (interface, "org.a11y.atspi.Event.", 21))
 750   {
 751     return defer_message (bus, message, data);
 752   }
 753   if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
 754   {
 755     return defer_message (bus, message, data);
 756   }
 757   if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
 758   {
 759     return defer_message (bus, message, data);
 760   }
 761   if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
 762   {
 763     return defer_message (bus, message, data);
 764   }
 765   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 766 }
 767
 768 static const char *signal_interfaces[] =
 769 {
 770   "org.a11y.atspi.Event.Object",
 771   "org.a11y.atspi.Event.Window",
 772   "org.a11y.atspi.Event.Mouse",
 773   "org.a11y.atspi.Event.Terminal",
 774   "org.a11y.atspi.Event.Document",
 775   "org.a11y.atspi.Event.Focus",
 776   NULL
 777 };
 778
 779 /*
 780  * Returns a 'canonicalized' value for DISPLAY,
 781  * with the screen number stripped off if present.
 782  *
 783  * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
 784  */
 785 static const gchar *
 786 spi_display_name (void)
 787 {
 788   static const char *canonical_display_name = NULL;
 789   if (!canonical_display_name)
 790     {
 791       const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
 792       if (!display_env)
 793         {
 794           display_env = g_getenv ("DISPLAY");
 795           if (!display_env || !display_env[0])
 796             canonical_display_name = ":0";
 797           else
 798             {
 799               gchar *display_p, *screen_p;
 800               canonical_display_name = g_strdup (display_env);
 801               display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
 802               screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
 803               if (screen_p && display_p && (screen_p > display_p))
 804                 {
 805                   *screen_p = '\0';
 806                 }
 807             }
 808         }
 809       else
 810         {
 811           canonical_display_name = display_env;
 812         }
 813     }
 814   return canonical_display_name;
 815 }
 816
 817 /* TODO: Avoid having duplicate functions for this here and in at-spi2-atk */
 818 static DBusConnection *
 819 get_accessibility_bus ()
 820 {
 821   Atom AT_SPI_BUS;
 822   Atom actual_type;
 823   Display *bridge_display;
 824   int actual_format;
 825   unsigned char *data = NULL;
 826   unsigned long nitems;
 827   unsigned long leftover;
 828
 829   DBusConnection *bus = NULL;
 830   DBusError error;
 831
 832   bridge_display = XOpenDisplay (spi_display_name ());
 833   if (!bridge_display)
 834     {
 835       g_warning (_("AT-SPI: Could not get the display\n"));
 836       return NULL;
 837     }
 838
 839   AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
 840   XGetWindowProperty (bridge_display,
 841                       XDefaultRootWindow (bridge_display),
 842                       AT_SPI_BUS, 0L,
 843                       (long) BUFSIZ, False,
 844                       (Atom) 31, &actual_type, &actual_format,
 845                       &nitems, &leftover, &data);
 846
 847   dbus_error_init (&error);
 848
 849   if (data == NULL)
 850     {
 851       g_warning
 852         (_("AT-SPI: Accessibility bus not found - Using session bus.\n"));
 853       bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
 854       if (!bus)
 855         {
 856           g_warning (_("AT-SPI: Couldn't connect to bus: %s\n"), error.message);
 857           return NULL;
 858         }
 859     }
 860   else
 861     {
 862       bus = dbus_connection_open (data, &error);
 863       if (!bus)
 864         {
 865           g_warning (_("AT-SPI: Couldn't connect to bus: %s\n"), error.message);
 866           return NULL;
 867         }
 868       else
 869         {
 870           if (!dbus_bus_register (bus, &error))
 871             {
 872               g_warning (_("AT-SPI: Couldn't register with bus: %s\n"), error.message);
 873               return NULL;
 874             }
 875         }
 876     }
 877
 878   return bus;
 879 }
 880
 881 /**
 882  * atspi_init:
 883  *
 884  * Connects to the accessibility registry and initializes the SPI.
 885  *
 886  * Returns: 0 on success, otherwise an integer error code.
 887  **/
 888 int
 889 atspi_init (void)
 890 {
 891   DBusError error;
 892   char *match;
 893   int i;
 894
 895   if (atspi_inited)
 896     {
 897       return 1;
 898     }
 899
 900   atspi_inited = TRUE;
 901
 902   g_type_init ();
 903
 904   get_live_refs();
 905
 906   dbus_error_init (&error);
 907   bus = get_accessibility_bus ();
 908   if (!bus)
 909   {
 910     g_error ("Couldn't get session bus");
 911     return 2;
 912   }
 913   dbus_bus_register (bus, &error);
 914   dbus_connection_setup_with_g_main(bus, g_main_context_default());
 915   dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
 916   dbind_set_timeout (1000);
 917   match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
 918   dbus_error_init (&error);
 919   dbus_bus_add_match (bus, match, &error);
 920   g_free (match);
 921   match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
 922   dbus_bus_add_match (bus, match, &error);
 923   g_free (match);
 924   match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
 925   dbus_bus_add_match (bus, match, &error);
 926   g_free (match);
 927   match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
 928   dbus_bus_add_match (bus, match, &error);
 929   g_free (match);
 930   match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
 931   dbus_bus_add_match (bus, match, &error);
 932   g_free (match);
 933   return 0;
 934 }
 935
 936   static GMainLoop *mainloop;
 937
 938 /**
 939  * atspi_event_main:
 940  *
 941  * Starts/enters the main event loop for the AT-SPI services.
 942  *
 943  * (NOTE: This method does not return control, it is exited via a call to
 944  *  atspi_event_quit () from within an event handler).
 945  *
 946  **/
 947 void
 948 atspi_event_main (void)
 949 {
 950   mainloop = g_main_loop_new (NULL, FALSE);
 951   g_main_loop_run (mainloop);
 952 }
 953
 954 /**
 955  * atspi_event_quit:
 956  *
 957  * Quits the last main event loop for the SPI services,
 958  * see atspi_event_main
 959  **/
 960 void
 961 atspi_event_quit (void)
 962 {
 963   g_main_loop_quit (mainloop);
 964 }
 965
 966 /**
 967  * atspi_exit:
 968  *
 969  * Disconnects from the Accessibility Registry and releases
 970  * any floating resources. Call only once at exit.
 971  *
 972  * Returns: 0 if there were no leaks, otherwise non zero.
 973  **/
 974 int
 975 atspi_exit (void)
 976 {
 977   int leaked;
 978
 979   if (!atspi_inited)
 980     {
 981       return 0;
 982     }
 983
 984   atspi_inited = FALSE;
 985
 986   if (live_refs)
 987     {
 988       leaked = g_hash_table_size (live_refs);
 989     }
 990   else
 991     {
 992       leaked = 0;
 993     }
 994
 995   cleanup ();
 996
 997   return leaked;
 998 }
 999
1000 dbus_bool_t
1001 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
1002 {
1003   va_list args;
1004   dbus_bool_t retval;
1005   DBusError err;
1006   AtspiObject *aobj = ATSPI_OBJECT (obj);
1007
1008   if (!aobj->app || !aobj->app->bus)
1009   {
1010     g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
1011                           _("The application no longer exists"));
1012     return FALSE;
1013   }
1014
1015   va_start (args, type);
1016   dbus_error_init (&err);
1017   retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
1018                                            aobj->path, interface, method, &err,
1019                                            type, args);
1020   va_end (args);
1021   _atspi_process_deferred_messages ((gpointer)TRUE);
1022   if (dbus_error_is_set (&err))
1023   {
1024     /* TODO: Set gerror */
1025     dbus_error_free (&err);
1026   }
1027   return retval;
1028 }
1029
1030 DBusMessage *
1031 _atspi_dbus_call_partial (gpointer obj,
1032                           const char *interface,
1033                           const char *method,
1034                           GError **error,
1035                           const char *type, ...)
1036 {
1037   va_list args;
1038
1039   va_start (args, type);
1040   return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
1041 }
1042
1043 DBusMessage *
1044 _atspi_dbus_call_partial_va (gpointer obj,
1045                           const char *interface,
1046                           const char *method,
1047                           GError **error,
1048                           const char *type,
1049                           va_list args)
1050 {
1051   AtspiObject *aobj = ATSPI_OBJECT (obj);
1052   dbus_bool_t retval;
1053   DBusError err;
1054     DBusMessage *msg = NULL, *reply = NULL;
1055     DBusMessageIter iter;
1056     const char *p;
1057
1058   dbus_error_init (&err);
1059
1060   if (!aobj->app || !aobj->app->bus)
1061   {
1062     g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
1063                           _("The application no longer exists"));
1064     goto out;
1065   }
1066
1067     msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
1068     if (!msg)
1069         goto out;
1070
1071     p = type;
1072     dbus_message_iter_init_append (msg, &iter);
1073     dbind_any_marshal_va (&iter, &p, args);
1074
1075     reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1076 out:
1077   va_end (args);
1078   _atspi_process_deferred_messages ((gpointer)TRUE);
1079   if (dbus_error_is_set (&err))
1080   {
1081     /* TODO: Set gerror */
1082     dbus_error_free (&err);
1083   }
1084   return reply;
1085 }
1086
1087 dbus_bool_t
1088 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1089 {
1090   DBusMessage *message, *reply;
1091   DBusMessageIter iter, iter_variant;
1092   DBusError err;
1093   dbus_bool_t retval = FALSE;
1094   AtspiObject *aobj = ATSPI_OBJECT (obj);
1095
1096   if (!aobj)
1097     return FALSE;
1098
1099   message = dbus_message_new_method_call (aobj->app->bus_name,
1100                                           aobj->path,
1101                                           "org.freedesktop.DBus.Properties",
1102                                           "Get");
1103   if (!message)
1104   {
1105     // TODO: throw exception
1106     goto done;
1107   }
1108   dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1109   dbus_error_init (&err);
1110   reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1111   dbus_message_unref (message);
1112   _atspi_process_deferred_messages ((gpointer)TRUE);
1113   if (!reply)
1114   {
1115     // TODO: throw exception
1116     goto done;
1117   }
1118   dbus_message_iter_init (reply, &iter);
1119   if (dbus_message_iter_get_arg_type (&iter) != 'v')
1120   {
1121     g_warning (_("AT-SPI: expected a variant when fetching %s from interface %s; got %s\n"), name, interface, dbus_message_get_signature (reply));
1122     goto done;
1123   }
1124   dbus_message_iter_recurse (&iter, &iter_variant);
1125   if (dbus_message_iter_get_arg_type (&iter_variant) != type[0])
1126   {
1127     g_warning (_("atspi_dbus_get_property: Wrong type: expected %s, got %c\n"), type, dbus_message_iter_get_arg_type (&iter_variant));
1128     goto done;
1129   }
1130   if (!strcmp (type, "(so)"))
1131   {
1132     *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1133   }
1134   else
1135   {
1136     dbus_message_iter_get_basic (&iter_variant, data);
1137     dbus_message_unref (reply);
1138     if (type [0] == 's')
1139       *(char **)data = g_strdup (*(char **)data);
1140   }
1141   retval = TRUE;
1142 done:
1143   return retval;
1144 }
1145
1146 DBusMessage *
1147 _atspi_dbus_send_with_reply_and_block (DBusMessage *message)
1148 {
1149   DBusMessage *reply;
1150   DBusError err;
1151   AtspiApplication *app;
1152   DBusConnection *bus;
1153
1154   app = get_application (dbus_message_get_destination (message));
1155   bus = (app ? app->bus : _atspi_bus());
1156   dbus_error_init (&err);
1157   reply = dbind_send_and_allow_reentry (bus, message, &err);
1158   _atspi_process_deferred_messages ((gpointer)TRUE);
1159   dbus_message_unref (message);
1160   if (err.message)
1161     g_warning (_("AT-SPI: Got error: %s\n"), err.message);
1162   return reply;
1163 }
1164
1165 GHashTable *
1166 _atspi_dbus_return_hash_from_message (DBusMessage *message)
1167 {
1168   DBusMessageIter iter;
1169   GHashTable *ret;
1170
1171   _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL);
1172
1173   dbus_message_iter_init (message, &iter);
1174   ret = _atspi_dbus_hash_from_iter (&iter);
1175   dbus_message_unref (message);
1176   return ret;
1177 }
1178
1179 GHashTable *
1180 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1181 {
1182   GHashTable *hash = g_hash_table_new (g_str_hash, g_str_equal);
1183   DBusMessageIter iter_array, iter_dict;
1184
1185   dbus_message_iter_recurse (iter, &iter_array);
1186   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1187   {
1188     const char *name, *value;
1189     dbus_message_iter_recurse (&iter_array, &iter_dict);
1190     dbus_message_iter_get_basic (&iter_dict, &name);
1191     dbus_message_iter_next (&iter_dict);
1192     dbus_message_iter_get_basic (&iter_dict, &value);
1193     g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1194     dbus_message_iter_next (&iter_array);
1195   }
1196   return hash;
1197 }
1198
1199 GArray *
1200 _atspi_dbus_return_attribute_array_from_message (DBusMessage *message)
1201 {
1202   DBusMessageIter iter;
1203   GArray *ret;
1204
1205   _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL);
1206
1207   dbus_message_iter_init (message, &iter);
1208
1209   ret = _atspi_dbus_attribute_array_from_iter (&iter);
1210   dbus_message_unref (message);
1211   return ret;
1212 }
1213
1214 GArray *
1215 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1216 {
1217   DBusMessageIter iter_array, iter_dict;
1218   GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1219   gint count = 0;
1220
1221   dbus_message_iter_recurse (iter, &iter_array);
1222   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1223   {
1224     const char *name, *value;
1225     gchar *str;
1226     GArray *new_array;
1227     dbus_message_iter_recurse (&iter_array, &iter_dict);
1228     dbus_message_iter_get_basic (&iter_dict, &name);
1229     dbus_message_iter_next (&iter_dict);
1230     dbus_message_iter_get_basic (&iter_dict, &value);
1231     str = g_strdup_printf ("%s:%s", name, value);
1232     new_array = g_array_append_val (array, str);
1233     if (new_array)
1234       array = new_array;
1235     dbus_message_iter_next (&iter_array);;
1236   }
1237   return array;
1238 }
1239
1240 void
1241 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1242 {
1243   DBusMessageIter iter_array;
1244
1245   accessible->interfaces = 0;
1246   dbus_message_iter_recurse (iter, &iter_array);
1247   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1248   {
1249     const char *iface;
1250     gint n;
1251     dbus_message_iter_get_basic (&iter_array, &iface);
1252     if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1253     n = _atspi_get_iface_num (iface);
1254     if (n == -1)
1255     {
1256       g_warning (_("AT-SPI: Unknown interface %s"), iface);
1257     }
1258     else
1259       accessible->interfaces |= (1 << n);
1260     dbus_message_iter_next (&iter_array);
1261   }
1262   accessible->cached_properties |= ATSPI_CACHE_INTERFACES;
1263 }
1264
1265 void
1266 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1267 {
1268   DBusMessageIter iter_array;
1269   gint count;
1270   dbus_uint32_t *states;
1271
1272   dbus_message_iter_recurse (iter, &iter_array);
1273   dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1274   if (count != 2)
1275   {
1276     g_warning (_("AT-SPI: expected 2 values in states array; got %d\n"), count);
1277     if (!accessible->states)
1278       accessible->states = _atspi_state_set_new_internal (accessible, 0);
1279   }
1280   else
1281   {
1282     guint64 val = ((guint64)states [1]) << 32;
1283     val += states [0];
1284     if (!accessible->states)
1285       accessible->states = _atspi_state_set_new_internal (accessible, val);
1286     else
1287       accessible->states->states = val;
1288   }
1289   accessible->cached_properties |= ATSPI_CACHE_STATES;
1290 }
1291
1292 GQuark
1293 atspi_error_quark (void)
1294 {
1295   return g_quark_from_static_string ("atspi_error");
1296 }
1297