blob: 98dfb843fa03e3a217c61e9732d7c1bf27b76388 [file] [log] [blame]
James Feist5b4aa862018-08-16 14:07:01 -07001// Copyright (c) 2018 Intel Corporation
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
Ed Tanousb9b2e0b2018-09-13 13:47:50 -070014
James Feist5b4aa862018-08-16 14:07:01 -070015#pragma once
Ed Tanous3ccb3ad2023-01-13 17:40:03 -080016#include "app.hpp"
17#include "async_resp.hpp"
18#include "dbus_singleton.hpp"
George Liu7a1dbc42022-12-07 16:03:22 +080019#include "dbus_utility.hpp"
Nan Zhoud5c80ad2022-07-11 01:16:31 +000020#include "http_request.hpp"
21#include "http_response.hpp"
22#include "logging.hpp"
Ed Tanous1aa0c2b2022-02-08 12:24:30 +010023#include "parsing.hpp"
Nan Zhoud5c80ad2022-07-11 01:16:31 +000024#include "routing.hpp"
Ed Tanous50ebd4a2023-01-19 19:03:17 -080025#include "str_utility.hpp"
Nan Zhoud5c80ad2022-07-11 01:16:31 +000026
27#include <systemd/sd-bus-protocol.h>
28#include <systemd/sd-bus.h>
Ed Tanous911ac312017-08-15 09:37:42 -070029#include <tinyxml2.h>
Ed Tanous1abe55e2018-09-05 08:30:59 -070030
Ed Tanous11ba3972022-07-11 09:50:41 -070031#include <boost/algorithm/string/classification.hpp>
32#include <boost/algorithm/string/predicate.hpp>
Nan Zhoud5c80ad2022-07-11 01:16:31 +000033#include <boost/beast/http/status.hpp>
34#include <boost/beast/http/verb.hpp>
35#include <boost/container/flat_map.hpp>
36#include <boost/container/vector.hpp>
37#include <boost/iterator/iterator_facade.hpp>
George Liue99073f2022-12-09 11:06:16 +080038#include <boost/system/error_code.hpp>
Nan Zhoud5c80ad2022-07-11 01:16:31 +000039#include <nlohmann/json.hpp>
40#include <sdbusplus/asio/connection.hpp>
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +020041#include <sdbusplus/asio/property.hpp>
Nan Zhoud5c80ad2022-07-11 01:16:31 +000042#include <sdbusplus/exception.hpp>
43#include <sdbusplus/message.hpp>
44#include <sdbusplus/message/native_types.hpp>
Gunnar Mills1214b7e2020-06-04 10:11:30 -050045
Nan Zhoud5c80ad2022-07-11 01:16:31 +000046#include <algorithm>
47#include <array>
48#include <cerrno>
49#include <cstdint>
50#include <cstring>
James Feist4418c7f2019-04-15 11:09:15 -070051#include <filesystem>
Ed Tanousd4bb9bb2018-05-16 13:36:42 -070052#include <fstream>
Nan Zhoud5c80ad2022-07-11 01:16:31 +000053#include <functional>
54#include <initializer_list>
55#include <iterator>
56#include <limits>
57#include <map>
58#include <memory>
Ramesh Iyyard9207042019-07-05 08:04:42 -050059#include <regex>
Nan Zhoud5c80ad2022-07-11 01:16:31 +000060#include <string>
61#include <string_view>
62#include <type_traits>
Ed Tanousb5a76932020-09-29 16:16:58 -070063#include <utility>
Nan Zhoud5c80ad2022-07-11 01:16:31 +000064#include <variant>
65#include <vector>
66
67// IWYU pragma: no_include <boost/algorithm/string/detail/classification.hpp>
68// IWYU pragma: no_include <boost/system/detail/error_code.hpp>
69// IWYU pragma: no_include <boost/system/detail/error_category.hpp>
70// IWYU pragma: no_include <errno.h>
71// IWYU pragma: no_include <string.h>
72// IWYU pragma: no_include <ext/alloc_traits.h>
73// IWYU pragma: no_include <exception>
74// IWYU pragma: no_include <boost/type_index/type_index_facade.hpp>
Ed Tanous911ac312017-08-15 09:37:42 -070075
Ed Tanous1abe55e2018-09-05 08:30:59 -070076namespace crow
77{
78namespace openbmc_mapper
79{
Ed Tanous23a21a12020-07-25 04:45:05 +000080const constexpr char* notFoundMsg = "404 Not Found";
81const constexpr char* badReqMsg = "400 Bad Request";
82const constexpr char* methodNotAllowedMsg = "405 Method Not Allowed";
83const constexpr char* forbiddenMsg = "403 Forbidden";
Ed Tanous1aa0c2b2022-02-08 12:24:30 +010084const constexpr char* unsupportedMediaMsg = "415 Unsupported Media Type";
Ed Tanous23a21a12020-07-25 04:45:05 +000085const constexpr char* methodFailedMsg = "500 Method Call Failed";
86const constexpr char* methodOutputFailedMsg = "500 Method Output Error";
87const constexpr char* notFoundDesc =
Matt Spinler2ae60092018-12-06 10:35:36 -060088 "org.freedesktop.DBus.Error.FileNotFound: path or object not found";
Ed Tanous23a21a12020-07-25 04:45:05 +000089const constexpr char* propNotFoundDesc =
90 "The specified property cannot be found";
91const constexpr char* noJsonDesc = "No JSON object could be decoded";
Ed Tanous1aa0c2b2022-02-08 12:24:30 +010092const constexpr char* invalidContentType =
93 "Content-type header is missing or invalid";
Ed Tanous23a21a12020-07-25 04:45:05 +000094const constexpr char* methodNotFoundDesc =
95 "The specified method cannot be found";
96const constexpr char* methodNotAllowedDesc = "Method not allowed";
97const constexpr char* forbiddenPropDesc =
98 "The specified property cannot be created";
99const constexpr char* forbiddenResDesc =
100 "The specified resource cannot be created";
Matt Spinler2ae60092018-12-06 10:35:36 -0600101
Josh Lehan482c45a2022-03-29 17:10:44 -0700102inline bool validateFilename(const std::string& filename)
103{
104 std::regex validFilename(R"(^[\w\- ]+(\.?[\w\- ]*)$)");
105
106 return std::regex_match(filename, validFilename);
107}
108
Ed Tanous23a21a12020-07-25 04:45:05 +0000109inline void setErrorResponse(crow::Response& res,
110 boost::beast::http::status result,
Ed Tanous26ccae32023-02-16 10:28:44 -0800111 const std::string& desc, std::string_view msg)
Matt Spinler2ae60092018-12-06 10:35:36 -0600112{
113 res.result(result);
Ed Tanous14766872022-03-15 10:44:42 -0700114 res.jsonValue["data"]["description"] = desc;
115 res.jsonValue["message"] = msg;
116 res.jsonValue["status"] = "error";
Matt Spinler2ae60092018-12-06 10:35:36 -0600117}
118
Ed Tanousb5a76932020-09-29 16:16:58 -0700119inline void
120 introspectObjects(const std::string& processName,
121 const std::string& objectPath,
122 const std::shared_ptr<bmcweb::AsyncResp>& transaction)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700123{
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700124 if (transaction->res.jsonValue.is_null())
125 {
Ed Tanous14766872022-03-15 10:44:42 -0700126 transaction->res.jsonValue["status"] = "ok";
127 transaction->res.jsonValue["bus_name"] = processName;
128 transaction->res.jsonValue["objects"] = nlohmann::json::array();
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700129 }
130
Ed Tanous1abe55e2018-09-05 08:30:59 -0700131 crow::connections::systemBus->async_method_call(
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700132 [transaction, processName{std::string(processName)},
133 objectPath{std::string(objectPath)}](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800134 const boost::system::error_code& ec,
Ed Tanous81ce6092020-12-17 16:54:55 +0000135 const std::string& introspectXml) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700136 if (ec)
137 {
138 BMCWEB_LOG_ERROR
139 << "Introspect call failed with error: " << ec.message()
140 << " on process: " << processName << " path: " << objectPath
141 << "\n";
142 return;
143 }
144 nlohmann::json::object_t object;
145 object["path"] = objectPath;
Ed Tanous14766872022-03-15 10:44:42 -0700146
Ed Tanous002d39b2022-05-31 08:59:27 -0700147 transaction->res.jsonValue["objects"].push_back(std::move(object));
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700148
Ed Tanous002d39b2022-05-31 08:59:27 -0700149 tinyxml2::XMLDocument doc;
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700150
Ed Tanous002d39b2022-05-31 08:59:27 -0700151 doc.Parse(introspectXml.c_str());
152 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
153 if (pRoot == nullptr)
154 {
155 BMCWEB_LOG_ERROR << "XML document failed to parse " << processName
156 << " " << objectPath << "\n";
157 }
158 else
159 {
160 tinyxml2::XMLElement* node = pRoot->FirstChildElement("node");
161 while (node != nullptr)
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700162 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700163 const char* childPath = node->Attribute("name");
164 if (childPath != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700165 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700166 std::string newpath;
167 if (objectPath != "/")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700168 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700169 newpath += objectPath;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700170 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700171 newpath += std::string("/") + childPath;
172 // introspect the subobjects as well
173 introspectObjects(processName, newpath, transaction);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700174 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700175
176 node = node->NextSiblingElement("node");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700177 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700178 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700179 },
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700180 processName, objectPath, "org.freedesktop.DBus.Introspectable",
Ed Tanous1abe55e2018-09-05 08:30:59 -0700181 "Introspect");
Ed Tanous911ac312017-08-15 09:37:42 -0700182}
Ed Tanous64530012018-02-06 17:08:16 -0800183
Ed Tanous23a21a12020-07-25 04:45:05 +0000184inline void getPropertiesForEnumerate(
185 const std::string& objectPath, const std::string& service,
Ed Tanousb5a76932020-09-29 16:16:58 -0700186 const std::string& interface,
187 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600188{
189 BMCWEB_LOG_DEBUG << "getPropertiesForEnumerate " << objectPath << " "
190 << service << " " << interface;
191
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200192 sdbusplus::asio::getAllProperties(
193 *crow::connections::systemBus, service, objectPath, interface,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800194 [asyncResp, objectPath, service,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800195 interface](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800196 const dbus::utility::DBusPropertiesMap& propertiesList) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700197 if (ec)
198 {
199 BMCWEB_LOG_ERROR << "GetAll on path " << objectPath << " iface "
200 << interface << " service " << service
201 << " failed with code " << ec;
202 return;
203 }
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600204
Ed Tanous002d39b2022-05-31 08:59:27 -0700205 nlohmann::json& dataJson = asyncResp->res.jsonValue["data"];
206 nlohmann::json& objectJson = dataJson[objectPath];
207 if (objectJson.is_null())
208 {
209 objectJson = nlohmann::json::object();
210 }
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600211
Ed Tanous002d39b2022-05-31 08:59:27 -0700212 for (const auto& [name, value] : propertiesList)
213 {
214 nlohmann::json& propertyJson = objectJson[name];
215 std::visit(
216 [&propertyJson](auto&& val) {
217 if constexpr (std::is_same_v<std::decay_t<decltype(val)>,
218 sdbusplus::message::unix_fd>)
219 {
220 propertyJson = val.fd;
221 }
222 else
223 {
Ed Tanousd1a64812021-12-13 12:14:05 -0800224
Ed Tanous002d39b2022-05-31 08:59:27 -0700225 propertyJson = val;
226 }
227 },
228 value);
229 }
Krzysztof Grobelnyc1343bf2022-08-31 13:15:26 +0200230 });
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600231}
232
233// Find any results that weren't picked up by ObjectManagers, to be
234// called after all ObjectManagers are searched for and called.
Ed Tanous23a21a12020-07-25 04:45:05 +0000235inline void findRemainingObjectsForEnumerate(
Ed Tanousb5a76932020-09-29 16:16:58 -0700236 const std::string& objectPath,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800237 const std::shared_ptr<dbus::utility::MapperGetSubTreeResponse>& subtree,
Ed Tanousb5a76932020-09-29 16:16:58 -0700238 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600239{
240 BMCWEB_LOG_DEBUG << "findRemainingObjectsForEnumerate";
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500241 const nlohmann::json& dataJson = asyncResp->res.jsonValue["data"];
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600242
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500243 for (const auto& [path, interface_map] : *subtree)
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600244 {
245 if (path == objectPath)
246 {
247 // An enumerate does not return the target path's properties
248 continue;
249 }
250 if (dataJson.find(path) == dataJson.end())
251 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500252 for (const auto& [service, interfaces] : interface_map)
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600253 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500254 for (const auto& interface : interfaces)
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600255 {
Ed Tanous11ba3972022-07-11 09:50:41 -0700256 if (!interface.starts_with("org.freedesktop.DBus"))
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600257 {
258 getPropertiesForEnumerate(path, service, interface,
259 asyncResp);
260 }
261 }
262 }
263 }
264 }
265}
266
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600267struct InProgressEnumerateData
268{
zhanghch058d1b46d2021-04-01 11:18:24 +0800269 InProgressEnumerateData(
270 const std::string& objectPathIn,
271 const std::shared_ptr<bmcweb::AsyncResp>& asyncRespIn) :
Ed Tanous23a21a12020-07-25 04:45:05 +0000272 objectPath(objectPathIn),
zhanghch058d1b46d2021-04-01 11:18:24 +0800273 asyncResp(asyncRespIn)
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500274 {}
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600275
276 ~InProgressEnumerateData()
277 {
Ed Tanous24b2fe82022-01-06 12:45:54 -0800278 try
279 {
280 findRemainingObjectsForEnumerate(objectPath, subtree, asyncResp);
281 }
282 catch (...)
283 {
284 BMCWEB_LOG_CRITICAL
285 << "findRemainingObjectsForEnumerate threw exception";
286 }
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600287 }
288
Ed Tanousecd6a3a2022-01-07 09:18:40 -0800289 InProgressEnumerateData(const InProgressEnumerateData&) = delete;
290 InProgressEnumerateData(InProgressEnumerateData&&) = delete;
291 InProgressEnumerateData& operator=(const InProgressEnumerateData&) = delete;
292 InProgressEnumerateData& operator=(InProgressEnumerateData&&) = delete;
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600293 const std::string objectPath;
Ed Tanousb9d36b42022-02-26 21:42:46 -0800294 std::shared_ptr<dbus::utility::MapperGetSubTreeResponse> subtree;
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600295 std::shared_ptr<bmcweb::AsyncResp> asyncResp;
296};
297
Ed Tanous23a21a12020-07-25 04:45:05 +0000298inline void getManagedObjectsForEnumerate(
Ed Tanous81ce6092020-12-17 16:54:55 +0000299 const std::string& objectName, const std::string& objectManagerPath,
300 const std::string& connectionName,
Ed Tanousb5a76932020-09-29 16:16:58 -0700301 const std::shared_ptr<InProgressEnumerateData>& transaction)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700302{
Ed Tanous81ce6092020-12-17 16:54:55 +0000303 BMCWEB_LOG_DEBUG << "getManagedObjectsForEnumerate " << objectName
304 << " object_manager_path " << objectManagerPath
305 << " connection_name " << connectionName;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700306 crow::connections::systemBus->async_method_call(
Ed Tanous81ce6092020-12-17 16:54:55 +0000307 [transaction, objectName,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800308 connectionName](const boost::system::error_code& ec,
Ed Tanous81ce6092020-12-17 16:54:55 +0000309 const dbus::utility::ManagedObjectType& objects) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700310 if (ec)
311 {
312 BMCWEB_LOG_ERROR << "GetManagedObjects on path " << objectName
313 << " on connection " << connectionName
314 << " failed with code " << ec;
315 return;
316 }
Ed Tanous64530012018-02-06 17:08:16 -0800317
Ed Tanous002d39b2022-05-31 08:59:27 -0700318 nlohmann::json& dataJson =
319 transaction->asyncResp->res.jsonValue["data"];
Ed Tanous049a0512018-11-01 13:58:42 -0700320
Ed Tanous002d39b2022-05-31 08:59:27 -0700321 for (const auto& objectPath : objects)
322 {
Ed Tanous11ba3972022-07-11 09:50:41 -0700323 if (objectPath.first.str.starts_with(objectName))
Ed Tanous049a0512018-11-01 13:58:42 -0700324 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700325 BMCWEB_LOG_DEBUG << "Reading object " << objectPath.first.str;
326 nlohmann::json& objectJson = dataJson[objectPath.first.str];
327 if (objectJson.is_null())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700328 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700329 objectJson = nlohmann::json::object();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700330 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500331 for (const auto& interface : objectPath.second)
Ed Tanous049a0512018-11-01 13:58:42 -0700332 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700333 for (const auto& property : interface.second)
Ed Tanous049a0512018-11-01 13:58:42 -0700334 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700335 nlohmann::json& propertyJson =
336 objectJson[property.first];
337 std::visit(
338 [&propertyJson](auto&& val) {
339 if constexpr (std::is_same_v<
340 std::decay_t<decltype(val)>,
341 sdbusplus::message::unix_fd>)
342 {
343 propertyJson = val.fd;
344 }
345 else
346 {
347
348 propertyJson = val;
349 }
350 },
351 property.second);
Ed Tanous049a0512018-11-01 13:58:42 -0700352 }
353 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700354 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700355 for (const auto& interface : objectPath.second)
356 {
357 if (interface.first == "org.freedesktop.DBus.ObjectManager")
358 {
359 getManagedObjectsForEnumerate(objectPath.first.str,
360 objectPath.first.str,
361 connectionName, transaction);
362 }
363 }
364 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700365 },
Ed Tanous81ce6092020-12-17 16:54:55 +0000366 connectionName, objectManagerPath, "org.freedesktop.DBus.ObjectManager",
367 "GetManagedObjects");
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700368}
369
Ed Tanous23a21a12020-07-25 04:45:05 +0000370inline void findObjectManagerPathForEnumerate(
Ed Tanous81ce6092020-12-17 16:54:55 +0000371 const std::string& objectName, const std::string& connectionName,
Ed Tanousb5a76932020-09-29 16:16:58 -0700372 const std::shared_ptr<InProgressEnumerateData>& transaction)
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700373{
Ed Tanous81ce6092020-12-17 16:54:55 +0000374 BMCWEB_LOG_DEBUG << "Finding objectmanager for path " << objectName
375 << " on connection:" << connectionName;
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700376 crow::connections::systemBus->async_method_call(
Ed Tanous81ce6092020-12-17 16:54:55 +0000377 [transaction, objectName, connectionName](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -0800378 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800379 const dbus::utility::MapperGetAncestorsResponse& objects) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700380 if (ec)
381 {
382 BMCWEB_LOG_ERROR << "GetAncestors on path " << objectName
383 << " failed with code " << ec;
384 return;
385 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700386
Ed Tanous002d39b2022-05-31 08:59:27 -0700387 for (const auto& pathGroup : objects)
388 {
389 for (const auto& connectionGroup : pathGroup.second)
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700390 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700391 if (connectionGroup.first == connectionName)
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700392 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700393 // Found the object manager path for this resource.
394 getManagedObjectsForEnumerate(objectName, pathGroup.first,
395 connectionName, transaction);
396 return;
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700397 }
398 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700399 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700400 },
401 "xyz.openbmc_project.ObjectMapper",
402 "/xyz/openbmc_project/object_mapper",
Ed Tanous81ce6092020-12-17 16:54:55 +0000403 "xyz.openbmc_project.ObjectMapper", "GetAncestors", objectName,
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500404 std::array<const char*, 1>{"org.freedesktop.DBus.ObjectManager"});
Ed Tanousaa2e59c2018-04-12 12:17:20 -0700405}
Ed Tanous64530012018-02-06 17:08:16 -0800406
Ed Tanous7c091622019-05-23 11:42:36 -0700407// Uses GetObject to add the object info about the target /enumerate path to
408// the results of GetSubTree, as GetSubTree will not return info for the
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600409// target path, and then continues on enumerating the rest of the tree.
Ed Tanousb5a76932020-09-29 16:16:58 -0700410inline void getObjectAndEnumerate(
411 const std::shared_ptr<InProgressEnumerateData>& transaction)
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600412{
George Liu2b731192023-01-11 16:27:13 +0800413 dbus::utility::getDbusObject(
414 transaction->objectPath, {},
415 [transaction](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -0800416 const dbus::utility::MapperGetObject& objects) {
Ed Tanous002d39b2022-05-31 08:59:27 -0700417 if (ec)
418 {
419 BMCWEB_LOG_ERROR << "GetObject for path " << transaction->objectPath
420 << " failed with code " << ec;
421 return;
422 }
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600423
Ed Tanous002d39b2022-05-31 08:59:27 -0700424 BMCWEB_LOG_DEBUG << "GetObject for " << transaction->objectPath
425 << " has " << objects.size() << " entries";
426 if (!objects.empty())
427 {
428 transaction->subtree->emplace_back(transaction->objectPath,
429 objects);
430 }
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600431
Ed Tanous002d39b2022-05-31 08:59:27 -0700432 // Map indicating connection name, and the path where the object
433 // manager exists
434 boost::container::flat_map<std::string, std::string> connections;
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600435
Ed Tanous002d39b2022-05-31 08:59:27 -0700436 for (const auto& object : *(transaction->subtree))
437 {
438 for (const auto& connection : object.second)
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600439 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700440 for (const auto& interface : connection.second)
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600441 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700442 BMCWEB_LOG_DEBUG << connection.first << " has interface "
443 << interface;
444 if (interface == "org.freedesktop.DBus.ObjectManager")
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600445 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700446 BMCWEB_LOG_DEBUG << "found object manager path "
447 << object.first;
Ed Tanousf8fe53e2022-06-30 15:55:45 -0700448 connections[connection.first] = object.first;
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600449 }
450 }
451 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700452 }
453 BMCWEB_LOG_DEBUG << "Got " << connections.size() << " connections";
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600454
Ed Tanous002d39b2022-05-31 08:59:27 -0700455 for (const auto& connection : connections)
456 {
457 // If we already know where the object manager is, we don't
458 // need to search for it, we can call directly in to
459 // getManagedObjects
460 if (!connection.second.empty())
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600461 {
Ed Tanous002d39b2022-05-31 08:59:27 -0700462 getManagedObjectsForEnumerate(transaction->objectPath,
463 connection.second,
464 connection.first, transaction);
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600465 }
Ed Tanous002d39b2022-05-31 08:59:27 -0700466 else
467 {
468 // otherwise we need to find the object manager path
469 // before we can continue
470 findObjectManagerPathForEnumerate(
471 transaction->objectPath, connection.first, transaction);
472 }
473 }
George Liu2b731192023-01-11 16:27:13 +0800474 });
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600475}
Ed Tanous64530012018-02-06 17:08:16 -0800476
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700477// Structure for storing data on an in progress action
Ed Tanous1abe55e2018-09-05 08:30:59 -0700478struct InProgressActionData
479{
Ed Tanous4e23a442022-06-06 09:57:26 -0700480 explicit InProgressActionData(crow::Response& resIn) : res(resIn)
Ed Tanous23a21a12020-07-25 04:45:05 +0000481 {}
Ed Tanous1abe55e2018-09-05 08:30:59 -0700482 ~InProgressActionData()
483 {
Matt Spinler16caaee2019-01-15 11:40:34 -0600484 // Methods could have been called across different owners
485 // and interfaces, where some calls failed and some passed.
486 //
487 // The rules for this are:
488 // * if no method was called - error
489 // * if a method failed and none passed - error
490 // (converse: if at least one method passed - OK)
491 // * for the method output:
492 // * if output processing didn't fail, return the data
493
494 // Only deal with method returns if nothing failed earlier
495 if (res.result() == boost::beast::http::status::ok)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700496 {
Matt Spinler16caaee2019-01-15 11:40:34 -0600497 if (!methodPassed)
498 {
Matt Spinler06b1b632019-06-18 16:09:25 -0500499 if (!methodFailed)
Matt Spinler16caaee2019-01-15 11:40:34 -0600500 {
501 setErrorResponse(res, boost::beast::http::status::not_found,
502 methodNotFoundDesc, notFoundMsg);
503 }
504 }
505 else
506 {
507 if (outputFailed)
508 {
509 setErrorResponse(
510 res, boost::beast::http::status::internal_server_error,
511 "Method output failure", methodOutputFailedMsg);
512 }
513 else
514 {
Ed Tanous14766872022-03-15 10:44:42 -0700515 res.jsonValue["status"] = "ok";
516 res.jsonValue["message"] = "200 OK";
517 res.jsonValue["data"] = methodResponse;
Matt Spinler16caaee2019-01-15 11:40:34 -0600518 }
519 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700520 }
Matt Spinler16caaee2019-01-15 11:40:34 -0600521
Ed Tanous1abe55e2018-09-05 08:30:59 -0700522 res.end();
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700523 }
Ed Tanousecd6a3a2022-01-07 09:18:40 -0800524 InProgressActionData(const InProgressActionData&) = delete;
525 InProgressActionData(InProgressActionData&&) = delete;
526 InProgressActionData& operator=(const InProgressActionData&) = delete;
527 InProgressActionData& operator=(InProgressActionData&&) = delete;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700528
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500529 void setErrorStatus(const std::string& desc)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700530 {
Matt Spinlerc0eb9bd2019-01-09 15:22:30 -0600531 setErrorResponse(res, boost::beast::http::status::bad_request, desc,
532 badReqMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700533 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500534 crow::Response& res;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700535 std::string path;
536 std::string methodName;
Matt Spinlerde818812018-12-11 16:39:20 -0600537 std::string interfaceName;
Matt Spinler16caaee2019-01-15 11:40:34 -0600538 bool methodPassed = false;
539 bool methodFailed = false;
540 bool outputFailed = false;
Matt Spinler39a4e392019-01-15 11:53:13 -0600541 bool convertedToArray = false;
Matt Spinler16caaee2019-01-15 11:40:34 -0600542 nlohmann::json methodResponse;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700543 nlohmann::json arguments;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700544};
545
Ed Tanous23a21a12020-07-25 04:45:05 +0000546inline std::vector<std::string> dbusArgSplit(const std::string& string)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700547{
548 std::vector<std::string> ret;
549 if (string.empty())
550 {
551 return ret;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700552 }
Ed Tanous0f0353b2019-10-24 11:37:51 -0700553 ret.emplace_back("");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700554 int containerDepth = 0;
555
556 for (std::string::const_iterator character = string.begin();
557 character != string.end(); character++)
558 {
559 ret.back() += *character;
560 switch (*character)
561 {
562 case ('a'):
563 break;
564 case ('('):
565 case ('{'):
566 containerDepth++;
567 break;
568 case ('}'):
569 case (')'):
570 containerDepth--;
571 if (containerDepth == 0)
572 {
573 if (character + 1 != string.end())
574 {
Ed Tanous0f0353b2019-10-24 11:37:51 -0700575 ret.emplace_back("");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700576 }
577 }
578 break;
579 default:
580 if (containerDepth == 0)
581 {
582 if (character + 1 != string.end())
583 {
Ed Tanous0f0353b2019-10-24 11:37:51 -0700584 ret.emplace_back("");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700585 }
586 }
587 break;
588 }
589 }
Matt Spinler4ae611d2019-01-11 15:37:06 -0600590
591 return ret;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700592}
593
Ed Tanous81ce6092020-12-17 16:54:55 +0000594inline int convertJsonToDbus(sd_bus_message* m, const std::string& argType,
595 const nlohmann::json& inputJson)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700596{
597 int r = 0;
Ed Tanous71f52d92021-02-19 08:51:17 -0800598 BMCWEB_LOG_DEBUG << "Converting "
599 << inputJson.dump(2, ' ', true,
600 nlohmann::json::error_handler_t::replace)
Ed Tanous81ce6092020-12-17 16:54:55 +0000601 << " to type: " << argType;
602 const std::vector<std::string> argTypes = dbusArgSplit(argType);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700603
Ed Tanous1abe55e2018-09-05 08:30:59 -0700604 // Assume a single object for now.
Ed Tanous81ce6092020-12-17 16:54:55 +0000605 const nlohmann::json* j = &inputJson;
606 nlohmann::json::const_iterator jIt = inputJson.begin();
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700607
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500608 for (const std::string& argCode : argTypes)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700609 {
610 // If we are decoding multiple objects, grab the pointer to the
611 // iterator, and increment it for the next loop
612 if (argTypes.size() > 1)
613 {
Ed Tanous81ce6092020-12-17 16:54:55 +0000614 if (jIt == inputJson.end())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700615 {
616 return -2;
617 }
618 j = &*jIt;
619 jIt++;
620 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500621 const int64_t* intValue = j->get_ptr<const int64_t*>();
622 const std::string* stringValue = j->get_ptr<const std::string*>();
623 const double* doubleValue = j->get_ptr<const double*>();
624 const bool* b = j->get_ptr<const bool*>();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700625 int64_t v = 0;
626 double d = 0.0;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700627
Ed Tanous1abe55e2018-09-05 08:30:59 -0700628 // Do some basic type conversions that make sense. uint can be
629 // converted to int. int and uint can be converted to double
Ed Tanous66664f22019-10-11 13:05:49 -0700630 if (intValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700631 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500632 const uint64_t* uintValue = j->get_ptr<const uint64_t*>();
Ed Tanous66664f22019-10-11 13:05:49 -0700633 if (uintValue != nullptr)
634 {
635 v = static_cast<int64_t>(*uintValue);
636 intValue = &v;
637 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700638 }
Ed Tanous66664f22019-10-11 13:05:49 -0700639 if (doubleValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700640 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500641 const uint64_t* uintValue = j->get_ptr<const uint64_t*>();
Ed Tanous66664f22019-10-11 13:05:49 -0700642 if (uintValue != nullptr)
643 {
644 d = static_cast<double>(*uintValue);
645 doubleValue = &d;
646 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700647 }
Ed Tanous66664f22019-10-11 13:05:49 -0700648 if (doubleValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700649 {
Ed Tanous66664f22019-10-11 13:05:49 -0700650 if (intValue != nullptr)
651 {
652 d = static_cast<double>(*intValue);
653 doubleValue = &d;
654 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700655 }
656
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700657 if (argCode == "s")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700658 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700659 if (stringValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700660 {
661 return -1;
662 }
Ed Tanous271584a2019-07-09 16:24:22 -0700663 r = sd_bus_message_append_basic(
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500664 m, argCode[0], static_cast<const void*>(stringValue->data()));
Ed Tanous1abe55e2018-09-05 08:30:59 -0700665 if (r < 0)
666 {
667 return r;
668 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700669 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700670 else if (argCode == "i")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700671 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700672 if (intValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700673 {
674 return -1;
675 }
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500676 if ((*intValue < std::numeric_limits<int32_t>::lowest()) ||
677 (*intValue > std::numeric_limits<int32_t>::max()))
678 {
679 return -ERANGE;
680 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700681 int32_t i = static_cast<int32_t>(*intValue);
682 r = sd_bus_message_append_basic(m, argCode[0], &i);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700683 if (r < 0)
684 {
685 return r;
686 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700687 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700688 else if (argCode == "b")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700689 {
690 // lots of ways bool could be represented here. Try them all
Ed Tanouse662eae2022-01-25 10:39:19 -0800691 int boolInt = 0;
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700692 if (intValue != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700693 {
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500694 if (*intValue == 1)
695 {
Ed Tanouse662eae2022-01-25 10:39:19 -0800696 boolInt = 1;
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500697 }
698 else if (*intValue == 0)
699 {
Ed Tanouse662eae2022-01-25 10:39:19 -0800700 boolInt = 0;
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500701 }
702 else
703 {
704 return -ERANGE;
705 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700706 }
707 else if (b != nullptr)
708 {
Matt Spinlera2f02632019-01-18 10:15:35 -0600709 boolInt = *b ? 1 : 0;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700710 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700711 else if (stringValue != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700712 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700713 boolInt = boost::istarts_with(*stringValue, "t") ? 1 : 0;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700714 }
715 else
716 {
717 return -1;
718 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700719 r = sd_bus_message_append_basic(m, argCode[0], &boolInt);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700720 if (r < 0)
721 {
722 return r;
723 }
724 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700725 else if (argCode == "n")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700726 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700727 if (intValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700728 {
729 return -1;
730 }
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500731 if ((*intValue < std::numeric_limits<int16_t>::lowest()) ||
732 (*intValue > std::numeric_limits<int16_t>::max()))
733 {
734 return -ERANGE;
735 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700736 int16_t n = static_cast<int16_t>(*intValue);
737 r = sd_bus_message_append_basic(m, argCode[0], &n);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700738 if (r < 0)
739 {
740 return r;
741 }
742 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700743 else if (argCode == "x")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700744 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700745 if (intValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700746 {
747 return -1;
748 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700749 r = sd_bus_message_append_basic(m, argCode[0], intValue);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700750 if (r < 0)
751 {
752 return r;
753 }
754 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700755 else if (argCode == "y")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700756 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500757 const uint64_t* uintValue = j->get_ptr<const uint64_t*>();
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700758 if (uintValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700759 {
760 return -1;
761 }
Ed Tanous23a21a12020-07-25 04:45:05 +0000762 if (*uintValue > std::numeric_limits<uint8_t>::max())
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500763 {
764 return -ERANGE;
765 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700766 uint8_t y = static_cast<uint8_t>(*uintValue);
767 r = sd_bus_message_append_basic(m, argCode[0], &y);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700768 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700769 else if (argCode == "q")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700770 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500771 const uint64_t* uintValue = j->get_ptr<const uint64_t*>();
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700772 if (uintValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700773 {
774 return -1;
775 }
Ed Tanous23a21a12020-07-25 04:45:05 +0000776 if (*uintValue > std::numeric_limits<uint16_t>::max())
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500777 {
778 return -ERANGE;
779 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700780 uint16_t q = static_cast<uint16_t>(*uintValue);
781 r = sd_bus_message_append_basic(m, argCode[0], &q);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700782 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700783 else if (argCode == "u")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700784 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500785 const uint64_t* uintValue = j->get_ptr<const uint64_t*>();
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700786 if (uintValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700787 {
788 return -1;
789 }
Ed Tanous23a21a12020-07-25 04:45:05 +0000790 if (*uintValue > std::numeric_limits<uint32_t>::max())
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500791 {
792 return -ERANGE;
793 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700794 uint32_t u = static_cast<uint32_t>(*uintValue);
795 r = sd_bus_message_append_basic(m, argCode[0], &u);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700796 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700797 else if (argCode == "t")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700798 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500799 const uint64_t* uintValue = j->get_ptr<const uint64_t*>();
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700800 if (uintValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700801 {
802 return -1;
803 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700804 r = sd_bus_message_append_basic(m, argCode[0], uintValue);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700805 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700806 else if (argCode == "d")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700807 {
Adriana Kobylakc66c8592019-08-06 15:08:05 -0500808 if (doubleValue == nullptr)
809 {
810 return -1;
811 }
812 if ((*doubleValue < std::numeric_limits<double>::lowest()) ||
813 (*doubleValue > std::numeric_limits<double>::max()))
814 {
815 return -ERANGE;
816 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700817 sd_bus_message_append_basic(m, argCode[0], doubleValue);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700818 }
Ed Tanous11ba3972022-07-11 09:50:41 -0700819 else if (argCode.starts_with("a"))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700820 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700821 std::string containedType = argCode.substr(1);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700822 r = sd_bus_message_open_container(m, SD_BUS_TYPE_ARRAY,
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700823 containedType.c_str());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700824 if (r < 0)
825 {
826 return r;
827 }
828
Ed Tanous0dfeda62019-10-24 11:21:38 -0700829 for (const auto& it : *j)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700830 {
Ed Tanous0dfeda62019-10-24 11:21:38 -0700831 r = convertJsonToDbus(m, containedType, it);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700832 if (r < 0)
833 {
834 return r;
835 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700836 }
837 sd_bus_message_close_container(m);
838 }
Ed Tanous11ba3972022-07-11 09:50:41 -0700839 else if (argCode.starts_with("v"))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700840 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700841 std::string containedType = argCode.substr(1);
842 BMCWEB_LOG_DEBUG << "variant type: " << argCode
843 << " appending variant of type: " << containedType;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700844 r = sd_bus_message_open_container(m, SD_BUS_TYPE_VARIANT,
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700845 containedType.c_str());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700846 if (r < 0)
847 {
848 return r;
849 }
850
Ed Tanous81ce6092020-12-17 16:54:55 +0000851 r = convertJsonToDbus(m, containedType, inputJson);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700852 if (r < 0)
853 {
854 return r;
855 }
856
857 r = sd_bus_message_close_container(m);
858 if (r < 0)
859 {
860 return r;
861 }
862 }
Ed Tanous11ba3972022-07-11 09:50:41 -0700863 else if (argCode.starts_with("(") && argCode.ends_with(")"))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700864 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700865 std::string containedType = argCode.substr(1, argCode.size() - 1);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700866 r = sd_bus_message_open_container(m, SD_BUS_TYPE_STRUCT,
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700867 containedType.c_str());
Ed Tanousf1eebf02019-03-04 15:57:09 -0800868 if (r < 0)
869 {
870 return r;
871 }
872
Ed Tanous1abe55e2018-09-05 08:30:59 -0700873 nlohmann::json::const_iterator it = j->begin();
Ed Tanous81ce6092020-12-17 16:54:55 +0000874 for (const std::string& argCode2 : dbusArgSplit(argType))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700875 {
876 if (it == j->end())
877 {
878 return -1;
879 }
Ed Tanouscb13a392020-07-25 19:02:03 +0000880 r = convertJsonToDbus(m, argCode2, *it);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700881 if (r < 0)
882 {
883 return r;
884 }
885 it++;
886 }
887 r = sd_bus_message_close_container(m);
888 }
Ed Tanous11ba3972022-07-11 09:50:41 -0700889 else if (argCode.starts_with("{") && argCode.ends_with("}"))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700890 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700891 std::string containedType = argCode.substr(1, argCode.size() - 1);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700892 r = sd_bus_message_open_container(m, SD_BUS_TYPE_DICT_ENTRY,
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700893 containedType.c_str());
Ed Tanousf1eebf02019-03-04 15:57:09 -0800894 if (r < 0)
895 {
896 return r;
897 }
898
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700899 std::vector<std::string> codes = dbusArgSplit(containedType);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700900 if (codes.size() != 2)
901 {
902 return -1;
903 }
Ed Tanous2c70f802020-09-28 14:29:23 -0700904 const std::string& keyType = codes[0];
905 const std::string& valueType = codes[1];
Ed Tanous3174e4d2020-10-07 11:41:22 -0700906 for (const auto& it : j->items())
Ed Tanous1abe55e2018-09-05 08:30:59 -0700907 {
Ed Tanous2c70f802020-09-28 14:29:23 -0700908 r = convertJsonToDbus(m, keyType, it.key());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700909 if (r < 0)
910 {
911 return r;
912 }
913
Ed Tanous2c70f802020-09-28 14:29:23 -0700914 r = convertJsonToDbus(m, valueType, it.value());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700915 if (r < 0)
916 {
917 return r;
918 }
919 }
920 r = sd_bus_message_close_container(m);
921 }
922 else
923 {
924 return -2;
925 }
926 if (r < 0)
927 {
928 return r;
Ed Tanous75db20e2018-07-27 13:44:44 -0700929 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700930
Ed Tanous1abe55e2018-09-05 08:30:59 -0700931 if (argTypes.size() > 1)
932 {
933 jIt++;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700934 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700935 }
Matt Spinler127ea542019-01-14 11:04:28 -0600936
937 return r;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700938}
939
Matt Spinlerd22a7132019-01-14 12:14:30 -0600940template <typename T>
Patrick Williams59d494e2022-07-22 19:26:55 -0500941int readMessageItem(const std::string& typeCode, sdbusplus::message_t& m,
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500942 nlohmann::json& data)
Matt Spinlerd22a7132019-01-14 12:14:30 -0600943{
944 T value;
945
946 int r = sd_bus_message_read_basic(m.get(), typeCode.front(), &value);
947 if (r < 0)
948 {
949 BMCWEB_LOG_ERROR << "sd_bus_message_read_basic on type " << typeCode
950 << " failed!";
951 return r;
952 }
953
954 data = value;
955 return 0;
956}
957
Patrick Williams59d494e2022-07-22 19:26:55 -0500958int convertDBusToJSON(const std::string& returnType, sdbusplus::message_t& m,
959 nlohmann::json& response);
Matt Spinler6df8f992019-01-14 12:47:47 -0600960
Ed Tanous23a21a12020-07-25 04:45:05 +0000961inline int readDictEntryFromMessage(const std::string& typeCode,
Patrick Williams59d494e2022-07-22 19:26:55 -0500962 sdbusplus::message_t& m,
Ed Tanous23a21a12020-07-25 04:45:05 +0000963 nlohmann::json& object)
Matt Spinler6df8f992019-01-14 12:47:47 -0600964{
965 std::vector<std::string> types = dbusArgSplit(typeCode);
966 if (types.size() != 2)
967 {
968 BMCWEB_LOG_ERROR << "wrong number contained types in dictionary: "
969 << types.size();
970 return -1;
971 }
972
973 int r = sd_bus_message_enter_container(m.get(), SD_BUS_TYPE_DICT_ENTRY,
974 typeCode.c_str());
975 if (r < 0)
976 {
977 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container with rc " << r;
978 return r;
979 }
980
981 nlohmann::json key;
982 r = convertDBusToJSON(types[0], m, key);
983 if (r < 0)
984 {
985 return r;
986 }
987
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500988 const std::string* keyPtr = key.get_ptr<const std::string*>();
Matt Spinler6df8f992019-01-14 12:47:47 -0600989 if (keyPtr == nullptr)
990 {
991 // json doesn't support non-string keys. If we hit this condition,
992 // convert the result to a string so we can proceed
Ed Tanous71f52d92021-02-19 08:51:17 -0800993 key = key.dump(2, ' ', true, nlohmann::json::error_handler_t::replace);
Gunnar Mills1214b7e2020-06-04 10:11:30 -0500994 keyPtr = key.get_ptr<const std::string*>();
Ed Tanous7c091622019-05-23 11:42:36 -0700995 // in theory this can't fail now, but lets be paranoid about it
996 // anyway
Matt Spinler6df8f992019-01-14 12:47:47 -0600997 if (keyPtr == nullptr)
998 {
999 return -1;
1000 }
1001 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001002 nlohmann::json& value = object[*keyPtr];
Matt Spinler6df8f992019-01-14 12:47:47 -06001003
1004 r = convertDBusToJSON(types[1], m, value);
1005 if (r < 0)
1006 {
1007 return r;
1008 }
1009
1010 r = sd_bus_message_exit_container(m.get());
1011 if (r < 0)
1012 {
1013 BMCWEB_LOG_ERROR << "sd_bus_message_exit_container failed";
1014 return r;
1015 }
1016
1017 return 0;
1018}
1019
Ed Tanous23a21a12020-07-25 04:45:05 +00001020inline int readArrayFromMessage(const std::string& typeCode,
Patrick Williams59d494e2022-07-22 19:26:55 -05001021 sdbusplus::message_t& m, nlohmann::json& data)
Matt Spinler6df8f992019-01-14 12:47:47 -06001022{
1023 if (typeCode.size() < 2)
1024 {
1025 BMCWEB_LOG_ERROR << "Type code " << typeCode
1026 << " too small for an array";
1027 return -1;
1028 }
1029
1030 std::string containedType = typeCode.substr(1);
1031
1032 int r = sd_bus_message_enter_container(m.get(), SD_BUS_TYPE_ARRAY,
1033 containedType.c_str());
1034 if (r < 0)
1035 {
1036 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container failed with rc "
1037 << r;
1038 return r;
1039 }
1040
Ed Tanous11ba3972022-07-11 09:50:41 -07001041 bool dict = containedType.starts_with("{") && containedType.ends_with("}");
Matt Spinler6df8f992019-01-14 12:47:47 -06001042
1043 if (dict)
1044 {
1045 // Remove the { }
1046 containedType = containedType.substr(1, containedType.size() - 2);
1047 data = nlohmann::json::object();
1048 }
1049 else
1050 {
1051 data = nlohmann::json::array();
1052 }
1053
1054 while (true)
1055 {
Ed Tanouse662eae2022-01-25 10:39:19 -08001056 r = sd_bus_message_at_end(m.get(), 0);
Matt Spinler6df8f992019-01-14 12:47:47 -06001057 if (r < 0)
1058 {
1059 BMCWEB_LOG_ERROR << "sd_bus_message_at_end failed";
1060 return r;
1061 }
1062
1063 if (r > 0)
1064 {
1065 break;
1066 }
1067
1068 // Dictionaries are only ever seen in an array
1069 if (dict)
1070 {
1071 r = readDictEntryFromMessage(containedType, m, data);
1072 if (r < 0)
1073 {
1074 return r;
1075 }
1076 }
1077 else
1078 {
1079 data.push_back(nlohmann::json());
1080
1081 r = convertDBusToJSON(containedType, m, data.back());
1082 if (r < 0)
1083 {
1084 return r;
1085 }
1086 }
1087 }
1088
1089 r = sd_bus_message_exit_container(m.get());
1090 if (r < 0)
1091 {
1092 BMCWEB_LOG_ERROR << "sd_bus_message_exit_container failed";
1093 return r;
1094 }
1095
1096 return 0;
1097}
1098
Ed Tanous23a21a12020-07-25 04:45:05 +00001099inline int readStructFromMessage(const std::string& typeCode,
Patrick Williams59d494e2022-07-22 19:26:55 -05001100 sdbusplus::message_t& m, nlohmann::json& data)
Matt Spinler75c6c672019-01-14 13:01:46 -06001101{
1102 if (typeCode.size() < 3)
1103 {
1104 BMCWEB_LOG_ERROR << "Type code " << typeCode
1105 << " too small for a struct";
1106 return -1;
1107 }
1108
1109 std::string containedTypes = typeCode.substr(1, typeCode.size() - 2);
1110 std::vector<std::string> types = dbusArgSplit(containedTypes);
1111
1112 int r = sd_bus_message_enter_container(m.get(), SD_BUS_TYPE_STRUCT,
1113 containedTypes.c_str());
1114 if (r < 0)
1115 {
1116 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container failed with rc "
1117 << r;
1118 return r;
1119 }
1120
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001121 for (const std::string& type : types)
Matt Spinler75c6c672019-01-14 13:01:46 -06001122 {
1123 data.push_back(nlohmann::json());
1124 r = convertDBusToJSON(type, m, data.back());
1125 if (r < 0)
1126 {
1127 return r;
1128 }
1129 }
1130
1131 r = sd_bus_message_exit_container(m.get());
1132 if (r < 0)
1133 {
1134 BMCWEB_LOG_ERROR << "sd_bus_message_exit_container failed";
1135 return r;
1136 }
1137 return 0;
1138}
1139
Patrick Williams59d494e2022-07-22 19:26:55 -05001140inline int readVariantFromMessage(sdbusplus::message_t& m, nlohmann::json& data)
Matt Spinler89c19702019-01-14 13:13:00 -06001141{
Ed Tanous543f4402022-01-06 13:12:53 -08001142 const char* containerType = nullptr;
Ed Tanous99131cd2019-10-24 11:12:47 -07001143 int r = sd_bus_message_peek_type(m.get(), nullptr, &containerType);
Matt Spinler89c19702019-01-14 13:13:00 -06001144 if (r < 0)
1145 {
1146 BMCWEB_LOG_ERROR << "sd_bus_message_peek_type failed";
1147 return r;
1148 }
1149
1150 r = sd_bus_message_enter_container(m.get(), SD_BUS_TYPE_VARIANT,
1151 containerType);
1152 if (r < 0)
1153 {
1154 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container failed with rc "
1155 << r;
1156 return r;
1157 }
1158
1159 r = convertDBusToJSON(containerType, m, data);
1160 if (r < 0)
1161 {
1162 return r;
1163 }
1164
1165 r = sd_bus_message_exit_container(m.get());
1166 if (r < 0)
1167 {
1168 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container failed";
1169 return r;
1170 }
1171
1172 return 0;
1173}
1174
Ed Tanous23a21a12020-07-25 04:45:05 +00001175inline int convertDBusToJSON(const std::string& returnType,
Patrick Williams59d494e2022-07-22 19:26:55 -05001176 sdbusplus::message_t& m, nlohmann::json& response)
Matt Spinler16caaee2019-01-15 11:40:34 -06001177{
Matt Spinlerd22a7132019-01-14 12:14:30 -06001178 int r = 0;
1179 const std::vector<std::string> returnTypes = dbusArgSplit(returnType);
1180
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001181 for (const std::string& typeCode : returnTypes)
Matt Spinlerd22a7132019-01-14 12:14:30 -06001182 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001183 nlohmann::json* thisElement = &response;
Matt Spinlerf39420c2019-01-30 12:57:18 -06001184 if (returnTypes.size() > 1)
Matt Spinlerd22a7132019-01-14 12:14:30 -06001185 {
1186 response.push_back(nlohmann::json{});
Matt Spinlerf39420c2019-01-30 12:57:18 -06001187 thisElement = &response.back();
Matt Spinlerd22a7132019-01-14 12:14:30 -06001188 }
1189
Ed Tanousd4d25792020-09-29 15:15:03 -07001190 if (typeCode == "s" || typeCode == "g" || typeCode == "o")
Matt Spinlerd22a7132019-01-14 12:14:30 -06001191 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001192 r = readMessageItem<char*>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001193 if (r < 0)
1194 {
1195 return r;
1196 }
1197 }
1198 else if (typeCode == "b")
1199 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001200 r = readMessageItem<int>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001201 if (r < 0)
1202 {
1203 return r;
1204 }
1205
Matt Spinlerf39420c2019-01-30 12:57:18 -06001206 *thisElement = static_cast<bool>(thisElement->get<int>());
Matt Spinlerd22a7132019-01-14 12:14:30 -06001207 }
1208 else if (typeCode == "u")
1209 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001210 r = readMessageItem<uint32_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001211 if (r < 0)
1212 {
1213 return r;
1214 }
1215 }
1216 else if (typeCode == "i")
1217 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001218 r = readMessageItem<int32_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001219 if (r < 0)
1220 {
1221 return r;
1222 }
1223 }
1224 else if (typeCode == "x")
1225 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001226 r = readMessageItem<int64_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001227 if (r < 0)
1228 {
1229 return r;
1230 }
1231 }
1232 else if (typeCode == "t")
1233 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001234 r = readMessageItem<uint64_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001235 if (r < 0)
1236 {
1237 return r;
1238 }
1239 }
1240 else if (typeCode == "n")
1241 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001242 r = readMessageItem<int16_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001243 if (r < 0)
1244 {
1245 return r;
1246 }
1247 }
1248 else if (typeCode == "q")
1249 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001250 r = readMessageItem<uint16_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001251 if (r < 0)
1252 {
1253 return r;
1254 }
1255 }
1256 else if (typeCode == "y")
1257 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001258 r = readMessageItem<uint8_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001259 if (r < 0)
1260 {
1261 return r;
1262 }
1263 }
1264 else if (typeCode == "d")
1265 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001266 r = readMessageItem<double>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001267 if (r < 0)
1268 {
1269 return r;
1270 }
1271 }
1272 else if (typeCode == "h")
1273 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001274 r = readMessageItem<int>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001275 if (r < 0)
1276 {
1277 return r;
1278 }
1279 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001280 else if (typeCode.starts_with("a"))
Matt Spinler6df8f992019-01-14 12:47:47 -06001281 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001282 r = readArrayFromMessage(typeCode, m, *thisElement);
Matt Spinler6df8f992019-01-14 12:47:47 -06001283 if (r < 0)
1284 {
1285 return r;
1286 }
1287 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001288 else if (typeCode.starts_with("(") && typeCode.ends_with(")"))
Matt Spinler75c6c672019-01-14 13:01:46 -06001289 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001290 r = readStructFromMessage(typeCode, m, *thisElement);
Matt Spinler75c6c672019-01-14 13:01:46 -06001291 if (r < 0)
1292 {
1293 return r;
1294 }
1295 }
Ed Tanous11ba3972022-07-11 09:50:41 -07001296 else if (typeCode.starts_with("v"))
Matt Spinler89c19702019-01-14 13:13:00 -06001297 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001298 r = readVariantFromMessage(m, *thisElement);
Matt Spinler89c19702019-01-14 13:13:00 -06001299 if (r < 0)
1300 {
1301 return r;
1302 }
1303 }
Matt Spinlerd22a7132019-01-14 12:14:30 -06001304 else
1305 {
Matt Spinlerd22a7132019-01-14 12:14:30 -06001306 BMCWEB_LOG_ERROR << "Invalid D-Bus signature type " << typeCode;
1307 return -2;
1308 }
1309 }
1310
Matt Spinler16caaee2019-01-15 11:40:34 -06001311 return 0;
1312}
1313
Ed Tanousb5a76932020-09-29 16:16:58 -07001314inline void handleMethodResponse(
1315 const std::shared_ptr<InProgressActionData>& transaction,
Patrick Williams59d494e2022-07-22 19:26:55 -05001316 sdbusplus::message_t& m, const std::string& returnType)
Matt Spinler16caaee2019-01-15 11:40:34 -06001317{
Matt Spinler39a4e392019-01-15 11:53:13 -06001318 nlohmann::json data;
1319
1320 int r = convertDBusToJSON(returnType, m, data);
1321 if (r < 0)
1322 {
1323 transaction->outputFailed = true;
1324 return;
1325 }
1326
1327 if (data.is_null())
1328 {
1329 return;
1330 }
1331
1332 if (transaction->methodResponse.is_null())
1333 {
1334 transaction->methodResponse = std::move(data);
1335 return;
1336 }
1337
1338 // If they're both dictionaries or arrays, merge into one.
1339 // Otherwise, make the results an array with every result
1340 // an entry. Could also just fail in that case, but it
1341 // seems better to get the data back somehow.
1342
1343 if (transaction->methodResponse.is_object() && data.is_object())
1344 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001345 for (const auto& obj : data.items())
Matt Spinler39a4e392019-01-15 11:53:13 -06001346 {
1347 // Note: Will overwrite the data for a duplicate key
1348 transaction->methodResponse.emplace(obj.key(),
1349 std::move(obj.value()));
1350 }
1351 return;
1352 }
1353
1354 if (transaction->methodResponse.is_array() && data.is_array())
1355 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001356 for (auto& obj : data)
Matt Spinler39a4e392019-01-15 11:53:13 -06001357 {
1358 transaction->methodResponse.push_back(std::move(obj));
1359 }
1360 return;
1361 }
1362
1363 if (!transaction->convertedToArray)
1364 {
1365 // They are different types. May as well turn them into an array
1366 nlohmann::json j = std::move(transaction->methodResponse);
1367 transaction->methodResponse = nlohmann::json::array();
1368 transaction->methodResponse.push_back(std::move(j));
1369 transaction->methodResponse.push_back(std::move(data));
1370 transaction->convertedToArray = true;
1371 }
1372 else
1373 {
1374 transaction->methodResponse.push_back(std::move(data));
1375 }
Matt Spinler16caaee2019-01-15 11:40:34 -06001376}
1377
Ed Tanousb5a76932020-09-29 16:16:58 -07001378inline void findActionOnInterface(
1379 const std::shared_ptr<InProgressActionData>& transaction,
1380 const std::string& connectionName)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001381{
1382 BMCWEB_LOG_DEBUG << "findActionOnInterface for connection "
1383 << connectionName;
1384 crow::connections::systemBus->async_method_call(
1385 [transaction, connectionName{std::string(connectionName)}](
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001386 const boost::system::error_code& ec,
Ed Tanous81ce6092020-12-17 16:54:55 +00001387 const std::string& introspectXml) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001388 BMCWEB_LOG_DEBUG << "got xml:\n " << introspectXml;
1389 if (ec)
1390 {
1391 BMCWEB_LOG_ERROR
1392 << "Introspect call failed with error: " << ec.message()
1393 << " on process: " << connectionName << "\n";
1394 return;
1395 }
1396 tinyxml2::XMLDocument doc;
Matt Spinler318bd892019-01-15 09:59:20 -06001397
Ed Tanous002d39b2022-05-31 08:59:27 -07001398 doc.Parse(introspectXml.data(), introspectXml.size());
1399 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
1400 if (pRoot == nullptr)
1401 {
1402 BMCWEB_LOG_ERROR << "XML document failed to parse "
1403 << connectionName << "\n";
1404 return;
1405 }
1406 tinyxml2::XMLElement* interfaceNode =
1407 pRoot->FirstChildElement("interface");
1408 while (interfaceNode != nullptr)
1409 {
1410 const char* thisInterfaceName = interfaceNode->Attribute("name");
1411 if (thisInterfaceName != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001412 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001413 if (!transaction->interfaceName.empty() &&
1414 (transaction->interfaceName != thisInterfaceName))
Ed Tanous1abe55e2018-09-05 08:30:59 -07001415 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001416 interfaceNode =
1417 interfaceNode->NextSiblingElement("interface");
1418 continue;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001419 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001420
1421 tinyxml2::XMLElement* methodNode =
1422 interfaceNode->FirstChildElement("method");
1423 while (methodNode != nullptr)
1424 {
1425 const char* thisMethodName = methodNode->Attribute("name");
1426 BMCWEB_LOG_DEBUG << "Found method: " << thisMethodName;
1427 if (thisMethodName != nullptr &&
1428 thisMethodName == transaction->methodName)
1429 {
1430 BMCWEB_LOG_DEBUG << "Found method named "
1431 << thisMethodName << " on interface "
1432 << thisInterfaceName;
Patrick Williams59d494e2022-07-22 19:26:55 -05001433 sdbusplus::message_t m =
Ed Tanous002d39b2022-05-31 08:59:27 -07001434 crow::connections::systemBus->new_method_call(
1435 connectionName.c_str(),
1436 transaction->path.c_str(), thisInterfaceName,
1437 transaction->methodName.c_str());
1438
1439 tinyxml2::XMLElement* argumentNode =
1440 methodNode->FirstChildElement("arg");
1441
1442 std::string returnType;
1443
1444 // Find the output type
1445 while (argumentNode != nullptr)
1446 {
1447 const char* argDirection =
1448 argumentNode->Attribute("direction");
1449 const char* argType =
1450 argumentNode->Attribute("type");
1451 if (argDirection != nullptr && argType != nullptr &&
1452 std::string(argDirection) == "out")
1453 {
1454 returnType = argType;
1455 break;
1456 }
1457 argumentNode =
1458 argumentNode->NextSiblingElement("arg");
1459 }
1460
Nan Zhoub2ec0ce2022-06-02 23:57:38 +00001461 auto argIt = transaction->arguments.begin();
Ed Tanous002d39b2022-05-31 08:59:27 -07001462
1463 argumentNode = methodNode->FirstChildElement("arg");
1464
1465 while (argumentNode != nullptr)
1466 {
1467 const char* argDirection =
1468 argumentNode->Attribute("direction");
1469 const char* argType =
1470 argumentNode->Attribute("type");
1471 if (argDirection != nullptr && argType != nullptr &&
1472 std::string(argDirection) == "in")
1473 {
1474 if (argIt == transaction->arguments.end())
1475 {
1476 transaction->setErrorStatus(
1477 "Invalid method args");
1478 return;
1479 }
1480 if (convertJsonToDbus(m.get(),
1481 std::string(argType),
1482 *argIt) < 0)
1483 {
1484 transaction->setErrorStatus(
1485 "Invalid method arg type");
1486 return;
1487 }
1488
1489 argIt++;
1490 }
1491 argumentNode =
1492 argumentNode->NextSiblingElement("arg");
1493 }
1494
1495 crow::connections::systemBus->async_send(
1496 m,
1497 [transaction,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001498 returnType](const boost::system::error_code& ec2,
Patrick Williams59d494e2022-07-22 19:26:55 -05001499 sdbusplus::message_t& m2) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001500 if (ec2)
1501 {
1502 transaction->methodFailed = true;
1503 const sd_bus_error* e = m2.get_error();
1504
1505 if (e != nullptr)
1506 {
1507 setErrorResponse(
1508 transaction->res,
1509 boost::beast::http::status::bad_request,
1510 e->name, e->message);
1511 }
1512 else
1513 {
1514 setErrorResponse(
1515 transaction->res,
1516 boost::beast::http::status::bad_request,
1517 "Method call failed", methodFailedMsg);
1518 }
1519 return;
1520 }
1521 transaction->methodPassed = true;
1522
1523 handleMethodResponse(transaction, m2, returnType);
1524 });
1525 break;
1526 }
1527 methodNode = methodNode->NextSiblingElement("method");
1528 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001529 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001530 interfaceNode = interfaceNode->NextSiblingElement("interface");
1531 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001532 },
1533 connectionName, transaction->path,
1534 "org.freedesktop.DBus.Introspectable", "Introspect");
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001535}
1536
zhanghch058d1b46d2021-04-01 11:18:24 +08001537inline void handleAction(const crow::Request& req,
1538 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous23a21a12020-07-25 04:45:05 +00001539 const std::string& objectPath,
1540 const std::string& methodName)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001541{
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001542 BMCWEB_LOG_DEBUG << "handleAction on path: " << objectPath << " and method "
1543 << methodName;
Ed Tanous1aa0c2b2022-02-08 12:24:30 +01001544 nlohmann::json requestDbusData;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001545
Ed Tanous1aa0c2b2022-02-08 12:24:30 +01001546 JsonParseResult ret = parseRequestAsJson(req, requestDbusData);
1547 if (ret == JsonParseResult::BadContentType)
1548 {
1549 setErrorResponse(asyncResp->res,
1550 boost::beast::http::status::unsupported_media_type,
1551 invalidContentType, unsupportedMediaMsg);
1552 return;
1553 }
1554 if (ret != JsonParseResult::Success)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001555 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001556 setErrorResponse(asyncResp->res,
1557 boost::beast::http::status::bad_request, noJsonDesc,
1558 badReqMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001559 return;
1560 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001561 nlohmann::json::iterator data = requestDbusData.find("data");
1562 if (data == requestDbusData.end())
1563 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001564 setErrorResponse(asyncResp->res,
1565 boost::beast::http::status::bad_request, noJsonDesc,
1566 badReqMsg);
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001567 return;
1568 }
1569
1570 if (!data->is_array())
Ed Tanous1abe55e2018-09-05 08:30:59 -07001571 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001572 setErrorResponse(asyncResp->res,
1573 boost::beast::http::status::bad_request, noJsonDesc,
1574 badReqMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001575 return;
1576 }
zhanghch058d1b46d2021-04-01 11:18:24 +08001577 auto transaction = std::make_shared<InProgressActionData>(asyncResp->res);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001578
1579 transaction->path = objectPath;
1580 transaction->methodName = methodName;
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001581 transaction->arguments = std::move(*data);
George Liu2b731192023-01-11 16:27:13 +08001582 dbus::utility::getDbusObject(
1583 objectPath, {},
Ed Tanous1abe55e2018-09-05 08:30:59 -07001584 [transaction](
George Liu2b731192023-01-11 16:27:13 +08001585 const boost::system::error_code& ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001586 const std::vector<std::pair<std::string, std::vector<std::string>>>&
1587 interfaceNames) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001588 if (ec || interfaceNames.empty())
1589 {
1590 BMCWEB_LOG_ERROR << "Can't find object";
1591 setErrorResponse(transaction->res,
1592 boost::beast::http::status::not_found,
1593 notFoundDesc, notFoundMsg);
1594 return;
1595 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001596
Ed Tanous002d39b2022-05-31 08:59:27 -07001597 BMCWEB_LOG_DEBUG << "GetObject returned " << interfaceNames.size()
1598 << " object(s)";
Ed Tanous1abe55e2018-09-05 08:30:59 -07001599
Ed Tanous002d39b2022-05-31 08:59:27 -07001600 for (const std::pair<std::string, std::vector<std::string>>& object :
1601 interfaceNames)
1602 {
1603 findActionOnInterface(transaction, object.first);
1604 }
George Liu2b731192023-01-11 16:27:13 +08001605 });
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001606}
1607
zhanghch058d1b46d2021-04-01 11:18:24 +08001608inline void handleDelete(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1609 const std::string& objectPath)
Matt Spinlerde818812018-12-11 16:39:20 -06001610{
1611 BMCWEB_LOG_DEBUG << "handleDelete on path: " << objectPath;
1612
George Liu2b731192023-01-11 16:27:13 +08001613 dbus::utility::getDbusObject(
1614 objectPath, {},
zhanghch058d1b46d2021-04-01 11:18:24 +08001615 [asyncResp, objectPath](
George Liu2b731192023-01-11 16:27:13 +08001616 const boost::system::error_code& ec,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001617 const std::vector<std::pair<std::string, std::vector<std::string>>>&
1618 interfaceNames) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001619 if (ec || interfaceNames.empty())
1620 {
1621 BMCWEB_LOG_ERROR << "Can't find object";
1622 setErrorResponse(asyncResp->res,
1623 boost::beast::http::status::method_not_allowed,
1624 methodNotAllowedDesc, methodNotAllowedMsg);
1625 return;
1626 }
Matt Spinlerde818812018-12-11 16:39:20 -06001627
Ed Tanous002d39b2022-05-31 08:59:27 -07001628 auto transaction =
1629 std::make_shared<InProgressActionData>(asyncResp->res);
1630 transaction->path = objectPath;
1631 transaction->methodName = "Delete";
1632 transaction->interfaceName = "xyz.openbmc_project.Object.Delete";
Matt Spinlerde818812018-12-11 16:39:20 -06001633
Ed Tanous002d39b2022-05-31 08:59:27 -07001634 for (const std::pair<std::string, std::vector<std::string>>& object :
1635 interfaceNames)
1636 {
1637 findActionOnInterface(transaction, object.first);
1638 }
George Liu2b731192023-01-11 16:27:13 +08001639 });
Matt Spinlerde818812018-12-11 16:39:20 -06001640}
1641
zhanghch058d1b46d2021-04-01 11:18:24 +08001642inline void handleList(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1643 const std::string& objectPath, int32_t depth = 0)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001644{
George Liu7a1dbc42022-12-07 16:03:22 +08001645 dbus::utility::getSubTreePaths(
1646 objectPath, depth, {},
Ed Tanousb9d36b42022-02-26 21:42:46 -08001647 [asyncResp](
George Liu7a1dbc42022-12-07 16:03:22 +08001648 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001649 const dbus::utility::MapperGetSubTreePathsResponse& objectPaths) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001650 if (ec)
1651 {
1652 setErrorResponse(asyncResp->res,
1653 boost::beast::http::status::not_found,
1654 notFoundDesc, notFoundMsg);
1655 }
1656 else
1657 {
1658 asyncResp->res.jsonValue["status"] = "ok";
1659 asyncResp->res.jsonValue["message"] = "200 OK";
1660 asyncResp->res.jsonValue["data"] = objectPaths;
1661 }
George Liu7a1dbc42022-12-07 16:03:22 +08001662 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07001663}
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001664
zhanghch058d1b46d2021-04-01 11:18:24 +08001665inline void handleEnumerate(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1666 const std::string& objectPath)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001667{
Ed Tanous049a0512018-11-01 13:58:42 -07001668 BMCWEB_LOG_DEBUG << "Doing enumerate on " << objectPath;
Ed Tanous049a0512018-11-01 13:58:42 -07001669
Ed Tanous14766872022-03-15 10:44:42 -07001670 asyncResp->res.jsonValue["message"] = "200 OK";
1671 asyncResp->res.jsonValue["status"] = "ok";
1672 asyncResp->res.jsonValue["data"] = nlohmann::json::object();
Ed Tanous049a0512018-11-01 13:58:42 -07001673
George Liue99073f2022-12-09 11:06:16 +08001674 dbus::utility::getSubTree(
1675 objectPath, 0, {},
Ed Tanousb9d36b42022-02-26 21:42:46 -08001676 [objectPath, asyncResp](
George Liue99073f2022-12-09 11:06:16 +08001677 const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001678 const dbus::utility::MapperGetSubTreeResponse& objectNames) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001679 auto transaction =
1680 std::make_shared<InProgressEnumerateData>(objectPath, asyncResp);
Matt Spinler3ae4ba72018-12-05 14:01:22 -06001681
Ed Tanous002d39b2022-05-31 08:59:27 -07001682 transaction->subtree =
1683 std::make_shared<dbus::utility::MapperGetSubTreeResponse>(
1684 objectNames);
Matt Spinler3ae4ba72018-12-05 14:01:22 -06001685
Ed Tanous002d39b2022-05-31 08:59:27 -07001686 if (ec)
1687 {
1688 BMCWEB_LOG_ERROR << "GetSubTree failed on "
1689 << transaction->objectPath;
1690 setErrorResponse(transaction->asyncResp->res,
1691 boost::beast::http::status::not_found,
1692 notFoundDesc, notFoundMsg);
1693 return;
1694 }
Ed Tanous64530012018-02-06 17:08:16 -08001695
Ed Tanous002d39b2022-05-31 08:59:27 -07001696 // Add the data for the path passed in to the results
1697 // as if GetSubTree returned it, and continue on enumerating
1698 getObjectAndEnumerate(transaction);
George Liue99073f2022-12-09 11:06:16 +08001699 });
Ed Tanous64530012018-02-06 17:08:16 -08001700}
Ed Tanous911ac312017-08-15 09:37:42 -07001701
zhanghch058d1b46d2021-04-01 11:18:24 +08001702inline void handleGet(const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
1703 std::string& objectPath, std::string& destProperty)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001704{
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001705 BMCWEB_LOG_DEBUG << "handleGet: " << objectPath << " prop:" << destProperty;
1706 std::shared_ptr<std::string> propertyName =
Ed Tanous1abe55e2018-09-05 08:30:59 -07001707 std::make_shared<std::string>(std::move(destProperty));
Ed Tanous75db20e2018-07-27 13:44:44 -07001708
Ed Tanous1abe55e2018-09-05 08:30:59 -07001709 std::shared_ptr<std::string> path =
1710 std::make_shared<std::string>(std::move(objectPath));
Ed Tanous75db20e2018-07-27 13:44:44 -07001711
George Liu2b731192023-01-11 16:27:13 +08001712 dbus::utility::getDbusObject(
1713 *path, {},
Ed Tanousb9d36b42022-02-26 21:42:46 -08001714 [asyncResp, path,
George Liu2b731192023-01-11 16:27:13 +08001715 propertyName](const boost::system::error_code& ec,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001716 const dbus::utility::MapperGetObject& objectNames) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001717 if (ec || objectNames.empty())
1718 {
1719 setErrorResponse(asyncResp->res,
1720 boost::beast::http::status::not_found,
1721 notFoundDesc, notFoundMsg);
1722 return;
1723 }
1724 std::shared_ptr<nlohmann::json> response =
1725 std::make_shared<nlohmann::json>(nlohmann::json::object());
1726 // The mapper should never give us an empty interface names
1727 // list, but check anyway
1728 for (const std::pair<std::string, std::vector<std::string>>&
1729 connection : objectNames)
1730 {
1731 const std::vector<std::string>& interfaceNames = connection.second;
1732
1733 if (interfaceNames.empty())
Ed Tanous1abe55e2018-09-05 08:30:59 -07001734 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001735 setErrorResponse(asyncResp->res,
1736 boost::beast::http::status::not_found,
Matt Spinlerdc2f9f12018-12-06 13:53:53 -06001737 notFoundDesc, notFoundMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001738 return;
1739 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001740
1741 for (const std::string& interface : interfaceNames)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001742 {
Patrick Williams59d494e2022-07-22 19:26:55 -05001743 sdbusplus::message_t m =
Ed Tanous002d39b2022-05-31 08:59:27 -07001744 crow::connections::systemBus->new_method_call(
1745 connection.first.c_str(), path->c_str(),
1746 "org.freedesktop.DBus.Properties", "GetAll");
1747 m.append(interface);
1748 crow::connections::systemBus->async_send(
1749 m, [asyncResp, response,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001750 propertyName](const boost::system::error_code& ec2,
Patrick Williams59d494e2022-07-22 19:26:55 -05001751 sdbusplus::message_t& msg) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001752 if (ec2)
1753 {
1754 BMCWEB_LOG_ERROR << "Bad dbus request error: "
1755 << ec2;
1756 }
1757 else
1758 {
1759 nlohmann::json properties;
1760 int r = convertDBusToJSON("a{sv}", msg, properties);
1761 if (r < 0)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001762 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001763 BMCWEB_LOG_ERROR << "convertDBusToJSON failed";
Ed Tanous1abe55e2018-09-05 08:30:59 -07001764 }
1765 else
1766 {
Patrick Williams62bafc02022-09-08 17:35:35 -05001767 for (const auto& prop : properties.items())
Ed Tanous1abe55e2018-09-05 08:30:59 -07001768 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001769 // if property name is empty, or
1770 // matches our search query, add it
1771 // to the response json
Ed Tanous1abe55e2018-09-05 08:30:59 -07001772
Ed Tanous002d39b2022-05-31 08:59:27 -07001773 if (propertyName->empty())
1774 {
1775 (*response)[prop.key()] =
1776 std::move(prop.value());
1777 }
1778 else if (prop.key() == *propertyName)
1779 {
1780 *response = std::move(prop.value());
Ed Tanous1abe55e2018-09-05 08:30:59 -07001781 }
1782 }
1783 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001784 }
1785 if (response.use_count() == 1)
1786 {
1787 if (!propertyName->empty() && response->empty())
Ed Tanous1abe55e2018-09-05 08:30:59 -07001788 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001789 setErrorResponse(
1790 asyncResp->res,
1791 boost::beast::http::status::not_found,
1792 propNotFoundDesc, notFoundMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001793 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001794 else
1795 {
1796 asyncResp->res.jsonValue["status"] = "ok";
1797 asyncResp->res.jsonValue["message"] = "200 OK";
1798 asyncResp->res.jsonValue["data"] = *response;
1799 }
1800 }
1801 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07001802 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001803 }
George Liu2b731192023-01-11 16:27:13 +08001804 });
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001805}
1806
Ed Tanous1abe55e2018-09-05 08:30:59 -07001807struct AsyncPutRequest
1808{
Ed Tanous4e23a442022-06-06 09:57:26 -07001809 explicit AsyncPutRequest(const std::shared_ptr<bmcweb::AsyncResp>& resIn) :
zhanghch058d1b46d2021-04-01 11:18:24 +08001810 asyncResp(resIn)
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001811 {}
Ed Tanous1abe55e2018-09-05 08:30:59 -07001812 ~AsyncPutRequest()
1813 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001814 if (asyncResp->res.jsonValue.empty())
Ed Tanous1abe55e2018-09-05 08:30:59 -07001815 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001816 setErrorResponse(asyncResp->res,
1817 boost::beast::http::status::forbidden,
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001818 forbiddenMsg, forbiddenPropDesc);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001819 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001820 }
1821
Ed Tanousecd6a3a2022-01-07 09:18:40 -08001822 AsyncPutRequest(const AsyncPutRequest&) = delete;
1823 AsyncPutRequest(AsyncPutRequest&&) = delete;
1824 AsyncPutRequest& operator=(const AsyncPutRequest&) = delete;
1825 AsyncPutRequest& operator=(AsyncPutRequest&&) = delete;
1826
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001827 void setErrorStatus(const std::string& desc)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001828 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001829 setErrorResponse(asyncResp->res,
1830 boost::beast::http::status::internal_server_error,
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001831 desc, badReqMsg);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001832 }
1833
zhanghch058d1b46d2021-04-01 11:18:24 +08001834 const std::shared_ptr<bmcweb::AsyncResp> asyncResp;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001835 std::string objectPath;
1836 std::string propertyName;
1837 nlohmann::json propertyValue;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001838};
1839
zhanghch058d1b46d2021-04-01 11:18:24 +08001840inline void handlePut(const crow::Request& req,
1841 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous23a21a12020-07-25 04:45:05 +00001842 const std::string& objectPath,
1843 const std::string& destProperty)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001844{
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001845 if (destProperty.empty())
1846 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001847 setErrorResponse(asyncResp->res, boost::beast::http::status::forbidden,
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001848 forbiddenResDesc, forbiddenMsg);
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001849 return;
1850 }
Ed Tanous1aa0c2b2022-02-08 12:24:30 +01001851 nlohmann::json requestDbusData;
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001852
Ed Tanous1aa0c2b2022-02-08 12:24:30 +01001853 JsonParseResult ret = parseRequestAsJson(req, requestDbusData);
1854 if (ret == JsonParseResult::BadContentType)
1855 {
1856 setErrorResponse(asyncResp->res,
1857 boost::beast::http::status::unsupported_media_type,
1858 invalidContentType, unsupportedMediaMsg);
1859 return;
1860 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001861
Ed Tanous1aa0c2b2022-02-08 12:24:30 +01001862 if (ret != JsonParseResult::Success)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001863 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001864 setErrorResponse(asyncResp->res,
1865 boost::beast::http::status::bad_request, noJsonDesc,
1866 badReqMsg);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001867 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001868 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001869
Nan Zhoub2ec0ce2022-06-02 23:57:38 +00001870 auto propertyIt = requestDbusData.find("data");
Ed Tanous1abe55e2018-09-05 08:30:59 -07001871 if (propertyIt == requestDbusData.end())
1872 {
zhanghch058d1b46d2021-04-01 11:18:24 +08001873 setErrorResponse(asyncResp->res,
1874 boost::beast::http::status::bad_request, noJsonDesc,
1875 badReqMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001876 return;
1877 }
Gunnar Mills1214b7e2020-06-04 10:11:30 -05001878 const nlohmann::json& propertySetValue = *propertyIt;
zhanghch058d1b46d2021-04-01 11:18:24 +08001879 auto transaction = std::make_shared<AsyncPutRequest>(asyncResp);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001880 transaction->objectPath = objectPath;
1881 transaction->propertyName = destProperty;
1882 transaction->propertyValue = propertySetValue;
Ed Tanous911ac312017-08-15 09:37:42 -07001883
George Liu2b731192023-01-11 16:27:13 +08001884 dbus::utility::getDbusObject(
1885 transaction->objectPath, {},
1886 [transaction](const boost::system::error_code& ec2,
Ed Tanousb9d36b42022-02-26 21:42:46 -08001887 const dbus::utility::MapperGetObject& objectNames) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001888 if (!ec2 && objectNames.empty())
1889 {
1890 setErrorResponse(transaction->asyncResp->res,
1891 boost::beast::http::status::not_found,
1892 propNotFoundDesc, notFoundMsg);
1893 return;
1894 }
Ed Tanous911ac312017-08-15 09:37:42 -07001895
Ed Tanous002d39b2022-05-31 08:59:27 -07001896 for (const std::pair<std::string, std::vector<std::string>>&
1897 connection : objectNames)
1898 {
1899 const std::string& connectionName = connection.first;
Ed Tanous911ac312017-08-15 09:37:42 -07001900
Ed Tanous002d39b2022-05-31 08:59:27 -07001901 crow::connections::systemBus->async_method_call(
1902 [connectionName{std::string(connectionName)},
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001903 transaction](const boost::system::error_code& ec3,
Ed Tanous002d39b2022-05-31 08:59:27 -07001904 const std::string& introspectXml) {
1905 if (ec3)
1906 {
1907 BMCWEB_LOG_ERROR << "Introspect call failed with error: "
1908 << ec3.message()
1909 << " on process: " << connectionName;
1910 transaction->setErrorStatus("Unexpected Error");
1911 return;
1912 }
1913 tinyxml2::XMLDocument doc;
Ed Tanous911ac312017-08-15 09:37:42 -07001914
Ed Tanous002d39b2022-05-31 08:59:27 -07001915 doc.Parse(introspectXml.c_str());
1916 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
1917 if (pRoot == nullptr)
1918 {
1919 BMCWEB_LOG_ERROR << "XML document failed to parse: "
1920 << introspectXml;
1921 transaction->setErrorStatus("Unexpected Error");
1922 return;
1923 }
1924 tinyxml2::XMLElement* ifaceNode =
1925 pRoot->FirstChildElement("interface");
1926 while (ifaceNode != nullptr)
1927 {
1928 const char* interfaceName = ifaceNode->Attribute("name");
1929 BMCWEB_LOG_DEBUG << "found interface " << interfaceName;
1930 tinyxml2::XMLElement* propNode =
1931 ifaceNode->FirstChildElement("property");
1932 while (propNode != nullptr)
1933 {
1934 const char* propertyName = propNode->Attribute("name");
1935 BMCWEB_LOG_DEBUG << "Found property " << propertyName;
1936 if (propertyName == transaction->propertyName)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001937 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001938 const char* argType = propNode->Attribute("type");
1939 if (argType != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001940 {
Patrick Williams59d494e2022-07-22 19:26:55 -05001941 sdbusplus::message_t m =
Ed Tanous002d39b2022-05-31 08:59:27 -07001942 crow::connections::systemBus
1943 ->new_method_call(
1944 connectionName.c_str(),
1945 transaction->objectPath.c_str(),
1946 "org.freedesktop.DBus."
1947 "Properties",
1948 "Set");
1949 m.append(interfaceName,
1950 transaction->propertyName);
1951 int r = sd_bus_message_open_container(
1952 m.get(), SD_BUS_TYPE_VARIANT, argType);
1953 if (r < 0)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001954 {
Ed Tanous002d39b2022-05-31 08:59:27 -07001955 transaction->setErrorStatus(
1956 "Unexpected Error");
1957 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001958 }
Ed Tanous002d39b2022-05-31 08:59:27 -07001959 r = convertJsonToDbus(
1960 m.get(), argType,
1961 transaction->propertyValue);
1962 if (r < 0)
1963 {
1964 if (r == -ERANGE)
1965 {
1966 transaction->setErrorStatus(
1967 "Provided property value "
1968 "is out of range for the "
1969 "property type");
1970 }
1971 else
1972 {
1973 transaction->setErrorStatus(
1974 "Invalid arg type");
1975 }
1976 return;
1977 }
1978 r = sd_bus_message_close_container(m.get());
1979 if (r < 0)
1980 {
1981 transaction->setErrorStatus(
1982 "Unexpected Error");
1983 return;
1984 }
1985 crow::connections::systemBus->async_send(
1986 m,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08001987 [transaction](
1988 const boost::system::error_code& ec,
1989 sdbusplus::message_t& m2) {
Ed Tanous002d39b2022-05-31 08:59:27 -07001990 BMCWEB_LOG_DEBUG << "sent";
1991 if (ec)
1992 {
1993 const sd_bus_error* e = m2.get_error();
1994 setErrorResponse(
1995 transaction->asyncResp->res,
1996 boost::beast::http::status::
1997 forbidden,
1998 (e) != nullptr
1999 ? e->name
2000 : ec.category().name(),
2001 (e) != nullptr ? e->message
2002 : ec.message());
2003 }
2004 else
2005 {
2006 transaction->asyncResp->res
2007 .jsonValue["status"] = "ok";
2008 transaction->asyncResp->res
2009 .jsonValue["message"] = "200 OK";
2010 transaction->asyncResp->res
2011 .jsonValue["data"] = nullptr;
2012 }
2013 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002014 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07002015 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002016 propNode = propNode->NextSiblingElement("property");
2017 }
2018 ifaceNode = ifaceNode->NextSiblingElement("interface");
2019 }
2020 },
2021 connectionName, transaction->objectPath,
2022 "org.freedesktop.DBus.Introspectable", "Introspect");
2023 }
George Liu2b731192023-01-11 16:27:13 +08002024 });
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07002025}
Ed Tanous1abe55e2018-09-05 08:30:59 -07002026
zhanghch058d1b46d2021-04-01 11:18:24 +08002027inline void handleDBusUrl(const crow::Request& req,
2028 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002029 std::string& objectPath)
Ed Tanous049a0512018-11-01 13:58:42 -07002030{
Ed Tanous049a0512018-11-01 13:58:42 -07002031
2032 // If accessing a single attribute, fill in and update objectPath,
2033 // otherwise leave destProperty blank
Ed Tanouse05aec52022-01-25 10:28:56 -08002034 std::string destProperty;
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002035 const char* attrSeperator = "/attr/";
Ed Tanous049a0512018-11-01 13:58:42 -07002036 size_t attrPosition = objectPath.find(attrSeperator);
Ed Tanous71d5d8d2022-01-25 11:04:33 -08002037 if (attrPosition != std::string::npos)
Ed Tanous049a0512018-11-01 13:58:42 -07002038 {
2039 destProperty = objectPath.substr(attrPosition + strlen(attrSeperator),
2040 objectPath.length());
Ed Tanous7f57f192022-12-20 09:53:40 -08002041 objectPath.resize(attrPosition);
Ed Tanous049a0512018-11-01 13:58:42 -07002042 }
2043
Ed Tanousb41187f2019-10-24 16:30:02 -07002044 if (req.method() == boost::beast::http::verb::post)
Ed Tanous049a0512018-11-01 13:58:42 -07002045 {
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002046 constexpr const char* actionSeperator = "/action/";
Ed Tanous049a0512018-11-01 13:58:42 -07002047 size_t actionPosition = objectPath.find(actionSeperator);
Ed Tanous71d5d8d2022-01-25 11:04:33 -08002048 if (actionPosition != std::string::npos)
Ed Tanous049a0512018-11-01 13:58:42 -07002049 {
2050 std::string postProperty =
2051 objectPath.substr((actionPosition + strlen(actionSeperator)),
2052 objectPath.length());
Ed Tanous7f57f192022-12-20 09:53:40 -08002053 objectPath.resize(actionPosition);
zhanghch058d1b46d2021-04-01 11:18:24 +08002054 handleAction(req, asyncResp, objectPath, postProperty);
Ed Tanous049a0512018-11-01 13:58:42 -07002055 return;
2056 }
2057 }
Ed Tanousb41187f2019-10-24 16:30:02 -07002058 else if (req.method() == boost::beast::http::verb::get)
Ed Tanous049a0512018-11-01 13:58:42 -07002059 {
Ed Tanous11ba3972022-07-11 09:50:41 -07002060 if (objectPath.ends_with("/enumerate"))
Ed Tanous049a0512018-11-01 13:58:42 -07002061 {
2062 objectPath.erase(objectPath.end() - sizeof("enumerate"),
2063 objectPath.end());
zhanghch058d1b46d2021-04-01 11:18:24 +08002064 handleEnumerate(asyncResp, objectPath);
Ed Tanous049a0512018-11-01 13:58:42 -07002065 }
Ed Tanous11ba3972022-07-11 09:50:41 -07002066 else if (objectPath.ends_with("/list"))
Ed Tanous049a0512018-11-01 13:58:42 -07002067 {
2068 objectPath.erase(objectPath.end() - sizeof("list"),
2069 objectPath.end());
zhanghch058d1b46d2021-04-01 11:18:24 +08002070 handleList(asyncResp, objectPath);
Ed Tanous049a0512018-11-01 13:58:42 -07002071 }
2072 else
2073 {
Ed Tanousf839dfe2018-11-12 11:11:15 -08002074 // Trim any trailing "/" at the end
Ed Tanous11ba3972022-07-11 09:50:41 -07002075 if (objectPath.ends_with("/"))
Ed Tanousf839dfe2018-11-12 11:11:15 -08002076 {
2077 objectPath.pop_back();
zhanghch058d1b46d2021-04-01 11:18:24 +08002078 handleList(asyncResp, objectPath, 1);
Ed Tanousf839dfe2018-11-12 11:11:15 -08002079 }
2080 else
2081 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002082 handleGet(asyncResp, objectPath, destProperty);
Ed Tanousf839dfe2018-11-12 11:11:15 -08002083 }
Ed Tanous049a0512018-11-01 13:58:42 -07002084 }
2085 return;
2086 }
Ed Tanousb41187f2019-10-24 16:30:02 -07002087 else if (req.method() == boost::beast::http::verb::put)
Ed Tanous049a0512018-11-01 13:58:42 -07002088 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002089 handlePut(req, asyncResp, objectPath, destProperty);
Ed Tanous049a0512018-11-01 13:58:42 -07002090 return;
2091 }
Ed Tanousb41187f2019-10-24 16:30:02 -07002092 else if (req.method() == boost::beast::http::verb::delete_)
Matt Spinlerde818812018-12-11 16:39:20 -06002093 {
zhanghch058d1b46d2021-04-01 11:18:24 +08002094 handleDelete(asyncResp, objectPath);
Matt Spinlerde818812018-12-11 16:39:20 -06002095 return;
2096 }
Ed Tanous049a0512018-11-01 13:58:42 -07002097
zhanghch058d1b46d2021-04-01 11:18:24 +08002098 setErrorResponse(asyncResp->res,
2099 boost::beast::http::status::method_not_allowed,
Matt Spinlerc4e8d21d62018-12-11 11:47:17 -06002100 methodNotAllowedDesc, methodNotAllowedMsg);
Ed Tanous049a0512018-11-01 13:58:42 -07002101}
2102
Ed Tanous1656b292022-05-04 11:33:42 -07002103inline void
2104 handleBusSystemPost(const crow::Request& req,
2105 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2106 const std::string& processName,
2107 const std::string& requestedPath)
2108{
2109 std::vector<std::string> strs;
Ed Tanous50ebd4a2023-01-19 19:03:17 -08002110
2111 bmcweb::split(strs, requestedPath, '/');
Ed Tanous1656b292022-05-04 11:33:42 -07002112 std::string objectPath;
2113 std::string interfaceName;
2114 std::string methodName;
2115 auto it = strs.begin();
2116 if (it == strs.end())
2117 {
2118 objectPath = "/";
2119 }
2120 while (it != strs.end())
2121 {
2122 // Check if segment contains ".". If it does, it must be an
2123 // interface
2124 if (it->find(".") != std::string::npos)
2125 {
2126 break;
2127 // This check is necessary as the trailing slash gets
2128 // parsed as part of our <path> specifier above, which
2129 // causes the normal trailing backslash redirector to
2130 // fail.
2131 }
2132 if (!it->empty())
2133 {
2134 objectPath += "/" + *it;
2135 }
2136 it++;
2137 }
2138 if (it != strs.end())
2139 {
2140 interfaceName = *it;
2141 it++;
2142
2143 // after interface, we might have a method name
2144 if (it != strs.end())
2145 {
2146 methodName = *it;
2147 it++;
2148 }
2149 }
2150 if (it != strs.end())
2151 {
2152 // if there is more levels past the method name, something
2153 // went wrong, return not found
2154 asyncResp->res.result(boost::beast::http::status::not_found);
2155 return;
2156 }
2157 if (interfaceName.empty())
2158 {
2159 crow::connections::systemBus->async_method_call(
2160 [asyncResp, processName,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002161 objectPath](const boost::system::error_code& ec,
Ed Tanous1656b292022-05-04 11:33:42 -07002162 const std::string& introspectXml) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002163 if (ec)
2164 {
2165 BMCWEB_LOG_ERROR
2166 << "Introspect call failed with error: " << ec.message()
2167 << " on process: " << processName << " path: " << objectPath
2168 << "\n";
2169 return;
2170 }
2171 tinyxml2::XMLDocument doc;
Ed Tanous1656b292022-05-04 11:33:42 -07002172
Ed Tanous002d39b2022-05-31 08:59:27 -07002173 doc.Parse(introspectXml.c_str());
2174 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
2175 if (pRoot == nullptr)
2176 {
2177 BMCWEB_LOG_ERROR << "XML document failed to parse "
2178 << processName << " " << objectPath << "\n";
2179 asyncResp->res.jsonValue["status"] = "XML parse error";
2180 asyncResp->res.result(
2181 boost::beast::http::status::internal_server_error);
2182 return;
2183 }
2184
2185 BMCWEB_LOG_DEBUG << introspectXml;
2186 asyncResp->res.jsonValue["status"] = "ok";
2187 asyncResp->res.jsonValue["bus_name"] = processName;
2188 asyncResp->res.jsonValue["object_path"] = objectPath;
2189
2190 nlohmann::json& interfacesArray =
2191 asyncResp->res.jsonValue["interfaces"];
2192 interfacesArray = nlohmann::json::array();
2193 tinyxml2::XMLElement* interface =
2194 pRoot->FirstChildElement("interface");
2195
2196 while (interface != nullptr)
2197 {
2198 const char* ifaceName = interface->Attribute("name");
2199 if (ifaceName != nullptr)
Ed Tanous1656b292022-05-04 11:33:42 -07002200 {
Ed Tanous8a592812022-06-04 09:06:59 -07002201 nlohmann::json::object_t interfaceObj;
2202 interfaceObj["name"] = ifaceName;
2203 interfacesArray.push_back(std::move(interfaceObj));
Ed Tanous1656b292022-05-04 11:33:42 -07002204 }
2205
Ed Tanous002d39b2022-05-31 08:59:27 -07002206 interface = interface->NextSiblingElement("interface");
2207 }
Ed Tanous1656b292022-05-04 11:33:42 -07002208 },
2209 processName, objectPath, "org.freedesktop.DBus.Introspectable",
2210 "Introspect");
2211 }
2212 else if (methodName.empty())
2213 {
2214 crow::connections::systemBus->async_method_call(
2215 [asyncResp, processName, objectPath,
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002216 interfaceName](const boost::system::error_code& ec,
Ed Tanous1656b292022-05-04 11:33:42 -07002217 const std::string& introspectXml) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002218 if (ec)
2219 {
2220 BMCWEB_LOG_ERROR
2221 << "Introspect call failed with error: " << ec.message()
2222 << " on process: " << processName << " path: " << objectPath
2223 << "\n";
2224 return;
2225 }
2226 tinyxml2::XMLDocument doc;
Ed Tanous1656b292022-05-04 11:33:42 -07002227
Ed Tanous002d39b2022-05-31 08:59:27 -07002228 doc.Parse(introspectXml.data(), introspectXml.size());
2229 tinyxml2::XMLNode* pRoot = doc.FirstChildElement("node");
2230 if (pRoot == nullptr)
2231 {
2232 BMCWEB_LOG_ERROR << "XML document failed to parse "
2233 << processName << " " << objectPath << "\n";
2234 asyncResp->res.result(
2235 boost::beast::http::status::internal_server_error);
2236 return;
2237 }
2238
2239 asyncResp->res.jsonValue["status"] = "ok";
2240 asyncResp->res.jsonValue["bus_name"] = processName;
2241 asyncResp->res.jsonValue["interface"] = interfaceName;
2242 asyncResp->res.jsonValue["object_path"] = objectPath;
2243
2244 nlohmann::json& methodsArray = asyncResp->res.jsonValue["methods"];
2245 methodsArray = nlohmann::json::array();
2246
2247 nlohmann::json& signalsArray = asyncResp->res.jsonValue["signals"];
2248 signalsArray = nlohmann::json::array();
2249
2250 nlohmann::json& propertiesObj =
2251 asyncResp->res.jsonValue["properties"];
2252 propertiesObj = nlohmann::json::object();
2253
2254 // if we know we're the only call, build the
2255 // json directly
2256 tinyxml2::XMLElement* interface =
2257 pRoot->FirstChildElement("interface");
2258 while (interface != nullptr)
2259 {
2260 const char* ifaceName = interface->Attribute("name");
2261
2262 if (ifaceName != nullptr && ifaceName == interfaceName)
Ed Tanous1656b292022-05-04 11:33:42 -07002263 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002264 break;
Ed Tanous1656b292022-05-04 11:33:42 -07002265 }
Ed Tanous14766872022-03-15 10:44:42 -07002266
Ed Tanous002d39b2022-05-31 08:59:27 -07002267 interface = interface->NextSiblingElement("interface");
2268 }
2269 if (interface == nullptr)
2270 {
2271 // if we got to the end of the list and
2272 // never found a match, throw 404
2273 asyncResp->res.result(boost::beast::http::status::not_found);
2274 return;
2275 }
Ed Tanous1656b292022-05-04 11:33:42 -07002276
Ed Tanous002d39b2022-05-31 08:59:27 -07002277 tinyxml2::XMLElement* methods =
2278 interface->FirstChildElement("method");
2279 while (methods != nullptr)
2280 {
2281 nlohmann::json argsArray = nlohmann::json::array();
2282 tinyxml2::XMLElement* arg = methods->FirstChildElement("arg");
2283 while (arg != nullptr)
Ed Tanous1656b292022-05-04 11:33:42 -07002284 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002285 nlohmann::json thisArg;
2286 for (const char* fieldName : std::array<const char*, 3>{
2287 "name", "direction", "type"})
Ed Tanous1656b292022-05-04 11:33:42 -07002288 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002289 const char* fieldValue = arg->Attribute(fieldName);
2290 if (fieldValue != nullptr)
Ed Tanous1656b292022-05-04 11:33:42 -07002291 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002292 thisArg[fieldName] = fieldValue;
2293 }
2294 }
2295 argsArray.push_back(std::move(thisArg));
2296 arg = arg->NextSiblingElement("arg");
2297 }
2298
2299 const char* name = methods->Attribute("name");
2300 if (name != nullptr)
2301 {
2302 std::string uri;
2303 uri.reserve(14 + processName.size() + objectPath.size() +
2304 interfaceName.size() + strlen(name));
2305 uri += "/bus/system/";
2306 uri += processName;
2307 uri += objectPath;
2308 uri += "/";
2309 uri += interfaceName;
2310 uri += "/";
2311 uri += name;
2312
2313 nlohmann::json::object_t object;
2314 object["name"] = name;
2315 object["uri"] = std::move(uri);
2316 object["args"] = argsArray;
2317
2318 methodsArray.push_back(std::move(object));
2319 }
2320 methods = methods->NextSiblingElement("method");
2321 }
2322 tinyxml2::XMLElement* signals =
2323 interface->FirstChildElement("signal");
2324 while (signals != nullptr)
2325 {
2326 nlohmann::json argsArray = nlohmann::json::array();
2327
2328 tinyxml2::XMLElement* arg = signals->FirstChildElement("arg");
2329 while (arg != nullptr)
2330 {
2331 const char* name = arg->Attribute("name");
2332 const char* type = arg->Attribute("type");
2333 if (name != nullptr && type != nullptr)
2334 {
2335 argsArray.push_back({
2336 {"name", name},
2337 {"type", type},
2338 });
2339 }
2340 arg = arg->NextSiblingElement("arg");
2341 }
2342 const char* name = signals->Attribute("name");
2343 if (name != nullptr)
2344 {
2345 nlohmann::json::object_t object;
2346 object["name"] = name;
2347 object["args"] = argsArray;
2348 signalsArray.push_back(std::move(object));
2349 }
2350
2351 signals = signals->NextSiblingElement("signal");
2352 }
2353
2354 tinyxml2::XMLElement* property =
2355 interface->FirstChildElement("property");
2356 while (property != nullptr)
2357 {
2358 const char* name = property->Attribute("name");
2359 const char* type = property->Attribute("type");
2360 if (type != nullptr && name != nullptr)
2361 {
Patrick Williams59d494e2022-07-22 19:26:55 -05002362 sdbusplus::message_t m =
Ed Tanous002d39b2022-05-31 08:59:27 -07002363 crow::connections::systemBus->new_method_call(
2364 processName.c_str(), objectPath.c_str(),
2365 "org.freedesktop."
2366 "DBus."
2367 "Properties",
2368 "Get");
2369 m.append(interfaceName, name);
2370 nlohmann::json& propertyItem = propertiesObj[name];
2371 crow::connections::systemBus->async_send(
2372 m, [&propertyItem,
Ed Tanous02cad962022-06-30 16:50:15 -07002373 asyncResp](const boost::system::error_code& e,
Patrick Williams59d494e2022-07-22 19:26:55 -05002374 sdbusplus::message_t& msg) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002375 if (e)
Ed Tanous1656b292022-05-04 11:33:42 -07002376 {
Ed Tanous002d39b2022-05-31 08:59:27 -07002377 return;
Ed Tanous1656b292022-05-04 11:33:42 -07002378 }
Ed Tanous1656b292022-05-04 11:33:42 -07002379
Ed Tanous002d39b2022-05-31 08:59:27 -07002380 convertDBusToJSON("v", msg, propertyItem);
2381 });
Ed Tanous1656b292022-05-04 11:33:42 -07002382 }
Ed Tanous002d39b2022-05-31 08:59:27 -07002383 property = property->NextSiblingElement("property");
2384 }
Ed Tanous1656b292022-05-04 11:33:42 -07002385 },
2386 processName, objectPath, "org.freedesktop.DBus.Introspectable",
2387 "Introspect");
2388 }
2389 else
2390 {
2391 if (req.method() != boost::beast::http::verb::post)
2392 {
2393 asyncResp->res.result(boost::beast::http::status::not_found);
2394 return;
2395 }
2396
Ed Tanous1aa0c2b2022-02-08 12:24:30 +01002397 nlohmann::json requestDbusData;
2398 JsonParseResult ret = parseRequestAsJson(req, requestDbusData);
2399 if (ret == JsonParseResult::BadContentType)
Ed Tanous1656b292022-05-04 11:33:42 -07002400 {
Ed Tanous1aa0c2b2022-02-08 12:24:30 +01002401 setErrorResponse(asyncResp->res,
2402 boost::beast::http::status::unsupported_media_type,
2403 invalidContentType, unsupportedMediaMsg);
Ed Tanous1656b292022-05-04 11:33:42 -07002404 return;
2405 }
Ed Tanous1aa0c2b2022-02-08 12:24:30 +01002406 if (ret != JsonParseResult::Success)
2407 {
2408 setErrorResponse(asyncResp->res,
2409 boost::beast::http::status::bad_request,
2410 noJsonDesc, badReqMsg);
2411 return;
2412 }
2413
Ed Tanous1656b292022-05-04 11:33:42 -07002414 if (!requestDbusData.is_array())
2415 {
2416 asyncResp->res.result(boost::beast::http::status::bad_request);
2417 return;
2418 }
2419 auto transaction =
2420 std::make_shared<InProgressActionData>(asyncResp->res);
2421
2422 transaction->path = objectPath;
2423 transaction->methodName = methodName;
2424 transaction->arguments = std::move(requestDbusData);
2425
2426 findActionOnInterface(transaction, processName);
2427 }
2428}
2429
Ed Tanous23a21a12020-07-25 04:45:05 +00002430inline void requestRoutes(App& app)
Ed Tanous1abe55e2018-09-05 08:30:59 -07002431{
2432 BMCWEB_ROUTE(app, "/bus/")
Ed Tanous432a8902021-06-14 15:28:56 -07002433 .privileges({{"Login"}})
Ed Tanousb41187f2019-10-24 16:30:02 -07002434 .methods(boost::beast::http::verb::get)(
zhanghch058d1b46d2021-04-01 11:18:24 +08002435 [](const crow::Request&,
2436 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002437 nlohmann::json::array_t buses;
2438 nlohmann::json& bus = buses.emplace_back();
2439 bus["name"] = "system";
2440 asyncResp->res.jsonValue["busses"] = std::move(buses);
2441 asyncResp->res.jsonValue["status"] = "ok";
2442 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002443
2444 BMCWEB_ROUTE(app, "/bus/system/")
Ed Tanous432a8902021-06-14 15:28:56 -07002445 .privileges({{"Login"}})
Ed Tanousb41187f2019-10-24 16:30:02 -07002446 .methods(boost::beast::http::verb::get)(
zhanghch058d1b46d2021-04-01 11:18:24 +08002447 [](const crow::Request&,
2448 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Ed Tanous5e7e2dc2023-02-16 10:37:01 -08002449 auto myCallback = [asyncResp](const boost::system::error_code& ec,
zhanghch058d1b46d2021-04-01 11:18:24 +08002450 std::vector<std::string>& names) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002451 if (ec)
2452 {
2453 BMCWEB_LOG_ERROR << "Dbus call failed with code " << ec;
2454 asyncResp->res.result(
2455 boost::beast::http::status::internal_server_error);
2456 }
2457 else
2458 {
2459 std::sort(names.begin(), names.end());
2460 asyncResp->res.jsonValue["status"] = "ok";
2461 auto& objectsSub = asyncResp->res.jsonValue["objects"];
Ed Tanous02cad962022-06-30 16:50:15 -07002462 for (const auto& name : names)
Ed Tanous002d39b2022-05-31 08:59:27 -07002463 {
2464 nlohmann::json::object_t object;
2465 object["name"] = name;
2466 objectsSub.push_back(std::move(object));
2467 }
2468 }
2469 };
2470 crow::connections::systemBus->async_method_call(
2471 std::move(myCallback), "org.freedesktop.DBus", "/",
2472 "org.freedesktop.DBus", "ListNames");
2473 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002474
2475 BMCWEB_ROUTE(app, "/list/")
Ed Tanous432a8902021-06-14 15:28:56 -07002476 .privileges({{"Login"}})
Ed Tanousb41187f2019-10-24 16:30:02 -07002477 .methods(boost::beast::http::verb::get)(
zhanghch058d1b46d2021-04-01 11:18:24 +08002478 [](const crow::Request&,
2479 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002480 handleList(asyncResp, "/");
2481 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002482
2483 BMCWEB_ROUTE(app, "/xyz/<path>")
Ed Tanous432a8902021-06-14 15:28:56 -07002484 .privileges({{"Login"}})
zhanghch058d1b46d2021-04-01 11:18:24 +08002485 .methods(boost::beast::http::verb::get)(
2486 [](const crow::Request& req,
2487 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002488 const std::string& path) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002489 std::string objectPath = "/xyz/" + path;
2490 handleDBusUrl(req, asyncResp, objectPath);
2491 });
zhanghch058d1b46d2021-04-01 11:18:24 +08002492
2493 BMCWEB_ROUTE(app, "/xyz/<path>")
Ed Tanous432a8902021-06-14 15:28:56 -07002494 .privileges({{"ConfigureComponents", "ConfigureManager"}})
zhanghch058d1b46d2021-04-01 11:18:24 +08002495 .methods(boost::beast::http::verb::put, boost::beast::http::verb::post,
2496 boost::beast::http::verb::delete_)(
2497 [](const crow::Request& req,
2498 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2499 const std::string& path) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002500 std::string objectPath = "/xyz/" + path;
2501 handleDBusUrl(req, asyncResp, objectPath);
2502 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002503
Ed Tanous049a0512018-11-01 13:58:42 -07002504 BMCWEB_ROUTE(app, "/org/<path>")
Ed Tanous432a8902021-06-14 15:28:56 -07002505 .privileges({{"Login"}})
zhanghch058d1b46d2021-04-01 11:18:24 +08002506 .methods(boost::beast::http::verb::get)(
2507 [](const crow::Request& req,
2508 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2509 const std::string& path) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002510 std::string objectPath = "/org/" + path;
2511 handleDBusUrl(req, asyncResp, objectPath);
2512 });
Tanousf00032d2018-11-05 01:18:10 -03002513
2514 BMCWEB_ROUTE(app, "/org/<path>")
Ed Tanous432a8902021-06-14 15:28:56 -07002515 .privileges({{"ConfigureComponents", "ConfigureManager"}})
Ed Tanousb41187f2019-10-24 16:30:02 -07002516 .methods(boost::beast::http::verb::put, boost::beast::http::verb::post,
2517 boost::beast::http::verb::delete_)(
zhanghch058d1b46d2021-04-01 11:18:24 +08002518 [](const crow::Request& req,
2519 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Gunnar Mills1214b7e2020-06-04 10:11:30 -05002520 const std::string& path) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002521 std::string objectPath = "/org/" + path;
2522 handleDBusUrl(req, asyncResp, objectPath);
2523 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002524
Ed Tanous1abe55e2018-09-05 08:30:59 -07002525 BMCWEB_ROUTE(app, "/download/dump/<str>/")
Ed Tanous432a8902021-06-14 15:28:56 -07002526 .privileges({{"ConfigureManager"}})
zhanghch058d1b46d2021-04-01 11:18:24 +08002527 .methods(boost::beast::http::verb::get)(
2528 [](const crow::Request&,
2529 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
2530 const std::string& dumpId) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002531 if (!validateFilename(dumpId))
2532 {
2533 asyncResp->res.result(boost::beast::http::status::bad_request);
2534 return;
2535 }
2536 std::filesystem::path loc("/var/lib/phosphor-debug-collector/dumps");
Ramesh Iyyard9207042019-07-05 08:04:42 -05002537
Ed Tanous002d39b2022-05-31 08:59:27 -07002538 loc /= dumpId;
Ramesh Iyyard9207042019-07-05 08:04:42 -05002539
Ed Tanous002d39b2022-05-31 08:59:27 -07002540 if (!std::filesystem::exists(loc) ||
2541 !std::filesystem::is_directory(loc))
2542 {
2543 BMCWEB_LOG_ERROR << loc.string() << "Not found";
2544 asyncResp->res.result(boost::beast::http::status::not_found);
2545 return;
2546 }
2547 std::filesystem::directory_iterator files(loc);
zhanghch058d1b46d2021-04-01 11:18:24 +08002548
Ed Tanous002d39b2022-05-31 08:59:27 -07002549 for (const auto& file : files)
2550 {
2551 std::ifstream readFile(file.path());
2552 if (!readFile.good())
2553 {
2554 continue;
2555 }
zhanghch058d1b46d2021-04-01 11:18:24 +08002556
Ed Tanousd9f6c622022-03-17 09:12:17 -07002557 asyncResp->res.addHeader(boost::beast::http::field::content_type,
Ed Tanous002d39b2022-05-31 08:59:27 -07002558 "application/octet-stream");
zhanghch058d1b46d2021-04-01 11:18:24 +08002559
Ed Tanous002d39b2022-05-31 08:59:27 -07002560 // Assuming only one dump file will be present in the dump
2561 // id directory
2562 std::string dumpFileName = file.path().filename().string();
zhanghch058d1b46d2021-04-01 11:18:24 +08002563
Ed Tanous002d39b2022-05-31 08:59:27 -07002564 // Filename should be in alphanumeric, dot and underscore
2565 // Its based on phosphor-debug-collector application
2566 // dumpfile format
2567 std::regex dumpFileRegex("[a-zA-Z0-9\\._]+");
2568 if (!std::regex_match(dumpFileName, dumpFileRegex))
2569 {
2570 BMCWEB_LOG_ERROR << "Invalid dump filename " << dumpFileName;
zhanghch058d1b46d2021-04-01 11:18:24 +08002571 asyncResp->res.result(boost::beast::http::status::not_found);
Ed Tanousad18f072018-11-14 14:07:48 -08002572 return;
Ed Tanous002d39b2022-05-31 08:59:27 -07002573 }
2574 std::string contentDispositionParam =
2575 "attachment; filename=\"" + dumpFileName + "\"";
2576
Ed Tanousd9f6c622022-03-17 09:12:17 -07002577 asyncResp->res.addHeader(
2578 boost::beast::http::field::content_disposition,
2579 contentDispositionParam);
Ed Tanous002d39b2022-05-31 08:59:27 -07002580
2581 asyncResp->res.body() = {std::istreambuf_iterator<char>(readFile),
2582 std::istreambuf_iterator<char>()};
2583 return;
2584 }
2585 asyncResp->res.result(boost::beast::http::status::not_found);
2586 return;
2587 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002588
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002589 BMCWEB_ROUTE(app, "/bus/system/<str>/")
Ed Tanous432a8902021-06-14 15:28:56 -07002590 .privileges({{"Login"}})
Ed Tanousb41187f2019-10-24 16:30:02 -07002591
2592 .methods(boost::beast::http::verb::get)(
zhanghch058d1b46d2021-04-01 11:18:24 +08002593 [](const crow::Request&,
2594 const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
Ed Tanous81ce6092020-12-17 16:54:55 +00002595 const std::string& connection) {
Ed Tanous002d39b2022-05-31 08:59:27 -07002596 introspectObjects(connection, "/", asyncResp);
2597 });
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002598
2599 BMCWEB_ROUTE(app, "/bus/system/<str>/<path>")
Ed Tanous432a8902021-06-14 15:28:56 -07002600 .privileges({{"ConfigureComponents", "ConfigureManager"}})
Ed Tanous1656b292022-05-04 11:33:42 -07002601 .methods(boost::beast::http::verb::get,
2602 boost::beast::http::verb::post)(handleBusSystemPost);
Ed Tanous1abe55e2018-09-05 08:30:59 -07002603}
2604} // namespace openbmc_mapper
2605} // namespace crow