1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2013 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU Lesser General Public License as published by
10 the Free Software Foundation; either version 2.1 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Lesser General Public License for more details.
18 You should have received a copy of the GNU Lesser General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 #include "bus-internal.h"
23 #include "bus-introspect.h"
24 #include "bus-protocol.h"
25 #include "bus-signature.h"
28 #include "string-util.h"
31 int introspect_begin(struct introspect *i, bool trusted) {
37 i->f = open_memstream(&i->introspection, &i->size);
41 fputs(BUS_INTROSPECT_DOCTYPE
47 int introspect_write_default_interfaces(struct introspect *i, bool object_manager) {
50 fputs(BUS_INTROSPECT_INTERFACE_PEER
51 BUS_INTROSPECT_INTERFACE_INTROSPECTABLE
52 BUS_INTROSPECT_INTERFACE_PROPERTIES, i->f);
55 fputs(BUS_INTROSPECT_INTERFACE_OBJECT_MANAGER, i->f);
60 int introspect_write_child_nodes(struct introspect *i, Set *s, const char *prefix) {
66 while ((node = set_steal_first(s))) {
69 e = object_path_startswith(node, prefix);
71 fprintf(i->f, " <node name=\"%s\"/>\n", e);
79 static void introspect_write_flags(struct introspect *i, int type, int flags) {
80 if (flags & SD_BUS_VTABLE_DEPRECATED)
81 fputs(" <annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n", i->f);
83 if (type == _SD_BUS_VTABLE_METHOD && (flags & SD_BUS_VTABLE_METHOD_NO_REPLY))
84 fputs(" <annotation name=\"org.freedesktop.DBus.Method.NoReply\" value=\"true\"/>\n", i->f);
86 if (type == _SD_BUS_VTABLE_PROPERTY || type == _SD_BUS_VTABLE_WRITABLE_PROPERTY) {
87 if (flags & SD_BUS_VTABLE_PROPERTY_EXPLICIT)
88 fputs(" <annotation name=\"org.freedesktop.systemd1.Explicit\" value=\"true\"/>\n", i->f);
90 if (flags & SD_BUS_VTABLE_PROPERTY_CONST)
91 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"const\"/>\n", i->f);
92 else if (flags & SD_BUS_VTABLE_PROPERTY_EMITS_INVALIDATION)
93 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"invalidates\"/>\n", i->f);
94 else if (!(flags & SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE))
95 fputs(" <annotation name=\"org.freedesktop.DBus.Property.EmitsChangedSignal\" value=\"false\"/>\n", i->f);
99 (type == _SD_BUS_VTABLE_METHOD || type == _SD_BUS_VTABLE_WRITABLE_PROPERTY) &&
100 !(flags & SD_BUS_VTABLE_UNPRIVILEGED))
101 fputs(" <annotation name=\"org.freedesktop.systemd1.Privileged\" value=\"true\"/>\n", i->f);
104 static int introspect_write_arguments(struct introspect *i, const char *signature, const char *direction) {
113 r = signature_element_length(signature, &l);
117 fprintf(i->f, " <arg type=\"%.*s\"", (int) l, signature);
120 fprintf(i->f, " direction=\"%s\"/>\n", direction);
128 int introspect_write_interface(struct introspect *i, const sd_bus_vtable *v) {
132 for (; v->type != _SD_BUS_VTABLE_END; v++) {
134 /* Ignore methods, signals and properties that are
135 * marked "hidden", but do show the interface
138 if (v->type != _SD_BUS_VTABLE_START && (v->flags & SD_BUS_VTABLE_HIDDEN))
143 case _SD_BUS_VTABLE_START:
144 if (v->flags & SD_BUS_VTABLE_DEPRECATED)
145 fputs(" <annotation name=\"org.freedesktop.DBus.Deprecated\" value=\"true\"/>\n", i->f);
148 case _SD_BUS_VTABLE_METHOD:
149 fprintf(i->f, " <method name=\"%s\">\n", v->x.method.member);
150 introspect_write_arguments(i, strempty(v->x.method.signature), "in");
151 introspect_write_arguments(i, strempty(v->x.method.result), "out");
152 introspect_write_flags(i, v->type, v->flags);
153 fputs(" </method>\n", i->f);
156 case _SD_BUS_VTABLE_PROPERTY:
157 case _SD_BUS_VTABLE_WRITABLE_PROPERTY:
158 fprintf(i->f, " <property name=\"%s\" type=\"%s\" access=\"%s\">\n",
159 v->x.property.member,
160 v->x.property.signature,
161 v->type == _SD_BUS_VTABLE_WRITABLE_PROPERTY ? "readwrite" : "read");
162 introspect_write_flags(i, v->type, v->flags);
163 fputs(" </property>\n", i->f);
166 case _SD_BUS_VTABLE_SIGNAL:
167 fprintf(i->f, " <signal name=\"%s\">\n", v->x.signal.member);
168 introspect_write_arguments(i, strempty(v->x.signal.signature), NULL);
169 introspect_write_flags(i, v->type, v->flags);
170 fputs(" </signal>\n", i->f);
179 int introspect_finish(struct introspect *i, sd_bus *bus, sd_bus_message *m, sd_bus_message **reply) {
187 fputs("</node>\n", i->f);
189 r = fflush_and_check(i->f);
193 r = sd_bus_message_new_method_return(m, &q);
197 r = sd_bus_message_append(q, "s", i->introspection);
199 sd_bus_message_unref(q);
207 void introspect_free(struct introspect *i) {
212 free(i->introspection);