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);
179 g_ptr_array_add (cnx->registered_paths, new_path);
184 droute_add_many (DRouteContext *cnx,
187 const DRouteGetDatumFunction get_datum)
189 DRoutePath *new_path;
191 new_path = path_new (cnx, (void *) data, get_datum);
193 if (!dbus_connection_register_fallback (cnx->bus, path, &droute_vtable, new_path))
196 g_ptr_array_add (cnx->registered_paths, new_path);
200 /*---------------------------------------------------------------------------*/
203 droute_path_add_interface(DRoutePath *path,
205 const char *introspect,
206 const DRouteMethod *methods,
207 const DRouteProperty *properties)
211 g_return_if_fail (name != NULL);
213 itf = g_string_chunk_insert (path->chunks, name);
214 g_ptr_array_add (path->interfaces, itf);
215 g_ptr_array_add (path->introspection, introspect);
217 for (; methods != NULL && methods->name != NULL; methods++)
221 meth = g_string_chunk_insert (path->chunks, methods->name);
222 g_hash_table_insert (path->methods, str_pair_new (itf, meth), methods->func);
225 for (; properties != NULL && properties->name != NULL; properties++)
230 prop = g_string_chunk_insert (path->chunks, properties->name);
231 pair = g_new (PropertyPair, 1);
232 pair->get = properties->get;
233 pair->set = properties->set;
234 g_hash_table_insert (path->properties, str_pair_new (itf, prop), pair);
238 /*---------------------------------------------------------------------------*/
240 /* The data structures don't support an efficient implementation of GetAll
241 * and I don't really care.
244 impl_prop_GetAll (DBusMessage *message,
248 DBusMessageIter iter, iter_dict, iter_dict_entry;
251 GHashTableIter prop_iter;
257 void *datum = path_get_datum (path, pathstr);
259 return droute_object_does_not_exist_error (message);
261 dbus_error_init (&error);
262 if (!dbus_message_get_args
263 (message, &error, DBUS_TYPE_STRING, &iface, DBUS_TYPE_INVALID))
264 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
266 reply = dbus_message_new_method_return (message);
270 dbus_message_iter_init_append (reply, &iter);
271 if (!dbus_message_iter_open_container
272 (&iter, DBUS_TYPE_ARRAY, "{sv}", &iter_dict))
275 g_hash_table_iter_init (&prop_iter, path->properties);
276 while (g_hash_table_iter_next (&prop_iter, (gpointer*)&key, (gpointer*)&value))
278 if (!g_strcmp0 (key->one, iface))
282 if (!dbus_message_iter_open_container
283 (&iter_dict, DBUS_TYPE_DICT_ENTRY, NULL, &iter_dict_entry))
285 dbus_message_iter_append_basic (&iter_dict_entry, DBUS_TYPE_STRING,
287 (value->get) (&iter_dict_entry, datum);
288 if (!dbus_message_iter_close_container (&iter_dict, &iter_dict_entry))
293 if (!dbus_message_iter_close_container (&iter, &iter_dict))
299 impl_prop_GetSet (DBusMessage *message,
304 DBusMessage *reply = NULL;
308 PropertyPair *prop_funcs = NULL;
312 dbus_error_init (&error);
313 if (!dbus_message_get_args (message,
320 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
322 _DROUTE_DEBUG ("DRoute (handle prop): %s|%s on %s\n", pair.one, pair.two, pathstr);
324 prop_funcs = (PropertyPair *) g_hash_table_lookup (path->properties, &pair);
326 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
328 datum = path_get_datum (path, pathstr);
330 return droute_object_does_not_exist_error (message);
332 if (get && prop_funcs->get)
335 DBusMessageIter iter;
337 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
339 reply = dbus_message_new_method_return (message);
340 dbus_message_iter_init_append (reply, &iter);
341 if (!(prop_funcs->get) (&iter, datum))
343 dbus_message_unref (reply);
344 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Get failed");
347 else if (!get && prop_funcs->set)
349 DBusMessageIter iter;
351 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
353 dbus_message_iter_init (message, &iter);
354 /* Skip the interface and property name */
355 dbus_message_iter_next(&iter);
356 dbus_message_iter_next(&iter);
357 (prop_funcs->set) (&iter, datum);
359 reply = dbus_message_new_method_return (message);
363 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Getter or setter unavailable");
369 static DBusHandlerResult
370 handle_properties (DBusConnection *bus,
371 DBusMessage *message,
375 const gchar *pathstr)
378 DBusHandlerResult result = DBUS_HANDLER_RESULT_HANDLED;
380 if (!g_strcmp0(member, "GetAll"))
381 reply = impl_prop_GetAll (message, path, pathstr);
382 else if (!g_strcmp0 (member, "Get"))
383 reply = impl_prop_GetSet (message, path, pathstr, TRUE);
384 else if (!g_strcmp0 (member, "Set"))
385 reply = impl_prop_GetSet (message, path, pathstr, FALSE);
387 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
391 dbus_connection_send (bus, reply, NULL);
392 dbus_message_unref (reply);
398 /*---------------------------------------------------------------------------*/
400 static const char *introspection_header =
401 "<?xml version=\"1.0\"?>\n";
403 static const char *introspection_node_element =
404 "<node name=\"%s\">\n";
406 static const char *introspection_footer =
409 static DBusHandlerResult
410 handle_introspection (DBusConnection *bus,
411 DBusMessage *message,
415 const gchar *pathstr)
423 _DROUTE_DEBUG ("DRoute (handle introspection): %s\n", pathstr);
425 if (g_strcmp0 (member, "Introspect"))
426 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
428 output = g_string_new(introspection_header);
430 g_string_append_printf(output, introspection_node_element, pathstr);
432 for (i=0; i < path->introspection->len; i++)
434 gchar *introspect = (gchar *) g_ptr_array_index (path->introspection, i);
435 g_string_append (output, introspect);
438 g_string_append(output, introspection_footer);
439 final = g_string_free(output, FALSE);
441 reply = dbus_message_new_method_return (message);
444 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final,
446 dbus_connection_send (bus, reply, NULL);
448 dbus_message_unref (reply);
450 return DBUS_HANDLER_RESULT_HANDLED;
453 /*---------------------------------------------------------------------------*/
455 static DBusHandlerResult
456 handle_other (DBusConnection *bus,
457 DBusMessage *message,
461 const gchar *pathstr)
463 gint result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
467 DBusMessage *reply = NULL;
474 _DROUTE_DEBUG ("DRoute (handle other): %s|%s on %s\n", member, iface, pathstr);
476 func = (DRouteFunction) g_hash_table_lookup (path->methods, &pair);
479 datum = path_get_datum (path, pathstr);
481 reply = droute_object_does_not_exist_error (message);
483 reply = (func) (bus, message, datum);
487 /* All D-Bus method calls must have a reply.
488 * If one is not provided presume that the call has a void
489 * return and no error has occured.
491 reply = dbus_message_new_method_return (message);
493 dbus_connection_send (bus, reply, NULL);
494 dbus_message_unref (reply);
495 result = DBUS_HANDLER_RESULT_HANDLED;
498 _DROUTE_DEBUG ("DRoute (handle other) (reply): type %d\n",
499 dbus_message_get_type(reply));
503 /*---------------------------------------------------------------------------*/
505 static DBusHandlerResult
506 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data)
508 DRoutePath *path = (DRoutePath *) user_data;
509 const gchar *iface = dbus_message_get_interface (message);
510 const gchar *member = dbus_message_get_member (message);
511 const gint type = dbus_message_get_type (message);
512 const gchar *pathstr = dbus_message_get_path (message);
514 DBusHandlerResult result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
516 _DROUTE_DEBUG ("DRoute (handle message): %s|%s of type %d on %s\n", member, iface, type, pathstr);
518 /* Check for basic reasons not to handle */
519 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
524 if (!strcmp (iface, "org.freedesktop.DBus.Properties"))
525 result = handle_properties (bus, message, path, iface, member, pathstr);
526 else if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
527 result = handle_introspection (bus, message, path, iface, member, pathstr);
529 result = handle_other (bus, message, path, iface, member, pathstr);
531 if (result == DBUS_HANDLER_RESULT_NOT_YET_HANDLED)
532 g_print ("DRoute | Unhandled message: %s|%s of type %d on %s\n", member, iface, type, pathstr);
538 /*---------------------------------------------------------------------------*/
541 droute_object_does_not_exist_error (DBusMessage *message)
546 errmsg= g_strdup_printf (
547 "Method \"%s\" with signature \"%s\" on interface \"%s\" could not be processed as object %s does not exist\n",
548 dbus_message_get_member (message),
549 dbus_message_get_signature (message),
550 dbus_message_get_interface (message),
551 dbus_message_get_path (message));
552 reply = dbus_message_new_error (message,
559 /*---------------------------------------------------------------------------*/
562 droute_not_yet_handled_error (DBusMessage *message)
567 errmsg= g_strdup_printf (
568 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
569 dbus_message_get_member (message),
570 dbus_message_get_signature (message),
571 dbus_message_get_interface (message));
572 reply = dbus_message_new_error (message,
573 DBUS_ERROR_UNKNOWN_METHOD,
580 droute_out_of_memory_error (DBusMessage *message)
585 errmsg= g_strdup_printf (
586 "Method \"%s\" with signature \"%s\" on interface \"%s\" could not be processed due to lack of memory\n",
587 dbus_message_get_member (message),
588 dbus_message_get_signature (message),
589 dbus_message_get_interface (message));
590 reply = dbus_message_new_error (message,
591 DBUS_ERROR_NO_MEMORY,
598 droute_invalid_arguments_error (DBusMessage *message)
603 errmsg= g_strdup_printf (
604 "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
605 dbus_message_get_member (message),
606 dbus_message_get_signature (message),
607 dbus_message_get_interface (message));
608 reply = dbus_message_new_error (message,
609 DBUS_ERROR_INVALID_ARGS,
615 /*END------------------------------------------------------------------------*/