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 "<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(name_, value_) \
113 "<annotation name=\"org.freedesktop.DBus." name_ "\" " \
114 "value=\"" value_ "\"/>"
116 #define G_DBUS_ANNOTATE_DEPRECATED \
117 G_DBUS_ANNOTATE("Deprecated", "true")
119 #define G_DBUS_ANNOTATE_NOREPLY \
120 G_DBUS_ANNOTATE("Method.NoReply", "true")
122 static gboolean check_experimental(int flags, int flag)
127 return !(global_flags & G_DBUS_FLAG_ENABLE_EXPERIMENTAL);
130 static void generate_interface_xml(GString *gstr, struct interface_data *iface)
132 const GDBusMethodTable *method;
133 const GDBusSignalTable *signal;
134 const GDBusPropertyTable *property;
136 for (method = iface->methods; method && method->name; method++) {
137 if (check_experimental(method->flags,
138 G_DBUS_METHOD_FLAG_EXPERIMENTAL))
141 g_string_append_printf(gstr, "<method name=\"%s\">",
143 print_arguments(gstr, method->in_args, "in");
144 print_arguments(gstr, method->out_args, "out");
146 if (method->flags & G_DBUS_METHOD_FLAG_DEPRECATED)
147 g_string_append_printf(gstr,
148 G_DBUS_ANNOTATE_DEPRECATED);
150 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY)
151 g_string_append_printf(gstr, G_DBUS_ANNOTATE_NOREPLY);
153 g_string_append_printf(gstr, "</method>");
156 for (signal = iface->signals; signal && signal->name; signal++) {
157 if (check_experimental(signal->flags,
158 G_DBUS_SIGNAL_FLAG_EXPERIMENTAL))
161 g_string_append_printf(gstr, "<signal name=\"%s\">",
163 print_arguments(gstr, signal->args, NULL);
165 if (signal->flags & G_DBUS_SIGNAL_FLAG_DEPRECATED)
166 g_string_append_printf(gstr,
167 G_DBUS_ANNOTATE_DEPRECATED);
169 g_string_append_printf(gstr, "</signal>\n");
172 for (property = iface->properties; property && property->name;
174 if (check_experimental(property->flags,
175 G_DBUS_PROPERTY_FLAG_EXPERIMENTAL))
178 g_string_append_printf(gstr, "<property name=\"%s\""
179 " type=\"%s\" access=\"%s%s\">",
180 property->name, property->type,
181 property->get ? "read" : "",
182 property->set ? "write" : "");
184 if (property->flags & G_DBUS_PROPERTY_FLAG_DEPRECATED)
185 g_string_append_printf(gstr,
186 G_DBUS_ANNOTATE_DEPRECATED);
188 g_string_append_printf(gstr, "</property>");
192 static void generate_introspection_xml(DBusConnection *conn,
193 struct generic_data *data, const char *path)
200 g_free(data->introspect);
202 gstr = g_string_new(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE);
204 g_string_append_printf(gstr, "<node>");
206 for (list = data->interfaces; list; list = list->next) {
207 struct interface_data *iface = list->data;
209 g_string_append_printf(gstr, "<interface name=\"%s\">",
212 generate_interface_xml(gstr, iface);
214 g_string_append_printf(gstr, "</interface>");
217 if (!dbus_connection_list_registered(conn, path, &children))
220 for (i = 0; children[i]; i++)
221 g_string_append_printf(gstr, "<node name=\"%s\"/>",
224 dbus_free_string_array(children);
227 g_string_append_printf(gstr, "</node>");
229 data->introspect = g_string_free(gstr, FALSE);
232 static DBusMessage *introspect(DBusConnection *connection,
233 DBusMessage *message, void *user_data)
235 struct generic_data *data = user_data;
238 if (data->introspect == NULL)
239 generate_introspection_xml(connection, data,
240 dbus_message_get_path(message));
242 reply = dbus_message_new_method_return(message);
246 dbus_message_append_args(reply, DBUS_TYPE_STRING, &data->introspect,
252 static DBusHandlerResult process_message(DBusConnection *connection,
253 DBusMessage *message, const GDBusMethodTable *method,
254 void *iface_user_data)
258 reply = method->function(connection, message, iface_user_data);
260 if (method->flags & G_DBUS_METHOD_FLAG_NOREPLY) {
262 dbus_message_unref(reply);
263 return DBUS_HANDLER_RESULT_HANDLED;
266 if (method->flags & G_DBUS_METHOD_FLAG_ASYNC) {
268 return DBUS_HANDLER_RESULT_HANDLED;
272 return DBUS_HANDLER_RESULT_NEED_MEMORY;
274 dbus_connection_send(connection, reply, NULL);
275 dbus_message_unref(reply);
277 return DBUS_HANDLER_RESULT_HANDLED;
280 static GDBusPendingReply next_pending = 1;
281 static GSList *pending_security = NULL;
283 static const GDBusSecurityTable *security_table = NULL;
285 void g_dbus_pending_success(DBusConnection *connection,
286 GDBusPendingReply pending)
290 for (list = pending_security; list; list = list->next) {
291 struct security_data *secdata = list->data;
293 if (secdata->pending != pending)
296 pending_security = g_slist_remove(pending_security, secdata);
298 process_message(connection, secdata->message,
299 secdata->method, secdata->iface_user_data);
301 dbus_message_unref(secdata->message);
307 void g_dbus_pending_error_valist(DBusConnection *connection,
308 GDBusPendingReply pending, const char *name,
309 const char *format, va_list args)
313 for (list = pending_security; list; list = list->next) {
314 struct security_data *secdata = list->data;
317 if (secdata->pending != pending)
320 pending_security = g_slist_remove(pending_security, secdata);
322 reply = g_dbus_create_error_valist(secdata->message,
325 dbus_connection_send(connection, reply, NULL);
326 dbus_message_unref(reply);
329 dbus_message_unref(secdata->message);
335 void g_dbus_pending_error(DBusConnection *connection,
336 GDBusPendingReply pending,
337 const char *name, const char *format, ...)
341 va_start(args, format);
343 g_dbus_pending_error_valist(connection, pending, name, format, args);
348 int polkit_check_authorization(DBusConnection *conn,
349 const char *action, gboolean interaction,
350 void (*function) (dbus_bool_t authorized,
352 void *user_data, int timeout);
354 struct builtin_security_data {
355 DBusConnection *conn;
356 GDBusPendingReply pending;
359 static void builtin_security_result(dbus_bool_t authorized, void *user_data)
361 struct builtin_security_data *data = user_data;
363 if (authorized == TRUE)
364 g_dbus_pending_success(data->conn, data->pending);
366 g_dbus_pending_error(data->conn, data->pending,
367 DBUS_ERROR_AUTH_FAILED, NULL);
372 static void builtin_security_function(DBusConnection *conn,
374 gboolean interaction,
375 GDBusPendingReply pending)
377 struct builtin_security_data *data;
379 data = g_new0(struct builtin_security_data, 1);
381 data->pending = pending;
383 if (polkit_check_authorization(conn, action, interaction,
384 builtin_security_result, data, 30000) < 0)
385 g_dbus_pending_error(conn, pending, NULL, NULL);
388 static gboolean check_privilege(DBusConnection *conn, DBusMessage *msg,
389 const GDBusMethodTable *method, void *iface_user_data)
391 const GDBusSecurityTable *security;
393 for (security = security_table; security && security->privilege;
395 struct security_data *secdata;
396 gboolean interaction;
398 if (security->privilege != method->privilege)
401 secdata = g_new(struct security_data, 1);
402 secdata->pending = next_pending++;
403 secdata->message = dbus_message_ref(msg);
404 secdata->method = method;
405 secdata->iface_user_data = iface_user_data;
407 pending_security = g_slist_prepend(pending_security, secdata);
409 if (security->flags & G_DBUS_SECURITY_FLAG_ALLOW_INTERACTION)
414 if (!(security->flags & G_DBUS_SECURITY_FLAG_BUILTIN) &&
416 security->function(conn, security->action,
417 interaction, secdata->pending);
419 builtin_security_function(conn, security->action,
420 interaction, secdata->pending);
428 static GDBusPendingPropertySet next_pending_property = 1;
429 static GSList *pending_property_set;
431 static struct property_data *remove_pending_property_data(
432 GDBusPendingPropertySet id)
434 struct property_data *propdata;
437 for (l = pending_property_set; l != NULL; l = l->next) {
439 if (propdata->id != id)
448 pending_property_set = g_slist_delete_link(pending_property_set, l);
453 void g_dbus_pending_property_success(GDBusPendingPropertySet id)
455 struct property_data *propdata;
457 propdata = remove_pending_property_data(id);
458 if (propdata == NULL)
461 g_dbus_send_reply(propdata->conn, propdata->message,
463 dbus_message_unref(propdata->message);
467 void g_dbus_pending_property_error_valist(GDBusPendingReply id,
468 const char *name, const char *format,
471 struct property_data *propdata;
474 propdata = remove_pending_property_data(id);
475 if (propdata == NULL)
478 reply = g_dbus_create_error_valist(propdata->message, name, format,
481 dbus_connection_send(propdata->conn, reply, NULL);
482 dbus_message_unref(reply);
485 dbus_message_unref(propdata->message);
489 void g_dbus_pending_property_error(GDBusPendingReply id, const char *name,
490 const char *format, ...)
494 va_start(args, format);
496 g_dbus_pending_property_error_valist(id, name, format, args);
501 static void reset_parent(gpointer data, gpointer user_data)
503 struct generic_data *child = data;
504 struct generic_data *parent = user_data;
506 child->parent = parent;
509 static void append_property(struct interface_data *iface,
510 const GDBusPropertyTable *p, DBusMessageIter *dict)
512 DBusMessageIter entry, value;
514 dbus_message_iter_open_container(dict, DBUS_TYPE_DICT_ENTRY, NULL,
516 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &p->name);
517 dbus_message_iter_open_container(&entry, DBUS_TYPE_VARIANT, p->type,
520 p->get(p, &value, iface->user_data);
522 dbus_message_iter_close_container(&entry, &value);
523 dbus_message_iter_close_container(dict, &entry);
526 static void append_properties(struct interface_data *data,
527 DBusMessageIter *iter)
529 DBusMessageIter dict;
530 const GDBusPropertyTable *p;
532 dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
533 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
534 DBUS_TYPE_STRING_AS_STRING
535 DBUS_TYPE_VARIANT_AS_STRING
536 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
538 for (p = data->properties; p && p->name; p++) {
539 if (check_experimental(p->flags,
540 G_DBUS_PROPERTY_FLAG_EXPERIMENTAL))
546 if (p->exists != NULL && !p->exists(p, data->user_data))
549 append_property(data, p, &dict);
552 dbus_message_iter_close_container(iter, &dict);
555 static void append_interface(gpointer data, gpointer user_data)
557 struct interface_data *iface = data;
558 DBusMessageIter *array = user_data;
559 DBusMessageIter entry;
561 dbus_message_iter_open_container(array, DBUS_TYPE_DICT_ENTRY, NULL,
563 dbus_message_iter_append_basic(&entry, DBUS_TYPE_STRING, &iface->name);
564 append_properties(data, &entry);
565 dbus_message_iter_close_container(array, &entry);
568 static void emit_interfaces_added(struct generic_data *data)
571 DBusMessageIter iter, array;
573 if (root == NULL || data == root)
576 signal = dbus_message_new_signal(root->path,
577 DBUS_INTERFACE_OBJECT_MANAGER,
582 dbus_message_iter_init_append(signal, &iter);
583 dbus_message_iter_append_basic(&iter, DBUS_TYPE_OBJECT_PATH,
586 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
587 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
588 DBUS_TYPE_STRING_AS_STRING
589 DBUS_TYPE_ARRAY_AS_STRING
590 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
591 DBUS_TYPE_STRING_AS_STRING
592 DBUS_TYPE_VARIANT_AS_STRING
593 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
594 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &array);
596 g_slist_foreach(data->added, append_interface, &array);
597 g_slist_free(data->added);
600 dbus_message_iter_close_container(&iter, &array);
602 g_dbus_send_message(data->conn, signal);
605 static struct interface_data *find_interface(GSList *interfaces,
613 for (list = interfaces; list; list = list->next) {
614 struct interface_data *iface = list->data;
615 if (!strcmp(name, iface->name))
622 static gboolean g_dbus_args_have_signature(const GDBusArgInfo *args,
623 DBusMessage *message)
625 const char *sig = dbus_message_get_signature(message);
626 const char *p = NULL;
628 for (; args && args->signature && *sig; args++) {
631 for (; *sig && *p; sig++, p++) {
637 if (*sig || (p && *p) || (args && args->signature))
643 static gboolean remove_interface(struct generic_data *data, const char *name)
645 struct interface_data *iface;
647 iface = find_interface(data->interfaces, name);
651 process_properties_from_interface(data, iface);
653 data->interfaces = g_slist_remove(data->interfaces, iface);
655 if (iface->destroy) {
656 iface->destroy(iface->user_data);
657 iface->user_data = 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 if (data->parent == NULL) {
677 data->removed = g_slist_prepend(data->removed, iface->name);
680 if (data->process_id > 0)
683 data->process_id = g_idle_add(process_changes, data);
688 static struct generic_data *invalidate_parent_data(DBusConnection *conn,
689 const char *child_path)
691 struct generic_data *data = NULL, *child = NULL, *parent = NULL;
692 char *parent_path, *slash;
694 parent_path = g_strdup(child_path);
695 slash = strrchr(parent_path, '/');
699 if (slash == parent_path && parent_path[1] != '\0')
700 parent_path[1] = '\0';
704 if (!strlen(parent_path))
707 if (dbus_connection_get_object_path_data(conn, parent_path,
708 (void *) &data) == FALSE) {
712 parent = invalidate_parent_data(conn, parent_path);
720 g_free(data->introspect);
721 data->introspect = NULL;
723 if (!dbus_connection_get_object_path_data(conn, child_path,
727 if (child == NULL || g_slist_find(data->objects, child) != NULL)
730 data->objects = g_slist_prepend(data->objects, child);
731 child->parent = data;
738 static inline const GDBusPropertyTable *find_property(const GDBusPropertyTable *properties,
741 const GDBusPropertyTable *p;
743 for (p = properties; p && p->name; p++) {
744 if (strcmp(name, p->name) != 0)
747 if (check_experimental(p->flags,
748 G_DBUS_PROPERTY_FLAG_EXPERIMENTAL))
757 static DBusMessage *properties_get(DBusConnection *connection,
758 DBusMessage *message, void *user_data)
760 struct generic_data *data = user_data;
761 struct interface_data *iface;
762 const GDBusPropertyTable *property;
763 const char *interface, *name;
764 DBusMessageIter iter, value;
767 if (!dbus_message_get_args(message, NULL,
768 DBUS_TYPE_STRING, &interface,
769 DBUS_TYPE_STRING, &name,
773 iface = find_interface(data->interfaces, interface);
775 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
776 "No such interface '%s'", interface);
778 property = find_property(iface->properties, name);
779 if (property == NULL)
780 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
781 "No such property '%s'", name);
783 if (property->exists != NULL &&
784 !property->exists(property, iface->user_data))
785 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
786 "No such property '%s'", name);
788 if (property->get == NULL)
789 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
790 "Property '%s' is not readable", name);
792 reply = dbus_message_new_method_return(message);
796 dbus_message_iter_init_append(reply, &iter);
797 dbus_message_iter_open_container(&iter, DBUS_TYPE_VARIANT,
798 property->type, &value);
800 if (!property->get(property, &value, iface->user_data)) {
801 dbus_message_unref(reply);
805 dbus_message_iter_close_container(&iter, &value);
810 static DBusMessage *properties_get_all(DBusConnection *connection,
811 DBusMessage *message, void *user_data)
813 struct generic_data *data = user_data;
814 struct interface_data *iface;
815 const char *interface;
816 DBusMessageIter iter;
819 if (!dbus_message_get_args(message, NULL,
820 DBUS_TYPE_STRING, &interface,
824 iface = find_interface(data->interfaces, interface);
826 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
827 "No such interface '%s'", interface);
829 reply = dbus_message_new_method_return(message);
833 dbus_message_iter_init_append(reply, &iter);
835 append_properties(iface, &iter);
840 static DBusMessage *properties_set(DBusConnection *connection,
841 DBusMessage *message, void *user_data)
843 struct generic_data *data = user_data;
844 DBusMessageIter iter, sub;
845 struct interface_data *iface;
846 const GDBusPropertyTable *property;
847 const char *name, *interface;
848 struct property_data *propdata;
850 if (!dbus_message_iter_init(message, &iter))
851 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
852 "No arguments given");
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, &interface);
860 dbus_message_iter_next(&iter);
862 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_STRING)
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_get_basic(&iter, &name);
868 dbus_message_iter_next(&iter);
870 if (dbus_message_iter_get_arg_type(&iter) != DBUS_TYPE_VARIANT)
871 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
872 "Invalid argument type: '%c'",
873 dbus_message_iter_get_arg_type(&iter));
875 dbus_message_iter_recurse(&iter, &sub);
877 iface = find_interface(data->interfaces, interface);
879 return g_dbus_create_error(message, DBUS_ERROR_INVALID_ARGS,
880 "No such interface '%s'", interface);
882 property = find_property(iface->properties, name);
883 if (property == NULL)
884 return g_dbus_create_error(message,
885 DBUS_ERROR_UNKNOWN_PROPERTY,
886 "No such property '%s'", name);
888 if (property->set == NULL)
889 return g_dbus_create_error(message,
890 DBUS_ERROR_PROPERTY_READ_ONLY,
891 "Property '%s' is not writable", name);
893 if (property->exists != NULL &&
894 !property->exists(property, iface->user_data))
895 return g_dbus_create_error(message,
896 DBUS_ERROR_UNKNOWN_PROPERTY,
897 "No such property '%s'", name);
899 if (strcmp(dbus_message_iter_get_signature(&sub), property->type))
900 return g_dbus_create_error(message,
901 DBUS_ERROR_INVALID_SIGNATURE,
902 "Invalid signature for '%s'", name);
904 propdata = g_new(struct property_data, 1);
905 propdata->id = next_pending_property++;
906 propdata->message = dbus_message_ref(message);
907 propdata->conn = connection;
908 pending_property_set = g_slist_prepend(pending_property_set, propdata);
910 property->set(property, &sub, propdata->id, iface->user_data);
915 static const GDBusMethodTable properties_methods[] = {
916 { GDBUS_METHOD("Get",
917 GDBUS_ARGS({ "interface", "s" }, { "name", "s" }),
918 GDBUS_ARGS({ "value", "v" }),
920 { GDBUS_ASYNC_METHOD("Set",
921 GDBUS_ARGS({ "interface", "s" }, { "name", "s" },
925 { GDBUS_METHOD("GetAll",
926 GDBUS_ARGS({ "interface", "s" }),
927 GDBUS_ARGS({ "properties", "a{sv}" }),
928 properties_get_all) },
932 static const GDBusSignalTable properties_signals[] = {
933 { GDBUS_SIGNAL("PropertiesChanged",
934 GDBUS_ARGS({ "interface", "s" },
935 { "changed_properties", "a{sv}" },
936 { "invalidated_properties", "as"})) },
940 static void append_name(gpointer data, gpointer user_data)
943 DBusMessageIter *iter = user_data;
945 dbus_message_iter_append_basic(iter, DBUS_TYPE_STRING, &name);
948 static void emit_interfaces_removed(struct generic_data *data)
951 DBusMessageIter iter, array;
953 if (root == NULL || data == root)
956 signal = dbus_message_new_signal(root->path,
957 DBUS_INTERFACE_OBJECT_MANAGER,
958 "InterfacesRemoved");
962 dbus_message_iter_init_append(signal, &iter);
963 dbus_message_iter_append_basic(&iter, DBUS_TYPE_OBJECT_PATH,
965 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
966 DBUS_TYPE_STRING_AS_STRING, &array);
968 g_slist_foreach(data->removed, append_name, &array);
969 g_slist_free_full(data->removed, g_free);
970 data->removed = NULL;
972 dbus_message_iter_close_container(&iter, &array);
974 g_dbus_send_message(data->conn, signal);
977 static gboolean process_changes(gpointer user_data)
979 struct generic_data *data = user_data;
981 data->process_id = 0;
983 if (data->added != NULL)
984 emit_interfaces_added(data);
986 /* Flush pending properties */
987 if (data->pending_prop == TRUE)
988 process_property_changes(data);
990 if (data->removed != NULL)
991 emit_interfaces_removed(data);
996 static void generic_unregister(DBusConnection *connection, void *user_data)
998 struct generic_data *data = user_data;
999 struct generic_data *parent = data->parent;
1002 parent->objects = g_slist_remove(parent->objects, data);
1004 if (data->process_id > 0) {
1005 g_source_remove(data->process_id);
1006 process_changes(data);
1009 g_slist_foreach(data->objects, reset_parent, data->parent);
1010 g_slist_free(data->objects);
1012 dbus_connection_unref(data->conn);
1013 g_free(data->introspect);
1018 static DBusHandlerResult generic_message(DBusConnection *connection,
1019 DBusMessage *message, void *user_data)
1021 struct generic_data *data = user_data;
1022 struct interface_data *iface;
1023 const GDBusMethodTable *method;
1024 const char *interface;
1026 interface = dbus_message_get_interface(message);
1028 iface = find_interface(data->interfaces, interface);
1030 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1032 for (method = iface->methods; method &&
1033 method->name && method->function; method++) {
1035 if (dbus_message_is_method_call(message, iface->name,
1036 method->name) == FALSE)
1039 if (check_experimental(method->flags,
1040 G_DBUS_METHOD_FLAG_EXPERIMENTAL))
1041 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1043 if (g_dbus_args_have_signature(method->in_args,
1047 if (check_privilege(connection, message, method,
1048 iface->user_data) == TRUE)
1049 return DBUS_HANDLER_RESULT_HANDLED;
1051 return process_message(connection, message, method,
1055 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
1058 static DBusObjectPathVTable generic_table = {
1059 .unregister_function = generic_unregister,
1060 .message_function = generic_message,
1063 static const GDBusMethodTable introspect_methods[] = {
1064 { GDBUS_METHOD("Introspect", NULL,
1065 GDBUS_ARGS({ "xml", "s" }), introspect) },
1069 static void append_interfaces(struct generic_data *data, DBusMessageIter *iter)
1071 DBusMessageIter array;
1074 dbus_message_iter_open_container(iter, DBUS_TYPE_ARRAY,
1075 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1076 DBUS_TYPE_STRING_AS_STRING
1077 DBUS_TYPE_ARRAY_AS_STRING
1078 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1079 DBUS_TYPE_STRING_AS_STRING
1080 DBUS_TYPE_VARIANT_AS_STRING
1081 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1082 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &array);
1084 for (l = data->interfaces; l != NULL; l = l->next) {
1085 if (g_slist_find(data->added, l->data))
1088 append_interface(l->data, &array);
1091 dbus_message_iter_close_container(iter, &array);
1094 static void append_object(gpointer data, gpointer user_data)
1096 struct generic_data *child = data;
1097 DBusMessageIter *array = user_data;
1098 DBusMessageIter entry;
1100 dbus_message_iter_open_container(array, DBUS_TYPE_DICT_ENTRY, NULL,
1102 dbus_message_iter_append_basic(&entry, DBUS_TYPE_OBJECT_PATH,
1104 append_interfaces(child, &entry);
1105 dbus_message_iter_close_container(array, &entry);
1107 g_slist_foreach(child->objects, append_object, user_data);
1110 static DBusMessage *get_objects(DBusConnection *connection,
1111 DBusMessage *message, void *user_data)
1113 struct generic_data *data = user_data;
1115 DBusMessageIter iter;
1116 DBusMessageIter array;
1118 reply = dbus_message_new_method_return(message);
1122 dbus_message_iter_init_append(reply, &iter);
1124 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1125 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1126 DBUS_TYPE_OBJECT_PATH_AS_STRING
1127 DBUS_TYPE_ARRAY_AS_STRING
1128 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1129 DBUS_TYPE_STRING_AS_STRING
1130 DBUS_TYPE_ARRAY_AS_STRING
1131 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1132 DBUS_TYPE_STRING_AS_STRING
1133 DBUS_TYPE_VARIANT_AS_STRING
1134 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1135 DBUS_DICT_ENTRY_END_CHAR_AS_STRING
1136 DBUS_DICT_ENTRY_END_CHAR_AS_STRING,
1139 g_slist_foreach(data->objects, append_object, &array);
1141 dbus_message_iter_close_container(&iter, &array);
1146 static const GDBusMethodTable manager_methods[] = {
1147 { GDBUS_METHOD("GetManagedObjects", NULL,
1148 GDBUS_ARGS({ "objects", "a{oa{sa{sv}}}" }), get_objects) },
1152 static const GDBusSignalTable manager_signals[] = {
1153 { GDBUS_SIGNAL("InterfacesAdded",
1154 GDBUS_ARGS({ "object", "o" },
1155 { "interfaces", "a{sa{sv}}" })) },
1156 { GDBUS_SIGNAL("InterfacesRemoved",
1157 GDBUS_ARGS({ "object", "o" }, { "interfaces", "as" })) },
1161 static gboolean add_interface(struct generic_data *data,
1163 const GDBusMethodTable *methods,
1164 const GDBusSignalTable *signals,
1165 const GDBusPropertyTable *properties,
1167 GDBusDestroyFunction destroy)
1169 struct interface_data *iface;
1170 const GDBusMethodTable *method;
1171 const GDBusSignalTable *signal;
1172 const GDBusPropertyTable *property;
1174 for (method = methods; method && method->name; method++) {
1175 if (!check_experimental(method->flags,
1176 G_DBUS_METHOD_FLAG_EXPERIMENTAL))
1180 for (signal = signals; signal && signal->name; signal++) {
1181 if (!check_experimental(signal->flags,
1182 G_DBUS_SIGNAL_FLAG_EXPERIMENTAL))
1186 for (property = properties; property && property->name; property++) {
1187 if (!check_experimental(property->flags,
1188 G_DBUS_PROPERTY_FLAG_EXPERIMENTAL))
1192 /* Nothing to register */
1196 iface = g_new0(struct interface_data, 1);
1197 iface->name = g_strdup(name);
1198 iface->methods = methods;
1199 iface->signals = signals;
1200 iface->properties = properties;
1201 iface->user_data = user_data;
1202 iface->destroy = destroy;
1204 data->interfaces = g_slist_append(data->interfaces, iface);
1205 if (data->parent == NULL)
1208 data->added = g_slist_append(data->added, iface);
1209 if (data->process_id > 0)
1212 data->process_id = g_idle_add(process_changes, data);
1217 static struct generic_data *object_path_ref(DBusConnection *connection,
1220 struct generic_data *data;
1222 if (dbus_connection_get_object_path_data(connection, path,
1223 (void *) &data) == TRUE) {
1230 data = g_new0(struct generic_data, 1);
1231 data->conn = dbus_connection_ref(connection);
1232 data->path = g_strdup(path);
1235 data->introspect = g_strdup(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE "<node></node>");
1237 if (!dbus_connection_register_object_path(connection, path,
1238 &generic_table, data)) {
1239 g_free(data->introspect);
1244 invalidate_parent_data(connection, path);
1246 add_interface(data, DBUS_INTERFACE_INTROSPECTABLE, introspect_methods,
1247 NULL, NULL, data, NULL);
1252 static void object_path_unref(DBusConnection *connection, const char *path)
1254 struct generic_data *data = NULL;
1256 if (dbus_connection_get_object_path_data(connection, path,
1257 (void *) &data) == FALSE)
1265 if (data->refcount > 0)
1268 remove_interface(data, DBUS_INTERFACE_INTROSPECTABLE);
1269 remove_interface(data, DBUS_INTERFACE_PROPERTIES);
1271 invalidate_parent_data(data->conn, data->path);
1273 dbus_connection_unregister_object_path(data->conn, data->path);
1276 static gboolean check_signal(DBusConnection *conn, const char *path,
1277 const char *interface, const char *name,
1278 const GDBusArgInfo **args)
1280 struct generic_data *data = NULL;
1281 struct interface_data *iface;
1282 const GDBusSignalTable *signal;
1285 if (!dbus_connection_get_object_path_data(conn, path,
1286 (void *) &data) || data == NULL) {
1287 error("dbus_connection_emit_signal: path %s isn't registered",
1292 iface = find_interface(data->interfaces, interface);
1293 if (iface == NULL) {
1294 error("dbus_connection_emit_signal: %s does not implement %s",
1299 for (signal = iface->signals; signal && signal->name; signal++) {
1300 if (strcmp(signal->name, name) != 0)
1303 if (signal->flags & G_DBUS_SIGNAL_FLAG_EXPERIMENTAL) {
1304 const char *env = g_getenv("GDBUS_EXPERIMENTAL");
1305 if (g_strcmp0(env, "1") != 0)
1309 *args = signal->args;
1313 error("No signal named %s on interface %s", name, interface);
1317 static dbus_bool_t emit_signal_valist(DBusConnection *conn,
1319 const char *interface,
1324 DBusMessage *signal;
1326 const GDBusArgInfo *args;
1328 if (!check_signal(conn, path, interface, name, &args))
1331 signal = dbus_message_new_signal(path, interface, name);
1332 if (signal == NULL) {
1333 error("Unable to allocate new %s.%s signal", interface, name);
1337 ret = dbus_message_append_args_valist(signal, first, var_args);
1341 if (g_dbus_args_have_signature(args, signal) == FALSE) {
1342 error("%s.%s: got unexpected signature '%s'", interface, name,
1343 dbus_message_get_signature(signal));
1348 ret = dbus_connection_send(conn, signal, NULL);
1351 dbus_message_unref(signal);
1356 gboolean g_dbus_register_interface(DBusConnection *connection,
1357 const char *path, const char *name,
1358 const GDBusMethodTable *methods,
1359 const GDBusSignalTable *signals,
1360 const GDBusPropertyTable *properties,
1362 GDBusDestroyFunction destroy)
1364 struct generic_data *data;
1366 data = object_path_ref(connection, path);
1370 if (find_interface(data->interfaces, name)) {
1371 object_path_unref(connection, path);
1375 if (!add_interface(data, name, methods, signals, properties, user_data,
1377 object_path_unref(connection, path);
1381 if (properties != NULL && !find_interface(data->interfaces,
1382 DBUS_INTERFACE_PROPERTIES))
1383 add_interface(data, DBUS_INTERFACE_PROPERTIES,
1384 properties_methods, properties_signals, NULL,
1387 g_free(data->introspect);
1388 data->introspect = NULL;
1393 gboolean g_dbus_unregister_interface(DBusConnection *connection,
1394 const char *path, const char *name)
1396 struct generic_data *data = NULL;
1401 if (dbus_connection_get_object_path_data(connection, path,
1402 (void *) &data) == FALSE)
1408 if (remove_interface(data, name) == FALSE)
1411 g_free(data->introspect);
1412 data->introspect = NULL;
1414 object_path_unref(connection, data->path);
1419 gboolean g_dbus_register_security(const GDBusSecurityTable *security)
1421 if (security_table != NULL)
1424 security_table = security;
1429 gboolean g_dbus_unregister_security(const GDBusSecurityTable *security)
1431 security_table = NULL;
1436 DBusMessage *g_dbus_create_error_valist(DBusMessage *message, const char *name,
1437 const char *format, va_list args)
1441 vsnprintf(str, sizeof(str), format, args);
1443 return dbus_message_new_error(message, name, str);
1446 DBusMessage *g_dbus_create_error(DBusMessage *message, const char *name,
1447 const char *format, ...)
1452 va_start(args, format);
1454 reply = g_dbus_create_error_valist(message, name, format, args);
1461 DBusMessage *g_dbus_create_reply_valist(DBusMessage *message,
1462 int type, va_list args)
1466 reply = dbus_message_new_method_return(message);
1470 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
1471 dbus_message_unref(reply);
1478 DBusMessage *g_dbus_create_reply(DBusMessage *message, int type, ...)
1483 va_start(args, type);
1485 reply = g_dbus_create_reply_valist(message, type, args);
1492 gboolean g_dbus_send_message(DBusConnection *connection, DBusMessage *message)
1496 if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_METHOD_CALL)
1497 dbus_message_set_no_reply(message, TRUE);
1498 else if (dbus_message_get_type(message) == DBUS_MESSAGE_TYPE_SIGNAL) {
1499 const char *path = dbus_message_get_path(message);
1500 const char *interface = dbus_message_get_interface(message);
1501 const char *name = dbus_message_get_member(message);
1502 const GDBusArgInfo *args;
1504 if (!check_signal(connection, path, interface, name, &args))
1508 result = dbus_connection_send(connection, message, NULL);
1510 dbus_message_unref(message);
1515 gboolean g_dbus_send_error_valist(DBusConnection *connection,
1516 DBusMessage *message, const char *name,
1517 const char *format, va_list args)
1522 vsnprintf(str, sizeof(str), format, args);
1524 error = dbus_message_new_error(message, name, str);
1528 return g_dbus_send_message(connection, error);
1531 gboolean g_dbus_send_error(DBusConnection *connection, DBusMessage *message,
1532 const char *name, const char *format, ...)
1537 va_start(args, format);
1539 result = g_dbus_send_error_valist(connection, message, name,
1547 gboolean g_dbus_send_reply_valist(DBusConnection *connection,
1548 DBusMessage *message, int type, va_list args)
1552 reply = dbus_message_new_method_return(message);
1556 if (dbus_message_append_args_valist(reply, type, args) == FALSE) {
1557 dbus_message_unref(reply);
1561 return g_dbus_send_message(connection, reply);
1564 gboolean g_dbus_send_reply(DBusConnection *connection,
1565 DBusMessage *message, int type, ...)
1570 va_start(args, type);
1572 result = g_dbus_send_reply_valist(connection, message, type, args);
1579 gboolean g_dbus_emit_signal(DBusConnection *connection,
1580 const char *path, const char *interface,
1581 const char *name, int type, ...)
1586 va_start(args, type);
1588 result = emit_signal_valist(connection, path, interface,
1596 gboolean g_dbus_emit_signal_valist(DBusConnection *connection,
1597 const char *path, const char *interface,
1598 const char *name, int type, va_list args)
1600 return emit_signal_valist(connection, path, interface,
1604 static void process_properties_from_interface(struct generic_data *data,
1605 struct interface_data *iface)
1608 DBusMessage *signal;
1609 DBusMessageIter iter, dict, array;
1610 GSList *invalidated;
1612 if (iface->pending_prop == NULL)
1615 signal = dbus_message_new_signal(data->path,
1616 DBUS_INTERFACE_PROPERTIES, "PropertiesChanged");
1617 if (signal == NULL) {
1618 error("Unable to allocate new " DBUS_INTERFACE_PROPERTIES
1619 ".PropertiesChanged signal");
1623 iface->pending_prop = g_slist_reverse(iface->pending_prop);
1625 dbus_message_iter_init_append(signal, &iter);
1626 dbus_message_iter_append_basic(&iter, DBUS_TYPE_STRING, &iface->name);
1627 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1628 DBUS_DICT_ENTRY_BEGIN_CHAR_AS_STRING
1629 DBUS_TYPE_STRING_AS_STRING DBUS_TYPE_VARIANT_AS_STRING
1630 DBUS_DICT_ENTRY_END_CHAR_AS_STRING, &dict);
1634 for (l = iface->pending_prop; l != NULL; l = l->next) {
1635 GDBusPropertyTable *p = l->data;
1640 if (p->exists != NULL && !p->exists(p, iface->user_data)) {
1641 invalidated = g_slist_prepend(invalidated, p);
1645 append_property(iface, p, &dict);
1648 dbus_message_iter_close_container(&iter, &dict);
1650 dbus_message_iter_open_container(&iter, DBUS_TYPE_ARRAY,
1651 DBUS_TYPE_STRING_AS_STRING, &array);
1652 for (l = invalidated; l != NULL; l = g_slist_next(l)) {
1653 GDBusPropertyTable *p = l->data;
1655 dbus_message_iter_append_basic(&array, DBUS_TYPE_STRING,
1658 g_slist_free(invalidated);
1659 dbus_message_iter_close_container(&iter, &array);
1661 g_dbus_send_message(data->conn, signal);
1663 g_slist_free(iface->pending_prop);
1664 iface->pending_prop = NULL;
1667 static void process_property_changes(struct generic_data *data)
1671 for (l = data->interfaces; l != NULL; l = l->next) {
1672 struct interface_data *iface = l->data;
1674 process_properties_from_interface(data, iface);
1677 data->pending_prop = FALSE;
1680 void g_dbus_emit_property_changed(DBusConnection *connection,
1681 const char *path, const char *interface,
1684 const GDBusPropertyTable *property;
1685 struct generic_data *data;
1686 struct interface_data *iface;
1688 if (!dbus_connection_get_object_path_data(connection, path,
1689 (void **) &data) || data == NULL)
1692 iface = find_interface(data->interfaces, interface);
1696 property = find_property(iface->properties, name);
1697 if (property == NULL) {
1698 error("Could not find property %s in %p", name,
1703 if (g_slist_find(iface->pending_prop, (void *) property) != NULL)
1706 data->pending_prop = TRUE;
1707 iface->pending_prop = g_slist_prepend(iface->pending_prop,
1710 if (!data->process_id) {
1711 data->process_id = g_idle_add(process_changes, data);
1716 gboolean g_dbus_get_properties(DBusConnection *connection, const char *path,
1717 const char *interface, DBusMessageIter *iter)
1719 struct generic_data *data;
1720 struct interface_data *iface;
1722 if (!dbus_connection_get_object_path_data(connection, path,
1723 (void **) &data) || data == NULL)
1726 iface = find_interface(data->interfaces, interface);
1730 append_properties(iface, iter);
1735 gboolean g_dbus_attach_object_manager(DBusConnection *connection)
1737 struct generic_data *data;
1739 data = object_path_ref(connection, "/");
1743 add_interface(data, DBUS_INTERFACE_OBJECT_MANAGER,
1744 manager_methods, manager_signals,
1751 gboolean g_dbus_detach_object_manager(DBusConnection *connection)
1753 if (!g_dbus_unregister_interface(connection, "/",
1754 DBUS_INTERFACE_OBJECT_MANAGER))
1762 void g_dbus_set_flags(int flags)
1764 global_flags = flags;