5 * Copyright (C) 2004-2010 Marcel Holtmann <marcel@holtmann.org>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program 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
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
32 #include <dbus/dbus.h>
41 unsigned int refcount;
46 struct interface_data {
48 const GDBusMethodTable *methods;
49 const GDBusSignalTable *signals;
50 const GDBusPropertyTable *properties;
52 GDBusDestroyFunction destroy;
55 static void print_arguments(GString *gstr, const char *sig,
56 const char *direction)
60 for (i = 0; sig[i]; i++) {
62 int struct_level, dict_level;
67 struct_level = dict_level = 0;
68 memset(type, 0, sizeof(type));
70 /* Gather enough data to have a single complete type */
71 for (len = 0; len < (sizeof(type) - 1) && sig[i]; len++, i++) {
78 if (struct_level <= 0 && dict_level <= 0)
86 if (struct_level <= 0 && dict_level <= 0)
92 if (struct_level <= 0 && dict_level <= 0)
105 g_string_append_printf(gstr,
106 "\t\t\t<arg type=\"%s\" direction=\"%s\"/>\n",
109 g_string_append_printf(gstr,
110 "\t\t\t<arg type=\"%s\"/>\n",
115 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
117 const GDBusMethodTable *method;
118 const GDBusSignalTable *signal;
120 for (method = iface->methods; method && method->name; method++) {
121 if (!strlen(method->signature) && !strlen(method->reply))
122 g_string_append_printf(gstr, "\t\t<method name=\"%s\"/>\n",
125 g_string_append_printf(gstr, "\t\t<method name=\"%s\">\n",
127 print_arguments(gstr, method->signature, "in");
128 print_arguments(gstr, method->reply, "out");
129 g_string_append_printf(gstr, "\t\t</method>\n");
133 for (signal = iface->signals; signal && signal->name; signal++) {
134 if (!strlen(signal->signature))
135 g_string_append_printf(gstr, "\t\t<signal name=\"%s\"/>\n",
138 g_string_append_printf(gstr, "\t\t<signal name=\"%s\">\n",
140 print_arguments(gstr, signal->signature, NULL);
141 g_string_append_printf(gstr, "\t\t</signal>\n");
146 static void generate_introspection_xml(DBusConnection *conn,
147 struct generic_data *data, const char *path)
154 g_free(data->introspect);
156 gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
158 g_string_append_printf(gstr, "<node name=\"%s\">\n", path);
160 for (list = data->interfaces; list; list = list->next) {
161 struct interface_data *iface = list->data;
163 g_string_append_printf(gstr, "\t<interface name=\"%s\">\n",
166 generate_interface_xml(gstr, iface);
168 g_string_append_printf(gstr, "\t</interface>\n");
171 if (!dbus_connection_list_registered(conn, path, &children))
174 for (i = 0; children[i]; i++)
175 g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n",
178 dbus_free_string_array(children);
181 g_string_append_printf(gstr, "</node>\n");
183 data->introspect = g_string_free(gstr, FALSE);
186 static DBusMessage *introspect(DBusConnection *connection,
187 DBusMessage *message, void *user_data)
189 struct generic_data *data = user_data;
192 if (!dbus_message_has_signature(message, DBUS_TYPE_INVALID_AS_STRING)) {
193 error("Unexpected signature to introspect call");
197 if (!data->introspect)
198 generate_introspection_xml(connection, data,
199 dbus_message_get_path(message));
201 reply = dbus_message_new_method_return(message);
205 dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
211 static void generic_unregister(DBusConnection *connection, void *user_data)
213 struct generic_data *data = user_data;
215 g_free(data->introspect);
219 static struct interface_data *find_interface(GSList *interfaces,
227 for (list = interfaces; list; list = list->next) {
228 struct interface_data *iface = list->data;
229 if (!strcmp(name, iface->name))
236 static DBusHandlerResult generic_message(DBusConnection *connection,
237 DBusMessage *message, void *user_data)
239 struct generic_data *data = user_data;
240 struct interface_data *iface;
241 const GDBusMethodTable *method;
242 const char *interface;
244 interface = dbus_message_get_interface(message);
246 iface = find_interface(data->interfaces, interface);
248 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
250 for (method = iface->methods; method &&
251 method->name && method->function; method++) {
254 if (dbus_message_is_method_call(message, iface->name,
255 method->name) == FALSE)
258 if (dbus_message_has_signature(message,
259 method->signature) == FALSE)
262 reply = method->function(connection, message, iface->user_data);
264 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
266 dbus_message_unref(reply);
267 return DBUS_HANDLER_RESULT_HANDLED;
270 if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
272 return DBUS_HANDLER_RESULT_HANDLED;
276 return DBUS_HANDLER_RESULT_NEED_MEMORY;
278 dbus_connection_send(connection, reply, NULL);
279 dbus_message_unref(reply);
281 return DBUS_HANDLER_RESULT_HANDLED;
284 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
287 static DBusObjectPathVTable generic_table = {
288 .unregister_function = generic_unregister,
289 .message_function = generic_message,
292 static void invalidate_parent_data(DBusConnection *conn, const char *child_path)
294 struct generic_data *data = NULL;
295 char *parent_path, *slash;
297 parent_path = g_strdup(child_path);
298 slash = strrchr(parent_path, '/');
302 if (slash == parent_path && parent_path[1] != '\0')
303 parent_path[1] = '\0';
307 if (!strlen(parent_path))
310 if (!dbus_connection_get_object_path_data(conn, parent_path,
312 invalidate_parent_data(conn, parent_path);
319 g_free(data->introspect);
320 data->introspect = NULL;
326 static GDBusMethodTable introspect_methods[] = {
327 { "Introspect", "", "s", introspect },
331 static void add_interface(struct generic_data *data, const char *name,
332 const GDBusMethodTable *methods,
333 const GDBusSignalTable *signals,
334 const GDBusPropertyTable *properties,
336 GDBusDestroyFunction destroy)
338 struct interface_data *iface;
340 iface = g_new0(struct interface_data, 1);
341 iface->name = g_strdup(name);
342 iface->methods = methods;
343 iface->signals = signals;
344 iface->properties = properties;
345 iface->user_data = user_data;
346 iface->destroy = destroy;
348 data->interfaces = g_slist_append(data->interfaces, iface);
351 static struct generic_data *object_path_ref(DBusConnection *connection,
354 struct generic_data *data;
356 if (dbus_connection_get_object_path_data(connection, path,
357 (void *) &data) == TRUE) {
364 data = g_new0(struct generic_data, 1);
366 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
370 if (!dbus_connection_register_object_path(connection, path,
371 &generic_table, data)) {
372 g_free(data->introspect);
377 invalidate_parent_data(connection, path);
379 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE,
380 introspect_methods, NULL, NULL, data, NULL);
385 static gboolean remove_interface(struct generic_data *data, const char *name)
387 struct interface_data *iface;
389 iface = find_interface(data->interfaces, name);
393 data->interfaces = g_slist_remove(data->interfaces, iface);
396 iface->destroy(iface->user_data);
404 static void object_path_unref(DBusConnection *connection, const char *path)
406 struct generic_data *data = NULL;
408 if (dbus_connection_get_object_path_data(connection, path,
409 (void *) &data) == FALSE)
417 if (data->refcount > 0)
420 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
422 invalidate_parent_data(connection, path);
424 dbus_connection_unregister_object_path(connection, path);
427 static gboolean check_signal(DBusConnection *conn, const char *path,
428 const char *interface, const char *name,
431 struct generic_data *data = NULL;
432 struct interface_data *iface;
433 const GDBusSignalTable *signal;
436 if (!dbus_connection_get_object_path_data(conn, path,
437 (void *) &data) || !data) {
438 error("dbus_connection_emit_signal: path %s isn't registered",
443 iface = find_interface(data->interfaces, interface);
445 error("dbus_connection_emit_signal: %s does not implement %s",
450 for (signal = iface->signals; signal && signal->name; signal++) {
451 if (!strcmp(signal->name, name)) {
452 *args = signal->signature;
458 error("No signal named %s on interface %s", name, interface);
465 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
467 const char *interface,
474 const char *signature, *args;
476 if (!check_signal(conn, path, interface, name, &args))
479 signal = dbus_message_new_signal(path, interface, name);
481 error("Unable to allocate new %s.%s signal", interface, name);
485 ret = dbus_message_append_args_valist(signal, first, var_args);
489 signature = dbus_message_get_signature(signal);
490 if (strcmp(args, signature) != 0) {
491 error("%s.%s: expected signature'%s' but got '%s'",
492 interface, name, args, signature);
497 ret = dbus_connection_send(conn, signal, NULL);
500 dbus_message_unref(signal);
505 gboolean g_dbus_register_interface(DBusConnection *connection,
506 const char *path, const char *name,
507 const GDBusMethodTable *methods,
508 const GDBusSignalTable *signals,
509 const GDBusPropertyTable *properties,
511 GDBusDestroyFunction destroy)
513 struct generic_data *data;
515 data = object_path_ref(connection, path);
519 if (find_interface(data->interfaces, name)) {
520 object_path_unref(connection, path);
524 add_interface(data, name, methods, signals,
525 properties, user_data, destroy);
527 g_free(data->introspect);
528 data->introspect = NULL;
533 gboolean g_dbus_unregister_interface(DBusConnection *connection,
534 const char *path, const char *name)
536 struct generic_data *data = NULL;
541 if (dbus_connection_get_object_path_data(connection, path,
542 (void *) &data) == FALSE)
548 if (remove_interface(data, name) == FALSE)
551 g_free(data->introspect);
552 data->introspect = NULL;
554 object_path_unref(connection, path);
559 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
560 const char *format, va_list args)
564 vsnprintf(str, sizeof(str), format, args);
566 return dbus_message_new_error(message, name, str);
569 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
570 const char *format, ...)
575 va_start(args, format);
577 reply = g_dbus_create_error_valist(message, name, format, args);
584 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
585 int type, va_list args)
589 reply = dbus_message_new_method_return(message);
593 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
594 dbus_message_unref(reply);
601 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
606 va_start(args, type);
608 reply = g_dbus_create_reply_valist(message, type, args);
615 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
619 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
620 dbus_message_set_no_reply(message, TRUE);
622 result = dbus_connection_send(connection, message, NULL);
624 dbus_message_unref(message);
629 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
630 DBusMessage *message, int type, va_list args)
634 reply = dbus_message_new_method_return(message);
638 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
639 dbus_message_unref(reply);
643 return g_dbus_send_message(connection, reply);
646 gboolean g_dbus_send_reply(DBusConnection *connection,
647 DBusMessage *message, int type, ...)
652 va_start(args, type);
654 result = g_dbus_send_reply_valist(connection, message, type, args);
661 gboolean g_dbus_emit_signal(DBusConnection *connection,
662 const char *path, const char *interface,
663 const char *name, int type, ...)
668 va_start(args, type);
670 result = emit_signal_valist(connection, path, interface,
678 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
679 const char *path, const char *interface,
680 const char *name, int type, va_list args)
682 return emit_signal_valist(connection, path, interface,