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 Display *bridge_display = NULL;*/
61 /*---------------------------------------------------------------------------*/
64 * Returns a 'canonicalized' value for DISPLAY,
65 * with the screen number stripped off if present.
69 spi_display_name (void)
71 static const char *canonical_display_name = NULL;
72 if (!canonical_display_name)
74 const gchar *display_env = g_getenv ("AT_SPI_DISPLAY");
77 display_env = g_getenv ("DISPLAY");
78 if (!display_env || !display_env[0])
79 canonical_display_name = ":0";
82 gchar *display_p, *screen_p;
83 canonical_display_name = g_strdup (display_env);
84 display_p = strrchr (canonical_display_name, ':');
85 screen_p = strrchr (canonical_display_name, '.');
86 if (screen_p && display_p && (screen_p > display_p))
94 canonical_display_name = display_env;
97 return canonical_display_name;
100 /*---------------------------------------------------------------------------*/
103 set_reply (DBusPendingCall *pending, void *user_data)
105 void **replyptr = (void **)user_data;
107 *replyptr = dbus_pending_call_steal_reply (pending);
108 dbus_pending_call_unref (pending);
111 /*---------------------------------------------------------------------------*/
114 add_event (const char *bus_name, const char *event)
120 evdata = (event_data *) g_malloc (sizeof (*evdata));
123 data = g_strsplit (event, ":", 3);
129 evdata->bus_name = g_strdup (bus_name);
131 new_list = g_list_append (spi_global_app_data->events, evdata);
133 spi_global_app_data->events = new_list;
137 get_registered_event_listeners (SpiBridge *app)
139 DBusMessage *message, *reply;
140 DBusMessageIter iter, iter_array, iter_struct;
142 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
143 SPI_DBUS_PATH_REGISTRY,
144 SPI_DBUS_INTERFACE_REGISTRY,
145 "GetRegisteredEvents");
146 spi_global_app_data->events_initialized = TRUE;
150 reply = dbus_connection_send_with_reply_and_block (app->bus, message, 5000, NULL);
151 dbus_message_unref (message);
154 if (strcmp (dbus_message_get_signature (reply), "a(ss)") != 0)
156 /* TODO: Add a warning when it's okay to add strings */
157 dbus_message_unref (reply);
160 dbus_message_iter_init (reply, &iter);
161 dbus_message_iter_recurse (&iter, &iter_array);
162 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
164 char *bus_name, *event;
165 dbus_message_iter_recurse (&iter_array, &iter_struct);
166 dbus_message_iter_get_basic (&iter_struct, &bus_name);
167 dbus_message_iter_next (&iter_struct);
168 dbus_message_iter_get_basic (&iter_struct, &event);
169 add_event (bus_name, event);
170 dbus_message_iter_next (&iter_array);
172 dbus_message_unref (reply);
176 register_reply (DBusPendingCall *pending, void *user_data)
179 SpiBridge *app = user_data;
180 DBusMessage *message;
182 reply = dbus_pending_call_steal_reply (pending);
183 dbus_pending_call_unref (pending);
186 gchar *app_name, *obj_path;
188 if (strcmp (dbus_message_get_signature (reply), "(so)") != 0)
190 g_warning ("AT-SPI: Could not obtain desktop path or name\n");
194 DBusMessageIter iter, iter_struct;
195 dbus_message_iter_init (reply, &iter);
196 dbus_message_iter_recurse (&iter, &iter_struct);
197 dbus_message_iter_get_basic (&iter_struct, &app_name);
198 dbus_message_iter_next (&iter_struct);
199 dbus_message_iter_get_basic (&iter_struct, &obj_path);
201 app->desktop_name = g_strdup (app_name);
202 app->desktop_path = g_strdup (obj_path);
207 g_warning ("AT-SPI: Could not embed inside desktop");
210 dbus_message_unref (reply);
212 get_registered_event_listeners (spi_global_app_data);
216 register_application (SpiBridge * app)
218 DBusMessage *message, *reply;
219 DBusMessageIter iter;
221 DBusPendingCall *pending;
222 const int max_addr_length = 128; /* should be long enough */
224 dbus_error_init (&error);
226 /* These will be overridden when we get a reply, but in practice these
227 defaults should always be correct */
228 app->desktop_name = SPI_DBUS_NAME_REGISTRY;
229 app->desktop_path = SPI_DBUS_PATH_ROOT;
231 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
233 SPI_DBUS_INTERFACE_SOCKET,
236 dbus_message_iter_init_append (message, &iter);
237 spi_object_append_reference (&iter, app->root);
239 if (!dbus_connection_send_with_reply (app->bus, message, &pending, -1)
245 dbus_pending_call_set_notify (pending, register_reply, app, NULL);
248 dbus_message_unref (message);
250 /* could this be better, we accept some amount of race in getting the temp name*/
251 /* make sure the directory exists */
252 mkdir ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
253 chmod ("/tmp/at-spi2/", S_IRWXU|S_IRWXG|S_IRWXO|S_ISVTX);
254 app->app_bus_addr = g_malloc(max_addr_length * sizeof(char));
256 sprintf (app->app_bus_addr, "unix:path=/tmp/at-spi2/socket-%d-%d", getpid(),
259 app->app_bus_addr [0] = '\0';
265 /*---------------------------------------------------------------------------*/
268 deregister_application (SpiBridge * app)
270 DBusMessage *message;
271 DBusMessageIter iter;
275 dbus_error_init (&error);
277 message = dbus_message_new_method_call (SPI_DBUS_NAME_REGISTRY,
278 SPI_DBUS_PATH_REGISTRY,
279 SPI_DBUS_INTERFACE_REGISTRY,
280 "DeregisterApplication");
281 dbus_message_set_no_reply (message, TRUE);
283 uname = dbus_bus_get_unique_name (app->bus);
285 dbus_message_iter_init_append (message, &iter);
286 dbus_message_iter_append_basic (&iter, DBUS_TYPE_STRING, &uname);
287 dbus_connection_send (app->bus, message, NULL);
289 dbus_message_unref (message);
292 /*---------------------------------------------------------------------------*/
297 if (!spi_global_app_data)
302 spi_atk_tidy_windows ();
303 spi_atk_deregister_event_listeners ();
304 deregister_application (spi_global_app_data);
306 g_free (spi_global_app_data);
307 spi_global_app_data = NULL;
309 /* Not currently creating an XDisplay */
312 XCloseDisplay (bridge_display);
316 /*---------------------------------------------------------------------------*/
318 static AtkPlugClass *plug_class;
319 static AtkSocketClass *socket_class;
322 get_plug_id (AtkPlug * plug)
324 const char *uname = dbus_bus_get_unique_name (spi_global_app_data->bus);
326 GString *str = g_string_new (NULL);
328 path = spi_register_object_to_path (spi_global_register, G_OBJECT (plug));
329 g_string_printf (str, "%s:%s", uname, path);
331 return g_string_free (str, FALSE);
335 socket_ref_state_set (AtkObject *accessible)
337 char *child_name, *child_path;
338 AtkSocket *socket = ATK_SOCKET (accessible);
342 DBusMessage *message, *reply;
343 DBusMessageIter iter, iter_array;
346 if (!socket->embedded_plug_id)
349 child_name = g_strdup (socket->embedded_plug_id);
352 child_path = g_utf8_strchr (child_name + 1, -1, ':');
358 *(child_path++) = '\0';
359 message = dbus_message_new_method_call (child_name, child_path, SPI_DBUS_INTERFACE_ACCESSIBLE, "GetState");
361 reply = dbus_connection_send_with_reply_and_block (spi_global_app_data->bus, message, 1, NULL);
362 dbus_message_unref (message);
365 if (strcmp (dbus_message_get_signature (reply), "au") != 0)
367 dbus_message_unref (reply);
370 set = atk_state_set_new ();
373 dbus_message_iter_init (reply, &iter);
374 dbus_message_iter_recurse (&iter, &iter_array);
377 dbus_message_iter_get_basic (&iter_array, &v);
378 for (j = 0; j < 32; j++)
382 AtkState state = spi_atk_state_from_spi_state ((count << 5) + j);
383 atk_state_set_add_state (set, state);
388 while (dbus_message_iter_next (&iter_array));
389 dbus_message_unref (reply);
394 socket_embed_hook (AtkSocket * socket, gchar * plug_id)
396 AtkObject *accessible = ATK_OBJECT(socket);
397 gchar *plug_name, *plug_path;
398 AtkObjectClass *klass;
400 /* Force registration */
401 gchar *path = spi_register_object_to_path (spi_global_register, G_OBJECT (accessible));
402 /* Let the plug know that it has been embedded */
403 plug_name = g_strdup (plug_id);
409 plug_path = g_utf8_strchr (plug_name + 1, -1, ':');
412 DBusMessage *message;
413 *(plug_path++) = '\0';
414 message = dbus_message_new_method_call (plug_name, plug_path, SPI_DBUS_INTERFACE_SOCKET, "Embedded");
415 dbus_message_append_args (message, DBUS_TYPE_STRING, &path, DBUS_TYPE_INVALID);
416 dbus_connection_send (spi_global_app_data->bus, message, NULL);
421 klass = ATK_OBJECT_GET_CLASS (accessible);
422 klass->ref_state_set = socket_ref_state_set;
426 install_plug_hooks ()
430 data = g_type_class_ref (ATK_TYPE_PLUG);
431 plug_class = ATK_PLUG_CLASS (data);
432 data = g_type_class_ref (ATK_TYPE_SOCKET);
433 socket_class = ATK_SOCKET_CLASS (data);
434 plug_class->get_object_id = get_plug_id;
435 socket_class->embed = socket_embed_hook;
439 get_ancestral_uid (uint pid)
445 gboolean got_ppid = 0;
446 gboolean got_uid = 0;
448 sprintf (buf, "/proc/%d/status", pid);
449 fp = fopen (buf, "r");
452 while ((!got_ppid || !got_uid) && fgets (buf, sizeof (buf), fp))
454 if (sscanf (buf, "PPid:\t%d", &ppid) == 1)
456 else if (sscanf (buf, "Uid:\t%d", &uid) == 1)
461 if (!got_ppid || !got_uid)
465 if (ppid == 0 || ppid == 1)
467 return get_ancestral_uid (ppid);
471 user_check (DBusConnection *bus, unsigned long uid)
473 if (uid == getuid () || uid == geteuid ())
476 return get_ancestral_uid (getpid ()) == uid;
481 new_connection_cb (DBusServer *server, DBusConnection *con, void *data)
485 dbus_connection_set_unix_user_function (con, user_check, NULL, NULL);
486 dbus_connection_ref(con);
487 atspi_dbus_connection_setup_with_g_main(con, NULL);
488 droute_intercept_dbus (con);
489 droute_context_register (spi_global_app_data->droute, con);
491 new_list = g_list_append (spi_global_app_data->direct_connections, con);
493 spi_global_app_data->direct_connections = new_list;
503 dbus_error_init(&err);
504 server = dbus_server_listen(spi_global_app_data->app_bus_addr, &err);
507 g_warning (_("atk-bridge: Couldn't listen on dbus server: %s"), err.message);
508 dbus_error_init (&err);
509 spi_global_app_data->app_bus_addr [0] = '\0';
510 g_main_context_unref (spi_global_app_data->main_context);
511 spi_global_app_data->main_context = NULL;
515 atspi_dbus_server_setup_with_g_main(server, NULL);
516 dbus_server_set_new_connection_function(server, new_connection_cb, NULL, NULL);
518 spi_global_app_data->server = server;
525 gchar *atspi_dbus_name = NULL;
526 static gboolean atspi_no_register = FALSE;
528 static GOptionEntry atspi_option_entries[] = {
529 {"atspi-dbus-name", 0, 0, G_OPTION_ARG_STRING, &atspi_dbus_name,
530 "D-Bus bus name to register as", NULL},
531 {"atspi-no-register", 0, 0, G_OPTION_ARG_NONE, &atspi_no_register,
532 "Do not register with Registry Daemon", NULL},
537 introspect_children_cb (const char *path, void *data)
539 if (!strcmp (path, "/org/a11y/atspi/accessible"))
541 return g_strdup ("<node name=\"root\"/>\n");
542 /* TODO: Should we place the whole hierarchy here? */
548 handle_event_listener_registered (DBusConnection *bus, DBusMessage *message,
554 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
555 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
558 add_event (sender, name);
562 remove_events (const char *bus_name, const char *event)
568 remove_data = g_strsplit (event, ":", 3);
574 for (list = spi_global_app_data->events; list;)
576 event_data *evdata = list->data;
577 if (!g_strcmp0 (evdata->bus_name, bus_name) &&
578 spi_event_is_subtype (evdata->data, remove_data))
580 GList *events = spi_global_app_data->events;
582 g_strfreev (evdata->data);
583 g_free (evdata->bus_name);
585 spi_global_app_data->events = g_list_remove (events, evdata);
593 g_strfreev (remove_data);
597 handle_event_listener_deregistered (DBusConnection *bus, DBusMessage *message,
600 const char *orig_name;
604 if (!dbus_message_get_args (message, NULL, DBUS_TYPE_STRING, &sender,
605 DBUS_TYPE_STRING, &name, DBUS_TYPE_INVALID))
608 remove_events (sender, name);
611 static DBusHandlerResult
612 signal_filter (DBusConnection *bus, DBusMessage *message, void *user_data)
614 const char *interface = dbus_message_get_interface (message);
615 const char *member = dbus_message_get_member (message);
616 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
618 if (dbus_message_get_type (message) != DBUS_MESSAGE_TYPE_SIGNAL)
619 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
621 if (!strcmp (interface, SPI_DBUS_INTERFACE_REGISTRY))
623 result = DBUS_HANDLER_RESULT_HANDLED;
624 if (!strcmp (member, "EventListenerRegistered"))
625 handle_event_listener_registered (bus, message, user_data);
626 else if (!strcmp (member, "EventListenerDeregistered"))
627 handle_event_listener_deregistered (bus, message, user_data);
629 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
637 * The following needs to be initialized.
639 * - DRoute for routing message to their accessible objects.
640 * - Event handlers for emmitting signals on specific ATK events.
641 * - setup the bus for p2p communication
642 * - Application registration with the AT-SPI registry.
646 adaptor_init (gint * argc, gchar ** argv[])
652 gchar *introspection_directory;
653 static gboolean inited = FALSE;
660 DRoutePath *treepath, *accpath;
662 root = atk_get_root ();
663 g_warn_if_fail (root);
670 /* Parse command line options */
671 opt = g_option_context_new (NULL);
672 g_option_context_add_main_entries (opt, atspi_option_entries, NULL);
673 g_option_context_set_ignore_unknown_options (opt, TRUE);
674 if (!g_option_context_parse (opt, argc, argv, &err))
675 g_warning ("AT-SPI Option parsing failed: %s\n", err->message);
676 g_option_context_free (opt);
678 /* Allocate global data and do ATK initializations */
679 spi_global_app_data = g_new0 (SpiBridge, 1);
680 spi_global_app_data->root = g_object_ref (root);
682 /* Set up D-Bus connection and register bus name */
683 dbus_error_init (&error);
684 spi_global_app_data->bus = atspi_get_a11y_bus ();
685 if (!spi_global_app_data->bus)
687 g_free (spi_global_app_data);
688 spi_global_app_data = NULL;
693 if (atspi_dbus_name != NULL)
695 if (dbus_bus_request_name
696 (spi_global_app_data->bus, atspi_dbus_name, 0, &error))
698 g_print ("AT-SPI Recieved D-Bus name - %s\n", atspi_dbus_name);
703 ("AT-SPI D-Bus name requested but could not be allocated - %s\n",
708 spi_global_app_data->main_context = g_main_context_new ();
710 atspi_dbus_connection_setup_with_g_main (spi_global_app_data->bus, NULL);
712 /* Hook our plug-and socket functions */
713 install_plug_hooks ();
716 * Create the leasing, register and cache objects.
717 * The order is important here, the cache depends on the
720 spi_global_register = g_object_new (SPI_REGISTER_TYPE, NULL);
721 spi_global_leasing = g_object_new (SPI_LEASING_TYPE, NULL);
722 spi_global_cache = g_object_new (SPI_CACHE_TYPE, NULL);
724 /* Register droute for routing AT-SPI messages */
725 spi_global_app_data->droute =
728 treepath = droute_add_one (spi_global_app_data->droute,
729 "/org/a11y/atspi/cache", spi_global_cache);
733 g_warning ("atk-bridge: Error in droute_add_one(). Already running?");
737 accpath = droute_add_many (spi_global_app_data->droute,
738 "/org/a11y/atspi/accessible",
740 introspect_children_cb,
742 (DRouteGetDatumFunction)
743 spi_global_register_path_to_object);
746 /* Register all interfaces with droute and set up application accessible db */
747 spi_initialize_cache (treepath);
748 spi_initialize_accessible (accpath);
749 spi_initialize_application (accpath);
750 spi_initialize_action (accpath);
751 spi_initialize_collection (accpath);
752 spi_initialize_component (accpath);
753 spi_initialize_document (accpath);
754 spi_initialize_editabletext (accpath);
755 spi_initialize_hyperlink (accpath);
756 spi_initialize_hypertext (accpath);
757 spi_initialize_image (accpath);
758 spi_initialize_selection (accpath);
759 spi_initialize_socket (accpath);
760 spi_initialize_table (accpath);
761 spi_initialize_text (accpath);
762 spi_initialize_value (accpath);
764 droute_context_register (spi_global_app_data->droute,
765 spi_global_app_data->bus);
767 /* Register methods to send D-Bus signals on certain ATK events */
768 spi_atk_register_event_listeners ();
770 /* Set up filter and match rules to catch signals */
771 dbus_bus_add_match (spi_global_app_data->bus, "type='signal', interface='org.a11y.atspi.Registry', sender='org.a11y.atspi.Registry'", NULL);
772 dbus_connection_add_filter (spi_global_app_data->bus, signal_filter, NULL,
775 /* Register this app by sending a signal out to AT-SPI registry daemon */
776 if (!atspi_no_register && (!root || !ATK_IS_PLUG (root)))
777 register_application (spi_global_app_data);
779 get_registered_event_listeners (spi_global_app_data);
786 /*---------------------------------------------------------------------------*/
789 gtk_module_init (gint * argc, gchar ** argv[])
791 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
793 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
795 return adaptor_init (argc, argv);
801 g_module_check_init (GModule *module)
803 g_module_make_resident (module);
809 gnome_accessibility_module_init (void)
811 const gchar *load_bridge = g_getenv ("NO_AT_BRIDGE");
813 if (!load_bridge || g_ascii_strtod (load_bridge, NULL) == 0)
815 adaptor_init (NULL, NULL);
817 if (g_getenv ("AT_SPI_DEBUG"))
819 g_print ("Atk Accessibility bridge initialized\n");
825 gnome_accessibility_module_shutdown (void)
827 spi_atk_deregister_event_listeners ();
831 /*END------------------------------------------------------------------------*/