blob: f600c14e2f0319d38de026a205b52c48d9b7db27 [file] [log] [blame]
Jennifer Lee729dae72018-04-24 15:59:34 -07001/*
2// Copyright (c) 2018 Intel Corporation
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8// http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15*/
16#pragma once
17
18#include "node.hpp"
Ed Tanous1abe55e2018-09-05 08:30:59 -070019
Jennifer Lee729dae72018-04-24 15:59:34 -070020#include <boost/container/flat_map.hpp>
21
Ed Tanous1abe55e2018-09-05 08:30:59 -070022namespace redfish
23{
Ed Tanous27826b52018-10-29 11:40:58 -070024
Jennifer Leeacb7cfb2018-06-07 16:08:15 -070025static std::unique_ptr<sdbusplus::bus::match::match> fwUpdateMatcher;
Jennifer Lee729dae72018-04-24 15:59:34 -070026
Ed Tanous1abe55e2018-09-05 08:30:59 -070027class UpdateService : public Node
28{
29 public:
30 UpdateService(CrowApp &app) : Node(app, "/redfish/v1/UpdateService/")
31 {
Ed Tanous1abe55e2018-09-05 08:30:59 -070032 entityPrivileges = {
33 {boost::beast::http::verb::get, {{"Login"}}},
34 {boost::beast::http::verb::head, {{"Login"}}},
35 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
36 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
37 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
38 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
Jennifer Leeacb7cfb2018-06-07 16:08:15 -070039 }
Jennifer Leeacb7cfb2018-06-07 16:08:15 -070040
Ed Tanous1abe55e2018-09-05 08:30:59 -070041 private:
42 void doGet(crow::Response &res, const crow::Request &req,
43 const std::vector<std::string> &params) override
44 {
Ed Tanous0f74e642018-11-12 15:17:05 -080045 res.jsonValue["@odata.type"] = "#UpdateService.v1_2_0.UpdateService";
46 res.jsonValue["@odata.id"] = "/redfish/v1/UpdateService";
47 res.jsonValue["@odata.context"] =
48 "/redfish/v1/$metadata#UpdateService.UpdateService";
49 res.jsonValue["Id"] = "UpdateService";
50 res.jsonValue["Description"] = "Service for Software Update";
51 res.jsonValue["Name"] = "Update Service";
52 res.jsonValue["HttpPushUri"] = "/redfish/v1/UpdateService";
53 // UpdateService cannot be disabled
54 res.jsonValue["ServiceEnabled"] = true;
55 res.jsonValue["FirmwareInventory"] = {
56 {"@odata.id", "/redfish/v1/UpdateService/FirmwareInventory"}};
Jennifer Leeacb7cfb2018-06-07 16:08:15 -070057 res.end();
Ed Tanous1abe55e2018-09-05 08:30:59 -070058 }
59 static void activateImage(const std::string &objPath)
60 {
61 crow::connections::systemBus->async_method_call(
62 [objPath](const boost::system::error_code error_code) {
63 if (error_code)
64 {
65 BMCWEB_LOG_DEBUG << "error_code = " << error_code;
66 BMCWEB_LOG_DEBUG << "error msg = " << error_code.message();
67 }
68 },
69 "xyz.openbmc_project.Software.BMC.Updater", objPath,
70 "org.freedesktop.DBus.Properties", "Set",
71 "xyz.openbmc_project.Software.Activation", "RequestedActivation",
72 sdbusplus::message::variant<std::string>(
73 "xyz.openbmc_project.Software.Activation.RequestedActivations."
74 "Active"));
75 }
76 void doPost(crow::Response &res, const crow::Request &req,
77 const std::vector<std::string> &params) override
78 {
79 BMCWEB_LOG_DEBUG << "doPost...";
Jennifer Leeacb7cfb2018-06-07 16:08:15 -070080
Ed Tanous1abe55e2018-09-05 08:30:59 -070081 // Only allow one FW update at a time
82 if (fwUpdateMatcher != nullptr)
83 {
84 res.addHeader("Retry-After", "30");
Jason M. Billsf12894f2018-10-09 12:45:45 -070085 messages::serviceTemporarilyUnavailable(res, "3");
Ed Tanous1abe55e2018-09-05 08:30:59 -070086 res.end();
Jennifer Lee6c4eb9d2018-05-22 10:58:31 -070087 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -070088 }
89 // Make this const static so it survives outside this method
90 static boost::asio::deadline_timer timeout(
91 *req.ioService, boost::posix_time::seconds(5));
Jennifer Lee6c4eb9d2018-05-22 10:58:31 -070092
Ed Tanous1abe55e2018-09-05 08:30:59 -070093 timeout.expires_from_now(boost::posix_time::seconds(5));
Jennifer Lee6c4eb9d2018-05-22 10:58:31 -070094
Ed Tanous1abe55e2018-09-05 08:30:59 -070095 timeout.async_wait([&res](const boost::system::error_code &ec) {
96 fwUpdateMatcher = nullptr;
97 if (ec == boost::asio::error::operation_aborted)
98 {
99 // expected, we were canceled before the timer completed.
100 return;
Jennifer Lee6c4eb9d2018-05-22 10:58:31 -0700101 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700102 BMCWEB_LOG_ERROR
103 << "Timed out waiting for firmware object being created";
104 BMCWEB_LOG_ERROR
105 << "FW image may has already been uploaded to server";
106 if (ec)
107 {
108 BMCWEB_LOG_ERROR << "Async_wait failed" << ec;
109 return;
110 }
111
Jason M. Billsf12894f2018-10-09 12:45:45 -0700112 redfish::messages::internalError(res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700113 res.end();
114 });
115
116 auto callback = [&res](sdbusplus::message::message &m) {
117 BMCWEB_LOG_DEBUG << "Match fired";
118 bool flag = false;
119
120 if (m.is_method_error())
121 {
122 BMCWEB_LOG_DEBUG << "Dbus method error!!!";
123 res.end();
124 return;
125 }
126 std::vector<std::pair<
127 std::string,
128 std::vector<std::pair<
129 std::string, sdbusplus::message::variant<std::string>>>>>
Ed Tanous3ae837c2018-08-07 14:41:19 -0700130 interfacesProperties;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700131
132 sdbusplus::message::object_path objPath;
133
Ed Tanous3ae837c2018-08-07 14:41:19 -0700134 m.read(objPath, interfacesProperties); // Read in the object path
135 // that was just created
Ed Tanous1abe55e2018-09-05 08:30:59 -0700136 // std::string str_objpath = objPath.str; // keep a copy for
137 // constructing response message
138 BMCWEB_LOG_DEBUG << "obj path = " << objPath.str; // str_objpath;
Ed Tanous3ae837c2018-08-07 14:41:19 -0700139 for (auto &interface : interfacesProperties)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700140 {
141 BMCWEB_LOG_DEBUG << "interface = " << interface.first;
142
143 if (interface.first ==
144 "xyz.openbmc_project.Software.Activation")
145 {
146 // cancel timer only when
147 // xyz.openbmc_project.Software.Activation interface is
148 // added
149 boost::system::error_code ec;
150 timeout.cancel(ec);
151 if (ec)
152 {
153 BMCWEB_LOG_ERROR << "error canceling timer " << ec;
154 }
155 UpdateService::activateImage(objPath.str); // str_objpath);
Jason M. Billsf12894f2018-10-09 12:45:45 -0700156 redfish::messages::success(res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700157 BMCWEB_LOG_DEBUG << "ending response";
158 res.end();
159 fwUpdateMatcher = nullptr;
160 }
161 }
162 };
163
164 fwUpdateMatcher = std::make_unique<sdbusplus::bus::match::match>(
165 *crow::connections::systemBus,
166 "interface='org.freedesktop.DBus.ObjectManager',type='signal',"
167 "member='InterfacesAdded',path='/xyz/openbmc_project/software'",
168 callback);
169
170 std::string filepath(
171 "/tmp/images/" +
172 boost::uuids::to_string(boost::uuids::random_generator()()));
173 BMCWEB_LOG_DEBUG << "Writing file to " << filepath;
174 std::ofstream out(filepath, std::ofstream::out | std::ofstream::binary |
175 std::ofstream::trunc);
176 out << req.body;
177 out.close();
178 BMCWEB_LOG_DEBUG << "file upload complete!!";
179 }
Jennifer Lee729dae72018-04-24 15:59:34 -0700180};
Ed Tanousc711bf82018-07-30 16:31:33 -0700181
Ed Tanous1abe55e2018-09-05 08:30:59 -0700182class SoftwareInventoryCollection : public Node
183{
184 public:
185 template <typename CrowApp>
186 SoftwareInventoryCollection(CrowApp &app) :
187 Node(app, "/redfish/v1/UpdateService/FirmwareInventory/")
188 {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700189 entityPrivileges = {
190 {boost::beast::http::verb::get, {{"Login"}}},
191 {boost::beast::http::verb::head, {{"Login"}}},
192 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
193 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
194 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
195 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
Jennifer Lee729dae72018-04-24 15:59:34 -0700196 }
Jennifer Lee729dae72018-04-24 15:59:34 -0700197
Ed Tanous1abe55e2018-09-05 08:30:59 -0700198 private:
199 void doGet(crow::Response &res, const crow::Request &req,
200 const std::vector<std::string> &params) override
201 {
202 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous0f74e642018-11-12 15:17:05 -0800203 res.jsonValue["@odata.type"] =
204 "#SoftwareInventoryCollection.SoftwareInventoryCollection";
205 res.jsonValue["@odata.id"] =
206 "/redfish/v1/UpdateService/FirmwareInventory";
207 res.jsonValue["@odata.context"] =
208 "/redfish/v1/"
209 "$metadata#SoftwareInventoryCollection.SoftwareInventoryCollection";
210 res.jsonValue["Name"] = "Software Inventory Collection";
Ed Tanousc711bf82018-07-30 16:31:33 -0700211
Ed Tanous1abe55e2018-09-05 08:30:59 -0700212 crow::connections::systemBus->async_method_call(
213 [asyncResp](
214 const boost::system::error_code ec,
215 const std::vector<std::pair<
216 std::string, std::vector<std::pair<
217 std::string, std::vector<std::string>>>>>
218 &subtree) {
219 if (ec)
220 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700221 messages::internalError(asyncResp->res);
Ed Tanousc711bf82018-07-30 16:31:33 -0700222 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700223 }
224 asyncResp->res.jsonValue["Members"] = nlohmann::json::array();
225 asyncResp->res.jsonValue["Members@odata.count"] = 0;
Jennifer Lee6c4eb9d2018-05-22 10:58:31 -0700226
Ed Tanous1abe55e2018-09-05 08:30:59 -0700227 for (auto &obj : subtree)
228 {
229 const std::vector<
230 std::pair<std::string, std::vector<std::string>>>
231 &connections = obj.second;
232
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700233 // if can't parse fw id then return
Ed Tanous27826b52018-10-29 11:40:58 -0700234 std::size_t idPos;
235 if ((idPos = obj.first.rfind("/")) == std::string::npos)
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700236 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700237 messages::internalError(asyncResp->res);
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700238 BMCWEB_LOG_DEBUG << "Can't parse firmware ID!!";
239 return;
240 }
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700241 std::string swId = obj.first.substr(idPos + 1);
242
Ed Tanous1abe55e2018-09-05 08:30:59 -0700243 for (auto &conn : connections)
244 {
245 const std::string &connectionName = conn.first;
246 BMCWEB_LOG_DEBUG << "connectionName = "
247 << connectionName;
248 BMCWEB_LOG_DEBUG << "obj.first = " << obj.first;
249
250 crow::connections::systemBus->async_method_call(
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700251 [asyncResp,
252 swId](const boost::system::error_code error_code,
253 const VariantType &activation) {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700254 BMCWEB_LOG_DEBUG
255 << "safe returned in lambda function";
256 if (error_code)
257 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700258 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700259 return;
260 }
261
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700262 const std::string *swActivationStatus =
Ed Tanous1abe55e2018-09-05 08:30:59 -0700263 mapbox::getPtr<const std::string>(
264 activation);
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700265 if (swActivationStatus == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700266 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700267 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700268 return;
269 }
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700270 if (swActivationStatus != nullptr &&
271 *swActivationStatus !=
272 "xyz.openbmc_project.Software."
273 "Activation."
274 "Activations.Active")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700275 {
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700276 // The activation status of this software is
277 // not currently active, so does not need to
278 // be listed in the response
Ed Tanous1abe55e2018-09-05 08:30:59 -0700279 return;
280 }
281 nlohmann::json &members =
282 asyncResp->res.jsonValue["Members"];
283 members.push_back(
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700284 {{"@odata.id", "/redfish/v1/UpdateService/"
285 "FirmwareInventory/" +
286 swId}});
Ed Tanous1abe55e2018-09-05 08:30:59 -0700287 asyncResp->res
288 .jsonValue["Members@odata.count"] =
289 members.size();
290 },
291 connectionName, obj.first,
292 "org.freedesktop.DBus.Properties", "Get",
293 "xyz.openbmc_project.Software.Activation",
294 "Activation");
Ed Tanousc711bf82018-07-30 16:31:33 -0700295 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700296 }
297 },
298 "xyz.openbmc_project.ObjectMapper",
299 "/xyz/openbmc_project/object_mapper",
300 "xyz.openbmc_project.ObjectMapper", "GetSubTree",
301 "/xyz/openbmc_project/software", int32_t(1),
302 std::array<const char *, 1>{
303 "xyz.openbmc_project.Software.Version"});
304 }
Jennifer Lee729dae72018-04-24 15:59:34 -0700305};
306
Ed Tanous1abe55e2018-09-05 08:30:59 -0700307class SoftwareInventory : public Node
308{
309 public:
310 template <typename CrowApp>
311 SoftwareInventory(CrowApp &app) :
312 Node(app, "/redfish/v1/UpdateService/FirmwareInventory/<str>/",
313 std::string())
314 {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700315 entityPrivileges = {
316 {boost::beast::http::verb::get, {{"Login"}}},
317 {boost::beast::http::verb::head, {{"Login"}}},
318 {boost::beast::http::verb::patch, {{"ConfigureComponents"}}},
319 {boost::beast::http::verb::put, {{"ConfigureComponents"}}},
320 {boost::beast::http::verb::delete_, {{"ConfigureComponents"}}},
321 {boost::beast::http::verb::post, {{"ConfigureComponents"}}}};
322 }
323
324 private:
325 void doGet(crow::Response &res, const crow::Request &req,
326 const std::vector<std::string> &params) override
327 {
328 std::shared_ptr<AsyncResp> asyncResp = std::make_shared<AsyncResp>(res);
Ed Tanous0f74e642018-11-12 15:17:05 -0800329 res.jsonValue["@odata.type"] =
330 "#SoftwareInventory.v1_1_0.SoftwareInventory";
331 res.jsonValue["@odata.context"] =
332 "/redfish/v1/$metadata#SoftwareInventory.SoftwareInventory";
333 res.jsonValue["Name"] = "Software Inventory";
334 res.jsonValue["Updateable"] = false;
335 res.jsonValue["Status"]["Health"] = "OK";
336 res.jsonValue["Status"]["HealthRollup"] = "OK";
337 res.jsonValue["Status"]["State"] = "Enabled";
Ed Tanous1abe55e2018-09-05 08:30:59 -0700338
339 if (params.size() != 1)
340 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700341 messages::internalError(res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700342 res.end();
343 return;
344 }
345
Ed Tanous3ae837c2018-08-07 14:41:19 -0700346 std::shared_ptr<std::string> swId =
Ed Tanous1abe55e2018-09-05 08:30:59 -0700347 std::make_shared<std::string>(params[0]);
348
349 res.jsonValue["@odata.id"] =
Ed Tanous3ae837c2018-08-07 14:41:19 -0700350 "/redfish/v1/UpdateService/FirmwareInventory/" + *swId;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700351
352 crow::connections::systemBus->async_method_call(
Ed Tanous3ae837c2018-08-07 14:41:19 -0700353 [asyncResp, swId](
Ed Tanous1abe55e2018-09-05 08:30:59 -0700354 const boost::system::error_code ec,
355 const std::vector<std::pair<
356 std::string, std::vector<std::pair<
357 std::string, std::vector<std::string>>>>>
358 &subtree) {
359 BMCWEB_LOG_DEBUG << "doGet callback...";
360 if (ec)
361 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700362 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700363 return;
364 }
365
366 for (const std::pair<
367 std::string,
368 std::vector<
369 std::pair<std::string, std::vector<std::string>>>>
370 &obj : subtree)
371 {
Ed Tanous3ae837c2018-08-07 14:41:19 -0700372 if (boost::ends_with(obj.first, *swId) != true)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700373 {
374 continue;
375 }
376
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700377 if (obj.second.size() < 1)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700378 {
379 continue;
380 }
381
382 crow::connections::systemBus->async_method_call(
383 [asyncResp,
Ed Tanous3ae837c2018-08-07 14:41:19 -0700384 swId](const boost::system::error_code error_code,
385 const boost::container::flat_map<
386 std::string, VariantType> &propertiesList) {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700387 if (error_code)
388 {
Jason M. Billsf12894f2018-10-09 12:45:45 -0700389 messages::internalError(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700390 return;
391 }
392 boost::container::flat_map<
393 std::string, VariantType>::const_iterator it =
394 propertiesList.find("Purpose");
395 if (it == propertiesList.end())
396 {
397 BMCWEB_LOG_DEBUG
398 << "Can't find property \"Purpose\"!";
Jason M. Billsf12894f2018-10-09 12:45:45 -0700399 messages::propertyMissing(asyncResp->res,
400 "Purpose");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700401 return;
402 }
Ed Tanous3ae837c2018-08-07 14:41:19 -0700403 const std::string *swInvPurpose =
Ed Tanous1abe55e2018-09-05 08:30:59 -0700404 mapbox::getPtr<const std::string>(it->second);
Ed Tanous3ae837c2018-08-07 14:41:19 -0700405 if (swInvPurpose == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700406 {
407 BMCWEB_LOG_DEBUG
408 << "wrong types for property\"Purpose\"!";
Jason M. Billsf12894f2018-10-09 12:45:45 -0700409 messages::propertyValueTypeError(asyncResp->res,
410 "", "Purpose");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700411 return;
412 }
413
Ed Tanous3ae837c2018-08-07 14:41:19 -0700414 BMCWEB_LOG_DEBUG << "swInvPurpose = "
415 << *swInvPurpose;
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700416 it = propertiesList.find("Version");
417 if (it == propertiesList.end())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700418 {
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700419 BMCWEB_LOG_DEBUG
420 << "Can't find property \"Version\"!";
Jason M. Billsf12894f2018-10-09 12:45:45 -0700421 messages::propertyMissing(asyncResp->res,
422 "Version");
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700423 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700424 }
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700425
426 BMCWEB_LOG_DEBUG << "Version found!";
427
428 const std::string *version =
429 mapbox::getPtr<const std::string>(it->second);
430
431 if (version == nullptr)
432 {
433 BMCWEB_LOG_DEBUG
434 << "Can't find property \"Version\"!";
Jason M. Billsf12894f2018-10-09 12:45:45 -0700435
436 messages::propertyValueTypeError(asyncResp->res,
437 "", "Version");
Jennifer Leef4b65ab2018-09-18 12:00:13 -0700438 return;
439 }
440 asyncResp->res.jsonValue["Version"] = *version;
441 asyncResp->res.jsonValue["Id"] = *swId;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700442 },
443 obj.second[0].first, obj.first,
444 "org.freedesktop.DBus.Properties", "GetAll",
445 "xyz.openbmc_project.Software.Version");
446 }
447 },
448 "xyz.openbmc_project.ObjectMapper",
449 "/xyz/openbmc_project/object_mapper",
450 "xyz.openbmc_project.ObjectMapper", "GetSubTree",
451 "/xyz/openbmc_project/software", int32_t(1),
452 std::array<const char *, 1>{
453 "xyz.openbmc_project.Software.Version"});
454 }
455};
456
457} // namespace redfish