src/dbus-job.c

   1 /*-*- Mode: C; c-basic-offset: 8 -*-*/
   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         "  <signal name=\"Changed\"/>\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"   \
  36         " </interface>\n"
  37
  38 #define INTROSPECTION                                                 \
  39         DBUS_INTROSPECT_1_0_XML_DOCTYPE_DECL_NODE                     \
  40         "<node>\n"                                                    \
  41         BUS_JOB_INTERFACE                                             \
  42         BUS_PROPERTIES_INTERFACE                                      \
  43         BUS_INTROSPECTABLE_INTERFACE                                  \
  44         "</node>\n"
  45
  46 const char bus_job_interface[] = BUS_JOB_INTERFACE;
  47
  48 static DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_job_append_state, job_state, JobState);
  49 static DEFINE_BUS_PROPERTY_APPEND_ENUM(bus_job_append_type, job_type, JobType);
  50
  51 static int bus_job_append_unit(Manager *m, DBusMessageIter *i, const char *property, void *data) {
  52         Job *j = data;
  53         DBusMessageIter sub;
  54         char *p;
  55
  56         assert(m);
  57         assert(i);
  58         assert(property);
  59         assert(j);
  60
  61         if (!dbus_message_iter_open_container(i, DBUS_TYPE_STRUCT, NULL, &sub))
  62                 return -ENOMEM;
  63
  64         if (!(p = unit_dbus_path(j->unit)))
  65                 return -ENOMEM;
  66
  67         if (!dbus_message_iter_append_basic(&sub, DBUS_TYPE_STRING, &j->unit->meta.id) ||
  68             !dbus_message_iter_append_basic(&sub, DBUS_TYPE_OBJECT_PATH, &p)) {
  69                 free(p);
  70                 return -ENOMEM;
  71         }
  72
  73         free(p);
  74
  75         if (!dbus_message_iter_close_container(i, &sub))
  76                 return -ENOMEM;
  77
  78         return 0;
  79 }
  80
  81 static DBusHandlerResult bus_job_message_dispatch(Job *j, DBusConnection *connection, DBusMessage *message) {
  82         const BusProperty properties[] = {
  83                 { "org.freedesktop.systemd1.Job", "Id",      bus_property_append_uint32, "u",    &j->id    },
  84                 { "org.freedesktop.systemd1.Job", "State",   bus_job_append_state,       "s",    &j->state },
  85                 { "org.freedesktop.systemd1.Job", "JobType", bus_job_append_type,        "s",    &j->type  },
  86                 { "org.freedesktop.systemd1.Job", "Unit",    bus_job_append_unit,        "(so)", j         },
  87                 { NULL, NULL, NULL, NULL, NULL }
  88         };
  89
  90         DBusMessage *reply = NULL;
  91
  92         if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Job", "Cancel")) {
  93                 if (!(reply = dbus_message_new_method_return(message)))
  94                         goto oom;
  95
  96                 job_free(j);
  97
  98         } else
  99                 return bus_default_message_handler(j->manager, connection, message, INTROSPECTION, properties);
 100
 101         if (reply) {
 102                 if (!dbus_connection_send(connection, reply, NULL))
 103                         goto oom;
 104
 105                 dbus_message_unref(reply);
 106         }
 107
 108         return DBUS_HANDLER_RESULT_HANDLED;
 109
 110 oom:
 111         if (reply)
 112                 dbus_message_unref(reply);
 113
 114         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 115 }
 116
 117 static DBusHandlerResult bus_job_message_handler(DBusConnection *connection, DBusMessage  *message, void *data) {
 118         Manager *m = data;
 119         Job *j;
 120         int r;
 121
 122         assert(connection);
 123         assert(message);
 124         assert(m);
 125
 126         log_debug("Got D-Bus request: %s.%s() on %s",
 127                   dbus_message_get_interface(message),
 128                   dbus_message_get_member(message),
 129                   dbus_message_get_path(message));
 130
 131         if ((r = manager_get_job_from_dbus_path(m, dbus_message_get_path(message), &j)) < 0) {
 132
 133                 if (r == -ENOMEM)
 134                         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 135
 136                 if (r == -ENOENT)
 137                         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 138
 139                 return bus_send_error_reply(m, connection, message, NULL, r);
 140         }
 141
 142         return bus_job_message_dispatch(j, connection, message);
 143 }
 144
 145 const DBusObjectPathVTable bus_job_vtable = {
 146         .message_function = bus_job_message_handler
 147 };
 148
 149 static int job_send_message(Job *j, DBusMessage *m) {
 150         int r;
 151
 152         assert(j);
 153         assert(m);
 154
 155         if (bus_has_subscriber(j->manager)) {
 156                 if ((r = bus_broadcast(j->manager, m)) < 0)
 157                         return r;
 158
 159         } else  if (j->bus_client) {
 160                 /* If nobody is subscribed, we just send the message
 161                  * to the client which created the job */
 162
 163                 assert(j->bus);
 164
 165                 if (!dbus_message_set_destination(m, j->bus_client))
 166                         return -ENOMEM;
 167
 168                 if (!dbus_connection_send(j->bus, m, NULL))
 169                         return -ENOMEM;
 170         }
 171
 172         return 0;
 173 }
 174
 175 void bus_job_send_change_signal(Job *j) {
 176         char *p = NULL;
 177         DBusMessage *m = NULL;
 178
 179         assert(j);
 180         assert(j->in_dbus_queue);
 181
 182         LIST_REMOVE(Job, dbus_queue, j->manager->dbus_job_queue, j);
 183         j->in_dbus_queue = false;
 184
 185         if (!bus_has_subscriber(j->manager) && !j->bus_client) {
 186                 j->sent_dbus_new_signal = true;
 187                 return;
 188         }
 189
 190         if (!(p = job_dbus_path(j)))
 191                 goto oom;
 192
 193         if (j->sent_dbus_new_signal) {
 194                 /* Send a change signal */
 195
 196                 if (!(m = dbus_message_new_signal(p, "org.freedesktop.systemd1.Job", "Changed")))
 197                         goto oom;
 198         } else {
 199                 /* Send a new signal */
 200
 201                 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "JobNew")))
 202                         goto oom;
 203
 204                 if (!dbus_message_append_args(m,
 205                                               DBUS_TYPE_UINT32, &j->id,
 206                                               DBUS_TYPE_OBJECT_PATH, &p,
 207                                               DBUS_TYPE_INVALID))
 208                         goto oom;
 209         }
 210
 211         if (job_send_message(j, m) < 0)
 212                 goto oom;
 213
 214         free(p);
 215         dbus_message_unref(m);
 216
 217         j->sent_dbus_new_signal = true;
 218
 219         return;
 220
 221 oom:
 222         free(p);
 223
 224         if (m)
 225                 dbus_message_unref(m);
 226
 227         log_error("Failed to allocate job change signal.");
 228 }
 229
 230 void bus_job_send_removed_signal(Job *j, bool success) {
 231         char *p = NULL;
 232         DBusMessage *m = NULL;
 233         dbus_bool_t b = success;
 234
 235         assert(j);
 236
 237         if (!bus_has_subscriber(j->manager) && !j->bus_client)
 238                 return;
 239
 240         if (!j->sent_dbus_new_signal)
 241                 bus_job_send_change_signal(j);
 242
 243         if (!(p = job_dbus_path(j)))
 244                 goto oom;
 245
 246         if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "JobRemoved")))
 247                 goto oom;
 248
 249         if (!dbus_message_append_args(m,
 250                                       DBUS_TYPE_UINT32, &j->id,
 251                                       DBUS_TYPE_OBJECT_PATH, &p,
 252                                       DBUS_TYPE_BOOLEAN, &b,
 253                                       DBUS_TYPE_INVALID))
 254                 goto oom;
 255
 256         if (job_send_message(j, m) < 0)
 257                 goto oom;
 258
 259         free(p);
 260         dbus_message_unref(m);
 261
 262         return;
 263
 264 oom:
 265         free(p);
 266
 267         if (m)
 268                 dbus_message_unref(m);
 269
 270         log_error("Failed to allocate job remove signal.");
 271 }