chiark / gitweb /
shutdown: accept minutes argument without '+'
[elogind.git] / src / dbus-unit.c
1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
2
3 /***
4   This file is part of systemd.
5
6   Copyright 2010 Lennart Poettering
7
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.
12
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.
17
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/>.
20 ***/
21
22 #include <errno.h>
23
24 #include "dbus.h"
25 #include "log.h"
26 #include "dbus-unit.h"
27 #include "bus-errors.h"
28 #include "dbus-common.h"
29
30 const char bus_unit_interface[] _introspect_("Unit") = BUS_UNIT_INTERFACE;
31
32 #define INVALIDATING_PROPERTIES                 \
33         "LoadState\0"                           \
34         "ActiveState\0"                         \
35         "SubState\0"                            \
36         "InactiveExitTimestamp\0"               \
37         "ActiveEnterTimestamp\0"                \
38         "ActiveExitTimestamp\0"                 \
39         "InactiveEnterTimestamp\0"              \
40         "Job\0"                                 \
41         "NeedDaemonReload\0"
42
43 int bus_unit_append_names(DBusMessageIter *i, const char *property, void *data) {
44         char *t;
45         Iterator j;
46         DBusMessageIter sub;
47         Unit *u = data;
48
49         if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
50                 return -ENOMEM;
51
52         SET_FOREACH(t, u->meta.names, j)
53                 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &t))
54                         return -ENOMEM;
55
56         if (!dbus_message_iter_close_container(i, &sub))
57                 return -ENOMEM;
58
59         return 0;
60 }
61
62 int bus_unit_append_following(DBusMessageIter *i, const char *property, void *data) {
63         Unit *u = data, *f;
64         const char *d;
65
66         assert(i);
67         assert(property);
68         assert(u);
69
70         f = unit_following(u);
71         d = f ? f->meta.id : "";
72
73         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &d))
74                 return -ENOMEM;
75
76         return 0;
77 }
78
79 int bus_unit_append_dependencies(DBusMessageIter *i, const char *property, void *data) {
80         Unit *u;
81         Iterator j;
82         DBusMessageIter sub;
83         Set *s = data;
84
85         if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
86                 return -ENOMEM;
87
88         SET_FOREACH(u, s, j)
89                 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &u->meta.id))
90                         return -ENOMEM;
91
92         if (!dbus_message_iter_close_container(i, &sub))
93                 return -ENOMEM;
94
95         return 0;
96 }
97
98 int bus_unit_append_description(DBusMessageIter *i, const char *property, void *data) {
99         Unit *u = data;
100         const char *d;
101
102         assert(i);
103         assert(property);
104         assert(u);
105
106         d = unit_description(u);
107
108         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &d))
109                 return -ENOMEM;
110
111         return 0;
112 }
113
114 DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_unit_append_load_state, unit_load_state, UnitLoadState);
115
116 int bus_unit_append_active_state(DBusMessageIter *i, const char *property, void *data) {
117         Unit *u = data;
118         const char *state;
119
120         assert(i);
121         assert(property);
122         assert(u);
123
124         state = unit_active_state_to_string(unit_active_state(u));
125
126         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &state))
127                 return -ENOMEM;
128
129         return 0;
130 }
131
132 int bus_unit_append_sub_state(DBusMessageIter *i, const char *property, void *data) {
133         Unit *u = data;
134         const char *state;
135
136         assert(i);
137         assert(property);
138         assert(u);
139
140         state = unit_sub_state_to_string(u);
141
142         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &state))
143                 return -ENOMEM;
144
145         return 0;
146 }
147
148 int bus_unit_append_can_start(DBusMessageIter *i, const char *property, void *data) {
149         Unit *u = data;
150         dbus_bool_t b;
151
152         assert(i);
153         assert(property);
154         assert(u);
155
156         b = unit_can_start(u) &&
157                 !u->meta.refuse_manual_start;
158
159         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
160                 return -ENOMEM;
161
162         return 0;
163 }
164
165 int bus_unit_append_can_stop(DBusMessageIter *i, const char *property, void *data) {
166         Unit *u = data;
167         dbus_bool_t b;
168
169         assert(i);
170         assert(property);
171         assert(u);
172
173         /* On the lower levels we assume that every unit we can start
174          * we can also stop */
175
176         b = unit_can_start(u) &&
177                 !u->meta.refuse_manual_stop;
178
179         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
180                 return -ENOMEM;
181
182         return 0;
183 }
184
185 int bus_unit_append_can_reload(DBusMessageIter *i, const char *property, void *data) {
186         Unit *u = data;
187         dbus_bool_t b;
188
189         assert(i);
190         assert(property);
191         assert(u);
192
193         b = unit_can_reload(u);
194
195         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
196                 return -ENOMEM;
197
198         return 0;
199 }
200
201 int bus_unit_append_can_isolate(DBusMessageIter *i, const char *property, void *data) {
202         Unit *u = data;
203         dbus_bool_t b;
204
205         assert(i);
206         assert(property);
207         assert(u);
208
209         b = unit_can_isolate(u) &&
210                 !u->meta.refuse_manual_start;
211
212         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
213                 return -ENOMEM;
214
215         return 0;
216 }
217
218 int bus_unit_append_job(DBusMessageIter *i, const char *property, void *data) {
219         Unit *u = data;
220         DBusMessageIter sub;
221         char *p;
222
223         assert(i);
224         assert(property);
225         assert(u);
226
227         if (!dbus_message_iter_open_container(i, DBUS_TYPE_STRUCT, NULL, &sub))
228                 return -ENOMEM;
229
230         if (u->meta.job) {
231
232                 if (!(p = job_dbus_path(u->meta.job)))
233                         return -ENOMEM;
234
235                 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_UINT32, &u->meta.job->id) ||
236                     !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
237                         free(p);
238                         return -ENOMEM;
239                 }
240         } else {
241                 uint32_t id = 0;
242
243                 /* No job, so let's fill in some placeholder
244                  * data. Since we need to fill in a valid path we
245                  * simple point to ourselves. */
246
247                 if (!(p = unit_dbus_path(u)))
248                         return -ENOMEM;
249
250                 if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_UINT32, &id) ||
251                     !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
252                         free(p);
253                         return -ENOMEM;
254                 }
255         }
256
257         free(p);
258
259         if (!dbus_message_iter_close_container(i, &sub))
260                 return -ENOMEM;
261
262         return 0;
263 }
264
265 int bus_unit_append_default_cgroup(DBusMessageIter *i, const char *property, void *data) {
266         Unit *u = data;
267         char *t;
268         CGroupBonding *cgb;
269         bool success;
270
271         assert(i);
272         assert(property);
273         assert(u);
274
275         if ((cgb = unit_get_default_cgroup(u))) {
276                 if (!(t = cgroup_bonding_to_string(cgb)))
277                         return -ENOMEM;
278         } else
279                 t = (char*) "";
280
281         success = dbus_message_iter_append_basic(i, DBUS_TYPE_STRING, &t);
282
283         if (cgb)
284                 free(t);
285
286         return success ? 0 : -ENOMEM;
287 }
288
289 int bus_unit_append_cgroups(DBusMessageIter *i, const char *property, void *data) {
290         Unit *u = data;
291         CGroupBonding *cgb;
292         DBusMessageIter sub;
293
294         if (!dbus_message_iter_open_container(i, DBUS_TYPE_ARRAY, "s", &sub))
295                 return -ENOMEM;
296
297         LIST_FOREACH(by_unit, cgb, u->meta.cgroup_bondings) {
298                 char *t;
299                 bool success;
300
301                 if (!(t = cgroup_bonding_to_string(cgb)))
302                         return -ENOMEM;
303
304                 success = dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &t);
305                 free(t);
306
307                 if (!success)
308                         return -ENOMEM;
309         }
310
311         if (!dbus_message_iter_close_container(i, &sub))
312                 return -ENOMEM;
313
314         return 0;
315 }
316
317 int bus_unit_append_need_daemon_reload(DBusMessageIter *i, const char *property, void *data) {
318         Unit *u = data;
319         dbus_bool_t b;
320
321         assert(i);
322         assert(property);
323         assert(u);
324
325         b = unit_need_daemon_reload(u);
326
327         if (!dbus_message_iter_append_basic(i, DBUS_TYPE_BOOLEAN, &b))
328                 return -ENOMEM;
329
330         return 0;
331 }
332
333 static DBusHandlerResult bus_unit_message_dispatch(Unit *u, DBusConnection *connection, DBusMessage *message) {
334         DBusMessage *reply = NULL;
335         Manager *m = u->meta.manager;
336         DBusError error;
337         JobType job_type = _JOB_TYPE_INVALID;
338         char *path = NULL;
339         bool reload_if_possible = false;
340
341         dbus_error_init(&error);
342
343         if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Start"))
344                 job_type = JOB_START;
345         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Stop"))
346                 job_type = JOB_STOP;
347         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Reload"))
348                 job_type = JOB_RELOAD;
349         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Restart"))
350                 job_type = JOB_RESTART;
351         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "TryRestart"))
352                 job_type = JOB_TRY_RESTART;
353         else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ReloadOrRestart")) {
354                 reload_if_possible = true;
355                 job_type = JOB_RESTART;
356         } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ReloadOrTryRestart")) {
357                 reload_if_possible = true;
358                 job_type = JOB_TRY_RESTART;
359         } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "Kill")) {
360                 const char *swho, *smode;
361                 int32_t signo;
362                 KillMode mode;
363                 KillWho who;
364                 int r;
365
366                 if (!dbus_message_get_args(
367                                     message,
368                                     &error,
369                                     DBUS_TYPE_STRING, &swho,
370                                     DBUS_TYPE_STRING, &smode,
371                                     DBUS_TYPE_INT32, &signo,
372                                     DBUS_TYPE_INVALID))
373                         return bus_send_error_reply(connection, message, &error, -EINVAL);
374
375                 if ((mode = kill_mode_from_string(smode)) < 0 ||
376                     (who = kill_who_from_string(swho)) < 0 ||
377                     signo <= 0 ||
378                     signo >= _NSIG)
379                         return bus_send_error_reply(connection, message, &error, -EINVAL);
380
381                 if ((r = unit_kill(u, who, mode, signo, &error)) < 0)
382                         return bus_send_error_reply(connection, message, &error, r);
383
384                 if (!(reply = dbus_message_new_method_return(message)))
385                         goto oom;
386
387         } else if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Unit", "ResetFailed")) {
388
389                 unit_reset_failed(u);
390
391                 if (!(reply = dbus_message_new_method_return(message)))
392                         goto oom;
393
394         } else if (UNIT_VTABLE(u)->bus_message_handler)
395                 return UNIT_VTABLE(u)->bus_message_handler(u, connection, message);
396         else
397                 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
398
399         if (job_type != _JOB_TYPE_INVALID) {
400                 const char *smode;
401                 JobMode mode;
402                 Job *j;
403                 int r;
404
405                 if ((job_type == JOB_START && u->meta.refuse_manual_start) ||
406                     (job_type == JOB_STOP && u->meta.refuse_manual_stop) ||
407                     ((job_type == JOB_RESTART || job_type == JOB_TRY_RESTART) &&
408                      (u->meta.refuse_manual_start || u->meta.refuse_manual_stop))) {
409                         dbus_set_error(&error, BUS_ERROR_ONLY_BY_DEPENDENCY, "Operation refused, may be requested by dependency only.");
410                         return bus_send_error_reply(connection, message, &error, -EPERM);
411                 }
412
413                 if (!dbus_message_get_args(
414                                     message,
415                                     &error,
416                                     DBUS_TYPE_STRING, &smode,
417                                     DBUS_TYPE_INVALID))
418                         return bus_send_error_reply(connection, message, &error, -EINVAL);
419
420                 if (reload_if_possible && unit_can_reload(u)) {
421                         if (job_type == JOB_RESTART)
422                                 job_type = JOB_RELOAD_OR_START;
423                         else if (job_type == JOB_TRY_RESTART)
424                                 job_type = JOB_RELOAD;
425                 }
426
427                 if ((mode = job_mode_from_string(smode)) == _JOB_MODE_INVALID) {
428                         dbus_set_error(&error, BUS_ERROR_INVALID_JOB_MODE, "Job mode %s is invalid.", smode);
429                         return bus_send_error_reply(connection, message, &error, -EINVAL);
430                 }
431
432                 if ((r = manager_add_job(m, job_type, u, mode, true, &error, &j)) < 0)
433                         return bus_send_error_reply(connection, message, &error, r);
434
435                 if (!(reply = dbus_message_new_method_return(message)))
436                         goto oom;
437
438                 if (!(path = job_dbus_path(j)))
439                         goto oom;
440
441                 if (!dbus_message_append_args(
442                                     reply,
443                                     DBUS_TYPE_OBJECT_PATH, &path,
444                                     DBUS_TYPE_INVALID))
445                         goto oom;
446         }
447
448         if (reply) {
449                 if (!dbus_connection_send(connection, reply, NULL))
450                         goto oom;
451
452                 dbus_message_unref(reply);
453         }
454
455         free(path);
456
457         return DBUS_HANDLER_RESULT_HANDLED;
458
459 oom:
460         free(path);
461
462         if (reply)
463                 dbus_message_unref(reply);
464
465         dbus_error_free(&error);
466
467         return DBUS_HANDLER_RESULT_NEED_MEMORY;
468 }
469
470 static DBusHandlerResult bus_unit_message_handler(DBusConnection *connection, DBusMessage  *message, void *data) {
471         Manager *m = data;
472         Unit *u;
473         int r;
474         DBusMessage *reply;
475
476         assert(connection);
477         assert(message);
478         assert(m);
479
480         if (streq(dbus_message_get_path(message), "/org/freedesktop/systemd1/unit")) {
481                 /* Be nice to gdbus and return introspection data for our mid-level paths */
482
483                 if (dbus_message_is_method_call(message, "org.freedesktop.DBus.Introspectable", "Introspect")) {
484                         char *introspection = NULL;
485                         FILE *f;
486                         Iterator i;
487                         const char *k;
488                         size_t size;
489
490                         if (!(reply = dbus_message_new_method_return(message)))
491                                 goto oom;
492
493                         /* We roll our own introspection code here, instead of
494                          * relying on bus_default_message_handler() because we
495                          * need to generate our introspection string
496                          * dynamically. */
497
498                         if (!(f = open_memstream(&introspection, &size)))
499                                 goto oom;
500
501                         fputs(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE
502                               "<node>\n", f);
503
504                         fputs(BUS_INTROSPECTABLE_INTERFACE, f);
505                         fputs(BUS_PEER_INTERFACE, f);
506
507                         HASHMAP_FOREACH_KEY(u, k, m->units, i) {
508                                 char *p;
509
510                                 if (k != u->meta.id)
511                                         continue;
512
513                                 if (!(p = bus_path_escape(k))) {
514                                         fclose(f);
515                                         free(introspection);
516                                         goto oom;
517                                 }
518
519                                 fprintf(f, "<node name=\"%s\"/>", p);
520                                 free(p);
521                         }
522
523                         fputs("</node>\n", f);
524
525                         if (ferror(f)) {
526                                 fclose(f);
527                                 free(introspection);
528                                 goto oom;
529                         }
530
531                         fclose(f);
532
533                         if (!introspection)
534                                 goto oom;
535
536                         if (!dbus_message_append_args(reply, DBUS_TYPE_STRING, &introspection, DBUS_TYPE_INVALID)) {
537                                 free(introspection);
538                                 goto oom;
539                         }
540
541                         free(introspection);
542
543                         if (!dbus_connection_send(connection, reply, NULL))
544                                 goto oom;
545
546                         dbus_message_unref(reply);
547
548                         return DBUS_HANDLER_RESULT_HANDLED;
549                 }
550
551                 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
552         }
553
554         if ((r = manager_get_unit_from_dbus_path(m, dbus_message_get_path(message), &u)) < 0) {
555
556                 if (r == -ENOMEM)
557                         return DBUS_HANDLER_RESULT_NEED_MEMORY;
558
559                 if (r == -ENOENT) {
560                         DBusError e;
561
562                         dbus_error_init(&e);
563                         dbus_set_error_const(&e, DBUS_ERROR_UNKNOWN_OBJECT, "Unknown unit");
564                         return bus_send_error_reply(connection, message, &e, r);
565                 }
566
567                 return bus_send_error_reply(connection, message, NULL, r);
568         }
569
570         return bus_unit_message_dispatch(u, connection, message);
571
572 oom:
573         if (reply)
574                 dbus_message_unref(reply);
575
576         return DBUS_HANDLER_RESULT_NEED_MEMORY;
577 }
578
579 const DBusObjectPathVTable bus_unit_vtable = {
580         .message_function = bus_unit_message_handler
581 };
582
583 void bus_unit_send_change_signal(Unit *u) {
584         char *p = NULL;
585         DBusMessage *m = NULL;
586
587         assert(u);
588
589         if (u->meta.in_dbus_queue) {
590                 LIST_REMOVE(Meta, dbus_queue, u->meta.manager->dbus_unit_queue, &u->meta);
591                 u->meta.in_dbus_queue = false;
592         }
593
594         if (!u->meta.id)
595                 return;
596
597         if (!bus_has_subscriber(u->meta.manager)) {
598                 u->meta.sent_dbus_new_signal = true;
599                 return;
600         }
601
602         if (!(p = unit_dbus_path(u)))
603                 goto oom;
604
605         if (u->meta.sent_dbus_new_signal) {
606                 /* Send a properties changed signal. First for the
607                  * specific type, then for the generic unit. The
608                  * clients may rely on this order to get atomic
609                  * behaviour if needed. */
610
611                 if (UNIT_VTABLE(u)->bus_invalidating_properties) {
612
613                         if (!(m = bus_properties_changed_new(p,
614                                                              UNIT_VTABLE(u)->bus_interface,
615                                                              UNIT_VTABLE(u)->bus_invalidating_properties)))
616                                 goto oom;
617
618                         if (bus_broadcast(u->meta.manager, m) < 0)
619                                 goto oom;
620
621                         dbus_message_unref(m);
622                 }
623
624                 if (!(m = bus_properties_changed_new(p, "org.freedesktop.systemd1.Unit", INVALIDATING_PROPERTIES)))
625                         goto oom;
626
627         } else {
628                 /* Send a new signal */
629
630                 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitNew")))
631                         goto oom;
632
633                 if (!dbus_message_append_args(m,
634                                               DBUS_TYPE_STRING, &u->meta.id,
635                                               DBUS_TYPE_OBJECT_PATH, &p,
636                                               DBUS_TYPE_INVALID))
637                         goto oom;
638         }
639
640         if (bus_broadcast(u->meta.manager, m) < 0)
641                 goto oom;
642
643         free(p);
644         dbus_message_unref(m);
645
646         u->meta.sent_dbus_new_signal = true;
647
648         return;
649
650 oom:
651         free(p);
652
653         if (m)
654                 dbus_message_unref(m);
655
656         log_error("Failed to allocate unit change/new signal.");
657 }
658
659 void bus_unit_send_removed_signal(Unit *u) {
660         char *p = NULL;
661         DBusMessage *m = NULL;
662
663         assert(u);
664
665         if (!bus_has_subscriber(u->meta.manager))
666                 return;
667
668         if (!u->meta.sent_dbus_new_signal)
669                 bus_unit_send_change_signal(u);
670
671         if (!u->meta.id)
672                 return;
673
674         if (!(p = unit_dbus_path(u)))
675                 goto oom;
676
677         if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "UnitRemoved")))
678                 goto oom;
679
680         if (!dbus_message_append_args(m,
681                                       DBUS_TYPE_STRING, &u->meta.id,
682                                       DBUS_TYPE_OBJECT_PATH, &p,
683                                       DBUS_TYPE_INVALID))
684                 goto oom;
685
686         if (bus_broadcast(u->meta.manager, m) < 0)
687                 goto oom;
688
689         free(p);
690         dbus_message_unref(m);
691
692         return;
693
694 oom:
695         free(p);
696
697         if (m)
698                 dbus_message_unref(m);
699
700         log_error("Failed to allocate unit remove signal.");
701 }