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>
40 #include <glib/gi18n.h>
47 #include "accessible-register.h"
48 #include "accessible-leasing.h"
49 #include "accessible-cache.h"
51 #include "common/spi-dbus.h"
53 /*---------------------------------------------------------------------------*/
55 SpiBridge *spi_global_app_data = NULL;
57 static const AtkMisc *atk_misc = NULL;
59 /*static Display *bridge_display = NULL;*/
61 /*---------------------------------------------------------------------------*/
64 * Returns a 'canonicalized' value for DISPLAY,
65 * with the screen number stripped off if present.
69 spi_display_name (void)
71 static const char *canonical_display_name = NULL;
72 if (!canonical_display_name)
74 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
77 display_env = g_getenv ("DISPLAY");
78 if (!display_env || !display_env[0])
79 canonical_display_name = ":0";
82 gchar *display_p, *screen_p;
83 canonical_display_name = g_strdup (display_env);
84 display_p = strrchr (canonical_display_name, ':');
85 screen_p = strrchr (canonical_display_name, '.');
86 if (screen_p && display_p && (screen_p > display_p))
94 canonical_display_name = display_env;
97 return canonical_display_name;
100 /*---------------------------------------------------------------------------*/
103 * Gets the IOR from the XDisplay.
104 * Not currently used in D-Bus version, but something similar
105 * may be employed in the future for accessing the registry daemon
109 static DBusConnection *
110 spi_atk_bridge_get_bus (void)
114 Display *bridge_display;
116 unsigned char *data = NULL;
117 unsigned long nitems;
118 unsigned long leftover;
120 DBusConnection *bus = NULL;
123 bridge_display = XOpenDisplay (spi_display_name ());
126 g_warning ("AT_SPI: Could not get the display\n");
130 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
131 XGetWindowProperty (bridge_display,
132 XDefaultRootWindow (bridge_display),
134 (long) BUFSIZ, False,
135 (Atom) 31, &actual_type, &actual_format,
136 &nitems, &leftover, &data);
138 dbus_error_init (&error);
143 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
144 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
147 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
153 bus = dbus_connection_open (data, &error);
156 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
161 if (!dbus_bus_register (bus, &error))
163 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
173 set_reply (DBusPendingCall *pending, void *user_data)
175 void **replyptr = (void **)user_data;
177 *replyptr = dbus_pending_call_steal_reply (pending);
178 dbus_pending_call_unref (pending);
181 /*---------------------------------------------------------------------------*/
184 add_event (const char *bus_name, const char *event)
190 evdata = (event_data *) g_malloc (sizeof (*evdata));
193 data = g_strsplit (event, ":", 3);
199 evdata->bus_name = g_strdup (bus_name);
201 new_list = g_list_append (spi_global_app_data->events, evdata);
203 spi_global_app_data->events = new_list;
207 get_registered_event_listeners (SpiBridge *app)
209 DBusMessage *message, *reply;
210 DBusMessageIter iter, iter_array, iter_struct;
212 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
213 SPI_DBUS_PATH_REGISTRY,
214 SPI_DBUS_INTERFACE_REGISTRY,
215 "GetRegisteredEvents");
216 spi_global_app_data->events_initialized = TRUE;
220 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
221 dbus_message_unref (message);
224 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
226 /* TODO: Add a warning when it's okay to add strings */
227 dbus_message_unref (reply);
230 dbus_message_iter_init (reply, &iter);
231 dbus_message_iter_recurse (&iter, &iter_array);
232 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
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);
240 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);
253 dbus_pending_call_unref (pending);
256 gchar *app_name, *obj_path;
258 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
260 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
264 DBusMessageIter iter, iter_struct;
265 dbus_message_iter_init (reply, &iter);
266 dbus_message_iter_recurse (&iter, &iter_struct);
267 dbus_message_iter_get_basic (&iter_struct, &app_name);
268 dbus_message_iter_next (&iter_struct);
269 dbus_message_iter_get_basic (&iter_struct, &obj_path);
271 app->desktop_name = g_strdup (app_name);
272 app->desktop_path = g_strdup (obj_path);
277 g_warning ("AT-SPI: Could not embed inside desktop");
280 dbus_message_unref (reply);
282 get_registered_event_listeners (spi_global_app_data);
286 register_application (SpiBridge * app)
288 DBusMessage *message, *reply;
289 DBusMessageIter iter;
291 DBusPendingCall *pending;
292 const int max_addr_length = 128; /* should be long enough */
294 dbus_error_init (&error);
296 /* These will be overridden when we get a reply, but in practice these
297 defaults should always be correct */
298 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
299 app->desktop_path = SPI_DBUS_PATH_ROOT;
301 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
303 SPI_DBUS_INTERFACE_SOCKET,
306 dbus_message_iter_init_append (message, &iter);
307 spi_object_append_reference (&iter, app->root);
309 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1)
315 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
318 dbus_message_unref (message);
320 /* could this be better, we accept some amount of race in getting the temp name*/
321 /* make sure the directory exists */
322 mkdir ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
323 chmod ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
324 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
326 sprintf (app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
329 app->app_bus_addr [0] = '\0';
335 /*---------------------------------------------------------------------------*/
338 deregister_application (SpiBridge * app)
340 DBusMessage *message;
341 DBusMessageIter iter;
345 dbus_error_init (&error);
347 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
348 SPI_DBUS_PATH_REGISTRY,
349 SPI_DBUS_INTERFACE_REGISTRY,
350 "DeregisterApplication");
351 dbus_message_set_no_reply (message, TRUE);
353 uname = dbus_bus_get_unique_name (app->bus);
355 dbus_message_iter_init_append (message, &iter);
356 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
357 dbus_connection_send (app->bus, message, NULL);
359 dbus_message_unref (message);
362 /*---------------------------------------------------------------------------*/
367 if (!spi_global_app_data)
372 spi_atk_tidy_windows ();
373 spi_atk_deregister_event_listeners ();
374 deregister_application (spi_global_app_data);
376 g_free (spi_global_app_data);
377 spi_global_app_data = NULL;
379 /* Not currently creating an XDisplay */
382 XCloseDisplay (bridge_display);
386 /*---------------------------------------------------------------------------*/
388 static AtkPlugClass *plug_class;
389 static AtkSocketClass *socket_class;
392 get_plug_id (AtkPlug * plug)
394 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
396 GString *str = g_string_new (NULL);
398 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
399 g_string_printf (str, "%s:%s", uname, path);
401 return g_string_free (str, FALSE);
405 socket_ref_state_set (AtkObject *accessible)
407 char *child_name, *child_path;
408 AtkSocket *socket = ATK_SOCKET (accessible);
412 DBusMessage *message, *reply;
413 DBusMessageIter iter, iter_array;
416 if (!socket->embedded_plug_id)
419 child_name = g_strdup (socket->embedded_plug_id);
422 child_path = g_utf8_strchr (child_name + 1, -1, ':');
428 *(child_path++) = '\0';
429 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
431 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
432 dbus_message_unref (message);
435 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
437 dbus_message_unref (reply);
440 set = atk_state_set_new ();
443 dbus_message_iter_init (reply, &iter);
444 dbus_message_iter_recurse (&iter, &iter_array);
447 dbus_message_iter_get_basic (&iter_array, &v);
448 for (j = 0; j < 32; j++)
452 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
453 atk_state_set_add_state (set, state);
458 while (dbus_message_iter_next (&iter_array));
459 dbus_message_unref (reply);
464 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
466 AtkObject *accessible = ATK_OBJECT(socket);
467 gchar *plug_name, *plug_path;
468 AtkObjectClass *klass;
470 /* Force registration */
471 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
472 /* Let the plug know that it has been embedded */
473 plug_name = g_strdup (plug_id);
479 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
482 DBusMessage *message;
483 *(plug_path++) = '\0';
484 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
485 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
486 dbus_connection_send (spi_global_app_data->bus, message, NULL);
491 klass = ATK_OBJECT_GET_CLASS (accessible);
492 klass->ref_state_set = socket_ref_state_set;
496 install_plug_hooks ()
500 data = g_type_class_ref (ATK_TYPE_PLUG);
501 plug_class = ATK_PLUG_CLASS (data);
502 data = g_type_class_ref (ATK_TYPE_SOCKET);
503 socket_class = ATK_SOCKET_CLASS (data);
504 plug_class->get_object_id = get_plug_id;
505 socket_class->embed = socket_embed_hook;
509 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
513 dbus_connection_ref(con);
514 dbus_connection_setup_with_g_main(con, NULL);
515 droute_intercept_dbus (con);
516 droute_context_register (spi_global_app_data->droute, con);
518 new_list = g_list_append (spi_global_app_data->direct_connections, con);
520 spi_global_app_data->direct_connections = new_list;
530 dbus_error_init(&err);
531 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
534 g_warning (_("atk-bridge: Couldn't listen on dbus server: %s"), err.message);
535 dbus_error_init (&err);
536 spi_global_app_data->app_bus_addr [0] = '\0';
537 g_main_context_unref (spi_global_app_data->main_context);
538 spi_global_app_data->main_context = NULL;
542 dbus_server_setup_with_g_main(server, NULL);
543 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
545 spi_global_app_data->server = server;
552 gchar *atspi_dbus_name = NULL;
553 static gboolean atspi_no_register = FALSE;
555 static GOptionEntry atspi_option_entries[] = {
556 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
557 "D-Bus bus name to register as", NULL},
558 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
559 "Do not register with Registry Daemon", NULL},
564 introspect_children_cb (const char *path, void *data)
566 if (!strcmp (path, "/org/a11y/atspi/accessible"))
568 return g_strdup ("<node name=\"root\"/>\n");
569 /* TODO: Should we place the whole hierarchy here? */
575 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
581 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
582 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
585 add_event (sender, name);
589 remove_events (const char *bus_name, const char *event)
595 remove_data = g_strsplit (event, ":", 3);
601 for (list = spi_global_app_data->events; list;)
603 event_data *evdata = list->data;
604 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
605 spi_event_is_subtype (evdata->data, remove_data))
607 GList *events = spi_global_app_data->events;
609 g_strfreev (evdata->data);
610 g_free (evdata->bus_name);
612 spi_global_app_data->events = g_list_remove (events, evdata);
622 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
625 const char *orig_name;
629 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
630 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
633 remove_events (sender, name);
636 static DBusHandlerResult
637 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
639 const char *interface = dbus_message_get_interface (message);
640 const char *member = dbus_message_get_member (message);
641 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
643 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
644 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
646 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
648 result = DBUS_HANDLER_RESULT_HANDLED;
649 if (!strcmp (member, "EventListenerRegistered"))
650 handle_event_listener_registered (bus, message, user_data);
651 else if (!strcmp (member, "EventListenerDeregistered"))
652 handle_event_listener_deregistered (bus, message, user_data);
654 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
662 * The following needs to be initialized.
664 * - DRoute for routing message to their accessible objects.
665 * - Event handlers for emmitting signals on specific ATK events.
666 * - setup the bus for p2p communication
667 * - Application registration with the AT-SPI registry.
671 adaptor_init (gint * argc, gchar ** argv[])
677 gchar *introspection_directory;
678 static gboolean inited = FALSE;
685 DRoutePath *treepath, *accpath;
687 root = atk_get_root ();
688 g_warn_if_fail (root);
695 /* Parse command line options */
696 opt = g_option_context_new (NULL);
697 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
698 g_option_context_set_ignore_unknown_options (opt, TRUE);
699 if (!g_option_context_parse (opt, argc, argv, &err))
700 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
702 /* Allocate global data and do ATK initializations */
703 spi_global_app_data = g_new0 (SpiBridge, 1);
704 atk_misc = atk_misc_get_instance ();
705 spi_global_app_data->root = g_object_ref (root);
707 /* Set up D-Bus connection and register bus name */
708 dbus_error_init (&error);
709 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
710 if (!spi_global_app_data->bus)
712 g_free (spi_global_app_data);
713 spi_global_app_data = NULL;
718 if (atspi_dbus_name != NULL)
720 if (dbus_bus_request_name
721 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
723 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
728 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
734 spi_global_app_data->main_context = g_main_context_new ();
736 spi_global_app_data->main_context = NULL;
739 dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
741 /* Hook our plug-and socket functions */
742 install_plug_hooks ();
745 * Create the leasing, register and cache objects.
746 * The order is important here, the cache depends on the
749 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
750 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
751 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
753 /* Register droute for routing AT-SPI messages */
754 spi_global_app_data->droute =
757 treepath = droute_add_one (spi_global_app_data->droute,
758 "/org/a11y/atspi/cache", spi_global_cache);
762 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
766 accpath = droute_add_many (spi_global_app_data->droute,
767 "/org/a11y/atspi/accessible",
769 introspect_children_cb,
771 (DRouteGetDatumFunction)
772 spi_global_register_path_to_object);
775 /* Register all interfaces with droute and set up application accessible db */
776 spi_initialize_cache (treepath);
777 spi_initialize_accessible (accpath);
778 spi_initialize_application (accpath);
779 spi_initialize_action (accpath);
780 spi_initialize_collection (accpath);
781 spi_initialize_component (accpath);
782 spi_initialize_document (accpath);
783 spi_initialize_editabletext (accpath);
784 spi_initialize_hyperlink (accpath);
785 spi_initialize_hypertext (accpath);
786 spi_initialize_image (accpath);
787 spi_initialize_selection (accpath);
788 spi_initialize_socket (accpath);
789 spi_initialize_table (accpath);
790 spi_initialize_text (accpath);
791 spi_initialize_value (accpath);
793 droute_context_register (spi_global_app_data->droute,
794 spi_global_app_data->bus);
796 /* Register methods to send D-Bus signals on certain ATK events */
797 spi_atk_register_event_listeners ();
799 /* Set up filter and match rules to catch signals */
800 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
801 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
804 /* Register this app by sending a signal out to AT-SPI registry daemon */
805 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
806 register_application (spi_global_app_data);
808 get_registered_event_listeners (spi_global_app_data);
815 /*---------------------------------------------------------------------------*/
818 gtk_module_init (gint * argc, gchar ** argv[])
820 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
822 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
824 return adaptor_init (argc, argv);
830 g_module_check_init (GModule *module)
832 g_module_make_resident (module);
838 gnome_accessibility_module_init (void)
840 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
842 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
844 adaptor_init (NULL, NULL);
846 if (g_getenv ("AT_SPI_DEBUG"))
848 g_print ("Atk Accessibility bridge initialized\n");
854 gnome_accessibility_module_shutdown (void)
856 spi_atk_deregister_event_listeners ();
860 /*END------------------------------------------------------------------------*/