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;
259 if (secdata->pending != pending)
262 pending_security = g_slist_remove(pending_security, secdata);
264 process_message(connection, secdata->message,
265 secdata->method, secdata->iface_user_data);
267 dbus_message_unref(secdata->message);
273 void g_dbus_pending_error_valist(DBusConnection *connection,
274 GDBusPendingReply pending, const char *name,
275 const char *format, va_list args)
279 for (list = pending_security; list; list = list->next) {
280 struct security_data *secdata = list->data;
283 if (secdata->pending != pending)
286 pending_security = g_slist_remove(pending_security, secdata);
288 reply = g_dbus_create_error_valist(secdata->message,
291 dbus_connection_send(connection, reply, NULL);
292 dbus_message_unref(reply);
295 dbus_message_unref(secdata->message);
301 void g_dbus_pending_error(DBusConnection *connection,
302 GDBusPendingReply pending,
303 const char *name, const char *format, ...)
307 va_start(args, format);
309 g_dbus_pending_error_valist(connection, pending, name, format, args);
314 int polkit_check_authorization(DBusConnection *conn,
315 const char *action, gboolean interaction,
316 void (*function) (dbus_bool_t authorized,
318 void *user_data, int timeout);
320 struct builtin_security_data {
321 DBusConnection *conn;
322 GDBusPendingReply pending;
325 static void builtin_security_result(dbus_bool_t authorized, void *user_data)
327 struct builtin_security_data *data = user_data;
329 if (authorized == TRUE)
330 g_dbus_pending_success(data->conn, data->pending);
332 g_dbus_pending_error(data->conn, data->pending,
333 DBUS_ERROR_AUTH_FAILED, NULL);
338 static void builtin_security_function(DBusConnection *conn,
340 gboolean interaction,
341 GDBusPendingReply pending)
343 struct builtin_security_data *data;
345 data = g_new0(struct builtin_security_data, 1);
347 data->pending = pending;
349 if (polkit_check_authorization(conn, action, interaction,
350 builtin_security_result, data, 30000) < 0)
351 g_dbus_pending_error(conn, pending, NULL, NULL);
354 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
355 const GDBusMethodTable *method, void *iface_user_data)
357 const GDBusSecurityTable *security;
359 for (security = security_table; security && security->privilege;
361 struct security_data *secdata;
362 gboolean interaction;
364 if (security->privilege != method->privilege)
367 secdata = g_new(struct security_data, 1);
368 secdata->pending = next_pending++;
369 secdata->message = dbus_message_ref(msg);
370 secdata->method = method;
371 secdata->iface_user_data = iface_user_data;
373 pending_security = g_slist_prepend(pending_security, secdata);
375 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
380 if (!(security->flags & G_DBUS_SECURITY_FLAG_BUILTIN) &&
382 security->function(conn, security->action,
383 interaction, secdata->pending);
385 builtin_security_function(conn, security->action,
386 interaction, secdata->pending);
394 static void generic_unregister(DBusConnection *connection, void *user_data)
396 struct generic_data *data = user_data;
398 g_free(data->introspect);
402 static struct interface_data *find_interface(GSList *interfaces,
410 for (list = interfaces; list; list = list->next) {
411 struct interface_data *iface = list->data;
412 if (!strcmp(name, iface->name))
419 static DBusHandlerResult generic_message(DBusConnection *connection,
420 DBusMessage *message, void *user_data)
422 struct generic_data *data = user_data;
423 struct interface_data *iface;
424 const GDBusMethodTable *method;
425 const char *interface;
427 interface = dbus_message_get_interface(message);
429 iface = find_interface(data->interfaces, interface);
431 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
433 for (method = iface->methods; method &&
434 method->name && method->function; method++) {
435 if (dbus_message_is_method_call(message, iface->name,
436 method->name) == FALSE)
439 if (dbus_message_has_signature(message,
440 method->signature) == FALSE)
443 if (check_privilege(connection, message, method,
444 iface->user_data) == TRUE)
445 return DBUS_HANDLER_RESULT_HANDLED;
447 return process_message(connection, message, method,
451 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
454 static DBusObjectPathVTable generic_table = {
455 .unregister_function = generic_unregister,
456 .message_function = generic_message,
459 static void invalidate_parent_data(DBusConnection *conn, const char *child_path)
461 struct generic_data *data = NULL;
462 char *parent_path, *slash;
464 parent_path = g_strdup(child_path);
465 slash = strrchr(parent_path, '/');
469 if (slash == parent_path && parent_path[1] != '\0')
470 parent_path[1] = '\0';
474 if (!strlen(parent_path))
477 if (dbus_connection_get_object_path_data(conn, parent_path,
478 (void *) &data) == FALSE) {
482 invalidate_parent_data(conn, parent_path);
487 g_free(data->introspect);
488 data->introspect = NULL;
494 static GDBusMethodTable introspect_methods[] = {
495 { "Introspect", "", "s", introspect },
499 static void add_interface(struct generic_data *data, const char *name,
500 const GDBusMethodTable *methods,
501 const GDBusSignalTable *signals,
502 const GDBusPropertyTable *properties,
504 GDBusDestroyFunction destroy)
506 struct interface_data *iface;
508 iface = g_new0(struct interface_data, 1);
509 iface->name = g_strdup(name);
510 iface->methods = methods;
511 iface->signals = signals;
512 iface->properties = properties;
513 iface->user_data = user_data;
514 iface->destroy = destroy;
516 data->interfaces = g_slist_append(data->interfaces, iface);
519 static struct generic_data *object_path_ref(DBusConnection *connection,
522 struct generic_data *data;
524 if (dbus_connection_get_object_path_data(connection, path,
525 (void *) &data) == TRUE) {
532 data = g_new0(struct generic_data, 1);
535 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
537 if (!dbus_connection_register_object_path(connection, path,
538 &generic_table, data)) {
539 g_free(data->introspect);
544 invalidate_parent_data(connection, path);
546 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE,
547 introspect_methods, NULL, NULL, data, NULL);
552 static gboolean remove_interface(struct generic_data *data, const char *name)
554 struct interface_data *iface;
556 iface = find_interface(data->interfaces, name);
560 data->interfaces = g_slist_remove(data->interfaces, iface);
563 iface->destroy(iface->user_data);
571 static void object_path_unref(DBusConnection *connection, const char *path)
573 struct generic_data *data = NULL;
575 if (dbus_connection_get_object_path_data(connection, path,
576 (void *) &data) == FALSE)
584 if (data->refcount > 0)
587 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
589 invalidate_parent_data(connection, path);
591 dbus_connection_unregister_object_path(connection, path);
594 static gboolean check_signal(DBusConnection *conn, const char *path,
595 const char *interface, const char *name,
598 struct generic_data *data = NULL;
599 struct interface_data *iface;
600 const GDBusSignalTable *signal;
603 if (!dbus_connection_get_object_path_data(conn, path,
604 (void *) &data) || data == NULL) {
605 error("dbus_connection_emit_signal: path %s isn't registered",
610 iface = find_interface(data->interfaces, interface);
612 error("dbus_connection_emit_signal: %s does not implement %s",
617 for (signal = iface->signals; signal && signal->name; signal++) {
618 if (!strcmp(signal->name, name)) {
619 *args = signal->signature;
625 error("No signal named %s on interface %s", name, interface);
632 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
634 const char *interface,
641 const char *signature, *args;
643 if (!check_signal(conn, path, interface, name, &args))
646 signal = dbus_message_new_signal(path, interface, name);
647 if (signal == NULL) {
648 error("Unable to allocate new %s.%s signal", interface, name);
652 ret = dbus_message_append_args_valist(signal, first, var_args);
656 signature = dbus_message_get_signature(signal);
657 if (strcmp(args, signature) != 0) {
658 error("%s.%s: expected signature'%s' but got '%s'",
659 interface, name, args, signature);
664 ret = dbus_connection_send(conn, signal, NULL);
667 dbus_message_unref(signal);
672 gboolean g_dbus_register_interface(DBusConnection *connection,
673 const char *path, const char *name,
674 const GDBusMethodTable *methods,
675 const GDBusSignalTable *signals,
676 const GDBusPropertyTable *properties,
678 GDBusDestroyFunction destroy)
680 struct generic_data *data;
682 data = object_path_ref(connection, path);
686 if (find_interface(data->interfaces, name)) {
687 object_path_unref(connection, path);
691 add_interface(data, name, methods, signals,
692 properties, user_data, destroy);
694 g_free(data->introspect);
695 data->introspect = NULL;
700 gboolean g_dbus_unregister_interface(DBusConnection *connection,
701 const char *path, const char *name)
703 struct generic_data *data = NULL;
708 if (dbus_connection_get_object_path_data(connection, path,
709 (void *) &data) == FALSE)
715 if (remove_interface(data, name) == FALSE)
718 g_free(data->introspect);
719 data->introspect = NULL;
721 object_path_unref(connection, path);
726 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
728 if (security_table != NULL)
731 security_table = security;
736 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
738 security_table = NULL;
743 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
744 const char *format, va_list args)
748 vsnprintf(str, sizeof(str), format, args);
750 return dbus_message_new_error(message, name, str);
753 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
754 const char *format, ...)
759 va_start(args, format);
761 reply = g_dbus_create_error_valist(message, name, format, args);
768 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
769 int type, va_list args)
773 reply = dbus_message_new_method_return(message);
777 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
778 dbus_message_unref(reply);
785 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
790 va_start(args, type);
792 reply = g_dbus_create_reply_valist(message, type, args);
799 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
803 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
804 dbus_message_set_no_reply(message, TRUE);
806 result = dbus_connection_send(connection, message, NULL);
808 dbus_message_unref(message);
813 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
814 DBusMessage *message, int type, va_list args)
818 reply = dbus_message_new_method_return(message);
822 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
823 dbus_message_unref(reply);
827 return g_dbus_send_message(connection, reply);
830 gboolean g_dbus_send_reply(DBusConnection *connection,
831 DBusMessage *message, int type, ...)
836 va_start(args, type);
838 result = g_dbus_send_reply_valist(connection, message, type, args);
845 gboolean g_dbus_emit_signal(DBusConnection *connection,
846 const char *path, const char *interface,
847 const char *name, int type, ...)
852 va_start(args, type);
854 result = emit_signal_valist(connection, path, interface,
862 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
863 const char *path, const char *interface,
864 const char *name, int type, va_list args)
866 return emit_signal_valist(connection, path, interface,