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);
139 dbus_error_init (&error);
144 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
145 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
148 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
154 bus = dbus_connection_open (data, &error);
158 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
163 if (!dbus_bus_register (bus, &error))
165 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
168 dbus_connection_set_exit_on_disconnect (bus, FALSE);
176 set_reply (DBusPendingCall *pending, void *user_data)
178 void **replyptr = (void **)user_data;
180 *replyptr = dbus_pending_call_steal_reply (pending);
181 dbus_pending_call_unref (pending);
184 /*---------------------------------------------------------------------------*/
187 add_event (const char *bus_name, const char *event)
193 evdata = (event_data *) g_malloc (sizeof (*evdata));
196 data = g_strsplit (event, ":", 3);
202 evdata->bus_name = g_strdup (bus_name);
204 new_list = g_list_append (spi_global_app_data->events, evdata);
206 spi_global_app_data->events = new_list;
210 get_registered_event_listeners (SpiBridge *app)
212 DBusMessage *message, *reply;
213 DBusMessageIter iter, iter_array, iter_struct;
215 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
216 SPI_DBUS_PATH_REGISTRY,
217 SPI_DBUS_INTERFACE_REGISTRY,
218 "GetRegisteredEvents");
219 spi_global_app_data->events_initialized = TRUE;
223 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
224 dbus_message_unref (message);
227 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
229 /* TODO: Add a warning when it's okay to add strings */
230 dbus_message_unref (reply);
233 dbus_message_iter_init (reply, &iter);
234 dbus_message_iter_recurse (&iter, &iter_array);
235 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
237 char *bus_name, *event;
238 dbus_message_iter_recurse (&iter_array, &iter_struct);
239 dbus_message_iter_get_basic (&iter_struct, &bus_name);
240 dbus_message_iter_next (&iter_struct);
241 dbus_message_iter_get_basic (&iter_struct, &event);
242 add_event (bus_name, event);
243 dbus_message_iter_next (&iter_array);
245 dbus_message_unref (reply);
249 register_reply (DBusPendingCall *pending, void *user_data)
252 SpiBridge *app = user_data;
253 DBusMessage *message;
255 reply = dbus_pending_call_steal_reply (pending);
256 dbus_pending_call_unref (pending);
259 gchar *app_name, *obj_path;
261 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
263 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
267 DBusMessageIter iter, iter_struct;
268 dbus_message_iter_init (reply, &iter);
269 dbus_message_iter_recurse (&iter, &iter_struct);
270 dbus_message_iter_get_basic (&iter_struct, &app_name);
271 dbus_message_iter_next (&iter_struct);
272 dbus_message_iter_get_basic (&iter_struct, &obj_path);
274 app->desktop_name = g_strdup (app_name);
275 app->desktop_path = g_strdup (obj_path);
280 g_warning ("AT-SPI: Could not embed inside desktop");
283 dbus_message_unref (reply);
285 get_registered_event_listeners (spi_global_app_data);
289 register_application (SpiBridge * app)
291 DBusMessage *message, *reply;
292 DBusMessageIter iter;
294 DBusPendingCall *pending;
295 const int max_addr_length = 128; /* should be long enough */
297 dbus_error_init (&error);
299 /* These will be overridden when we get a reply, but in practice these
300 defaults should always be correct */
301 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
302 app->desktop_path = SPI_DBUS_PATH_ROOT;
304 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
306 SPI_DBUS_INTERFACE_SOCKET,
309 dbus_message_iter_init_append (message, &iter);
310 spi_object_append_reference (&iter, app->root);
312 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1)
318 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
321 dbus_message_unref (message);
323 /* could this be better, we accept some amount of race in getting the temp name*/
324 /* make sure the directory exists */
325 mkdir ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
326 chmod ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
327 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
329 sprintf (app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
332 app->app_bus_addr [0] = '\0';
338 /*---------------------------------------------------------------------------*/
341 deregister_application (SpiBridge * app)
343 DBusMessage *message;
344 DBusMessageIter iter;
348 dbus_error_init (&error);
350 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
351 SPI_DBUS_PATH_REGISTRY,
352 SPI_DBUS_INTERFACE_REGISTRY,
353 "DeregisterApplication");
354 dbus_message_set_no_reply (message, TRUE);
356 uname = dbus_bus_get_unique_name (app->bus);
358 dbus_message_iter_init_append (message, &iter);
359 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
360 dbus_connection_send (app->bus, message, NULL);
362 dbus_message_unref (message);
365 /*---------------------------------------------------------------------------*/
370 if (!spi_global_app_data)
375 spi_atk_tidy_windows ();
376 spi_atk_deregister_event_listeners ();
377 deregister_application (spi_global_app_data);
379 g_free (spi_global_app_data);
380 spi_global_app_data = NULL;
382 /* Not currently creating an XDisplay */
385 XCloseDisplay (bridge_display);
389 /*---------------------------------------------------------------------------*/
391 static AtkPlugClass *plug_class;
392 static AtkSocketClass *socket_class;
395 get_plug_id (AtkPlug * plug)
397 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
399 GString *str = g_string_new (NULL);
401 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
402 g_string_printf (str, "%s:%s", uname, path);
404 return g_string_free (str, FALSE);
408 socket_ref_state_set (AtkObject *accessible)
410 char *child_name, *child_path;
411 AtkSocket *socket = ATK_SOCKET (accessible);
415 DBusMessage *message, *reply;
416 DBusMessageIter iter, iter_array;
419 if (!socket->embedded_plug_id)
422 child_name = g_strdup (socket->embedded_plug_id);
425 child_path = g_utf8_strchr (child_name + 1, -1, ':');
431 *(child_path++) = '\0';
432 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
434 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
435 dbus_message_unref (message);
438 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
440 dbus_message_unref (reply);
443 set = atk_state_set_new ();
446 dbus_message_iter_init (reply, &iter);
447 dbus_message_iter_recurse (&iter, &iter_array);
450 dbus_message_iter_get_basic (&iter_array, &v);
451 for (j = 0; j < 32; j++)
455 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
456 atk_state_set_add_state (set, state);
461 while (dbus_message_iter_next (&iter_array));
462 dbus_message_unref (reply);
467 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
469 AtkObject *accessible = ATK_OBJECT(socket);
470 gchar *plug_name, *plug_path;
471 AtkObjectClass *klass;
473 /* Force registration */
474 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
475 /* Let the plug know that it has been embedded */
476 plug_name = g_strdup (plug_id);
482 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
485 DBusMessage *message;
486 *(plug_path++) = '\0';
487 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
488 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
489 dbus_connection_send (spi_global_app_data->bus, message, NULL);
494 klass = ATK_OBJECT_GET_CLASS (accessible);
495 klass->ref_state_set = socket_ref_state_set;
499 install_plug_hooks ()
503 data = g_type_class_ref (ATK_TYPE_PLUG);
504 plug_class = ATK_PLUG_CLASS (data);
505 data = g_type_class_ref (ATK_TYPE_SOCKET);
506 socket_class = ATK_SOCKET_CLASS (data);
507 plug_class->get_object_id = get_plug_id;
508 socket_class->embed = socket_embed_hook;
512 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
516 dbus_connection_ref(con);
517 dbus_connection_setup_with_g_main(con, NULL);
518 droute_intercept_dbus (con);
519 droute_context_register (spi_global_app_data->droute, con);
521 new_list = g_list_append (spi_global_app_data->direct_connections, con);
523 spi_global_app_data->direct_connections = new_list;
533 dbus_error_init(&err);
534 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
537 g_warning (_("atk-bridge: Couldn't listen on dbus server: %s"), err.message);
538 dbus_error_init (&err);
539 spi_global_app_data->app_bus_addr [0] = '\0';
540 g_main_context_unref (spi_global_app_data->main_context);
541 spi_global_app_data->main_context = NULL;
545 dbus_server_setup_with_g_main(server, NULL);
546 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
548 spi_global_app_data->server = server;
555 gchar *atspi_dbus_name = NULL;
556 static gboolean atspi_no_register = FALSE;
558 static GOptionEntry atspi_option_entries[] = {
559 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
560 "D-Bus bus name to register as", NULL},
561 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
562 "Do not register with Registry Daemon", NULL},
567 introspect_children_cb (const char *path, void *data)
569 if (!strcmp (path, "/org/a11y/atspi/accessible"))
571 return g_strdup ("<node name=\"root\"/>\n");
572 /* TODO: Should we place the whole hierarchy here? */
578 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
584 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
585 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
588 add_event (sender, name);
592 remove_events (const char *bus_name, const char *event)
598 remove_data = g_strsplit (event, ":", 3);
604 for (list = spi_global_app_data->events; list;)
606 event_data *evdata = list->data;
607 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
608 spi_event_is_subtype (evdata->data, remove_data))
610 GList *events = spi_global_app_data->events;
612 g_strfreev (evdata->data);
613 g_free (evdata->bus_name);
615 spi_global_app_data->events = g_list_remove (events, evdata);
623 g_strfreev (remove_data);
627 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
630 const char *orig_name;
634 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
635 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
638 remove_events (sender, name);
641 static DBusHandlerResult
642 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
644 const char *interface = dbus_message_get_interface (message);
645 const char *member = dbus_message_get_member (message);
646 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
648 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
649 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
651 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
653 result = DBUS_HANDLER_RESULT_HANDLED;
654 if (!strcmp (member, "EventListenerRegistered"))
655 handle_event_listener_registered (bus, message, user_data);
656 else if (!strcmp (member, "EventListenerDeregistered"))
657 handle_event_listener_deregistered (bus, message, user_data);
659 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
667 * The following needs to be initialized.
669 * - DRoute for routing message to their accessible objects.
670 * - Event handlers for emmitting signals on specific ATK events.
671 * - setup the bus for p2p communication
672 * - Application registration with the AT-SPI registry.
676 adaptor_init (gint * argc, gchar ** argv[])
682 gchar *introspection_directory;
683 static gboolean inited = FALSE;
690 DRoutePath *treepath, *accpath;
692 root = atk_get_root ();
693 g_warn_if_fail (root);
700 /* Parse command line options */
701 opt = g_option_context_new (NULL);
702 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
703 g_option_context_set_ignore_unknown_options (opt, TRUE);
704 if (!g_option_context_parse (opt, argc, argv, &err))
705 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
706 g_option_context_free (opt);
708 /* Allocate global data and do ATK initializations */
709 spi_global_app_data = g_new0 (SpiBridge, 1);
710 atk_misc = atk_misc_get_instance ();
711 spi_global_app_data->root = g_object_ref (root);
713 /* Set up D-Bus connection and register bus name */
714 dbus_error_init (&error);
715 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
716 if (!spi_global_app_data->bus)
718 g_free (spi_global_app_data);
719 spi_global_app_data = NULL;
724 if (atspi_dbus_name != NULL)
726 if (dbus_bus_request_name
727 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
729 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
734 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
740 spi_global_app_data->main_context = g_main_context_new ();
742 spi_global_app_data->main_context = NULL;
745 dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
747 /* Hook our plug-and socket functions */
748 install_plug_hooks ();
751 * Create the leasing, register and cache objects.
752 * The order is important here, the cache depends on the
755 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
756 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
757 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
759 /* Register droute for routing AT-SPI messages */
760 spi_global_app_data->droute =
763 treepath = droute_add_one (spi_global_app_data->droute,
764 "/org/a11y/atspi/cache", spi_global_cache);
768 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
772 accpath = droute_add_many (spi_global_app_data->droute,
773 "/org/a11y/atspi/accessible",
775 introspect_children_cb,
777 (DRouteGetDatumFunction)
778 spi_global_register_path_to_object);
781 /* Register all interfaces with droute and set up application accessible db */
782 spi_initialize_cache (treepath);
783 spi_initialize_accessible (accpath);
784 spi_initialize_application (accpath);
785 spi_initialize_action (accpath);
786 spi_initialize_collection (accpath);
787 spi_initialize_component (accpath);
788 spi_initialize_document (accpath);
789 spi_initialize_editabletext (accpath);
790 spi_initialize_hyperlink (accpath);
791 spi_initialize_hypertext (accpath);
792 spi_initialize_image (accpath);
793 spi_initialize_selection (accpath);
794 spi_initialize_socket (accpath);
795 spi_initialize_table (accpath);
796 spi_initialize_text (accpath);
797 spi_initialize_value (accpath);
799 droute_context_register (spi_global_app_data->droute,
800 spi_global_app_data->bus);
802 /* Register methods to send D-Bus signals on certain ATK events */
803 spi_atk_register_event_listeners ();
805 /* Set up filter and match rules to catch signals */
806 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
807 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
810 /* Register this app by sending a signal out to AT-SPI registry daemon */
811 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
812 register_application (spi_global_app_data);
814 get_registered_event_listeners (spi_global_app_data);
821 /*---------------------------------------------------------------------------*/
824 gtk_module_init (gint * argc, gchar ** argv[])
826 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
828 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
830 return adaptor_init (argc, argv);
836 g_module_check_init (GModule *module)
838 g_module_make_resident (module);
844 gnome_accessibility_module_init (void)
846 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
848 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
850 adaptor_init (NULL, NULL);
852 if (g_getenv ("AT_SPI_DEBUG"))
854 g_print ("Atk Accessibility bridge initialized\n");
860 gnome_accessibility_module_shutdown (void)
862 spi_atk_deregister_event_listeners ();
866 /*END------------------------------------------------------------------------*/