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, sender=%s", dbus_message_get_sender (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
 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;
 570
 571   if (!message)
 572     return NULL;
 573
 574   signature = dbus_message_get_signature (message);
 575   if (!strcmp (signature, "(so)"))
 576   {
 577     dbus_message_iter_init (message, &iter);
 578     retval =  _atspi_dbus_return_accessible_from_iter (&iter);
 579   }
 580   else
 581   {
 582     g_warning ("Atspi: Called _atspi_dbus_return_accessible_from_message with strange signature %s", signature);
 583   }
 584   dbus_message_unref (message);
 585   return retval;
 586 }
 587
 588 AtspiAccessible *
 589 _atspi_dbus_return_accessible_from_iter (DBusMessageIter *iter)
 590 {
 591   const char *app_name, *path;
 592
 593   get_reference_from_iter (iter, &app_name, &path);
 594   return ref_accessible (app_name, path);
 595 }
 596
 597 AtspiHyperlink *
 598 _atspi_dbus_return_hyperlink_from_message (DBusMessage *message)
 599 {
 600   DBusMessageIter iter;
 601   AtspiHyperlink *retval = NULL;
 602   const char *signature = dbus_message_get_signature (message);
 603
 604   if (!strcmp (signature, "(so)"))
 605   {
 606     dbus_message_iter_init (message, &iter);
 607     retval =  _atspi_dbus_return_hyperlink_from_iter (&iter);
 608   }
 609   else
 610   {
 611     g_warning ("Atspi: Called _atspi_dbus_return_hyperlink_from_message with strange signature %s", signature);
 612   }
 613   dbus_message_unref (message);
 614   return retval;
 615 }
 616
 617 AtspiHyperlink *
 618 _atspi_dbus_return_hyperlink_from_iter (DBusMessageIter *iter)
 619 {
 620   const char *app_name, *path;
 621
 622   get_reference_from_iter (iter, &app_name, &path);
 623   return ref_hyperlink (app_name, path);
 624 }
 625
 626 const char *cache_signal_type = "((so)(so)(so)a(so)assusau)";
 627
 628 static DBusHandlerResult
 629 handle_add_accessible (DBusConnection *bus, DBusMessage *message, void *user_data)
 630 {
 631   DBusMessageIter iter;
 632   const char *sender = dbus_message_get_sender (message);
 633   AtspiApplication *app = get_application (sender);
 634   const char *type = cache_signal_type;
 635
 636   if (strcmp (dbus_message_get_signature (message), cache_signal_type) != 0)
 637   {
 638     g_warning ("atspi: AddAccessible with unknown signature %s\n", dbus_message_get_signature (message));
 639     return;
 640   }
 641
 642   dbus_message_iter_init (message, &iter);
 643   add_accessible_from_iter (&iter);
 644 }
 645
 646 typedef struct
 647 {
 648   DBusConnection *bus;
 649   DBusMessage *message;
 650   void *data;
 651 } BusDataClosure;
 652
 653 static guint process_deferred_messages_id = -1;
 654
 655 static void
 656 process_deferred_message (BusDataClosure *closure)
 657 {
 658   int type = dbus_message_get_type (closure->message);
 659   const char *interface = dbus_message_get_interface (closure->message);
 660   const char *member = dbus_message_get_member (closure->message);
 661   dbus_uint32_t v;
 662   char *bus_name;
 663
 664   if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
 665       !strncmp (interface, "org.a11y.atspi.Event.", 21))
 666   {
 667     atspi_dbus_handle_event (closure->bus, closure->message, closure->data);
 668   }
 669   if (dbus_message_is_method_call (closure->message, atspi_interface_device_event_listener, "NotifyEvent"))
 670   {
 671     atspi_dbus_handle_DeviceEvent (closure->bus,
 672                                    closure->message, closure->data);
 673   }
 674   if (dbus_message_is_signal (closure->message, atspi_interface_cache, "AddAccessible"))
 675   {
 676     handle_add_accessible (closure->bus, closure->message, closure->data);
 677   }
 678   if (dbus_message_is_signal (closure->message, atspi_interface_cache, "RemoveAccessible"))
 679   {
 680     handle_remove_accessible (closure->bus, closure->message, closure->data);
 681   }
 682 }
 683
 684 static GList *deferred_messages = NULL;
 685
 686 gboolean
 687 _atspi_process_deferred_messages (gpointer data)
 688 {
 689   static int in_process_deferred_messages = 0;
 690
 691   if (in_process_deferred_messages)
 692     return;
 693   in_process_deferred_messages = 1;
 694   while (deferred_messages != NULL)
 695   {
 696     BusDataClosure *closure = deferred_messages->data;
 697     process_deferred_message (closure);
 698     deferred_messages = g_list_remove (deferred_messages, closure);
 699     dbus_message_unref (closure->message);
 700     dbus_connection_unref (closure->bus);
 701     g_free (closure);
 702   }
 703   /* If data is NULL, assume that we were called from GLib */
 704   if (!data)
 705     process_deferred_messages_id = -1;
 706   in_process_deferred_messages = 0;
 707   return FALSE;
 708 }
 709
 710 static DBusHandlerResult
 711 defer_message (DBusConnection *connection, DBusMessage *message, void *user_data)
 712 {
 713   BusDataClosure *closure = g_new (BusDataClosure, 1);
 714   GList *new_list;
 715
 716   if (!closure)
 717     return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 718   closure->bus = dbus_connection_ref (bus);
 719   closure->message = dbus_message_ref (message);
 720   closure->data = user_data;
 721
 722   new_list = g_list_append (deferred_messages, closure);
 723   if (new_list)
 724     deferred_messages = new_list;
 725
 726   if (process_deferred_messages_id == -1)
 727     process_deferred_messages_id = g_idle_add (_atspi_process_deferred_messages, NULL);
 728   return DBUS_HANDLER_RESULT_HANDLED;
 729 }
 730
 731 static DBusHandlerResult
 732 atspi_dbus_filter (DBusConnection *bus, DBusMessage *message, void *data)
 733 {
 734   int type = dbus_message_get_type (message);
 735   const char *interface = dbus_message_get_interface (message);
 736   const char *member = dbus_message_get_member (message);
 737   dbus_uint32_t v;
 738   char *bus_name;
 739
 740   if (type == DBUS_MESSAGE_TYPE_SIGNAL &&
 741       !strncmp (interface, "org.a11y.atspi.Event.", 21))
 742   {
 743     return defer_message (bus, message, data);
 744   }
 745   if (dbus_message_is_method_call (message, atspi_interface_device_event_listener, "NotifyEvent"))
 746   {
 747     return defer_message (bus, message, data);
 748   }
 749   if (dbus_message_is_signal (message, atspi_interface_cache, "AddAccessible"))
 750   {
 751     return defer_message (bus, message, data);
 752   }
 753   if (dbus_message_is_signal (message, atspi_interface_cache, "RemoveAccessible"))
 754   {
 755     return defer_message (bus, message, data);
 756   }
 757   return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 758 }
 759
 760 static const char *signal_interfaces[] =
 761 {
 762   "org.a11y.atspi.Event.Object",
 763   "org.a11y.atspi.Event.Window",
 764   "org.a11y.atspi.Event.Mouse",
 765   "org.a11y.atspi.Event.Terminal",
 766   "org.a11y.atspi.Event.Document",
 767   "org.a11y.atspi.Event.Focus",
 768   NULL
 769 };
 770
 771 /*
 772  * Returns a 'canonicalized' value for DISPLAY,
 773  * with the screen number stripped off if present.
 774  *
 775  * TODO: Avoid having duplicate functions for this here and in at-spi2-atk
 776  */
 777 static const gchar *
 778 spi_display_name (void)
 779 {
 780   static const char *canonical_display_name = NULL;
 781   if (!canonical_display_name)
 782     {
 783       const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
 784       if (!display_env)
 785         {
 786           display_env = g_getenv ("DISPLAY");
 787           if (!display_env || !display_env[0])
 788             canonical_display_name = ":0";
 789           else
 790             {
 791               gchar *display_p, *screen_p;
 792               canonical_display_name = g_strdup (display_env);
 793               display_p = g_utf8_strrchr (canonical_display_name, -1, ':');
 794               screen_p = g_utf8_strrchr (canonical_display_name, -1, '.');
 795               if (screen_p && display_p && (screen_p > display_p))
 796                 {
 797                   *screen_p = '\0';
 798                 }
 799             }
 800         }
 801       else
 802         {
 803           canonical_display_name = display_env;
 804         }
 805     }
 806   return canonical_display_name;
 807 }
 808
 809 /* TODO: Avoid having duplicate functions for this here and in at-spi2-atk */
 810 static DBusConnection *
 811 get_accessibility_bus ()
 812 {
 813   Atom AT_SPI_BUS;
 814   Atom actual_type;
 815   Display *bridge_display;
 816   int actual_format;
 817   unsigned char *data = NULL;
 818   unsigned long nitems;
 819   unsigned long leftover;
 820
 821   DBusConnection *bus = NULL;
 822   DBusError error;
 823
 824   bridge_display = XOpenDisplay (spi_display_name ());
 825   if (!bridge_display)
 826     {
 827       g_warning ("AT_SPI: Could not get the display\n");
 828       return NULL;
 829     }
 830
 831   AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
 832   XGetWindowProperty (bridge_display,
 833                       XDefaultRootWindow (bridge_display),
 834                       AT_SPI_BUS, 0L,
 835                       (long) BUFSIZ, False,
 836                       (Atom) 31, &actual_type, &actual_format,
 837                       &nitems, &leftover, &data);
 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   int i;
 886
 887   if (atspi_inited)
 888     {
 889       return 1;
 890     }
 891
 892   atspi_inited = TRUE;
 893
 894   g_type_init ();
 895
 896   get_live_refs();
 897
 898   dbus_error_init (&error);
 899   bus = get_accessibility_bus ();
 900   if (!bus)
 901   {
 902     g_error ("Couldn't get session bus");
 903     return 2;
 904   }
 905   dbus_bus_register (bus, &error);
 906   dbus_connection_setup_with_g_main(bus, g_main_context_default());
 907   dbus_connection_add_filter (bus, atspi_dbus_filter, NULL, NULL);
 908   dbind_set_timeout (1000);
 909   match = g_strdup_printf ("type='signal',interface='%s',member='AddAccessible'", atspi_interface_cache);
 910   dbus_error_init (&error);
 911   dbus_bus_add_match (bus, match, &error);
 912   g_free (match);
 913   match = g_strdup_printf ("type='signal',interface='%s',member='RemoveAccessible'", atspi_interface_cache);
 914   dbus_bus_add_match (bus, match, &error);
 915   g_free (match);
 916   match = g_strdup_printf ("type='signal',interface='%s',member='ChildrenChanged'", atspi_interface_event_object);
 917   dbus_bus_add_match (bus, match, &error);
 918   g_free (match);
 919   match = g_strdup_printf ("type='signal',interface='%s',member='PropertyChange'", atspi_interface_event_object);
 920   dbus_bus_add_match (bus, match, &error);
 921   g_free (match);
 922   match = g_strdup_printf ("type='signal',interface='%s',member='StateChanged'", atspi_interface_event_object);
 923   dbus_bus_add_match (bus, match, &error);
 924   g_free (match);
 925   return 0;
 926 }
 927
 928   static GMainLoop *mainloop;
 929
 930 /**
 931  * atspi_event_main:
 932  *
 933  * Starts/enters the main event loop for the AT-SPI services.
 934  *
 935  * (NOTE: This method does not return control, it is exited via a call to
 936  *  atspi_event_quit () from within an event handler).
 937  *
 938  **/
 939 void
 940 atspi_event_main (void)
 941 {
 942   mainloop = g_main_loop_new (NULL, FALSE);
 943   g_main_loop_run (mainloop);
 944 }
 945
 946 /**
 947  * atspi_event_quit:
 948  *
 949  * Quits the last main event loop for the SPI services,
 950  * see atspi_event_main
 951  **/
 952 void
 953 atspi_event_quit (void)
 954 {
 955   g_main_loop_quit (mainloop);
 956 }
 957
 958 /**
 959  * atspi_exit:
 960  *
 961  * Disconnects from the Accessibility Registry and releases
 962  * any floating resources. Call only once at exit.
 963  *
 964  * Returns: 0 if there were no leaks, otherwise non zero.
 965  **/
 966 int
 967 atspi_exit (void)
 968 {
 969   int leaked;
 970
 971   if (!atspi_inited)
 972     {
 973       return 0;
 974     }
 975
 976   atspi_inited = FALSE;
 977
 978   if (live_refs)
 979     {
 980       leaked = g_hash_table_size (live_refs);
 981     }
 982   else
 983     {
 984       leaked = 0;
 985     }
 986
 987   cleanup ();
 988
 989   return leaked;
 990 }
 991
 992 dbus_bool_t
 993 _atspi_dbus_call (gpointer obj, const char *interface, const char *method, GError **error, const char *type, ...)
 994 {
 995   va_list args;
 996   dbus_bool_t retval;
 997   DBusError err;
 998   AtspiObject *aobj = ATSPI_OBJECT (obj);
 999
1000   va_start (args, type);
1001   dbus_error_init (&err);
1002   retval = dbind_method_call_reentrant_va (aobj->app->bus, aobj->app->bus_name,
1003                                            aobj->path, interface, method, &err,
1004                                            type, args);
1005   va_end (args);
1006   _atspi_process_deferred_messages ((gpointer)TRUE);
1007   if (dbus_error_is_set (&err))
1008   {
1009     /* TODO: Set gerror */
1010     dbus_error_free (&err);
1011   }
1012   return retval;
1013 }
1014
1015 DBusMessage *
1016 _atspi_dbus_call_partial (gpointer obj,
1017                           const char *interface,
1018                           const char *method,
1019                           GError **error,
1020                           const char *type, ...)
1021 {
1022   va_list args;
1023
1024   va_start (args, type);
1025   return _atspi_dbus_call_partial_va (obj, interface, method, error, type, args);
1026 }
1027
1028 DBusMessage *
1029 _atspi_dbus_call_partial_va (gpointer obj,
1030                           const char *interface,
1031                           const char *method,
1032                           GError **error,
1033                           const char *type,
1034                           va_list args)
1035 {
1036   AtspiObject *aobj = ATSPI_OBJECT (obj);
1037   dbus_bool_t retval;
1038   DBusError err;
1039     DBusMessage *msg = NULL, *reply = NULL;
1040     DBusMessageIter iter;
1041     const char *p;
1042
1043   dbus_error_init (&err);
1044
1045     msg = dbus_message_new_method_call (aobj->app->bus_name, aobj->path, interface, method);
1046     if (!msg)
1047         goto out;
1048
1049     p = type;
1050     dbus_message_iter_init_append (msg, &iter);
1051     dbind_any_marshal_va (&iter, &p, args);
1052
1053     reply = dbind_send_and_allow_reentry (aobj->app->bus, msg, &err);
1054 out:
1055   va_end (args);
1056   _atspi_process_deferred_messages ((gpointer)TRUE);
1057   if (dbus_error_is_set (&err))
1058   {
1059     /* TODO: Set gerror */
1060     dbus_error_free (&err);
1061   }
1062   return reply;
1063 }
1064
1065 dbus_bool_t
1066 _atspi_dbus_get_property (gpointer obj, const char *interface, const char *name, GError **error, const char *type, void *data)
1067 {
1068   DBusMessage *message, *reply;
1069   DBusMessageIter iter, iter_variant;
1070   DBusError err;
1071   dbus_bool_t retval = FALSE;
1072   AtspiObject *aobj = ATSPI_OBJECT (obj);
1073
1074   if (!aobj)
1075     return FALSE;
1076
1077   message = dbus_message_new_method_call (aobj->app->bus_name,
1078                                           aobj->path,
1079                                           "org.freedesktop.DBus.Properties",
1080                                           "Get");
1081   if (!message)
1082   {
1083     // TODO: throw exception
1084     goto done;
1085   }
1086   dbus_message_append_args (message, DBUS_TYPE_STRING, &interface, DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID);
1087   dbus_error_init (&err);
1088   reply = dbind_send_and_allow_reentry (aobj->app->bus, message, &err);
1089   dbus_message_unref (message);
1090   _atspi_process_deferred_messages ((gpointer)TRUE);
1091   if (!reply)
1092   {
1093     // TODO: throw exception
1094     goto done;
1095   }
1096   dbus_message_iter_init (reply, &iter);
1097   if (dbus_message_iter_get_arg_type (&iter) != 'v')
1098   {
1099     g_warning ("at-spi: expected a variant when fetching %s from interface %s; got %s\n", name, interface, dbus_message_get_signature (reply));
1100     goto done;
1101   }
1102   dbus_message_iter_recurse (&iter, &iter_variant);
1103   if (dbus_message_iter_get_arg_type (&iter_variant) != type[0])
1104   {
1105     g_warning ("atspi_dbus_get_property: Wrong type: expected %s, got %c\n", type, dbus_message_iter_get_arg_type (&iter_variant));
1106     goto done;
1107   }
1108   if (!strcmp (type, "(so)"))
1109   {
1110     *((AtspiAccessible **)data) = _atspi_dbus_return_accessible_from_iter (&iter_variant);
1111   }
1112   else
1113   {
1114     dbus_message_iter_get_basic (&iter_variant, data);
1115     dbus_message_unref (reply);
1116     if (type [0] == 's')
1117       *(char **)data = g_strdup (*(char **)data);
1118   }
1119   retval = TRUE;
1120 done:
1121   return retval;
1122 }
1123
1124 DBusMessage *
1125 _atspi_dbus_send_with_reply_and_block (DBusMessage *message)
1126 {
1127   DBusMessage *reply;
1128   DBusError err;
1129   AtspiApplication *app;
1130   DBusConnection *bus;
1131
1132   app = get_application (dbus_message_get_destination (message));
1133   bus = (app ? app->bus : _atspi_bus());
1134   dbus_error_init (&err);
1135   reply = dbind_send_and_allow_reentry (bus, message, &err);
1136   _atspi_process_deferred_messages ((gpointer)TRUE);
1137   dbus_message_unref (message);
1138   if (err.message)
1139     g_warning ("Atspi: Got error: %s\n", err.message);
1140   return reply;
1141 }
1142
1143 GHashTable *
1144 _atspi_dbus_return_hash_from_message (DBusMessage *message)
1145 {
1146   DBusMessageIter iter;
1147   GHashTable *ret;
1148
1149   _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL);
1150
1151   dbus_message_iter_init (message, &iter);
1152   ret = _atspi_dbus_hash_from_iter (&iter);
1153   dbus_message_unref (message);
1154   return ret;
1155 }
1156
1157 GHashTable *
1158 _atspi_dbus_hash_from_iter (DBusMessageIter *iter)
1159 {
1160   GHashTable *hash = g_hash_table_new (g_str_hash, g_str_equal);
1161   DBusMessageIter iter_array, iter_dict;
1162
1163   dbus_message_iter_recurse (iter, &iter_array);
1164   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1165   {
1166     const char *name, *value;
1167     dbus_message_iter_recurse (&iter_array, &iter_dict);
1168     dbus_message_iter_get_basic (&iter_dict, &name);
1169     dbus_message_iter_next (&iter_dict);
1170     dbus_message_iter_get_basic (&iter_dict, &value);
1171     g_hash_table_insert (hash, g_strdup (name), g_strdup (value));
1172     dbus_message_iter_next (&iter_array);
1173   }
1174   return hash;
1175 }
1176
1177 GArray *
1178 _atspi_dbus_return_attribute_array_from_message (DBusMessage *message)
1179 {
1180   DBusMessageIter iter;
1181   GArray *ret;
1182
1183   _ATSPI_DBUS_CHECK_SIG (message, "a{ss}", NULL);
1184
1185   dbus_message_iter_init (message, &iter);
1186
1187   ret = _atspi_dbus_attribute_array_from_iter (&iter);
1188   dbus_message_unref (message);
1189   return ret;
1190 }
1191
1192 GArray *
1193 _atspi_dbus_attribute_array_from_iter (DBusMessageIter *iter)
1194 {
1195   DBusMessageIter iter_array, iter_dict;
1196   GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1197   gint count = 0;
1198
1199   dbus_message_iter_recurse (iter, &iter_array);
1200   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1201   {
1202     const char *name, *value;
1203     gchar *str;
1204     GArray *new_array;
1205     dbus_message_iter_recurse (&iter_array, &iter_dict);
1206     dbus_message_iter_get_basic (&iter_dict, &name);
1207     dbus_message_iter_next (&iter_dict);
1208     dbus_message_iter_get_basic (&iter_dict, &value);
1209     str = g_strdup_printf ("%s:%s", name, value);
1210     new_array = g_array_append_val (array, str);
1211     if (new_array)
1212       array = new_array;
1213     dbus_message_iter_next (&iter_array);;
1214   }
1215   return array;
1216 }
1217
1218 void
1219 _atspi_dbus_set_interfaces (AtspiAccessible *accessible, DBusMessageIter *iter)
1220 {
1221   DBusMessageIter iter_array;
1222
1223   accessible->interfaces = 0;
1224   dbus_message_iter_recurse (iter, &iter_array);
1225   while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
1226   {
1227     const char *iface;
1228     gint n;
1229     dbus_message_iter_get_basic (&iter_array, &iface);
1230     if (!strcmp (iface, "org.freedesktop.DBus.Introspectable")) continue;
1231     n = _atspi_get_iface_num (iface);
1232     if (n == -1)
1233     {
1234       g_warning ("at-spi: Unknown interface %s", iface);
1235     }
1236     else
1237       accessible->interfaces |= (1 << n);
1238     dbus_message_iter_next (&iter_array);
1239   }
1240   accessible->cached_properties |= ATSPI_CACHE_INTERFACES;
1241 }
1242
1243 void
1244 _atspi_dbus_set_state (AtspiAccessible *accessible, DBusMessageIter *iter)
1245 {
1246   DBusMessageIter iter_array;
1247   gint count;
1248   dbus_uint32_t *states;
1249
1250   dbus_message_iter_recurse (iter, &iter_array);
1251   dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
1252   if (count != 2)
1253   {
1254     g_warning ("at-spi: expected 2 values in states array; got %d\n", count);
1255     if (!accessible->states)
1256       accessible->states = _atspi_state_set_new_internal (accessible, 0);
1257   }
1258   else
1259   {
1260     guint64 val = ((guint64)states [1]) << 32;
1261     val += states [0];
1262     if (!accessible->states)
1263       accessible->states = _atspi_state_set_new_internal (accessible, val);
1264     else
1265       accessible->states->states = val;
1266   }
1267   accessible->cached_properties |= ATSPI_CACHE_STATES;
1268 }