2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2008 Novell, Inc.
6 * Copyright 2008 Codethink Ltd.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
29 #include "droute-pairhash.h"
31 #define CHUNKS_DEFAULT (512)
33 #define oom() g_error ("D-Bus out of memory, this message will fail anyway")
35 #if defined DROUTE_DEBUG
36 #define _DROUTE_DEBUG(format, args...) g_print (format , ## args)
38 #define _DROUTE_DEBUG(format, args...)
43 GPtrArray *registered_paths;
45 gchar *introspect_string;
54 GPtrArray *interfaces;
55 GPtrArray *introspection;
57 GHashTable *properties;
59 DRouteIntrospectChildrenFunction introspect_children_cb;
60 void *introspect_children_data;
62 DRouteGetDatumFunction get_datum;
65 /*---------------------------------------------------------------------------*/
67 typedef struct PropertyPair
69 DRoutePropertyFunction get;
70 DRoutePropertyFunction set;
73 /*---------------------------------------------------------------------------*/
75 static DBusHandlerResult
76 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data);
79 droute_object_does_not_exist_error (DBusMessage *message);
81 /*---------------------------------------------------------------------------*/
84 path_new (DRouteContext *cnx,
88 DRouteIntrospectChildrenFunction introspect_children_cb,
89 void *introspect_children_data,
90 DRouteGetDatumFunction get_datum)
94 new_path = g_new0 (DRoutePath, 1);
96 new_path->path = g_strdup (path);
97 new_path->prefix = prefix;
98 new_path->chunks = g_string_chunk_new (CHUNKS_DEFAULT);
99 new_path->interfaces = g_ptr_array_new ();
100 new_path->introspection = g_ptr_array_new ();
102 new_path->methods = g_hash_table_new_full ((GHashFunc)str_pair_hash,
107 new_path->properties = g_hash_table_new_full ((GHashFunc)str_pair_hash,
112 new_path->introspect_children_cb = introspect_children_cb;
113 new_path->introspect_children_data = introspect_children_data;
114 new_path->user_data = user_data;
115 new_path->get_datum = get_datum;
121 path_free (DRoutePath *path, gpointer user_data)
124 g_string_chunk_free (path->chunks);
125 g_ptr_array_free (path->interfaces, TRUE);
126 g_free(g_ptr_array_free (path->introspection, FALSE));
127 g_hash_table_destroy (path->methods);
128 g_hash_table_destroy (path->properties);
133 path_get_datum (DRoutePath *path, const gchar *pathstr)
135 if (path->get_datum != NULL)
136 return (path->get_datum) (pathstr, path->user_data);
138 return path->user_data;
141 /*---------------------------------------------------------------------------*/
148 cnx = g_new0 (DRouteContext, 1);
149 cnx->registered_paths = g_ptr_array_new ();
155 droute_free (DRouteContext *cnx)
157 g_ptr_array_foreach (cnx->registered_paths, (GFunc) path_free, NULL);
158 g_ptr_array_free (cnx->registered_paths, TRUE);
162 /*---------------------------------------------------------------------------*/
164 /*---------------------------------------------------------------------------*/
166 static DBusObjectPathVTable droute_vtable =
170 NULL, NULL, NULL, NULL
174 droute_add_one (DRouteContext *cnx,
178 DRoutePath *new_path;
180 new_path = path_new (cnx, path, FALSE, (void *)data, NULL, NULL, NULL);
182 g_ptr_array_add (cnx->registered_paths, new_path);
187 droute_add_many (DRouteContext *cnx,
190 DRouteIntrospectChildrenFunction introspect_children_cb,
191 void *introspect_children_data,
192 const DRouteGetDatumFunction get_datum)
194 DRoutePath *new_path;
196 new_path = path_new (cnx, path, TRUE, (void *) data,
197 introspect_children_cb, introspect_children_data,
200 g_ptr_array_add (cnx->registered_paths, new_path);
204 /*---------------------------------------------------------------------------*/
207 droute_path_add_interface(DRoutePath *path,
209 const char *introspect,
210 const DRouteMethod *methods,
211 const DRouteProperty *properties)
215 g_return_if_fail (name != NULL);
217 itf = g_string_chunk_insert (path->chunks, name);
218 g_ptr_array_add (path->interfaces, itf);
219 g_ptr_array_add (path->introspection, (gpointer) introspect);
221 for (; methods != NULL && methods->name != NULL; methods++)
225 meth = g_string_chunk_insert (path->chunks, methods->name);
226 g_hash_table_insert (path->methods, str_pair_new (itf, meth), methods->func);
229 for (; properties != NULL && properties->name != NULL; properties++)
234 prop = g_string_chunk_insert (path->chunks, properties->name);
235 pair = g_new (PropertyPair, 1);
236 pair->get = properties->get;
237 pair->set = properties->set;
238 g_hash_table_insert (path->properties, str_pair_new (itf, prop), pair);
242 /*---------------------------------------------------------------------------*/
244 /* The data structures don't support an efficient implementation of GetAll
245 * and I don't really care.
248 impl_prop_GetAll (DBusMessage *message,
252 DBusMessageIter iter, iter_dict, iter_dict_entry;
255 GHashTableIter prop_iter;
261 void *datum = path_get_datum (path, pathstr);
263 return droute_object_does_not_exist_error (message);
265 dbus_error_init (&error);
266 if (!dbus_message_get_args
267 (message, &error, DBUS_TYPE_STRING, &iface, DBUS_TYPE_INVALID))
268 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
270 reply = dbus_message_new_method_return (message);
274 dbus_message_iter_init_append (reply, &iter);
275 if (!dbus_message_iter_open_container
276 (&iter, DBUS_TYPE_ARRAY, "{sv}", &iter_dict))
279 g_hash_table_iter_init (&prop_iter, path->properties);
280 while (g_hash_table_iter_next (&prop_iter, (gpointer*)&key, (gpointer*)&value))
282 if (!g_strcmp0 (key->one, iface))
286 if (!dbus_message_iter_open_container
287 (&iter_dict, DBUS_TYPE_DICT_ENTRY, NULL, &iter_dict_entry))
289 dbus_message_iter_append_basic (&iter_dict_entry, DBUS_TYPE_STRING,
291 (value->get) (&iter_dict_entry, datum);
292 if (!dbus_message_iter_close_container (&iter_dict, &iter_dict_entry))
297 if (!dbus_message_iter_close_container (&iter, &iter_dict))
303 impl_prop_GetSet (DBusMessage *message,
308 DBusMessage *reply = NULL;
312 PropertyPair *prop_funcs = NULL;
316 dbus_error_init (&error);
317 if (!dbus_message_get_args (message,
324 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
326 _DROUTE_DEBUG ("DRoute (handle prop): %s|%s on %s\n", pair.one, pair.two, pathstr);
328 prop_funcs = (PropertyPair *) g_hash_table_lookup (path->properties, &pair);
330 #ifdef DBUS_ERROR_UNKNOWN_PROPERTY
331 return dbus_message_new_error (message, DBUS_ERROR_UNKNOWN_PROPERTY, "Property unavailable");
333 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
336 datum = path_get_datum (path, pathstr);
338 return droute_object_does_not_exist_error (message);
340 if (get && prop_funcs->get)
343 DBusMessageIter iter;
345 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
347 reply = dbus_message_new_method_return (message);
348 dbus_message_iter_init_append (reply, &iter);
349 if (!(prop_funcs->get) (&iter, datum))
351 dbus_message_unref (reply);
352 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Get failed");
355 else if (!get && prop_funcs->set)
357 DBusMessageIter iter;
359 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
361 dbus_message_iter_init (message, &iter);
362 /* Skip the interface and property name */
363 dbus_message_iter_next(&iter);
364 dbus_message_iter_next(&iter);
365 (prop_funcs->set) (&iter, datum);
367 reply = dbus_message_new_method_return (message);
369 #ifdef DBUS_ERROR_PROPERTY_READ_ONLY
372 reply = dbus_message_new_error (message, DBUS_ERROR_PROPERTY_READ_ONLY, "Property is read-only");
377 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Getter or setter unavailable");
383 static DBusHandlerResult
384 handle_dbus (DBusConnection *bus,
385 DBusMessage *message,
388 const gchar *pathstr)
391 char *id_str = (char *) g_malloc(40);
394 if (strcmp (iface, DBUS_INTERFACE_DBUS) != 0 ||
395 strcmp (member, "Hello") != 0)
398 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
401 /* TODO: Fix this hack (we don't handle wrap-around, for instance) */
402 sprintf (id_str, ":1.%d", id++);
403 reply = dbus_message_new_method_return (message);
404 dbus_message_append_args (reply, DBUS_TYPE_STRING, &id_str, DBUS_TYPE_INVALID);
405 dbus_connection_send (bus, reply, NULL);
406 dbus_connection_flush (bus);
407 dbus_message_unref (reply);
409 return DBUS_HANDLER_RESULT_HANDLED;
412 static DBusHandlerResult
413 handle_properties (DBusConnection *bus,
414 DBusMessage *message,
418 const gchar *pathstr)
420 DBusMessage *reply = NULL;
421 DBusHandlerResult result = DBUS_HANDLER_RESULT_HANDLED;
423 if (!g_strcmp0(member, "GetAll"))
424 reply = impl_prop_GetAll (message, path, pathstr);
425 else if (!g_strcmp0 (member, "Get"))
426 reply = impl_prop_GetSet (message, path, pathstr, TRUE);
427 else if (!g_strcmp0 (member, "Set"))
428 reply = impl_prop_GetSet (message, path, pathstr, FALSE);
430 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
434 dbus_connection_send (bus, reply, NULL);
435 dbus_message_unref (reply);
441 /*---------------------------------------------------------------------------*/
443 static const char *introspection_header =
444 "<?xml version=\"1.0\"?>\n";
446 static const char *introspection_node_element =
447 "<node name=\"%s\">\n";
449 static const char *introspection_footer =
452 static DBusHandlerResult
453 handle_introspection (DBusConnection *bus,
454 DBusMessage *message,
458 const gchar *pathstr)
466 _DROUTE_DEBUG ("DRoute (handle introspection): %s\n", pathstr);
468 if (g_strcmp0 (member, "Introspect"))
469 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
471 output = g_string_new(introspection_header);
473 g_string_append_printf(output, introspection_node_element, pathstr);
475 if (!path->get_datum || path_get_datum (path, pathstr))
477 for (i=0; i < path->introspection->len; i++)
479 gchar *introspect = (gchar *) g_ptr_array_index (path->introspection, i);
480 g_string_append (output, introspect);
484 if (path->introspect_children_cb)
486 gchar *children = (*path->introspect_children_cb) (pathstr, path->introspect_children_data);
489 g_string_append (output, children);
494 g_string_append(output, introspection_footer);
495 final = g_string_free(output, FALSE);
497 reply = dbus_message_new_method_return (message);
500 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final,
502 dbus_connection_send (bus, reply, NULL);
504 dbus_message_unref (reply);
506 return DBUS_HANDLER_RESULT_HANDLED;
509 /*---------------------------------------------------------------------------*/
511 static DBusHandlerResult
512 handle_other (DBusConnection *bus,
513 DBusMessage *message,
517 const gchar *pathstr)
519 gint result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
523 DBusMessage *reply = NULL;
530 _DROUTE_DEBUG ("DRoute (handle other): %s|%s on %s\n", member, iface, pathstr);
532 func = (DRouteFunction) g_hash_table_lookup (path->methods, &pair);
535 datum = path_get_datum (path, pathstr);
537 reply = droute_object_does_not_exist_error (message);
539 reply = (func) (bus, message, datum);
541 /* All D-Bus method calls must have a reply.
542 * If one is not provided presume that the caller has already
547 dbus_connection_send (bus, reply, NULL);
548 dbus_message_unref (reply);
550 result = DBUS_HANDLER_RESULT_HANDLED;
553 _DROUTE_DEBUG ("DRoute (handle other) (reply): type %d\n",
554 dbus_message_get_type(reply));
558 /*---------------------------------------------------------------------------*/
560 static DBusHandlerResult
561 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data)
563 DRoutePath *path = (DRoutePath *) user_data;
564 const gchar *iface = dbus_message_get_interface (message);
565 const gchar *member = dbus_message_get_member (message);
566 const gint type = dbus_message_get_type (message);
567 const gchar *pathstr = dbus_message_get_path (message);
569 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
571 _DROUTE_DEBUG ("DRoute (handle message): %s|%s of type %d on %s\n", member, iface, type, pathstr);
573 /* Check for basic reasons not to handle */
574 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
579 if (!strcmp (pathstr, DBUS_PATH_DBUS))
580 result = handle_dbus (bus, message, iface, member, pathstr);
581 else if (!strcmp (iface, "org.freedesktop.DBus.Properties"))
582 result = handle_properties (bus, message, path, iface, member, pathstr);
583 else if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
584 result = handle_introspection (bus, message, path, iface, member, pathstr);
586 result = handle_other (bus, message, path, iface, member, pathstr);
588 if (result == DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
589 g_print ("DRoute | Unhandled message: %s|%s of type %d on %s\n", member, iface, type, pathstr);
595 /*---------------------------------------------------------------------------*/
598 droute_object_does_not_exist_error (DBusMessage *message)
603 errmsg= g_strdup_printf (
604 "Method \"%s\" with signature \"%s\" on interface \"%s\" could not be processed as object %s does not exist\n",
605 dbus_message_get_member (message),
606 dbus_message_get_signature (message),
607 dbus_message_get_interface (message),
608 dbus_message_get_path (message));
609 #ifdef DBUS_ERROR_UNKNOWN_OBJECT
610 reply = dbus_message_new_error (message,
611 DBUS_ERROR_UNKNOWN_OBJECT,
614 reply = dbus_message_new_error (message,
622 /*---------------------------------------------------------------------------*/
625 droute_not_yet_handled_error (DBusMessage *message)
630 errmsg= g_strdup_printf (
631 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
632 dbus_message_get_member (message),
633 dbus_message_get_signature (message),
634 dbus_message_get_interface (message));
635 reply = dbus_message_new_error (message,
636 DBUS_ERROR_UNKNOWN_METHOD,
643 droute_out_of_memory_error (DBusMessage *message)
648 errmsg= g_strdup_printf (
649 "Method \"%s\" with signature \"%s\" on interface \"%s\" could not be processed due to lack of memory\n",
650 dbus_message_get_member (message),
651 dbus_message_get_signature (message),
652 dbus_message_get_interface (message));
653 reply = dbus_message_new_error (message,
654 DBUS_ERROR_NO_MEMORY,
661 droute_invalid_arguments_error (DBusMessage *message)
666 errmsg= g_strdup_printf (
667 "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
668 dbus_message_get_member (message),
669 dbus_message_get_signature (message),
670 dbus_message_get_interface (message));
671 reply = dbus_message_new_error (message,
672 DBUS_ERROR_INVALID_ARGS,
679 droute_path_register (DRoutePath *path, DBusConnection *bus)
682 dbus_connection_register_fallback (bus, path->path, &droute_vtable, path);
684 dbus_connection_register_object_path (bus, path->path,
685 &droute_vtable, path);
689 droute_path_unregister (DRoutePath *path, DBusConnection *bus)
691 dbus_connection_unregister_object_path (bus, path->path);
695 droute_context_register (DRouteContext *cnx, DBusConnection *bus)
697 g_ptr_array_foreach (cnx->registered_paths, (GFunc) droute_path_register,
702 droute_context_unregister (DRouteContext *cnx, DBusConnection *bus)
704 g_ptr_array_foreach (cnx->registered_paths, (GFunc) droute_path_unregister,
709 droute_context_deregister (DRouteContext *cnx, DBusConnection *bus)
711 g_ptr_array_foreach (cnx->registered_paths, (GFunc) droute_path_unregister,
716 droute_intercept_dbus (DBusConnection *bus)
718 dbus_connection_register_object_path (bus, DBUS_PATH_DBUS,
719 &droute_vtable, NULL);
723 droute_unintercept_dbus (DBusConnection *bus)
725 dbus_connection_unregister_object_path (bus, DBUS_PATH_DBUS);
728 /*END------------------------------------------------------------------------*/