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>
46 #include "common/spi-stateset.h"
48 #include "accessible-register.h"
49 #include "accessible-leasing.h"
50 #include "accessible-cache.h"
52 #include "common/spi-dbus.h"
54 /*---------------------------------------------------------------------------*/
56 SpiBridge *spi_global_app_data = NULL;
58 static const AtkMisc *atk_misc = NULL;
60 /*static Display *bridge_display = NULL;*/
62 /*---------------------------------------------------------------------------*/
65 * Returns a 'canonicalized' value for DISPLAY,
66 * with the screen number stripped off if present.
70 spi_display_name (void)
72 static const char *canonical_display_name = NULL;
73 if (!canonical_display_name)
75 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
78 display_env = g_getenv ("DISPLAY");
79 if (!display_env || !display_env[0])
80 canonical_display_name = ":0";
83 gchar *display_p, *screen_p;
84 canonical_display_name = g_strdup (display_env);
85 display_p = strrchr (canonical_display_name, ':');
86 screen_p = strrchr (canonical_display_name, '.');
87 if (screen_p && display_p && (screen_p > display_p))
95 canonical_display_name = display_env;
98 return canonical_display_name;
101 /*---------------------------------------------------------------------------*/
104 * Gets the IOR from the XDisplay.
105 * Not currently used in D-Bus version, but something similar
106 * may be employed in the future for accessing the registry daemon
110 static DBusConnection *
111 spi_atk_bridge_get_bus (void)
115 Display *bridge_display;
117 unsigned char *data = NULL;
118 unsigned long nitems;
119 unsigned long leftover;
121 DBusConnection *bus = NULL;
124 bridge_display = XOpenDisplay (spi_display_name ());
127 g_warning ("AT_SPI: Could not get the display\n");
131 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
132 XGetWindowProperty (bridge_display,
133 XDefaultRootWindow (bridge_display),
135 (long) BUFSIZ, False,
136 (Atom) 31, &actual_type, &actual_format,
137 &nitems, &leftover, &data);
138 XCloseDisplay (bridge_display);
140 dbus_error_init (&error);
145 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
146 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
149 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
155 bus = dbus_connection_open (data, &error);
159 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
164 if (!dbus_bus_register (bus, &error))
166 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
169 dbus_connection_set_exit_on_disconnect (bus, FALSE);
177 set_reply (DBusPendingCall *pending, void *user_data)
179 void **replyptr = (void **)user_data;
181 *replyptr = dbus_pending_call_steal_reply (pending);
182 dbus_pending_call_unref (pending);
185 /*---------------------------------------------------------------------------*/
188 add_event (const char *bus_name, const char *event)
194 evdata = (event_data *) g_malloc (sizeof (*evdata));
197 data = g_strsplit (event, ":", 3);
203 evdata->bus_name = g_strdup (bus_name);
205 new_list = g_list_append (spi_global_app_data->events, evdata);
207 spi_global_app_data->events = new_list;
211 get_registered_event_listeners (SpiBridge *app)
213 DBusMessage *message, *reply;
214 DBusMessageIter iter, iter_array, iter_struct;
216 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
217 SPI_DBUS_PATH_REGISTRY,
218 SPI_DBUS_INTERFACE_REGISTRY,
219 "GetRegisteredEvents");
220 spi_global_app_data->events_initialized = TRUE;
224 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
225 dbus_message_unref (message);
228 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
230 /* TODO: Add a warning when it's okay to add strings */
231 dbus_message_unref (reply);
234 dbus_message_iter_init (reply, &iter);
235 dbus_message_iter_recurse (&iter, &iter_array);
236 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
238 char *bus_name, *event;
239 dbus_message_iter_recurse (&iter_array, &iter_struct);
240 dbus_message_iter_get_basic (&iter_struct, &bus_name);
241 dbus_message_iter_next (&iter_struct);
242 dbus_message_iter_get_basic (&iter_struct, &event);
243 add_event (bus_name, event);
244 dbus_message_iter_next (&iter_array);
246 dbus_message_unref (reply);
250 register_reply (DBusPendingCall *pending, void *user_data)
253 SpiBridge *app = user_data;
254 DBusMessage *message;
256 reply = dbus_pending_call_steal_reply (pending);
257 dbus_pending_call_unref (pending);
260 gchar *app_name, *obj_path;
262 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
264 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
268 DBusMessageIter iter, iter_struct;
269 dbus_message_iter_init (reply, &iter);
270 dbus_message_iter_recurse (&iter, &iter_struct);
271 dbus_message_iter_get_basic (&iter_struct, &app_name);
272 dbus_message_iter_next (&iter_struct);
273 dbus_message_iter_get_basic (&iter_struct, &obj_path);
275 app->desktop_name = g_strdup (app_name);
276 app->desktop_path = g_strdup (obj_path);
281 g_warning ("AT-SPI: Could not embed inside desktop");
284 dbus_message_unref (reply);
286 get_registered_event_listeners (spi_global_app_data);
290 register_application (SpiBridge * app)
292 DBusMessage *message, *reply;
293 DBusMessageIter iter;
295 DBusPendingCall *pending;
296 const int max_addr_length = 128; /* should be long enough */
298 dbus_error_init (&error);
300 /* These will be overridden when we get a reply, but in practice these
301 defaults should always be correct */
302 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
303 app->desktop_path = SPI_DBUS_PATH_ROOT;
305 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
307 SPI_DBUS_INTERFACE_SOCKET,
310 dbus_message_iter_init_append (message, &iter);
311 spi_object_append_reference (&iter, app->root);
313 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1)
319 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
322 dbus_message_unref (message);
324 /* could this be better, we accept some amount of race in getting the temp name*/
325 /* make sure the directory exists */
326 mkdir ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
327 chmod ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
328 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
330 sprintf (app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
333 app->app_bus_addr [0] = '\0';
339 /*---------------------------------------------------------------------------*/
342 deregister_application (SpiBridge * app)
344 DBusMessage *message;
345 DBusMessageIter iter;
349 dbus_error_init (&error);
351 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
352 SPI_DBUS_PATH_REGISTRY,
353 SPI_DBUS_INTERFACE_REGISTRY,
354 "DeregisterApplication");
355 dbus_message_set_no_reply (message, TRUE);
357 uname = dbus_bus_get_unique_name (app->bus);
359 dbus_message_iter_init_append (message, &iter);
360 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
361 dbus_connection_send (app->bus, message, NULL);
363 dbus_message_unref (message);
366 /*---------------------------------------------------------------------------*/
371 if (!spi_global_app_data)
376 spi_atk_tidy_windows ();
377 spi_atk_deregister_event_listeners ();
378 deregister_application (spi_global_app_data);
380 g_free (spi_global_app_data);
381 spi_global_app_data = NULL;
383 /* Not currently creating an XDisplay */
386 XCloseDisplay (bridge_display);
390 /*---------------------------------------------------------------------------*/
392 static AtkPlugClass *plug_class;
393 static AtkSocketClass *socket_class;
396 get_plug_id (AtkPlug * plug)
398 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
400 GString *str = g_string_new (NULL);
402 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
403 g_string_printf (str, "%s:%s", uname, path);
405 return g_string_free (str, FALSE);
409 socket_ref_state_set (AtkObject *accessible)
411 char *child_name, *child_path;
412 AtkSocket *socket = ATK_SOCKET (accessible);
416 DBusMessage *message, *reply;
417 DBusMessageIter iter, iter_array;
420 if (!socket->embedded_plug_id)
423 child_name = g_strdup (socket->embedded_plug_id);
426 child_path = g_utf8_strchr (child_name + 1, -1, ':');
432 *(child_path++) = '\0';
433 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
435 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
436 dbus_message_unref (message);
439 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
441 dbus_message_unref (reply);
444 set = atk_state_set_new ();
447 dbus_message_iter_init (reply, &iter);
448 dbus_message_iter_recurse (&iter, &iter_array);
451 dbus_message_iter_get_basic (&iter_array, &v);
452 for (j = 0; j < 32; j++)
456 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
457 atk_state_set_add_state (set, state);
462 while (dbus_message_iter_next (&iter_array));
463 dbus_message_unref (reply);
468 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
470 AtkObject *accessible = ATK_OBJECT(socket);
471 gchar *plug_name, *plug_path;
472 AtkObjectClass *klass;
474 /* Force registration */
475 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
476 /* Let the plug know that it has been embedded */
477 plug_name = g_strdup (plug_id);
483 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
486 DBusMessage *message;
487 *(plug_path++) = '\0';
488 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
489 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
490 dbus_connection_send (spi_global_app_data->bus, message, NULL);
495 klass = ATK_OBJECT_GET_CLASS (accessible);
496 klass->ref_state_set = socket_ref_state_set;
500 install_plug_hooks ()
504 data = g_type_class_ref (ATK_TYPE_PLUG);
505 plug_class = ATK_PLUG_CLASS (data);
506 data = g_type_class_ref (ATK_TYPE_SOCKET);
507 socket_class = ATK_SOCKET_CLASS (data);
508 plug_class->get_object_id = get_plug_id;
509 socket_class->embed = socket_embed_hook;
513 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
517 dbus_connection_ref(con);
518 dbus_connection_setup_with_g_main(con, NULL);
519 droute_intercept_dbus (con);
520 droute_context_register (spi_global_app_data->droute, con);
522 new_list = g_list_append (spi_global_app_data->direct_connections, con);
524 spi_global_app_data->direct_connections = new_list;
534 dbus_error_init(&err);
535 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
538 g_warning (_("atk-bridge: Couldn't listen on dbus server: %s"), err.message);
539 dbus_error_init (&err);
540 spi_global_app_data->app_bus_addr [0] = '\0';
541 g_main_context_unref (spi_global_app_data->main_context);
542 spi_global_app_data->main_context = NULL;
546 dbus_server_setup_with_g_main(server, NULL);
547 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
549 spi_global_app_data->server = server;
556 gchar *atspi_dbus_name = NULL;
557 static gboolean atspi_no_register = FALSE;
559 static GOptionEntry atspi_option_entries[] = {
560 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
561 "D-Bus bus name to register as", NULL},
562 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
563 "Do not register with Registry Daemon", NULL},
568 introspect_children_cb (const char *path, void *data)
570 if (!strcmp (path, "/org/a11y/atspi/accessible"))
572 return g_strdup ("<node name=\"root\"/>\n");
573 /* TODO: Should we place the whole hierarchy here? */
579 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
585 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
586 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
589 add_event (sender, name);
593 remove_events (const char *bus_name, const char *event)
599 remove_data = g_strsplit (event, ":", 3);
605 for (list = spi_global_app_data->events; list;)
607 event_data *evdata = list->data;
608 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
609 spi_event_is_subtype (evdata->data, remove_data))
611 GList *events = spi_global_app_data->events;
613 g_strfreev (evdata->data);
614 g_free (evdata->bus_name);
616 spi_global_app_data->events = g_list_remove (events, evdata);
624 g_strfreev (remove_data);
628 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
631 const char *orig_name;
635 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
636 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
639 remove_events (sender, name);
642 static DBusHandlerResult
643 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
645 const char *interface = dbus_message_get_interface (message);
646 const char *member = dbus_message_get_member (message);
647 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
649 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
650 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
652 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
654 result = DBUS_HANDLER_RESULT_HANDLED;
655 if (!strcmp (member, "EventListenerRegistered"))
656 handle_event_listener_registered (bus, message, user_data);
657 else if (!strcmp (member, "EventListenerDeregistered"))
658 handle_event_listener_deregistered (bus, message, user_data);
660 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
668 * The following needs to be initialized.
670 * - DRoute for routing message to their accessible objects.
671 * - Event handlers for emmitting signals on specific ATK events.
672 * - setup the bus for p2p communication
673 * - Application registration with the AT-SPI registry.
677 adaptor_init (gint * argc, gchar ** argv[])
683 gchar *introspection_directory;
684 static gboolean inited = FALSE;
691 DRoutePath *treepath, *accpath;
693 root = atk_get_root ();
694 g_warn_if_fail (root);
701 /* Parse command line options */
702 opt = g_option_context_new (NULL);
703 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
704 g_option_context_set_ignore_unknown_options (opt, TRUE);
705 if (!g_option_context_parse (opt, argc, argv, &err))
706 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
707 g_option_context_free (opt);
709 /* Allocate global data and do ATK initializations */
710 spi_global_app_data = g_new0 (SpiBridge, 1);
711 atk_misc = atk_misc_get_instance ();
712 spi_global_app_data->root = g_object_ref (root);
714 /* Set up D-Bus connection and register bus name */
715 dbus_error_init (&error);
716 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
717 if (!spi_global_app_data->bus)
719 g_free (spi_global_app_data);
720 spi_global_app_data = NULL;
725 if (atspi_dbus_name != NULL)
727 if (dbus_bus_request_name
728 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
730 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
735 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
741 spi_global_app_data->main_context = g_main_context_new ();
743 spi_global_app_data->main_context = NULL;
746 dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
748 /* Hook our plug-and socket functions */
749 install_plug_hooks ();
752 * Create the leasing, register and cache objects.
753 * The order is important here, the cache depends on the
756 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
757 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
758 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
760 /* Register droute for routing AT-SPI messages */
761 spi_global_app_data->droute =
764 treepath = droute_add_one (spi_global_app_data->droute,
765 "/org/a11y/atspi/cache", spi_global_cache);
769 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
773 accpath = droute_add_many (spi_global_app_data->droute,
774 "/org/a11y/atspi/accessible",
776 introspect_children_cb,
778 (DRouteGetDatumFunction)
779 spi_global_register_path_to_object);
782 /* Register all interfaces with droute and set up application accessible db */
783 spi_initialize_cache (treepath);
784 spi_initialize_accessible (accpath);
785 spi_initialize_application (accpath);
786 spi_initialize_action (accpath);
787 spi_initialize_collection (accpath);
788 spi_initialize_component (accpath);
789 spi_initialize_document (accpath);
790 spi_initialize_editabletext (accpath);
791 spi_initialize_hyperlink (accpath);
792 spi_initialize_hypertext (accpath);
793 spi_initialize_image (accpath);
794 spi_initialize_selection (accpath);
795 spi_initialize_socket (accpath);
796 spi_initialize_table (accpath);
797 spi_initialize_text (accpath);
798 spi_initialize_value (accpath);
800 droute_context_register (spi_global_app_data->droute,
801 spi_global_app_data->bus);
803 /* Register methods to send D-Bus signals on certain ATK events */
804 spi_atk_register_event_listeners ();
806 /* Set up filter and match rules to catch signals */
807 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
808 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
811 /* Register this app by sending a signal out to AT-SPI registry daemon */
812 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
813 register_application (spi_global_app_data);
815 get_registered_event_listeners (spi_global_app_data);
822 /*---------------------------------------------------------------------------*/
825 gtk_module_init (gint * argc, gchar ** argv[])
827 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
829 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
831 return adaptor_init (argc, argv);
837 g_module_check_init (GModule *module)
839 g_module_make_resident (module);
845 gnome_accessibility_module_init (void)
847 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
849 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
851 adaptor_init (NULL, NULL);
853 if (g_getenv ("AT_SPI_DEBUG"))
855 g_print ("Atk Accessibility bridge initialized\n");
861 gnome_accessibility_module_shutdown (void)
863 spi_atk_deregister_event_listeners ();
867 /*END------------------------------------------------------------------------*/