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 #define G_DBUS_ANNOTATE(prefix_, name_, value_) \
80 prefix_ "<annotation name=\"org.freedesktop.DBus." name_ "\" " \
81 "value=\"" value_ "\"/>\n"
83 #define G_DBUS_ANNOTATE_DEPRECATED(prefix_) \
84 G_DBUS_ANNOTATE(prefix_, "Deprecated", "true")
86 #define G_DBUS_ANNOTATE_NOREPLY(prefix_) \
87 G_DBUS_ANNOTATE(prefix_, "Method.NoReply", "true")
89 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
91 const GDBusMethodTable *method;
92 const GDBusSignalTable *signal;
94 for (method = iface->methods; method && method->name; method++) {
95 gboolean deprecated = method->flags &
96 G_DBUS_METHOD_FLAG_DEPRECATED;
97 gboolean noreply = method->flags &
98 G_DBUS_METHOD_FLAG_NOREPLY;
100 if (!deprecated && !noreply &&
101 !(method->in_args && method->in_args->name) &&
102 !(method->out_args && method->out_args->name))
103 g_string_append_printf(gstr,
104 "\t\t<method name=\"%s\"/>\n",
107 g_string_append_printf(gstr,
108 "\t\t<method name=\"%s\">\n",
110 print_arguments(gstr, method->in_args, "in");
111 print_arguments(gstr, method->out_args, "out");
114 g_string_append_printf(gstr,
115 G_DBUS_ANNOTATE_DEPRECATED("\t\t\t"));
117 g_string_append_printf(gstr,
118 G_DBUS_ANNOTATE_NOREPLY("\t\t\t"));
120 g_string_append_printf(gstr, "\t\t</method>\n");
124 for (signal = iface->signals; signal && signal->name; signal++) {
125 gboolean deprecated = signal->flags &
126 G_DBUS_SIGNAL_FLAG_DEPRECATED;
128 if (!deprecated && !(signal->args && signal->args->name))
129 g_string_append_printf(gstr,
130 "\t\t<signal name=\"%s\"/>\n",
133 g_string_append_printf(gstr,
134 "\t\t<signal name=\"%s\">\n",
136 print_arguments(gstr, signal->args, NULL);
139 g_string_append_printf(gstr,
140 G_DBUS_ANNOTATE_DEPRECATED("\t\t\t"));
142 g_string_append_printf(gstr, "\t\t</signal>\n");
147 static void generate_introspection_xml(DBusConnection *conn,
148 struct generic_data *data, const char *path)
155 g_free(data->introspect);
157 gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
159 g_string_append_printf(gstr, "<node>\n");
161 for (list = data->interfaces; list; list = list->next) {
162 struct interface_data *iface = list->data;
164 g_string_append_printf(gstr, "\t<interface name=\"%s\">\n",
167 generate_interface_xml(gstr, iface);
169 g_string_append_printf(gstr, "\t</interface>\n");
172 if (!dbus_connection_list_registered(conn, path, &children))
175 for (i = 0; children[i]; i++)
176 g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n",
179 dbus_free_string_array(children);
182 g_string_append_printf(gstr, "</node>\n");
184 data->introspect = g_string_free(gstr, FALSE);
187 static DBusMessage *introspect(DBusConnection *connection,
188 DBusMessage *message, void *user_data)
190 struct generic_data *data = user_data;
193 if (data->introspect == NULL)
194 generate_introspection_xml(connection, data,
195 dbus_message_get_path(message));
197 reply = dbus_message_new_method_return(message);
201 dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
207 static DBusHandlerResult process_message(DBusConnection *connection,
208 DBusMessage *message, const GDBusMethodTable *method,
209 void *iface_user_data)
213 reply = method->function(connection, message, iface_user_data);
215 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
217 dbus_message_unref(reply);
218 return DBUS_HANDLER_RESULT_HANDLED;
221 if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
223 return DBUS_HANDLER_RESULT_HANDLED;
227 return DBUS_HANDLER_RESULT_NEED_MEMORY;
229 dbus_connection_send(connection, reply, NULL);
230 dbus_message_unref(reply);
232 return DBUS_HANDLER_RESULT_HANDLED;
235 static GDBusPendingReply next_pending = 1;
236 static GSList *pending_security = NULL;
238 static const GDBusSecurityTable *security_table = NULL;
240 void g_dbus_pending_success(DBusConnection *connection,
241 GDBusPendingReply pending)
245 for (list = pending_security; list; list = list->next) {
246 struct security_data *secdata = list->data;
248 if (secdata->pending != pending)
251 pending_security = g_slist_remove(pending_security, secdata);
253 process_message(connection, secdata->message,
254 secdata->method, secdata->iface_user_data);
256 dbus_message_unref(secdata->message);
262 void g_dbus_pending_error_valist(DBusConnection *connection,
263 GDBusPendingReply pending, const char *name,
264 const char *format, va_list args)
268 for (list = pending_security; list; list = list->next) {
269 struct security_data *secdata = list->data;
272 if (secdata->pending != pending)
275 pending_security = g_slist_remove(pending_security, secdata);
277 reply = g_dbus_create_error_valist(secdata->message,
280 dbus_connection_send(connection, reply, NULL);
281 dbus_message_unref(reply);
284 dbus_message_unref(secdata->message);
290 void g_dbus_pending_error(DBusConnection *connection,
291 GDBusPendingReply pending,
292 const char *name, const char *format, ...)
296 va_start(args, format);
298 g_dbus_pending_error_valist(connection, pending, name, format, args);
303 int polkit_check_authorization(DBusConnection *conn,
304 const char *action, gboolean interaction,
305 void (*function) (dbus_bool_t authorized,
307 void *user_data, int timeout);
309 struct builtin_security_data {
310 DBusConnection *conn;
311 GDBusPendingReply pending;
314 static void builtin_security_result(dbus_bool_t authorized, void *user_data)
316 struct builtin_security_data *data = user_data;
318 if (authorized == TRUE)
319 g_dbus_pending_success(data->conn, data->pending);
321 g_dbus_pending_error(data->conn, data->pending,
322 DBUS_ERROR_AUTH_FAILED, NULL);
327 static void builtin_security_function(DBusConnection *conn,
329 gboolean interaction,
330 GDBusPendingReply pending)
332 struct builtin_security_data *data;
334 data = g_new0(struct builtin_security_data, 1);
336 data->pending = pending;
338 if (polkit_check_authorization(conn, action, interaction,
339 builtin_security_result, data, 30000) < 0)
340 g_dbus_pending_error(conn, pending, NULL, NULL);
343 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
344 const GDBusMethodTable *method, void *iface_user_data)
346 const GDBusSecurityTable *security;
348 for (security = security_table; security && security->privilege;
350 struct security_data *secdata;
351 gboolean interaction;
353 if (security->privilege != method->privilege)
356 secdata = g_new(struct security_data, 1);
357 secdata->pending = next_pending++;
358 secdata->message = dbus_message_ref(msg);
359 secdata->method = method;
360 secdata->iface_user_data = iface_user_data;
362 pending_security = g_slist_prepend(pending_security, secdata);
364 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
369 if (!(security->flags & G_DBUS_SECURITY_FLAG_BUILTIN) &&
371 security->function(conn, security->action,
372 interaction, secdata->pending);
374 builtin_security_function(conn, security->action,
375 interaction, secdata->pending);
383 static void generic_unregister(DBusConnection *connection, void *user_data)
385 struct generic_data *data = user_data;
387 g_free(data->introspect);
391 static struct interface_data *find_interface(GSList *interfaces,
399 for (list = interfaces; list; list = list->next) {
400 struct interface_data *iface = list->data;
401 if (!strcmp(name, iface->name))
408 static gboolean g_dbus_args_have_signature(const GDBusArgInfo *args,
409 DBusMessage *message)
411 const char *sig = dbus_message_get_signature(message);
412 const char *p = NULL;
414 for (; args && args->signature && *sig; args++) {
417 for (; *sig && *p; sig++, p++) {
423 if (*sig || (p && *p) || (args && args->signature))
429 static DBusHandlerResult generic_message(DBusConnection *connection,
430 DBusMessage *message, void *user_data)
432 struct generic_data *data = user_data;
433 struct interface_data *iface;
434 const GDBusMethodTable *method;
435 const char *interface;
437 interface = dbus_message_get_interface(message);
439 iface = find_interface(data->interfaces, interface);
441 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
443 for (method = iface->methods; method &&
444 method->name && method->function; method++) {
445 if (dbus_message_is_method_call(message, iface->name,
446 method->name) == FALSE)
449 if (g_dbus_args_have_signature(method->in_args,
453 if (check_privilege(connection, message, method,
454 iface->user_data) == TRUE)
455 return DBUS_HANDLER_RESULT_HANDLED;
457 return process_message(connection, message, method,
461 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
464 static DBusObjectPathVTable generic_table = {
465 .unregister_function = generic_unregister,
466 .message_function = generic_message,
469 static void invalidate_parent_data(DBusConnection *conn, const char *child_path)
471 struct generic_data *data = NULL;
472 char *parent_path, *slash;
474 parent_path = g_strdup(child_path);
475 slash = strrchr(parent_path, '/');
479 if (slash == parent_path && parent_path[1] != '\0')
480 parent_path[1] = '\0';
484 if (!strlen(parent_path))
487 if (dbus_connection_get_object_path_data(conn, parent_path,
488 (void *) &data) == FALSE) {
492 invalidate_parent_data(conn, parent_path);
497 g_free(data->introspect);
498 data->introspect = NULL;
504 static const GDBusMethodTable introspect_methods[] = {
505 { GDBUS_METHOD("Introspect", NULL,
506 GDBUS_ARGS({ "xml", "s" }), introspect) },
510 static inline const GDBusPropertyTable *find_property(const GDBusPropertyTable *properties,
513 const GDBusPropertyTable *p;
515 for (p = properties; p && p->name; p++) {
516 if (strcmp(name, p->name) == 0)
523 static DBusMessage *properties_get(DBusConnection *connection,
524 DBusMessage *message, void *user_data)
526 struct generic_data *data = user_data;
527 struct interface_data *iface;
528 const GDBusPropertyTable *property;
529 const char *interface, *name;
530 DBusMessageIter iter, value;
533 if (!dbus_message_get_args(message, NULL,
534 DBUS_TYPE_STRING, &interface,
535 DBUS_TYPE_STRING, &name,
539 iface = find_interface(data->interfaces, interface);
541 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
542 "No such interface '%s'", interface);
544 property = find_property(iface->properties, name);
545 if (property == NULL)
546 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
547 "No such property '%s'", name);
549 if (property->exists != NULL &&
550 !property->exists(property, iface->user_data))
551 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
552 "No such property '%s'", name);
554 if (property->get == NULL)
555 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
556 "Property '%s' is not readable", name);
558 reply = dbus_message_new_method_return(message);
562 dbus_message_iter_init_append(reply, &iter);
563 dbus_message_iter_open_container(&iter, DBUS_TYPE_VARIANT,
564 property->type, &value);
566 if (!property->get(property, &value, iface->user_data)) {
567 dbus_message_unref(reply);
571 dbus_message_iter_close_container(&iter, &value);
576 static DBusMessage *properties_get_all(DBusConnection *connection,
577 DBusMessage *message, void *user_data)
579 struct generic_data *data = user_data;
580 struct interface_data *iface;
581 const GDBusPropertyTable *p;
582 const char *interface;
583 DBusMessageIter iter, dict;
586 if (!dbus_message_get_args(message, NULL,
587 DBUS_TYPE_STRING, &interface,
591 iface = find_interface(data->interfaces, interface);
593 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
594 "No such interface '%s'", interface);
596 reply = dbus_message_new_method_return(message);
600 dbus_message_iter_init_append(reply, &iter);
601 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
602 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
603 DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
604 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
606 for (p = iface->properties; p && p->name; p++) {
607 DBusMessageIter entry, value;
612 if (p->exists != NULL && !p->exists(p, iface->user_data))
615 dbus_message_iter_open_container(&dict, DBUS_TYPE_DICT_ENTRY,
617 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING,
619 dbus_message_iter_open_container(&entry, DBUS_TYPE_VARIANT,
622 if (!p->get(p, &value, iface->user_data)) {
623 dbus_message_unref(reply);
627 dbus_message_iter_close_container(&entry, &value);
628 dbus_message_iter_close_container(&dict, &entry);
631 dbus_message_iter_close_container(&iter, &dict);
636 static DBusMessage *properties_set(DBusConnection *connection,
637 DBusMessage *message, void *user_data)
639 return dbus_message_new_method_return(message);
642 static const GDBusMethodTable properties_methods[] = {
643 { GDBUS_METHOD("Get",
644 GDBUS_ARGS({ "interface", "s" }, { "name", "s" }),
645 GDBUS_ARGS({ "value", "v" }),
647 { GDBUS_ASYNC_METHOD("Set", NULL,
648 GDBUS_ARGS({ "interface", "s" }, { "name", "s" },
651 { GDBUS_METHOD("GetAll",
652 GDBUS_ARGS({ "interface", "s" }),
653 GDBUS_ARGS({ "properties", "a{sv}" }),
654 properties_get_all) },
658 static const GDBusSignalTable properties_signals[] = {
659 { GDBUS_SIGNAL("PropertiesChanged",
660 GDBUS_ARGS({ "interface", "s" },
661 { "changed_properties", "a{sv}" },
662 { "invalidated_properties", "as"})) },
666 static void add_interface(struct generic_data *data, const char *name,
667 const GDBusMethodTable *methods,
668 const GDBusSignalTable *signals,
669 const GDBusPropertyTable *properties,
671 GDBusDestroyFunction destroy)
673 struct interface_data *iface;
675 iface = g_new0(struct interface_data, 1);
676 iface->name = g_strdup(name);
677 iface->methods = methods;
678 iface->signals = signals;
679 iface->properties = properties;
680 iface->user_data = user_data;
681 iface->destroy = destroy;
683 data->interfaces = g_slist_append(data->interfaces, iface);
686 static struct generic_data *object_path_ref(DBusConnection *connection,
689 struct generic_data *data;
691 if (dbus_connection_get_object_path_data(connection, path,
692 (void *) &data) == TRUE) {
699 data = g_new0(struct generic_data, 1);
702 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
704 if (!dbus_connection_register_object_path(connection, path,
705 &generic_table, data)) {
706 g_free(data->introspect);
711 invalidate_parent_data(connection, path);
713 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE,
714 introspect_methods, NULL, NULL, data, NULL);
716 add_interface(data, DBUS_INTERFACE_PROPERTIES, properties_methods,
717 properties_signals, NULL, data, NULL);
722 static gboolean remove_interface(struct generic_data *data, const char *name)
724 struct interface_data *iface;
726 iface = find_interface(data->interfaces, name);
730 data->interfaces = g_slist_remove(data->interfaces, iface);
733 iface->destroy(iface->user_data);
741 static void object_path_unref(DBusConnection *connection, const char *path)
743 struct generic_data *data = NULL;
745 if (dbus_connection_get_object_path_data(connection, path,
746 (void *) &data) == FALSE)
754 if (data->refcount > 0)
757 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
758 remove_interface(data, DBUS_INTERFACE_PROPERTIES);
760 invalidate_parent_data(connection, path);
762 dbus_connection_unregister_object_path(connection, path);
765 static gboolean check_signal(DBusConnection *conn, const char *path,
766 const char *interface, const char *name,
767 const GDBusArgInfo **args)
769 struct generic_data *data = NULL;
770 struct interface_data *iface;
771 const GDBusSignalTable *signal;
774 if (!dbus_connection_get_object_path_data(conn, path,
775 (void *) &data) || data == NULL) {
776 error("dbus_connection_emit_signal: path %s isn't registered",
781 iface = find_interface(data->interfaces, interface);
783 error("dbus_connection_emit_signal: %s does not implement %s",
788 for (signal = iface->signals; signal && signal->name; signal++) {
789 if (!strcmp(signal->name, name)) {
790 *args = signal->args;
795 error("No signal named %s on interface %s", name, interface);
799 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
801 const char *interface,
808 const GDBusArgInfo *args;
810 if (!check_signal(conn, path, interface, name, &args))
813 signal = dbus_message_new_signal(path, interface, name);
814 if (signal == NULL) {
815 error("Unable to allocate new %s.%s signal", interface, name);
819 ret = dbus_message_append_args_valist(signal, first, var_args);
823 if (g_dbus_args_have_signature(args, signal) == FALSE) {
824 error("%s.%s: got unexpected signature '%s'", interface, name,
825 dbus_message_get_signature(signal));
830 ret = dbus_connection_send(conn, signal, NULL);
833 dbus_message_unref(signal);
838 gboolean g_dbus_register_interface(DBusConnection *connection,
839 const char *path, const char *name,
840 const GDBusMethodTable *methods,
841 const GDBusSignalTable *signals,
842 const GDBusPropertyTable *properties,
844 GDBusDestroyFunction destroy)
846 struct generic_data *data;
848 data = object_path_ref(connection, path);
852 if (find_interface(data->interfaces, name)) {
853 object_path_unref(connection, path);
857 add_interface(data, name, methods, signals,
858 properties, user_data, destroy);
860 g_free(data->introspect);
861 data->introspect = NULL;
866 gboolean g_dbus_unregister_interface(DBusConnection *connection,
867 const char *path, const char *name)
869 struct generic_data *data = NULL;
874 if (dbus_connection_get_object_path_data(connection, path,
875 (void *) &data) == FALSE)
881 if (remove_interface(data, name) == FALSE)
884 g_free(data->introspect);
885 data->introspect = NULL;
887 object_path_unref(connection, path);
892 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
894 if (security_table != NULL)
897 security_table = security;
902 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
904 security_table = NULL;
909 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
910 const char *format, va_list args)
914 vsnprintf(str, sizeof(str), format, args);
916 return dbus_message_new_error(message, name, str);
919 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
920 const char *format, ...)
925 va_start(args, format);
927 reply = g_dbus_create_error_valist(message, name, format, args);
934 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
935 int type, va_list args)
939 reply = dbus_message_new_method_return(message);
943 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
944 dbus_message_unref(reply);
951 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
956 va_start(args, type);
958 reply = g_dbus_create_reply_valist(message, type, args);
965 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
969 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
970 dbus_message_set_no_reply(message, TRUE);
972 result = dbus_connection_send(connection, message, NULL);
974 dbus_message_unref(message);
979 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
980 DBusMessage *message, int type, va_list args)
984 reply = dbus_message_new_method_return(message);
988 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
989 dbus_message_unref(reply);
993 return g_dbus_send_message(connection, reply);
996 gboolean g_dbus_send_reply(DBusConnection *connection,
997 DBusMessage *message, int type, ...)
1002 va_start(args, type);
1004 result = g_dbus_send_reply_valist(connection, message, type, args);
1011 gboolean g_dbus_emit_signal(DBusConnection *connection,
1012 const char *path, const char *interface,
1013 const char *name, int type, ...)
1018 va_start(args, type);
1020 result = emit_signal_valist(connection, path, interface,
1028 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
1029 const char *path, const char *interface,
1030 const char *name, int type, va_list args)
1032 return emit_signal_valist(connection, path, interface,