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 GDBusArgInfo *args,
63 const char *direction)
65 for (; args && args->name; args++) {
66 g_string_append_printf(gstr,
67 "\t\t\t<arg name=\"%s\" type=\"%s\"",
68 args->name, args->signature);
71 g_string_append_printf(gstr,
72 " direction=\"%s\"/>\n", direction);
74 g_string_append_printf(gstr, "/>\n");
79 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
81 const GDBusMethodTable *method;
82 const GDBusSignalTable *signal;
84 for (method = iface->methods; method && method->name; method++) {
85 gboolean deprecated = method->flags &
86 G_DBUS_METHOD_FLAG_DEPRECATED;
87 gboolean noreply = method->flags &
88 G_DBUS_METHOD_FLAG_NOREPLY;
90 if (!deprecated && !noreply &&
91 !(method->in_args && method->in_args->name) &&
92 !(method->out_args && method->out_args->name))
93 g_string_append_printf(gstr, "\t\t<method name=\"%s\"/>\n",
96 g_string_append_printf(gstr, "\t\t<method name=\"%s\">\n",
98 print_arguments(gstr, method->in_args, "in");
99 print_arguments(gstr, method->out_args, "out");
102 g_string_append_printf(gstr, "\t\t\t<annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n");
105 g_string_append_printf(gstr, "\t\t\t<annotation name=\"org.freedesktop.DBus.Method.NoReply\" value=\"true\"/>\n");
107 g_string_append_printf(gstr, "\t\t</method>\n");
111 for (signal = iface->signals; signal && signal->name; signal++) {
112 gboolean deprecated = signal->flags &
113 G_DBUS_SIGNAL_FLAG_DEPRECATED;
115 if (!deprecated && !(signal->args && signal->args->name))
116 g_string_append_printf(gstr, "\t\t<signal name=\"%s\"/>\n",
119 g_string_append_printf(gstr, "\t\t<signal name=\"%s\">\n",
121 print_arguments(gstr, signal->args, NULL);
124 g_string_append_printf(gstr, "\t\t\t<annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n");
126 g_string_append_printf(gstr, "\t\t</signal>\n");
131 static void generate_introspection_xml(DBusConnection *conn,
132 struct generic_data *data, const char *path)
139 g_free(data->introspect);
141 gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
143 g_string_append_printf(gstr, "<node>\n");
145 for (list = data->interfaces; list; list = list->next) {
146 struct interface_data *iface = list->data;
148 g_string_append_printf(gstr, "\t<interface name=\"%s\">\n",
151 generate_interface_xml(gstr, iface);
153 g_string_append_printf(gstr, "\t</interface>\n");
156 if (!dbus_connection_list_registered(conn, path, &children))
159 for (i = 0; children[i]; i++)
160 g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n",
163 dbus_free_string_array(children);
166 g_string_append_printf(gstr, "</node>\n");
168 data->introspect = g_string_free(gstr, FALSE);
171 static DBusMessage *introspect(DBusConnection *connection,
172 DBusMessage *message, void *user_data)
174 struct generic_data *data = user_data;
177 if (!dbus_message_has_signature(message, DBUS_TYPE_INVALID_AS_STRING)) {
178 error("Unexpected signature to introspect call");
182 if (data->introspect == NULL)
183 generate_introspection_xml(connection, data,
184 dbus_message_get_path(message));
186 reply = dbus_message_new_method_return(message);
190 dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
196 static DBusHandlerResult process_message(DBusConnection *connection,
197 DBusMessage *message, const GDBusMethodTable *method,
198 void *iface_user_data)
202 reply = method->function(connection, message, iface_user_data);
204 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
206 dbus_message_unref(reply);
207 return DBUS_HANDLER_RESULT_HANDLED;
210 if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
212 return DBUS_HANDLER_RESULT_HANDLED;
216 return DBUS_HANDLER_RESULT_NEED_MEMORY;
218 dbus_connection_send(connection, reply, NULL);
219 dbus_message_unref(reply);
221 return DBUS_HANDLER_RESULT_HANDLED;
224 static GDBusPendingReply next_pending = 1;
225 static GSList *pending_security = NULL;
227 static const GDBusSecurityTable *security_table = NULL;
229 void g_dbus_pending_success(DBusConnection *connection,
230 GDBusPendingReply pending)
234 for (list = pending_security; list; list = list->next) {
235 struct security_data *secdata = list->data;
237 if (secdata->pending != pending)
240 pending_security = g_slist_remove(pending_security, secdata);
242 process_message(connection, secdata->message,
243 secdata->method, secdata->iface_user_data);
245 dbus_message_unref(secdata->message);
251 void g_dbus_pending_error_valist(DBusConnection *connection,
252 GDBusPendingReply pending, const char *name,
253 const char *format, va_list args)
257 for (list = pending_security; list; list = list->next) {
258 struct security_data *secdata = list->data;
261 if (secdata->pending != pending)
264 pending_security = g_slist_remove(pending_security, secdata);
266 reply = g_dbus_create_error_valist(secdata->message,
269 dbus_connection_send(connection, reply, NULL);
270 dbus_message_unref(reply);
273 dbus_message_unref(secdata->message);
279 void g_dbus_pending_error(DBusConnection *connection,
280 GDBusPendingReply pending,
281 const char *name, const char *format, ...)
285 va_start(args, format);
287 g_dbus_pending_error_valist(connection, pending, name, format, args);
292 int polkit_check_authorization(DBusConnection *conn,
293 const char *action, gboolean interaction,
294 void (*function) (dbus_bool_t authorized,
296 void *user_data, int timeout);
298 struct builtin_security_data {
299 DBusConnection *conn;
300 GDBusPendingReply pending;
303 static void builtin_security_result(dbus_bool_t authorized, void *user_data)
305 struct builtin_security_data *data = user_data;
307 if (authorized == TRUE)
308 g_dbus_pending_success(data->conn, data->pending);
310 g_dbus_pending_error(data->conn, data->pending,
311 DBUS_ERROR_AUTH_FAILED, NULL);
316 static void builtin_security_function(DBusConnection *conn,
318 gboolean interaction,
319 GDBusPendingReply pending)
321 struct builtin_security_data *data;
323 data = g_new0(struct builtin_security_data, 1);
325 data->pending = pending;
327 if (polkit_check_authorization(conn, action, interaction,
328 builtin_security_result, data, 30000) < 0)
329 g_dbus_pending_error(conn, pending, NULL, NULL);
332 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
333 const GDBusMethodTable *method, void *iface_user_data)
335 const GDBusSecurityTable *security;
337 for (security = security_table; security && security->privilege;
339 struct security_data *secdata;
340 gboolean interaction;
342 if (security->privilege != method->privilege)
345 secdata = g_new(struct security_data, 1);
346 secdata->pending = next_pending++;
347 secdata->message = dbus_message_ref(msg);
348 secdata->method = method;
349 secdata->iface_user_data = iface_user_data;
351 pending_security = g_slist_prepend(pending_security, secdata);
353 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
358 if (!(security->flags & G_DBUS_SECURITY_FLAG_BUILTIN) &&
360 security->function(conn, security->action,
361 interaction, secdata->pending);
363 builtin_security_function(conn, security->action,
364 interaction, secdata->pending);
372 static void generic_unregister(DBusConnection *connection, void *user_data)
374 struct generic_data *data = user_data;
376 g_free(data->introspect);
380 static struct interface_data *find_interface(GSList *interfaces,
388 for (list = interfaces; list; list = list->next) {
389 struct interface_data *iface = list->data;
390 if (!strcmp(name, iface->name))
397 static gboolean g_dbus_args_have_signature(const GDBusArgInfo *args,
398 DBusMessage *message)
400 const char *sig = dbus_message_get_signature(message);
401 const char *p = NULL;
403 for (; args && args->signature && *sig; args++) {
406 for (; *sig && *p; sig++, p++) {
412 if (*sig || (p && *p) || (args && args->signature))
418 static DBusHandlerResult generic_message(DBusConnection *connection,
419 DBusMessage *message, void *user_data)
421 struct generic_data *data = user_data;
422 struct interface_data *iface;
423 const GDBusMethodTable *method;
424 const char *interface;
426 interface = dbus_message_get_interface(message);
428 iface = find_interface(data->interfaces, interface);
430 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
432 for (method = iface->methods; method &&
433 method->name && method->function; method++) {
434 if (dbus_message_is_method_call(message, iface->name,
435 method->name) == FALSE)
438 if (g_dbus_args_have_signature(method->in_args,
442 if (check_privilege(connection, message, method,
443 iface->user_data) == TRUE)
444 return DBUS_HANDLER_RESULT_HANDLED;
446 return process_message(connection, message, method,
450 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
453 static DBusObjectPathVTable generic_table = {
454 .unregister_function = generic_unregister,
455 .message_function = generic_message,
458 static void invalidate_parent_data(DBusConnection *conn, const char *child_path)
460 struct generic_data *data = NULL;
461 char *parent_path, *slash;
463 parent_path = g_strdup(child_path);
464 slash = strrchr(parent_path, '/');
468 if (slash == parent_path && parent_path[1] != '\0')
469 parent_path[1] = '\0';
473 if (!strlen(parent_path))
476 if (dbus_connection_get_object_path_data(conn, parent_path,
477 (void *) &data) == FALSE) {
481 invalidate_parent_data(conn, parent_path);
486 g_free(data->introspect);
487 data->introspect = NULL;
493 static const GDBusMethodTable introspect_methods[] = {
494 { GDBUS_METHOD("Introspect", NULL,
495 GDBUS_ARGS({ "xml", "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,
596 const GDBusArgInfo **args)
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->args;
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 GDBusArgInfo *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 if (g_dbus_args_have_signature(args, signal) == FALSE) {
657 error("%s.%s: expected signature'%s' but got '%s'",
658 interface, name, args, signature);
663 ret = dbus_connection_send(conn, signal, NULL);
666 dbus_message_unref(signal);
671 gboolean g_dbus_register_interface(DBusConnection *connection,
672 const char *path, const char *name,
673 const GDBusMethodTable *methods,
674 const GDBusSignalTable *signals,
675 const GDBusPropertyTable *properties,
677 GDBusDestroyFunction destroy)
679 struct generic_data *data;
681 data = object_path_ref(connection, path);
685 if (find_interface(data->interfaces, name)) {
686 object_path_unref(connection, path);
690 add_interface(data, name, methods, signals,
691 properties, user_data, destroy);
693 g_free(data->introspect);
694 data->introspect = NULL;
699 gboolean g_dbus_unregister_interface(DBusConnection *connection,
700 const char *path, const char *name)
702 struct generic_data *data = NULL;
707 if (dbus_connection_get_object_path_data(connection, path,
708 (void *) &data) == FALSE)
714 if (remove_interface(data, name) == FALSE)
717 g_free(data->introspect);
718 data->introspect = NULL;
720 object_path_unref(connection, path);
725 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
727 if (security_table != NULL)
730 security_table = security;
735 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
737 security_table = NULL;
742 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
743 const char *format, va_list args)
747 vsnprintf(str, sizeof(str), format, args);
749 return dbus_message_new_error(message, name, str);
752 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
753 const char *format, ...)
758 va_start(args, format);
760 reply = g_dbus_create_error_valist(message, name, format, args);
767 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
768 int type, va_list args)
772 reply = dbus_message_new_method_return(message);
776 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
777 dbus_message_unref(reply);
784 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
789 va_start(args, type);
791 reply = g_dbus_create_reply_valist(message, type, args);
798 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
802 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
803 dbus_message_set_no_reply(message, TRUE);
805 result = dbus_connection_send(connection, message, NULL);
807 dbus_message_unref(message);
812 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
813 DBusMessage *message, int type, va_list args)
817 reply = dbus_message_new_method_return(message);
821 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
822 dbus_message_unref(reply);
826 return g_dbus_send_message(connection, reply);
829 gboolean g_dbus_send_reply(DBusConnection *connection,
830 DBusMessage *message, int type, ...)
835 va_start(args, type);
837 result = g_dbus_send_reply_valist(connection, message, type, args);
844 gboolean g_dbus_emit_signal(DBusConnection *connection,
845 const char *path, const char *interface,
846 const char *name, int type, ...)
851 va_start(args, type);
853 result = emit_signal_valist(connection, path, interface,
861 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
862 const char *path, const char *interface,
863 const char *name, int type, va_list args)
865 return emit_signal_valist(connection, path, interface,