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.
29 #include <X11/Xatom.h>
38 #include <droute/droute.h>
40 #include <glib/gi18n.h>
41 #include <atspi/atspi.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 set_reply (DBusPendingCall *pending, void *user_data)
107 void **replyptr = (void **)user_data;
109 *replyptr = dbus_pending_call_steal_reply (pending);
110 dbus_pending_call_unref (pending);
113 /*---------------------------------------------------------------------------*/
116 add_event (const char *bus_name, const char *event)
122 evdata = (event_data *) g_malloc (sizeof (*evdata));
125 data = g_strsplit (event, ":", 3);
131 evdata->bus_name = g_strdup (bus_name);
133 new_list = g_list_append (spi_global_app_data->events, evdata);
135 spi_global_app_data->events = new_list;
139 get_registered_event_listeners (SpiBridge *app)
141 DBusMessage *message, *reply;
142 DBusMessageIter iter, iter_array, iter_struct;
144 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
145 SPI_DBUS_PATH_REGISTRY,
146 SPI_DBUS_INTERFACE_REGISTRY,
147 "GetRegisteredEvents");
148 spi_global_app_data->events_initialized = TRUE;
152 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
153 dbus_message_unref (message);
156 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
158 /* TODO: Add a warning when it's okay to add strings */
159 dbus_message_unref (reply);
162 dbus_message_iter_init (reply, &iter);
163 dbus_message_iter_recurse (&iter, &iter_array);
164 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
166 char *bus_name, *event;
167 dbus_message_iter_recurse (&iter_array, &iter_struct);
168 dbus_message_iter_get_basic (&iter_struct, &bus_name);
169 dbus_message_iter_next (&iter_struct);
170 dbus_message_iter_get_basic (&iter_struct, &event);
171 add_event (bus_name, event);
172 dbus_message_iter_next (&iter_array);
174 dbus_message_unref (reply);
178 register_reply (DBusPendingCall *pending, void *user_data)
181 SpiBridge *app = user_data;
182 DBusMessage *message;
184 reply = dbus_pending_call_steal_reply (pending);
185 dbus_pending_call_unref (pending);
188 gchar *app_name, *obj_path;
190 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
192 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
196 DBusMessageIter iter, iter_struct;
197 dbus_message_iter_init (reply, &iter);
198 dbus_message_iter_recurse (&iter, &iter_struct);
199 dbus_message_iter_get_basic (&iter_struct, &app_name);
200 dbus_message_iter_next (&iter_struct);
201 dbus_message_iter_get_basic (&iter_struct, &obj_path);
203 app->desktop_name = g_strdup (app_name);
204 app->desktop_path = g_strdup (obj_path);
209 g_warning ("AT-SPI: Could not embed inside desktop");
212 dbus_message_unref (reply);
214 get_registered_event_listeners (spi_global_app_data);
218 register_application (SpiBridge * app)
220 DBusMessage *message, *reply;
221 DBusMessageIter iter;
223 DBusPendingCall *pending;
224 const int max_addr_length = 128; /* should be long enough */
226 dbus_error_init (&error);
228 /* These will be overridden when we get a reply, but in practice these
229 defaults should always be correct */
230 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
231 app->desktop_path = SPI_DBUS_PATH_ROOT;
233 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
235 SPI_DBUS_INTERFACE_SOCKET,
238 dbus_message_iter_init_append (message, &iter);
239 spi_object_append_reference (&iter, app->root);
241 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1)
247 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
250 dbus_message_unref (message);
252 /* could this be better, we accept some amount of race in getting the temp name*/
253 /* make sure the directory exists */
254 mkdir ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
255 chmod ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
256 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
258 sprintf (app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
261 app->app_bus_addr [0] = '\0';
267 /*---------------------------------------------------------------------------*/
270 deregister_application (SpiBridge * app)
272 DBusMessage *message;
273 DBusMessageIter iter;
277 dbus_error_init (&error);
279 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
280 SPI_DBUS_PATH_REGISTRY,
281 SPI_DBUS_INTERFACE_REGISTRY,
282 "DeregisterApplication");
283 dbus_message_set_no_reply (message, TRUE);
285 uname = dbus_bus_get_unique_name (app->bus);
287 dbus_message_iter_init_append (message, &iter);
288 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
289 dbus_connection_send (app->bus, message, NULL);
291 dbus_message_unref (message);
294 /*---------------------------------------------------------------------------*/
299 if (!spi_global_app_data)
304 spi_atk_tidy_windows ();
305 spi_atk_deregister_event_listeners ();
306 deregister_application (spi_global_app_data);
308 g_free (spi_global_app_data);
309 spi_global_app_data = NULL;
311 /* Not currently creating an XDisplay */
314 XCloseDisplay (bridge_display);
318 /*---------------------------------------------------------------------------*/
320 static AtkPlugClass *plug_class;
321 static AtkSocketClass *socket_class;
324 get_plug_id (AtkPlug * plug)
326 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
328 GString *str = g_string_new (NULL);
330 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
331 g_string_printf (str, "%s:%s", uname, path);
333 return g_string_free (str, FALSE);
337 socket_ref_state_set (AtkObject *accessible)
339 char *child_name, *child_path;
340 AtkSocket *socket = ATK_SOCKET (accessible);
344 DBusMessage *message, *reply;
345 DBusMessageIter iter, iter_array;
348 if (!socket->embedded_plug_id)
351 child_name = g_strdup (socket->embedded_plug_id);
354 child_path = g_utf8_strchr (child_name + 1, -1, ':');
360 *(child_path++) = '\0';
361 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
363 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
364 dbus_message_unref (message);
367 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
369 dbus_message_unref (reply);
372 set = atk_state_set_new ();
375 dbus_message_iter_init (reply, &iter);
376 dbus_message_iter_recurse (&iter, &iter_array);
379 dbus_message_iter_get_basic (&iter_array, &v);
380 for (j = 0; j < 32; j++)
384 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
385 atk_state_set_add_state (set, state);
390 while (dbus_message_iter_next (&iter_array));
391 dbus_message_unref (reply);
396 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
398 AtkObject *accessible = ATK_OBJECT(socket);
399 gchar *plug_name, *plug_path;
400 AtkObjectClass *klass;
402 /* Force registration */
403 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
404 /* Let the plug know that it has been embedded */
405 plug_name = g_strdup (plug_id);
411 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
414 DBusMessage *message;
415 *(plug_path++) = '\0';
416 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
417 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
418 dbus_connection_send (spi_global_app_data->bus, message, NULL);
423 klass = ATK_OBJECT_GET_CLASS (accessible);
424 klass->ref_state_set = socket_ref_state_set;
428 install_plug_hooks ()
432 data = g_type_class_ref (ATK_TYPE_PLUG);
433 plug_class = ATK_PLUG_CLASS (data);
434 data = g_type_class_ref (ATK_TYPE_SOCKET);
435 socket_class = ATK_SOCKET_CLASS (data);
436 plug_class->get_object_id = get_plug_id;
437 socket_class->embed = socket_embed_hook;
441 get_ancestral_uid (uint pid)
447 gboolean got_ppid = 0;
448 gboolean got_uid = 0;
450 sprintf (buf, "/proc/%d/status", pid);
451 fp = fopen (buf, "r");
454 while ((!got_ppid || !got_uid) && fgets (buf, sizeof (buf), fp))
456 if (sscanf (buf, "PPid:\t%d", &ppid) == 1)
458 else if (sscanf (buf, "Uid:\t%d", &uid) == 1)
463 if (!got_ppid || !got_uid)
467 if (ppid == 0 || ppid == 1)
469 return get_ancestral_uid (ppid);
473 user_check (DBusConnection *bus, unsigned long uid)
475 if (uid == getuid () || uid == geteuid ())
478 return get_ancestral_uid (getpid ()) == uid;
483 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
487 dbus_connection_set_unix_user_function (con, user_check, NULL, NULL);
488 dbus_connection_ref(con);
489 atspi_dbus_connection_setup_with_g_main(con, NULL);
490 droute_intercept_dbus (con);
491 droute_context_register (spi_global_app_data->droute, con);
493 new_list = g_list_append (spi_global_app_data->direct_connections, con);
495 spi_global_app_data->direct_connections = new_list;
505 dbus_error_init(&err);
506 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
509 g_warning (_("atk-bridge: Couldn't listen on dbus server: %s"), err.message);
510 dbus_error_init (&err);
511 spi_global_app_data->app_bus_addr [0] = '\0';
512 g_main_context_unref (spi_global_app_data->main_context);
513 spi_global_app_data->main_context = NULL;
517 atspi_dbus_server_setup_with_g_main(server, NULL);
518 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
520 spi_global_app_data->server = server;
527 gchar *atspi_dbus_name = NULL;
528 static gboolean atspi_no_register = FALSE;
530 static GOptionEntry atspi_option_entries[] = {
531 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
532 "D-Bus bus name to register as", NULL},
533 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
534 "Do not register with Registry Daemon", NULL},
539 introspect_children_cb (const char *path, void *data)
541 if (!strcmp (path, "/org/a11y/atspi/accessible"))
543 return g_strdup ("<node name=\"root\"/>\n");
544 /* TODO: Should we place the whole hierarchy here? */
550 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
556 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
557 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
560 add_event (sender, name);
564 remove_events (const char *bus_name, const char *event)
570 remove_data = g_strsplit (event, ":", 3);
576 for (list = spi_global_app_data->events; list;)
578 event_data *evdata = list->data;
579 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
580 spi_event_is_subtype (evdata->data, remove_data))
582 GList *events = spi_global_app_data->events;
584 g_strfreev (evdata->data);
585 g_free (evdata->bus_name);
587 spi_global_app_data->events = g_list_remove (events, evdata);
595 g_strfreev (remove_data);
599 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
602 const char *orig_name;
606 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
607 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
610 remove_events (sender, name);
613 static DBusHandlerResult
614 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
616 const char *interface = dbus_message_get_interface (message);
617 const char *member = dbus_message_get_member (message);
618 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
620 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
621 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
623 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
625 result = DBUS_HANDLER_RESULT_HANDLED;
626 if (!strcmp (member, "EventListenerRegistered"))
627 handle_event_listener_registered (bus, message, user_data);
628 else if (!strcmp (member, "EventListenerDeregistered"))
629 handle_event_listener_deregistered (bus, message, user_data);
631 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
639 * The following needs to be initialized.
641 * - DRoute for routing message to their accessible objects.
642 * - Event handlers for emmitting signals on specific ATK events.
643 * - setup the bus for p2p communication
644 * - Application registration with the AT-SPI registry.
648 adaptor_init (gint * argc, gchar ** argv[])
654 gchar *introspection_directory;
655 static gboolean inited = FALSE;
662 DRoutePath *treepath, *accpath;
664 root = atk_get_root ();
665 g_warn_if_fail (root);
672 /* Parse command line options */
673 opt = g_option_context_new (NULL);
674 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
675 g_option_context_set_ignore_unknown_options (opt, TRUE);
676 if (!g_option_context_parse (opt, argc, argv, &err))
677 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
678 g_option_context_free (opt);
680 /* Allocate global data and do ATK initializations */
681 spi_global_app_data = g_new0 (SpiBridge, 1);
682 atk_misc = atk_misc_get_instance ();
683 spi_global_app_data->root = g_object_ref (root);
685 /* Set up D-Bus connection and register bus name */
686 dbus_error_init (&error);
687 spi_global_app_data->bus = atspi_get_a11y_bus ();
688 if (!spi_global_app_data->bus)
690 g_free (spi_global_app_data);
691 spi_global_app_data = NULL;
696 if (atspi_dbus_name != NULL)
698 if (dbus_bus_request_name
699 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
701 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
706 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
712 spi_global_app_data->main_context = g_main_context_new ();
714 spi_global_app_data->main_context = NULL;
717 atspi_dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
719 /* Hook our plug-and socket functions */
720 install_plug_hooks ();
723 * Create the leasing, register and cache objects.
724 * The order is important here, the cache depends on the
727 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
728 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
729 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
731 /* Register droute for routing AT-SPI messages */
732 spi_global_app_data->droute =
735 treepath = droute_add_one (spi_global_app_data->droute,
736 "/org/a11y/atspi/cache", spi_global_cache);
740 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
744 accpath = droute_add_many (spi_global_app_data->droute,
745 "/org/a11y/atspi/accessible",
747 introspect_children_cb,
749 (DRouteGetDatumFunction)
750 spi_global_register_path_to_object);
753 /* Register all interfaces with droute and set up application accessible db */
754 spi_initialize_cache (treepath);
755 spi_initialize_accessible (accpath);
756 spi_initialize_application (accpath);
757 spi_initialize_action (accpath);
758 spi_initialize_collection (accpath);
759 spi_initialize_component (accpath);
760 spi_initialize_document (accpath);
761 spi_initialize_editabletext (accpath);
762 spi_initialize_hyperlink (accpath);
763 spi_initialize_hypertext (accpath);
764 spi_initialize_image (accpath);
765 spi_initialize_selection (accpath);
766 spi_initialize_socket (accpath);
767 spi_initialize_table (accpath);
768 spi_initialize_text (accpath);
769 spi_initialize_value (accpath);
771 droute_context_register (spi_global_app_data->droute,
772 spi_global_app_data->bus);
774 /* Register methods to send D-Bus signals on certain ATK events */
775 spi_atk_register_event_listeners ();
777 /* Set up filter and match rules to catch signals */
778 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
779 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
782 /* Register this app by sending a signal out to AT-SPI registry daemon */
783 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
784 register_application (spi_global_app_data);
786 get_registered_event_listeners (spi_global_app_data);
793 /*---------------------------------------------------------------------------*/
796 gtk_module_init (gint * argc, gchar ** argv[])
798 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
800 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
802 return adaptor_init (argc, argv);
808 g_module_check_init (GModule *module)
810 g_module_make_resident (module);
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------------------------------------------------------------------------*/