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)
111 error("Unexpected signature: %s", sig);
116 g_string_append_printf(gstr,
117 "\t\t\t<arg type=\"%s\" direction=\"%s\"/>\n",
120 g_string_append_printf(gstr,
121 "\t\t\t<arg type=\"%s\"/>\n",
126 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
128 const GDBusMethodTable *method;
129 const GDBusSignalTable *signal;
131 for (method = iface->methods; method && method->name; method++) {
132 if (!strlen(method->signature) && !strlen(method->reply))
133 g_string_append_printf(gstr, "\t\t<method name=\"%s\"/>\n",
136 g_string_append_printf(gstr, "\t\t<method name=\"%s\">\n",
138 print_arguments(gstr, method->signature, "in");
139 print_arguments(gstr, method->reply, "out");
140 g_string_append_printf(gstr, "\t\t</method>\n");
144 for (signal = iface->signals; signal && signal->name; signal++) {
145 if (!strlen(signal->signature))
146 g_string_append_printf(gstr, "\t\t<signal name=\"%s\"/>\n",
149 g_string_append_printf(gstr, "\t\t<signal name=\"%s\">\n",
151 print_arguments(gstr, signal->signature, NULL);
152 g_string_append_printf(gstr, "\t\t</signal>\n");
157 static void generate_introspection_xml(DBusConnection *conn,
158 struct generic_data *data, const char *path)
165 g_free(data->introspect);
167 gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
169 g_string_append_printf(gstr, "<node>\n");
171 for (list = data->interfaces; list; list = list->next) {
172 struct interface_data *iface = list->data;
174 g_string_append_printf(gstr, "\t<interface name=\"%s\">\n",
177 generate_interface_xml(gstr, iface);
179 g_string_append_printf(gstr, "\t</interface>\n");
182 if (!dbus_connection_list_registered(conn, path, &children))
185 for (i = 0; children[i]; i++)
186 g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n",
189 dbus_free_string_array(children);
192 g_string_append_printf(gstr, "</node>\n");
194 data->introspect = g_string_free(gstr, FALSE);
197 static DBusMessage *introspect(DBusConnection *connection,
198 DBusMessage *message, void *user_data)
200 struct generic_data *data = user_data;
203 if (!dbus_message_has_signature(message, DBUS_TYPE_INVALID_AS_STRING)) {
204 error("Unexpected signature to introspect call");
208 if (data->introspect == NULL)
209 generate_introspection_xml(connection, data,
210 dbus_message_get_path(message));
212 reply = dbus_message_new_method_return(message);
216 dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
222 static DBusHandlerResult process_message(DBusConnection *connection,
223 DBusMessage *message, const GDBusMethodTable *method,
224 void *iface_user_data)
228 reply = method->function(connection, message, iface_user_data);
230 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
232 dbus_message_unref(reply);
233 return DBUS_HANDLER_RESULT_HANDLED;
236 if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
238 return DBUS_HANDLER_RESULT_HANDLED;
242 return DBUS_HANDLER_RESULT_NEED_MEMORY;
244 dbus_connection_send(connection, reply, NULL);
245 dbus_message_unref(reply);
247 return DBUS_HANDLER_RESULT_HANDLED;
250 static GDBusPendingReply next_pending = 1;
251 static GSList *pending_security = NULL;
253 static const GDBusSecurityTable *security_table = NULL;
255 void g_dbus_pending_success(DBusConnection *connection,
256 GDBusPendingReply pending)
260 for (list = pending_security; list; list = list->next) {
261 struct security_data *secdata = list->data;
263 if (secdata->pending != pending)
266 pending_security = g_slist_remove(pending_security, secdata);
268 process_message(connection, secdata->message,
269 secdata->method, secdata->iface_user_data);
271 dbus_message_unref(secdata->message);
277 void g_dbus_pending_error_valist(DBusConnection *connection,
278 GDBusPendingReply pending, const char *name,
279 const char *format, va_list args)
283 for (list = pending_security; list; list = list->next) {
284 struct security_data *secdata = list->data;
287 if (secdata->pending != pending)
290 pending_security = g_slist_remove(pending_security, secdata);
292 reply = g_dbus_create_error_valist(secdata->message,
295 dbus_connection_send(connection, reply, NULL);
296 dbus_message_unref(reply);
299 dbus_message_unref(secdata->message);
305 void g_dbus_pending_error(DBusConnection *connection,
306 GDBusPendingReply pending,
307 const char *name, const char *format, ...)
311 va_start(args, format);
313 g_dbus_pending_error_valist(connection, pending, name, format, args);
318 int polkit_check_authorization(DBusConnection *conn,
319 const char *action, gboolean interaction,
320 void (*function) (dbus_bool_t authorized,
322 void *user_data, int timeout);
324 struct builtin_security_data {
325 DBusConnection *conn;
326 GDBusPendingReply pending;
329 static void builtin_security_result(dbus_bool_t authorized, void *user_data)
331 struct builtin_security_data *data = user_data;
333 if (authorized == TRUE)
334 g_dbus_pending_success(data->conn, data->pending);
336 g_dbus_pending_error(data->conn, data->pending,
337 DBUS_ERROR_AUTH_FAILED, NULL);
342 static void builtin_security_function(DBusConnection *conn,
344 gboolean interaction,
345 GDBusPendingReply pending)
347 struct builtin_security_data *data;
349 data = g_new0(struct builtin_security_data, 1);
351 data->pending = pending;
353 if (polkit_check_authorization(conn, action, interaction,
354 builtin_security_result, data, 30000) < 0)
355 g_dbus_pending_error(conn, pending, NULL, NULL);
358 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
359 const GDBusMethodTable *method, void *iface_user_data)
361 const GDBusSecurityTable *security;
363 for (security = security_table; security && security->privilege;
365 struct security_data *secdata;
366 gboolean interaction;
368 if (security->privilege != method->privilege)
371 secdata = g_new(struct security_data, 1);
372 secdata->pending = next_pending++;
373 secdata->message = dbus_message_ref(msg);
374 secdata->method = method;
375 secdata->iface_user_data = iface_user_data;
377 pending_security = g_slist_prepend(pending_security, secdata);
379 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
384 if (!(security->flags & G_DBUS_SECURITY_FLAG_BUILTIN) &&
386 security->function(conn, security->action,
387 interaction, secdata->pending);
389 builtin_security_function(conn, security->action,
390 interaction, secdata->pending);
398 static void generic_unregister(DBusConnection *connection, void *user_data)
400 struct generic_data *data = user_data;
402 g_free(data->introspect);
406 static struct interface_data *find_interface(GSList *interfaces,
414 for (list = interfaces; list; list = list->next) {
415 struct interface_data *iface = list->data;
416 if (!strcmp(name, iface->name))
423 static DBusHandlerResult generic_message(DBusConnection *connection,
424 DBusMessage *message, void *user_data)
426 struct generic_data *data = user_data;
427 struct interface_data *iface;
428 const GDBusMethodTable *method;
429 const char *interface;
431 interface = dbus_message_get_interface(message);
433 iface = find_interface(data->interfaces, interface);
435 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
437 for (method = iface->methods; method &&
438 method->name && method->function; method++) {
439 if (dbus_message_is_method_call(message, iface->name,
440 method->name) == FALSE)
443 if (dbus_message_has_signature(message,
444 method->signature) == FALSE)
447 if (check_privilege(connection, message, method,
448 iface->user_data) == TRUE)
449 return DBUS_HANDLER_RESULT_HANDLED;
451 return process_message(connection, message, method,
455 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
458 static DBusObjectPathVTable generic_table = {
459 .unregister_function = generic_unregister,
460 .message_function = generic_message,
463 static void invalidate_parent_data(DBusConnection *conn, const char *child_path)
465 struct generic_data *data = NULL;
466 char *parent_path, *slash;
468 parent_path = g_strdup(child_path);
469 slash = strrchr(parent_path, '/');
473 if (slash == parent_path && parent_path[1] != '\0')
474 parent_path[1] = '\0';
478 if (!strlen(parent_path))
481 if (dbus_connection_get_object_path_data(conn, parent_path,
482 (void *) &data) == FALSE) {
486 invalidate_parent_data(conn, parent_path);
491 g_free(data->introspect);
492 data->introspect = NULL;
498 static GDBusMethodTable introspect_methods[] = {
499 { "Introspect", "", "s", introspect },
503 static void add_interface(struct generic_data *data, const char *name,
504 const GDBusMethodTable *methods,
505 const GDBusSignalTable *signals,
506 const GDBusPropertyTable *properties,
508 GDBusDestroyFunction destroy)
510 struct interface_data *iface;
512 iface = g_new0(struct interface_data, 1);
513 iface->name = g_strdup(name);
514 iface->methods = methods;
515 iface->signals = signals;
516 iface->properties = properties;
517 iface->user_data = user_data;
518 iface->destroy = destroy;
520 data->interfaces = g_slist_append(data->interfaces, iface);
523 static struct generic_data *object_path_ref(DBusConnection *connection,
526 struct generic_data *data;
528 if (dbus_connection_get_object_path_data(connection, path,
529 (void *) &data) == TRUE) {
536 data = g_new0(struct generic_data, 1);
539 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
541 if (!dbus_connection_register_object_path(connection, path,
542 &generic_table, data)) {
543 g_free(data->introspect);
548 invalidate_parent_data(connection, path);
550 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE,
551 introspect_methods, NULL, NULL, data, NULL);
556 static gboolean remove_interface(struct generic_data *data, const char *name)
558 struct interface_data *iface;
560 iface = find_interface(data->interfaces, name);
564 data->interfaces = g_slist_remove(data->interfaces, iface);
567 iface->destroy(iface->user_data);
575 static void object_path_unref(DBusConnection *connection, const char *path)
577 struct generic_data *data = NULL;
579 if (dbus_connection_get_object_path_data(connection, path,
580 (void *) &data) == FALSE)
588 if (data->refcount > 0)
591 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
593 invalidate_parent_data(connection, path);
595 dbus_connection_unregister_object_path(connection, path);
598 static gboolean check_signal(DBusConnection *conn, const char *path,
599 const char *interface, const char *name,
602 struct generic_data *data = NULL;
603 struct interface_data *iface;
604 const GDBusSignalTable *signal;
607 if (!dbus_connection_get_object_path_data(conn, path,
608 (void *) &data) || data == NULL) {
609 error("dbus_connection_emit_signal: path %s isn't registered",
614 iface = find_interface(data->interfaces, interface);
616 error("dbus_connection_emit_signal: %s does not implement %s",
621 for (signal = iface->signals; signal && signal->name; signal++) {
622 if (!strcmp(signal->name, name)) {
623 *args = signal->signature;
629 error("No signal named %s on interface %s", name, interface);
636 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
638 const char *interface,
645 const char *signature, *args;
647 if (!check_signal(conn, path, interface, name, &args))
650 signal = dbus_message_new_signal(path, interface, name);
651 if (signal == NULL) {
652 error("Unable to allocate new %s.%s signal", interface, name);
656 ret = dbus_message_append_args_valist(signal, first, var_args);
660 signature = dbus_message_get_signature(signal);
661 if (strcmp(args, signature) != 0) {
662 error("%s.%s: expected signature'%s' but got '%s'",
663 interface, name, args, signature);
668 ret = dbus_connection_send(conn, signal, NULL);
671 dbus_message_unref(signal);
676 gboolean g_dbus_register_interface(DBusConnection *connection,
677 const char *path, const char *name,
678 const GDBusMethodTable *methods,
679 const GDBusSignalTable *signals,
680 const GDBusPropertyTable *properties,
682 GDBusDestroyFunction destroy)
684 struct generic_data *data;
686 data = object_path_ref(connection, path);
690 if (find_interface(data->interfaces, name)) {
691 object_path_unref(connection, path);
695 add_interface(data, name, methods, signals,
696 properties, user_data, destroy);
698 g_free(data->introspect);
699 data->introspect = NULL;
704 gboolean g_dbus_unregister_interface(DBusConnection *connection,
705 const char *path, const char *name)
707 struct generic_data *data = NULL;
712 if (dbus_connection_get_object_path_data(connection, path,
713 (void *) &data) == FALSE)
719 if (remove_interface(data, name) == FALSE)
722 g_free(data->introspect);
723 data->introspect = NULL;
725 object_path_unref(connection, path);
730 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
732 if (security_table != NULL)
735 security_table = security;
740 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
742 security_table = NULL;
747 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
748 const char *format, va_list args)
752 vsnprintf(str, sizeof(str), format, args);
754 return dbus_message_new_error(message, name, str);
757 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
758 const char *format, ...)
763 va_start(args, format);
765 reply = g_dbus_create_error_valist(message, name, format, args);
772 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
773 int type, va_list args)
777 reply = dbus_message_new_method_return(message);
781 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
782 dbus_message_unref(reply);
789 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
794 va_start(args, type);
796 reply = g_dbus_create_reply_valist(message, type, args);
803 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
807 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
808 dbus_message_set_no_reply(message, TRUE);
810 result = dbus_connection_send(connection, message, NULL);
812 dbus_message_unref(message);
817 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
818 DBusMessage *message, int type, va_list args)
822 reply = dbus_message_new_method_return(message);
826 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
827 dbus_message_unref(reply);
831 return g_dbus_send_message(connection, reply);
834 gboolean g_dbus_send_reply(DBusConnection *connection,
835 DBusMessage *message, int type, ...)
840 va_start(args, type);
842 result = g_dbus_send_reply_valist(connection, message, type, args);
849 gboolean g_dbus_emit_signal(DBusConnection *connection,
850 const char *path, const char *interface,
851 const char *name, int type, ...)
856 va_start(args, type);
858 result = emit_signal_valist(connection, path, interface,
866 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
867 const char *path, const char *interface,
868 const char *name, int type, va_list args)
870 return emit_signal_valist(connection, path, interface,