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);
253 dbus_error_init (&error);
254 if (!dbus_message_get_args
255 (message, &error, DBUS_TYPE_STRING, &iface, DBUS_TYPE_INVALID))
256 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
258 reply = dbus_message_new_method_return (message);
262 dbus_message_iter_init_append (reply, &iter);
263 if (!dbus_message_iter_open_container
264 (&iter, DBUS_TYPE_ARRAY, "{sv}", &iter_dict))
267 g_hash_table_iter_init (&prop_iter, path->properties);
268 while (g_hash_table_iter_next (&prop_iter, (gpointer*)&key, (gpointer*)&value))
270 if (!g_strcmp0 (key->one, iface))
274 if (!dbus_message_iter_open_container
275 (&iter_dict, DBUS_TYPE_DICT_ENTRY, NULL, &iter_dict_entry))
277 dbus_message_iter_append_basic (&iter_dict_entry, DBUS_TYPE_STRING,
279 (value->get) (&iter_dict_entry, datum);
280 if (!dbus_message_iter_close_container (&iter_dict, &iter_dict_entry))
285 if (!dbus_message_iter_close_container (&iter, &iter_dict))
291 impl_prop_GetSet (DBusMessage *message,
296 DBusMessage *reply = NULL;
300 PropertyPair *prop_funcs = NULL;
303 dbus_error_init (&error);
304 if (!dbus_message_get_args (message,
311 return dbus_message_new_error (message, DBUS_ERROR_FAILED, error.message);
313 prop_funcs = (PropertyPair *) g_hash_table_lookup (path->properties, &pair);
315 return dbus_message_new_error (message, DBUS_ERROR_FAILED, "Property unavailable");
317 if (get && prop_funcs->get)
319 void *datum = path_get_datum (path, pathstr);
320 DBusMessageIter iter;
322 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
324 reply = dbus_message_new_method_return (message);
325 dbus_message_iter_init_append (reply, &iter);
326 (prop_funcs->get) (&iter, datum);
328 else if (!get && prop_funcs->set)
330 void *datum = path_get_datum (path, pathstr);
331 DBusMessageIter iter;
333 _DROUTE_DEBUG ("DRoute (handle prop Get): %s|%s on %s\n", pair.one, pair.two, pathstr);
335 dbus_message_iter_init_append (message, &iter);
336 /* Skip the interface and property name */
337 dbus_message_iter_next(&iter);
338 dbus_message_iter_next(&iter);
339 (prop_funcs->set) (&iter, datum);
341 reply = dbus_message_new_method_return (message);
345 reply = dbus_message_new_error (message, DBUS_ERROR_FAILED, "Getter or setter unavailable");
351 static DBusHandlerResult
352 handle_properties (DBusConnection *bus,
353 DBusMessage *message,
357 const gchar *pathstr)
360 DBusHandlerResult result = DBUS_HANDLER_RESULT_HANDLED;
362 if (!g_strcmp0(member, "GetAll"))
363 reply = impl_prop_GetAll (message, path, pathstr);
364 else if (!g_strcmp0 (member, "Get"))
365 reply = impl_prop_GetSet (message, path, pathstr, TRUE);
366 else if (!g_strcmp0 (member, "Set"))
367 reply = impl_prop_GetSet (message, path, pathstr, FALSE);
369 result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
373 dbus_connection_send (bus, reply, NULL);
374 dbus_message_unref (reply);
380 /*---------------------------------------------------------------------------*/
382 static const char *introspection_header =
383 "<?xml version=\"1.0\"?>\n";
385 static const char *introspection_node_element =
386 "<node name=\"%s\">\n";
388 static const char *introspection_footer =
392 append_interface (GString *str,
393 const gchar *interface,
394 const gchar *directory)
402 filename = g_build_filename (directory, interface, NULL);
404 if (g_file_get_contents (filename, &contents, &len, &err))
406 g_string_append_len (str, contents, len);
410 g_warning ("AT-SPI: Cannot find introspection XML file %s - %s",
411 filename, err->message);
415 g_string_append (str, "\n");
420 static DBusHandlerResult
421 handle_introspection (DBusConnection *bus,
422 DBusMessage *message,
426 const gchar *pathstr)
434 _DROUTE_DEBUG ("DRoute (handle introspection): %s\n", pathstr);
436 if (g_strcmp0 (member, "Introspect"))
437 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
439 output = g_string_new(introspection_header);
441 g_string_append_printf(output, introspection_node_element, pathstr);
443 for (i=0; i < path->interfaces->len; i++)
445 gchar *interface = (gchar *) g_ptr_array_index (path->interfaces, i);
446 append_interface(output, interface, path->cnx->introspect_dir);
449 g_string_append(output, introspection_footer);
450 final = g_string_free(output, FALSE);
452 reply = dbus_message_new_method_return (message);
455 dbus_message_append_args(reply, DBUS_TYPE_STRING, &final,
457 dbus_connection_send (bus, reply, NULL);
459 dbus_message_unref (reply);
461 return DBUS_HANDLER_RESULT_HANDLED;
464 /*---------------------------------------------------------------------------*/
466 static DBusHandlerResult
467 handle_other (DBusConnection *bus,
468 DBusMessage *message,
472 const gchar *pathstr)
474 gint result = DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
483 _DROUTE_DEBUG ("DRoute (handle other): %s|%s on %s\n", member, iface, pathstr);
485 func = (DRouteFunction) g_hash_table_lookup (path->methods, &pair);
488 void *datum = path_get_datum (path, pathstr);
490 reply = (func) (bus, message, datum);
494 dbus_connection_send (bus, reply, NULL);
495 dbus_message_unref (reply);
497 result = DBUS_HANDLER_RESULT_HANDLED;
502 /*---------------------------------------------------------------------------*/
504 static DBusHandlerResult
505 handle_message (DBusConnection *bus, DBusMessage *message, void *user_data)
507 DRoutePath *path = (DRoutePath *) user_data;
508 const gchar *iface = dbus_message_get_interface (message);
509 const gchar *member = dbus_message_get_member (message);
510 const gint type = dbus_message_get_type (message);
511 const gchar *pathstr = dbus_message_get_path (message);
513 /* Check for basic reasons not to handle */
514 if (type != DBUS_MESSAGE_TYPE_METHOD_CALL ||
517 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
519 if (!strcmp (iface, "org.freedesktop.DBus.Properties"))
520 return handle_properties (bus, message, path, iface, member, pathstr);
522 if (!strcmp (iface, "org.freedesktop.DBus.Introspectable"))
523 return handle_introspection (bus, message, path, iface, member, pathstr);
525 return handle_other (bus, message, path, iface, member, pathstr);
528 /*---------------------------------------------------------------------------*/
531 droute_not_yet_handled_error (DBusMessage *message)
536 errmsg= g_strdup_printf (
537 "Method \"%s\" with signature \"%s\" on interface \"%s\" doesn't exist\n",
538 dbus_message_get_member (message),
539 dbus_message_get_signature (message),
540 dbus_message_get_interface (message));
541 reply = dbus_message_new_error (message,
542 DBUS_ERROR_UNKNOWN_METHOD,
549 droute_out_of_memory_error (DBusMessage *message)
554 errmsg= g_strdup_printf (
555 "Method \"%s\" with signature \"%s\" on interface \"%s\" could not be processed due to lack of memory\n",
556 dbus_message_get_member (message),
557 dbus_message_get_signature (message),
558 dbus_message_get_interface (message));
559 reply = dbus_message_new_error (message,
560 DBUS_ERROR_NO_MEMORY,
567 droute_invalid_arguments_error (DBusMessage *message)
572 errmsg= g_strdup_printf (
573 "Method \"%s\" with signature \"%s\" on interface \"%s\" was supplied with invalid arguments\n",
574 dbus_message_get_member (message),
575 dbus_message_get_signature (message),
576 dbus_message_get_interface (message));
577 reply = dbus_message_new_error (message,
578 DBUS_ERROR_INVALID_ARGS,
584 /*END------------------------------------------------------------------------*/