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)
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);
135 droute_free (DRouteContext *cnx)
137 g_ptr_array_foreach (cnx->registered_paths, (GFunc) path_free, NULL);
138 g_free (cnx->introspect_dir);
142 /*---------------------------------------------------------------------------*/
145 droute_get_bus (DRouteContext *cnx)
150 /*---------------------------------------------------------------------------*/
152 static DBusObjectPathVTable droute_vtable =
156 NULL, NULL, NULL, NULL
160 droute_add_one (DRouteContext *cnx,
164 DRoutePath *new_path;
166 new_path = path_new (cnx, (void *) data, NULL);
168 if (!dbus_connection_register_object_path (cnx->bus, path, &droute_vtable, new_path))
171 g_ptr_array_add (cnx->registered_paths, new_path);
176 droute_add_many (DRouteContext *cnx,
179 const DRouteGetDatumFunction get_datum)
181 DRoutePath *new_path;
183 new_path = path_new (cnx, (void *) data, get_datum);
185 if (!dbus_connection_register_fallback (cnx->bus, path, &droute_vtable, new_path))
188 g_ptr_array_add (cnx->registered_paths, new_path);
192 /*---------------------------------------------------------------------------*/
195 droute_path_add_interface(DRoutePath *path,
197 const DRouteMethod *methods,
198 const DRouteProperty *properties)
202 g_return_if_fail (name != NULL);
204 itf = g_string_chunk_insert (path->chunks, name);
205 g_ptr_array_add (path->interfaces, itf);
207 for (; methods != NULL && methods->name != NULL; methods++)
211 meth = g_string_chunk_insert (path->chunks, methods->name);
212 g_hash_table_insert (path->methods, str_pair_new (itf, meth), methods->func);
215 for (; properties != NULL && properties->name != NULL; properties++)
220 prop = g_string_chunk_insert (path->chunks, properties->name);
221 pair = g_new (PropertyPair, 1);
222 pair->get = properties->get;
223 pair->set = properties->set;
224 g_hash_table_insert (path->properties, str_pair_new (itf, prop), pair);
228 /*---------------------------------------------------------------------------*/
230 /* The data structures don't support an efficient implementation of GetAll
231 * and I don't really care.
234 impl_prop_GetAll (DBusMessage *message,
238 DBusMessageIter iter, iter_dict, iter_dict_entry;
241 GHashTableIter prop_iter;
247 void *datum = path_get_datum (path, pathstr);
249 dbus_error_init (&error);
250 if (!dbus_message_get_args
251 (message, &error, DBUS_TYPE_STRING, &iface, DBUS_TYPE_INVALID))
252 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
254 reply = dbus_message_new_method_return (message);
258 dbus_message_iter_init_append (reply, &iter);
259 if (!dbus_message_iter_open_container
260 (&iter, DBUS_TYPE_ARRAY, "{sv}", &iter_dict))
263 g_hash_table_iter_init (&prop_iter, path->properties);
264 while (g_hash_table_iter_next (&prop_iter, (gpointer*)&key, (gpointer*)&value))
266 if (!g_strcmp0 (key->one, iface))
270 if (!dbus_message_iter_open_container
271 (&iter_dict, DBUS_TYPE_DICT_ENTRY, NULL, &iter_dict_entry))
273 dbus_message_iter_append_basic (&iter_dict_entry, DBUS_TYPE_STRING,
275 (value->get) (&iter_dict_entry, datum);
276 if (!dbus_message_iter_close_container (&iter_dict, &iter_dict_entry))
281 if (!dbus_message_iter_close_container (&iter, &iter_dict))
287 impl_prop_GetSet (DBusMessage *message,
292 DBusMessage *reply = NULL;
296 PropertyPair *prop_funcs = NULL;
299 dbus_error_init (&error);
300 if (!dbus_message_get_args (message,
307 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
309 prop_funcs = (PropertyPair *) g_hash_table_lookup (path->properties, &pair);
311 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
313 if (get && prop_funcs->get)
315 void *datum = path_get_datum (path, pathstr);
316 DBusMessageIter iter;
318 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
320 reply = dbus_message_new_method_return (message);
321 dbus_message_iter_init_append (reply, &iter);
322 (prop_funcs->get) (&iter, datum);
324 else if (!get && prop_funcs->set)
326 void *datum = path_get_datum (path, pathstr);
327 DBusMessageIter iter;
329 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
331 dbus_message_iter_init_append (message, &iter);
332 /* Skip the interface and property name */
333 dbus_message_iter_next(&iter);
334 dbus_message_iter_next(&iter);
335 (prop_funcs->set) (&iter, datum);
337 reply = dbus_message_new_method_return (message);
341 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Getter or setter unavailable");
347 static DBusHandlerResult
348 handle_properties (DBusConnection *bus,
349 DBusMessage *message,
353 const gchar *pathstr)
356 DBusHandlerResult result = DBUS_HANDLER_RESULT_HANDLED;
358 if (!g_strcmp0(member, "GetAll"))
359 reply = impl_prop_GetAll (message, path, pathstr);
360 else if (!g_strcmp0 (member, "Get"))
361 reply = impl_prop_GetSet (message, path, pathstr, TRUE);
362 else if (!g_strcmp0 (member, "Set"))
363 reply = impl_prop_GetSet (message, path, pathstr, FALSE);
365 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
369 dbus_connection_send (bus, reply, NULL);
370 dbus_message_unref (reply);
376 /*---------------------------------------------------------------------------*/
378 static const char *introspection_header =
379 "<?xml version=\"1.0\"?>\n";
381 static const char *introspection_node_element =
382 "<node name=\"%s\">\n";
384 static const char *introspection_footer =
388 append_interface (GString *str,
389 const gchar *interface,
390 const gchar *directory)
398 filename = g_build_filename (directory, interface, NULL);
400 if (g_file_get_contents (filename, &contents, &len, &err))
402 g_string_append_len (str, contents, len);
406 g_warning ("AT-SPI: Cannot find introspection XML file %s - %s",
407 filename, err->message);
411 g_string_append (str, "\n");
416 static DBusHandlerResult
417 handle_introspection (DBusConnection *bus,
418 DBusMessage *message,
422 const gchar *pathstr)
430 _DROUTE_DEBUG ("DRoute (handle introspection): %s\n", pathstr);
432 if (g_strcmp0 (member, "Introspect"))
433 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
435 output = g_string_new(introspection_header);
437 g_string_append_printf(output, introspection_node_element, pathstr);
439 for (i=0; i < path->interfaces->len; i++)
441 gchar *interface = (gchar *) g_ptr_array_index (path->interfaces, i);
442 append_interface(output, interface, path->cnx->introspect_dir);
445 g_string_append(output, introspection_footer);
446 final = g_string_free(output, FALSE);
448 reply = dbus_message_new_method_return (message);
451 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final,
453 dbus_connection_send (bus, reply, NULL);
455 dbus_message_unref (reply);
457 return DBUS_HANDLER_RESULT_HANDLED;
460 /*---------------------------------------------------------------------------*/
462 static DBusHandlerResult
463 handle_other (DBusConnection *bus,
464 DBusMessage *message,
468 const gchar *pathstr)
470 gint result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
479 _DROUTE_DEBUG ("DRoute (handle other): %s|%s on %s\n", member, iface, pathstr);
481 func = (DRouteFunction) g_hash_table_lookup (path->methods, &pair);
484 void *datum = path_get_datum (path, pathstr);
486 reply = (func) (bus, message, datum);
490 dbus_connection_send (bus, reply, NULL);
491 dbus_message_unref (reply);
493 result = DBUS_HANDLER_RESULT_HANDLED;
498 /*---------------------------------------------------------------------------*/
500 static DBusHandlerResult
501 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data)
503 DRoutePath *path = (DRoutePath *) user_data;
504 const gchar *iface = dbus_message_get_interface (message);
505 const gchar *member = dbus_message_get_member (message);
506 const gint type = dbus_message_get_type (message);
507 const gchar *pathstr = dbus_message_get_path (message);
509 /* Check for basic reasons not to handle */
510 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
513 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
515 if (!strcmp (iface, "org.freedesktop.DBus.Properties"))
516 return handle_properties (bus, message, path, iface, member, pathstr);
518 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
519 return handle_introspection (bus, message, path, iface, member, pathstr);
521 return handle_other (bus, message, path, iface, member, pathstr);
524 /*---------------------------------------------------------------------------*/
527 droute_not_yet_handled_error (DBusMessage *message)
532 errmsg= g_strdup_printf (
533 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
534 dbus_message_get_member (message),
535 dbus_message_get_signature (message),
536 dbus_message_get_interface (message));
537 reply = dbus_message_new_error (message,
538 DBUS_ERROR_UNKNOWN_METHOD,
544 /*END------------------------------------------------------------------------*/