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_dir;
52 GPtrArray *interfaces;
54 GHashTable *properties;
57 DRouteGetDatumFunction get_datum;
60 /*---------------------------------------------------------------------------*/
62 typedef struct PropertyPair
64 DRoutePropertyFunction get;
65 DRoutePropertyFunction set;
68 /*---------------------------------------------------------------------------*/
70 static DBusHandlerResult
71 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data);
73 /*---------------------------------------------------------------------------*/
76 path_new (DRouteContext *cnx,
78 DRouteGetDatumFunction get_datum)
82 new_path = g_new0 (DRoutePath, 1);
84 new_path->chunks = g_string_chunk_new (CHUNKS_DEFAULT);
85 new_path->interfaces = g_ptr_array_new ();
87 new_path->methods = g_hash_table_new_full ((GHashFunc)str_pair_hash,
92 new_path->properties = g_hash_table_new_full ((GHashFunc)str_pair_hash,
97 new_path->user_data = user_data;
98 new_path->get_datum = get_datum;
104 path_free (DRoutePath *path, gpointer user_data)
106 g_string_chunk_free (path->chunks);
107 g_ptr_array_free (path->interfaces, TRUE);
108 g_hash_table_destroy (path->methods);
109 g_hash_table_destroy (path->properties);
113 path_get_datum (DRoutePath *path, const gchar *pathstr)
115 if (path->get_datum != NULL)
116 return (path->get_datum) (pathstr, path->user_data);
118 return path->user_data;
121 /*---------------------------------------------------------------------------*/
124 droute_new (DBusConnection *bus, const char *introspect_dir)
128 cnx = g_new0 (DRouteContext, 1);
130 cnx->registered_paths = g_ptr_array_new ();
131 cnx->introspect_dir = g_strdup(introspect_dir);
137 droute_free (DRouteContext *cnx)
139 g_ptr_array_foreach (cnx->registered_paths, (GFunc) path_free, NULL);
140 g_free (cnx->introspect_dir);
144 /*---------------------------------------------------------------------------*/
147 droute_get_bus (DRouteContext *cnx)
152 /*---------------------------------------------------------------------------*/
154 static DBusObjectPathVTable droute_vtable =
158 NULL, NULL, NULL, NULL
162 droute_add_one (DRouteContext *cnx,
166 DRoutePath *new_path;
169 new_path = path_new (cnx, (void *) data, NULL);
171 registered = dbus_connection_register_object_path (cnx->bus, path, &droute_vtable, new_path);
175 g_ptr_array_add (cnx->registered_paths, new_path);
180 droute_add_many (DRouteContext *cnx,
183 const DRouteGetDatumFunction get_datum)
185 DRoutePath *new_path;
187 new_path = path_new (cnx, (void *) data, get_datum);
189 if (!dbus_connection_register_fallback (cnx->bus, path, &droute_vtable, new_path))
192 g_ptr_array_add (cnx->registered_paths, new_path);
196 /*---------------------------------------------------------------------------*/
199 droute_path_add_interface(DRoutePath *path,
201 const DRouteMethod *methods,
202 const DRouteProperty *properties)
206 g_return_if_fail (name != NULL);
208 itf = g_string_chunk_insert (path->chunks, name);
209 g_ptr_array_add (path->interfaces, itf);
211 for (; methods != NULL && methods->name != NULL; methods++)
215 meth = g_string_chunk_insert (path->chunks, methods->name);
216 g_hash_table_insert (path->methods, str_pair_new (itf, meth), methods->func);
219 for (; properties != NULL && properties->name != NULL; properties++)
224 prop = g_string_chunk_insert (path->chunks, properties->name);
225 pair = g_new (PropertyPair, 1);
226 pair->get = properties->get;
227 pair->set = properties->set;
228 g_hash_table_insert (path->properties, str_pair_new (itf, prop), pair);
232 /*---------------------------------------------------------------------------*/
234 /* The data structures don't support an efficient implementation of GetAll
235 * and I don't really care.
238 impl_prop_GetAll (DBusMessage *message,
242 DBusMessageIter iter, iter_dict, iter_dict_entry;
245 GHashTableIter prop_iter;
251 void *datum = path_get_datum (path, pathstr);
255 dbus_error_init (&error);
256 if (!dbus_message_get_args
257 (message, &error, DBUS_TYPE_STRING, &iface, DBUS_TYPE_INVALID))
258 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
260 reply = dbus_message_new_method_return (message);
264 dbus_message_iter_init_append (reply, &iter);
265 if (!dbus_message_iter_open_container
266 (&iter, DBUS_TYPE_ARRAY, "{sv}", &iter_dict))
269 g_hash_table_iter_init (&prop_iter, path->properties);
270 while (g_hash_table_iter_next (&prop_iter, (gpointer*)&key, (gpointer*)&value))
272 if (!g_strcmp0 (key->one, iface))
276 if (!dbus_message_iter_open_container
277 (&iter_dict, DBUS_TYPE_DICT_ENTRY, NULL, &iter_dict_entry))
279 dbus_message_iter_append_basic (&iter_dict_entry, DBUS_TYPE_STRING,
281 (value->get) (&iter_dict_entry, datum);
282 if (!dbus_message_iter_close_container (&iter_dict, &iter_dict_entry))
287 if (!dbus_message_iter_close_container (&iter, &iter_dict))
293 impl_prop_GetSet (DBusMessage *message,
298 DBusMessage *reply = NULL;
302 PropertyPair *prop_funcs = NULL;
306 dbus_error_init (&error);
307 if (!dbus_message_get_args (message,
314 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
316 _DROUTE_DEBUG ("DRoute (handle prop): %s|%s on %s\n", pair.one, pair.two, pathstr);
318 prop_funcs = (PropertyPair *) g_hash_table_lookup (path->properties, &pair);
320 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
322 datum = path_get_datum (path, pathstr);
326 if (get && prop_funcs->get)
329 DBusMessageIter iter;
331 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
333 reply = dbus_message_new_method_return (message);
334 dbus_message_iter_init_append (reply, &iter);
335 if (!(prop_funcs->get) (&iter, datum))
337 dbus_message_unref (reply);
338 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Get failed");
341 else if (!get && prop_funcs->set)
343 DBusMessageIter iter;
345 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
347 dbus_message_iter_init (message, &iter);
348 /* Skip the interface and property name */
349 dbus_message_iter_next(&iter);
350 dbus_message_iter_next(&iter);
351 (prop_funcs->set) (&iter, datum);
353 reply = dbus_message_new_method_return (message);
357 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Getter or setter unavailable");
363 static DBusHandlerResult
364 handle_properties (DBusConnection *bus,
365 DBusMessage *message,
369 const gchar *pathstr)
372 DBusHandlerResult result = DBUS_HANDLER_RESULT_HANDLED;
374 if (!g_strcmp0(member, "GetAll"))
375 reply = impl_prop_GetAll (message, path, pathstr);
376 else if (!g_strcmp0 (member, "Get"))
377 reply = impl_prop_GetSet (message, path, pathstr, TRUE);
378 else if (!g_strcmp0 (member, "Set"))
379 reply = impl_prop_GetSet (message, path, pathstr, FALSE);
381 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
385 dbus_connection_send (bus, reply, NULL);
386 dbus_message_unref (reply);
392 /*---------------------------------------------------------------------------*/
394 static const char *introspection_header =
395 "<?xml version=\"1.0\"?>\n";
397 static const char *introspection_node_element =
398 "<node name=\"%s\">\n";
400 static const char *introspection_footer =
404 append_interface (GString *str,
405 const gchar *interface,
406 const gchar *directory)
414 filename = g_build_filename (directory, interface, NULL);
416 if (g_file_get_contents (filename, &contents, &len, &err))
418 g_string_append_len (str, contents, len);
422 g_warning ("AT-SPI: Cannot find introspection XML file %s - %s",
423 filename, err->message);
427 g_string_append (str, "\n");
432 static DBusHandlerResult
433 handle_introspection (DBusConnection *bus,
434 DBusMessage *message,
438 const gchar *pathstr)
446 _DROUTE_DEBUG ("DRoute (handle introspection): %s\n", pathstr);
448 if (g_strcmp0 (member, "Introspect"))
449 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
451 output = g_string_new(introspection_header);
453 g_string_append_printf(output, introspection_node_element, pathstr);
455 for (i=0; i < path->interfaces->len; i++)
457 gchar *interface = (gchar *) g_ptr_array_index (path->interfaces, i);
458 _DROUTE_DEBUG ("DRoute (appending interface): %s\n", interface);
459 append_interface(output, interface, path->cnx->introspect_dir);
462 g_string_append(output, introspection_footer);
463 final = g_string_free(output, FALSE);
465 reply = dbus_message_new_method_return (message);
468 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final,
470 dbus_connection_send (bus, reply, NULL);
472 dbus_message_unref (reply);
474 return DBUS_HANDLER_RESULT_HANDLED;
477 /*---------------------------------------------------------------------------*/
479 static DBusHandlerResult
480 handle_other (DBusConnection *bus,
481 DBusMessage *message,
485 const gchar *pathstr)
487 gint result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
491 DBusMessage *reply = NULL;
498 _DROUTE_DEBUG ("DRoute (handle other): %s|%s on %s\n", member, iface, pathstr);
500 datum = path_get_datum (path, pathstr);
504 func = (DRouteFunction) g_hash_table_lookup (path->methods, &pair);
508 reply = (func) (bus, message, datum);
512 /* All D-Bus method calls must have a reply.
513 * If one is not provided presume that the call has a void
514 * return and no error has occured.
516 reply = dbus_message_new_method_return (message);
518 dbus_connection_send (bus, reply, NULL);
519 dbus_message_unref (reply);
520 result = DBUS_HANDLER_RESULT_HANDLED;
523 _DROUTE_DEBUG ("DRoute (handle other) (reply): type %d\n",
524 dbus_message_get_type(reply));
528 /*---------------------------------------------------------------------------*/
530 static DBusHandlerResult
531 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data)
533 DRoutePath *path = (DRoutePath *) user_data;
534 const gchar *iface = dbus_message_get_interface (message);
535 const gchar *member = dbus_message_get_member (message);
536 const gint type = dbus_message_get_type (message);
537 const gchar *pathstr = dbus_message_get_path (message);
539 _DROUTE_DEBUG ("DRoute (handle message): %s|%s of type %d on %s\n", member, iface, type, pathstr);
541 /* Check for basic reasons not to handle */
542 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
545 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
547 if (!strcmp (iface, "org.freedesktop.DBus.Properties"))
548 return handle_properties (bus, message, path, iface, member, pathstr);
550 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
551 return handle_introspection (bus, message, path, iface, member, pathstr);
553 return handle_other (bus, message, path, iface, member, pathstr);
556 /*---------------------------------------------------------------------------*/
559 droute_not_yet_handled_error (DBusMessage *message)
564 errmsg= g_strdup_printf (
565 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
566 dbus_message_get_member (message),
567 dbus_message_get_signature (message),
568 dbus_message_get_interface (message));
569 reply = dbus_message_new_error (message,
570 DBUS_ERROR_UNKNOWN_METHOD,
577 droute_out_of_memory_error (DBusMessage *message)
582 errmsg= g_strdup_printf (
583 "Method \"%s\" with signature \"%s\" on interface \"%s\" could not be processed due to lack of memory\n",
584 dbus_message_get_member (message),
585 dbus_message_get_signature (message),
586 dbus_message_get_interface (message));
587 reply = dbus_message_new_error (message,
588 DBUS_ERROR_NO_MEMORY,
595 droute_invalid_arguments_error (DBusMessage *message)
600 errmsg= g_strdup_printf (
601 "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
602 dbus_message_get_member (message),
603 dbus_message_get_signature (message),
604 dbus_message_get_interface (message));
605 reply = dbus_message_new_error (message,
606 DBUS_ERROR_INVALID_ARGS,
612 /*END------------------------------------------------------------------------*/