2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2008, 2009 Codethink Ltd.
6 * Copyright 2001, 2002, 2003 Sun Microsystems Inc.,
7 * Copyright 2001, 2002, 2003 Ximian, Inc.
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.
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.
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.
26 #include "dbus/dbus-glib-lowlevel.h"
29 #include <X11/Xatom.h>
38 #include <droute/droute.h>
46 #include "accessible-register.h"
47 #include "accessible-leasing.h"
48 #include "accessible-cache.h"
50 #include "common/spi-dbus.h"
52 /*---------------------------------------------------------------------------*/
54 SpiBridge *spi_global_app_data = NULL;
56 static const AtkMisc *atk_misc = NULL;
58 /*static Display *bridge_display = NULL;*/
60 /*---------------------------------------------------------------------------*/
63 * Returns a 'canonicalized' value for DISPLAY,
64 * with the screen number stripped off if present.
68 spi_display_name (void)
70 static const char *canonical_display_name = NULL;
71 if (!canonical_display_name)
73 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
76 display_env = g_getenv ("DISPLAY");
77 if (!display_env || !display_env[0])
78 canonical_display_name = ":0";
81 gchar *display_p, *screen_p;
82 canonical_display_name = g_strdup (display_env);
83 display_p = strrchr (canonical_display_name, ':');
84 screen_p = strrchr (canonical_display_name, '.');
85 if (screen_p && display_p && (screen_p > display_p))
93 canonical_display_name = display_env;
96 return canonical_display_name;
99 /*---------------------------------------------------------------------------*/
102 * Gets the IOR from the XDisplay.
103 * Not currently used in D-Bus version, but something similar
104 * may be employed in the future for accessing the registry daemon
108 static DBusConnection *
109 spi_atk_bridge_get_bus (void)
113 Display *bridge_display;
115 unsigned char *data = NULL;
116 unsigned long nitems;
117 unsigned long leftover;
119 DBusConnection *bus = NULL;
122 bridge_display = XOpenDisplay (spi_display_name ());
125 g_warning ("AT_SPI: Could not get the display\n");
129 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
130 XGetWindowProperty (bridge_display,
131 XDefaultRootWindow (bridge_display),
133 (long) BUFSIZ, False,
134 (Atom) 31, &actual_type, &actual_format,
135 &nitems, &leftover, &data);
137 dbus_error_init (&error);
142 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
143 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
146 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
152 bus = dbus_connection_open (data, &error);
155 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
160 if (!dbus_bus_register (bus, &error))
162 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
172 set_reply (DBusPendingCall *pending, void *user_data)
174 void **replyptr = (void **)user_data;
176 *replyptr = dbus_pending_call_steal_reply (pending);
179 /*---------------------------------------------------------------------------*/
182 add_event (const char *bus_name, const char *event)
188 evdata = (event_data *) g_malloc (sizeof (*evdata));
191 data = g_strsplit (event, ":", 3);
197 evdata->bus_name = g_strdup (bus_name);
199 new_list = g_list_append (spi_global_app_data->events, evdata);
201 spi_global_app_data->events = new_list;
205 get_registered_event_listeners (SpiBridge *app)
207 DBusMessage *message, *reply;
208 DBusMessageIter iter, iter_array, iter_struct;
210 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
211 SPI_DBUS_PATH_REGISTRY,
212 SPI_DBUS_INTERFACE_REGISTRY,
213 "GetRegisteredEvents");
217 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
218 dbus_message_unref (message);
221 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
223 /* TODO: Add a warning when it's okay to add strings */
224 dbus_message_unref (reply);
227 dbus_message_iter_init (reply, &iter);
228 dbus_message_iter_recurse (&iter, &iter_array);
229 /* TODO: This is bad. Need to determine that the array is non-empty,
230 so that we don't initially read a value rom it in that case, but using
231 a deprecated function. */
232 if (dbus_message_iter_get_array_len (&iter_array) > 0) do
234 char *bus_name, *event;
235 dbus_message_iter_recurse (&iter_array, &iter_struct);
236 dbus_message_iter_get_basic (&iter_struct, &bus_name);
237 dbus_message_iter_next (&iter_struct);
238 dbus_message_iter_get_basic (&iter_struct, &event);
239 add_event (bus_name, event);
241 while (dbus_message_iter_next (&iter_array));
242 dbus_message_unref (reply);
246 register_reply (DBusPendingCall *pending, void *user_data)
249 SpiBridge *app = user_data;
250 DBusMessage *message;
252 reply = dbus_pending_call_steal_reply (pending);
255 gchar *app_name, *obj_path;
257 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
259 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
263 DBusMessageIter iter, iter_struct;
264 dbus_message_iter_init (reply, &iter);
265 dbus_message_iter_recurse (&iter, &iter_struct);
266 dbus_message_iter_get_basic (&iter_struct, &app_name);
267 dbus_message_iter_next (&iter_struct);
268 dbus_message_iter_get_basic (&iter_struct, &obj_path);
270 app->desktop_name = g_strdup (app_name);
271 app->desktop_path = g_strdup (obj_path);
276 g_warning ("AT-SPI: Could not embed inside desktop");
279 dbus_message_unref (reply);
281 get_registered_event_listeners (spi_global_app_data);
285 register_application (SpiBridge * app)
287 DBusMessage *message, *reply;
288 DBusMessageIter iter;
290 DBusPendingCall *pending;
291 const int max_addr_length = 128; /* should be long enough */
293 dbus_error_init (&error);
295 /* These will be overridden when we get a reply, but in practice these
296 defaults should always be correct */
297 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
298 app->desktop_path = SPI_DBUS_PATH_ROOT;
300 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
302 SPI_DBUS_INTERFACE_SOCKET,
305 dbus_message_iter_init_append (message, &iter);
306 spi_object_append_reference (&iter, app->root);
308 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1))
313 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
316 dbus_message_unref (message);
318 /* could this be better, we accept some amount of race in getting the temp name*/
319 /* make sure the directory exists */
320 mkdir("/tmp/at-spi2/", S_IRWXU);
321 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
322 sprintf(app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
328 /*---------------------------------------------------------------------------*/
331 deregister_application (SpiBridge * app)
333 DBusMessage *message;
334 DBusMessageIter iter;
338 dbus_error_init (&error);
340 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
341 SPI_DBUS_PATH_REGISTRY,
342 SPI_DBUS_INTERFACE_REGISTRY,
343 "DeregisterApplication");
344 dbus_message_set_no_reply (message, TRUE);
346 uname = dbus_bus_get_unique_name (app->bus);
348 dbus_message_iter_init_append (message, &iter);
349 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
350 dbus_connection_send (app->bus, message, NULL);
352 dbus_message_unref (message);
355 /*---------------------------------------------------------------------------*/
360 if (!spi_global_app_data)
365 spi_atk_tidy_windows ();
366 spi_atk_deregister_event_listeners ();
367 deregister_application (spi_global_app_data);
369 g_free (spi_global_app_data);
370 spi_global_app_data = NULL;
372 /* Not currently creating an XDisplay */
375 XCloseDisplay (bridge_display);
379 /*---------------------------------------------------------------------------*/
381 static AtkPlugClass *plug_class;
382 static AtkSocketClass *socket_class;
385 get_plug_id (AtkPlug * plug)
387 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
389 GString *str = g_string_new (NULL);
391 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
392 g_string_printf (str, "%s:%s", uname, path);
394 return g_string_free (str, FALSE);
398 socket_ref_state_set (AtkObject *accessible)
400 char *child_name, *child_path;
401 AtkSocket *socket = ATK_SOCKET (accessible);
405 DBusMessage *message, *reply;
406 DBusMessageIter iter, iter_array;
409 if (!socket->embedded_plug_id)
412 child_name = g_strdup (socket->embedded_plug_id);
415 child_path = g_utf8_strchr (child_name + 1, -1, ':');
421 *(child_path++) = '\0';
422 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
424 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
425 dbus_message_unref (message);
428 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
430 dbus_message_unref (reply);
433 set = atk_state_set_new ();
436 dbus_message_iter_init (reply, &iter);
437 dbus_message_iter_recurse (&iter, &iter_array);
440 dbus_message_iter_get_basic (&iter_array, &v);
441 for (j = 0; j < 32; j++)
445 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
446 atk_state_set_add_state (set, state);
451 while (dbus_message_iter_next (&iter_array));
452 dbus_message_unref (reply);
457 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
459 AtkObject *accessible = ATK_OBJECT(socket);
460 gchar *plug_name, *plug_path;
461 AtkObjectClass *klass;
463 /* Force registration */
464 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
465 /* Let the plug know that it has been embedded */
466 plug_name = g_strdup (plug_id);
472 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
475 DBusMessage *message;
476 *(plug_path++) = '\0';
477 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
478 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
479 dbus_connection_send (spi_global_app_data->bus, message, NULL);
484 klass = ATK_OBJECT_GET_CLASS (accessible);
485 klass->ref_state_set = socket_ref_state_set;
489 install_plug_hooks ()
493 data = g_type_class_ref (ATK_TYPE_PLUG);
494 plug_class = ATK_PLUG_CLASS (data);
495 data = g_type_class_ref (ATK_TYPE_SOCKET);
496 socket_class = ATK_SOCKET_CLASS (data);
497 plug_class->get_object_id = get_plug_id;
498 socket_class->embed = socket_embed_hook;
502 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
506 dbus_connection_ref(con);
507 dbus_connection_setup_with_g_main(con, NULL);
508 droute_intercept_dbus (con);
509 droute_context_register (spi_global_app_data->droute, con);
511 new_list = g_list_append (spi_global_app_data->direct_connections, con);
513 spi_global_app_data->direct_connections = new_list;
522 dbus_error_init(&err);
523 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
525 /* is there a better way to handle this */
529 dbus_server_setup_with_g_main(server, NULL);
530 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
532 spi_global_app_data->server = server;
538 gchar *atspi_dbus_name = NULL;
539 static gboolean atspi_no_register = FALSE;
541 static GOptionEntry atspi_option_entries[] = {
542 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
543 "D-Bus bus name to register as", NULL},
544 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
545 "Do not register with Registry Daemon", NULL},
550 introspect_children_cb (const char *path, void *data)
552 if (!strcmp (path, "/org/a11y/atspi/accessible"))
554 return g_strdup ("<node name=\"root\"/>\n");
555 /* TODO: Should we place the whole hierarchy here? */
561 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
567 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
568 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
571 add_event (sender, name);
575 remove_events (const char *bus_name, const char *event)
581 remove_data = g_strsplit (event, ":", 3);
587 for (list = spi_global_app_data->events; list;)
589 event_data *evdata = list->data;
590 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
591 spi_event_is_subtype (evdata->data, remove_data))
593 GList *events = spi_global_app_data->events;
595 g_strfreev (evdata->data);
596 g_free (evdata->bus_name);
598 spi_global_app_data->events = g_list_remove (events, evdata);
608 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
611 const char *orig_name;
615 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
616 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
619 remove_events (sender, name);
622 static DBusHandlerResult
623 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
625 const char *interface = dbus_message_get_interface (message);
626 const char *member = dbus_message_get_member (message);
627 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
629 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
630 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
632 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
634 result = DBUS_HANDLER_RESULT_HANDLED;
635 if (!strcmp (member, "EventListenerRegistered"))
636 handle_event_listener_registered (bus, message, user_data);
637 else if (!strcmp (member, "EventListenerDeregistered"))
638 handle_event_listener_deregistered (bus, message, user_data);
640 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
648 * The following needs to be initialized.
650 * - DRoute for routing message to their accessible objects.
651 * - Event handlers for emmitting signals on specific ATK events.
652 * - setup the bus for p2p communication
653 * - Application registration with the AT-SPI registry.
657 adaptor_init (gint * argc, gchar ** argv[])
663 gchar *introspection_directory;
664 static gboolean inited = FALSE;
671 DRoutePath *treepath, *accpath;
673 root = atk_get_root ();
674 g_warn_if_fail (root);
681 /* Parse command line options */
682 opt = g_option_context_new (NULL);
683 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
684 g_option_context_set_ignore_unknown_options (opt, TRUE);
685 if (!g_option_context_parse (opt, argc, argv, &err))
686 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
688 /* Allocate global data and do ATK initializations */
689 spi_global_app_data = g_new0 (SpiBridge, 1);
690 atk_misc = atk_misc_get_instance ();
691 spi_global_app_data->root = g_object_ref (root);
693 /* Set up D-Bus connection and register bus name */
694 dbus_error_init (&error);
695 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
696 if (!spi_global_app_data->bus)
698 g_free (spi_global_app_data);
699 spi_global_app_data = NULL;
704 if (atspi_dbus_name != NULL)
706 if (dbus_bus_request_name
707 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
709 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
714 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
719 spi_global_app_data->main_context = g_main_context_new ();
721 dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
723 /* Hook our plug-and socket functions */
724 install_plug_hooks ();
727 * Create the leasing, register and cache objects.
728 * The order is important here, the cache depends on the
731 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
732 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
733 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
735 /* Register droute for routing AT-SPI messages */
736 spi_global_app_data->droute =
739 treepath = droute_add_one (spi_global_app_data->droute,
740 "/org/a11y/atspi/cache", spi_global_cache);
744 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
748 accpath = droute_add_many (spi_global_app_data->droute,
749 "/org/a11y/atspi/accessible",
751 introspect_children_cb,
753 (DRouteGetDatumFunction)
754 spi_global_register_path_to_object);
757 /* Register all interfaces with droute and set up application accessible db */
758 spi_initialize_cache (treepath);
759 spi_initialize_accessible (accpath);
760 spi_initialize_application (accpath);
761 spi_initialize_action (accpath);
762 spi_initialize_collection (accpath);
763 spi_initialize_component (accpath);
764 spi_initialize_document (accpath);
765 spi_initialize_editabletext (accpath);
766 spi_initialize_hyperlink (accpath);
767 spi_initialize_hypertext (accpath);
768 spi_initialize_image (accpath);
769 spi_initialize_selection (accpath);
770 spi_initialize_socket (accpath);
771 spi_initialize_table (accpath);
772 spi_initialize_text (accpath);
773 spi_initialize_value (accpath);
775 droute_context_register (spi_global_app_data->droute,
776 spi_global_app_data->bus);
778 /* Register methods to send D-Bus signals on certain ATK events */
779 spi_atk_register_event_listeners ();
781 /* Set up filter and match rules to catch signals */
782 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
783 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
786 /* Register this app by sending a signal out to AT-SPI registry daemon */
787 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
788 register_application (spi_global_app_data);
790 get_registered_event_listeners (spi_global_app_data);
794 g_atexit (exit_func);
799 /*---------------------------------------------------------------------------*/
802 gtk_module_init (gint * argc, gchar ** argv[])
804 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
806 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
808 return adaptor_init (argc, argv);
814 g_module_check_init (GModule *module)
816 g_module_make_resident (module);
822 gnome_accessibility_module_init (void)
824 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
826 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
828 adaptor_init (NULL, NULL);
830 if (g_getenv ("AT_SPI_DEBUG"))
832 g_print ("Atk Accessibility bridge initialized\n");
838 gnome_accessibility_module_shutdown (void)
840 spi_atk_deregister_event_listeners ();
844 /*END------------------------------------------------------------------------*/