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");
214 spi_global_app_data->events_initialized = TRUE;
218 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
219 dbus_message_unref (message);
222 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
224 /* TODO: Add a warning when it's okay to add strings */
225 dbus_message_unref (reply);
228 dbus_message_iter_init (reply, &iter);
229 dbus_message_iter_recurse (&iter, &iter_array);
230 /* TODO: This is bad. Need to determine that the array is non-empty,
231 so that we don't initially read a value rom it in that case, but using
232 a deprecated function. */
233 if (dbus_message_iter_get_array_len (&iter_array) > 0) do
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);
242 while (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);
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))
314 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
317 dbus_message_unref (message);
319 /* could this be better, we accept some amount of race in getting the temp name*/
320 /* make sure the directory exists */
321 mkdir("/tmp/at-spi2/", S_IRWXU);
322 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
324 sprintf(app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
331 /*---------------------------------------------------------------------------*/
334 deregister_application (SpiBridge * app)
336 DBusMessage *message;
337 DBusMessageIter iter;
341 dbus_error_init (&error);
343 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
344 SPI_DBUS_PATH_REGISTRY,
345 SPI_DBUS_INTERFACE_REGISTRY,
346 "DeregisterApplication");
347 dbus_message_set_no_reply (message, TRUE);
349 uname = dbus_bus_get_unique_name (app->bus);
351 dbus_message_iter_init_append (message, &iter);
352 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
353 dbus_connection_send (app->bus, message, NULL);
355 dbus_message_unref (message);
358 /*---------------------------------------------------------------------------*/
363 if (!spi_global_app_data)
368 spi_atk_tidy_windows ();
369 spi_atk_deregister_event_listeners ();
370 deregister_application (spi_global_app_data);
372 g_free (spi_global_app_data);
373 spi_global_app_data = NULL;
375 /* Not currently creating an XDisplay */
378 XCloseDisplay (bridge_display);
382 /*---------------------------------------------------------------------------*/
384 static AtkPlugClass *plug_class;
385 static AtkSocketClass *socket_class;
388 get_plug_id (AtkPlug * plug)
390 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
392 GString *str = g_string_new (NULL);
394 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
395 g_string_printf (str, "%s:%s", uname, path);
397 return g_string_free (str, FALSE);
401 socket_ref_state_set (AtkObject *accessible)
403 char *child_name, *child_path;
404 AtkSocket *socket = ATK_SOCKET (accessible);
408 DBusMessage *message, *reply;
409 DBusMessageIter iter, iter_array;
412 if (!socket->embedded_plug_id)
415 child_name = g_strdup (socket->embedded_plug_id);
418 child_path = g_utf8_strchr (child_name + 1, -1, ':');
424 *(child_path++) = '\0';
425 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
427 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
428 dbus_message_unref (message);
431 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
433 dbus_message_unref (reply);
436 set = atk_state_set_new ();
439 dbus_message_iter_init (reply, &iter);
440 dbus_message_iter_recurse (&iter, &iter_array);
443 dbus_message_iter_get_basic (&iter_array, &v);
444 for (j = 0; j < 32; j++)
448 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
449 atk_state_set_add_state (set, state);
454 while (dbus_message_iter_next (&iter_array));
455 dbus_message_unref (reply);
460 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
462 AtkObject *accessible = ATK_OBJECT(socket);
463 gchar *plug_name, *plug_path;
464 AtkObjectClass *klass;
466 /* Force registration */
467 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
468 /* Let the plug know that it has been embedded */
469 plug_name = g_strdup (plug_id);
475 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
478 DBusMessage *message;
479 *(plug_path++) = '\0';
480 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
481 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
482 dbus_connection_send (spi_global_app_data->bus, message, NULL);
487 klass = ATK_OBJECT_GET_CLASS (accessible);
488 klass->ref_state_set = socket_ref_state_set;
492 install_plug_hooks ()
496 data = g_type_class_ref (ATK_TYPE_PLUG);
497 plug_class = ATK_PLUG_CLASS (data);
498 data = g_type_class_ref (ATK_TYPE_SOCKET);
499 socket_class = ATK_SOCKET_CLASS (data);
500 plug_class->get_object_id = get_plug_id;
501 socket_class->embed = socket_embed_hook;
505 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
509 dbus_connection_ref(con);
510 dbus_connection_setup_with_g_main(con, NULL);
511 droute_intercept_dbus (con);
512 droute_context_register (spi_global_app_data->droute, con);
514 new_list = g_list_append (spi_global_app_data->direct_connections, con);
516 spi_global_app_data->direct_connections = new_list;
526 dbus_error_init(&err);
527 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
529 /* is there a better way to handle this */
533 dbus_server_setup_with_g_main(server, NULL);
534 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
536 spi_global_app_data->server = server;
543 gchar *atspi_dbus_name = NULL;
544 static gboolean atspi_no_register = FALSE;
546 static GOptionEntry atspi_option_entries[] = {
547 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
548 "D-Bus bus name to register as", NULL},
549 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
550 "Do not register with Registry Daemon", NULL},
555 introspect_children_cb (const char *path, void *data)
557 if (!strcmp (path, "/org/a11y/atspi/accessible"))
559 return g_strdup ("<node name=\"root\"/>\n");
560 /* TODO: Should we place the whole hierarchy here? */
566 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
572 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
573 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
576 add_event (sender, name);
580 remove_events (const char *bus_name, const char *event)
586 remove_data = g_strsplit (event, ":", 3);
592 for (list = spi_global_app_data->events; list;)
594 event_data *evdata = list->data;
595 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
596 spi_event_is_subtype (evdata->data, remove_data))
598 GList *events = spi_global_app_data->events;
600 g_strfreev (evdata->data);
601 g_free (evdata->bus_name);
603 spi_global_app_data->events = g_list_remove (events, evdata);
613 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
616 const char *orig_name;
620 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
621 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
624 remove_events (sender, name);
627 static DBusHandlerResult
628 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
630 const char *interface = dbus_message_get_interface (message);
631 const char *member = dbus_message_get_member (message);
632 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
634 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
635 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
637 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
639 result = DBUS_HANDLER_RESULT_HANDLED;
640 if (!strcmp (member, "EventListenerRegistered"))
641 handle_event_listener_registered (bus, message, user_data);
642 else if (!strcmp (member, "EventListenerDeregistered"))
643 handle_event_listener_deregistered (bus, message, user_data);
645 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
653 * The following needs to be initialized.
655 * - DRoute for routing message to their accessible objects.
656 * - Event handlers for emmitting signals on specific ATK events.
657 * - setup the bus for p2p communication
658 * - Application registration with the AT-SPI registry.
662 adaptor_init (gint * argc, gchar ** argv[])
668 gchar *introspection_directory;
669 static gboolean inited = FALSE;
676 DRoutePath *treepath, *accpath;
678 root = atk_get_root ();
679 g_warn_if_fail (root);
686 /* Parse command line options */
687 opt = g_option_context_new (NULL);
688 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
689 g_option_context_set_ignore_unknown_options (opt, TRUE);
690 if (!g_option_context_parse (opt, argc, argv, &err))
691 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
693 /* Allocate global data and do ATK initializations */
694 spi_global_app_data = g_new0 (SpiBridge, 1);
695 atk_misc = atk_misc_get_instance ();
696 spi_global_app_data->root = g_object_ref (root);
698 /* Set up D-Bus connection and register bus name */
699 dbus_error_init (&error);
700 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
701 if (!spi_global_app_data->bus)
703 g_free (spi_global_app_data);
704 spi_global_app_data = NULL;
709 if (atspi_dbus_name != NULL)
711 if (dbus_bus_request_name
712 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
714 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
719 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
725 spi_global_app_data->main_context = g_main_context_new ();
727 spi_global_app_data->main_context = NULL;
730 dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
732 /* Hook our plug-and socket functions */
733 install_plug_hooks ();
736 * Create the leasing, register and cache objects.
737 * The order is important here, the cache depends on the
740 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
741 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
742 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
744 /* Register droute for routing AT-SPI messages */
745 spi_global_app_data->droute =
748 treepath = droute_add_one (spi_global_app_data->droute,
749 "/org/a11y/atspi/cache", spi_global_cache);
753 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
757 accpath = droute_add_many (spi_global_app_data->droute,
758 "/org/a11y/atspi/accessible",
760 introspect_children_cb,
762 (DRouteGetDatumFunction)
763 spi_global_register_path_to_object);
766 /* Register all interfaces with droute and set up application accessible db */
767 spi_initialize_cache (treepath);
768 spi_initialize_accessible (accpath);
769 spi_initialize_application (accpath);
770 spi_initialize_action (accpath);
771 spi_initialize_collection (accpath);
772 spi_initialize_component (accpath);
773 spi_initialize_document (accpath);
774 spi_initialize_editabletext (accpath);
775 spi_initialize_hyperlink (accpath);
776 spi_initialize_hypertext (accpath);
777 spi_initialize_image (accpath);
778 spi_initialize_selection (accpath);
779 spi_initialize_socket (accpath);
780 spi_initialize_table (accpath);
781 spi_initialize_text (accpath);
782 spi_initialize_value (accpath);
784 droute_context_register (spi_global_app_data->droute,
785 spi_global_app_data->bus);
787 /* Register methods to send D-Bus signals on certain ATK events */
788 spi_atk_register_event_listeners ();
790 /* Set up filter and match rules to catch signals */
791 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
792 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
795 /* Register this app by sending a signal out to AT-SPI registry daemon */
796 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
797 register_application (spi_global_app_data);
799 get_registered_event_listeners (spi_global_app_data);
806 /*---------------------------------------------------------------------------*/
809 gtk_module_init (gint * argc, gchar ** argv[])
811 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
813 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
815 return adaptor_init (argc, argv);
821 g_module_check_init (GModule *module)
823 g_module_make_resident (module);
829 gnome_accessibility_module_init (void)
831 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
833 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
835 adaptor_init (NULL, NULL);
837 if (g_getenv ("AT_SPI_DEBUG"))
839 g_print ("Atk Accessibility bridge initialized\n");
845 gnome_accessibility_module_shutdown (void)
847 spi_atk_deregister_event_listeners ();
851 /*END------------------------------------------------------------------------*/