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