src/dbus-job.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-job.h"
  27
  28 #define BUS_JOB_INTERFACE                                             \
  29         " <interface name=\"org.freedesktop.systemd1.Job\">\n"        \
  30         "  <method name=\"Cancel\"/>\n"                               \
  31         "  <property name=\"Id\" type=\"u\" access=\"read\"/>\n"      \
  32         "  <property name=\"Unit\" type=\"(so)\" access=\"read\"/>\n" \
  33         "  <property name=\"JobType\" type=\"s\" access=\"read\"/>\n" \
  34         "  <property name=\"State\" type=\"s\" access=\"read\"/>\n"   \
  35         " </interface>\n"
  36
  37 #define INTROSPECTION                                                 \
  38         DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE                     \
  39         "<node>\n"                                                    \
  40         BUS_JOB_INTERFACE                                             \
  41         BUS_PROPERTIES_INTERFACE                                      \
  42         BUS_PEER_INTERFACE                                            \
  43         BUS_INTROSPECTABLE_INTERFACE                                  \
  44         "</node>\n"
  45
  46 const char bus_job_interface[] = BUS_JOB_INTERFACE;
  47
  48 #define INVALIDATING_PROPERTIES                 \
  49         "State\0"                               \
  50         "\0"                                    \
  51
  52 static DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_job_append_state, job_state, JobState);
  53 static DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_job_append_type, job_type, JobType);
  54
  55 static int bus_job_append_unit(Manager *m, DBusMessageIter *i, const char *property, void *data) {
  56         Job *j = data;
  57         DBusMessageIter sub;
  58         char *p;
  59
  60         assert(m);
  61         assert(i);
  62         assert(property);
  63         assert(j);
  64
  65         if (!dbus_message_iter_open_container(i, DBUS_TYPE_STRUCT, NULL, &sub))
  66                 return -ENOMEM;
  67
  68         if (!(p = unit_dbus_path(j->unit)))
  69                 return -ENOMEM;
  70
  71         if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &j->unit->meta.id) ||
  72             !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
  73                 free(p);
  74                 return -ENOMEM;
  75         }
  76
  77         free(p);
  78
  79         if (!dbus_message_iter_close_container(i, &sub))
  80                 return -ENOMEM;
  81
  82         return 0;
  83 }
  84
  85 static DBusHandlerResult bus_job_message_dispatch(Job *j, DBusConnection *connection, DBusMessage *message) {
  86         const BusProperty properties[] = {
  87                 { "org.freedesktop.systemd1.Job", "Id",      bus_property_append_uint32, "u",    &j->id    },
  88                 { "org.freedesktop.systemd1.Job", "State",   bus_job_append_state,       "s",    &j->state },
  89                 { "org.freedesktop.systemd1.Job", "JobType", bus_job_append_type,        "s",    &j->type  },
  90                 { "org.freedesktop.systemd1.Job", "Unit",    bus_job_append_unit,        "(so)", j         },
  91                 { NULL, NULL, NULL, NULL, NULL }
  92         };
  93
  94         DBusMessage *reply = NULL;
  95
  96         if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Job", "Cancel")) {
  97                 if (!(reply = dbus_message_new_method_return(message)))
  98                         goto oom;
  99
 100                 job_free(j);
 101
 102         } else
 103                 return bus_default_message_handler(j->manager, connection, message, INTROSPECTION, properties);
 104
 105         if (reply) {
 106                 if (!dbus_connection_send(connection, reply, NULL))
 107                         goto oom;
 108
 109                 dbus_message_unref(reply);
 110         }
 111
 112         return DBUS_HANDLER_RESULT_HANDLED;
 113
 114 oom:
 115         if (reply)
 116                 dbus_message_unref(reply);
 117
 118         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 119 }
 120
 121 static DBusHandlerResult bus_job_message_handler(DBusConnection *connection, DBusMessage  *message, void *data) {
 122         Manager *m = data;
 123         Job *j;
 124         int r;
 125         DBusMessage *reply;
 126
 127         assert(connection);
 128         assert(message);
 129         assert(m);
 130
 131         if (streq(dbus_message_get_path(message), "/org/freedesktop/systemd1/job")) {
 132                 /* Be nice to gdbus and return introspection data for our mid-level paths */
 133
 134                 if (dbus_message_is_method_call(message, "org.freedesktop.DBus.Introspectable", "Introspect")) {
 135                         char *introspection = NULL;
 136                         FILE *f;
 137                         Iterator i;
 138                         size_t size;
 139
 140                         if (!(reply = dbus_message_new_method_return(message)))
 141                                 goto oom;
 142
 143                         /* We roll our own introspection code here, instead of
 144                          * relying on bus_default_message_handler() because we
 145                          * need to generate our introspection string
 146                          * dynamically. */
 147
 148                         if (!(f = open_memstream(&introspection, &size)))
 149                                 goto oom;
 150
 151                         fputs(DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE
 152                               "<node>\n", f);
 153
 154                         fputs(BUS_INTROSPECTABLE_INTERFACE, f);
 155                         fputs(BUS_PEER_INTERFACE, f);
 156
 157                         HASHMAP_FOREACH(j, m->jobs, i)
 158                                 fprintf(f, "<node name=\"job/%lu\"/>", (unsigned long) j->id);
 159
 160                         fputs("</node>\n", f);
 161
 162                         if (ferror(f)) {
 163                                 fclose(f);
 164                                 free(introspection);
 165                                 goto oom;
 166                         }
 167
 168                         fclose(f);
 169
 170                         if (!introspection)
 171                                 goto oom;
 172
 173                         if (!dbus_message_append_args(reply, DBUS_TYPE_STRING, &introspection, DBUS_TYPE_INVALID)) {
 174                                 free(introspection);
 175                                 goto oom;
 176                         }
 177
 178                         free(introspection);
 179
 180                         if (!dbus_connection_send(connection, reply, NULL))
 181                                 goto oom;
 182
 183                         dbus_message_unref(reply);
 184
 185                         return DBUS_HANDLER_RESULT_HANDLED;
 186                 }
 187
 188                 return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 189         }
 190
 191         if ((r = manager_get_job_from_dbus_path(m, dbus_message_get_path(message), &j)) < 0) {
 192
 193                 if (r == -ENOMEM)
 194                         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 195
 196                 if (r == -ENOENT)
 197                         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 198
 199                 return bus_send_error_reply(m, connection, message, NULL, r);
 200         }
 201
 202         return bus_job_message_dispatch(j, connection, message);
 203
 204 oom:
 205         if (reply)
 206                 dbus_message_unref(reply);
 207
 208         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 209 }
 210
 211 const DBusObjectPathVTable bus_job_vtable = {
 212         .message_function = bus_job_message_handler
 213 };
 214
 215 static int job_send_message(Job *j, DBusMessage *m) {
 216         int r;
 217
 218         assert(j);
 219         assert(m);
 220
 221         if (bus_has_subscriber(j->manager)) {
 222                 if ((r = bus_broadcast(j->manager, m)) < 0)
 223                         return r;
 224
 225         } else  if (j->bus_client) {
 226                 /* If nobody is subscribed, we just send the message
 227                  * to the client which created the job */
 228
 229                 assert(j->bus);
 230
 231                 if (!dbus_message_set_destination(m, j->bus_client))
 232                         return -ENOMEM;
 233
 234                 if (!dbus_connection_send(j->bus, m, NULL))
 235                         return -ENOMEM;
 236         }
 237
 238         return 0;
 239 }
 240
 241 void bus_job_send_change_signal(Job *j) {
 242         char *p = NULL;
 243         DBusMessage *m = NULL;
 244
 245         assert(j);
 246
 247         if (j->in_dbus_queue) {
 248                 LIST_REMOVE(Job, dbus_queue, j->manager->dbus_job_queue, j);
 249                 j->in_dbus_queue = false;
 250         }
 251
 252         if (!bus_has_subscriber(j->manager) && !j->bus_client) {
 253                 j->sent_dbus_new_signal = true;
 254                 return;
 255         }
 256
 257         if (!(p = job_dbus_path(j)))
 258                 goto oom;
 259
 260         if (j->sent_dbus_new_signal) {
 261                 /* Send a properties changed signal */
 262
 263                 if (!(m = bus_properties_changed_new(p, "org.freedesktop.systemd1.Job", INVALIDATING_PROPERTIES)))
 264                         goto oom;
 265
 266         } else {
 267                 /* Send a new signal */
 268
 269                 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "JobNew")))
 270                         goto oom;
 271
 272                 if (!dbus_message_append_args(m,
 273                                               DBUS_TYPE_UINT32, &j->id,
 274                                               DBUS_TYPE_OBJECT_PATH, &p,
 275                                               DBUS_TYPE_INVALID))
 276                         goto oom;
 277         }
 278
 279         if (job_send_message(j, m) < 0)
 280                 goto oom;
 281
 282         free(p);
 283         dbus_message_unref(m);
 284
 285         j->sent_dbus_new_signal = true;
 286
 287         return;
 288
 289 oom:
 290         free(p);
 291
 292         if (m)
 293                 dbus_message_unref(m);
 294
 295         log_error("Failed to allocate job change signal.");
 296 }
 297
 298 void bus_job_send_removed_signal(Job *j, bool success) {
 299         char *p = NULL;
 300         DBusMessage *m = NULL;
 301         dbus_bool_t b = success;
 302
 303         assert(j);
 304
 305         if (!bus_has_subscriber(j->manager) && !j->bus_client)
 306                 return;
 307
 308         if (!j->sent_dbus_new_signal)
 309                 bus_job_send_change_signal(j);
 310
 311         if (!(p = job_dbus_path(j)))
 312                 goto oom;
 313
 314         if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "JobRemoved")))
 315                 goto oom;
 316
 317         if (!dbus_message_append_args(m,
 318                                       DBUS_TYPE_UINT32, &j->id,
 319                                       DBUS_TYPE_OBJECT_PATH, &p,
 320                                       DBUS_TYPE_BOOLEAN, &b,
 321                                       DBUS_TYPE_INVALID))
 322                 goto oom;
 323
 324         if (job_send_message(j, m) < 0)
 325                 goto oom;
 326
 327         free(p);
 328         dbus_message_unref(m);
 329
 330         return;
 331
 332 oom:
 333         free(p);
 334
 335         if (m)
 336                 dbus_message_unref(m);
 337
 338         log_error("Failed to allocate job remove signal.");
 339 }