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, 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         Manager *m = j->manager;
  92
  93         if (dbus_message_is_method_call(message, "org.freedesktop.systemd1.Job", "Cancel")) {
  94                 if (!(reply = dbus_message_new_method_return(message)))
  95                         goto oom;
  96
  97                 job_free(j);
  98
  99         } else
 100                 return bus_default_message_handler(j->manager, message, INTROSPECTION, properties);
 101
 102         if (reply) {
 103                 if (!dbus_connection_send(m->api_bus, reply, NULL))
 104                         goto oom;
 105
 106                 dbus_message_unref(reply);
 107         }
 108
 109         return DBUS_HANDLER_RESULT_HANDLED;
 110
 111 oom:
 112         if (reply)
 113                 dbus_message_unref(reply);
 114
 115         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 116 }
 117
 118 static DBusHandlerResult bus_job_message_handler(DBusConnection  *connection, DBusMessage  *message, void *data) {
 119         Manager *m = data;
 120         Job *j;
 121         int r;
 122
 123         assert(connection);
 124         assert(message);
 125         assert(m);
 126
 127         log_debug("Got D-Bus request: %s.%s() on %s",
 128                   dbus_message_get_interface(message),
 129                   dbus_message_get_member(message),
 130                   dbus_message_get_path(message));
 131
 132         if ((r = manager_get_job_from_dbus_path(m, dbus_message_get_path(message), &j)) < 0) {
 133
 134                 if (r == -ENOMEM)
 135                         return DBUS_HANDLER_RESULT_NEED_MEMORY;
 136
 137                 if (r == -ENOENT)
 138                         return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 139
 140                 return bus_send_error_reply(m, message, NULL, r);
 141         }
 142
 143         return bus_job_message_dispatch(j, message);
 144 }
 145
 146 const DBusObjectPathVTable bus_job_vtable = {
 147         .message_function = bus_job_message_handler
 148 };
 149
 150 void bus_job_send_change_signal(Job *j) {
 151         char *p = NULL;
 152         DBusMessage *m = NULL;
 153
 154         assert(j);
 155         assert(j->in_dbus_queue);
 156
 157         LIST_REMOVE(Job, dbus_queue, j->manager->dbus_job_queue, j);
 158         j->in_dbus_queue = false;
 159
 160         if (set_isempty(j->manager->subscribed)) {
 161                 j->sent_dbus_new_signal = true;
 162                 return;
 163         }
 164
 165         if (!(p = job_dbus_path(j)))
 166                 goto oom;
 167
 168         if (j->sent_dbus_new_signal) {
 169                 /* Send a change signal */
 170
 171                 if (!(m = dbus_message_new_signal(p, "org.freedesktop.systemd1.Job", "Changed")))
 172                         goto oom;
 173         } else {
 174                 /* Send a new signal */
 175
 176                 if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "JobNew")))
 177                         goto oom;
 178
 179                 if (!dbus_message_append_args(m,
 180                                               DBUS_TYPE_UINT32, &j->id,
 181                                               DBUS_TYPE_OBJECT_PATH, &p,
 182                                               DBUS_TYPE_INVALID))
 183                         goto oom;
 184         }
 185
 186         if (!dbus_connection_send(j->manager->api_bus, m, NULL))
 187                 goto oom;
 188
 189         free(p);
 190         dbus_message_unref(m);
 191
 192         j->sent_dbus_new_signal = true;
 193
 194         return;
 195
 196 oom:
 197         free(p);
 198
 199         if (m)
 200                 dbus_message_unref(m);
 201
 202         log_error("Failed to allocate job change signal.");
 203 }
 204
 205 void bus_job_send_removed_signal(Job *j, bool success) {
 206         char *p = NULL;
 207         DBusMessage *m = NULL;
 208         dbus_bool_t b = success;
 209
 210         assert(j);
 211
 212         if (set_isempty(j->manager->subscribed))
 213                 return;
 214
 215         if (!j->sent_dbus_new_signal)
 216                 bus_job_send_change_signal(j);
 217
 218         if (!(p = job_dbus_path(j)))
 219                 goto oom;
 220
 221         if (!(m = dbus_message_new_signal("/org/freedesktop/systemd1", "org.freedesktop.systemd1.Manager", "JobRemoved")))
 222                 goto oom;
 223
 224         if (!dbus_message_append_args(m,
 225                                       DBUS_TYPE_UINT32, &j->id,
 226                                       DBUS_TYPE_OBJECT_PATH, &p,
 227                                       DBUS_TYPE_BOOLEAN, &b,
 228                                       DBUS_TYPE_INVALID))
 229                 goto oom;
 230
 231         if (!dbus_connection_send(j->manager->api_bus, m, NULL))
 232                 goto oom;
 233
 234         free(p);
 235         dbus_message_unref(m);
 236
 237         return;
 238
 239 oom:
 240         free(p);
 241
 242         if (m)
 243                 dbus_message_unref(m);
 244
 245         log_error("Failed to allocate job remove signal.");
 246 }