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>
45 #include "accessible-register.h"
46 #include "accessible-leasing.h"
47 #include "accessible-cache.h"
49 #include "common/spi-dbus.h"
51 /*---------------------------------------------------------------------------*/
53 SpiBridge *spi_global_app_data = NULL;
55 static const AtkMisc *atk_misc = NULL;
57 /*static Display *bridge_display = NULL;*/
59 /*---------------------------------------------------------------------------*/
62 * Returns a 'canonicalized' value for DISPLAY,
63 * with the screen number stripped off if present.
67 spi_display_name (void)
69 static const char *canonical_display_name = NULL;
70 if (!canonical_display_name)
72 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
75 display_env = g_getenv ("DISPLAY");
76 if (!display_env || !display_env[0])
77 canonical_display_name = ":0";
80 gchar *display_p, *screen_p;
81 canonical_display_name = g_strdup (display_env);
82 display_p = strrchr (canonical_display_name, ':');
83 screen_p = strrchr (canonical_display_name, '.');
84 if (screen_p && display_p && (screen_p > display_p))
92 canonical_display_name = display_env;
95 return canonical_display_name;
98 /*---------------------------------------------------------------------------*/
101 * Gets the IOR from the XDisplay.
102 * Not currently used in D-Bus version, but something similar
103 * may be employed in the future for accessing the registry daemon
107 static DBusConnection *
108 spi_atk_bridge_get_bus (void)
112 Display *bridge_display;
114 unsigned char *data = NULL;
115 unsigned long nitems;
116 unsigned long leftover;
118 DBusConnection *bus = NULL;
121 bridge_display = XOpenDisplay (spi_display_name ());
124 g_warning ("AT_SPI: Could not get the display\n");
128 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
129 XGetWindowProperty (bridge_display,
130 XDefaultRootWindow (bridge_display),
132 (long) BUFSIZ, False,
133 (Atom) 31, &actual_type, &actual_format,
134 &nitems, &leftover, &data);
136 dbus_error_init (&error);
141 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
142 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
145 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
151 bus = dbus_connection_open (data, &error);
154 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
159 if (!dbus_bus_register (bus, &error))
161 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
171 set_reply (DBusPendingCall *pending, void *user_data)
173 void **replyptr = (void **)user_data;
175 *replyptr = dbus_pending_call_steal_reply (pending);
179 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, DBusError *error)
181 DBusPendingCall *pending;
182 DBusMessage *reply = NULL;
184 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
188 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
191 if (!dbus_connection_read_write_dispatch (bus, -1)) return NULL;
195 /*---------------------------------------------------------------------------*/
198 add_event (const char *bus_name, const char *event)
204 evdata = (event_data *) g_malloc (sizeof (*evdata));
207 data = g_strsplit (event, ":", 3);
213 evdata->bus_name = g_strdup (bus_name);
215 new_list = g_list_append (spi_global_app_data->events, evdata);
217 spi_global_app_data->events = new_list;
221 get_registered_event_listeners (SpiBridge *app)
223 DBusMessage *message, *reply;
224 DBusMessageIter iter, iter_array, iter_struct;
226 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
227 SPI_DBUS_PATH_REGISTRY,
228 SPI_DBUS_INTERFACE_REGISTRY,
229 "GetRegisteredEvents");
233 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
234 dbus_message_unref (message);
237 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
239 /* TODO: Add a warning when it's okay to add strings */
240 dbus_message_unref (reply);
243 dbus_message_iter_init (reply, &iter);
244 dbus_message_iter_recurse (&iter, &iter_array);
245 /* TODO: This is bad. Need to determine that the array is non-empty,
246 so that we don't initially read a value rom it in that case, but using
247 a deprecated function. */
248 if (dbus_message_iter_get_array_len (&iter_array) > 0) do
250 char *bus_name, *event;
251 dbus_message_iter_recurse (&iter_array, &iter_struct);
252 dbus_message_iter_get_basic (&iter_struct, &bus_name);
253 dbus_message_iter_next (&iter_struct);
254 dbus_message_iter_get_basic (&iter_struct, &event);
255 add_event (bus_name, event);
257 while (dbus_message_iter_next (&iter_array));
258 dbus_message_unref (reply);
262 register_reply (DBusPendingCall *pending, void *user_data)
265 SpiBridge *app = user_data;
266 DBusMessage *message;
268 reply = dbus_pending_call_steal_reply (pending);
271 gchar *app_name, *obj_path;
273 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
275 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
276 printf("sig: %s\n", dbus_message_get_signature(reply));
280 DBusMessageIter iter, iter_struct;
281 dbus_message_iter_init (reply, &iter);
282 dbus_message_iter_recurse (&iter, &iter_struct);
283 dbus_message_iter_get_basic (&iter_struct, &app_name);
284 dbus_message_iter_next (&iter_struct);
285 dbus_message_iter_get_basic (&iter_struct, &obj_path);
287 app->desktop_name = g_strdup (app_name);
288 app->desktop_path = g_strdup (obj_path);
293 g_warning ("AT-SPI: Could not embed inside desktop");
296 dbus_message_unref (reply);
298 get_registered_event_listeners (spi_global_app_data);
302 register_application (SpiBridge * app)
304 DBusMessage *message, *reply;
305 DBusMessageIter iter;
307 DBusPendingCall *pending;
309 dbus_error_init (&error);
311 /* These will be overridden when we get a reply, but in practice these
312 defaults should always be correct */
313 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
314 app->desktop_path = SPI_DBUS_PATH_ROOT;
316 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
318 SPI_DBUS_INTERFACE_SOCKET,
321 dbus_message_iter_init_append (message, &iter);
322 spi_object_append_reference (&iter, app->root);
324 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1))
329 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
332 dbus_message_unref (message);
334 /* could this be better, we accept some amount of race in getting the temp name*/
335 /* make sure the directory exists */
336 mkdir("/tmp/at-spi2/", S_IRWXU);
337 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
338 sprintf(app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
343 g_warning ("AT-SPI: Could not embed inside desktop: %s\n", error.message);
349 /*---------------------------------------------------------------------------*/
352 deregister_application (SpiBridge * app)
354 DBusMessage *message;
355 DBusMessageIter iter;
359 dbus_error_init (&error);
361 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
362 SPI_DBUS_PATH_REGISTRY,
363 SPI_DBUS_INTERFACE_REGISTRY,
364 "DeregisterApplication");
365 dbus_message_set_no_reply (message, TRUE);
367 uname = dbus_bus_get_unique_name (app->bus);
369 dbus_message_iter_init_append (message, &iter);
370 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
371 dbus_connection_send (app->bus, message, NULL);
373 dbus_message_unref (message);
376 /*---------------------------------------------------------------------------*/
381 if (!spi_global_app_data)
386 spi_atk_tidy_windows ();
387 spi_atk_deregister_event_listeners ();
388 deregister_application (spi_global_app_data);
390 g_free (spi_global_app_data);
391 spi_global_app_data = NULL;
393 /* Not currently creating an XDisplay */
396 XCloseDisplay (bridge_display);
400 /*---------------------------------------------------------------------------*/
402 static AtkPlugClass *plug_class;
403 static AtkSocketClass *socket_class;
406 get_plug_id (AtkPlug * plug)
408 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
410 GString *str = g_string_new (NULL);
412 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
413 g_string_printf (str, "%s:%s", uname, path);
415 return g_string_free (str, FALSE);
419 socket_ref_state_set (AtkObject *accessible)
421 char *child_name, *child_path;
422 AtkSocket *socket = ATK_SOCKET (accessible);
426 DBusMessage *message, *reply;
427 DBusMessageIter iter, iter_array;
430 if (!socket->embedded_plug_id)
433 child_name = g_strdup (socket->embedded_plug_id);
436 child_path = g_utf8_strchr (child_name + 1, -1, ':');
442 *(child_path++) = '\0';
443 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
445 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
446 dbus_message_unref (message);
449 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
451 dbus_message_unref (reply);
454 set = atk_state_set_new ();
457 dbus_message_iter_init (reply, &iter);
458 dbus_message_iter_recurse (&iter, &iter_array);
461 dbus_message_iter_get_basic (&iter_array, &v);
462 for (j = 0; j < 32; j++)
466 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
467 atk_state_set_add_state (set, state);
472 while (dbus_message_iter_next (&iter_array));
473 dbus_message_unref (reply);
478 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
480 AtkObject *accessible = ATK_OBJECT(socket);
481 gchar *plug_name, *plug_path;
482 AtkObjectClass *klass;
484 /* Force registration */
485 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
486 /* Let the plug know that it has been embedded */
487 plug_name = g_strdup (plug_id);
493 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
496 DBusMessage *message;
497 *(plug_path++) = '\0';
498 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
499 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
500 dbus_connection_send (spi_global_app_data->bus, message, NULL);
505 klass = ATK_OBJECT_GET_CLASS (accessible);
506 klass->ref_state_set = socket_ref_state_set;
510 install_plug_hooks ()
514 data = g_type_class_ref (ATK_TYPE_PLUG);
515 plug_class = ATK_PLUG_CLASS (data);
516 data = g_type_class_ref (ATK_TYPE_SOCKET);
517 socket_class = ATK_SOCKET_CLASS (data);
518 plug_class->get_object_id = get_plug_id;
519 socket_class->embed = socket_embed_hook;
523 new_connection_cb(DBusServer *server, DBusConnection *con, void *data)
525 dbus_connection_ref(con);
526 dbus_connection_setup_with_g_main(con, NULL);
529 static int setup_bus(void)
534 dbus_error_init(&err);
535 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
537 /* is there a better way to handle this */
538 if(server == NULL) return -1;
540 dbus_server_setup_with_g_main(server, NULL);
541 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
547 gchar *atspi_dbus_name = NULL;
548 static gboolean atspi_no_register = FALSE;
550 static GOptionEntry atspi_option_entries[] = {
551 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
552 "D-Bus bus name to register as", NULL},
553 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
554 "Do not register with Registry Daemon", NULL},
559 introspect_children_cb (const char *path, void *data)
561 if (!strcmp (path, "/org/a11y/atspi/accessible"))
563 return g_strdup ("<node name=\"root\"/>\n");
564 /* TODO: Should we place the whole hierarchy here? */
570 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
576 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
577 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
580 add_event (sender, name);
584 remove_events (const char *bus_name, const char *event)
590 remove_data = g_strsplit (event, ":", 3);
596 for (list = spi_global_app_data->events; list;)
598 event_data *evdata = list->data;
599 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
600 spi_event_is_subtype (evdata->data, remove_data))
602 GList *events = spi_global_app_data->events;
604 g_strfreev (evdata->data);
605 g_free (evdata->bus_name);
607 spi_global_app_data->events = g_list_remove (events, evdata);
617 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
620 const char *orig_name;
624 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
625 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
628 remove_events (sender, name);
631 static DBusHandlerResult
632 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
634 const char *interface = dbus_message_get_interface (message);
635 const char *member = dbus_message_get_member (message);
636 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
638 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
639 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
641 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
643 result = DBUS_HANDLER_RESULT_HANDLED;
644 if (!strcmp (member, "EventListenerRegistered"))
645 handle_event_listener_registered (bus, message, user_data);
646 else if (!strcmp (member, "EventListenerDeregistered"))
647 handle_event_listener_deregistered (bus, message, user_data);
649 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
657 * The following needs to be initialized.
659 * - DRoute for routing message to their accessible objects.
660 * - Event handlers for emmitting signals on specific ATK events.
661 * - setup the bus for p2p communication
662 * - Application registration with the AT-SPI registry.
666 adaptor_init (gint * argc, gchar ** argv[])
672 gchar *introspection_directory;
673 static gboolean inited = FALSE;
680 DRoutePath *treepath, *accpath;
682 root = atk_get_root ();
683 g_warn_if_fail (root);
690 /* Parse command line options */
691 opt = g_option_context_new (NULL);
692 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
693 g_option_context_set_ignore_unknown_options (opt, TRUE);
694 if (!g_option_context_parse (opt, argc, argv, &err))
695 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
697 /* Allocate global data and do ATK initializations */
698 spi_global_app_data = g_new0 (SpiBridge, 1);
699 atk_misc = atk_misc_get_instance ();
700 spi_global_app_data->root = g_object_ref (root);
702 /* Set up D-Bus connection and register bus name */
703 dbus_error_init (&error);
704 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
705 if (!spi_global_app_data->bus)
707 g_free (spi_global_app_data);
708 spi_global_app_data = NULL;
713 if (atspi_dbus_name != NULL)
715 if (dbus_bus_request_name
716 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
718 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
723 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
728 dbus_connection_setup_with_g_main (spi_global_app_data->bus,
729 g_main_context_default ());
731 /* Hook our plug-and socket functions */
732 install_plug_hooks ();
735 * Create the leasing, register and cache objects.
736 * The order is important here, the cache depends on the
739 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
740 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
741 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
743 /* Register droute for routing AT-SPI messages */
744 spi_global_app_data->droute =
745 droute_new (spi_global_app_data->bus);
747 treepath = droute_add_one (spi_global_app_data->droute,
748 "/org/a11y/atspi/cache", spi_global_cache);
752 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
756 accpath = droute_add_many (spi_global_app_data->droute,
757 "/org/a11y/atspi/accessible",
759 introspect_children_cb,
761 (DRouteGetDatumFunction)
762 spi_global_register_path_to_object);
765 /* Register all interfaces with droute and set up application accessible db */
766 spi_initialize_cache (treepath);
767 spi_initialize_accessible (accpath);
768 spi_initialize_application (accpath);
769 spi_initialize_action (accpath);
770 spi_initialize_collection (accpath);
771 spi_initialize_component (accpath);
772 spi_initialize_document (accpath);
773 spi_initialize_editabletext (accpath);
774 spi_initialize_hyperlink (accpath);
775 spi_initialize_hypertext (accpath);
776 spi_initialize_image (accpath);
777 spi_initialize_selection (accpath);
778 spi_initialize_socket (accpath);
779 spi_initialize_table (accpath);
780 spi_initialize_text (accpath);
781 spi_initialize_value (accpath);
783 /* Register methods to send D-Bus signals on certain ATK events */
784 spi_atk_register_event_listeners ();
786 /* Set up filter and match rules to catch signals */
787 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
788 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
791 /* Register this app by sending a signal out to AT-SPI registry daemon */
792 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
793 register_application (spi_global_app_data);
795 get_registered_event_listeners (spi_global_app_data);
799 g_atexit (exit_func);
804 /*---------------------------------------------------------------------------*/
807 gtk_module_init (gint * argc, gchar ** argv[])
809 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
811 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
813 return adaptor_init (argc, argv);
819 gnome_accessibility_module_init (void)
821 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
823 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
825 adaptor_init (NULL, NULL);
827 if (g_getenv ("AT_SPI_DEBUG"))
829 g_print ("Atk Accessibility bridge initialized\n");
835 gnome_accessibility_module_shutdown (void)
837 spi_atk_deregister_event_listeners ();
841 /*END------------------------------------------------------------------------*/