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.
27 #include "dbus/dbus-glib-lowlevel.h"
30 #include <X11/Xatom.h>
39 #include <droute/droute.h>
41 #include <glib/gi18n.h>
47 #include "common/spi-stateset.h"
49 #include "accessible-register.h"
50 #include "accessible-leasing.h"
51 #include "accessible-cache.h"
53 #include "common/spi-dbus.h"
55 /*---------------------------------------------------------------------------*/
57 SpiBridge *spi_global_app_data = NULL;
59 static const AtkMisc *atk_misc = NULL;
61 /*static Display *bridge_display = NULL;*/
63 /*---------------------------------------------------------------------------*/
66 * Returns a 'canonicalized' value for DISPLAY,
67 * with the screen number stripped off if present.
71 spi_display_name (void)
73 static const char *canonical_display_name = NULL;
74 if (!canonical_display_name)
76 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
79 display_env = g_getenv ("DISPLAY");
80 if (!display_env || !display_env[0])
81 canonical_display_name = ":0";
84 gchar *display_p, *screen_p;
85 canonical_display_name = g_strdup (display_env);
86 display_p = strrchr (canonical_display_name, ':');
87 screen_p = strrchr (canonical_display_name, '.');
88 if (screen_p && display_p && (screen_p > display_p))
96 canonical_display_name = display_env;
99 return canonical_display_name;
102 /*---------------------------------------------------------------------------*/
105 * Gets the IOR from the XDisplay.
106 * Not currently used in D-Bus version, but something similar
107 * may be employed in the future for accessing the registry daemon
111 static DBusConnection *
112 spi_atk_bridge_get_bus (void)
116 Display *bridge_display;
118 unsigned char *data = NULL;
119 unsigned long nitems;
120 unsigned long leftover;
122 DBusConnection *bus = NULL;
125 bridge_display = XOpenDisplay (spi_display_name ());
128 g_warning ("AT_SPI: Could not get the display\n");
132 AT_SPI_BUS = XInternAtom (bridge_display, "AT_SPI_BUS", False);
133 XGetWindowProperty (bridge_display,
134 XDefaultRootWindow (bridge_display),
136 (long) BUFSIZ, False,
137 (Atom) 31, &actual_type, &actual_format,
138 &nitems, &leftover, &data);
139 XCloseDisplay (bridge_display);
141 dbus_error_init (&error);
146 ("AT-SPI: Accessibility bus not found - Using session bus.\n");
147 bus = dbus_bus_get (DBUS_BUS_SESSION, &error);
150 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
156 bus = dbus_connection_open (data, &error);
160 g_warning ("AT-SPI: Couldn't connect to bus: %s\n", error.message);
165 if (!dbus_bus_register (bus, &error))
167 g_warning ("AT-SPI: Couldn't register with bus: %s\n", error.message);
170 dbus_connection_set_exit_on_disconnect (bus, FALSE);
178 set_reply (DBusPendingCall *pending, void *user_data)
180 void **replyptr = (void **)user_data;
182 *replyptr = dbus_pending_call_steal_reply (pending);
183 dbus_pending_call_unref (pending);
186 /*---------------------------------------------------------------------------*/
189 add_event (const char *bus_name, const char *event)
195 evdata = (event_data *) g_malloc (sizeof (*evdata));
198 data = g_strsplit (event, ":", 3);
204 evdata->bus_name = g_strdup (bus_name);
206 new_list = g_list_append (spi_global_app_data->events, evdata);
208 spi_global_app_data->events = new_list;
212 get_registered_event_listeners (SpiBridge *app)
214 DBusMessage *message, *reply;
215 DBusMessageIter iter, iter_array, iter_struct;
217 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
218 SPI_DBUS_PATH_REGISTRY,
219 SPI_DBUS_INTERFACE_REGISTRY,
220 "GetRegisteredEvents");
221 spi_global_app_data->events_initialized = TRUE;
225 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
226 dbus_message_unref (message);
229 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
231 /* TODO: Add a warning when it's okay to add strings */
232 dbus_message_unref (reply);
235 dbus_message_iter_init (reply, &iter);
236 dbus_message_iter_recurse (&iter, &iter_array);
237 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
239 char *bus_name, *event;
240 dbus_message_iter_recurse (&iter_array, &iter_struct);
241 dbus_message_iter_get_basic (&iter_struct, &bus_name);
242 dbus_message_iter_next (&iter_struct);
243 dbus_message_iter_get_basic (&iter_struct, &event);
244 add_event (bus_name, event);
245 dbus_message_iter_next (&iter_array);
247 dbus_message_unref (reply);
251 register_reply (DBusPendingCall *pending, void *user_data)
254 SpiBridge *app = user_data;
255 DBusMessage *message;
257 reply = dbus_pending_call_steal_reply (pending);
258 dbus_pending_call_unref (pending);
261 gchar *app_name, *obj_path;
263 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
265 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
269 DBusMessageIter iter, iter_struct;
270 dbus_message_iter_init (reply, &iter);
271 dbus_message_iter_recurse (&iter, &iter_struct);
272 dbus_message_iter_get_basic (&iter_struct, &app_name);
273 dbus_message_iter_next (&iter_struct);
274 dbus_message_iter_get_basic (&iter_struct, &obj_path);
276 app->desktop_name = g_strdup (app_name);
277 app->desktop_path = g_strdup (obj_path);
282 g_warning ("AT-SPI: Could not embed inside desktop");
285 dbus_message_unref (reply);
287 get_registered_event_listeners (spi_global_app_data);
291 register_application (SpiBridge * app)
293 DBusMessage *message, *reply;
294 DBusMessageIter iter;
296 DBusPendingCall *pending;
297 const int max_addr_length = 128; /* should be long enough */
299 dbus_error_init (&error);
301 /* These will be overridden when we get a reply, but in practice these
302 defaults should always be correct */
303 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
304 app->desktop_path = SPI_DBUS_PATH_ROOT;
306 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
308 SPI_DBUS_INTERFACE_SOCKET,
311 dbus_message_iter_init_append (message, &iter);
312 spi_object_append_reference (&iter, app->root);
314 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1)
320 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
323 dbus_message_unref (message);
325 /* could this be better, we accept some amount of race in getting the temp name*/
326 /* make sure the directory exists */
327 mkdir ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
328 chmod ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
329 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
331 sprintf (app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
334 app->app_bus_addr [0] = '\0';
340 /*---------------------------------------------------------------------------*/
343 deregister_application (SpiBridge * app)
345 DBusMessage *message;
346 DBusMessageIter iter;
350 dbus_error_init (&error);
352 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
353 SPI_DBUS_PATH_REGISTRY,
354 SPI_DBUS_INTERFACE_REGISTRY,
355 "DeregisterApplication");
356 dbus_message_set_no_reply (message, TRUE);
358 uname = dbus_bus_get_unique_name (app->bus);
360 dbus_message_iter_init_append (message, &iter);
361 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
362 dbus_connection_send (app->bus, message, NULL);
364 dbus_message_unref (message);
367 /*---------------------------------------------------------------------------*/
372 if (!spi_global_app_data)
377 spi_atk_tidy_windows ();
378 spi_atk_deregister_event_listeners ();
379 deregister_application (spi_global_app_data);
381 g_free (spi_global_app_data);
382 spi_global_app_data = NULL;
384 /* Not currently creating an XDisplay */
387 XCloseDisplay (bridge_display);
391 /*---------------------------------------------------------------------------*/
393 static AtkPlugClass *plug_class;
394 static AtkSocketClass *socket_class;
397 get_plug_id (AtkPlug * plug)
399 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
401 GString *str = g_string_new (NULL);
403 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
404 g_string_printf (str, "%s:%s", uname, path);
406 return g_string_free (str, FALSE);
410 socket_ref_state_set (AtkObject *accessible)
412 char *child_name, *child_path;
413 AtkSocket *socket = ATK_SOCKET (accessible);
417 DBusMessage *message, *reply;
418 DBusMessageIter iter, iter_array;
421 if (!socket->embedded_plug_id)
424 child_name = g_strdup (socket->embedded_plug_id);
427 child_path = g_utf8_strchr (child_name + 1, -1, ':');
433 *(child_path++) = '\0';
434 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
436 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
437 dbus_message_unref (message);
440 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
442 dbus_message_unref (reply);
445 set = atk_state_set_new ();
448 dbus_message_iter_init (reply, &iter);
449 dbus_message_iter_recurse (&iter, &iter_array);
452 dbus_message_iter_get_basic (&iter_array, &v);
453 for (j = 0; j < 32; j++)
457 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
458 atk_state_set_add_state (set, state);
463 while (dbus_message_iter_next (&iter_array));
464 dbus_message_unref (reply);
469 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
471 AtkObject *accessible = ATK_OBJECT(socket);
472 gchar *plug_name, *plug_path;
473 AtkObjectClass *klass;
475 /* Force registration */
476 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
477 /* Let the plug know that it has been embedded */
478 plug_name = g_strdup (plug_id);
484 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
487 DBusMessage *message;
488 *(plug_path++) = '\0';
489 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
490 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
491 dbus_connection_send (spi_global_app_data->bus, message, NULL);
496 klass = ATK_OBJECT_GET_CLASS (accessible);
497 klass->ref_state_set = socket_ref_state_set;
501 install_plug_hooks ()
505 data = g_type_class_ref (ATK_TYPE_PLUG);
506 plug_class = ATK_PLUG_CLASS (data);
507 data = g_type_class_ref (ATK_TYPE_SOCKET);
508 socket_class = ATK_SOCKET_CLASS (data);
509 plug_class->get_object_id = get_plug_id;
510 socket_class->embed = socket_embed_hook;
514 get_ancestral_uid (uint pid)
520 gboolean got_ppid = 0;
521 gboolean got_uid = 0;
523 sprintf (buf, "/proc/%d/status", pid);
524 fp = fopen (buf, "r");
527 while ((!got_ppid || !got_uid) && fgets (buf, sizeof (buf), fp))
529 if (sscanf (buf, "PPid:\t%d", &ppid) == 1)
531 else if (sscanf (buf, "Uid:\t%d", &uid) == 1)
536 if (!got_ppid || !got_uid)
540 if (ppid == 0 || ppid == 1)
542 return get_ancestral_uid (ppid);
546 user_check (DBusConnection *bus, unsigned long uid)
548 if (uid == getuid () || uid == geteuid ())
551 return get_ancestral_uid (getpid ()) == uid;
556 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
560 dbus_connection_set_unix_user_function (con, user_check, NULL, NULL);
561 dbus_connection_ref(con);
562 dbus_connection_setup_with_g_main(con, NULL);
563 droute_intercept_dbus (con);
564 droute_context_register (spi_global_app_data->droute, con);
566 new_list = g_list_append (spi_global_app_data->direct_connections, con);
568 spi_global_app_data->direct_connections = new_list;
578 dbus_error_init(&err);
579 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
582 g_warning (_("atk-bridge: Couldn't listen on dbus server: %s"), err.message);
583 dbus_error_init (&err);
584 spi_global_app_data->app_bus_addr [0] = '\0';
585 g_main_context_unref (spi_global_app_data->main_context);
586 spi_global_app_data->main_context = NULL;
590 dbus_server_setup_with_g_main(server, NULL);
591 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
593 spi_global_app_data->server = server;
600 gchar *atspi_dbus_name = NULL;
601 static gboolean atspi_no_register = FALSE;
603 static GOptionEntry atspi_option_entries[] = {
604 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
605 "D-Bus bus name to register as", NULL},
606 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
607 "Do not register with Registry Daemon", NULL},
612 introspect_children_cb (const char *path, void *data)
614 if (!strcmp (path, "/org/a11y/atspi/accessible"))
616 return g_strdup ("<node name=\"root\"/>\n");
617 /* TODO: Should we place the whole hierarchy here? */
623 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
629 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
630 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
633 add_event (sender, name);
637 remove_events (const char *bus_name, const char *event)
643 remove_data = g_strsplit (event, ":", 3);
649 for (list = spi_global_app_data->events; list;)
651 event_data *evdata = list->data;
652 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
653 spi_event_is_subtype (evdata->data, remove_data))
655 GList *events = spi_global_app_data->events;
657 g_strfreev (evdata->data);
658 g_free (evdata->bus_name);
660 spi_global_app_data->events = g_list_remove (events, evdata);
668 g_strfreev (remove_data);
672 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
675 const char *orig_name;
679 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
680 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
683 remove_events (sender, name);
686 static DBusHandlerResult
687 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
689 const char *interface = dbus_message_get_interface (message);
690 const char *member = dbus_message_get_member (message);
691 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
693 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
694 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
696 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
698 result = DBUS_HANDLER_RESULT_HANDLED;
699 if (!strcmp (member, "EventListenerRegistered"))
700 handle_event_listener_registered (bus, message, user_data);
701 else if (!strcmp (member, "EventListenerDeregistered"))
702 handle_event_listener_deregistered (bus, message, user_data);
704 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
712 * The following needs to be initialized.
714 * - DRoute for routing message to their accessible objects.
715 * - Event handlers for emmitting signals on specific ATK events.
716 * - setup the bus for p2p communication
717 * - Application registration with the AT-SPI registry.
721 adaptor_init (gint * argc, gchar ** argv[])
727 gchar *introspection_directory;
728 static gboolean inited = FALSE;
735 DRoutePath *treepath, *accpath;
737 root = atk_get_root ();
738 g_warn_if_fail (root);
745 /* Parse command line options */
746 opt = g_option_context_new (NULL);
747 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
748 g_option_context_set_ignore_unknown_options (opt, TRUE);
749 if (!g_option_context_parse (opt, argc, argv, &err))
750 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
751 g_option_context_free (opt);
753 /* Allocate global data and do ATK initializations */
754 spi_global_app_data = g_new0 (SpiBridge, 1);
755 atk_misc = atk_misc_get_instance ();
756 spi_global_app_data->root = g_object_ref (root);
758 /* Set up D-Bus connection and register bus name */
759 dbus_error_init (&error);
760 spi_global_app_data->bus = spi_atk_bridge_get_bus ();
761 if (!spi_global_app_data->bus)
763 g_free (spi_global_app_data);
764 spi_global_app_data = NULL;
769 if (atspi_dbus_name != NULL)
771 if (dbus_bus_request_name
772 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
774 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
779 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
785 spi_global_app_data->main_context = g_main_context_new ();
787 spi_global_app_data->main_context = NULL;
790 dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
792 /* Hook our plug-and socket functions */
793 install_plug_hooks ();
796 * Create the leasing, register and cache objects.
797 * The order is important here, the cache depends on the
800 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
801 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
802 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
804 /* Register droute for routing AT-SPI messages */
805 spi_global_app_data->droute =
808 treepath = droute_add_one (spi_global_app_data->droute,
809 "/org/a11y/atspi/cache", spi_global_cache);
813 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
817 accpath = droute_add_many (spi_global_app_data->droute,
818 "/org/a11y/atspi/accessible",
820 introspect_children_cb,
822 (DRouteGetDatumFunction)
823 spi_global_register_path_to_object);
826 /* Register all interfaces with droute and set up application accessible db */
827 spi_initialize_cache (treepath);
828 spi_initialize_accessible (accpath);
829 spi_initialize_application (accpath);
830 spi_initialize_action (accpath);
831 spi_initialize_collection (accpath);
832 spi_initialize_component (accpath);
833 spi_initialize_document (accpath);
834 spi_initialize_editabletext (accpath);
835 spi_initialize_hyperlink (accpath);
836 spi_initialize_hypertext (accpath);
837 spi_initialize_image (accpath);
838 spi_initialize_selection (accpath);
839 spi_initialize_socket (accpath);
840 spi_initialize_table (accpath);
841 spi_initialize_text (accpath);
842 spi_initialize_value (accpath);
844 droute_context_register (spi_global_app_data->droute,
845 spi_global_app_data->bus);
847 /* Register methods to send D-Bus signals on certain ATK events */
848 spi_atk_register_event_listeners ();
850 /* Set up filter and match rules to catch signals */
851 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
852 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
855 /* Register this app by sending a signal out to AT-SPI registry daemon */
856 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
857 register_application (spi_global_app_data);
859 get_registered_event_listeners (spi_global_app_data);
866 /*---------------------------------------------------------------------------*/
869 gtk_module_init (gint * argc, gchar ** argv[])
871 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
873 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
875 return adaptor_init (argc, argv);
881 g_module_check_init (GModule *module)
883 g_module_make_resident (module);
889 gnome_accessibility_module_init (void)
891 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
893 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
895 adaptor_init (NULL, NULL);
897 if (g_getenv ("AT_SPI_DEBUG"))
899 g_print ("Atk Accessibility bridge initialized\n");
905 gnome_accessibility_module_shutdown (void)
907 spi_atk_deregister_event_listeners ();
911 /*END------------------------------------------------------------------------*/