1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 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 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 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
27 #include "dbus-common.h"
29 #define BUS_JOB_INTERFACE \
30 " <interface name=\"org.freedesktop.systemd1.Job\">\n" \
31 " <method name=\"Cancel\"/>\n" \
32 " <property name=\"Id\" type=\"u\" access=\"read\"/>\n" \
33 " <property name=\"Unit\" type=\"(so)\" access=\"read\"/>\n" \
34 " <property name=\"JobType\" type=\"s\" access=\"read\"/>\n" \
35 " <property name=\"State\" type=\"s\" access=\"read\"/>\n" \
38 #define INTROSPECTION \
39 DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE \
42 BUS_PROPERTIES_INTERFACE \
44 BUS_INTROSPECTABLE_INTERFACE \
47 const char bus_job_interface[] _introspect_("Job") = BUS_JOB_INTERFACE;
49 #define INTERFACES_LIST \
50 BUS_GENERIC_INTERFACES_LIST \
51 "org.freedesktop.systemd1.Job\0"
53 #define INVALIDATING_PROPERTIES \
56 static DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_job_append_state, job_state, JobState);
57 static DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_job_append_type, job_type, JobType);
59 static int bus_job_append_unit(DBusMessageIter *i, const char *property, void *data) {
68 if (!dbus_message_iter_open_container(i, DBUS_TYPE_STRUCT, NULL, &sub))
71 if (!(p = unit_dbus_path(j->unit)))
74 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &j->unit->meta.id) ||
75 !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
82 if (!dbus_message_iter_close_container(i, &sub))
88 static DBusHandlerResult bus_job_message_dispatch(Job *j, DBusConnection *connection, DBusMessage *message) {
89 const BusProperty properties[] = {
90 { "org.freedesktop.systemd1.Job", "Id", bus_property_append_uint32, "u", &j->id },
91 { "org.freedesktop.systemd1.Job", "State", bus_job_append_state, "s", &j->state },
92 { "org.freedesktop.systemd1.Job", "JobType", bus_job_append_type, "s", &j->type },
93 { "org.freedesktop.systemd1.Job", "Unit", bus_job_append_unit, "(so)", j },
94 { NULL, NULL, NULL, NULL, NULL }
97 DBusMessage *reply = NULL;
99 if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Job", "Cancel")) {
100 if (!(reply = dbus_message_new_method_return(message)))
103 job_finish_and_invalidate(j, JOB_CANCELED);
106 return bus_default_message_handler(connection, message, INTROSPECTION, INTERFACES_LIST, properties);
109 if (!dbus_connection_send(connection, reply, NULL))
112 dbus_message_unref(reply);
115 return DBUS_HANDLER_RESULT_HANDLED;
119 dbus_message_unref(reply);
121 return DBUS_HANDLER_RESULT_NEED_MEMORY;
124 static DBusHandlerResult bus_job_message_handler(DBusConnection *connection, DBusMessage *message, void *data) {
134 if (streq(dbus_message_get_path(message), "/org/freedesktop/systemd1/job")) {
135 /* Be nice to gdbus and return introspection data for our mid-level paths */
137 if (dbus_message_is_method_call(message, "org.freedesktop.DBus.Introspectable", "Introspect")) {
138 char *introspection = NULL;
143 if (!(reply = dbus_message_new_method_return(message)))
146 /* We roll our own introspection code here, instead of
147 * relying on bus_default_message_handler() because we
148 * need to generate our introspection string
151 if (!(f = open_memstream(&introspection, &size)))
154 fputs(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE
157 fputs(BUS_INTROSPECTABLE_INTERFACE, f);
158 fputs(BUS_PEER_INTERFACE, f);
160 HASHMAP_FOREACH(j, m->jobs, i)
161 fprintf(f, "<node name=\"job/%lu\"/>", (unsigned long) j->id);
163 fputs("</node>\n", f);
176 if (!dbus_message_append_args(reply, DBUS_TYPE_STRING, &introspection, DBUS_TYPE_INVALID)) {
183 if (!dbus_connection_send(connection, reply, NULL))
186 dbus_message_unref(reply);
188 return DBUS_HANDLER_RESULT_HANDLED;
191 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
194 if ((r = manager_get_job_from_dbus_path(m, dbus_message_get_path(message), &j)) < 0) {
197 return DBUS_HANDLER_RESULT_NEED_MEMORY;
203 dbus_set_error_const(&e, DBUS_ERROR_UNKNOWN_OBJECT, "Unknown job");
204 return bus_send_error_reply(connection, message, &e, r);
207 return bus_send_error_reply(connection, message, NULL, r);
210 return bus_job_message_dispatch(j, connection, message);
214 dbus_message_unref(reply);
216 return DBUS_HANDLER_RESULT_NEED_MEMORY;
219 const DBusObjectPathVTable bus_job_vtable = {
220 .message_function = bus_job_message_handler
223 static int job_send_message(Job *j, DBusMessage *m) {
229 if (bus_has_subscriber(j->manager)) {
230 if ((r = bus_broadcast(j->manager, m)) < 0)
233 } else if (j->bus_client) {
234 /* If nobody is subscribed, we just send the message
235 * to the client which created the job */
239 if (!dbus_message_set_destination(m, j->bus_client))
242 if (!dbus_connection_send(j->bus, m, NULL))
249 void bus_job_send_change_signal(Job *j) {
251 DBusMessage *m = NULL;
255 if (j->in_dbus_queue) {
256 LIST_REMOVE(Job, dbus_queue, j->manager->dbus_job_queue, j);
257 j->in_dbus_queue = false;
260 if (!bus_has_subscriber(j->manager) && !j->bus_client) {
261 j->sent_dbus_new_signal = true;
265 if (!(p = job_dbus_path(j)))
268 if (j->sent_dbus_new_signal) {
269 /* Send a properties changed signal */
271 if (!(m = bus_properties_changed_new(p, "org.freedesktop.systemd1.Job", INVALIDATING_PROPERTIES)))
275 /* Send a new signal */
277 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "JobNew")))
280 if (!dbus_message_append_args(m,
281 DBUS_TYPE_UINT32, &j->id,
282 DBUS_TYPE_OBJECT_PATH, &p,
287 if (job_send_message(j, m) < 0)
291 dbus_message_unref(m);
293 j->sent_dbus_new_signal = true;
301 dbus_message_unref(m);
303 log_error("Failed to allocate job change signal.");
306 void bus_job_send_removed_signal(Job *j) {
308 DBusMessage *m = NULL;
313 if (!bus_has_subscriber(j->manager) && !j->bus_client)
316 if (!j->sent_dbus_new_signal)
317 bus_job_send_change_signal(j);
319 if (!(p = job_dbus_path(j)))
322 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "JobRemoved")))
325 r = job_result_to_string(j->result);
327 if (!dbus_message_append_args(m,
328 DBUS_TYPE_UINT32, &j->id,
329 DBUS_TYPE_OBJECT_PATH, &p,
330 DBUS_TYPE_STRING, &r,
334 if (job_send_message(j, m) < 0)
338 dbus_message_unref(m);
346 dbus_message_unref(m);
348 log_error("Failed to allocate job remove signal.");