src/core/dbus-job.c

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2
   3 #include "sd-bus.h"
   4
   5 #include "alloc-util.h"
   6 #include "bus-get-properties.h"
   7 #include "bus-util.h"
   8 #include "dbus-job.h"
   9 #include "dbus-unit.h"
  10 #include "dbus-util.h"
  11 #include "dbus.h"
  12 #include "job.h"
  13 #include "log.h"
  14 #include "selinux-access.h"
  15 #include "string-util.h"
  16 #include "strv.h"
  17
  18 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_type, job_type, JobType);
  19 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_state, job_state, JobState);
  20
  21 static int property_get_unit(
  22                 sd_bus *bus,
  23                 const char *path,
  24                 const char *interface,
  25                 const char *property,
  26                 sd_bus_message *reply,
  27                 void *userdata,
  28                 sd_bus_error *error) {
  29
  30         _cleanup_free_ char *p = NULL;
  31         Job *j = ASSERT_PTR(userdata);
  32
  33         assert(bus);
  34         assert(reply);
  35
  36         p = unit_dbus_path(j->unit);
  37         if (!p)
  38                 return -ENOMEM;
  39
  40         return sd_bus_message_append(reply, "(so)", j->unit->id, p);
  41 }
  42
  43 int bus_job_method_cancel(sd_bus_message *message, void *userdata, sd_bus_error *error) {
  44         Job *j = ASSERT_PTR(userdata);
  45         int r;
  46
  47         assert(message);
  48
  49         r = mac_selinux_unit_access_check(j->unit, message, "stop", error);
  50         if (r < 0)
  51                 return r;
  52
  53         /* Access is granted to the job owner */
  54         if (!sd_bus_track_contains(j->bus_track, sd_bus_message_get_sender(message))) {
  55
  56                 /* And for everybody else consult polkit */
  57                 r = bus_verify_manage_units_async(j->unit->manager, message, error);
  58                 if (r < 0)
  59                         return r;
  60                 if (r == 0)
  61                         return 1; /* No authorization for now, but the async polkit stuff will call us again when it has it */
  62         }
  63
  64         job_finish_and_invalidate(j, JOB_CANCELED, true, false);
  65
  66         return sd_bus_reply_method_return(message, NULL);
  67 }
  68
  69 int bus_job_method_get_waiting_jobs(sd_bus_message *message, void *userdata, sd_bus_error *error) {
  70         _cleanup_(sd_bus_message_unrefp) sd_bus_message *reply = NULL;
  71         _cleanup_free_ Job **list = NULL;
  72         Job *j = userdata;
  73         int r, n;
  74
  75         if (strstr(sd_bus_message_get_member(message), "After"))
  76                 n = job_get_after(j, &list);
  77         else
  78                 n = job_get_before(j, &list);
  79         if (n < 0)
  80                 return n;
  81
  82         r = sd_bus_message_new_method_return(message, &reply);
  83         if (r < 0)
  84                 return r;
  85
  86         r = sd_bus_message_open_container(reply, 'a', "(usssoo)");
  87         if (r < 0)
  88                 return r;
  89
  90         for (int i = 0; i < n; i ++) {
  91                 _cleanup_free_ char *unit_path = NULL, *job_path = NULL;
  92
  93                 job_path = job_dbus_path(list[i]);
  94                 if (!job_path)
  95                         return -ENOMEM;
  96
  97                 unit_path = unit_dbus_path(list[i]->unit);
  98                 if (!unit_path)
  99                         return -ENOMEM;
 100
 101                 r = sd_bus_message_append(reply, "(usssoo)",
 102                                           list[i]->id,
 103                                           list[i]->unit->id,
 104                                           job_type_to_string(list[i]->type),
 105                                           job_state_to_string(list[i]->state),
 106                                           job_path,
 107                                           unit_path);
 108                 if (r < 0)
 109                         return r;
 110         }
 111
 112         r = sd_bus_message_close_container(reply);
 113         if (r < 0)
 114                 return r;
 115
 116         return sd_bus_send(NULL, reply, NULL);
 117 }
 118
 119 const sd_bus_vtable bus_job_vtable[] = {
 120         SD_BUS_VTABLE_START(0),
 121
 122         SD_BUS_METHOD("Cancel", NULL, NULL, bus_job_method_cancel, SD_BUS_VTABLE_UNPRIVILEGED),
 123         SD_BUS_METHOD_WITH_ARGS("GetAfter",
 124                                  SD_BUS_NO_ARGS,
 125                                  SD_BUS_RESULT("a(usssoo)", jobs),
 126                                  bus_job_method_get_waiting_jobs,
 127                                  SD_BUS_VTABLE_UNPRIVILEGED),
 128         SD_BUS_METHOD_WITH_ARGS("GetBefore",
 129                                  SD_BUS_NO_ARGS,
 130                                  SD_BUS_RESULT("a(usssoo)", jobs),
 131                                  bus_job_method_get_waiting_jobs,
 132                                  SD_BUS_VTABLE_UNPRIVILEGED),
 133
 134         SD_BUS_PROPERTY("Id", "u", NULL, offsetof(Job, id), SD_BUS_VTABLE_PROPERTY_CONST),
 135         SD_BUS_PROPERTY("Unit", "(so)", property_get_unit, 0, SD_BUS_VTABLE_PROPERTY_CONST),
 136         SD_BUS_PROPERTY("JobType", "s", property_get_type, offsetof(Job, type), SD_BUS_VTABLE_PROPERTY_CONST),
 137         SD_BUS_PROPERTY("State", "s", property_get_state, offsetof(Job, state), SD_BUS_VTABLE_PROPERTY_EMITS_CHANGE),
 138         SD_BUS_PROPERTY("ActivationDetails", "a(ss)", bus_property_get_activation_details, offsetof(Job, activation_details), SD_BUS_VTABLE_PROPERTY_CONST),
 139         SD_BUS_VTABLE_END
 140 };
 141
 142 static int bus_job_find(sd_bus *bus, const char *path, const char *interface, void *userdata, void **found, sd_bus_error *error) {
 143         Manager *m = ASSERT_PTR(userdata);
 144         Job *j;
 145         int r;
 146
 147         assert(bus);
 148         assert(path);
 149         assert(interface);
 150         assert(found);
 151
 152         r = manager_get_job_from_dbus_path(m, path, &j);
 153         if (r < 0)
 154                 return 0;
 155
 156         *found = j;
 157         return 1;
 158 }
 159
 160 static int bus_job_enumerate(sd_bus *bus, const char *path, void *userdata, char ***nodes, sd_bus_error *error) {
 161         _cleanup_strv_free_ char **l = NULL;
 162         Manager *m = userdata;
 163         unsigned k = 0;
 164         Job *j;
 165
 166         l = new0(char*, hashmap_size(m->jobs)+1);
 167         if (!l)
 168                 return -ENOMEM;
 169
 170         HASHMAP_FOREACH(j, m->jobs) {
 171                 l[k] = job_dbus_path(j);
 172                 if (!l[k])
 173                         return -ENOMEM;
 174
 175                 k++;
 176         }
 177
 178         assert(hashmap_size(m->jobs) == k);
 179
 180         *nodes = TAKE_PTR(l);
 181
 182         return k;
 183 }
 184
 185 const BusObjectImplementation job_object = {
 186         "/org/freedesktop/systemd1/job",
 187         "org.freedesktop.systemd1.Job",
 188         .fallback_vtables = BUS_FALLBACK_VTABLES({bus_job_vtable, bus_job_find}),
 189         .node_enumerator = bus_job_enumerate,
 190 };
 191
 192 static int send_new_signal(sd_bus *bus, void *userdata) {
 193         _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
 194         _cleanup_free_ char *p = NULL;
 195         Job *j = ASSERT_PTR(userdata);
 196         int r;
 197
 198         assert(bus);
 199
 200         p = job_dbus_path(j);
 201         if (!p)
 202                 return -ENOMEM;
 203
 204         r = sd_bus_message_new_signal(
 205                         bus,
 206                         &m,
 207                         "/org/freedesktop/systemd1",
 208                         "org.freedesktop.systemd1.Manager",
 209                         "JobNew");
 210         if (r < 0)
 211                 return r;
 212
 213         r = sd_bus_message_append(m, "uos", j->id, p, j->unit->id);
 214         if (r < 0)
 215                 return r;
 216
 217         return sd_bus_send(bus, m, NULL);
 218 }
 219
 220 static int send_changed_signal(sd_bus *bus, void *userdata) {
 221         _cleanup_free_ char *p = NULL;
 222         Job *j = ASSERT_PTR(userdata);
 223
 224         assert(bus);
 225
 226         p = job_dbus_path(j);
 227         if (!p)
 228                 return -ENOMEM;
 229
 230         return sd_bus_emit_properties_changed(bus, p, "org.freedesktop.systemd1.Job", "State", NULL);
 231 }
 232
 233 void bus_job_send_change_signal(Job *j) {
 234         int r;
 235
 236         assert(j);
 237
 238         /* Make sure that any change signal on the unit is reflected before we send out the change signal on the job */
 239         bus_unit_send_pending_change_signal(j->unit, true);
 240
 241         if (j->in_dbus_queue) {
 242                 LIST_REMOVE(dbus_queue, j->manager->dbus_job_queue, j);
 243                 j->in_dbus_queue = false;
 244
 245                 /* The job might be good to be GC once its pending signals have been sent */
 246                 job_add_to_gc_queue(j);
 247         }
 248
 249         r = bus_foreach_bus(j->manager, j->bus_track, j->sent_dbus_new_signal ? send_changed_signal : send_new_signal, j);
 250         if (r < 0)
 251                 log_debug_errno(r, "Failed to send job change signal for %u: %m", j->id);
 252
 253         j->sent_dbus_new_signal = true;
 254 }
 255
 256 void bus_job_send_pending_change_signal(Job *j, bool including_new) {
 257         assert(j);
 258
 259         if (!j->in_dbus_queue)
 260                 return;
 261
 262         if (!j->sent_dbus_new_signal && !including_new)
 263                 return;
 264
 265         if (MANAGER_IS_RELOADING(j->unit->manager))
 266                 return;
 267
 268         bus_job_send_change_signal(j);
 269 }
 270
 271 static int send_removed_signal(sd_bus *bus, void *userdata) {
 272         _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL;
 273         _cleanup_free_ char *p = NULL;
 274         Job *j = ASSERT_PTR(userdata);
 275         int r;
 276
 277         assert(bus);
 278
 279         p = job_dbus_path(j);
 280         if (!p)
 281                 return -ENOMEM;
 282
 283         r = sd_bus_message_new_signal(
 284                         bus,
 285                         &m,
 286                         "/org/freedesktop/systemd1",
 287                         "org.freedesktop.systemd1.Manager",
 288                         "JobRemoved");
 289         if (r < 0)
 290                 return r;
 291
 292         r = sd_bus_message_append(m, "uoss", j->id, p, j->unit->id, job_result_to_string(j->result));
 293         if (r < 0)
 294                 return r;
 295
 296         return sd_bus_send(bus, m, NULL);
 297 }
 298
 299 void bus_job_send_removed_signal(Job *j) {
 300         int r;
 301
 302         assert(j);
 303
 304         if (!j->sent_dbus_new_signal)
 305                 bus_job_send_change_signal(j);
 306
 307         /* Make sure that any change signal on the unit is reflected before we send out the change signal on the job */
 308         bus_unit_send_pending_change_signal(j->unit, true);
 309
 310         r = bus_foreach_bus(j->manager, j->bus_track, send_removed_signal, j);
 311         if (r < 0)
 312                 log_debug_errno(r, "Failed to send job remove signal for %u: %m", j->id);
 313 }
 314
 315 static int bus_job_track_handler(sd_bus_track *t, void *userdata) {
 316         Job *j = ASSERT_PTR(userdata);
 317
 318         assert(t);
 319
 320         j->bus_track = sd_bus_track_unref(j->bus_track); /* make sure we aren't called again */
 321
 322         /* Last client dropped off the bus, maybe we should GC this now? */
 323         job_add_to_gc_queue(j);
 324         return 0;
 325 }
 326
 327 static int bus_job_allocate_bus_track(Job *j) {
 328
 329         assert(j);
 330
 331         if (j->bus_track)
 332                 return 0;
 333
 334         return sd_bus_track_new(j->unit->manager->api_bus, &j->bus_track, bus_job_track_handler, j);
 335 }
 336
 337 int bus_job_coldplug_bus_track(Job *j) {
 338         int r;
 339         _cleanup_strv_free_ char **deserialized_clients = NULL;
 340
 341         assert(j);
 342
 343         deserialized_clients = TAKE_PTR(j->deserialized_clients);
 344
 345         if (strv_isempty(deserialized_clients))
 346                 return 0;
 347
 348         if (!j->manager->api_bus)
 349                 return 0;
 350
 351         r = bus_job_allocate_bus_track(j);
 352         if (r < 0)
 353                 return r;
 354
 355         return bus_track_add_name_many(j->bus_track, deserialized_clients);
 356 }
 357
 358 int bus_job_track_sender(Job *j, sd_bus_message *m) {
 359         int r;
 360
 361         assert(j);
 362         assert(m);
 363
 364         if (sd_bus_message_get_bus(m) != j->unit->manager->api_bus) {
 365                 j->ref_by_private_bus = true;
 366                 return 0;
 367         }
 368
 369         r = bus_job_allocate_bus_track(j);
 370         if (r < 0)
 371                 return r;
 372
 373         return sd_bus_track_add_sender(j->bus_track, m);
 374 }