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);
157 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
162 if (!dbus_bus_register (bus, &error))
164 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
174 set_reply (DBusPendingCall *pending, void *user_data)
176 void **replyptr = (void **)user_data;
178 *replyptr = dbus_pending_call_steal_reply (pending);
179 dbus_pending_call_unref (pending);
182 /*---------------------------------------------------------------------------*/
185 add_event (const char *bus_name, const char *event)
191 evdata = (event_data *) g_malloc (sizeof (*evdata));
194 data = g_strsplit (event, ":", 3);
200 evdata->bus_name = g_strdup (bus_name);
202 new_list = g_list_append (spi_global_app_data->events, evdata);
204 spi_global_app_data->events = new_list;
208 get_registered_event_listeners (SpiBridge *app)
210 DBusMessage *message, *reply;
211 DBusMessageIter iter, iter_array, iter_struct;
213 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
214 SPI_DBUS_PATH_REGISTRY,
215 SPI_DBUS_INTERFACE_REGISTRY,
216 "GetRegisteredEvents");
217 spi_global_app_data->events_initialized = TRUE;
221 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
222 dbus_message_unref (message);
225 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
227 /* TODO: Add a warning when it's okay to add strings */
228 dbus_message_unref (reply);
231 dbus_message_iter_init (reply, &iter);
232 dbus_message_iter_recurse (&iter, &iter_array);
233 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
235 char *bus_name, *event;
236 dbus_message_iter_recurse (&iter_array, &iter_struct);
237 dbus_message_iter_get_basic (&iter_struct, &bus_name);
238 dbus_message_iter_next (&iter_struct);
239 dbus_message_iter_get_basic (&iter_struct, &event);
240 add_event (bus_name, event);
241 dbus_message_iter_next (&iter_array);
243 dbus_message_unref (reply);
247 register_reply (DBusPendingCall *pending, void *user_data)
250 SpiBridge *app = user_data;
251 DBusMessage *message;
253 reply = dbus_pending_call_steal_reply (pending);
254 dbus_pending_call_unref (pending);
257 gchar *app_name, *obj_path;
259 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
261 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
265 DBusMessageIter iter, iter_struct;
266 dbus_message_iter_init (reply, &iter);
267 dbus_message_iter_recurse (&iter, &iter_struct);
268 dbus_message_iter_get_basic (&iter_struct, &app_name);
269 dbus_message_iter_next (&iter_struct);
270 dbus_message_iter_get_basic (&iter_struct, &obj_path);
272 app->desktop_name = g_strdup (app_name);
273 app->desktop_path = g_strdup (obj_path);
278 g_warning ("AT-SPI: Could not embed inside desktop");
281 dbus_message_unref (reply);
283 get_registered_event_listeners (spi_global_app_data);
287 register_application (SpiBridge * app)
289 DBusMessage *message, *reply;
290 DBusMessageIter iter;
292 DBusPendingCall *pending;
293 const int max_addr_length = 128; /* should be long enough */
295 dbus_error_init (&error);
297 /* These will be overridden when we get a reply, but in practice these
298 defaults should always be correct */
299 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
300 app->desktop_path = SPI_DBUS_PATH_ROOT;
302 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
304 SPI_DBUS_INTERFACE_SOCKET,
307 dbus_message_iter_init_append (message, &iter);
308 spi_object_append_reference (&iter, app->root);
310 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1)
316 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
319 dbus_message_unref (message);
321 /* could this be better, we accept some amount of race in getting the temp name*/
322 /* make sure the directory exists */
323 mkdir ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
324 chmod ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
325 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
327 sprintf (app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
330 app->app_bus_addr [0] = '\0';
336 /*---------------------------------------------------------------------------*/
339 deregister_application (SpiBridge * app)
341 DBusMessage *message;
342 DBusMessageIter iter;
346 dbus_error_init (&error);
348 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
349 SPI_DBUS_PATH_REGISTRY,
350 SPI_DBUS_INTERFACE_REGISTRY,
351 "DeregisterApplication");
352 dbus_message_set_no_reply (message, TRUE);
354 uname = dbus_bus_get_unique_name (app->bus);
356 dbus_message_iter_init_append (message, &iter);
357 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
358 dbus_connection_send (app->bus, message, NULL);
360 dbus_message_unref (message);
363 /*---------------------------------------------------------------------------*/
368 if (!spi_global_app_data)
373 spi_atk_tidy_windows ();
374 spi_atk_deregister_event_listeners ();
375 deregister_application (spi_global_app_data);
377 g_free (spi_global_app_data);
378 spi_global_app_data = NULL;
380 /* Not currently creating an XDisplay */
383 XCloseDisplay (bridge_display);
387 /*---------------------------------------------------------------------------*/
389 static AtkPlugClass *plug_class;
390 static AtkSocketClass *socket_class;
393 get_plug_id (AtkPlug * plug)
395 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
397 GString *str = g_string_new (NULL);
399 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
400 g_string_printf (str, "%s:%s", uname, path);
402 return g_string_free (str, FALSE);
406 socket_ref_state_set (AtkObject *accessible)
408 char *child_name, *child_path;
409 AtkSocket *socket = ATK_SOCKET (accessible);
413 DBusMessage *message, *reply;
414 DBusMessageIter iter, iter_array;
417 if (!socket->embedded_plug_id)
420 child_name = g_strdup (socket->embedded_plug_id);
423 child_path = g_utf8_strchr (child_name + 1, -1, ':');
429 *(child_path++) = '\0';
430 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
432 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
433 dbus_message_unref (message);
436 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
438 dbus_message_unref (reply);
441 set = atk_state_set_new ();
444 dbus_message_iter_init (reply, &iter);
445 dbus_message_iter_recurse (&iter, &iter_array);
448 dbus_message_iter_get_basic (&iter_array, &v);
449 for (j = 0; j < 32; j++)
453 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
454 atk_state_set_add_state (set, state);
459 while (dbus_message_iter_next (&iter_array));
460 dbus_message_unref (reply);
465 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
467 AtkObject *accessible = ATK_OBJECT(socket);
468 gchar *plug_name, *plug_path;
469 AtkObjectClass *klass;
471 /* Force registration */
472 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
473 /* Let the plug know that it has been embedded */
474 plug_name = g_strdup (plug_id);
480 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
483 DBusMessage *message;
484 *(plug_path++) = '\0';
485 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
486 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
487 dbus_connection_send (spi_global_app_data->bus, message, NULL);
492 klass = ATK_OBJECT_GET_CLASS (accessible);
493 klass->ref_state_set = socket_ref_state_set;
497 install_plug_hooks ()
501 data = g_type_class_ref (ATK_TYPE_PLUG);
502 plug_class = ATK_PLUG_CLASS (data);
503 data = g_type_class_ref (ATK_TYPE_SOCKET);
504 socket_class = ATK_SOCKET_CLASS (data);
505 plug_class->get_object_id = get_plug_id;
506 socket_class->embed = socket_embed_hook;
510 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
514 dbus_connection_ref(con);
515 dbus_connection_setup_with_g_main(con, NULL);
516 droute_intercept_dbus (con);
517 droute_context_register (spi_global_app_data->droute, con);
519 new_list = g_list_append (spi_global_app_data->direct_connections, con);
521 spi_global_app_data->direct_connections = new_list;
531 dbus_error_init(&err);
532 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
535 g_warning (_("atk-bridge: Couldn't listen on dbus server: %s"), err.message);
536 dbus_error_init (&err);
537 spi_global_app_data->app_bus_addr [0] = '\0';
538 g_main_context_unref (spi_global_app_data->main_context);
539 spi_global_app_data->main_context = NULL;
543 dbus_server_setup_with_g_main(server, NULL);
544 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
546 spi_global_app_data->server = server;
553 gchar *atspi_dbus_name = NULL;
554 static gboolean atspi_no_register = FALSE;
556 static GOptionEntry atspi_option_entries[] = {
557 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
558 "D-Bus bus name to register as", NULL},
559 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
560 "Do not register with Registry Daemon", NULL},
565 introspect_children_cb (const char *path, void *data)
567 if (!strcmp (path, "/org/a11y/atspi/accessible"))
569 return g_strdup ("<node name=\"root\"/>\n");
570 /* TODO: Should we place the whole hierarchy here? */
576 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
582 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
583 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
586 add_event (sender, name);
590 remove_events (const char *bus_name, const char *event)
596 remove_data = g_strsplit (event, ":", 3);
602 for (list = spi_global_app_data->events; list;)
604 event_data *evdata = list->data;
605 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
606 spi_event_is_subtype (evdata->data, remove_data))
608 GList *events = spi_global_app_data->events;
610 g_strfreev (evdata->data);
611 g_free (evdata->bus_name);
613 spi_global_app_data->events = g_list_remove (events, evdata);
623 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
626 const char *orig_name;
630 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
631 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
634 remove_events (sender, name);
637 static DBusHandlerResult
638 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
640 const char *interface = dbus_message_get_interface (message);
641 const char *member = dbus_message_get_member (message);
642 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
644 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
645 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
647 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
649 result = DBUS_HANDLER_RESULT_HANDLED;
650 if (!strcmp (member, "EventListenerRegistered"))
651 handle_event_listener_registered (bus, message, user_data);
652 else if (!strcmp (member, "EventListenerDeregistered"))
653 handle_event_listener_deregistered (bus, message, user_data);
655 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
663 * The following needs to be initialized.
665 * - DRoute for routing message to their accessible objects.
666 * - Event handlers for emmitting signals on specific ATK events.
667 * - setup the bus for p2p communication
668 * - Application registration with the AT-SPI registry.
672 adaptor_init (gint * argc, gchar ** argv[])
678 gchar *introspection_directory;
679 static gboolean inited = FALSE;
686 DRoutePath *treepath, *accpath;
688 root = atk_get_root ();
689 g_warn_if_fail (root);
696 /* Parse command line options */
697 opt = g_option_context_new (NULL);
698 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
699 g_option_context_set_ignore_unknown_options (opt, TRUE);
700 if (!g_option_context_parse (opt, argc, argv, &err))
701 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
702 g_option_context_free (opt);
704 /* Allocate global data and do ATK initializations */
705 spi_global_app_data = g_new0 (SpiBridge, 1);
706 atk_misc = atk_misc_get_instance ();
707 spi_global_app_data->root = g_object_ref (root);
709 /* Set up D-Bus connection and register bus name */
710 dbus_error_init (&error);
711 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
712 if (!spi_global_app_data->bus)
714 g_free (spi_global_app_data);
715 spi_global_app_data = NULL;
720 if (atspi_dbus_name != NULL)
722 if (dbus_bus_request_name
723 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
725 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
730 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
736 spi_global_app_data->main_context = g_main_context_new ();
738 spi_global_app_data->main_context = NULL;
741 dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
743 /* Hook our plug-and socket functions */
744 install_plug_hooks ();
747 * Create the leasing, register and cache objects.
748 * The order is important here, the cache depends on the
751 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
752 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
753 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
755 /* Register droute for routing AT-SPI messages */
756 spi_global_app_data->droute =
759 treepath = droute_add_one (spi_global_app_data->droute,
760 "/org/a11y/atspi/cache", spi_global_cache);
764 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
768 accpath = droute_add_many (spi_global_app_data->droute,
769 "/org/a11y/atspi/accessible",
771 introspect_children_cb,
773 (DRouteGetDatumFunction)
774 spi_global_register_path_to_object);
777 /* Register all interfaces with droute and set up application accessible db */
778 spi_initialize_cache (treepath);
779 spi_initialize_accessible (accpath);
780 spi_initialize_application (accpath);
781 spi_initialize_action (accpath);
782 spi_initialize_collection (accpath);
783 spi_initialize_component (accpath);
784 spi_initialize_document (accpath);
785 spi_initialize_editabletext (accpath);
786 spi_initialize_hyperlink (accpath);
787 spi_initialize_hypertext (accpath);
788 spi_initialize_image (accpath);
789 spi_initialize_selection (accpath);
790 spi_initialize_socket (accpath);
791 spi_initialize_table (accpath);
792 spi_initialize_text (accpath);
793 spi_initialize_value (accpath);
795 droute_context_register (spi_global_app_data->droute,
796 spi_global_app_data->bus);
798 /* Register methods to send D-Bus signals on certain ATK events */
799 spi_atk_register_event_listeners ();
801 /* Set up filter and match rules to catch signals */
802 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
803 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
806 /* Register this app by sending a signal out to AT-SPI registry daemon */
807 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
808 register_application (spi_global_app_data);
810 get_registered_event_listeners (spi_global_app_data);
817 /*---------------------------------------------------------------------------*/
820 gtk_module_init (gint * argc, gchar ** argv[])
822 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
824 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
826 return adaptor_init (argc, argv);
832 g_module_check_init (GModule *module)
834 g_module_make_resident (module);
840 gnome_accessibility_module_init (void)
842 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
844 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
846 adaptor_init (NULL, NULL);
848 if (g_getenv ("AT_SPI_DEBUG"))
850 g_print ("Atk Accessibility bridge initialized\n");
856 gnome_accessibility_module_shutdown (void)
858 spi_atk_deregister_event_listeners ();
862 /*END------------------------------------------------------------------------*/