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.
28 #include "droute-pairhash.h"
30 #define CHUNKS_DEFAULT (512)
32 #define oom() g_error ("D-Bus out of memory, this message will fail anyway")
34 #if defined DROUTE_DEBUG
35 #define _DROUTE_DEBUG(format, args...) g_print (format , ## args)
37 #define _DROUTE_DEBUG(format, args...)
43 GPtrArray *registered_paths;
45 gchar *introspect_string;
52 GPtrArray *interfaces;
53 GPtrArray *introspection;
55 GHashTable *properties;
58 DRouteGetDatumFunction get_datum;
61 /*---------------------------------------------------------------------------*/
63 typedef struct PropertyPair
65 DRoutePropertyFunction get;
66 DRoutePropertyFunction set;
69 /*---------------------------------------------------------------------------*/
71 static DBusHandlerResult
72 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data);
75 droute_object_does_not_exist_error (DBusMessage *message);
77 /*---------------------------------------------------------------------------*/
80 path_new (DRouteContext *cnx,
82 DRouteGetDatumFunction get_datum)
86 new_path = g_new0 (DRoutePath, 1);
88 new_path->chunks = g_string_chunk_new (CHUNKS_DEFAULT);
89 new_path->interfaces = g_ptr_array_new ();
90 new_path->introspection = g_ptr_array_new ();
92 new_path->methods = g_hash_table_new_full ((GHashFunc)str_pair_hash,
97 new_path->properties = g_hash_table_new_full ((GHashFunc)str_pair_hash,
102 new_path->user_data = user_data;
103 new_path->get_datum = get_datum;
109 path_free (DRoutePath *path, gpointer user_data)
111 g_string_chunk_free (path->chunks);
112 g_ptr_array_free (path->interfaces, TRUE);
113 g_ptr_array_free (path->introspection, FALSE);
114 g_hash_table_destroy (path->methods);
115 g_hash_table_destroy (path->properties);
119 path_get_datum (DRoutePath *path, const gchar *pathstr)
121 if (path->get_datum != NULL)
122 return (path->get_datum) (pathstr, path->user_data);
124 return path->user_data;
127 /*---------------------------------------------------------------------------*/
130 droute_new (DBusConnection *bus)
134 cnx = g_new0 (DRouteContext, 1);
136 cnx->registered_paths = g_ptr_array_new ();
142 droute_free (DRouteContext *cnx)
144 g_ptr_array_foreach (cnx->registered_paths, (GFunc) path_free, NULL);
148 /*---------------------------------------------------------------------------*/
151 droute_get_bus (DRouteContext *cnx)
156 /*---------------------------------------------------------------------------*/
158 static DBusObjectPathVTable droute_vtable =
162 NULL, NULL, NULL, NULL
166 droute_add_one (DRouteContext *cnx,
170 DRoutePath *new_path;
173 new_path = path_new (cnx, (void *) data, NULL);
175 registered = dbus_connection_register_object_path (cnx->bus, path, &droute_vtable, new_path);
178 path_free (new_path, NULL);
182 g_ptr_array_add (cnx->registered_paths, new_path);
187 droute_add_many (DRouteContext *cnx,
190 const DRouteGetDatumFunction get_datum)
192 DRoutePath *new_path;
194 new_path = path_new (cnx, (void *) data, get_datum);
196 if (!dbus_connection_register_fallback (cnx->bus, path, &droute_vtable, new_path))
199 g_ptr_array_add (cnx->registered_paths, new_path);
203 /*---------------------------------------------------------------------------*/
206 droute_path_add_interface(DRoutePath *path,
208 const char *introspect,
209 const DRouteMethod *methods,
210 const DRouteProperty *properties)
214 g_return_if_fail (name != NULL);
216 itf = g_string_chunk_insert (path->chunks, name);
217 g_ptr_array_add (path->interfaces, itf);
218 g_ptr_array_add (path->introspection, introspect);
220 for (; methods != NULL && methods->name != NULL; methods++)
224 meth = g_string_chunk_insert (path->chunks, methods->name);
225 g_hash_table_insert (path->methods, str_pair_new (itf, meth), methods->func);
228 for (; properties != NULL && properties->name != NULL; properties++)
233 prop = g_string_chunk_insert (path->chunks, properties->name);
234 pair = g_new (PropertyPair, 1);
235 pair->get = properties->get;
236 pair->set = properties->set;
237 g_hash_table_insert (path->properties, str_pair_new (itf, prop), pair);
241 /*---------------------------------------------------------------------------*/
243 /* The data structures don't support an efficient implementation of GetAll
244 * and I don't really care.
247 impl_prop_GetAll (DBusMessage *message,
251 DBusMessageIter iter, iter_dict, iter_dict_entry;
254 GHashTableIter prop_iter;
260 void *datum = path_get_datum (path, pathstr);
262 return droute_object_does_not_exist_error (message);
264 dbus_error_init (&error);
265 if (!dbus_message_get_args
266 (message, &error, DBUS_TYPE_STRING, &iface, DBUS_TYPE_INVALID))
267 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
269 reply = dbus_message_new_method_return (message);
273 dbus_message_iter_init_append (reply, &iter);
274 if (!dbus_message_iter_open_container
275 (&iter, DBUS_TYPE_ARRAY, "{sv}", &iter_dict))
278 g_hash_table_iter_init (&prop_iter, path->properties);
279 while (g_hash_table_iter_next (&prop_iter, (gpointer*)&key, (gpointer*)&value))
281 if (!g_strcmp0 (key->one, iface))
285 if (!dbus_message_iter_open_container
286 (&iter_dict, DBUS_TYPE_DICT_ENTRY, NULL, &iter_dict_entry))
288 dbus_message_iter_append_basic (&iter_dict_entry, DBUS_TYPE_STRING,
290 (value->get) (&iter_dict_entry, datum);
291 if (!dbus_message_iter_close_container (&iter_dict, &iter_dict_entry))
296 if (!dbus_message_iter_close_container (&iter, &iter_dict))
302 impl_prop_GetSet (DBusMessage *message,
307 DBusMessage *reply = NULL;
311 PropertyPair *prop_funcs = NULL;
315 dbus_error_init (&error);
316 if (!dbus_message_get_args (message,
323 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
325 _DROUTE_DEBUG ("DRoute (handle prop): %s|%s on %s\n", pair.one, pair.two, pathstr);
327 prop_funcs = (PropertyPair *) g_hash_table_lookup (path->properties, &pair);
329 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
331 datum = path_get_datum (path, pathstr);
333 return droute_object_does_not_exist_error (message);
335 if (get && prop_funcs->get)
338 DBusMessageIter iter;
340 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
342 reply = dbus_message_new_method_return (message);
343 dbus_message_iter_init_append (reply, &iter);
344 if (!(prop_funcs->get) (&iter, datum))
346 dbus_message_unref (reply);
347 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Get failed");
350 else if (!get && prop_funcs->set)
352 DBusMessageIter iter;
354 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
356 dbus_message_iter_init (message, &iter);
357 /* Skip the interface and property name */
358 dbus_message_iter_next(&iter);
359 dbus_message_iter_next(&iter);
360 (prop_funcs->set) (&iter, datum);
362 reply = dbus_message_new_method_return (message);
366 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Getter or setter unavailable");
372 static DBusHandlerResult
373 handle_properties (DBusConnection *bus,
374 DBusMessage *message,
378 const gchar *pathstr)
381 DBusHandlerResult result = DBUS_HANDLER_RESULT_HANDLED;
383 if (!g_strcmp0(member, "GetAll"))
384 reply = impl_prop_GetAll (message, path, pathstr);
385 else if (!g_strcmp0 (member, "Get"))
386 reply = impl_prop_GetSet (message, path, pathstr, TRUE);
387 else if (!g_strcmp0 (member, "Set"))
388 reply = impl_prop_GetSet (message, path, pathstr, FALSE);
390 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
394 dbus_connection_send (bus, reply, NULL);
395 dbus_message_unref (reply);
401 /*---------------------------------------------------------------------------*/
403 static const char *introspection_header =
404 "<?xml version=\"1.0\"?>\n";
406 static const char *introspection_node_element =
407 "<node name=\"%s\">\n";
409 static const char *introspection_footer =
412 static DBusHandlerResult
413 handle_introspection (DBusConnection *bus,
414 DBusMessage *message,
418 const gchar *pathstr)
426 _DROUTE_DEBUG ("DRoute (handle introspection): %s\n", pathstr);
428 if (g_strcmp0 (member, "Introspect"))
429 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
431 output = g_string_new(introspection_header);
433 g_string_append_printf(output, introspection_node_element, pathstr);
435 for (i=0; i < path->introspection->len; i++)
437 gchar *introspect = (gchar *) g_ptr_array_index (path->introspection, i);
438 g_string_append (output, introspect);
441 g_string_append(output, introspection_footer);
442 final = g_string_free(output, FALSE);
444 reply = dbus_message_new_method_return (message);
447 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final,
449 dbus_connection_send (bus, reply, NULL);
451 dbus_message_unref (reply);
453 return DBUS_HANDLER_RESULT_HANDLED;
456 /*---------------------------------------------------------------------------*/
458 static DBusHandlerResult
459 handle_other (DBusConnection *bus,
460 DBusMessage *message,
464 const gchar *pathstr)
466 gint result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
470 DBusMessage *reply = NULL;
477 _DROUTE_DEBUG ("DRoute (handle other): %s|%s on %s\n", member, iface, pathstr);
479 func = (DRouteFunction) g_hash_table_lookup (path->methods, &pair);
482 datum = path_get_datum (path, pathstr);
484 reply = droute_object_does_not_exist_error (message);
486 reply = (func) (bus, message, datum);
490 /* All D-Bus method calls must have a reply.
491 * If one is not provided presume that the call has a void
492 * return and no error has occured.
494 reply = dbus_message_new_method_return (message);
496 dbus_connection_send (bus, reply, NULL);
497 dbus_message_unref (reply);
498 result = DBUS_HANDLER_RESULT_HANDLED;
501 _DROUTE_DEBUG ("DRoute (handle other) (reply): type %d\n",
502 dbus_message_get_type(reply));
506 /*---------------------------------------------------------------------------*/
508 static DBusHandlerResult
509 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data)
511 DRoutePath *path = (DRoutePath *) user_data;
512 const gchar *iface = dbus_message_get_interface (message);
513 const gchar *member = dbus_message_get_member (message);
514 const gint type = dbus_message_get_type (message);
515 const gchar *pathstr = dbus_message_get_path (message);
517 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
519 _DROUTE_DEBUG ("DRoute (handle message): %s|%s of type %d on %s\n", member, iface, type, pathstr);
521 /* Check for basic reasons not to handle */
522 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
527 if (!strcmp (iface, "org.freedesktop.DBus.Properties"))
528 result = handle_properties (bus, message, path, iface, member, pathstr);
529 else if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
530 result = handle_introspection (bus, message, path, iface, member, pathstr);
532 result = handle_other (bus, message, path, iface, member, pathstr);
534 if (result == DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
535 g_print ("DRoute | Unhandled message: %s|%s of type %d on %s\n", member, iface, type, pathstr);
541 /*---------------------------------------------------------------------------*/
544 droute_object_does_not_exist_error (DBusMessage *message)
549 errmsg= g_strdup_printf (
550 "Method \"%s\" with signature \"%s\" on interface \"%s\" could not be processed as object %s does not exist\n",
551 dbus_message_get_member (message),
552 dbus_message_get_signature (message),
553 dbus_message_get_interface (message),
554 dbus_message_get_path (message));
555 reply = dbus_message_new_error (message,
562 /*---------------------------------------------------------------------------*/
565 droute_not_yet_handled_error (DBusMessage *message)
570 errmsg= g_strdup_printf (
571 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
572 dbus_message_get_member (message),
573 dbus_message_get_signature (message),
574 dbus_message_get_interface (message));
575 reply = dbus_message_new_error (message,
576 DBUS_ERROR_UNKNOWN_METHOD,
583 droute_out_of_memory_error (DBusMessage *message)
588 errmsg= g_strdup_printf (
589 "Method \"%s\" with signature \"%s\" on interface \"%s\" could not be processed due to lack of memory\n",
590 dbus_message_get_member (message),
591 dbus_message_get_signature (message),
592 dbus_message_get_interface (message));
593 reply = dbus_message_new_error (message,
594 DBUS_ERROR_NO_MEMORY,
601 droute_invalid_arguments_error (DBusMessage *message)
606 errmsg= g_strdup_printf (
607 "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
608 dbus_message_get_member (message),
609 dbus_message_get_signature (message),
610 dbus_message_get_interface (message));
611 reply = dbus_message_new_error (message,
612 DBUS_ERROR_INVALID_ARGS,
618 /*END------------------------------------------------------------------------*/