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>
42 #include <atspi/atspi.h>
48 #include "common/spi-stateset.h"
50 #include "accessible-register.h"
51 #include "accessible-leasing.h"
52 #include "accessible-cache.h"
54 #include "common/spi-dbus.h"
56 /*---------------------------------------------------------------------------*/
58 SpiBridge *spi_global_app_data = NULL;
60 static const AtkMisc *atk_misc = NULL;
62 /*static Display *bridge_display = NULL;*/
64 /*---------------------------------------------------------------------------*/
67 * Returns a 'canonicalized' value for DISPLAY,
68 * with the screen number stripped off if present.
72 spi_display_name (void)
74 static const char *canonical_display_name = NULL;
75 if (!canonical_display_name)
77 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
80 display_env = g_getenv ("DISPLAY");
81 if (!display_env || !display_env[0])
82 canonical_display_name = ":0";
85 gchar *display_p, *screen_p;
86 canonical_display_name = g_strdup (display_env);
87 display_p = strrchr (canonical_display_name, ':');
88 screen_p = strrchr (canonical_display_name, '.');
89 if (screen_p && display_p && (screen_p > display_p))
97 canonical_display_name = display_env;
100 return canonical_display_name;
103 /*---------------------------------------------------------------------------*/
106 set_reply (DBusPendingCall *pending, void *user_data)
108 void **replyptr = (void **)user_data;
110 *replyptr = dbus_pending_call_steal_reply (pending);
111 dbus_pending_call_unref (pending);
114 /*---------------------------------------------------------------------------*/
117 add_event (const char *bus_name, const char *event)
123 evdata = (event_data *) g_malloc (sizeof (*evdata));
126 data = g_strsplit (event, ":", 3);
132 evdata->bus_name = g_strdup (bus_name);
134 new_list = g_list_append (spi_global_app_data->events, evdata);
136 spi_global_app_data->events = new_list;
140 get_registered_event_listeners (SpiBridge *app)
142 DBusMessage *message, *reply;
143 DBusMessageIter iter, iter_array, iter_struct;
145 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
146 SPI_DBUS_PATH_REGISTRY,
147 SPI_DBUS_INTERFACE_REGISTRY,
148 "GetRegisteredEvents");
149 spi_global_app_data->events_initialized = TRUE;
153 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
154 dbus_message_unref (message);
157 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
159 /* TODO: Add a warning when it's okay to add strings */
160 dbus_message_unref (reply);
163 dbus_message_iter_init (reply, &iter);
164 dbus_message_iter_recurse (&iter, &iter_array);
165 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
167 char *bus_name, *event;
168 dbus_message_iter_recurse (&iter_array, &iter_struct);
169 dbus_message_iter_get_basic (&iter_struct, &bus_name);
170 dbus_message_iter_next (&iter_struct);
171 dbus_message_iter_get_basic (&iter_struct, &event);
172 add_event (bus_name, event);
173 dbus_message_iter_next (&iter_array);
175 dbus_message_unref (reply);
179 register_reply (DBusPendingCall *pending, void *user_data)
182 SpiBridge *app = user_data;
183 DBusMessage *message;
185 reply = dbus_pending_call_steal_reply (pending);
186 dbus_pending_call_unref (pending);
189 gchar *app_name, *obj_path;
191 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
193 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
197 DBusMessageIter iter, iter_struct;
198 dbus_message_iter_init (reply, &iter);
199 dbus_message_iter_recurse (&iter, &iter_struct);
200 dbus_message_iter_get_basic (&iter_struct, &app_name);
201 dbus_message_iter_next (&iter_struct);
202 dbus_message_iter_get_basic (&iter_struct, &obj_path);
204 app->desktop_name = g_strdup (app_name);
205 app->desktop_path = g_strdup (obj_path);
210 g_warning ("AT-SPI: Could not embed inside desktop");
213 dbus_message_unref (reply);
215 get_registered_event_listeners (spi_global_app_data);
219 register_application (SpiBridge * app)
221 DBusMessage *message, *reply;
222 DBusMessageIter iter;
224 DBusPendingCall *pending;
225 const int max_addr_length = 128; /* should be long enough */
227 dbus_error_init (&error);
229 /* These will be overridden when we get a reply, but in practice these
230 defaults should always be correct */
231 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
232 app->desktop_path = SPI_DBUS_PATH_ROOT;
234 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
236 SPI_DBUS_INTERFACE_SOCKET,
239 dbus_message_iter_init_append (message, &iter);
240 spi_object_append_reference (&iter, app->root);
242 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1)
248 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
251 dbus_message_unref (message);
253 /* could this be better, we accept some amount of race in getting the temp name*/
254 /* make sure the directory exists */
255 mkdir ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
256 chmod ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
257 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
259 sprintf (app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
262 app->app_bus_addr [0] = '\0';
268 /*---------------------------------------------------------------------------*/
271 deregister_application (SpiBridge * app)
273 DBusMessage *message;
274 DBusMessageIter iter;
278 dbus_error_init (&error);
280 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
281 SPI_DBUS_PATH_REGISTRY,
282 SPI_DBUS_INTERFACE_REGISTRY,
283 "DeregisterApplication");
284 dbus_message_set_no_reply (message, TRUE);
286 uname = dbus_bus_get_unique_name (app->bus);
288 dbus_message_iter_init_append (message, &iter);
289 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
290 dbus_connection_send (app->bus, message, NULL);
292 dbus_message_unref (message);
295 /*---------------------------------------------------------------------------*/
300 if (!spi_global_app_data)
305 spi_atk_tidy_windows ();
306 spi_atk_deregister_event_listeners ();
307 deregister_application (spi_global_app_data);
309 g_free (spi_global_app_data);
310 spi_global_app_data = NULL;
312 /* Not currently creating an XDisplay */
315 XCloseDisplay (bridge_display);
319 /*---------------------------------------------------------------------------*/
321 static AtkPlugClass *plug_class;
322 static AtkSocketClass *socket_class;
325 get_plug_id (AtkPlug * plug)
327 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
329 GString *str = g_string_new (NULL);
331 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
332 g_string_printf (str, "%s:%s", uname, path);
334 return g_string_free (str, FALSE);
338 socket_ref_state_set (AtkObject *accessible)
340 char *child_name, *child_path;
341 AtkSocket *socket = ATK_SOCKET (accessible);
345 DBusMessage *message, *reply;
346 DBusMessageIter iter, iter_array;
349 if (!socket->embedded_plug_id)
352 child_name = g_strdup (socket->embedded_plug_id);
355 child_path = g_utf8_strchr (child_name + 1, -1, ':');
361 *(child_path++) = '\0';
362 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
364 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
365 dbus_message_unref (message);
368 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
370 dbus_message_unref (reply);
373 set = atk_state_set_new ();
376 dbus_message_iter_init (reply, &iter);
377 dbus_message_iter_recurse (&iter, &iter_array);
380 dbus_message_iter_get_basic (&iter_array, &v);
381 for (j = 0; j < 32; j++)
385 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
386 atk_state_set_add_state (set, state);
391 while (dbus_message_iter_next (&iter_array));
392 dbus_message_unref (reply);
397 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
399 AtkObject *accessible = ATK_OBJECT(socket);
400 gchar *plug_name, *plug_path;
401 AtkObjectClass *klass;
403 /* Force registration */
404 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
405 /* Let the plug know that it has been embedded */
406 plug_name = g_strdup (plug_id);
412 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
415 DBusMessage *message;
416 *(plug_path++) = '\0';
417 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
418 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
419 dbus_connection_send (spi_global_app_data->bus, message, NULL);
424 klass = ATK_OBJECT_GET_CLASS (accessible);
425 klass->ref_state_set = socket_ref_state_set;
429 install_plug_hooks ()
433 data = g_type_class_ref (ATK_TYPE_PLUG);
434 plug_class = ATK_PLUG_CLASS (data);
435 data = g_type_class_ref (ATK_TYPE_SOCKET);
436 socket_class = ATK_SOCKET_CLASS (data);
437 plug_class->get_object_id = get_plug_id;
438 socket_class->embed = socket_embed_hook;
442 get_ancestral_uid (uint pid)
448 gboolean got_ppid = 0;
449 gboolean got_uid = 0;
451 sprintf (buf, "/proc/%d/status", pid);
452 fp = fopen (buf, "r");
455 while ((!got_ppid || !got_uid) && fgets (buf, sizeof (buf), fp))
457 if (sscanf (buf, "PPid:\t%d", &ppid) == 1)
459 else if (sscanf (buf, "Uid:\t%d", &uid) == 1)
464 if (!got_ppid || !got_uid)
468 if (ppid == 0 || ppid == 1)
470 return get_ancestral_uid (ppid);
474 user_check (DBusConnection *bus, unsigned long uid)
476 if (uid == getuid () || uid == geteuid ())
479 return get_ancestral_uid (getpid ()) == uid;
484 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
488 dbus_connection_set_unix_user_function (con, user_check, NULL, NULL);
489 dbus_connection_ref(con);
490 atspi_dbus_connection_setup_with_g_main(con, NULL);
491 droute_intercept_dbus (con);
492 droute_context_register (spi_global_app_data->droute, con);
494 new_list = g_list_append (spi_global_app_data->direct_connections, con);
496 spi_global_app_data->direct_connections = new_list;
506 dbus_error_init(&err);
507 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
510 g_warning (_("atk-bridge: Couldn't listen on dbus server: %s"), err.message);
511 dbus_error_init (&err);
512 spi_global_app_data->app_bus_addr [0] = '\0';
513 g_main_context_unref (spi_global_app_data->main_context);
514 spi_global_app_data->main_context = NULL;
518 atspi_dbus_server_setup_with_g_main(server, NULL);
519 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
521 spi_global_app_data->server = server;
528 gchar *atspi_dbus_name = NULL;
529 static gboolean atspi_no_register = FALSE;
531 static GOptionEntry atspi_option_entries[] = {
532 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
533 "D-Bus bus name to register as", NULL},
534 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
535 "Do not register with Registry Daemon", NULL},
540 introspect_children_cb (const char *path, void *data)
542 if (!strcmp (path, "/org/a11y/atspi/accessible"))
544 return g_strdup ("<node name=\"root\"/>\n");
545 /* TODO: Should we place the whole hierarchy here? */
551 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
557 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
558 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
561 add_event (sender, name);
565 remove_events (const char *bus_name, const char *event)
571 remove_data = g_strsplit (event, ":", 3);
577 for (list = spi_global_app_data->events; list;)
579 event_data *evdata = list->data;
580 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
581 spi_event_is_subtype (evdata->data, remove_data))
583 GList *events = spi_global_app_data->events;
585 g_strfreev (evdata->data);
586 g_free (evdata->bus_name);
588 spi_global_app_data->events = g_list_remove (events, evdata);
596 g_strfreev (remove_data);
600 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
603 const char *orig_name;
607 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
608 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
611 remove_events (sender, name);
614 static DBusHandlerResult
615 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
617 const char *interface = dbus_message_get_interface (message);
618 const char *member = dbus_message_get_member (message);
619 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
621 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
622 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
624 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
626 result = DBUS_HANDLER_RESULT_HANDLED;
627 if (!strcmp (member, "EventListenerRegistered"))
628 handle_event_listener_registered (bus, message, user_data);
629 else if (!strcmp (member, "EventListenerDeregistered"))
630 handle_event_listener_deregistered (bus, message, user_data);
632 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
640 * The following needs to be initialized.
642 * - DRoute for routing message to their accessible objects.
643 * - Event handlers for emmitting signals on specific ATK events.
644 * - setup the bus for p2p communication
645 * - Application registration with the AT-SPI registry.
649 adaptor_init (gint * argc, gchar ** argv[])
655 gchar *introspection_directory;
656 static gboolean inited = FALSE;
663 DRoutePath *treepath, *accpath;
665 root = atk_get_root ();
666 g_warn_if_fail (root);
673 /* Parse command line options */
674 opt = g_option_context_new (NULL);
675 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
676 g_option_context_set_ignore_unknown_options (opt, TRUE);
677 if (!g_option_context_parse (opt, argc, argv, &err))
678 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
679 g_option_context_free (opt);
681 /* Allocate global data and do ATK initializations */
682 spi_global_app_data = g_new0 (SpiBridge, 1);
683 atk_misc = atk_misc_get_instance ();
684 spi_global_app_data->root = g_object_ref (root);
686 /* Set up D-Bus connection and register bus name */
687 dbus_error_init (&error);
688 spi_global_app_data->bus = atspi_get_a11y_bus ();
689 if (!spi_global_app_data->bus)
691 g_free (spi_global_app_data);
692 spi_global_app_data = NULL;
697 if (atspi_dbus_name != NULL)
699 if (dbus_bus_request_name
700 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
702 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
707 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
713 spi_global_app_data->main_context = g_main_context_new ();
715 spi_global_app_data->main_context = NULL;
718 atspi_dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
720 /* Hook our plug-and socket functions */
721 install_plug_hooks ();
724 * Create the leasing, register and cache objects.
725 * The order is important here, the cache depends on the
728 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
729 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
730 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
732 /* Register droute for routing AT-SPI messages */
733 spi_global_app_data->droute =
736 treepath = droute_add_one (spi_global_app_data->droute,
737 "/org/a11y/atspi/cache", spi_global_cache);
741 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
745 accpath = droute_add_many (spi_global_app_data->droute,
746 "/org/a11y/atspi/accessible",
748 introspect_children_cb,
750 (DRouteGetDatumFunction)
751 spi_global_register_path_to_object);
754 /* Register all interfaces with droute and set up application accessible db */
755 spi_initialize_cache (treepath);
756 spi_initialize_accessible (accpath);
757 spi_initialize_application (accpath);
758 spi_initialize_action (accpath);
759 spi_initialize_collection (accpath);
760 spi_initialize_component (accpath);
761 spi_initialize_document (accpath);
762 spi_initialize_editabletext (accpath);
763 spi_initialize_hyperlink (accpath);
764 spi_initialize_hypertext (accpath);
765 spi_initialize_image (accpath);
766 spi_initialize_selection (accpath);
767 spi_initialize_socket (accpath);
768 spi_initialize_table (accpath);
769 spi_initialize_text (accpath);
770 spi_initialize_value (accpath);
772 droute_context_register (spi_global_app_data->droute,
773 spi_global_app_data->bus);
775 /* Register methods to send D-Bus signals on certain ATK events */
776 spi_atk_register_event_listeners ();
778 /* Set up filter and match rules to catch signals */
779 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
780 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
783 /* Register this app by sending a signal out to AT-SPI registry daemon */
784 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
785 register_application (spi_global_app_data);
787 get_registered_event_listeners (spi_global_app_data);
794 /*---------------------------------------------------------------------------*/
797 gtk_module_init (gint * argc, gchar ** argv[])
799 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
801 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
803 return adaptor_init (argc, argv);
809 g_module_check_init (GModule *module)
811 g_module_make_resident (module);
817 gnome_accessibility_module_init (void)
819 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
821 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
823 adaptor_init (NULL, NULL);
825 if (g_getenv ("AT_SPI_DEBUG"))
827 g_print ("Atk Accessibility bridge initialized\n");
833 gnome_accessibility_module_shutdown (void)
835 spi_atk_deregister_event_listeners ();
839 /*END------------------------------------------------------------------------*/