5 * Copyright (C) 2004-2011 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 struct security_data {
56 GDBusPendingReply pending;
58 const GDBusMethodTable *method;
59 void *iface_user_data;
62 static void print_arguments(GString *gstr, const char *sig,
63 const char *direction)
67 for (i = 0; sig[i]; i++) {
69 int struct_level, dict_level;
74 struct_level = dict_level = 0;
75 memset(type, 0, sizeof(type));
77 /* Gather enough data to have a single complete type */
78 for (len = 0; len < (sizeof(type) - 1) && sig[i]; len++, i++) {
85 if (struct_level <= 0 && dict_level <= 0)
93 if (struct_level <= 0 && dict_level <= 0)
99 if (struct_level <= 0 && dict_level <= 0)
112 g_string_append_printf(gstr,
113 "\t\t\t<arg type=\"%s\" direction=\"%s\"/>\n",
116 g_string_append_printf(gstr,
117 "\t\t\t<arg type=\"%s\"/>\n",
122 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
124 const GDBusMethodTable *method;
125 const GDBusSignalTable *signal;
127 for (method = iface->methods; method && method->name; method++) {
128 if (!strlen(method->signature) && !strlen(method->reply))
129 g_string_append_printf(gstr, "\t\t<method name=\"%s\"/>\n",
132 g_string_append_printf(gstr, "\t\t<method name=\"%s\">\n",
134 print_arguments(gstr, method->signature, "in");
135 print_arguments(gstr, method->reply, "out");
136 g_string_append_printf(gstr, "\t\t</method>\n");
140 for (signal = iface->signals; signal && signal->name; signal++) {
141 if (!strlen(signal->signature))
142 g_string_append_printf(gstr, "\t\t<signal name=\"%s\"/>\n",
145 g_string_append_printf(gstr, "\t\t<signal name=\"%s\">\n",
147 print_arguments(gstr, signal->signature, NULL);
148 g_string_append_printf(gstr, "\t\t</signal>\n");
153 static void generate_introspection_xml(DBusConnection *conn,
154 struct generic_data *data, const char *path)
161 g_free(data->introspect);
163 gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
165 g_string_append_printf(gstr, "<node>\n");
167 for (list = data->interfaces; list; list = list->next) {
168 struct interface_data *iface = list->data;
170 g_string_append_printf(gstr, "\t<interface name=\"%s\">\n",
173 generate_interface_xml(gstr, iface);
175 g_string_append_printf(gstr, "\t</interface>\n");
178 if (!dbus_connection_list_registered(conn, path, &children))
181 for (i = 0; children[i]; i++)
182 g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n",
185 dbus_free_string_array(children);
188 g_string_append_printf(gstr, "</node>\n");
190 data->introspect = g_string_free(gstr, FALSE);
193 static DBusMessage *introspect(DBusConnection *connection,
194 DBusMessage *message, void *user_data)
196 struct generic_data *data = user_data;
199 if (!dbus_message_has_signature(message, DBUS_TYPE_INVALID_AS_STRING)) {
200 error("Unexpected signature to introspect call");
204 if (data->introspect == NULL)
205 generate_introspection_xml(connection, data,
206 dbus_message_get_path(message));
208 reply = dbus_message_new_method_return(message);
212 dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
218 static DBusHandlerResult process_message(DBusConnection *connection,
219 DBusMessage *message, const GDBusMethodTable *method,
220 void *iface_user_data)
224 reply = method->function(connection, message, iface_user_data);
226 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
228 dbus_message_unref(reply);
229 return DBUS_HANDLER_RESULT_HANDLED;
232 if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
234 return DBUS_HANDLER_RESULT_HANDLED;
238 return DBUS_HANDLER_RESULT_NEED_MEMORY;
240 dbus_connection_send(connection, reply, NULL);
241 dbus_message_unref(reply);
243 return DBUS_HANDLER_RESULT_HANDLED;
246 static GDBusPendingReply next_pending = 1;
247 static GSList *pending_security = NULL;
249 static const GDBusSecurityTable *security_table = NULL;
251 void g_dbus_pending_success(DBusConnection *connection,
252 GDBusPendingReply pending)
256 for (list = pending_security; list; list = list->next) {
257 struct security_data *secdata = list->data;
258 DBusHandlerResult result;
260 if (secdata->pending != pending)
263 pending_security = g_slist_remove(pending_security, secdata);
265 result = process_message(connection, secdata->message,
266 secdata->method, secdata->iface_user_data);
268 dbus_message_unref(secdata->message);
274 void g_dbus_pending_error_valist(DBusConnection *connection,
275 GDBusPendingReply pending, const char *name,
276 const char *format, va_list args)
280 for (list = pending_security; list; list = list->next) {
281 struct security_data *secdata = list->data;
284 if (secdata->pending != pending)
287 pending_security = g_slist_remove(pending_security, secdata);
289 reply = g_dbus_create_error_valist(secdata->message,
292 dbus_connection_send(connection, reply, NULL);
293 dbus_message_unref(reply);
296 dbus_message_unref(secdata->message);
302 void g_dbus_pending_error(DBusConnection *connection,
303 GDBusPendingReply pending,
304 const char *name, const char *format, ...)
308 va_start(args, format);
310 g_dbus_pending_error_valist(connection, pending, name, format, args);
315 int polkit_check_authorization(DBusConnection *conn,
316 const char *action, gboolean interaction,
317 void (*function) (dbus_bool_t authorized,
319 void *user_data, int timeout);
321 struct builtin_security_data {
322 DBusConnection *conn;
323 GDBusPendingReply pending;
326 static void builtin_security_result(dbus_bool_t authorized, void *user_data)
328 struct builtin_security_data *data = user_data;
330 if (authorized == TRUE)
331 g_dbus_pending_success(data->conn, data->pending);
333 g_dbus_pending_error(data->conn, data->pending,
334 DBUS_ERROR_AUTH_FAILED, NULL);
339 static void builtin_security_function(DBusConnection *conn,
341 gboolean interaction,
342 GDBusPendingReply pending)
344 struct builtin_security_data *data;
346 data = g_new0(struct builtin_security_data, 1);
348 data->pending = pending;
350 if (polkit_check_authorization(conn, action, interaction,
351 builtin_security_result, data, 30000) < 0)
352 g_dbus_pending_error(conn, pending, NULL, NULL);
355 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
356 const GDBusMethodTable *method, void *iface_user_data)
358 const GDBusSecurityTable *security;
360 for (security = security_table; security && security->privilege;
362 struct security_data *secdata;
363 gboolean interaction;
365 if (security->privilege != method->privilege)
368 secdata = g_new(struct security_data, 1);
369 secdata->pending = next_pending++;
370 secdata->message = dbus_message_ref(msg);
371 secdata->method = method;
372 secdata->iface_user_data = iface_user_data;
374 pending_security = g_slist_prepend(pending_security, secdata);
376 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
381 if (!(security->flags & G_DBUS_SECURITY_FLAG_BUILTIN) &&
383 security->function(conn, security->action,
384 interaction, secdata->pending);
386 builtin_security_function(conn, security->action,
387 interaction, secdata->pending);
395 static void generic_unregister(DBusConnection *connection, void *user_data)
397 struct generic_data *data = user_data;
399 g_free(data->introspect);
403 static struct interface_data *find_interface(GSList *interfaces,
411 for (list = interfaces; list; list = list->next) {
412 struct interface_data *iface = list->data;
413 if (!strcmp(name, iface->name))
420 static DBusHandlerResult generic_message(DBusConnection *connection,
421 DBusMessage *message, void *user_data)
423 struct generic_data *data = user_data;
424 struct interface_data *iface;
425 const GDBusMethodTable *method;
426 const char *interface;
428 interface = dbus_message_get_interface(message);
430 iface = find_interface(data->interfaces, interface);
432 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
434 for (method = iface->methods; method &&
435 method->name && method->function; method++) {
436 if (dbus_message_is_method_call(message, iface->name,
437 method->name) == FALSE)
440 if (dbus_message_has_signature(message,
441 method->signature) == FALSE)
444 if (check_privilege(connection, message, method,
445 iface->user_data) == TRUE)
446 return DBUS_HANDLER_RESULT_HANDLED;
448 return process_message(connection, message, method,
452 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
455 static DBusObjectPathVTable generic_table = {
456 .unregister_function = generic_unregister,
457 .message_function = generic_message,
460 static void invalidate_parent_data(DBusConnection *conn, const char *child_path)
462 struct generic_data *data = NULL;
463 char *parent_path, *slash;
465 parent_path = g_strdup(child_path);
466 slash = strrchr(parent_path, '/');
470 if (slash == parent_path && parent_path[1] != '\0')
471 parent_path[1] = '\0';
475 if (!strlen(parent_path))
478 if (dbus_connection_get_object_path_data(conn, parent_path,
479 (void *) &data) == FALSE) {
483 invalidate_parent_data(conn, parent_path);
488 g_free(data->introspect);
489 data->introspect = NULL;
495 static GDBusMethodTable introspect_methods[] = {
496 { "Introspect", "", "s", introspect },
500 static void add_interface(struct generic_data *data, const char *name,
501 const GDBusMethodTable *methods,
502 const GDBusSignalTable *signals,
503 const GDBusPropertyTable *properties,
505 GDBusDestroyFunction destroy)
507 struct interface_data *iface;
509 iface = g_new0(struct interface_data, 1);
510 iface->name = g_strdup(name);
511 iface->methods = methods;
512 iface->signals = signals;
513 iface->properties = properties;
514 iface->user_data = user_data;
515 iface->destroy = destroy;
517 data->interfaces = g_slist_append(data->interfaces, iface);
520 static struct generic_data *object_path_ref(DBusConnection *connection,
523 struct generic_data *data;
525 if (dbus_connection_get_object_path_data(connection, path,
526 (void *) &data) == TRUE) {
533 data = g_new0(struct generic_data, 1);
536 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
538 if (!dbus_connection_register_object_path(connection, path,
539 &generic_table, data)) {
540 g_free(data->introspect);
545 invalidate_parent_data(connection, path);
547 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE,
548 introspect_methods, NULL, NULL, data, NULL);
553 static gboolean remove_interface(struct generic_data *data, const char *name)
555 struct interface_data *iface;
557 iface = find_interface(data->interfaces, name);
561 data->interfaces = g_slist_remove(data->interfaces, iface);
564 iface->destroy(iface->user_data);
572 static void object_path_unref(DBusConnection *connection, const char *path)
574 struct generic_data *data = NULL;
576 if (dbus_connection_get_object_path_data(connection, path,
577 (void *) &data) == FALSE)
585 if (data->refcount > 0)
588 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
590 invalidate_parent_data(connection, path);
592 dbus_connection_unregister_object_path(connection, path);
595 static gboolean check_signal(DBusConnection *conn, const char *path,
596 const char *interface, const char *name,
599 struct generic_data *data = NULL;
600 struct interface_data *iface;
601 const GDBusSignalTable *signal;
604 if (!dbus_connection_get_object_path_data(conn, path,
605 (void *) &data) || data == NULL) {
606 error("dbus_connection_emit_signal: path %s isn't registered",
611 iface = find_interface(data->interfaces, interface);
613 error("dbus_connection_emit_signal: %s does not implement %s",
618 for (signal = iface->signals; signal && signal->name; signal++) {
619 if (!strcmp(signal->name, name)) {
620 *args = signal->signature;
626 error("No signal named %s on interface %s", name, interface);
633 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
635 const char *interface,
642 const char *signature, *args;
644 if (!check_signal(conn, path, interface, name, &args))
647 signal = dbus_message_new_signal(path, interface, name);
648 if (signal == NULL) {
649 error("Unable to allocate new %s.%s signal", interface, name);
653 ret = dbus_message_append_args_valist(signal, first, var_args);
657 signature = dbus_message_get_signature(signal);
658 if (strcmp(args, signature) != 0) {
659 error("%s.%s: expected signature'%s' but got '%s'",
660 interface, name, args, signature);
665 ret = dbus_connection_send(conn, signal, NULL);
668 dbus_message_unref(signal);
673 gboolean g_dbus_register_interface(DBusConnection *connection,
674 const char *path, const char *name,
675 const GDBusMethodTable *methods,
676 const GDBusSignalTable *signals,
677 const GDBusPropertyTable *properties,
679 GDBusDestroyFunction destroy)
681 struct generic_data *data;
683 data = object_path_ref(connection, path);
687 if (find_interface(data->interfaces, name)) {
688 object_path_unref(connection, path);
692 add_interface(data, name, methods, signals,
693 properties, user_data, destroy);
695 g_free(data->introspect);
696 data->introspect = NULL;
701 gboolean g_dbus_unregister_interface(DBusConnection *connection,
702 const char *path, const char *name)
704 struct generic_data *data = NULL;
709 if (dbus_connection_get_object_path_data(connection, path,
710 (void *) &data) == FALSE)
716 if (remove_interface(data, name) == FALSE)
719 g_free(data->introspect);
720 data->introspect = NULL;
722 object_path_unref(connection, path);
727 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
729 if (security_table != NULL)
732 security_table = security;
737 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
739 security_table = NULL;
744 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
745 const char *format, va_list args)
749 vsnprintf(str, sizeof(str), format, args);
751 return dbus_message_new_error(message, name, str);
754 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
755 const char *format, ...)
760 va_start(args, format);
762 reply = g_dbus_create_error_valist(message, name, format, args);
769 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
770 int type, va_list args)
774 reply = dbus_message_new_method_return(message);
778 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
779 dbus_message_unref(reply);
786 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
791 va_start(args, type);
793 reply = g_dbus_create_reply_valist(message, type, args);
800 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
804 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
805 dbus_message_set_no_reply(message, TRUE);
807 result = dbus_connection_send(connection, message, NULL);
809 dbus_message_unref(message);
814 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
815 DBusMessage *message, int type, va_list args)
819 reply = dbus_message_new_method_return(message);
823 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
824 dbus_message_unref(reply);
828 return g_dbus_send_message(connection, reply);
831 gboolean g_dbus_send_reply(DBusConnection *connection,
832 DBusMessage *message, int type, ...)
837 va_start(args, type);
839 result = g_dbus_send_reply_valist(connection, message, type, args);
846 gboolean g_dbus_emit_signal(DBusConnection *connection,
847 const char *path, const char *interface,
848 const char *name, int type, ...)
853 va_start(args, type);
855 result = emit_signal_valist(connection, path, interface,
863 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
864 const char *path, const char *interface,
865 const char *name, int type, va_list args)
867 return emit_signal_valist(connection, path, interface,