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>
37 #include <droute/droute.h>
44 #include "accessible-register.h"
45 #include "accessible-leasing.h"
46 #include "accessible-cache.h"
48 #include "common/spi-dbus.h"
50 /*---------------------------------------------------------------------------*/
52 SpiBridge *spi_global_app_data = NULL;
54 static const AtkMisc *atk_misc = NULL;
56 /*static Display *bridge_display = NULL;*/
58 /*---------------------------------------------------------------------------*/
61 * Returns a 'canonicalized' value for DISPLAY,
62 * with the screen number stripped off if present.
66 spi_display_name (void)
68 static const char *canonical_display_name = NULL;
69 if (!canonical_display_name)
71 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
74 display_env = g_getenv ("DISPLAY");
75 if (!display_env || !display_env[0])
76 canonical_display_name = ":0";
79 gchar *display_p, *screen_p;
80 canonical_display_name = g_strdup (display_env);
81 display_p = strrchr (canonical_display_name, ':');
82 screen_p = strrchr (canonical_display_name, '.');
83 if (screen_p && display_p && (screen_p > display_p))
91 canonical_display_name = display_env;
94 return canonical_display_name;
97 /*---------------------------------------------------------------------------*/
100 * Gets the IOR from the XDisplay.
101 * Not currently used in D-Bus version, but something similar
102 * may be employed in the future for accessing the registry daemon
106 static DBusConnection *
107 spi_atk_bridge_get_bus (void)
111 Display *bridge_display;
113 unsigned char *data = NULL;
114 unsigned long nitems;
115 unsigned long leftover;
117 DBusConnection *bus = NULL;
120 bridge_display = XOpenDisplay (spi_display_name ());
123 g_warning ("AT_SPI: Could not get the display\n");
127 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
128 XGetWindowProperty (bridge_display,
129 XDefaultRootWindow (bridge_display),
131 (long) BUFSIZ, False,
132 (Atom) 31, &actual_type, &actual_format,
133 &nitems, &leftover, &data);
135 dbus_error_init (&error);
140 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
141 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
144 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
150 bus = dbus_connection_open (data, &error);
153 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
158 if (!dbus_bus_register (bus, &error))
160 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
170 set_reply (DBusPendingCall *pending, void *user_data)
172 void **replyptr = (void **)user_data;
174 *replyptr = dbus_pending_call_steal_reply (pending);
178 send_and_allow_reentry (DBusConnection *bus, DBusMessage *message, DBusError *error)
180 DBusPendingCall *pending;
181 DBusMessage *reply = NULL;
183 if (!dbus_connection_send_with_reply (bus, message, &pending, -1))
187 dbus_pending_call_set_notify (pending, set_reply, (void *)&reply, NULL);
190 if (!dbus_connection_read_write_dispatch (bus, -1)) return NULL;
194 /*---------------------------------------------------------------------------*/
197 add_event (const char *bus_name, const char *event)
203 evdata = (event_data *) g_malloc (sizeof (*evdata));
206 data = g_strsplit (event, ":", 3);
212 evdata->bus_name = g_strdup (bus_name);
214 new_list = g_list_append (spi_global_app_data->events, evdata);
216 spi_global_app_data->events = new_list;
220 get_registered_event_listeners (SpiBridge *app)
222 DBusMessage *message, *reply;
223 DBusMessageIter iter, iter_array, iter_struct;
225 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
226 SPI_DBUS_PATH_REGISTRY,
227 SPI_DBUS_INTERFACE_REGISTRY,
228 "GetRegisteredEvents");
232 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
233 dbus_message_unref (message);
236 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
238 /* TODO: Add a warning when it's okay to add strings */
239 dbus_message_unref (reply);
242 dbus_message_iter_init (reply, &iter);
243 dbus_message_iter_recurse (&iter, &iter_array);
244 /* TODO: This is bad. Need to determine that the array is non-empty,
245 so that we don't initially read a value rom it in that case, but using
246 a deprecated function. */
247 if (dbus_message_iter_get_array_len (&iter_array) > 0) do
249 char *bus_name, *event;
250 dbus_message_iter_recurse (&iter_array, &iter_struct);
251 dbus_message_iter_get_basic (&iter_struct, &bus_name);
252 dbus_message_iter_next (&iter_struct);
253 dbus_message_iter_get_basic (&iter_struct, &event);
254 add_event (bus_name, event);
256 while (dbus_message_iter_next (&iter_array));
257 dbus_message_unref (reply);
261 register_reply (DBusPendingCall *pending, void *user_data)
264 SpiBridge *app = user_data;
265 DBusMessage *message;
267 reply = dbus_pending_call_steal_reply (pending);
270 gchar *app_name, *obj_path;
272 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
274 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
275 printf("sig: %s\n", dbus_message_get_signature(reply));
279 DBusMessageIter iter, iter_struct;
280 dbus_message_iter_init (reply, &iter);
281 dbus_message_iter_recurse (&iter, &iter_struct);
282 dbus_message_iter_get_basic (&iter_struct, &app_name);
283 dbus_message_iter_next (&iter_struct);
284 dbus_message_iter_get_basic (&iter_struct, &obj_path);
286 app->desktop_name = g_strdup (app_name);
287 app->desktop_path = g_strdup (obj_path);
292 g_warning ("AT-SPI: Could not embed inside desktop");
295 dbus_message_unref (reply);
297 get_registered_event_listeners (spi_global_app_data);
301 register_application (SpiBridge * app)
303 DBusMessage *message, *reply;
304 DBusMessageIter iter;
306 DBusPendingCall *pending;
308 dbus_error_init (&error);
310 /* These will be overridden when we get a reply, but in practice these
311 defaults should always be correct */
312 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
313 app->desktop_path = SPI_DBUS_PATH_ROOT;
315 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
317 SPI_DBUS_INTERFACE_SOCKET,
320 dbus_message_iter_init_append (message, &iter);
321 spi_object_append_reference (&iter, app->root);
323 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1))
328 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
331 dbus_message_unref (message);
333 /* could this be better, we accept some amount of race in getting the temp name*/
334 /* make sure the directory exists */
335 mkdir("/tmp/at-spi2/", 0);
336 app->app_bus_addr = mktemp(file_template);
340 g_warning ("AT-SPI: Could not embed inside desktop: %s\n", error.message);
346 /*---------------------------------------------------------------------------*/
349 deregister_application (SpiBridge * app)
351 DBusMessage *message;
352 DBusMessageIter iter;
356 dbus_error_init (&error);
358 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
359 SPI_DBUS_PATH_REGISTRY,
360 SPI_DBUS_INTERFACE_REGISTRY,
361 "DeregisterApplication");
362 dbus_message_set_no_reply (message, TRUE);
364 uname = dbus_bus_get_unique_name (app->bus);
366 dbus_message_iter_init_append (message, &iter);
367 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
368 dbus_connection_send (app->bus, message, NULL);
370 dbus_message_unref (message);
373 /*---------------------------------------------------------------------------*/
378 if (!spi_global_app_data)
383 spi_atk_tidy_windows ();
384 spi_atk_deregister_event_listeners ();
385 deregister_application (spi_global_app_data);
387 g_free (spi_global_app_data);
388 spi_global_app_data = NULL;
390 /* Not currently creating an XDisplay */
393 XCloseDisplay (bridge_display);
397 /*---------------------------------------------------------------------------*/
399 static AtkPlugClass *plug_class;
400 static AtkSocketClass *socket_class;
403 get_plug_id (AtkPlug * plug)
405 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
407 GString *str = g_string_new (NULL);
409 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
410 g_string_printf (str, "%s:%s", uname, path);
412 return g_string_free (str, FALSE);
416 socket_ref_state_set (AtkObject *accessible)
418 char *child_name, *child_path;
419 AtkSocket *socket = ATK_SOCKET (accessible);
423 DBusMessage *message, *reply;
424 DBusMessageIter iter, iter_array;
427 if (!socket->embedded_plug_id)
430 child_name = g_strdup (socket->embedded_plug_id);
433 child_path = g_utf8_strchr (child_name + 1, -1, ':');
439 *(child_path++) = '\0';
440 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
442 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
443 dbus_message_unref (message);
446 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
448 dbus_message_unref (reply);
451 set = atk_state_set_new ();
454 dbus_message_iter_init (reply, &iter);
455 dbus_message_iter_recurse (&iter, &iter_array);
458 dbus_message_iter_get_basic (&iter_array, &v);
459 for (j = 0; j < 32; j++)
463 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
464 atk_state_set_add_state (set, state);
469 while (dbus_message_iter_next (&iter_array));
470 dbus_message_unref (reply);
475 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
477 AtkObject *accessible = ATK_OBJECT(socket);
478 gchar *plug_name, *plug_path;
479 AtkObjectClass *klass;
481 /* Force registration */
482 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
483 /* Let the plug know that it has been embedded */
484 plug_name = g_strdup (plug_id);
490 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
493 DBusMessage *message;
494 *(plug_path++) = '\0';
495 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
496 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
497 dbus_connection_send (spi_global_app_data->bus, message, NULL);
502 klass = ATK_OBJECT_GET_CLASS (accessible);
503 klass->ref_state_set = socket_ref_state_set;
507 install_plug_hooks ()
511 data = g_type_class_ref (ATK_TYPE_PLUG);
512 plug_class = ATK_PLUG_CLASS (data);
513 data = g_type_class_ref (ATK_TYPE_SOCKET);
514 socket_class = ATK_SOCKET_CLASS (data);
515 plug_class->get_object_id = get_plug_id;
516 socket_class->embed = socket_embed_hook;
520 new_connection_cb(DBusServer *server, DBusConnection *con, void *data)
522 dbus_connection_ref(con);
523 dbus_connection_setup_with_g_main(con, NULL);
526 static int setup_bus(void)
531 dbus_error_init(&err);
532 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
534 /* is there a better way to handle this */
535 if(server == NULL) return -1;
537 dbus_server_setup_with_g_main(server, NULL);
538 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
544 gchar *atspi_dbus_name = NULL;
545 static gboolean atspi_no_register = FALSE;
547 static GOptionEntry atspi_option_entries[] = {
548 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
549 "D-Bus bus name to register as", NULL},
550 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
551 "Do not register with Registry Daemon", NULL},
556 introspect_children_cb (const char *path, void *data)
558 if (!strcmp (path, "/org/a11y/atspi/accessible"))
560 return g_strdup ("<node name=\"root\"/>\n");
561 /* TODO: Should we place the whole hierarchy here? */
567 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
573 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
574 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
577 add_event (sender, name);
581 remove_events (const char *bus_name, const char *event)
587 remove_data = g_strsplit (event, ":", 3);
593 for (list = spi_global_app_data->events; list;)
595 event_data *evdata = list->data;
596 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
597 spi_event_is_subtype (evdata->data, remove_data))
599 GList *events = spi_global_app_data->events;
601 g_strfreev (evdata->data);
602 g_free (evdata->bus_name);
604 spi_global_app_data->events = g_list_remove (events, evdata);
614 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
617 const char *orig_name;
621 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
622 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
625 remove_events (sender, name);
628 static DBusHandlerResult
629 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
631 const char *interface = dbus_message_get_interface (message);
632 const char *member = dbus_message_get_member (message);
633 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
635 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
636 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
638 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
640 result = DBUS_HANDLER_RESULT_HANDLED;
641 if (!strcmp (member, "EventListenerRegistered"))
642 handle_event_listener_registered (bus, message, user_data);
643 else if (!strcmp (member, "EventListenerDeregistered"))
644 handle_event_listener_deregistered (bus, message, user_data);
646 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
654 * The following needs to be initialized.
656 * - DRoute for routing message to their accessible objects.
657 * - Event handlers for emmitting signals on specific ATK events.
658 * - setup the bus for p2p communication
659 * - Application registration with the AT-SPI registry.
663 adaptor_init (gint * argc, gchar ** argv[])
669 gchar *introspection_directory;
670 static gboolean inited = FALSE;
677 DRoutePath *treepath, *accpath;
679 root = atk_get_root ();
680 g_warn_if_fail (root);
687 /* Parse command line options */
688 opt = g_option_context_new (NULL);
689 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
690 g_option_context_set_ignore_unknown_options (opt, TRUE);
691 if (!g_option_context_parse (opt, argc, argv, &err))
692 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
694 /* Allocate global data and do ATK initializations */
695 spi_global_app_data = g_new0 (SpiBridge, 1);
696 atk_misc = atk_misc_get_instance ();
697 spi_global_app_data->root = g_object_ref (root);
699 /* Set up D-Bus connection and register bus name */
700 dbus_error_init (&error);
701 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
702 if (!spi_global_app_data->bus)
704 g_free (spi_global_app_data);
705 spi_global_app_data = NULL;
710 if (atspi_dbus_name != NULL)
712 if (dbus_bus_request_name
713 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
715 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
720 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
725 dbus_connection_setup_with_g_main (spi_global_app_data->bus,
726 g_main_context_default ());
728 /* Hook our plug-and socket functions */
729 install_plug_hooks ();
732 * Create the leasing, register and cache objects.
733 * The order is important here, the cache depends on the
736 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
737 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
738 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
740 /* Register droute for routing AT-SPI messages */
741 spi_global_app_data->droute =
742 droute_new (spi_global_app_data->bus);
744 treepath = droute_add_one (spi_global_app_data->droute,
745 "/org/a11y/atspi/cache", spi_global_cache);
749 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
753 accpath = droute_add_many (spi_global_app_data->droute,
754 "/org/a11y/atspi/accessible",
756 introspect_children_cb,
758 (DRouteGetDatumFunction)
759 spi_global_register_path_to_object);
762 /* Register all interfaces with droute and set up application accessible db */
763 spi_initialize_cache (treepath);
764 spi_initialize_accessible (accpath);
765 spi_initialize_application (accpath);
766 spi_initialize_action (accpath);
767 spi_initialize_collection (accpath);
768 spi_initialize_component (accpath);
769 spi_initialize_document (accpath);
770 spi_initialize_editabletext (accpath);
771 spi_initialize_hyperlink (accpath);
772 spi_initialize_hypertext (accpath);
773 spi_initialize_image (accpath);
774 spi_initialize_selection (accpath);
775 spi_initialize_socket (accpath);
776 spi_initialize_table (accpath);
777 spi_initialize_text (accpath);
778 spi_initialize_value (accpath);
780 /* Register methods to send D-Bus signals on certain ATK events */
781 spi_atk_register_event_listeners ();
783 /* Set up filter and match rules to catch signals */
784 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
785 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
788 /* Register this app by sending a signal out to AT-SPI registry daemon */
789 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
790 register_application (spi_global_app_data);
792 get_registered_event_listeners (spi_global_app_data);
796 g_atexit (exit_func);
801 /*---------------------------------------------------------------------------*/
804 gtk_module_init (gint * argc, gchar ** argv[])
806 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
808 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
810 return adaptor_init (argc, argv);
816 gnome_accessibility_module_init (void)
818 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
820 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
822 adaptor_init (NULL, NULL);
824 if (g_getenv ("AT_SPI_DEBUG"))
826 g_print ("Atk Accessibility bridge initialized\n");
832 gnome_accessibility_module_shutdown (void)
834 spi_atk_deregister_event_listeners ();
838 /*END------------------------------------------------------------------------*/