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)
441 pending_property_set = g_slist_delete_link(pending_property_set, l);
446 void g_dbus_pending_property_success(DBusConnection *connection,
447 GDBusPendingPropertySet id)
449 struct property_data *propdata;
451 propdata = remove_pending_property_data(id);
452 if (propdata == NULL)
455 g_dbus_send_reply(connection, propdata->message, DBUS_TYPE_INVALID);
456 dbus_message_unref(propdata->message);
460 void g_dbus_pending_property_error_valist(DBusConnection *connection,
461 GDBusPendingReply id, const char *name,
462 const char *format, va_list args)
464 struct property_data *propdata;
467 propdata = remove_pending_property_data(id);
468 if (propdata == NULL)
471 reply = g_dbus_create_error_valist(propdata->message, name, format,
474 dbus_connection_send(connection, reply, NULL);
475 dbus_message_unref(reply);
478 dbus_message_unref(propdata->message);
482 void g_dbus_pending_property_error(DBusConnection *connection,
483 GDBusPendingReply id, const char *name,
484 const char *format, ...)
488 va_start(args, format);
490 g_dbus_pending_property_error_valist(connection, id, name, format,
496 static void reset_parent(gpointer data, gpointer user_data)
498 struct generic_data *child = data;
499 struct generic_data *parent = user_data;
501 child->parent = parent;
504 static void append_property(struct interface_data *iface,
505 const GDBusPropertyTable *p, DBusMessageIter *dict)
507 DBusMessageIter entry, value;
509 dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY, NULL,
511 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &p->name);
512 dbus_message_iter_open_container(&entry, DBUS_TYPE_VARIANT, p->type,
515 p->get(p, &value, iface->user_data);
517 dbus_message_iter_close_container(&entry, &value);
518 dbus_message_iter_close_container(dict, &entry);
521 static void append_properties(struct interface_data *data,
522 DBusMessageIter *iter)
524 DBusMessageIter dict;
525 const GDBusPropertyTable *p;
527 dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
528 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
529 DBUS_TYPE_STRING_AS_STRING
530 DBUS_TYPE_VARIANT_AS_STRING
531 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
533 for (p = data->properties; p && p->name; p++) {
537 if (p->exists != NULL && !p->exists(p, data->user_data))
540 append_property(data, p, &dict);
543 dbus_message_iter_close_container(iter, &dict);
546 static void append_interface(gpointer data, gpointer user_data)
548 struct interface_data *iface = data;
549 DBusMessageIter *array = user_data;
550 DBusMessageIter entry;
552 dbus_message_iter_open_container(array, DBUS_TYPE_DICT_ENTRY, NULL,
554 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &iface->name);
555 append_properties(data, &entry);
556 dbus_message_iter_close_container(array, &entry);
559 static void emit_interfaces_added(struct generic_data *data)
562 DBusMessageIter iter, array;
563 struct generic_data *parent = data->parent;
569 while (parent->parent)
570 parent = parent->parent;
572 signal = dbus_message_new_signal(parent->path,
573 DBUS_INTERFACE_OBJECT_MANAGER,
578 dbus_message_iter_init_append(signal, &iter);
579 dbus_message_iter_append_basic(&iter, DBUS_TYPE_OBJECT_PATH,
582 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
583 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
584 DBUS_TYPE_STRING_AS_STRING
585 DBUS_TYPE_ARRAY_AS_STRING
586 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
587 DBUS_TYPE_STRING_AS_STRING
588 DBUS_TYPE_VARIANT_AS_STRING
589 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
590 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &array);
592 g_slist_foreach(data->added, append_interface, &array);
593 g_slist_free(data->added);
596 dbus_message_iter_close_container(&iter, &array);
598 g_dbus_send_message(data->conn, signal);
601 static struct interface_data *find_interface(GSList *interfaces,
609 for (list = interfaces; list; list = list->next) {
610 struct interface_data *iface = list->data;
611 if (!strcmp(name, iface->name))
618 static gboolean g_dbus_args_have_signature(const GDBusArgInfo *args,
619 DBusMessage *message)
621 const char *sig = dbus_message_get_signature(message);
622 const char *p = NULL;
624 for (; args && args->signature && *sig; args++) {
627 for (; *sig && *p; sig++, p++) {
633 if (*sig || (p && *p) || (args && args->signature))
639 static gboolean remove_interface(struct generic_data *data, const char *name)
641 struct interface_data *iface;
643 iface = find_interface(data->interfaces, name);
647 data->interfaces = g_slist_remove(data->interfaces, iface);
649 if (iface->destroy) {
650 iface->destroy(iface->user_data);
651 iface->user_data = NULL;
654 if (data->parent == NULL) {
661 * Interface being removed was just added, on the same mainloop
662 * iteration? Don't send any signal
664 if (g_slist_find(data->added, iface)) {
665 data->added = g_slist_remove(data->added, iface);
671 data->removed = g_slist_prepend(data->removed, iface->name);
674 if (data->process_id > 0)
677 data->process_id = g_idle_add(process_changes, data);
682 static struct generic_data *invalidate_parent_data(DBusConnection *conn,
683 const char *child_path)
685 struct generic_data *data = NULL, *child = NULL, *parent = NULL;
686 char *parent_path, *slash;
688 parent_path = g_strdup(child_path);
689 slash = strrchr(parent_path, '/');
693 if (slash == parent_path && parent_path[1] != '\0')
694 parent_path[1] = '\0';
698 if (!strlen(parent_path))
701 if (dbus_connection_get_object_path_data(conn, parent_path,
702 (void *) &data) == FALSE) {
706 parent = invalidate_parent_data(conn, parent_path);
714 g_free(data->introspect);
715 data->introspect = NULL;
717 if (!dbus_connection_get_object_path_data(conn, child_path,
721 if (child == NULL || g_slist_find(data->objects, child) != NULL)
724 data->objects = g_slist_prepend(data->objects, child);
725 child->parent = data;
732 static inline const GDBusPropertyTable *find_property(const GDBusPropertyTable *properties,
735 const GDBusPropertyTable *p;
737 for (p = properties; p && p->name; p++) {
738 if (strcmp(name, p->name) == 0)
745 static DBusMessage *properties_get(DBusConnection *connection,
746 DBusMessage *message, void *user_data)
748 struct generic_data *data = user_data;
749 struct interface_data *iface;
750 const GDBusPropertyTable *property;
751 const char *interface, *name;
752 DBusMessageIter iter, value;
755 if (!dbus_message_get_args(message, NULL,
756 DBUS_TYPE_STRING, &interface,
757 DBUS_TYPE_STRING, &name,
761 iface = find_interface(data->interfaces, interface);
763 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
764 "No such interface '%s'", interface);
766 property = find_property(iface->properties, name);
767 if (property == NULL)
768 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
769 "No such property '%s'", name);
771 if (property->exists != NULL &&
772 !property->exists(property, iface->user_data))
773 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
774 "No such property '%s'", name);
776 if (property->get == NULL)
777 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
778 "Property '%s' is not readable", name);
780 reply = dbus_message_new_method_return(message);
784 dbus_message_iter_init_append(reply, &iter);
785 dbus_message_iter_open_container(&iter, DBUS_TYPE_VARIANT,
786 property->type, &value);
788 if (!property->get(property, &value, iface->user_data)) {
789 dbus_message_unref(reply);
793 dbus_message_iter_close_container(&iter, &value);
798 static DBusMessage *properties_get_all(DBusConnection *connection,
799 DBusMessage *message, void *user_data)
801 struct generic_data *data = user_data;
802 struct interface_data *iface;
803 const char *interface;
804 DBusMessageIter iter;
807 if (!dbus_message_get_args(message, NULL,
808 DBUS_TYPE_STRING, &interface,
812 iface = find_interface(data->interfaces, interface);
814 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
815 "No such interface '%s'", interface);
817 reply = dbus_message_new_method_return(message);
821 dbus_message_iter_init_append(reply, &iter);
823 append_properties(iface, &iter);
828 static DBusMessage *properties_set(DBusConnection *connection,
829 DBusMessage *message, void *user_data)
831 struct generic_data *data = user_data;
832 DBusMessageIter iter, sub;
833 struct interface_data *iface;
834 const GDBusPropertyTable *property;
835 const char *name, *interface;
836 struct property_data *propdata;
838 if (!dbus_message_iter_init(message, &iter))
839 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
840 "No arguments given");
842 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
843 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
844 "Invalid argument type: '%c'",
845 dbus_message_iter_get_arg_type(&iter));
847 dbus_message_iter_get_basic(&iter, &name);
848 dbus_message_iter_next(&iter);
850 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
851 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
852 "Invalid argument type: '%c'",
853 dbus_message_iter_get_arg_type(&iter));
855 dbus_message_iter_get_basic(&iter, &interface);
856 dbus_message_iter_next(&iter);
858 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_VARIANT)
859 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
860 "Invalid argument type: '%c'",
861 dbus_message_iter_get_arg_type(&iter));
863 dbus_message_iter_recurse(&iter, &sub);
865 iface = find_interface(data->interfaces, interface);
867 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
868 "No such interface '%s'", interface);
870 property = find_property(iface->properties, name);
871 if (property == NULL)
872 return g_dbus_create_error(message,
873 DBUS_ERROR_UNKNOWN_PROPERTY,
874 "No such property '%s'", name);
876 if (property->set == NULL)
877 return g_dbus_create_error(message,
878 DBUS_ERROR_PROPERTY_READ_ONLY,
879 "Property '%s' is not writable", name);
881 if (property->exists != NULL &&
882 !property->exists(property, iface->user_data))
883 return g_dbus_create_error(message,
884 DBUS_ERROR_UNKNOWN_PROPERTY,
885 "No such property '%s'", name);
887 propdata = g_new(struct property_data, 1);
888 propdata->id = next_pending_property++;
889 propdata->message = dbus_message_ref(message);
891 property->set(property, &sub, propdata->id, iface->user_data);
896 static const GDBusMethodTable properties_methods[] = {
897 { GDBUS_METHOD("Get",
898 GDBUS_ARGS({ "interface", "s" }, { "name", "s" }),
899 GDBUS_ARGS({ "value", "v" }),
901 { GDBUS_ASYNC_METHOD("Set", NULL,
902 GDBUS_ARGS({ "interface", "s" }, { "name", "s" },
905 { GDBUS_METHOD("GetAll",
906 GDBUS_ARGS({ "interface", "s" }),
907 GDBUS_ARGS({ "properties", "a{sv}" }),
908 properties_get_all) },
912 static const GDBusSignalTable properties_signals[] = {
913 { GDBUS_SIGNAL("PropertiesChanged",
914 GDBUS_ARGS({ "interface", "s" },
915 { "changed_properties", "a{sv}" },
916 { "invalidated_properties", "as"})) },
920 static void append_name(gpointer data, gpointer user_data)
923 DBusMessageIter *iter = user_data;
925 dbus_message_iter_append_basic(iter, DBUS_TYPE_STRING, &name);
928 static void emit_interfaces_removed(struct generic_data *data)
931 DBusMessageIter iter, array;
932 struct generic_data *parent = data->parent;
938 while (parent->parent)
939 parent = parent->parent;
941 signal = dbus_message_new_signal(parent->path,
942 DBUS_INTERFACE_OBJECT_MANAGER,
943 "InterfacesRemoved");
947 dbus_message_iter_init_append(signal, &iter);
948 dbus_message_iter_append_basic(&iter, DBUS_TYPE_OBJECT_PATH,
950 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
951 DBUS_TYPE_STRING_AS_STRING, &array);
953 g_slist_foreach(data->removed, append_name, &array);
954 g_slist_free_full(data->removed, g_free);
955 data->removed = NULL;
957 dbus_message_iter_close_container(&iter, &array);
959 g_dbus_send_message(data->conn, signal);
962 static gboolean process_changes(gpointer user_data)
964 struct generic_data *data = user_data;
966 data->process_id = 0;
968 if (data->added != NULL)
969 emit_interfaces_added(data);
971 /* Flush pending properties */
972 if (data->pending_prop == TRUE)
973 process_property_changes(data);
975 if (data->removed != NULL)
976 emit_interfaces_removed(data);
981 static void generic_unregister(DBusConnection *connection, void *user_data)
983 struct generic_data *data = user_data;
984 struct generic_data *parent = data->parent;
987 parent->objects = g_slist_remove(parent->objects, data);
989 if (data->process_id > 0) {
990 g_source_remove(data->process_id);
991 process_changes(data);
994 g_slist_foreach(data->objects, reset_parent, data->parent);
995 g_slist_free(data->objects);
997 dbus_connection_unref(data->conn);
998 g_free(data->introspect);
1003 static DBusHandlerResult generic_message(DBusConnection *connection,
1004 DBusMessage *message, void *user_data)
1006 struct generic_data *data = user_data;
1007 struct interface_data *iface;
1008 const GDBusMethodTable *method;
1009 const char *interface;
1011 interface = dbus_message_get_interface(message);
1013 iface = find_interface(data->interfaces, interface);
1015 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1017 for (method = iface->methods; method &&
1018 method->name && method->function; method++) {
1019 if (dbus_message_is_method_call(message, iface->name,
1020 method->name) == FALSE)
1023 if (g_dbus_args_have_signature(method->in_args,
1027 if (check_privilege(connection, message, method,
1028 iface->user_data) == TRUE)
1029 return DBUS_HANDLER_RESULT_HANDLED;
1031 return process_message(connection, message, method,
1035 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1038 static DBusObjectPathVTable generic_table = {
1039 .unregister_function = generic_unregister,
1040 .message_function = generic_message,
1043 static const GDBusMethodTable introspect_methods[] = {
1044 { GDBUS_METHOD("Introspect", NULL,
1045 GDBUS_ARGS({ "xml", "s" }), introspect) },
1049 static void append_interfaces(struct generic_data *data, DBusMessageIter *iter)
1051 DBusMessageIter array;
1053 dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
1054 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1055 DBUS_TYPE_STRING_AS_STRING
1056 DBUS_TYPE_ARRAY_AS_STRING
1057 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1058 DBUS_TYPE_STRING_AS_STRING
1059 DBUS_TYPE_VARIANT_AS_STRING
1060 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1061 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &array);
1063 g_slist_foreach(data->interfaces, append_interface, &array);
1065 dbus_message_iter_close_container(iter, &array);
1068 static void append_object(gpointer data, gpointer user_data)
1070 struct generic_data *child = data;
1071 DBusMessageIter *array = user_data;
1072 DBusMessageIter entry;
1074 dbus_message_iter_open_container(array, DBUS_TYPE_DICT_ENTRY, NULL,
1076 dbus_message_iter_append_basic(&entry, DBUS_TYPE_OBJECT_PATH,
1078 append_interfaces(child, &entry);
1079 dbus_message_iter_close_container(array, &entry);
1081 g_slist_foreach(child->objects, append_object, user_data);
1084 static DBusMessage *get_objects(DBusConnection *connection,
1085 DBusMessage *message, void *user_data)
1087 struct generic_data *data = user_data;
1089 DBusMessageIter iter;
1090 DBusMessageIter array;
1092 reply = dbus_message_new_method_return(message);
1096 dbus_message_iter_init_append(reply, &iter);
1098 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1099 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1100 DBUS_TYPE_OBJECT_PATH_AS_STRING
1101 DBUS_TYPE_ARRAY_AS_STRING
1102 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1103 DBUS_TYPE_STRING_AS_STRING
1104 DBUS_TYPE_ARRAY_AS_STRING
1105 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1106 DBUS_TYPE_STRING_AS_STRING
1107 DBUS_TYPE_VARIANT_AS_STRING
1108 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1109 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1110 DBUS_DICT_ENTRY_END_CHAR_AS_STRING,
1113 g_slist_foreach(data->objects, append_object, &array);
1115 dbus_message_iter_close_container(&iter, &array);
1120 static const GDBusMethodTable manager_methods[] = {
1121 { GDBUS_METHOD("GetManagedObjects", NULL,
1122 GDBUS_ARGS({ "objects", "a{oa{sa{sv}}}" }), get_objects) },
1126 static const GDBusSignalTable manager_signals[] = {
1127 { GDBUS_SIGNAL("InterfacesAdded",
1128 GDBUS_ARGS({ "object", "o" },
1129 { "interfaces", "a{sa{sv}}" })) },
1130 { GDBUS_SIGNAL("InterfacesRemoved",
1131 GDBUS_ARGS({ "object", "o" }, { "interfaces", "as" })) },
1135 static void add_interface(struct generic_data *data,
1137 const GDBusMethodTable *methods,
1138 const GDBusSignalTable *signals,
1139 const GDBusPropertyTable *properties,
1141 GDBusDestroyFunction destroy)
1143 struct interface_data *iface;
1145 iface = g_new0(struct interface_data, 1);
1146 iface->name = g_strdup(name);
1147 iface->methods = methods;
1148 iface->signals = signals;
1149 iface->properties = properties;
1150 iface->user_data = user_data;
1151 iface->destroy = destroy;
1153 data->interfaces = g_slist_append(data->interfaces, iface);
1154 if (data->parent == NULL)
1157 data->added = g_slist_append(data->added, iface);
1158 if (data->process_id > 0)
1161 data->process_id = g_idle_add(process_changes, data);
1164 static struct generic_data *object_path_ref(DBusConnection *connection,
1167 struct generic_data *data;
1169 if (dbus_connection_get_object_path_data(connection, path,
1170 (void *) &data) == TRUE) {
1177 data = g_new0(struct generic_data, 1);
1178 data->conn = dbus_connection_ref(connection);
1179 data->path = g_strdup(path);
1182 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
1184 if (!dbus_connection_register_object_path(connection, path,
1185 &generic_table, data)) {
1186 g_free(data->introspect);
1191 invalidate_parent_data(connection, path);
1193 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE, introspect_methods,
1194 NULL, NULL, data, NULL);
1196 /* Only root path export ObjectManager interface */
1197 if (data->parent == NULL)
1198 add_interface(data, DBUS_INTERFACE_OBJECT_MANAGER,
1199 manager_methods, manager_signals,
1202 add_interface(data, DBUS_INTERFACE_PROPERTIES, properties_methods,
1203 properties_signals, NULL, data, NULL);
1208 static void object_path_unref(DBusConnection *connection, const char *path)
1210 struct generic_data *data = NULL;
1212 if (dbus_connection_get_object_path_data(connection, path,
1213 (void *) &data) == FALSE)
1221 if (data->refcount > 0)
1224 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
1225 remove_interface(data, DBUS_INTERFACE_PROPERTIES);
1226 remove_interface(data, DBUS_INTERFACE_OBJECT_MANAGER);
1228 invalidate_parent_data(data->conn, data->path);
1230 dbus_connection_unregister_object_path(data->conn, data->path);
1233 static gboolean check_signal(DBusConnection *conn, const char *path,
1234 const char *interface, const char *name,
1235 const GDBusArgInfo **args)
1237 struct generic_data *data = NULL;
1238 struct interface_data *iface;
1239 const GDBusSignalTable *signal;
1242 if (!dbus_connection_get_object_path_data(conn, path,
1243 (void *) &data) || data == NULL) {
1244 error("dbus_connection_emit_signal: path %s isn't registered",
1249 iface = find_interface(data->interfaces, interface);
1250 if (iface == NULL) {
1251 error("dbus_connection_emit_signal: %s does not implement %s",
1256 for (signal = iface->signals; signal && signal->name; signal++) {
1257 if (!strcmp(signal->name, name)) {
1258 *args = signal->args;
1263 error("No signal named %s on interface %s", name, interface);
1267 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
1269 const char *interface,
1274 DBusMessage *signal;
1276 const GDBusArgInfo *args;
1278 if (!check_signal(conn, path, interface, name, &args))
1281 signal = dbus_message_new_signal(path, interface, name);
1282 if (signal == NULL) {
1283 error("Unable to allocate new %s.%s signal", interface, name);
1287 ret = dbus_message_append_args_valist(signal, first, var_args);
1291 if (g_dbus_args_have_signature(args, signal) == FALSE) {
1292 error("%s.%s: got unexpected signature '%s'", interface, name,
1293 dbus_message_get_signature(signal));
1298 ret = dbus_connection_send(conn, signal, NULL);
1301 dbus_message_unref(signal);
1306 gboolean g_dbus_register_interface(DBusConnection *connection,
1307 const char *path, const char *name,
1308 const GDBusMethodTable *methods,
1309 const GDBusSignalTable *signals,
1310 const GDBusPropertyTable *properties,
1312 GDBusDestroyFunction destroy)
1314 struct generic_data *data;
1316 data = object_path_ref(connection, path);
1320 if (find_interface(data->interfaces, name)) {
1321 object_path_unref(connection, path);
1325 add_interface(data, name, methods, signals, properties, user_data,
1328 g_free(data->introspect);
1329 data->introspect = NULL;
1334 gboolean g_dbus_unregister_interface(DBusConnection *connection,
1335 const char *path, const char *name)
1337 struct generic_data *data = NULL;
1342 if (dbus_connection_get_object_path_data(connection, path,
1343 (void *) &data) == FALSE)
1349 if (remove_interface(data, name) == FALSE)
1352 g_free(data->introspect);
1353 data->introspect = NULL;
1355 object_path_unref(connection, data->path);
1360 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
1362 if (security_table != NULL)
1365 security_table = security;
1370 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
1372 security_table = NULL;
1377 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
1378 const char *format, va_list args)
1382 vsnprintf(str, sizeof(str), format, args);
1384 return dbus_message_new_error(message, name, str);
1387 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
1388 const char *format, ...)
1393 va_start(args, format);
1395 reply = g_dbus_create_error_valist(message, name, format, args);
1402 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
1403 int type, va_list args)
1407 reply = dbus_message_new_method_return(message);
1411 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
1412 dbus_message_unref(reply);
1419 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
1424 va_start(args, type);
1426 reply = g_dbus_create_reply_valist(message, type, args);
1433 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
1437 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
1438 dbus_message_set_no_reply(message, TRUE);
1440 result = dbus_connection_send(connection, message, NULL);
1442 dbus_message_unref(message);
1447 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
1448 DBusMessage *message, int type, va_list args)
1452 reply = dbus_message_new_method_return(message);
1456 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
1457 dbus_message_unref(reply);
1461 return g_dbus_send_message(connection, reply);
1464 gboolean g_dbus_send_reply(DBusConnection *connection,
1465 DBusMessage *message, int type, ...)
1470 va_start(args, type);
1472 result = g_dbus_send_reply_valist(connection, message, type, args);
1479 gboolean g_dbus_emit_signal(DBusConnection *connection,
1480 const char *path, const char *interface,
1481 const char *name, int type, ...)
1486 va_start(args, type);
1488 result = emit_signal_valist(connection, path, interface,
1496 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
1497 const char *path, const char *interface,
1498 const char *name, int type, va_list args)
1500 return emit_signal_valist(connection, path, interface,
1504 static void process_properties_from_interface(struct generic_data *data,
1505 struct interface_data *iface)
1508 DBusMessage *signal;
1509 DBusMessageIter iter, dict, array;
1511 if (iface->pending_prop == NULL)
1514 signal = dbus_message_new_signal(data->path,
1515 DBUS_INTERFACE_PROPERTIES, "PropertiesChanged");
1516 if (signal == NULL) {
1517 error("Unable to allocate new " DBUS_INTERFACE_PROPERTIES
1518 ".PropertiesChanged signal");
1522 iface->pending_prop = g_slist_reverse(iface->pending_prop);
1524 dbus_message_iter_init_append(signal, &iter);
1525 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &iface->name);
1526 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1527 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1528 DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
1529 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
1531 for (l = iface->pending_prop; l != NULL; l = l->next) {
1532 GDBusPropertyTable *p = l->data;
1537 if (p->exists != NULL && !p->exists(p, iface->user_data))
1540 append_property(iface, p, &dict);
1543 dbus_message_iter_close_container(&iter, &dict);
1544 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1545 DBUS_TYPE_STRING_AS_STRING, &array);
1546 dbus_message_iter_close_container(&iter, &array);
1548 g_dbus_send_message(data->conn, signal);
1550 g_slist_free(iface->pending_prop);
1551 iface->pending_prop = NULL;
1554 static void process_property_changes(struct generic_data *data)
1558 for (l = data->interfaces; l != NULL; l = l->next) {
1559 struct interface_data *iface = l->data;
1561 process_properties_from_interface(data, iface);
1564 data->pending_prop = FALSE;
1567 void g_dbus_emit_property_changed(DBusConnection *connection,
1568 const char *path, const char *interface,
1571 const GDBusPropertyTable *property;
1572 struct generic_data *data;
1573 struct interface_data *iface;
1575 if (!dbus_connection_get_object_path_data(connection, path,
1576 (void **) &data) || data == NULL)
1579 iface = find_interface(data->interfaces, interface);
1583 property = find_property(iface->properties, name);
1584 if (property == NULL) {
1585 error("Could not find property %s in %p", name,
1590 data->pending_prop = TRUE;
1591 iface->pending_prop = g_slist_prepend(iface->pending_prop,
1594 if (!data->process_id) {
1595 data->process_id = g_idle_add(process_changes, data);