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>
40 #define DBUS_INTERFACE_OBJECT_MANAGER "org.freedesktop.DBus.ObjectManager"
43 unsigned int refcount;
51 gboolean pending_prop;
53 struct generic_data *parent;
56 struct interface_data {
58 const GDBusMethodTable *methods;
59 const GDBusSignalTable *signals;
60 const GDBusPropertyTable *properties;
63 GDBusDestroyFunction destroy;
66 struct security_data {
67 GDBusPendingReply pending;
69 const GDBusMethodTable *method;
70 void *iface_user_data;
73 struct property_data {
74 GDBusPendingPropertySet id;
78 static gboolean process_changes(gpointer user_data);
79 static void process_properties_from_interface(struct generic_data *data,
80 struct interface_data *iface);
81 static void process_property_changes(struct generic_data *data);
83 static void print_arguments(GString *gstr, const GDBusArgInfo *args,
84 const char *direction)
86 for (; args && args->name; args++) {
87 g_string_append_printf(gstr,
88 "\t\t\t<arg name=\"%s\" type=\"%s\"",
89 args->name, args->signature);
92 g_string_append_printf(gstr,
93 " direction=\"%s\"/>\n", direction);
95 g_string_append_printf(gstr, "/>\n");
100 #define G_DBUS_ANNOTATE(prefix_, name_, value_) \
101 prefix_ "<annotation name=\"org.freedesktop.DBus." name_ "\" " \
102 "value=\"" value_ "\"/>\n"
104 #define G_DBUS_ANNOTATE_DEPRECATED(prefix_) \
105 G_DBUS_ANNOTATE(prefix_, "Deprecated", "true")
107 #define G_DBUS_ANNOTATE_NOREPLY(prefix_) \
108 G_DBUS_ANNOTATE(prefix_, "Method.NoReply", "true")
110 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
112 const GDBusMethodTable *method;
113 const GDBusSignalTable *signal;
114 const GDBusPropertyTable *property;
116 for (method = iface->methods; method && method->name; method++) {
117 gboolean deprecated = method->flags &
118 G_DBUS_METHOD_FLAG_DEPRECATED;
119 gboolean noreply = method->flags &
120 G_DBUS_METHOD_FLAG_NOREPLY;
122 if (!deprecated && !noreply &&
123 !(method->in_args && method->in_args->name) &&
124 !(method->out_args && method->out_args->name))
125 g_string_append_printf(gstr,
126 "\t\t<method name=\"%s\"/>\n",
129 g_string_append_printf(gstr,
130 "\t\t<method name=\"%s\">\n",
132 print_arguments(gstr, method->in_args, "in");
133 print_arguments(gstr, method->out_args, "out");
136 g_string_append_printf(gstr,
137 G_DBUS_ANNOTATE_DEPRECATED("\t\t\t"));
139 g_string_append_printf(gstr,
140 G_DBUS_ANNOTATE_NOREPLY("\t\t\t"));
142 g_string_append_printf(gstr, "\t\t</method>\n");
146 for (signal = iface->signals; signal && signal->name; signal++) {
147 gboolean deprecated = signal->flags &
148 G_DBUS_SIGNAL_FLAG_DEPRECATED;
150 if (!deprecated && !(signal->args && signal->args->name))
151 g_string_append_printf(gstr,
152 "\t\t<signal name=\"%s\"/>\n",
155 g_string_append_printf(gstr,
156 "\t\t<signal name=\"%s\">\n",
158 print_arguments(gstr, signal->args, NULL);
161 g_string_append_printf(gstr,
162 G_DBUS_ANNOTATE_DEPRECATED("\t\t\t"));
164 g_string_append_printf(gstr, "\t\t</signal>\n");
168 for (property = iface->properties; property && property->name;
170 gboolean deprecated = property->flags &
171 G_DBUS_PROPERTY_FLAG_DEPRECATED;
173 g_string_append_printf(gstr, "\t\t<property name=\"%s\""
174 " type=\"%s\" access=\"%s%s\"",
175 property->name, property->type,
176 property->get ? "read" : "",
177 property->set ? "write" : "");
180 g_string_append_printf(gstr, "/>\n");
182 g_string_append_printf(gstr,
183 G_DBUS_ANNOTATE_DEPRECATED(">\n\t\t\t"));
187 static void generate_introspection_xml(DBusConnection *conn,
188 struct generic_data *data, const char *path)
195 g_free(data->introspect);
197 gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
199 g_string_append_printf(gstr, "<node>\n");
201 for (list = data->interfaces; list; list = list->next) {
202 struct interface_data *iface = list->data;
204 g_string_append_printf(gstr, "\t<interface name=\"%s\">\n",
207 generate_interface_xml(gstr, iface);
209 g_string_append_printf(gstr, "\t</interface>\n");
212 if (!dbus_connection_list_registered(conn, path, &children))
215 for (i = 0; children[i]; i++)
216 g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n",
219 dbus_free_string_array(children);
222 g_string_append_printf(gstr, "</node>\n");
224 data->introspect = g_string_free(gstr, FALSE);
227 static DBusMessage *introspect(DBusConnection *connection,
228 DBusMessage *message, void *user_data)
230 struct generic_data *data = user_data;
233 if (data->introspect == NULL)
234 generate_introspection_xml(connection, data,
235 dbus_message_get_path(message));
237 reply = dbus_message_new_method_return(message);
241 dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
247 static DBusHandlerResult process_message(DBusConnection *connection,
248 DBusMessage *message, const GDBusMethodTable *method,
249 void *iface_user_data)
253 reply = method->function(connection, message, iface_user_data);
255 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
257 dbus_message_unref(reply);
258 return DBUS_HANDLER_RESULT_HANDLED;
261 if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
263 return DBUS_HANDLER_RESULT_HANDLED;
267 return DBUS_HANDLER_RESULT_NEED_MEMORY;
269 dbus_connection_send(connection, reply, NULL);
270 dbus_message_unref(reply);
272 return DBUS_HANDLER_RESULT_HANDLED;
275 static GDBusPendingReply next_pending = 1;
276 static GSList *pending_security = NULL;
278 static const GDBusSecurityTable *security_table = NULL;
280 void g_dbus_pending_success(DBusConnection *connection,
281 GDBusPendingReply pending)
285 for (list = pending_security; list; list = list->next) {
286 struct security_data *secdata = list->data;
288 if (secdata->pending != pending)
291 pending_security = g_slist_remove(pending_security, secdata);
293 process_message(connection, secdata->message,
294 secdata->method, secdata->iface_user_data);
296 dbus_message_unref(secdata->message);
302 void g_dbus_pending_error_valist(DBusConnection *connection,
303 GDBusPendingReply pending, const char *name,
304 const char *format, va_list args)
308 for (list = pending_security; list; list = list->next) {
309 struct security_data *secdata = list->data;
312 if (secdata->pending != pending)
315 pending_security = g_slist_remove(pending_security, secdata);
317 reply = g_dbus_create_error_valist(secdata->message,
320 dbus_connection_send(connection, reply, NULL);
321 dbus_message_unref(reply);
324 dbus_message_unref(secdata->message);
330 void g_dbus_pending_error(DBusConnection *connection,
331 GDBusPendingReply pending,
332 const char *name, const char *format, ...)
336 va_start(args, format);
338 g_dbus_pending_error_valist(connection, pending, name, format, args);
343 int polkit_check_authorization(DBusConnection *conn,
344 const char *action, gboolean interaction,
345 void (*function) (dbus_bool_t authorized,
347 void *user_data, int timeout);
349 struct builtin_security_data {
350 DBusConnection *conn;
351 GDBusPendingReply pending;
354 static void builtin_security_result(dbus_bool_t authorized, void *user_data)
356 struct builtin_security_data *data = user_data;
358 if (authorized == TRUE)
359 g_dbus_pending_success(data->conn, data->pending);
361 g_dbus_pending_error(data->conn, data->pending,
362 DBUS_ERROR_AUTH_FAILED, NULL);
367 static void builtin_security_function(DBusConnection *conn,
369 gboolean interaction,
370 GDBusPendingReply pending)
372 struct builtin_security_data *data;
374 data = g_new0(struct builtin_security_data, 1);
376 data->pending = pending;
378 if (polkit_check_authorization(conn, action, interaction,
379 builtin_security_result, data, 30000) < 0)
380 g_dbus_pending_error(conn, pending, NULL, NULL);
383 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
384 const GDBusMethodTable *method, void *iface_user_data)
386 const GDBusSecurityTable *security;
388 for (security = security_table; security && security->privilege;
390 struct security_data *secdata;
391 gboolean interaction;
393 if (security->privilege != method->privilege)
396 secdata = g_new(struct security_data, 1);
397 secdata->pending = next_pending++;
398 secdata->message = dbus_message_ref(msg);
399 secdata->method = method;
400 secdata->iface_user_data = iface_user_data;
402 pending_security = g_slist_prepend(pending_security, secdata);
404 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
409 if (!(security->flags & G_DBUS_SECURITY_FLAG_BUILTIN) &&
411 security->function(conn, security->action,
412 interaction, secdata->pending);
414 builtin_security_function(conn, security->action,
415 interaction, secdata->pending);
423 static GDBusPendingPropertySet next_pending_property = 1;
424 static GSList *pending_property_set;
426 static struct property_data *remove_pending_property_data(
427 GDBusPendingPropertySet id)
429 struct property_data *propdata;
432 for (l = pending_property_set; l != NULL; l = l->next) {
434 if (propdata->id != id)
443 pending_property_set = g_slist_delete_link(pending_property_set, l);
448 void g_dbus_pending_property_success(DBusConnection *connection,
449 GDBusPendingPropertySet id)
451 struct property_data *propdata;
453 propdata = remove_pending_property_data(id);
454 if (propdata == NULL)
457 g_dbus_send_reply(connection, propdata->message, DBUS_TYPE_INVALID);
458 dbus_message_unref(propdata->message);
462 void g_dbus_pending_property_error_valist(DBusConnection *connection,
463 GDBusPendingReply id, const char *name,
464 const char *format, va_list args)
466 struct property_data *propdata;
469 propdata = remove_pending_property_data(id);
470 if (propdata == NULL)
473 reply = g_dbus_create_error_valist(propdata->message, name, format,
476 dbus_connection_send(connection, reply, NULL);
477 dbus_message_unref(reply);
480 dbus_message_unref(propdata->message);
484 void g_dbus_pending_property_error(DBusConnection *connection,
485 GDBusPendingReply id, const char *name,
486 const char *format, ...)
490 va_start(args, format);
492 g_dbus_pending_property_error_valist(connection, id, name, format,
498 static void reset_parent(gpointer data, gpointer user_data)
500 struct generic_data *child = data;
501 struct generic_data *parent = user_data;
503 child->parent = parent;
506 static void append_property(struct interface_data *iface,
507 const GDBusPropertyTable *p, DBusMessageIter *dict)
509 DBusMessageIter entry, value;
511 dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY, NULL,
513 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &p->name);
514 dbus_message_iter_open_container(&entry, DBUS_TYPE_VARIANT, p->type,
517 p->get(p, &value, iface->user_data);
519 dbus_message_iter_close_container(&entry, &value);
520 dbus_message_iter_close_container(dict, &entry);
523 static void append_properties(struct interface_data *data,
524 DBusMessageIter *iter)
526 DBusMessageIter dict;
527 const GDBusPropertyTable *p;
529 dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
530 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
531 DBUS_TYPE_STRING_AS_STRING
532 DBUS_TYPE_VARIANT_AS_STRING
533 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
535 for (p = data->properties; p && p->name; p++) {
539 if (p->exists != NULL && !p->exists(p, data->user_data))
542 append_property(data, p, &dict);
545 dbus_message_iter_close_container(iter, &dict);
548 static void append_interface(gpointer data, gpointer user_data)
550 struct interface_data *iface = data;
551 DBusMessageIter *array = user_data;
552 DBusMessageIter entry;
554 dbus_message_iter_open_container(array, DBUS_TYPE_DICT_ENTRY, NULL,
556 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &iface->name);
557 append_properties(data, &entry);
558 dbus_message_iter_close_container(array, &entry);
561 static void emit_interfaces_added(struct generic_data *data)
564 DBusMessageIter iter, array;
565 struct generic_data *parent = data->parent;
571 while (parent->parent)
572 parent = parent->parent;
574 signal = dbus_message_new_signal(parent->path,
575 DBUS_INTERFACE_OBJECT_MANAGER,
580 dbus_message_iter_init_append(signal, &iter);
581 dbus_message_iter_append_basic(&iter, DBUS_TYPE_OBJECT_PATH,
584 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
585 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
586 DBUS_TYPE_STRING_AS_STRING
587 DBUS_TYPE_ARRAY_AS_STRING
588 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
589 DBUS_TYPE_STRING_AS_STRING
590 DBUS_TYPE_VARIANT_AS_STRING
591 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
592 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &array);
594 g_slist_foreach(data->added, append_interface, &array);
595 g_slist_free(data->added);
598 dbus_message_iter_close_container(&iter, &array);
600 g_dbus_send_message(data->conn, signal);
603 static struct interface_data *find_interface(GSList *interfaces,
611 for (list = interfaces; list; list = list->next) {
612 struct interface_data *iface = list->data;
613 if (!strcmp(name, iface->name))
620 static gboolean g_dbus_args_have_signature(const GDBusArgInfo *args,
621 DBusMessage *message)
623 const char *sig = dbus_message_get_signature(message);
624 const char *p = NULL;
626 for (; args && args->signature && *sig; args++) {
629 for (; *sig && *p; sig++, p++) {
635 if (*sig || (p && *p) || (args && args->signature))
641 static gboolean remove_interface(struct generic_data *data, const char *name)
643 struct interface_data *iface;
645 iface = find_interface(data->interfaces, name);
649 process_properties_from_interface(data, iface);
651 data->interfaces = g_slist_remove(data->interfaces, iface);
653 if (iface->destroy) {
654 iface->destroy(iface->user_data);
655 iface->user_data = NULL;
658 if (data->parent == NULL) {
665 * Interface being removed was just added, on the same mainloop
666 * iteration? Don't send any signal
668 if (g_slist_find(data->added, iface)) {
669 data->added = g_slist_remove(data->added, iface);
675 data->removed = g_slist_prepend(data->removed, iface->name);
678 if (data->process_id > 0)
681 data->process_id = g_idle_add(process_changes, data);
686 static struct generic_data *invalidate_parent_data(DBusConnection *conn,
687 const char *child_path)
689 struct generic_data *data = NULL, *child = NULL, *parent = NULL;
690 char *parent_path, *slash;
692 parent_path = g_strdup(child_path);
693 slash = strrchr(parent_path, '/');
697 if (slash == parent_path && parent_path[1] != '\0')
698 parent_path[1] = '\0';
702 if (!strlen(parent_path))
705 if (dbus_connection_get_object_path_data(conn, parent_path,
706 (void *) &data) == FALSE) {
710 parent = invalidate_parent_data(conn, parent_path);
718 g_free(data->introspect);
719 data->introspect = NULL;
721 if (!dbus_connection_get_object_path_data(conn, child_path,
725 if (child == NULL || g_slist_find(data->objects, child) != NULL)
728 data->objects = g_slist_prepend(data->objects, child);
729 child->parent = data;
736 static inline const GDBusPropertyTable *find_property(const GDBusPropertyTable *properties,
739 const GDBusPropertyTable *p;
741 for (p = properties; p && p->name; p++) {
742 if (strcmp(name, p->name) == 0)
749 static DBusMessage *properties_get(DBusConnection *connection,
750 DBusMessage *message, void *user_data)
752 struct generic_data *data = user_data;
753 struct interface_data *iface;
754 const GDBusPropertyTable *property;
755 const char *interface, *name;
756 DBusMessageIter iter, value;
759 if (!dbus_message_get_args(message, NULL,
760 DBUS_TYPE_STRING, &interface,
761 DBUS_TYPE_STRING, &name,
765 iface = find_interface(data->interfaces, interface);
767 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
768 "No such interface '%s'", interface);
770 property = find_property(iface->properties, name);
771 if (property == NULL)
772 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
773 "No such property '%s'", name);
775 if (property->exists != NULL &&
776 !property->exists(property, iface->user_data))
777 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
778 "No such property '%s'", name);
780 if (property->get == NULL)
781 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
782 "Property '%s' is not readable", name);
784 reply = dbus_message_new_method_return(message);
788 dbus_message_iter_init_append(reply, &iter);
789 dbus_message_iter_open_container(&iter, DBUS_TYPE_VARIANT,
790 property->type, &value);
792 if (!property->get(property, &value, iface->user_data)) {
793 dbus_message_unref(reply);
797 dbus_message_iter_close_container(&iter, &value);
802 static DBusMessage *properties_get_all(DBusConnection *connection,
803 DBusMessage *message, void *user_data)
805 struct generic_data *data = user_data;
806 struct interface_data *iface;
807 const char *interface;
808 DBusMessageIter iter;
811 if (!dbus_message_get_args(message, NULL,
812 DBUS_TYPE_STRING, &interface,
816 iface = find_interface(data->interfaces, interface);
818 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
819 "No such interface '%s'", interface);
821 reply = dbus_message_new_method_return(message);
825 dbus_message_iter_init_append(reply, &iter);
827 append_properties(iface, &iter);
832 static DBusMessage *properties_set(DBusConnection *connection,
833 DBusMessage *message, void *user_data)
835 struct generic_data *data = user_data;
836 DBusMessageIter iter, sub;
837 struct interface_data *iface;
838 const GDBusPropertyTable *property;
839 const char *name, *interface;
840 struct property_data *propdata;
842 if (!dbus_message_iter_init(message, &iter))
843 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
844 "No arguments given");
846 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
847 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
848 "Invalid argument type: '%c'",
849 dbus_message_iter_get_arg_type(&iter));
851 dbus_message_iter_get_basic(&iter, &interface);
852 dbus_message_iter_next(&iter);
854 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
855 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
856 "Invalid argument type: '%c'",
857 dbus_message_iter_get_arg_type(&iter));
859 dbus_message_iter_get_basic(&iter, &name);
860 dbus_message_iter_next(&iter);
862 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_VARIANT)
863 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
864 "Invalid argument type: '%c'",
865 dbus_message_iter_get_arg_type(&iter));
867 dbus_message_iter_recurse(&iter, &sub);
869 iface = find_interface(data->interfaces, interface);
871 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
872 "No such interface '%s'", interface);
874 property = find_property(iface->properties, name);
875 if (property == NULL)
876 return g_dbus_create_error(message,
877 DBUS_ERROR_UNKNOWN_PROPERTY,
878 "No such property '%s'", name);
880 if (property->set == NULL)
881 return g_dbus_create_error(message,
882 DBUS_ERROR_PROPERTY_READ_ONLY,
883 "Property '%s' is not writable", name);
885 if (property->exists != NULL &&
886 !property->exists(property, iface->user_data))
887 return g_dbus_create_error(message,
888 DBUS_ERROR_UNKNOWN_PROPERTY,
889 "No such property '%s'", name);
891 propdata = g_new(struct property_data, 1);
892 propdata->id = next_pending_property++;
893 propdata->message = dbus_message_ref(message);
894 pending_property_set = g_slist_prepend(pending_property_set, propdata);
896 property->set(property, &sub, propdata->id, iface->user_data);
901 static const GDBusMethodTable properties_methods[] = {
902 { GDBUS_METHOD("Get",
903 GDBUS_ARGS({ "interface", "s" }, { "name", "s" }),
904 GDBUS_ARGS({ "value", "v" }),
906 { GDBUS_ASYNC_METHOD("Set",
907 GDBUS_ARGS({ "interface", "s" }, { "name", "s" },
911 { GDBUS_METHOD("GetAll",
912 GDBUS_ARGS({ "interface", "s" }),
913 GDBUS_ARGS({ "properties", "a{sv}" }),
914 properties_get_all) },
918 static const GDBusSignalTable properties_signals[] = {
919 { GDBUS_SIGNAL("PropertiesChanged",
920 GDBUS_ARGS({ "interface", "s" },
921 { "changed_properties", "a{sv}" },
922 { "invalidated_properties", "as"})) },
926 static void append_name(gpointer data, gpointer user_data)
929 DBusMessageIter *iter = user_data;
931 dbus_message_iter_append_basic(iter, DBUS_TYPE_STRING, &name);
934 static void emit_interfaces_removed(struct generic_data *data)
937 DBusMessageIter iter, array;
938 struct generic_data *parent = data->parent;
944 while (parent->parent)
945 parent = parent->parent;
947 signal = dbus_message_new_signal(parent->path,
948 DBUS_INTERFACE_OBJECT_MANAGER,
949 "InterfacesRemoved");
953 dbus_message_iter_init_append(signal, &iter);
954 dbus_message_iter_append_basic(&iter, DBUS_TYPE_OBJECT_PATH,
956 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
957 DBUS_TYPE_STRING_AS_STRING, &array);
959 g_slist_foreach(data->removed, append_name, &array);
960 g_slist_free_full(data->removed, g_free);
961 data->removed = NULL;
963 dbus_message_iter_close_container(&iter, &array);
965 g_dbus_send_message(data->conn, signal);
968 static gboolean process_changes(gpointer user_data)
970 struct generic_data *data = user_data;
972 data->process_id = 0;
974 if (data->added != NULL)
975 emit_interfaces_added(data);
977 /* Flush pending properties */
978 if (data->pending_prop == TRUE)
979 process_property_changes(data);
981 if (data->removed != NULL)
982 emit_interfaces_removed(data);
987 static void generic_unregister(DBusConnection *connection, void *user_data)
989 struct generic_data *data = user_data;
990 struct generic_data *parent = data->parent;
993 parent->objects = g_slist_remove(parent->objects, data);
995 if (data->process_id > 0) {
996 g_source_remove(data->process_id);
997 process_changes(data);
1000 g_slist_foreach(data->objects, reset_parent, data->parent);
1001 g_slist_free(data->objects);
1003 dbus_connection_unref(data->conn);
1004 g_free(data->introspect);
1009 static DBusHandlerResult generic_message(DBusConnection *connection,
1010 DBusMessage *message, void *user_data)
1012 struct generic_data *data = user_data;
1013 struct interface_data *iface;
1014 const GDBusMethodTable *method;
1015 const char *interface;
1017 interface = dbus_message_get_interface(message);
1019 iface = find_interface(data->interfaces, interface);
1021 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1023 for (method = iface->methods; method &&
1024 method->name && method->function; method++) {
1025 if (dbus_message_is_method_call(message, iface->name,
1026 method->name) == FALSE)
1029 if (g_dbus_args_have_signature(method->in_args,
1033 if (check_privilege(connection, message, method,
1034 iface->user_data) == TRUE)
1035 return DBUS_HANDLER_RESULT_HANDLED;
1037 return process_message(connection, message, method,
1041 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1044 static DBusObjectPathVTable generic_table = {
1045 .unregister_function = generic_unregister,
1046 .message_function = generic_message,
1049 static const GDBusMethodTable introspect_methods[] = {
1050 { GDBUS_METHOD("Introspect", NULL,
1051 GDBUS_ARGS({ "xml", "s" }), introspect) },
1055 static void append_interfaces(struct generic_data *data, DBusMessageIter *iter)
1057 DBusMessageIter array;
1059 dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
1060 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1061 DBUS_TYPE_STRING_AS_STRING
1062 DBUS_TYPE_ARRAY_AS_STRING
1063 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1064 DBUS_TYPE_STRING_AS_STRING
1065 DBUS_TYPE_VARIANT_AS_STRING
1066 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1067 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &array);
1069 g_slist_foreach(data->interfaces, append_interface, &array);
1071 dbus_message_iter_close_container(iter, &array);
1074 static void append_object(gpointer data, gpointer user_data)
1076 struct generic_data *child = data;
1077 DBusMessageIter *array = user_data;
1078 DBusMessageIter entry;
1080 dbus_message_iter_open_container(array, DBUS_TYPE_DICT_ENTRY, NULL,
1082 dbus_message_iter_append_basic(&entry, DBUS_TYPE_OBJECT_PATH,
1084 append_interfaces(child, &entry);
1085 dbus_message_iter_close_container(array, &entry);
1087 g_slist_foreach(child->objects, append_object, user_data);
1090 static DBusMessage *get_objects(DBusConnection *connection,
1091 DBusMessage *message, void *user_data)
1093 struct generic_data *data = user_data;
1095 DBusMessageIter iter;
1096 DBusMessageIter array;
1098 reply = dbus_message_new_method_return(message);
1102 dbus_message_iter_init_append(reply, &iter);
1104 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1105 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1106 DBUS_TYPE_OBJECT_PATH_AS_STRING
1107 DBUS_TYPE_ARRAY_AS_STRING
1108 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1109 DBUS_TYPE_STRING_AS_STRING
1110 DBUS_TYPE_ARRAY_AS_STRING
1111 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1112 DBUS_TYPE_STRING_AS_STRING
1113 DBUS_TYPE_VARIANT_AS_STRING
1114 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1115 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1116 DBUS_DICT_ENTRY_END_CHAR_AS_STRING,
1119 g_slist_foreach(data->objects, append_object, &array);
1121 dbus_message_iter_close_container(&iter, &array);
1126 static const GDBusMethodTable manager_methods[] = {
1127 { GDBUS_METHOD("GetManagedObjects", NULL,
1128 GDBUS_ARGS({ "objects", "a{oa{sa{sv}}}" }), get_objects) },
1132 static const GDBusSignalTable manager_signals[] = {
1133 { GDBUS_SIGNAL("InterfacesAdded",
1134 GDBUS_ARGS({ "object", "o" },
1135 { "interfaces", "a{sa{sv}}" })) },
1136 { GDBUS_SIGNAL("InterfacesRemoved",
1137 GDBUS_ARGS({ "object", "o" }, { "interfaces", "as" })) },
1141 static void add_interface(struct generic_data *data,
1143 const GDBusMethodTable *methods,
1144 const GDBusSignalTable *signals,
1145 const GDBusPropertyTable *properties,
1147 GDBusDestroyFunction destroy)
1149 struct interface_data *iface;
1151 iface = g_new0(struct interface_data, 1);
1152 iface->name = g_strdup(name);
1153 iface->methods = methods;
1154 iface->signals = signals;
1155 iface->properties = properties;
1156 iface->user_data = user_data;
1157 iface->destroy = destroy;
1159 data->interfaces = g_slist_append(data->interfaces, iface);
1160 if (data->parent == NULL)
1163 data->added = g_slist_append(data->added, iface);
1164 if (data->process_id > 0)
1167 data->process_id = g_idle_add(process_changes, data);
1170 static struct generic_data *object_path_ref(DBusConnection *connection,
1173 struct generic_data *data;
1175 if (dbus_connection_get_object_path_data(connection, path,
1176 (void *) &data) == TRUE) {
1183 data = g_new0(struct generic_data, 1);
1184 data->conn = dbus_connection_ref(connection);
1185 data->path = g_strdup(path);
1188 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
1190 if (!dbus_connection_register_object_path(connection, path,
1191 &generic_table, data)) {
1192 g_free(data->introspect);
1197 invalidate_parent_data(connection, path);
1199 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE, introspect_methods,
1200 NULL, NULL, data, NULL);
1202 /* Only root path export ObjectManager interface */
1203 if (data->parent == NULL)
1204 add_interface(data, DBUS_INTERFACE_OBJECT_MANAGER,
1205 manager_methods, manager_signals,
1208 add_interface(data, DBUS_INTERFACE_PROPERTIES, properties_methods,
1209 properties_signals, NULL, data, NULL);
1214 static void object_path_unref(DBusConnection *connection, const char *path)
1216 struct generic_data *data = NULL;
1218 if (dbus_connection_get_object_path_data(connection, path,
1219 (void *) &data) == FALSE)
1227 if (data->refcount > 0)
1230 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
1231 remove_interface(data, DBUS_INTERFACE_PROPERTIES);
1232 remove_interface(data, DBUS_INTERFACE_OBJECT_MANAGER);
1234 invalidate_parent_data(data->conn, data->path);
1236 dbus_connection_unregister_object_path(data->conn, data->path);
1239 static gboolean check_signal(DBusConnection *conn, const char *path,
1240 const char *interface, const char *name,
1241 const GDBusArgInfo **args)
1243 struct generic_data *data = NULL;
1244 struct interface_data *iface;
1245 const GDBusSignalTable *signal;
1248 if (!dbus_connection_get_object_path_data(conn, path,
1249 (void *) &data) || data == NULL) {
1250 error("dbus_connection_emit_signal: path %s isn't registered",
1255 iface = find_interface(data->interfaces, interface);
1256 if (iface == NULL) {
1257 error("dbus_connection_emit_signal: %s does not implement %s",
1262 for (signal = iface->signals; signal && signal->name; signal++) {
1263 if (!strcmp(signal->name, name)) {
1264 *args = signal->args;
1269 error("No signal named %s on interface %s", name, interface);
1273 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
1275 const char *interface,
1280 DBusMessage *signal;
1282 const GDBusArgInfo *args;
1284 if (!check_signal(conn, path, interface, name, &args))
1287 signal = dbus_message_new_signal(path, interface, name);
1288 if (signal == NULL) {
1289 error("Unable to allocate new %s.%s signal", interface, name);
1293 ret = dbus_message_append_args_valist(signal, first, var_args);
1297 if (g_dbus_args_have_signature(args, signal) == FALSE) {
1298 error("%s.%s: got unexpected signature '%s'", interface, name,
1299 dbus_message_get_signature(signal));
1304 ret = dbus_connection_send(conn, signal, NULL);
1307 dbus_message_unref(signal);
1312 gboolean g_dbus_register_interface(DBusConnection *connection,
1313 const char *path, const char *name,
1314 const GDBusMethodTable *methods,
1315 const GDBusSignalTable *signals,
1316 const GDBusPropertyTable *properties,
1318 GDBusDestroyFunction destroy)
1320 struct generic_data *data;
1322 data = object_path_ref(connection, path);
1326 if (find_interface(data->interfaces, name)) {
1327 object_path_unref(connection, path);
1331 add_interface(data, name, methods, signals, properties, user_data,
1334 g_free(data->introspect);
1335 data->introspect = NULL;
1340 gboolean g_dbus_unregister_interface(DBusConnection *connection,
1341 const char *path, const char *name)
1343 struct generic_data *data = NULL;
1348 if (dbus_connection_get_object_path_data(connection, path,
1349 (void *) &data) == FALSE)
1355 if (remove_interface(data, name) == FALSE)
1358 g_free(data->introspect);
1359 data->introspect = NULL;
1361 object_path_unref(connection, data->path);
1366 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
1368 if (security_table != NULL)
1371 security_table = security;
1376 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
1378 security_table = NULL;
1383 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
1384 const char *format, va_list args)
1388 vsnprintf(str, sizeof(str), format, args);
1390 return dbus_message_new_error(message, name, str);
1393 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
1394 const char *format, ...)
1399 va_start(args, format);
1401 reply = g_dbus_create_error_valist(message, name, format, args);
1408 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
1409 int type, va_list args)
1413 reply = dbus_message_new_method_return(message);
1417 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
1418 dbus_message_unref(reply);
1425 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
1430 va_start(args, type);
1432 reply = g_dbus_create_reply_valist(message, type, args);
1439 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
1443 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
1444 dbus_message_set_no_reply(message, TRUE);
1446 result = dbus_connection_send(connection, message, NULL);
1448 dbus_message_unref(message);
1453 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
1454 DBusMessage *message, int type, va_list args)
1458 reply = dbus_message_new_method_return(message);
1462 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
1463 dbus_message_unref(reply);
1467 return g_dbus_send_message(connection, reply);
1470 gboolean g_dbus_send_reply(DBusConnection *connection,
1471 DBusMessage *message, int type, ...)
1476 va_start(args, type);
1478 result = g_dbus_send_reply_valist(connection, message, type, args);
1485 gboolean g_dbus_emit_signal(DBusConnection *connection,
1486 const char *path, const char *interface,
1487 const char *name, int type, ...)
1492 va_start(args, type);
1494 result = emit_signal_valist(connection, path, interface,
1502 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
1503 const char *path, const char *interface,
1504 const char *name, int type, va_list args)
1506 return emit_signal_valist(connection, path, interface,
1510 static void process_properties_from_interface(struct generic_data *data,
1511 struct interface_data *iface)
1514 DBusMessage *signal;
1515 DBusMessageIter iter, dict, array;
1516 GSList *invalidated;
1518 if (iface->pending_prop == NULL)
1521 signal = dbus_message_new_signal(data->path,
1522 DBUS_INTERFACE_PROPERTIES, "PropertiesChanged");
1523 if (signal == NULL) {
1524 error("Unable to allocate new " DBUS_INTERFACE_PROPERTIES
1525 ".PropertiesChanged signal");
1529 iface->pending_prop = g_slist_reverse(iface->pending_prop);
1531 dbus_message_iter_init_append(signal, &iter);
1532 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &iface->name);
1533 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1534 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1535 DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
1536 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
1540 for (l = iface->pending_prop; l != NULL; l = l->next) {
1541 GDBusPropertyTable *p = l->data;
1546 if (p->exists != NULL && !p->exists(p, iface->user_data)) {
1547 invalidated = g_slist_prepend(invalidated, p);
1551 append_property(iface, p, &dict);
1554 dbus_message_iter_close_container(&iter, &dict);
1556 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1557 DBUS_TYPE_STRING_AS_STRING, &array);
1558 for (l = invalidated; l != NULL; l = g_slist_next(l)) {
1559 GDBusPropertyTable *p = l->data;
1561 dbus_message_iter_append_basic(&array, DBUS_TYPE_STRING,
1564 g_slist_free(invalidated);
1565 dbus_message_iter_close_container(&iter, &array);
1567 g_dbus_send_message(data->conn, signal);
1569 g_slist_free(iface->pending_prop);
1570 iface->pending_prop = NULL;
1573 static void process_property_changes(struct generic_data *data)
1577 for (l = data->interfaces; l != NULL; l = l->next) {
1578 struct interface_data *iface = l->data;
1580 process_properties_from_interface(data, iface);
1583 data->pending_prop = FALSE;
1586 void g_dbus_emit_property_changed(DBusConnection *connection,
1587 const char *path, const char *interface,
1590 const GDBusPropertyTable *property;
1591 struct generic_data *data;
1592 struct interface_data *iface;
1594 if (!dbus_connection_get_object_path_data(connection, path,
1595 (void **) &data) || data == NULL)
1598 iface = find_interface(data->interfaces, interface);
1602 property = find_property(iface->properties, name);
1603 if (property == NULL) {
1604 error("Could not find property %s in %p", name,
1609 data->pending_prop = TRUE;
1610 iface->pending_prop = g_slist_prepend(iface->pending_prop,
1613 if (!data->process_id) {
1614 data->process_id = g_idle_add(process_changes, data);