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"
42 #ifndef DBUS_ERROR_UNKNOWN_PROPERTY
43 #define DBUS_ERROR_UNKNOWN_PROPERTY "org.freedesktop.DBus.Error.UnknownProperty"
46 #ifndef DBUS_ERROR_PROPERTY_READ_ONLY
47 #define DBUS_ERROR_PROPERTY_READ_ONLY "org.freedesktop.DBus.Error.PropertyReadOnly"
51 unsigned int refcount;
59 gboolean pending_prop;
61 struct generic_data *parent;
64 struct interface_data {
66 const GDBusMethodTable *methods;
67 const GDBusSignalTable *signals;
68 const GDBusPropertyTable *properties;
71 GDBusDestroyFunction destroy;
74 struct security_data {
75 GDBusPendingReply pending;
77 const GDBusMethodTable *method;
78 void *iface_user_data;
81 struct property_data {
83 GDBusPendingPropertySet id;
87 static int global_flags = 0;
88 static struct generic_data *root;
90 static gboolean process_changes(gpointer user_data);
91 static void process_properties_from_interface(struct generic_data *data,
92 struct interface_data *iface);
93 static void process_property_changes(struct generic_data *data);
95 static void print_arguments(GString *gstr, const GDBusArgInfo *args,
96 const char *direction)
98 for (; args && args->name; args++) {
99 g_string_append_printf(gstr,
100 "\t\t\t<arg name=\"%s\" type=\"%s\"",
101 args->name, args->signature);
104 g_string_append_printf(gstr,
105 " direction=\"%s\"/>\n", direction);
107 g_string_append_printf(gstr, "/>\n");
112 #define G_DBUS_ANNOTATE(prefix_, name_, value_) \
113 prefix_ "<annotation name=\"org.freedesktop.DBus." name_ "\" " \
114 "value=\"" value_ "\"/>\n"
116 #define G_DBUS_ANNOTATE_DEPRECATED(prefix_) \
117 G_DBUS_ANNOTATE(prefix_, "Deprecated", "true")
119 #define G_DBUS_ANNOTATE_NOREPLY(prefix_) \
120 G_DBUS_ANNOTATE(prefix_, "Method.NoReply", "true")
122 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
124 const GDBusMethodTable *method;
125 const GDBusSignalTable *signal;
126 const GDBusPropertyTable *property;
128 for (method = iface->methods; method && method->name; method++) {
129 gboolean deprecated = method->flags &
130 G_DBUS_METHOD_FLAG_DEPRECATED;
131 gboolean noreply = method->flags &
132 G_DBUS_METHOD_FLAG_NOREPLY;
133 gboolean experimental = method->flags &
134 G_DBUS_METHOD_FLAG_EXPERIMENTAL;
136 if (!(global_flags & G_DBUS_FLAG_ENABLE_EXPERIMENTAL) &&
140 if (!deprecated && !noreply &&
141 !(method->in_args && method->in_args->name) &&
142 !(method->out_args && method->out_args->name))
143 g_string_append_printf(gstr,
144 "\t\t<method name=\"%s\"/>\n",
147 g_string_append_printf(gstr,
148 "\t\t<method name=\"%s\">\n",
150 print_arguments(gstr, method->in_args, "in");
151 print_arguments(gstr, method->out_args, "out");
154 g_string_append_printf(gstr,
155 G_DBUS_ANNOTATE_DEPRECATED("\t\t\t"));
157 g_string_append_printf(gstr,
158 G_DBUS_ANNOTATE_NOREPLY("\t\t\t"));
160 g_string_append_printf(gstr, "\t\t</method>\n");
164 for (signal = iface->signals; signal && signal->name; signal++) {
165 gboolean deprecated = signal->flags &
166 G_DBUS_SIGNAL_FLAG_DEPRECATED;
167 gboolean experimental = signal->flags &
168 G_DBUS_SIGNAL_FLAG_EXPERIMENTAL;
170 if (!(global_flags & G_DBUS_FLAG_ENABLE_EXPERIMENTAL) &&
174 if (!deprecated && !(signal->args && signal->args->name))
175 g_string_append_printf(gstr,
176 "\t\t<signal name=\"%s\"/>\n",
179 g_string_append_printf(gstr,
180 "\t\t<signal name=\"%s\">\n",
182 print_arguments(gstr, signal->args, NULL);
185 g_string_append_printf(gstr,
186 G_DBUS_ANNOTATE_DEPRECATED("\t\t\t"));
188 g_string_append_printf(gstr, "\t\t</signal>\n");
192 for (property = iface->properties; property && property->name;
194 gboolean deprecated = property->flags &
195 G_DBUS_PROPERTY_FLAG_DEPRECATED;
197 g_string_append_printf(gstr, "\t\t<property name=\"%s\""
198 " type=\"%s\" access=\"%s%s\"",
199 property->name, property->type,
200 property->get ? "read" : "",
201 property->set ? "write" : "");
204 g_string_append_printf(gstr, "/>\n");
206 g_string_append_printf(gstr,
207 G_DBUS_ANNOTATE_DEPRECATED(">\n\t\t\t"));
211 static void generate_introspection_xml(DBusConnection *conn,
212 struct generic_data *data, const char *path)
219 g_free(data->introspect);
221 gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
223 g_string_append_printf(gstr, "<node>\n");
225 for (list = data->interfaces; list; list = list->next) {
226 struct interface_data *iface = list->data;
228 g_string_append_printf(gstr, "\t<interface name=\"%s\">\n",
231 generate_interface_xml(gstr, iface);
233 g_string_append_printf(gstr, "\t</interface>\n");
236 if (!dbus_connection_list_registered(conn, path, &children))
239 for (i = 0; children[i]; i++)
240 g_string_append_printf(gstr, "\t<node name=\"%s\"/>\n",
243 dbus_free_string_array(children);
246 g_string_append_printf(gstr, "</node>\n");
248 data->introspect = g_string_free(gstr, FALSE);
251 static DBusMessage *introspect(DBusConnection *connection,
252 DBusMessage *message, void *user_data)
254 struct generic_data *data = user_data;
257 if (data->introspect == NULL)
258 generate_introspection_xml(connection, data,
259 dbus_message_get_path(message));
261 reply = dbus_message_new_method_return(message);
265 dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
271 static DBusHandlerResult process_message(DBusConnection *connection,
272 DBusMessage *message, const GDBusMethodTable *method,
273 void *iface_user_data)
277 reply = method->function(connection, message, iface_user_data);
279 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
281 dbus_message_unref(reply);
282 return DBUS_HANDLER_RESULT_HANDLED;
285 if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
287 return DBUS_HANDLER_RESULT_HANDLED;
291 return DBUS_HANDLER_RESULT_NEED_MEMORY;
293 dbus_connection_send(connection, reply, NULL);
294 dbus_message_unref(reply);
296 return DBUS_HANDLER_RESULT_HANDLED;
299 static GDBusPendingReply next_pending = 1;
300 static GSList *pending_security = NULL;
302 static const GDBusSecurityTable *security_table = NULL;
304 void g_dbus_pending_success(DBusConnection *connection,
305 GDBusPendingReply pending)
309 for (list = pending_security; list; list = list->next) {
310 struct security_data *secdata = list->data;
312 if (secdata->pending != pending)
315 pending_security = g_slist_remove(pending_security, secdata);
317 process_message(connection, secdata->message,
318 secdata->method, secdata->iface_user_data);
320 dbus_message_unref(secdata->message);
326 void g_dbus_pending_error_valist(DBusConnection *connection,
327 GDBusPendingReply pending, const char *name,
328 const char *format, va_list args)
332 for (list = pending_security; list; list = list->next) {
333 struct security_data *secdata = list->data;
336 if (secdata->pending != pending)
339 pending_security = g_slist_remove(pending_security, secdata);
341 reply = g_dbus_create_error_valist(secdata->message,
344 dbus_connection_send(connection, reply, NULL);
345 dbus_message_unref(reply);
348 dbus_message_unref(secdata->message);
354 void g_dbus_pending_error(DBusConnection *connection,
355 GDBusPendingReply pending,
356 const char *name, const char *format, ...)
360 va_start(args, format);
362 g_dbus_pending_error_valist(connection, pending, name, format, args);
367 int polkit_check_authorization(DBusConnection *conn,
368 const char *action, gboolean interaction,
369 void (*function) (dbus_bool_t authorized,
371 void *user_data, int timeout);
373 struct builtin_security_data {
374 DBusConnection *conn;
375 GDBusPendingReply pending;
378 static void builtin_security_result(dbus_bool_t authorized, void *user_data)
380 struct builtin_security_data *data = user_data;
382 if (authorized == TRUE)
383 g_dbus_pending_success(data->conn, data->pending);
385 g_dbus_pending_error(data->conn, data->pending,
386 DBUS_ERROR_AUTH_FAILED, NULL);
391 static void builtin_security_function(DBusConnection *conn,
393 gboolean interaction,
394 GDBusPendingReply pending)
396 struct builtin_security_data *data;
398 data = g_new0(struct builtin_security_data, 1);
400 data->pending = pending;
402 if (polkit_check_authorization(conn, action, interaction,
403 builtin_security_result, data, 30000) < 0)
404 g_dbus_pending_error(conn, pending, NULL, NULL);
407 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
408 const GDBusMethodTable *method, void *iface_user_data)
410 const GDBusSecurityTable *security;
412 for (security = security_table; security && security->privilege;
414 struct security_data *secdata;
415 gboolean interaction;
417 if (security->privilege != method->privilege)
420 secdata = g_new(struct security_data, 1);
421 secdata->pending = next_pending++;
422 secdata->message = dbus_message_ref(msg);
423 secdata->method = method;
424 secdata->iface_user_data = iface_user_data;
426 pending_security = g_slist_prepend(pending_security, secdata);
428 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
433 if (!(security->flags & G_DBUS_SECURITY_FLAG_BUILTIN) &&
435 security->function(conn, security->action,
436 interaction, secdata->pending);
438 builtin_security_function(conn, security->action,
439 interaction, secdata->pending);
447 static GDBusPendingPropertySet next_pending_property = 1;
448 static GSList *pending_property_set;
450 static struct property_data *remove_pending_property_data(
451 GDBusPendingPropertySet id)
453 struct property_data *propdata;
456 for (l = pending_property_set; l != NULL; l = l->next) {
458 if (propdata->id != id)
467 pending_property_set = g_slist_delete_link(pending_property_set, l);
472 void g_dbus_pending_property_success(GDBusPendingPropertySet id)
474 struct property_data *propdata;
476 propdata = remove_pending_property_data(id);
477 if (propdata == NULL)
480 g_dbus_send_reply(propdata->conn, propdata->message,
482 dbus_message_unref(propdata->message);
486 void g_dbus_pending_property_error_valist(GDBusPendingReply id,
487 const char *name, const char *format,
490 struct property_data *propdata;
493 propdata = remove_pending_property_data(id);
494 if (propdata == NULL)
497 reply = g_dbus_create_error_valist(propdata->message, name, format,
500 dbus_connection_send(propdata->conn, reply, NULL);
501 dbus_message_unref(reply);
504 dbus_message_unref(propdata->message);
508 void g_dbus_pending_property_error(GDBusPendingReply id, const char *name,
509 const char *format, ...)
513 va_start(args, format);
515 g_dbus_pending_property_error_valist(id, name, format, args);
520 static void reset_parent(gpointer data, gpointer user_data)
522 struct generic_data *child = data;
523 struct generic_data *parent = user_data;
525 child->parent = parent;
528 static void append_property(struct interface_data *iface,
529 const GDBusPropertyTable *p, DBusMessageIter *dict)
531 DBusMessageIter entry, value;
533 dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY, NULL,
535 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &p->name);
536 dbus_message_iter_open_container(&entry, DBUS_TYPE_VARIANT, p->type,
539 p->get(p, &value, iface->user_data);
541 dbus_message_iter_close_container(&entry, &value);
542 dbus_message_iter_close_container(dict, &entry);
545 static void append_properties(struct interface_data *data,
546 DBusMessageIter *iter)
548 DBusMessageIter dict;
549 const GDBusPropertyTable *p;
551 dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
552 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
553 DBUS_TYPE_STRING_AS_STRING
554 DBUS_TYPE_VARIANT_AS_STRING
555 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
557 for (p = data->properties; p && p->name; p++) {
561 if (p->exists != NULL && !p->exists(p, data->user_data))
564 append_property(data, p, &dict);
567 dbus_message_iter_close_container(iter, &dict);
570 static void append_interface(gpointer data, gpointer user_data)
572 struct interface_data *iface = data;
573 DBusMessageIter *array = user_data;
574 DBusMessageIter entry;
576 dbus_message_iter_open_container(array, DBUS_TYPE_DICT_ENTRY, NULL,
578 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &iface->name);
579 append_properties(data, &entry);
580 dbus_message_iter_close_container(array, &entry);
583 static void emit_interfaces_added(struct generic_data *data)
586 DBusMessageIter iter, array;
588 if (root == NULL || data == root)
591 signal = dbus_message_new_signal(root->path,
592 DBUS_INTERFACE_OBJECT_MANAGER,
597 dbus_message_iter_init_append(signal, &iter);
598 dbus_message_iter_append_basic(&iter, DBUS_TYPE_OBJECT_PATH,
601 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
602 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
603 DBUS_TYPE_STRING_AS_STRING
604 DBUS_TYPE_ARRAY_AS_STRING
605 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
606 DBUS_TYPE_STRING_AS_STRING
607 DBUS_TYPE_VARIANT_AS_STRING
608 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
609 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &array);
611 g_slist_foreach(data->added, append_interface, &array);
612 g_slist_free(data->added);
615 dbus_message_iter_close_container(&iter, &array);
617 g_dbus_send_message(data->conn, signal);
620 static struct interface_data *find_interface(GSList *interfaces,
628 for (list = interfaces; list; list = list->next) {
629 struct interface_data *iface = list->data;
630 if (!strcmp(name, iface->name))
637 static gboolean g_dbus_args_have_signature(const GDBusArgInfo *args,
638 DBusMessage *message)
640 const char *sig = dbus_message_get_signature(message);
641 const char *p = NULL;
643 for (; args && args->signature && *sig; args++) {
646 for (; *sig && *p; sig++, p++) {
652 if (*sig || (p && *p) || (args && args->signature))
658 static gboolean remove_interface(struct generic_data *data, const char *name)
660 struct interface_data *iface;
662 iface = find_interface(data->interfaces, name);
666 process_properties_from_interface(data, iface);
668 data->interfaces = g_slist_remove(data->interfaces, iface);
670 if (iface->destroy) {
671 iface->destroy(iface->user_data);
672 iface->user_data = NULL;
676 * Interface being removed was just added, on the same mainloop
677 * iteration? Don't send any signal
679 if (g_slist_find(data->added, iface)) {
680 data->added = g_slist_remove(data->added, iface);
686 if (data->parent == NULL) {
692 data->removed = g_slist_prepend(data->removed, iface->name);
695 if (data->process_id > 0)
698 data->process_id = g_idle_add(process_changes, data);
703 static struct generic_data *invalidate_parent_data(DBusConnection *conn,
704 const char *child_path)
706 struct generic_data *data = NULL, *child = NULL, *parent = NULL;
707 char *parent_path, *slash;
709 parent_path = g_strdup(child_path);
710 slash = strrchr(parent_path, '/');
714 if (slash == parent_path && parent_path[1] != '\0')
715 parent_path[1] = '\0';
719 if (!strlen(parent_path))
722 if (dbus_connection_get_object_path_data(conn, parent_path,
723 (void *) &data) == FALSE) {
727 parent = invalidate_parent_data(conn, parent_path);
735 g_free(data->introspect);
736 data->introspect = NULL;
738 if (!dbus_connection_get_object_path_data(conn, child_path,
742 if (child == NULL || g_slist_find(data->objects, child) != NULL)
745 data->objects = g_slist_prepend(data->objects, child);
746 child->parent = data;
753 static inline const GDBusPropertyTable *find_property(const GDBusPropertyTable *properties,
756 const GDBusPropertyTable *p;
758 for (p = properties; p && p->name; p++) {
759 if (strcmp(name, p->name) == 0)
766 static DBusMessage *properties_get(DBusConnection *connection,
767 DBusMessage *message, void *user_data)
769 struct generic_data *data = user_data;
770 struct interface_data *iface;
771 const GDBusPropertyTable *property;
772 const char *interface, *name;
773 DBusMessageIter iter, value;
776 if (!dbus_message_get_args(message, NULL,
777 DBUS_TYPE_STRING, &interface,
778 DBUS_TYPE_STRING, &name,
782 iface = find_interface(data->interfaces, interface);
784 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
785 "No such interface '%s'", interface);
787 property = find_property(iface->properties, name);
788 if (property == NULL)
789 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
790 "No such property '%s'", name);
792 if (property->exists != NULL &&
793 !property->exists(property, iface->user_data))
794 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
795 "No such property '%s'", name);
797 if (property->get == NULL)
798 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
799 "Property '%s' is not readable", name);
801 reply = dbus_message_new_method_return(message);
805 dbus_message_iter_init_append(reply, &iter);
806 dbus_message_iter_open_container(&iter, DBUS_TYPE_VARIANT,
807 property->type, &value);
809 if (!property->get(property, &value, iface->user_data)) {
810 dbus_message_unref(reply);
814 dbus_message_iter_close_container(&iter, &value);
819 static DBusMessage *properties_get_all(DBusConnection *connection,
820 DBusMessage *message, void *user_data)
822 struct generic_data *data = user_data;
823 struct interface_data *iface;
824 const char *interface;
825 DBusMessageIter iter;
828 if (!dbus_message_get_args(message, NULL,
829 DBUS_TYPE_STRING, &interface,
833 iface = find_interface(data->interfaces, interface);
835 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
836 "No such interface '%s'", interface);
838 reply = dbus_message_new_method_return(message);
842 dbus_message_iter_init_append(reply, &iter);
844 append_properties(iface, &iter);
849 static DBusMessage *properties_set(DBusConnection *connection,
850 DBusMessage *message, void *user_data)
852 struct generic_data *data = user_data;
853 DBusMessageIter iter, sub;
854 struct interface_data *iface;
855 const GDBusPropertyTable *property;
856 const char *name, *interface;
857 struct property_data *propdata;
859 if (!dbus_message_iter_init(message, &iter))
860 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
861 "No arguments given");
863 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
864 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
865 "Invalid argument type: '%c'",
866 dbus_message_iter_get_arg_type(&iter));
868 dbus_message_iter_get_basic(&iter, &interface);
869 dbus_message_iter_next(&iter);
871 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
872 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
873 "Invalid argument type: '%c'",
874 dbus_message_iter_get_arg_type(&iter));
876 dbus_message_iter_get_basic(&iter, &name);
877 dbus_message_iter_next(&iter);
879 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_VARIANT)
880 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
881 "Invalid argument type: '%c'",
882 dbus_message_iter_get_arg_type(&iter));
884 dbus_message_iter_recurse(&iter, &sub);
886 iface = find_interface(data->interfaces, interface);
888 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
889 "No such interface '%s'", interface);
891 property = find_property(iface->properties, name);
892 if (property == NULL)
893 return g_dbus_create_error(message,
894 DBUS_ERROR_UNKNOWN_PROPERTY,
895 "No such property '%s'", name);
897 if (property->set == NULL)
898 return g_dbus_create_error(message,
899 DBUS_ERROR_PROPERTY_READ_ONLY,
900 "Property '%s' is not writable", name);
902 if (property->exists != NULL &&
903 !property->exists(property, iface->user_data))
904 return g_dbus_create_error(message,
905 DBUS_ERROR_UNKNOWN_PROPERTY,
906 "No such property '%s'", name);
908 propdata = g_new(struct property_data, 1);
909 propdata->id = next_pending_property++;
910 propdata->message = dbus_message_ref(message);
911 propdata->conn = connection;
912 pending_property_set = g_slist_prepend(pending_property_set, propdata);
914 property->set(property, &sub, propdata->id, iface->user_data);
919 static const GDBusMethodTable properties_methods[] = {
920 { GDBUS_METHOD("Get",
921 GDBUS_ARGS({ "interface", "s" }, { "name", "s" }),
922 GDBUS_ARGS({ "value", "v" }),
924 { GDBUS_ASYNC_METHOD("Set",
925 GDBUS_ARGS({ "interface", "s" }, { "name", "s" },
929 { GDBUS_METHOD("GetAll",
930 GDBUS_ARGS({ "interface", "s" }),
931 GDBUS_ARGS({ "properties", "a{sv}" }),
932 properties_get_all) },
936 static const GDBusSignalTable properties_signals[] = {
937 { GDBUS_SIGNAL("PropertiesChanged",
938 GDBUS_ARGS({ "interface", "s" },
939 { "changed_properties", "a{sv}" },
940 { "invalidated_properties", "as"})) },
944 static void append_name(gpointer data, gpointer user_data)
947 DBusMessageIter *iter = user_data;
949 dbus_message_iter_append_basic(iter, DBUS_TYPE_STRING, &name);
952 static void emit_interfaces_removed(struct generic_data *data)
955 DBusMessageIter iter, array;
957 if (root == NULL || data == root)
960 signal = dbus_message_new_signal(root->path,
961 DBUS_INTERFACE_OBJECT_MANAGER,
962 "InterfacesRemoved");
966 dbus_message_iter_init_append(signal, &iter);
967 dbus_message_iter_append_basic(&iter, DBUS_TYPE_OBJECT_PATH,
969 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
970 DBUS_TYPE_STRING_AS_STRING, &array);
972 g_slist_foreach(data->removed, append_name, &array);
973 g_slist_free_full(data->removed, g_free);
974 data->removed = NULL;
976 dbus_message_iter_close_container(&iter, &array);
978 g_dbus_send_message(data->conn, signal);
981 static gboolean process_changes(gpointer user_data)
983 struct generic_data *data = user_data;
985 data->process_id = 0;
987 if (data->added != NULL)
988 emit_interfaces_added(data);
990 /* Flush pending properties */
991 if (data->pending_prop == TRUE)
992 process_property_changes(data);
994 if (data->removed != NULL)
995 emit_interfaces_removed(data);
1000 static void generic_unregister(DBusConnection *connection, void *user_data)
1002 struct generic_data *data = user_data;
1003 struct generic_data *parent = data->parent;
1006 parent->objects = g_slist_remove(parent->objects, data);
1008 if (data->process_id > 0) {
1009 g_source_remove(data->process_id);
1010 process_changes(data);
1013 g_slist_foreach(data->objects, reset_parent, data->parent);
1014 g_slist_free(data->objects);
1016 dbus_connection_unref(data->conn);
1017 g_free(data->introspect);
1022 static DBusHandlerResult generic_message(DBusConnection *connection,
1023 DBusMessage *message, void *user_data)
1025 struct generic_data *data = user_data;
1026 struct interface_data *iface;
1027 const GDBusMethodTable *method;
1028 const char *interface;
1030 interface = dbus_message_get_interface(message);
1032 iface = find_interface(data->interfaces, interface);
1034 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1036 for (method = iface->methods; method &&
1037 method->name && method->function; method++) {
1038 gboolean experimental = method->flags &
1039 G_DBUS_METHOD_FLAG_EXPERIMENTAL;
1041 if (dbus_message_is_method_call(message, iface->name,
1042 method->name) == FALSE)
1046 const char *env = g_getenv("GDBUS_EXPERIMENTAL");
1047 if (g_strcmp0(env, "1") != 0)
1048 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1051 if (g_dbus_args_have_signature(method->in_args,
1055 if (check_privilege(connection, message, method,
1056 iface->user_data) == TRUE)
1057 return DBUS_HANDLER_RESULT_HANDLED;
1059 return process_message(connection, message, method,
1063 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1066 static DBusObjectPathVTable generic_table = {
1067 .unregister_function = generic_unregister,
1068 .message_function = generic_message,
1071 static const GDBusMethodTable introspect_methods[] = {
1072 { GDBUS_METHOD("Introspect", NULL,
1073 GDBUS_ARGS({ "xml", "s" }), introspect) },
1077 static void append_interfaces(struct generic_data *data, DBusMessageIter *iter)
1079 DBusMessageIter array;
1081 dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
1082 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1083 DBUS_TYPE_STRING_AS_STRING
1084 DBUS_TYPE_ARRAY_AS_STRING
1085 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1086 DBUS_TYPE_STRING_AS_STRING
1087 DBUS_TYPE_VARIANT_AS_STRING
1088 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1089 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &array);
1091 g_slist_foreach(data->interfaces, append_interface, &array);
1093 dbus_message_iter_close_container(iter, &array);
1096 static void append_object(gpointer data, gpointer user_data)
1098 struct generic_data *child = data;
1099 DBusMessageIter *array = user_data;
1100 DBusMessageIter entry;
1102 dbus_message_iter_open_container(array, DBUS_TYPE_DICT_ENTRY, NULL,
1104 dbus_message_iter_append_basic(&entry, DBUS_TYPE_OBJECT_PATH,
1106 append_interfaces(child, &entry);
1107 dbus_message_iter_close_container(array, &entry);
1109 g_slist_foreach(child->objects, append_object, user_data);
1112 static DBusMessage *get_objects(DBusConnection *connection,
1113 DBusMessage *message, void *user_data)
1115 struct generic_data *data = user_data;
1117 DBusMessageIter iter;
1118 DBusMessageIter array;
1120 reply = dbus_message_new_method_return(message);
1124 dbus_message_iter_init_append(reply, &iter);
1126 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1127 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1128 DBUS_TYPE_OBJECT_PATH_AS_STRING
1129 DBUS_TYPE_ARRAY_AS_STRING
1130 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1131 DBUS_TYPE_STRING_AS_STRING
1132 DBUS_TYPE_ARRAY_AS_STRING
1133 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1134 DBUS_TYPE_STRING_AS_STRING
1135 DBUS_TYPE_VARIANT_AS_STRING
1136 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1137 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1138 DBUS_DICT_ENTRY_END_CHAR_AS_STRING,
1141 g_slist_foreach(data->objects, append_object, &array);
1143 dbus_message_iter_close_container(&iter, &array);
1148 static const GDBusMethodTable manager_methods[] = {
1149 { GDBUS_METHOD("GetManagedObjects", NULL,
1150 GDBUS_ARGS({ "objects", "a{oa{sa{sv}}}" }), get_objects) },
1154 static const GDBusSignalTable manager_signals[] = {
1155 { GDBUS_SIGNAL("InterfacesAdded",
1156 GDBUS_ARGS({ "object", "o" },
1157 { "interfaces", "a{sa{sv}}" })) },
1158 { GDBUS_SIGNAL("InterfacesRemoved",
1159 GDBUS_ARGS({ "object", "o" }, { "interfaces", "as" })) },
1163 static void add_interface(struct generic_data *data,
1165 const GDBusMethodTable *methods,
1166 const GDBusSignalTable *signals,
1167 const GDBusPropertyTable *properties,
1169 GDBusDestroyFunction destroy)
1171 struct interface_data *iface;
1173 iface = g_new0(struct interface_data, 1);
1174 iface->name = g_strdup(name);
1175 iface->methods = methods;
1176 iface->signals = signals;
1177 iface->properties = properties;
1178 iface->user_data = user_data;
1179 iface->destroy = destroy;
1181 data->interfaces = g_slist_append(data->interfaces, iface);
1182 if (data->parent == NULL)
1185 data->added = g_slist_append(data->added, iface);
1186 if (data->process_id > 0)
1189 data->process_id = g_idle_add(process_changes, data);
1192 static struct generic_data *object_path_ref(DBusConnection *connection,
1195 struct generic_data *data;
1197 if (dbus_connection_get_object_path_data(connection, path,
1198 (void *) &data) == TRUE) {
1205 data = g_new0(struct generic_data, 1);
1206 data->conn = dbus_connection_ref(connection);
1207 data->path = g_strdup(path);
1210 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
1212 if (!dbus_connection_register_object_path(connection, path,
1213 &generic_table, data)) {
1214 g_free(data->introspect);
1219 invalidate_parent_data(connection, path);
1221 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE, introspect_methods,
1222 NULL, NULL, data, NULL);
1227 static void object_path_unref(DBusConnection *connection, const char *path)
1229 struct generic_data *data = NULL;
1231 if (dbus_connection_get_object_path_data(connection, path,
1232 (void *) &data) == FALSE)
1240 if (data->refcount > 0)
1243 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
1244 remove_interface(data, DBUS_INTERFACE_PROPERTIES);
1246 invalidate_parent_data(data->conn, data->path);
1248 dbus_connection_unregister_object_path(data->conn, data->path);
1251 static gboolean check_signal(DBusConnection *conn, const char *path,
1252 const char *interface, const char *name,
1253 const GDBusArgInfo **args)
1255 struct generic_data *data = NULL;
1256 struct interface_data *iface;
1257 const GDBusSignalTable *signal;
1260 if (!dbus_connection_get_object_path_data(conn, path,
1261 (void *) &data) || data == NULL) {
1262 error("dbus_connection_emit_signal: path %s isn't registered",
1267 iface = find_interface(data->interfaces, interface);
1268 if (iface == NULL) {
1269 error("dbus_connection_emit_signal: %s does not implement %s",
1274 for (signal = iface->signals; signal && signal->name; signal++) {
1275 if (strcmp(signal->name, name) != 0)
1278 if (signal->flags & G_DBUS_SIGNAL_FLAG_EXPERIMENTAL) {
1279 const char *env = g_getenv("GDBUS_EXPERIMENTAL");
1280 if (g_strcmp0(env, "1") != 0)
1284 *args = signal->args;
1288 error("No signal named %s on interface %s", name, interface);
1292 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
1294 const char *interface,
1299 DBusMessage *signal;
1301 const GDBusArgInfo *args;
1303 if (!check_signal(conn, path, interface, name, &args))
1306 signal = dbus_message_new_signal(path, interface, name);
1307 if (signal == NULL) {
1308 error("Unable to allocate new %s.%s signal", interface, name);
1312 ret = dbus_message_append_args_valist(signal, first, var_args);
1316 if (g_dbus_args_have_signature(args, signal) == FALSE) {
1317 error("%s.%s: got unexpected signature '%s'", interface, name,
1318 dbus_message_get_signature(signal));
1323 ret = dbus_connection_send(conn, signal, NULL);
1326 dbus_message_unref(signal);
1331 gboolean g_dbus_register_interface(DBusConnection *connection,
1332 const char *path, const char *name,
1333 const GDBusMethodTable *methods,
1334 const GDBusSignalTable *signals,
1335 const GDBusPropertyTable *properties,
1337 GDBusDestroyFunction destroy)
1339 struct generic_data *data;
1341 data = object_path_ref(connection, path);
1345 if (find_interface(data->interfaces, name)) {
1346 object_path_unref(connection, path);
1350 if (properties != NULL && !find_interface(data->interfaces,
1351 DBUS_INTERFACE_PROPERTIES))
1352 add_interface(data, DBUS_INTERFACE_PROPERTIES,
1353 properties_methods, properties_signals, NULL,
1356 add_interface(data, name, methods, signals, properties, user_data,
1359 g_free(data->introspect);
1360 data->introspect = NULL;
1365 gboolean g_dbus_unregister_interface(DBusConnection *connection,
1366 const char *path, const char *name)
1368 struct generic_data *data = NULL;
1373 if (dbus_connection_get_object_path_data(connection, path,
1374 (void *) &data) == FALSE)
1380 if (remove_interface(data, name) == FALSE)
1383 g_free(data->introspect);
1384 data->introspect = NULL;
1386 object_path_unref(connection, data->path);
1391 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
1393 if (security_table != NULL)
1396 security_table = security;
1401 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
1403 security_table = NULL;
1408 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
1409 const char *format, va_list args)
1413 vsnprintf(str, sizeof(str), format, args);
1415 return dbus_message_new_error(message, name, str);
1418 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
1419 const char *format, ...)
1424 va_start(args, format);
1426 reply = g_dbus_create_error_valist(message, name, format, args);
1433 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
1434 int type, va_list args)
1438 reply = dbus_message_new_method_return(message);
1442 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
1443 dbus_message_unref(reply);
1450 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
1455 va_start(args, type);
1457 reply = g_dbus_create_reply_valist(message, type, args);
1464 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
1468 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
1469 dbus_message_set_no_reply(message, TRUE);
1471 result = dbus_connection_send(connection, message, NULL);
1473 dbus_message_unref(message);
1478 gboolean g_dbus_send_error_valist(DBusConnection *connection,
1479 DBusMessage *message, const char *name,
1480 const char *format, va_list args)
1485 vsnprintf(str, sizeof(str), format, args);
1487 error = dbus_message_new_error(message, name, str);
1491 return g_dbus_send_message(connection, error);
1494 gboolean g_dbus_send_error(DBusConnection *connection, DBusMessage *message,
1495 const char *name, const char *format, ...)
1500 va_start(args, format);
1502 result = g_dbus_send_error_valist(connection, message, name,
1510 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
1511 DBusMessage *message, int type, va_list args)
1515 reply = dbus_message_new_method_return(message);
1519 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
1520 dbus_message_unref(reply);
1524 return g_dbus_send_message(connection, reply);
1527 gboolean g_dbus_send_reply(DBusConnection *connection,
1528 DBusMessage *message, int type, ...)
1533 va_start(args, type);
1535 result = g_dbus_send_reply_valist(connection, message, type, args);
1542 gboolean g_dbus_emit_signal(DBusConnection *connection,
1543 const char *path, const char *interface,
1544 const char *name, int type, ...)
1549 va_start(args, type);
1551 result = emit_signal_valist(connection, path, interface,
1559 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
1560 const char *path, const char *interface,
1561 const char *name, int type, va_list args)
1563 return emit_signal_valist(connection, path, interface,
1567 static void process_properties_from_interface(struct generic_data *data,
1568 struct interface_data *iface)
1571 DBusMessage *signal;
1572 DBusMessageIter iter, dict, array;
1573 GSList *invalidated;
1575 if (iface->pending_prop == NULL)
1578 signal = dbus_message_new_signal(data->path,
1579 DBUS_INTERFACE_PROPERTIES, "PropertiesChanged");
1580 if (signal == NULL) {
1581 error("Unable to allocate new " DBUS_INTERFACE_PROPERTIES
1582 ".PropertiesChanged signal");
1586 iface->pending_prop = g_slist_reverse(iface->pending_prop);
1588 dbus_message_iter_init_append(signal, &iter);
1589 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &iface->name);
1590 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1591 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1592 DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
1593 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
1597 for (l = iface->pending_prop; l != NULL; l = l->next) {
1598 GDBusPropertyTable *p = l->data;
1603 if (p->exists != NULL && !p->exists(p, iface->user_data)) {
1604 invalidated = g_slist_prepend(invalidated, p);
1608 append_property(iface, p, &dict);
1611 dbus_message_iter_close_container(&iter, &dict);
1613 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1614 DBUS_TYPE_STRING_AS_STRING, &array);
1615 for (l = invalidated; l != NULL; l = g_slist_next(l)) {
1616 GDBusPropertyTable *p = l->data;
1618 dbus_message_iter_append_basic(&array, DBUS_TYPE_STRING,
1621 g_slist_free(invalidated);
1622 dbus_message_iter_close_container(&iter, &array);
1624 g_dbus_send_message(data->conn, signal);
1626 g_slist_free(iface->pending_prop);
1627 iface->pending_prop = NULL;
1630 static void process_property_changes(struct generic_data *data)
1634 for (l = data->interfaces; l != NULL; l = l->next) {
1635 struct interface_data *iface = l->data;
1637 process_properties_from_interface(data, iface);
1640 data->pending_prop = FALSE;
1643 void g_dbus_emit_property_changed(DBusConnection *connection,
1644 const char *path, const char *interface,
1647 const GDBusPropertyTable *property;
1648 struct generic_data *data;
1649 struct interface_data *iface;
1651 if (!dbus_connection_get_object_path_data(connection, path,
1652 (void **) &data) || data == NULL)
1655 iface = find_interface(data->interfaces, interface);
1659 property = find_property(iface->properties, name);
1660 if (property == NULL) {
1661 error("Could not find property %s in %p", name,
1666 if (g_slist_find(iface->pending_prop, (void *) property) != NULL)
1669 data->pending_prop = TRUE;
1670 iface->pending_prop = g_slist_prepend(iface->pending_prop,
1673 if (!data->process_id) {
1674 data->process_id = g_idle_add(process_changes, data);
1679 gboolean g_dbus_get_properties(DBusConnection *connection, const char *path,
1680 const char *interface, DBusMessageIter *iter)
1682 struct generic_data *data;
1683 struct interface_data *iface;
1685 if (!dbus_connection_get_object_path_data(connection, path,
1686 (void **) &data) || data == NULL)
1689 iface = find_interface(data->interfaces, interface);
1693 append_properties(iface, iter);
1698 gboolean g_dbus_attach_object_manager(DBusConnection *connection)
1700 struct generic_data *data;
1702 data = object_path_ref(connection, "/");
1706 add_interface(data, DBUS_INTERFACE_OBJECT_MANAGER,
1707 manager_methods, manager_signals,
1714 gboolean g_dbus_detach_object_manager(DBusConnection *connection)
1716 if (!g_dbus_unregister_interface(connection, "/",
1717 DBUS_INTERFACE_OBJECT_MANAGER))
1725 void g_dbus_set_flags(int flags)
1727 global_flags = flags;