blob: 27a9e3d6b0e6f98c92e17b344c96c95785c013a0 [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
James Feistf6150402019-01-08 10:36:20 -080016#include "filesystem.hpp"
17
Ed Tanous911ac312017-08-15 09:37:42 -070018#include <crow/app.h>
Ed Tanous911ac312017-08-15 09:37:42 -070019#include <tinyxml2.h>
Ed Tanous1abe55e2018-09-05 08:30:59 -070020
Ed Tanouse3cb5a32018-08-08 14:16:49 -070021#include <async_resp.hpp>
Ed Tanous1abe55e2018-09-05 08:30:59 -070022#include <boost/algorithm/string.hpp>
23#include <boost/container/flat_set.hpp>
Ed Tanous911ac312017-08-15 09:37:42 -070024#include <dbus_singleton.hpp>
James Feist5b4aa862018-08-16 14:07:01 -070025#include <dbus_utility.hpp>
Ed Tanousd4bb9bb2018-05-16 13:36:42 -070026#include <fstream>
William A. Kennington III0a63b1c2018-10-18 13:37:19 -070027#include <sdbusplus/message/types.hpp>
Ed Tanous911ac312017-08-15 09:37:42 -070028
Ed Tanous1abe55e2018-09-05 08:30:59 -070029namespace crow
30{
31namespace openbmc_mapper
32{
Ed Tanousba9f9a62017-10-11 16:40:35 -070033
Matt Spinler3ae4ba72018-12-05 14:01:22 -060034using GetSubTreeType = std::vector<
35 std::pair<std::string,
36 std::vector<std::pair<std::string, std::vector<std::string>>>>>;
37
Matt Spinler2ae60092018-12-06 10:35:36 -060038const std::string notFoundMsg = "404 Not Found";
Matt Spinler6db06242018-12-11 11:21:22 -060039const std::string badReqMsg = "400 Bad Request";
Matt Spinlerc4e8d21d62018-12-11 11:47:17 -060040const std::string methodNotAllowedMsg = "405 Method Not Allowed";
Matt Spinlerfbc19ea2018-12-11 14:03:42 -060041const std::string forbiddenMsg = "403 Forbidden";
Matt Spinlerc0eb9bd2019-01-09 15:22:30 -060042const std::string methodFailedMsg = "500 Method Call Failed";
Matt Spinler16caaee2019-01-15 11:40:34 -060043const std::string methodOutputFailedMsg = "500 Method Output Error";
Matt Spinler6db06242018-12-11 11:21:22 -060044
Matt Spinler2ae60092018-12-06 10:35:36 -060045const std::string notFoundDesc =
46 "org.freedesktop.DBus.Error.FileNotFound: path or object not found";
Matt Spinlerdc2f9f12018-12-06 13:53:53 -060047const std::string propNotFoundDesc = "The specified property cannot be found";
Matt Spinler6db06242018-12-11 11:21:22 -060048const std::string noJsonDesc = "No JSON object could be decoded";
49const std::string methodNotFoundDesc = "The specified method cannot be found";
Matt Spinlerc4e8d21d62018-12-11 11:47:17 -060050const std::string methodNotAllowedDesc = "Method not allowed";
Matt Spinlerfbc19ea2018-12-11 14:03:42 -060051const std::string forbiddenPropDesc =
52 "The specified property cannot be created";
53const std::string forbiddenResDesc = "The specified resource cannot be created";
Matt Spinler2ae60092018-12-06 10:35:36 -060054
55void setErrorResponse(crow::Response &res, boost::beast::http::status result,
56 const std::string &desc, const std::string &msg)
57{
58 res.result(result);
59 res.jsonValue = {{"data", {{"description", desc}}},
60 {"message", msg},
61 {"status", "error"}};
62}
63
Ed Tanouse3cb5a32018-08-08 14:16:49 -070064void introspectObjects(const std::string &processName,
65 const std::string &objectPath,
66 std::shared_ptr<bmcweb::AsyncResp> transaction)
Ed Tanous1abe55e2018-09-05 08:30:59 -070067{
Ed Tanouse3cb5a32018-08-08 14:16:49 -070068 if (transaction->res.jsonValue.is_null())
69 {
70 transaction->res.jsonValue = {{"status", "ok"},
71 {"bus_name", processName},
72 {"objects", nlohmann::json::array()}};
73 }
74
Ed Tanous1abe55e2018-09-05 08:30:59 -070075 crow::connections::systemBus->async_method_call(
Ed Tanouse3cb5a32018-08-08 14:16:49 -070076 [transaction, processName{std::string(processName)},
77 objectPath{std::string(objectPath)}](
78 const boost::system::error_code ec,
79 const std::string &introspect_xml) {
Ed Tanous1abe55e2018-09-05 08:30:59 -070080 if (ec)
81 {
82 BMCWEB_LOG_ERROR
83 << "Introspect call failed with error: " << ec.message()
84 << " on process: " << processName << " path: " << objectPath
85 << "\n";
Ed Tanouse3cb5a32018-08-08 14:16:49 -070086 return;
87 }
88 transaction->res.jsonValue["objects"].push_back(
89 {{"path", objectPath}});
90
91 tinyxml2::XMLDocument doc;
92
93 doc.Parse(introspect_xml.c_str());
94 tinyxml2::XMLNode *pRoot = doc.FirstChildElement("node");
95 if (pRoot == nullptr)
96 {
97 BMCWEB_LOG_ERROR << "XML document failed to parse "
98 << processName << " " << objectPath << "\n";
Ed Tanous911ac312017-08-15 09:37:42 -070099 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700100 else
101 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700102 tinyxml2::XMLElement *node = pRoot->FirstChildElement("node");
103 while (node != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700104 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700105 const char *childPath = node->Attribute("name");
106 if (childPath != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700107 {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700108 std::string newpath;
109 if (objectPath != "/")
110 {
111 newpath += objectPath;
112 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700113 newpath += std::string("/") + childPath;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700114 // introspect the subobjects as well
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700115 introspectObjects(processName, newpath, transaction);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700116 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700117
118 node = node->NextSiblingElement("node");
Ed Tanous1abe55e2018-09-05 08:30:59 -0700119 }
120 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700121 },
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700122 processName, objectPath, "org.freedesktop.DBus.Introspectable",
Ed Tanous1abe55e2018-09-05 08:30:59 -0700123 "Introspect");
Ed Tanous911ac312017-08-15 09:37:42 -0700124}
Ed Tanous64530012018-02-06 17:08:16 -0800125
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600126void getPropertiesForEnumerate(const std::string &objectPath,
127 const std::string &service,
128 const std::string &interface,
129 std::shared_ptr<bmcweb::AsyncResp> asyncResp)
130{
131 BMCWEB_LOG_DEBUG << "getPropertiesForEnumerate " << objectPath << " "
132 << service << " " << interface;
133
134 crow::connections::systemBus->async_method_call(
135 [asyncResp, objectPath, service,
136 interface](const boost::system::error_code ec,
137 const std::vector<
138 std::pair<std::string, dbus::utility::DbusVariantType>>
139 &propertiesList) {
140 if (ec)
141 {
142 BMCWEB_LOG_ERROR << "GetAll on path " << objectPath << " iface "
143 << interface << " service " << service
144 << " failed with code " << ec;
145 return;
146 }
147
148 nlohmann::json &dataJson = asyncResp->res.jsonValue["data"];
149 nlohmann::json &objectJson = dataJson[objectPath];
150 if (objectJson.is_null())
151 {
152 objectJson = nlohmann::json::object();
153 }
154
155 for (const auto &[name, value] : propertiesList)
156 {
157 nlohmann::json &propertyJson = objectJson[name];
Ed Tanousabf2add2019-01-22 16:40:12 -0800158 std::visit([&propertyJson](auto &&val) { propertyJson = val; },
159 value);
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600160 }
161 },
162 service, objectPath, "org.freedesktop.DBus.Properties", "GetAll",
163 interface);
164}
165
166// Find any results that weren't picked up by ObjectManagers, to be
167// called after all ObjectManagers are searched for and called.
168void findRemainingObjectsForEnumerate(
169 const std::string &objectPath, std::shared_ptr<GetSubTreeType> subtree,
170 std::shared_ptr<bmcweb::AsyncResp> asyncResp)
171{
172 BMCWEB_LOG_DEBUG << "findRemainingObjectsForEnumerate";
173 const nlohmann::json &dataJson = asyncResp->res.jsonValue["data"];
174
175 for (const auto &[path, interface_map] : *subtree)
176 {
177 if (path == objectPath)
178 {
179 // An enumerate does not return the target path's properties
180 continue;
181 }
182 if (dataJson.find(path) == dataJson.end())
183 {
184 for (const auto &[service, interfaces] : interface_map)
185 {
186 for (const auto &interface : interfaces)
187 {
188 if (!boost::starts_with(interface, "org.freedesktop.DBus"))
189 {
190 getPropertiesForEnumerate(path, service, interface,
191 asyncResp);
192 }
193 }
194 }
195 }
196 }
197}
198
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600199struct InProgressEnumerateData
200{
201 InProgressEnumerateData(const std::string &objectPath,
202 std::shared_ptr<bmcweb::AsyncResp> asyncResp) :
203 objectPath(objectPath),
204 asyncResp(asyncResp)
205 {
206 }
207
208 ~InProgressEnumerateData()
209 {
Matt Spinler2df1e7d2018-12-05 15:53:16 -0600210 findRemainingObjectsForEnumerate(objectPath, subtree, asyncResp);
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600211 }
212
213 const std::string objectPath;
214 std::shared_ptr<GetSubTreeType> subtree;
215 std::shared_ptr<bmcweb::AsyncResp> asyncResp;
216};
217
218void getManagedObjectsForEnumerate(
219 const std::string &object_name, const std::string &object_manager_path,
220 const std::string &connection_name,
221 std::shared_ptr<InProgressEnumerateData> transaction)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700222{
Ed Tanous049a0512018-11-01 13:58:42 -0700223 BMCWEB_LOG_DEBUG << "getManagedObjectsForEnumerate " << object_name
224 << " object_manager_path " << object_manager_path
225 << " connection_name " << connection_name;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700226 crow::connections::systemBus->async_method_call(
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600227 [transaction, object_name,
Ed Tanous049a0512018-11-01 13:58:42 -0700228 connection_name](const boost::system::error_code ec,
229 const dbus::utility::ManagedObjectType &objects) {
Ed Tanous1abe55e2018-09-05 08:30:59 -0700230 if (ec)
231 {
Ed Tanous049a0512018-11-01 13:58:42 -0700232 BMCWEB_LOG_ERROR << "GetManagedObjects on path " << object_name
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600233 << " on connection " << connection_name
Ed Tanous049a0512018-11-01 13:58:42 -0700234 << " failed with code " << ec;
235 return;
Ed Tanousaa2e59c2018-04-12 12:17:20 -0700236 }
Ed Tanous64530012018-02-06 17:08:16 -0800237
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600238 nlohmann::json &dataJson =
239 transaction->asyncResp->res.jsonValue["data"];
Ed Tanous049a0512018-11-01 13:58:42 -0700240
241 for (const auto &objectPath : objects)
242 {
243 if (boost::starts_with(objectPath.first.str, object_name))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700244 {
Ed Tanous049a0512018-11-01 13:58:42 -0700245 BMCWEB_LOG_DEBUG << "Reading object "
246 << objectPath.first.str;
247 nlohmann::json &objectJson = dataJson[objectPath.first.str];
Ed Tanous1abe55e2018-09-05 08:30:59 -0700248 if (objectJson.is_null())
249 {
250 objectJson = nlohmann::json::object();
251 }
252 for (const auto &interface : objectPath.second)
253 {
254 for (const auto &property : interface.second)
255 {
256 nlohmann::json &propertyJson =
257 objectJson[property.first];
Ed Tanousabf2add2019-01-22 16:40:12 -0800258 std::visit([&propertyJson](
259 auto &&val) { propertyJson = val; },
260 property.second);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700261 }
262 }
263 }
Ed Tanous049a0512018-11-01 13:58:42 -0700264 for (const auto &interface : objectPath.second)
265 {
266 if (interface.first == "org.freedesktop.DBus.ObjectManager")
267 {
268 getManagedObjectsForEnumerate(
269 objectPath.first.str, objectPath.first.str,
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600270 connection_name, transaction);
Ed Tanous049a0512018-11-01 13:58:42 -0700271 }
272 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700273 }
274 },
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700275 connection_name, object_manager_path,
276 "org.freedesktop.DBus.ObjectManager", "GetManagedObjects");
277}
278
279void findObjectManagerPathForEnumerate(
280 const std::string &object_name, const std::string &connection_name,
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600281 std::shared_ptr<InProgressEnumerateData> transaction)
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700282{
Ed Tanous049a0512018-11-01 13:58:42 -0700283 BMCWEB_LOG_DEBUG << "Finding objectmanager for path " << object_name
284 << " on connection:" << connection_name;
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700285 crow::connections::systemBus->async_method_call(
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600286 [transaction, object_name, connection_name](
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700287 const boost::system::error_code ec,
288 const boost::container::flat_map<
289 std::string, boost::container::flat_map<
290 std::string, std::vector<std::string>>>
291 &objects) {
292 if (ec)
293 {
Ed Tanous049a0512018-11-01 13:58:42 -0700294 BMCWEB_LOG_ERROR << "GetAncestors on path " << object_name
295 << " failed with code " << ec;
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700296 return;
297 }
298
Ed Tanousf254ba72018-10-12 13:40:35 -0700299 for (const auto &pathGroup : objects)
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700300 {
Ed Tanousf254ba72018-10-12 13:40:35 -0700301 for (const auto &connectionGroup : pathGroup.second)
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700302 {
303 if (connectionGroup.first == connection_name)
304 {
305 // Found the object manager path for this resource.
306 getManagedObjectsForEnumerate(
Ed Tanous049a0512018-11-01 13:58:42 -0700307 object_name, pathGroup.first, connection_name,
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600308 transaction);
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700309 return;
310 }
311 }
312 }
313 },
314 "xyz.openbmc_project.ObjectMapper",
315 "/xyz/openbmc_project/object_mapper",
316 "xyz.openbmc_project.ObjectMapper", "GetAncestors", object_name,
317 std::array<const char *, 1>{"org.freedesktop.DBus.ObjectManager"});
Ed Tanousaa2e59c2018-04-12 12:17:20 -0700318}
Ed Tanous64530012018-02-06 17:08:16 -0800319
Matt Spinler3ae4ba72018-12-05 14:01:22 -0600320// Uses GetObject to add the object info about the target /enumerate path to the
321// results of GetSubTree, as GetSubTree will not return info for the
322// target path, and then continues on enumerating the rest of the tree.
323void getObjectAndEnumerate(std::shared_ptr<InProgressEnumerateData> transaction)
324{
325 using GetObjectType =
326 std::vector<std::pair<std::string, std::vector<std::string>>>;
327
328 crow::connections::systemBus->async_method_call(
329 [transaction](const boost::system::error_code ec,
330 const GetObjectType &objects) {
331 if (ec)
332 {
333 BMCWEB_LOG_ERROR << "GetObject for path "
334 << transaction->objectPath
335 << " failed with code " << ec;
336 return;
337 }
338
339 BMCWEB_LOG_DEBUG << "GetObject for " << transaction->objectPath
340 << " has " << objects.size() << " entries";
341 if (!objects.empty())
342 {
343 transaction->subtree->emplace_back(transaction->objectPath,
344 objects);
345 }
346
347 // Map indicating connection name, and the path where the object
348 // manager exists
349 boost::container::flat_map<std::string, std::string> connections;
350
351 for (const auto &object : *(transaction->subtree))
352 {
353 for (const auto &connection : object.second)
354 {
355 std::string &objectManagerPath =
356 connections[connection.first];
357 for (const auto &interface : connection.second)
358 {
359 BMCWEB_LOG_DEBUG << connection.first
360 << " has interface " << interface;
361 if (interface == "org.freedesktop.DBus.ObjectManager")
362 {
363 BMCWEB_LOG_DEBUG << "found object manager path "
364 << object.first;
365 objectManagerPath = object.first;
366 }
367 }
368 }
369 }
370 BMCWEB_LOG_DEBUG << "Got " << connections.size() << " connections";
371
372 for (const auto &connection : connections)
373 {
374 // If we already know where the object manager is, we don't need
375 // to search for it, we can call directly in to
376 // getManagedObjects
377 if (!connection.second.empty())
378 {
379 getManagedObjectsForEnumerate(
380 transaction->objectPath, connection.second,
381 connection.first, transaction);
382 }
383 else
384 {
385 // otherwise we need to find the object manager path before
386 // we can continue
387 findObjectManagerPathForEnumerate(
388 transaction->objectPath, connection.first, transaction);
389 }
390 }
391 },
392 "xyz.openbmc_project.ObjectMapper",
393 "/xyz/openbmc_project/object_mapper",
394 "xyz.openbmc_project.ObjectMapper", "GetObject",
395 transaction->objectPath, std::array<const char *, 0>());
396}
Ed Tanous64530012018-02-06 17:08:16 -0800397
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700398// Structure for storing data on an in progress action
Ed Tanous1abe55e2018-09-05 08:30:59 -0700399struct InProgressActionData
400{
401 InProgressActionData(crow::Response &res) : res(res){};
402 ~InProgressActionData()
403 {
Matt Spinler16caaee2019-01-15 11:40:34 -0600404 // Methods could have been called across different owners
405 // and interfaces, where some calls failed and some passed.
406 //
407 // The rules for this are:
408 // * if no method was called - error
409 // * if a method failed and none passed - error
410 // (converse: if at least one method passed - OK)
411 // * for the method output:
412 // * if output processing didn't fail, return the data
413
414 // Only deal with method returns if nothing failed earlier
415 if (res.result() == boost::beast::http::status::ok)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700416 {
Matt Spinler16caaee2019-01-15 11:40:34 -0600417 if (!methodPassed)
418 {
419 if (methodFailed)
420 {
421 setErrorResponse(res,
422 boost::beast::http::status::bad_request,
423 "Method call failed", methodFailedMsg);
424 }
425 else
426 {
427 setErrorResponse(res, boost::beast::http::status::not_found,
428 methodNotFoundDesc, notFoundMsg);
429 }
430 }
431 else
432 {
433 if (outputFailed)
434 {
435 setErrorResponse(
436 res, boost::beast::http::status::internal_server_error,
437 "Method output failure", methodOutputFailedMsg);
438 }
439 else
440 {
441 res.jsonValue = {{"status", "ok"},
442 {"message", "200 OK"},
443 {"data", methodResponse}};
444 }
445 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700446 }
Matt Spinler16caaee2019-01-15 11:40:34 -0600447
Ed Tanous1abe55e2018-09-05 08:30:59 -0700448 res.end();
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700449 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700450
Matt Spinler6db06242018-12-11 11:21:22 -0600451 void setErrorStatus(const std::string &desc)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700452 {
Matt Spinlerc0eb9bd2019-01-09 15:22:30 -0600453 setErrorResponse(res, boost::beast::http::status::bad_request, desc,
454 badReqMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700455 }
456 crow::Response &res;
457 std::string path;
458 std::string methodName;
Matt Spinlerde818812018-12-11 16:39:20 -0600459 std::string interfaceName;
Matt Spinler16caaee2019-01-15 11:40:34 -0600460 bool methodPassed = false;
461 bool methodFailed = false;
462 bool outputFailed = false;
Matt Spinler39a4e392019-01-15 11:53:13 -0600463 bool convertedToArray = false;
Matt Spinler16caaee2019-01-15 11:40:34 -0600464 nlohmann::json methodResponse;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700465 nlohmann::json arguments;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700466};
467
Ed Tanous1abe55e2018-09-05 08:30:59 -0700468std::vector<std::string> dbusArgSplit(const std::string &string)
469{
470 std::vector<std::string> ret;
471 if (string.empty())
472 {
473 return ret;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700474 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700475 ret.push_back("");
476 int containerDepth = 0;
477
478 for (std::string::const_iterator character = string.begin();
479 character != string.end(); character++)
480 {
481 ret.back() += *character;
482 switch (*character)
483 {
484 case ('a'):
485 break;
486 case ('('):
487 case ('{'):
488 containerDepth++;
489 break;
490 case ('}'):
491 case (')'):
492 containerDepth--;
493 if (containerDepth == 0)
494 {
495 if (character + 1 != string.end())
496 {
497 ret.push_back("");
498 }
499 }
500 break;
501 default:
502 if (containerDepth == 0)
503 {
504 if (character + 1 != string.end())
505 {
506 ret.push_back("");
507 }
508 }
509 break;
510 }
511 }
Matt Spinler4ae611d2019-01-11 15:37:06 -0600512
513 return ret;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700514}
515
Ed Tanousd76323e2018-08-07 14:35:40 -0700516int convertJsonToDbus(sd_bus_message *m, const std::string &arg_type,
Ed Tanous1abe55e2018-09-05 08:30:59 -0700517 const nlohmann::json &input_json)
518{
519 int r = 0;
520 BMCWEB_LOG_DEBUG << "Converting " << input_json.dump()
521 << " to type: " << arg_type;
522 const std::vector<std::string> argTypes = dbusArgSplit(arg_type);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700523
Ed Tanous1abe55e2018-09-05 08:30:59 -0700524 // Assume a single object for now.
525 const nlohmann::json *j = &input_json;
526 nlohmann::json::const_iterator jIt = input_json.begin();
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700527
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700528 for (const std::string &argCode : argTypes)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700529 {
530 // If we are decoding multiple objects, grab the pointer to the
531 // iterator, and increment it for the next loop
532 if (argTypes.size() > 1)
533 {
534 if (jIt == input_json.end())
535 {
536 return -2;
537 }
538 j = &*jIt;
539 jIt++;
540 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700541 const int64_t *intValue = j->get_ptr<const int64_t *>();
542 const uint64_t *uintValue = j->get_ptr<const uint64_t *>();
543 const std::string *stringValue = j->get_ptr<const std::string *>();
544 const double *doubleValue = j->get_ptr<const double *>();
Ed Tanous1abe55e2018-09-05 08:30:59 -0700545 const bool *b = j->get_ptr<const bool *>();
546 int64_t v = 0;
547 double d = 0.0;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700548
Ed Tanous1abe55e2018-09-05 08:30:59 -0700549 // Do some basic type conversions that make sense. uint can be
550 // converted to int. int and uint can be converted to double
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700551 if (uintValue != nullptr && intValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700552 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700553 v = static_cast<int64_t>(*uintValue);
554 intValue = &v;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700555 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700556 if (uintValue != nullptr && doubleValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700557 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700558 d = static_cast<double>(*uintValue);
559 doubleValue = &d;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700560 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700561 if (intValue != nullptr && doubleValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700562 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700563 d = static_cast<double>(*intValue);
564 doubleValue = &d;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700565 }
566
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700567 if (argCode == "s")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700568 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700569 if (stringValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700570 {
571 return -1;
572 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700573 r = sd_bus_message_append_basic(m, argCode[0],
574 (void *)stringValue->c_str());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700575 if (r < 0)
576 {
577 return r;
578 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700579 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700580 else if (argCode == "i")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700581 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700582 if (intValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700583 {
584 return -1;
585 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700586 int32_t i = static_cast<int32_t>(*intValue);
587 r = sd_bus_message_append_basic(m, argCode[0], &i);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700588 if (r < 0)
589 {
590 return r;
591 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700592 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700593 else if (argCode == "b")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700594 {
595 // lots of ways bool could be represented here. Try them all
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700596 int boolInt = false;
597 if (intValue != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700598 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700599 boolInt = *intValue > 0 ? 1 : 0;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700600 }
601 else if (b != nullptr)
602 {
Matt Spinlera2f02632019-01-18 10:15:35 -0600603 boolInt = *b ? 1 : 0;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700604 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700605 else if (stringValue != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700606 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700607 boolInt = boost::istarts_with(*stringValue, "t") ? 1 : 0;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700608 }
609 else
610 {
611 return -1;
612 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700613 r = sd_bus_message_append_basic(m, argCode[0], &boolInt);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700614 if (r < 0)
615 {
616 return r;
617 }
618 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700619 else if (argCode == "n")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700620 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700621 if (intValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700622 {
623 return -1;
624 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700625 int16_t n = static_cast<int16_t>(*intValue);
626 r = sd_bus_message_append_basic(m, argCode[0], &n);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700627 if (r < 0)
628 {
629 return r;
630 }
631 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700632 else if (argCode == "x")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700633 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700634 if (intValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700635 {
636 return -1;
637 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700638 r = sd_bus_message_append_basic(m, argCode[0], intValue);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700639 if (r < 0)
640 {
641 return r;
642 }
643 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700644 else if (argCode == "y")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700645 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700646 if (uintValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700647 {
648 return -1;
649 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700650 uint8_t y = static_cast<uint8_t>(*uintValue);
651 r = sd_bus_message_append_basic(m, argCode[0], &y);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700652 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700653 else if (argCode == "q")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700654 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700655 if (uintValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700656 {
657 return -1;
658 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700659 uint16_t q = static_cast<uint16_t>(*uintValue);
660 r = sd_bus_message_append_basic(m, argCode[0], &q);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700661 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700662 else if (argCode == "u")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700663 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700664 if (uintValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700665 {
666 return -1;
667 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700668 uint32_t u = static_cast<uint32_t>(*uintValue);
669 r = sd_bus_message_append_basic(m, argCode[0], &u);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700670 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700671 else if (argCode == "t")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700672 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700673 if (uintValue == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -0700674 {
675 return -1;
676 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700677 r = sd_bus_message_append_basic(m, argCode[0], uintValue);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700678 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700679 else if (argCode == "d")
Ed Tanous1abe55e2018-09-05 08:30:59 -0700680 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700681 sd_bus_message_append_basic(m, argCode[0], doubleValue);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700682 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700683 else if (boost::starts_with(argCode, "a"))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700684 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700685 std::string containedType = argCode.substr(1);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700686 r = sd_bus_message_open_container(m, SD_BUS_TYPE_ARRAY,
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700687 containedType.c_str());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700688 if (r < 0)
689 {
690 return r;
691 }
692
693 for (nlohmann::json::const_iterator it = j->begin(); it != j->end();
694 ++it)
695 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700696 r = convertJsonToDbus(m, containedType, *it);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700697 if (r < 0)
698 {
699 return r;
700 }
Ed Tanous1abe55e2018-09-05 08:30:59 -0700701 }
702 sd_bus_message_close_container(m);
703 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700704 else if (boost::starts_with(argCode, "v"))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700705 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700706 std::string containedType = argCode.substr(1);
707 BMCWEB_LOG_DEBUG << "variant type: " << argCode
708 << " appending variant of type: " << containedType;
Ed Tanous1abe55e2018-09-05 08:30:59 -0700709 r = sd_bus_message_open_container(m, SD_BUS_TYPE_VARIANT,
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700710 containedType.c_str());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700711 if (r < 0)
712 {
713 return r;
714 }
715
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700716 r = convertJsonToDbus(m, containedType, input_json);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700717 if (r < 0)
718 {
719 return r;
720 }
721
722 r = sd_bus_message_close_container(m);
723 if (r < 0)
724 {
725 return r;
726 }
727 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700728 else if (boost::starts_with(argCode, "(") &&
729 boost::ends_with(argCode, ")"))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700730 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700731 std::string containedType = argCode.substr(1, argCode.size() - 1);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700732 r = sd_bus_message_open_container(m, SD_BUS_TYPE_STRUCT,
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700733 containedType.c_str());
Ed Tanous1abe55e2018-09-05 08:30:59 -0700734 nlohmann::json::const_iterator it = j->begin();
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700735 for (const std::string &argCode : dbusArgSplit(arg_type))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700736 {
737 if (it == j->end())
738 {
739 return -1;
740 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700741 r = convertJsonToDbus(m, argCode, *it);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700742 if (r < 0)
743 {
744 return r;
745 }
746 it++;
747 }
748 r = sd_bus_message_close_container(m);
749 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700750 else if (boost::starts_with(argCode, "{") &&
751 boost::ends_with(argCode, "}"))
Ed Tanous1abe55e2018-09-05 08:30:59 -0700752 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700753 std::string containedType = argCode.substr(1, argCode.size() - 1);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700754 r = sd_bus_message_open_container(m, SD_BUS_TYPE_DICT_ENTRY,
Ed Tanouse3cb5a32018-08-08 14:16:49 -0700755 containedType.c_str());
756 std::vector<std::string> codes = dbusArgSplit(containedType);
Ed Tanous1abe55e2018-09-05 08:30:59 -0700757 if (codes.size() != 2)
758 {
759 return -1;
760 }
761 const std::string &key_type = codes[0];
762 const std::string &value_type = codes[1];
763 for (auto it : j->items())
764 {
765 r = convertJsonToDbus(m, key_type, it.key());
766 if (r < 0)
767 {
768 return r;
769 }
770
771 r = convertJsonToDbus(m, value_type, it.value());
772 if (r < 0)
773 {
774 return r;
775 }
776 }
777 r = sd_bus_message_close_container(m);
778 }
779 else
780 {
781 return -2;
782 }
783 if (r < 0)
784 {
785 return r;
Ed Tanous75db20e2018-07-27 13:44:44 -0700786 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700787
Ed Tanous1abe55e2018-09-05 08:30:59 -0700788 if (argTypes.size() > 1)
789 {
790 jIt++;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700791 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700792 }
Matt Spinler127ea542019-01-14 11:04:28 -0600793
794 return r;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -0700795}
796
Matt Spinlerd22a7132019-01-14 12:14:30 -0600797template <typename T>
798int readMessageItem(const std::string &typeCode, sdbusplus::message::message &m,
799 nlohmann::json &data)
800{
801 T value;
802
803 int r = sd_bus_message_read_basic(m.get(), typeCode.front(), &value);
804 if (r < 0)
805 {
806 BMCWEB_LOG_ERROR << "sd_bus_message_read_basic on type " << typeCode
807 << " failed!";
808 return r;
809 }
810
811 data = value;
812 return 0;
813}
814
Matt Spinler16caaee2019-01-15 11:40:34 -0600815int convertDBusToJSON(const std::string &returnType,
Matt Spinler6df8f992019-01-14 12:47:47 -0600816 sdbusplus::message::message &m, nlohmann::json &response);
817
818int readDictEntryFromMessage(const std::string &typeCode,
819 sdbusplus::message::message &m,
820 nlohmann::json &object)
821{
822 std::vector<std::string> types = dbusArgSplit(typeCode);
823 if (types.size() != 2)
824 {
825 BMCWEB_LOG_ERROR << "wrong number contained types in dictionary: "
826 << types.size();
827 return -1;
828 }
829
830 int r = sd_bus_message_enter_container(m.get(), SD_BUS_TYPE_DICT_ENTRY,
831 typeCode.c_str());
832 if (r < 0)
833 {
834 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container with rc " << r;
835 return r;
836 }
837
838 nlohmann::json key;
839 r = convertDBusToJSON(types[0], m, key);
840 if (r < 0)
841 {
842 return r;
843 }
844
845 const std::string *keyPtr = key.get_ptr<const std::string *>();
846 if (keyPtr == nullptr)
847 {
848 // json doesn't support non-string keys. If we hit this condition,
849 // convert the result to a string so we can proceed
850 key = key.dump();
851 keyPtr = key.get_ptr<const std::string *>();
852 // in theory this can't fail now, but lets be paranoid about it anyway
853 if (keyPtr == nullptr)
854 {
855 return -1;
856 }
857 }
858 nlohmann::json &value = object[*keyPtr];
859
860 r = convertDBusToJSON(types[1], m, value);
861 if (r < 0)
862 {
863 return r;
864 }
865
866 r = sd_bus_message_exit_container(m.get());
867 if (r < 0)
868 {
869 BMCWEB_LOG_ERROR << "sd_bus_message_exit_container failed";
870 return r;
871 }
872
873 return 0;
874}
875
876int readArrayFromMessage(const std::string &typeCode,
877 sdbusplus::message::message &m, nlohmann::json &data)
878{
879 if (typeCode.size() < 2)
880 {
881 BMCWEB_LOG_ERROR << "Type code " << typeCode
882 << " too small for an array";
883 return -1;
884 }
885
886 std::string containedType = typeCode.substr(1);
887
888 int r = sd_bus_message_enter_container(m.get(), SD_BUS_TYPE_ARRAY,
889 containedType.c_str());
890 if (r < 0)
891 {
892 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container failed with rc "
893 << r;
894 return r;
895 }
896
897 bool dict = boost::starts_with(containedType, "{") &&
898 boost::ends_with(containedType, "}");
899
900 if (dict)
901 {
902 // Remove the { }
903 containedType = containedType.substr(1, containedType.size() - 2);
904 data = nlohmann::json::object();
905 }
906 else
907 {
908 data = nlohmann::json::array();
909 }
910
911 while (true)
912 {
913 r = sd_bus_message_at_end(m.get(), false);
914 if (r < 0)
915 {
916 BMCWEB_LOG_ERROR << "sd_bus_message_at_end failed";
917 return r;
918 }
919
920 if (r > 0)
921 {
922 break;
923 }
924
925 // Dictionaries are only ever seen in an array
926 if (dict)
927 {
928 r = readDictEntryFromMessage(containedType, m, data);
929 if (r < 0)
930 {
931 return r;
932 }
933 }
934 else
935 {
936 data.push_back(nlohmann::json());
937
938 r = convertDBusToJSON(containedType, m, data.back());
939 if (r < 0)
940 {
941 return r;
942 }
943 }
944 }
945
946 r = sd_bus_message_exit_container(m.get());
947 if (r < 0)
948 {
949 BMCWEB_LOG_ERROR << "sd_bus_message_exit_container failed";
950 return r;
951 }
952
953 return 0;
954}
955
Matt Spinler75c6c672019-01-14 13:01:46 -0600956int readStructFromMessage(const std::string &typeCode,
957 sdbusplus::message::message &m, nlohmann::json &data)
958{
959 if (typeCode.size() < 3)
960 {
961 BMCWEB_LOG_ERROR << "Type code " << typeCode
962 << " too small for a struct";
963 return -1;
964 }
965
966 std::string containedTypes = typeCode.substr(1, typeCode.size() - 2);
967 std::vector<std::string> types = dbusArgSplit(containedTypes);
968
969 int r = sd_bus_message_enter_container(m.get(), SD_BUS_TYPE_STRUCT,
970 containedTypes.c_str());
971 if (r < 0)
972 {
973 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container failed with rc "
974 << r;
975 return r;
976 }
977
978 for (const std::string &type : types)
979 {
980 data.push_back(nlohmann::json());
981 r = convertDBusToJSON(type, m, data.back());
982 if (r < 0)
983 {
984 return r;
985 }
986 }
987
988 r = sd_bus_message_exit_container(m.get());
989 if (r < 0)
990 {
991 BMCWEB_LOG_ERROR << "sd_bus_message_exit_container failed";
992 return r;
993 }
994 return 0;
995}
996
Matt Spinler89c19702019-01-14 13:13:00 -0600997int readVariantFromMessage(sdbusplus::message::message &m, nlohmann::json &data)
998{
999 const char *containerType;
1000 int r = sd_bus_message_peek_type(m.get(), NULL, &containerType);
1001 if (r < 0)
1002 {
1003 BMCWEB_LOG_ERROR << "sd_bus_message_peek_type failed";
1004 return r;
1005 }
1006
1007 r = sd_bus_message_enter_container(m.get(), SD_BUS_TYPE_VARIANT,
1008 containerType);
1009 if (r < 0)
1010 {
1011 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container failed with rc "
1012 << r;
1013 return r;
1014 }
1015
1016 r = convertDBusToJSON(containerType, m, data);
1017 if (r < 0)
1018 {
1019 return r;
1020 }
1021
1022 r = sd_bus_message_exit_container(m.get());
1023 if (r < 0)
1024 {
1025 BMCWEB_LOG_ERROR << "sd_bus_message_enter_container failed";
1026 return r;
1027 }
1028
1029 return 0;
1030}
1031
Matt Spinler6df8f992019-01-14 12:47:47 -06001032int convertDBusToJSON(const std::string &returnType,
Matt Spinler16caaee2019-01-15 11:40:34 -06001033 sdbusplus::message::message &m, nlohmann::json &response)
1034{
Matt Spinlerd22a7132019-01-14 12:14:30 -06001035 int r = 0;
1036 const std::vector<std::string> returnTypes = dbusArgSplit(returnType);
1037
Matt Spinlerd22a7132019-01-14 12:14:30 -06001038 for (const std::string &typeCode : returnTypes)
1039 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001040 nlohmann::json *thisElement = &response;
1041 if (returnTypes.size() > 1)
Matt Spinlerd22a7132019-01-14 12:14:30 -06001042 {
1043 response.push_back(nlohmann::json{});
Matt Spinlerf39420c2019-01-30 12:57:18 -06001044 thisElement = &response.back();
Matt Spinlerd22a7132019-01-14 12:14:30 -06001045 }
1046
1047 if (typeCode == "s")
1048 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001049 r = readMessageItem<char *>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001050 if (r < 0)
1051 {
1052 return r;
1053 }
1054 }
1055 else if (typeCode == "g")
1056 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001057 r = readMessageItem<char *>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001058 if (r < 0)
1059 {
1060 return r;
1061 }
1062 }
1063 else if (typeCode == "o")
1064 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001065 r = readMessageItem<char *>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001066 if (r < 0)
1067 {
1068 return r;
1069 }
1070 }
1071 else if (typeCode == "b")
1072 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001073 r = readMessageItem<int>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001074 if (r < 0)
1075 {
1076 return r;
1077 }
1078
Matt Spinlerf39420c2019-01-30 12:57:18 -06001079 *thisElement = static_cast<bool>(thisElement->get<int>());
Matt Spinlerd22a7132019-01-14 12:14:30 -06001080 }
1081 else if (typeCode == "u")
1082 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001083 r = readMessageItem<uint32_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001084 if (r < 0)
1085 {
1086 return r;
1087 }
1088 }
1089 else if (typeCode == "i")
1090 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001091 r = readMessageItem<int32_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001092 if (r < 0)
1093 {
1094 return r;
1095 }
1096 }
1097 else if (typeCode == "x")
1098 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001099 r = readMessageItem<int64_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001100 if (r < 0)
1101 {
1102 return r;
1103 }
1104 }
1105 else if (typeCode == "t")
1106 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001107 r = readMessageItem<uint64_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001108 if (r < 0)
1109 {
1110 return r;
1111 }
1112 }
1113 else if (typeCode == "n")
1114 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001115 r = readMessageItem<int16_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001116 if (r < 0)
1117 {
1118 return r;
1119 }
1120 }
1121 else if (typeCode == "q")
1122 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001123 r = readMessageItem<uint16_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001124 if (r < 0)
1125 {
1126 return r;
1127 }
1128 }
1129 else if (typeCode == "y")
1130 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001131 r = readMessageItem<uint8_t>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001132 if (r < 0)
1133 {
1134 return r;
1135 }
1136 }
1137 else if (typeCode == "d")
1138 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001139 r = readMessageItem<double>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001140 if (r < 0)
1141 {
1142 return r;
1143 }
1144 }
1145 else if (typeCode == "h")
1146 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001147 r = readMessageItem<int>(typeCode, m, *thisElement);
Matt Spinlerd22a7132019-01-14 12:14:30 -06001148 if (r < 0)
1149 {
1150 return r;
1151 }
1152 }
Matt Spinler6df8f992019-01-14 12:47:47 -06001153 else if (boost::starts_with(typeCode, "a"))
1154 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001155 r = readArrayFromMessage(typeCode, m, *thisElement);
Matt Spinler6df8f992019-01-14 12:47:47 -06001156 if (r < 0)
1157 {
1158 return r;
1159 }
1160 }
Matt Spinler75c6c672019-01-14 13:01:46 -06001161 else if (boost::starts_with(typeCode, "(") &&
1162 boost::ends_with(typeCode, ")"))
1163 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001164 r = readStructFromMessage(typeCode, m, *thisElement);
Matt Spinler75c6c672019-01-14 13:01:46 -06001165 if (r < 0)
1166 {
1167 return r;
1168 }
1169 }
Matt Spinler89c19702019-01-14 13:13:00 -06001170 else if (boost::starts_with(typeCode, "v"))
1171 {
Matt Spinlerf39420c2019-01-30 12:57:18 -06001172 r = readVariantFromMessage(m, *thisElement);
Matt Spinler89c19702019-01-14 13:13:00 -06001173 if (r < 0)
1174 {
1175 return r;
1176 }
1177 }
Matt Spinlerd22a7132019-01-14 12:14:30 -06001178 else
1179 {
Matt Spinlerd22a7132019-01-14 12:14:30 -06001180 BMCWEB_LOG_ERROR << "Invalid D-Bus signature type " << typeCode;
1181 return -2;
1182 }
1183 }
1184
Matt Spinler16caaee2019-01-15 11:40:34 -06001185 return 0;
1186}
1187
1188void handleMethodResponse(std::shared_ptr<InProgressActionData> transaction,
1189 sdbusplus::message::message &m,
1190 const std::string &returnType)
1191{
Matt Spinler39a4e392019-01-15 11:53:13 -06001192 nlohmann::json data;
1193
1194 int r = convertDBusToJSON(returnType, m, data);
1195 if (r < 0)
1196 {
1197 transaction->outputFailed = true;
1198 return;
1199 }
1200
1201 if (data.is_null())
1202 {
1203 return;
1204 }
1205
1206 if (transaction->methodResponse.is_null())
1207 {
1208 transaction->methodResponse = std::move(data);
1209 return;
1210 }
1211
1212 // If they're both dictionaries or arrays, merge into one.
1213 // Otherwise, make the results an array with every result
1214 // an entry. Could also just fail in that case, but it
1215 // seems better to get the data back somehow.
1216
1217 if (transaction->methodResponse.is_object() && data.is_object())
1218 {
1219 for (const auto &obj : data.items())
1220 {
1221 // Note: Will overwrite the data for a duplicate key
1222 transaction->methodResponse.emplace(obj.key(),
1223 std::move(obj.value()));
1224 }
1225 return;
1226 }
1227
1228 if (transaction->methodResponse.is_array() && data.is_array())
1229 {
1230 for (auto &obj : data)
1231 {
1232 transaction->methodResponse.push_back(std::move(obj));
1233 }
1234 return;
1235 }
1236
1237 if (!transaction->convertedToArray)
1238 {
1239 // They are different types. May as well turn them into an array
1240 nlohmann::json j = std::move(transaction->methodResponse);
1241 transaction->methodResponse = nlohmann::json::array();
1242 transaction->methodResponse.push_back(std::move(j));
1243 transaction->methodResponse.push_back(std::move(data));
1244 transaction->convertedToArray = true;
1245 }
1246 else
1247 {
1248 transaction->methodResponse.push_back(std::move(data));
1249 }
Matt Spinler16caaee2019-01-15 11:40:34 -06001250}
1251
Ed Tanousd76323e2018-08-07 14:35:40 -07001252void findActionOnInterface(std::shared_ptr<InProgressActionData> transaction,
Ed Tanous1abe55e2018-09-05 08:30:59 -07001253 const std::string &connectionName)
1254{
1255 BMCWEB_LOG_DEBUG << "findActionOnInterface for connection "
1256 << connectionName;
1257 crow::connections::systemBus->async_method_call(
1258 [transaction, connectionName{std::string(connectionName)}](
1259 const boost::system::error_code ec,
1260 const std::string &introspect_xml) {
1261 BMCWEB_LOG_DEBUG << "got xml:\n " << introspect_xml;
1262 if (ec)
1263 {
1264 BMCWEB_LOG_ERROR
1265 << "Introspect call failed with error: " << ec.message()
1266 << " on process: " << connectionName << "\n";
Matt Spinler318bd892019-01-15 09:59:20 -06001267 return;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001268 }
Matt Spinler318bd892019-01-15 09:59:20 -06001269 tinyxml2::XMLDocument doc;
1270
1271 doc.Parse(introspect_xml.data(), introspect_xml.size());
1272 tinyxml2::XMLNode *pRoot = doc.FirstChildElement("node");
1273 if (pRoot == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001274 {
Matt Spinler318bd892019-01-15 09:59:20 -06001275 BMCWEB_LOG_ERROR << "XML document failed to parse "
1276 << connectionName << "\n";
1277 return;
1278 }
1279 tinyxml2::XMLElement *interfaceNode =
1280 pRoot->FirstChildElement("interface");
1281 while (interfaceNode != nullptr)
1282 {
1283 const char *thisInterfaceName =
1284 interfaceNode->Attribute("name");
1285 if (thisInterfaceName != nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001286 {
Matt Spinler318bd892019-01-15 09:59:20 -06001287 if (!transaction->interfaceName.empty() &&
1288 (transaction->interfaceName != thisInterfaceName))
Ed Tanous1abe55e2018-09-05 08:30:59 -07001289 {
Matt Spinler318bd892019-01-15 09:59:20 -06001290 interfaceNode =
1291 interfaceNode->NextSiblingElement("interface");
1292 continue;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001293 }
Matt Spinler318bd892019-01-15 09:59:20 -06001294
1295 tinyxml2::XMLElement *methodNode =
1296 interfaceNode->FirstChildElement("method");
1297 while (methodNode != nullptr)
1298 {
1299 const char *thisMethodName =
1300 methodNode->Attribute("name");
1301 BMCWEB_LOG_DEBUG << "Found method: " << thisMethodName;
1302 if (thisMethodName != nullptr &&
1303 thisMethodName == transaction->methodName)
1304 {
1305 BMCWEB_LOG_DEBUG
1306 << "Found method named " << thisMethodName
1307 << " on interface " << thisInterfaceName;
1308 sdbusplus::message::message m =
1309 crow::connections::systemBus->new_method_call(
1310 connectionName.c_str(),
1311 transaction->path.c_str(),
1312 thisInterfaceName,
1313 transaction->methodName.c_str());
1314
1315 tinyxml2::XMLElement *argumentNode =
1316 methodNode->FirstChildElement("arg");
1317
Matt Spinler16caaee2019-01-15 11:40:34 -06001318 std::string returnType;
1319
1320 // Find the output type
1321 while (argumentNode != nullptr)
1322 {
1323 const char *argDirection =
1324 argumentNode->Attribute("direction");
1325 const char *argType =
1326 argumentNode->Attribute("type");
1327 if (argDirection != nullptr &&
1328 argType != nullptr &&
1329 std::string(argDirection) == "out")
1330 {
1331 returnType = argType;
1332 break;
1333 }
1334 argumentNode =
1335 argumentNode->NextSiblingElement("arg");
1336 }
1337
Matt Spinler318bd892019-01-15 09:59:20 -06001338 nlohmann::json::const_iterator argIt =
1339 transaction->arguments.begin();
1340
Matt Spinler16caaee2019-01-15 11:40:34 -06001341 argumentNode = methodNode->FirstChildElement("arg");
1342
Matt Spinler318bd892019-01-15 09:59:20 -06001343 while (argumentNode != nullptr)
1344 {
1345 const char *argDirection =
1346 argumentNode->Attribute("direction");
1347 const char *argType =
1348 argumentNode->Attribute("type");
1349 if (argDirection != nullptr &&
1350 argType != nullptr &&
1351 std::string(argDirection) == "in")
1352 {
1353 if (argIt == transaction->arguments.end())
1354 {
1355 transaction->setErrorStatus(
1356 "Invalid method args");
1357 return;
1358 }
1359 if (convertJsonToDbus(m.get(),
1360 std::string(argType),
1361 *argIt) < 0)
1362 {
1363 transaction->setErrorStatus(
1364 "Invalid method arg type");
1365 return;
1366 }
1367
1368 argIt++;
1369 }
1370 argumentNode =
1371 argumentNode->NextSiblingElement("arg");
1372 }
1373
1374 crow::connections::systemBus->async_send(
Matt Spinler16caaee2019-01-15 11:40:34 -06001375 m, [transaction, returnType](
1376 boost::system::error_code ec,
1377 sdbusplus::message::message &m) {
Matt Spinler318bd892019-01-15 09:59:20 -06001378 if (ec)
1379 {
Matt Spinler16caaee2019-01-15 11:40:34 -06001380 transaction->methodFailed = true;
Matt Spinler318bd892019-01-15 09:59:20 -06001381 return;
1382 }
Matt Spinler16caaee2019-01-15 11:40:34 -06001383 else
1384 {
1385 transaction->methodPassed = true;
1386 }
1387
1388 handleMethodResponse(transaction, m,
1389 returnType);
Matt Spinler318bd892019-01-15 09:59:20 -06001390 });
1391 break;
1392 }
1393 methodNode = methodNode->NextSiblingElement("method");
1394 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001395 }
Matt Spinler318bd892019-01-15 09:59:20 -06001396 interfaceNode = interfaceNode->NextSiblingElement("interface");
Ed Tanous1abe55e2018-09-05 08:30:59 -07001397 }
1398 },
1399 connectionName, transaction->path,
1400 "org.freedesktop.DBus.Introspectable", "Introspect");
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001401}
1402
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001403void handleAction(const crow::Request &req, crow::Response &res,
1404 const std::string &objectPath, const std::string &methodName)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001405{
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001406 BMCWEB_LOG_DEBUG << "handleAction on path: " << objectPath << " and method "
1407 << methodName;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001408 nlohmann::json requestDbusData =
1409 nlohmann::json::parse(req.body, nullptr, false);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001410
Ed Tanous1abe55e2018-09-05 08:30:59 -07001411 if (requestDbusData.is_discarded())
1412 {
Matt Spinler6db06242018-12-11 11:21:22 -06001413 setErrorResponse(res, boost::beast::http::status::bad_request,
1414 noJsonDesc, badReqMsg);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001415 res.end();
Ed Tanous1abe55e2018-09-05 08:30:59 -07001416 return;
1417 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001418 nlohmann::json::iterator data = requestDbusData.find("data");
1419 if (data == requestDbusData.end())
1420 {
Matt Spinler6db06242018-12-11 11:21:22 -06001421 setErrorResponse(res, boost::beast::http::status::bad_request,
1422 noJsonDesc, badReqMsg);
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001423 res.end();
1424 return;
1425 }
1426
1427 if (!data->is_array())
Ed Tanous1abe55e2018-09-05 08:30:59 -07001428 {
Matt Spinler6db06242018-12-11 11:21:22 -06001429 setErrorResponse(res, boost::beast::http::status::bad_request,
1430 noJsonDesc, badReqMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001431 res.end();
1432 return;
1433 }
1434 auto transaction = std::make_shared<InProgressActionData>(res);
1435
1436 transaction->path = objectPath;
1437 transaction->methodName = methodName;
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001438 transaction->arguments = std::move(*data);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001439 crow::connections::systemBus->async_method_call(
1440 [transaction](
1441 const boost::system::error_code ec,
1442 const std::vector<std::pair<std::string, std::vector<std::string>>>
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001443 &interfaceNames) {
1444 if (ec || interfaceNames.size() <= 0)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001445 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001446 BMCWEB_LOG_ERROR << "Can't find object";
Matt Spinler6db06242018-12-11 11:21:22 -06001447 setErrorResponse(transaction->res,
1448 boost::beast::http::status::not_found,
1449 notFoundDesc, notFoundMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001450 return;
1451 }
1452
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001453 BMCWEB_LOG_DEBUG << "GetObject returned " << interfaceNames.size()
1454 << " object(s)";
Ed Tanous1abe55e2018-09-05 08:30:59 -07001455
1456 for (const std::pair<std::string, std::vector<std::string>>
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001457 &object : interfaceNames)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001458 {
1459 findActionOnInterface(transaction, object.first);
1460 }
1461 },
1462 "xyz.openbmc_project.ObjectMapper",
1463 "/xyz/openbmc_project/object_mapper",
1464 "xyz.openbmc_project.ObjectMapper", "GetObject", objectPath,
1465 std::array<std::string, 0>());
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001466}
1467
Matt Spinlerde818812018-12-11 16:39:20 -06001468void handleDelete(const crow::Request &req, crow::Response &res,
1469 const std::string &objectPath)
1470{
1471 BMCWEB_LOG_DEBUG << "handleDelete on path: " << objectPath;
1472
1473 crow::connections::systemBus->async_method_call(
1474 [&res, objectPath](
1475 const boost::system::error_code ec,
1476 const std::vector<std::pair<std::string, std::vector<std::string>>>
1477 &interfaceNames) {
1478 if (ec || interfaceNames.size() <= 0)
1479 {
1480 BMCWEB_LOG_ERROR << "Can't find object";
Matt Spinler62d2e8b2019-01-22 13:45:51 -06001481 setErrorResponse(res,
1482 boost::beast::http::status::method_not_allowed,
1483 methodNotAllowedDesc, methodNotAllowedMsg);
Matt Spinlerde818812018-12-11 16:39:20 -06001484 res.end();
1485 return;
1486 }
1487
1488 auto transaction = std::make_shared<InProgressActionData>(res);
1489 transaction->path = objectPath;
1490 transaction->methodName = "Delete";
1491 transaction->interfaceName = "xyz.openbmc_project.Object.Delete";
1492
1493 for (const std::pair<std::string, std::vector<std::string>>
1494 &object : interfaceNames)
1495 {
1496 findActionOnInterface(transaction, object.first);
1497 }
1498 },
1499 "xyz.openbmc_project.ObjectMapper",
1500 "/xyz/openbmc_project/object_mapper",
1501 "xyz.openbmc_project.ObjectMapper", "GetObject", objectPath,
1502 std::array<const char *, 0>());
1503}
1504
Ed Tanousf839dfe2018-11-12 11:11:15 -08001505void handleList(crow::Response &res, const std::string &objectPath,
1506 int32_t depth = 0)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001507{
1508 crow::connections::systemBus->async_method_call(
1509 [&res](const boost::system::error_code ec,
1510 std::vector<std::string> &objectPaths) {
1511 if (ec)
1512 {
Matt Spinlerd6091dd2018-12-06 14:08:27 -06001513 setErrorResponse(res, boost::beast::http::status::not_found,
1514 notFoundDesc, notFoundMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001515 }
1516 else
1517 {
1518 res.jsonValue = {{"status", "ok"},
1519 {"message", "200 OK"},
1520 {"data", std::move(objectPaths)}};
1521 }
1522 res.end();
1523 },
1524 "xyz.openbmc_project.ObjectMapper",
1525 "/xyz/openbmc_project/object_mapper",
1526 "xyz.openbmc_project.ObjectMapper", "GetSubTreePaths", objectPath,
Ed Tanousf839dfe2018-11-12 11:11:15 -08001527 depth, std::array<std::string, 0>());
Ed Tanous1abe55e2018-09-05 08:30:59 -07001528}
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001529
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001530void handleEnumerate(crow::Response &res, const std::string &objectPath)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001531{
Ed Tanous049a0512018-11-01 13:58:42 -07001532 BMCWEB_LOG_DEBUG << "Doing enumerate on " << objectPath;
1533 auto asyncResp = std::make_shared<bmcweb::AsyncResp>(res);
1534
1535 asyncResp->res.jsonValue = {{"message", "200 OK"},
1536 {"status", "ok"},
1537 {"data", nlohmann::json::object()}};
1538
Ed Tanous1abe55e2018-09-05 08:30:59 -07001539 crow::connections::systemBus->async_method_call(
Matt Spinler3ae4ba72018-12-05 14:01:22 -06001540 [objectPath, asyncResp](const boost::system::error_code ec,
1541 GetSubTreeType &object_names) {
1542 auto transaction = std::make_shared<InProgressEnumerateData>(
1543 objectPath, asyncResp);
1544
1545 transaction->subtree =
1546 std::make_shared<GetSubTreeType>(std::move(object_names));
1547
Ed Tanous1abe55e2018-09-05 08:30:59 -07001548 if (ec)
1549 {
Matt Spinler2ae60092018-12-06 10:35:36 -06001550 BMCWEB_LOG_ERROR << "GetSubTree failed on "
1551 << transaction->objectPath;
1552 setErrorResponse(transaction->asyncResp->res,
1553 boost::beast::http::status::not_found,
1554 notFoundDesc, notFoundMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001555 return;
1556 }
Ed Tanous64530012018-02-06 17:08:16 -08001557
Matt Spinler3ae4ba72018-12-05 14:01:22 -06001558 // Add the data for the path passed in to the results
1559 // as if GetSubTree returned it, and continue on enumerating
1560 getObjectAndEnumerate(transaction);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001561 },
1562 "xyz.openbmc_project.ObjectMapper",
1563 "/xyz/openbmc_project/object_mapper",
1564 "xyz.openbmc_project.ObjectMapper", "GetSubTree", objectPath,
Ed Tanous049a0512018-11-01 13:58:42 -07001565 static_cast<int32_t>(0), std::array<const char *, 0>());
Ed Tanous64530012018-02-06 17:08:16 -08001566}
Ed Tanous911ac312017-08-15 09:37:42 -07001567
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001568void handleGet(crow::Response &res, std::string &objectPath,
1569 std::string &destProperty)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001570{
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001571 BMCWEB_LOG_DEBUG << "handleGet: " << objectPath << " prop:" << destProperty;
1572 std::shared_ptr<std::string> propertyName =
Ed Tanous1abe55e2018-09-05 08:30:59 -07001573 std::make_shared<std::string>(std::move(destProperty));
Ed Tanous75db20e2018-07-27 13:44:44 -07001574
Ed Tanous1abe55e2018-09-05 08:30:59 -07001575 std::shared_ptr<std::string> path =
1576 std::make_shared<std::string>(std::move(objectPath));
Ed Tanous75db20e2018-07-27 13:44:44 -07001577
Ed Tanous1abe55e2018-09-05 08:30:59 -07001578 using GetObjectType =
1579 std::vector<std::pair<std::string, std::vector<std::string>>>;
1580 crow::connections::systemBus->async_method_call(
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001581 [&res, path, propertyName](const boost::system::error_code ec,
1582 const GetObjectType &object_names) {
Ed Tanous1abe55e2018-09-05 08:30:59 -07001583 if (ec || object_names.size() <= 0)
1584 {
Matt Spinlerdc2f9f12018-12-06 13:53:53 -06001585 setErrorResponse(res, boost::beast::http::status::not_found,
1586 notFoundDesc, notFoundMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001587 res.end();
1588 return;
1589 }
1590 std::shared_ptr<nlohmann::json> response =
1591 std::make_shared<nlohmann::json>(nlohmann::json::object());
1592 // The mapper should never give us an empty interface names list,
1593 // but check anyway
1594 for (const std::pair<std::string, std::vector<std::string>>
1595 connection : object_names)
1596 {
1597 const std::vector<std::string> &interfaceNames =
1598 connection.second;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001599
Ed Tanous1abe55e2018-09-05 08:30:59 -07001600 if (interfaceNames.size() <= 0)
1601 {
Matt Spinlerdc2f9f12018-12-06 13:53:53 -06001602 setErrorResponse(res, boost::beast::http::status::not_found,
1603 notFoundDesc, notFoundMsg);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001604 res.end();
Ed Tanous1abe55e2018-09-05 08:30:59 -07001605 return;
1606 }
1607
1608 for (const std::string &interface : interfaceNames)
1609 {
Matt Spinlerfe7e97d2019-01-30 15:33:21 -06001610 sdbusplus::message::message m =
1611 crow::connections::systemBus->new_method_call(
1612 connection.first.c_str(), path->c_str(),
1613 "org.freedesktop.DBus.Properties", "GetAll");
1614 m.append(interface);
1615 crow::connections::systemBus->async_send(
1616 m, [&res, response,
1617 propertyName](const boost::system::error_code ec,
1618 sdbusplus::message::message &msg) {
Ed Tanous1abe55e2018-09-05 08:30:59 -07001619 if (ec)
1620 {
1621 BMCWEB_LOG_ERROR << "Bad dbus request error: "
1622 << ec;
1623 }
1624 else
1625 {
Matt Spinlerfe7e97d2019-01-30 15:33:21 -06001626 nlohmann::json properties;
1627 int r =
1628 convertDBusToJSON("a{sv}", msg, properties);
1629 if (r < 0)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001630 {
Matt Spinlerfe7e97d2019-01-30 15:33:21 -06001631 BMCWEB_LOG_ERROR
1632 << "convertDBusToJSON failed";
1633 }
1634 else
1635 {
1636 for (auto &prop : properties.items())
1637 {
1638 // if property name is empty, or matches
1639 // our search query, add it to the
1640 // response json
Ed Tanous1abe55e2018-09-05 08:30:59 -07001641
Matt Spinlerfe7e97d2019-01-30 15:33:21 -06001642 if (propertyName->empty())
1643 {
1644 (*response)[prop.key()] =
1645 std::move(prop.value());
1646 }
1647 else if (prop.key() == *propertyName)
1648 {
1649 *response = std::move(prop.value());
1650 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001651 }
1652 }
1653 }
1654 if (response.use_count() == 1)
1655 {
Matt Spinlerdc2f9f12018-12-06 13:53:53 -06001656 if (!propertyName->empty() && response->empty())
1657 {
1658 setErrorResponse(
1659 res,
1660 boost::beast::http::status::not_found,
1661 propNotFoundDesc, notFoundMsg);
1662 }
1663 else
1664 {
1665 res.jsonValue = {{"status", "ok"},
1666 {"message", "200 OK"},
1667 {"data", *response}};
1668 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001669 res.end();
1670 }
Matt Spinlerfe7e97d2019-01-30 15:33:21 -06001671 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07001672 }
1673 }
1674 },
1675 "xyz.openbmc_project.ObjectMapper",
1676 "/xyz/openbmc_project/object_mapper",
1677 "xyz.openbmc_project.ObjectMapper", "GetObject", *path,
1678 std::array<std::string, 0>());
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001679}
1680
Ed Tanous1abe55e2018-09-05 08:30:59 -07001681struct AsyncPutRequest
1682{
1683 AsyncPutRequest(crow::Response &res) : res(res)
1684 {
Ed Tanous1abe55e2018-09-05 08:30:59 -07001685 }
1686 ~AsyncPutRequest()
1687 {
Ed Tanous1abe55e2018-09-05 08:30:59 -07001688 if (res.jsonValue.empty())
1689 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001690 setErrorResponse(res, boost::beast::http::status::forbidden,
1691 forbiddenMsg, forbiddenPropDesc);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001692 }
1693
1694 res.end();
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001695 }
1696
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001697 void setErrorStatus(const std::string &desc)
Ed Tanous1abe55e2018-09-05 08:30:59 -07001698 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001699 setErrorResponse(res, boost::beast::http::status::internal_server_error,
1700 desc, badReqMsg);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001701 }
1702
Ed Tanous1abe55e2018-09-05 08:30:59 -07001703 crow::Response &res;
1704 std::string objectPath;
1705 std::string propertyName;
1706 nlohmann::json propertyValue;
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001707};
1708
Ed Tanousd76323e2018-08-07 14:35:40 -07001709void handlePut(const crow::Request &req, crow::Response &res,
Ed Tanous1abe55e2018-09-05 08:30:59 -07001710 const std::string &objectPath, const std::string &destProperty)
1711{
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001712 if (destProperty.empty())
1713 {
1714 setErrorResponse(res, boost::beast::http::status::forbidden,
1715 forbiddenResDesc, forbiddenMsg);
1716 res.end();
1717 return;
1718 }
1719
Ed Tanous1abe55e2018-09-05 08:30:59 -07001720 nlohmann::json requestDbusData =
1721 nlohmann::json::parse(req.body, nullptr, false);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001722
Ed Tanous1abe55e2018-09-05 08:30:59 -07001723 if (requestDbusData.is_discarded())
1724 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001725 setErrorResponse(res, boost::beast::http::status::bad_request,
1726 noJsonDesc, badReqMsg);
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001727 res.end();
1728 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -07001729 }
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001730
Ed Tanous1abe55e2018-09-05 08:30:59 -07001731 nlohmann::json::const_iterator propertyIt = requestDbusData.find("data");
1732 if (propertyIt == requestDbusData.end())
1733 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001734 setErrorResponse(res, boost::beast::http::status::bad_request,
1735 noJsonDesc, badReqMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001736 res.end();
1737 return;
1738 }
1739 const nlohmann::json &propertySetValue = *propertyIt;
1740 auto transaction = std::make_shared<AsyncPutRequest>(res);
1741 transaction->objectPath = objectPath;
1742 transaction->propertyName = destProperty;
1743 transaction->propertyValue = propertySetValue;
Ed Tanous911ac312017-08-15 09:37:42 -07001744
Ed Tanous1abe55e2018-09-05 08:30:59 -07001745 using GetObjectType =
1746 std::vector<std::pair<std::string, std::vector<std::string>>>;
Ed Tanous911ac312017-08-15 09:37:42 -07001747
Ed Tanous1abe55e2018-09-05 08:30:59 -07001748 crow::connections::systemBus->async_method_call(
1749 [transaction](const boost::system::error_code ec,
1750 const GetObjectType &object_names) {
1751 if (!ec && object_names.size() <= 0)
1752 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001753 setErrorResponse(transaction->res,
1754 boost::beast::http::status::not_found,
1755 propNotFoundDesc, notFoundMsg);
Ed Tanous1abe55e2018-09-05 08:30:59 -07001756 return;
1757 }
Ed Tanous911ac312017-08-15 09:37:42 -07001758
Ed Tanous1abe55e2018-09-05 08:30:59 -07001759 for (const std::pair<std::string, std::vector<std::string>>
1760 connection : object_names)
1761 {
1762 const std::string &connectionName = connection.first;
Ed Tanous911ac312017-08-15 09:37:42 -07001763
Ed Tanous1abe55e2018-09-05 08:30:59 -07001764 crow::connections::systemBus->async_method_call(
1765 [connectionName{std::string(connectionName)},
1766 transaction](const boost::system::error_code ec,
1767 const std::string &introspectXml) {
1768 if (ec)
1769 {
1770 BMCWEB_LOG_ERROR
1771 << "Introspect call failed with error: "
1772 << ec.message()
1773 << " on process: " << connectionName;
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001774 transaction->setErrorStatus("Unexpected Error");
Ed Tanous1abe55e2018-09-05 08:30:59 -07001775 return;
Ed Tanous911ac312017-08-15 09:37:42 -07001776 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001777 tinyxml2::XMLDocument doc;
Ed Tanous911ac312017-08-15 09:37:42 -07001778
Ed Tanous1abe55e2018-09-05 08:30:59 -07001779 doc.Parse(introspectXml.c_str());
1780 tinyxml2::XMLNode *pRoot =
1781 doc.FirstChildElement("node");
1782 if (pRoot == nullptr)
1783 {
1784 BMCWEB_LOG_ERROR << "XML document failed to parse: "
1785 << introspectXml;
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001786 transaction->setErrorStatus("Unexpected Error");
Ed Tanous1abe55e2018-09-05 08:30:59 -07001787 return;
Ed Tanous911ac312017-08-15 09:37:42 -07001788 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07001789 tinyxml2::XMLElement *ifaceNode =
1790 pRoot->FirstChildElement("interface");
1791 while (ifaceNode != nullptr)
1792 {
1793 const char *interfaceName =
1794 ifaceNode->Attribute("name");
1795 BMCWEB_LOG_DEBUG << "found interface "
1796 << interfaceName;
1797 tinyxml2::XMLElement *propNode =
1798 ifaceNode->FirstChildElement("property");
1799 while (propNode != nullptr)
1800 {
1801 const char *propertyName =
1802 propNode->Attribute("name");
1803 BMCWEB_LOG_DEBUG << "Found property "
1804 << propertyName;
1805 if (propertyName == transaction->propertyName)
1806 {
1807 const char *argType =
1808 propNode->Attribute("type");
1809 if (argType != nullptr)
1810 {
1811 sdbusplus::message::message m =
1812 crow::connections::systemBus
1813 ->new_method_call(
1814 connectionName.c_str(),
1815 transaction->objectPath
1816 .c_str(),
1817 "org.freedesktop.DBus."
1818 "Properties",
1819 "Set");
1820 m.append(interfaceName,
1821 transaction->propertyName);
1822 int r = sd_bus_message_open_container(
1823 m.get(), SD_BUS_TYPE_VARIANT,
1824 argType);
1825 if (r < 0)
1826 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001827 transaction->setErrorStatus(
1828 "Unexpected Error");
Ed Tanous1abe55e2018-09-05 08:30:59 -07001829 return;
1830 }
1831 r = convertJsonToDbus(
1832 m.get(), argType,
1833 transaction->propertyValue);
1834 if (r < 0)
1835 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001836 transaction->setErrorStatus(
1837 "Invalid arg type");
Ed Tanous1abe55e2018-09-05 08:30:59 -07001838 return;
1839 }
1840 r = sd_bus_message_close_container(
1841 m.get());
1842 if (r < 0)
1843 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001844 transaction->setErrorStatus(
1845 "Unexpected Error");
Ed Tanous1abe55e2018-09-05 08:30:59 -07001846 return;
1847 }
Ed Tanous911ac312017-08-15 09:37:42 -07001848
Ed Tanous1abe55e2018-09-05 08:30:59 -07001849 crow::connections::systemBus
1850 ->async_send(
1851 m,
1852 [transaction](
1853 boost::system::error_code
1854 ec,
1855 sdbusplus::message::message
1856 &m) {
1857 BMCWEB_LOG_DEBUG << "sent";
1858 if (ec)
1859 {
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001860 setErrorResponse(
1861 transaction->res,
1862 boost::beast::http::
1863 status::
1864 forbidden,
1865 forbiddenPropDesc,
1866 ec.message());
1867 }
1868 else
1869 {
Ed Tanous1abe55e2018-09-05 08:30:59 -07001870 transaction->res
Matt Spinlerfbc19ea2018-12-11 14:03:42 -06001871 .jsonValue = {
1872 {"status", "ok"},
1873 {"message",
1874 "200 OK"},
1875 {"data", nullptr}};
Ed Tanous1abe55e2018-09-05 08:30:59 -07001876 }
1877 });
1878 }
1879 }
1880 propNode =
1881 propNode->NextSiblingElement("property");
1882 }
1883 ifaceNode =
1884 ifaceNode->NextSiblingElement("interface");
1885 }
1886 },
1887 connectionName, transaction->objectPath,
1888 "org.freedesktop.DBus.Introspectable", "Introspect");
1889 }
1890 },
1891 "xyz.openbmc_project.ObjectMapper",
1892 "/xyz/openbmc_project/object_mapper",
1893 "xyz.openbmc_project.ObjectMapper", "GetObject",
1894 transaction->objectPath, std::array<std::string, 0>());
Ed Tanousd4bb9bb2018-05-16 13:36:42 -07001895}
Ed Tanous1abe55e2018-09-05 08:30:59 -07001896
Ed Tanous049a0512018-11-01 13:58:42 -07001897inline void handleDBusUrl(const crow::Request &req, crow::Response &res,
1898 std::string &objectPath)
1899{
Ed Tanous049a0512018-11-01 13:58:42 -07001900
1901 // If accessing a single attribute, fill in and update objectPath,
1902 // otherwise leave destProperty blank
1903 std::string destProperty = "";
1904 const char *attrSeperator = "/attr/";
1905 size_t attrPosition = objectPath.find(attrSeperator);
1906 if (attrPosition != objectPath.npos)
1907 {
1908 destProperty = objectPath.substr(attrPosition + strlen(attrSeperator),
1909 objectPath.length());
1910 objectPath = objectPath.substr(0, attrPosition);
1911 }
1912
1913 if (req.method() == "POST"_method)
1914 {
1915 constexpr const char *actionSeperator = "/action/";
1916 size_t actionPosition = objectPath.find(actionSeperator);
1917 if (actionPosition != objectPath.npos)
1918 {
1919 std::string postProperty =
1920 objectPath.substr((actionPosition + strlen(actionSeperator)),
1921 objectPath.length());
1922 objectPath = objectPath.substr(0, actionPosition);
1923 handleAction(req, res, objectPath, postProperty);
1924 return;
1925 }
1926 }
1927 else if (req.method() == "GET"_method)
1928 {
1929 if (boost::ends_with(objectPath, "/enumerate"))
1930 {
1931 objectPath.erase(objectPath.end() - sizeof("enumerate"),
1932 objectPath.end());
1933 handleEnumerate(res, objectPath);
1934 }
1935 else if (boost::ends_with(objectPath, "/list"))
1936 {
1937 objectPath.erase(objectPath.end() - sizeof("list"),
1938 objectPath.end());
1939 handleList(res, objectPath);
1940 }
1941 else
1942 {
Ed Tanousf839dfe2018-11-12 11:11:15 -08001943 // Trim any trailing "/" at the end
1944 if (boost::ends_with(objectPath, "/"))
1945 {
1946 objectPath.pop_back();
1947 handleList(res, objectPath, 1);
1948 }
1949 else
1950 {
1951 handleGet(res, objectPath, destProperty);
1952 }
Ed Tanous049a0512018-11-01 13:58:42 -07001953 }
1954 return;
1955 }
1956 else if (req.method() == "PUT"_method)
1957 {
1958 handlePut(req, res, objectPath, destProperty);
1959 return;
1960 }
Matt Spinlerde818812018-12-11 16:39:20 -06001961 else if (req.method() == "DELETE"_method)
1962 {
1963 handleDelete(req, res, objectPath);
1964 return;
1965 }
Ed Tanous049a0512018-11-01 13:58:42 -07001966
Matt Spinlerc4e8d21d62018-12-11 11:47:17 -06001967 setErrorResponse(res, boost::beast::http::status::method_not_allowed,
1968 methodNotAllowedDesc, methodNotAllowedMsg);
Ed Tanous049a0512018-11-01 13:58:42 -07001969 res.end();
1970}
1971
Ed Tanous1abe55e2018-09-05 08:30:59 -07001972template <typename... Middlewares> void requestRoutes(Crow<Middlewares...> &app)
1973{
1974 BMCWEB_ROUTE(app, "/bus/")
1975 .methods("GET"_method)(
1976 [](const crow::Request &req, crow::Response &res) {
1977 res.jsonValue = {{"busses", {{{"name", "system"}}}},
1978 {"status", "ok"}};
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001979 res.end();
Ed Tanous1abe55e2018-09-05 08:30:59 -07001980 });
1981
1982 BMCWEB_ROUTE(app, "/bus/system/")
1983 .methods("GET"_method)(
1984 [](const crow::Request &req, crow::Response &res) {
1985 auto myCallback = [&res](const boost::system::error_code ec,
1986 std::vector<std::string> &names) {
1987 if (ec)
1988 {
1989 BMCWEB_LOG_ERROR << "Dbus call failed with code " << ec;
1990 res.result(
1991 boost::beast::http::status::internal_server_error);
1992 }
1993 else
1994 {
1995 std::sort(names.begin(), names.end());
Ed Tanouse3cb5a32018-08-08 14:16:49 -07001996 res.jsonValue = {{"status", "ok"}};
1997 auto &objectsSub = res.jsonValue["objects"];
Ed Tanous1abe55e2018-09-05 08:30:59 -07001998 for (auto &name : names)
1999 {
2000 objectsSub.push_back({{"name", name}});
2001 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07002002 }
2003 res.end();
2004 };
2005 crow::connections::systemBus->async_method_call(
2006 std::move(myCallback), "org.freedesktop.DBus", "/",
2007 "org.freedesktop.DBus", "ListNames");
2008 });
2009
2010 BMCWEB_ROUTE(app, "/list/")
2011 .methods("GET"_method)(
2012 [](const crow::Request &req, crow::Response &res) {
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002013 handleList(res, "/");
Ed Tanous1abe55e2018-09-05 08:30:59 -07002014 });
2015
2016 BMCWEB_ROUTE(app, "/xyz/<path>")
Matt Spinlerde818812018-12-11 16:39:20 -06002017 .methods("GET"_method, "PUT"_method, "POST"_method, "DELETE"_method)(
Ed Tanous049a0512018-11-01 13:58:42 -07002018 [](const crow::Request &req, crow::Response &res,
2019 const std::string &path) {
2020 std::string objectPath = "/xyz/" + path;
2021 handleDBusUrl(req, res, objectPath);
2022 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002023
Ed Tanous049a0512018-11-01 13:58:42 -07002024 BMCWEB_ROUTE(app, "/org/<path>")
Matt Spinlerde818812018-12-11 16:39:20 -06002025 .methods("GET"_method, "PUT"_method, "POST"_method, "DELETE"_method)(
Ed Tanous049a0512018-11-01 13:58:42 -07002026 [](const crow::Request &req, crow::Response &res,
2027 const std::string &path) {
2028 std::string objectPath = "/org/" + path;
2029 handleDBusUrl(req, res, objectPath);
2030 });
Ed Tanous1abe55e2018-09-05 08:30:59 -07002031
Ed Tanous1abe55e2018-09-05 08:30:59 -07002032 BMCWEB_ROUTE(app, "/download/dump/<str>/")
2033 .methods("GET"_method)([](const crow::Request &req, crow::Response &res,
2034 const std::string &dumpId) {
Ed Tanousad18f072018-11-14 14:07:48 -08002035 std::regex validFilename("^[\\w\\- ]+(\\.?[\\w\\- ]*)$");
Ed Tanous1abe55e2018-09-05 08:30:59 -07002036 if (!std::regex_match(dumpId, validFilename))
2037 {
Ed Tanousad18f072018-11-14 14:07:48 -08002038 res.result(boost::beast::http::status::bad_request);
Ed Tanous1abe55e2018-09-05 08:30:59 -07002039 res.end();
2040 return;
2041 }
James Feistf6150402019-01-08 10:36:20 -08002042 std::filesystem::path loc(
Ed Tanous1abe55e2018-09-05 08:30:59 -07002043 "/var/lib/phosphor-debug-collector/dumps");
2044
Ed Tanousad18f072018-11-14 14:07:48 -08002045 loc /= dumpId;
Ed Tanous1abe55e2018-09-05 08:30:59 -07002046
James Feistf6150402019-01-08 10:36:20 -08002047 if (!std::filesystem::exists(loc) ||
2048 !std::filesystem::is_directory(loc))
Ed Tanous1abe55e2018-09-05 08:30:59 -07002049 {
Ed Tanousad18f072018-11-14 14:07:48 -08002050 BMCWEB_LOG_ERROR << loc << "Not found";
Ed Tanous1abe55e2018-09-05 08:30:59 -07002051 res.result(boost::beast::http::status::not_found);
2052 res.end();
2053 return;
2054 }
James Feistf6150402019-01-08 10:36:20 -08002055 std::filesystem::directory_iterator files(loc);
Ed Tanousad18f072018-11-14 14:07:48 -08002056
Ed Tanous1abe55e2018-09-05 08:30:59 -07002057 for (auto &file : files)
2058 {
2059 std::ifstream readFile(file.path());
Ed Tanousad18f072018-11-14 14:07:48 -08002060 if (!readFile.good())
Ed Tanous1abe55e2018-09-05 08:30:59 -07002061 {
2062 continue;
2063 }
2064 res.addHeader("Content-Type", "application/octet-stream");
2065 res.body() = {std::istreambuf_iterator<char>(readFile),
2066 std::istreambuf_iterator<char>()};
2067 res.end();
Ed Tanousad18f072018-11-14 14:07:48 -08002068 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -07002069 }
2070 res.result(boost::beast::http::status::not_found);
2071 res.end();
2072 return;
2073 });
2074
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002075 BMCWEB_ROUTE(app, "/bus/system/<str>/")
Ed Tanous1abe55e2018-09-05 08:30:59 -07002076 .methods("GET"_method)([](const crow::Request &req, crow::Response &res,
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002077 const std::string &Connection) {
2078 introspectObjects(Connection, "/",
2079 std::make_shared<bmcweb::AsyncResp>(res));
2080 });
2081
2082 BMCWEB_ROUTE(app, "/bus/system/<str>/<path>")
2083 .methods("GET"_method,
2084 "POST"_method)([](const crow::Request &req,
2085 crow::Response &res,
2086 const std::string &processName,
2087 const std::string &requestedPath) {
Ed Tanous1abe55e2018-09-05 08:30:59 -07002088 std::vector<std::string> strs;
2089 boost::split(strs, requestedPath, boost::is_any_of("/"));
2090 std::string objectPath;
2091 std::string interfaceName;
2092 std::string methodName;
2093 auto it = strs.begin();
2094 if (it == strs.end())
2095 {
2096 objectPath = "/";
2097 }
2098 while (it != strs.end())
2099 {
2100 // Check if segment contains ".". If it does, it must be an
2101 // interface
2102 if (it->find(".") != std::string::npos)
2103 {
2104 break;
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002105 // This check is neccesary as the trailing slash gets parsed
Ed Tanous1abe55e2018-09-05 08:30:59 -07002106 // as part of our <path> specifier above, which causes the
2107 // normal trailing backslash redirector to fail.
2108 }
2109 else if (!it->empty())
2110 {
2111 objectPath += "/" + *it;
2112 }
2113 it++;
2114 }
2115 if (it != strs.end())
2116 {
2117 interfaceName = *it;
2118 it++;
2119
2120 // after interface, we might have a method name
2121 if (it != strs.end())
2122 {
2123 methodName = *it;
2124 it++;
2125 }
2126 }
2127 if (it != strs.end())
2128 {
2129 // if there is more levels past the method name, something went
2130 // wrong, return not found
2131 res.result(boost::beast::http::status::not_found);
2132 res.end();
2133 return;
2134 }
2135 if (interfaceName.empty())
2136 {
2137 crow::connections::systemBus->async_method_call(
2138 [&, processName,
2139 objectPath](const boost::system::error_code ec,
2140 const std::string &introspect_xml) {
2141 if (ec)
2142 {
2143 BMCWEB_LOG_ERROR
2144 << "Introspect call failed with error: "
2145 << ec.message()
2146 << " on process: " << processName
2147 << " path: " << objectPath << "\n";
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002148 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -07002149 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002150 tinyxml2::XMLDocument doc;
2151
2152 doc.Parse(introspect_xml.c_str());
2153 tinyxml2::XMLNode *pRoot =
2154 doc.FirstChildElement("node");
2155 if (pRoot == nullptr)
Ed Tanous1abe55e2018-09-05 08:30:59 -07002156 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002157 BMCWEB_LOG_ERROR << "XML document failed to parse "
2158 << processName << " " << objectPath
2159 << "\n";
2160 res.jsonValue = {{"status", "XML parse error"}};
2161 res.result(boost::beast::http::status::
2162 internal_server_error);
2163 return;
Ed Tanous1abe55e2018-09-05 08:30:59 -07002164 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002165
2166 BMCWEB_LOG_DEBUG << introspect_xml;
2167 res.jsonValue = {{"status", "ok"},
2168 {"bus_name", processName},
2169 {"object_path", objectPath}};
2170 nlohmann::json &interfacesArray =
2171 res.jsonValue["interfaces"];
2172 interfacesArray = nlohmann::json::array();
2173 tinyxml2::XMLElement *interface =
2174 pRoot->FirstChildElement("interface");
2175
2176 while (interface != nullptr)
2177 {
2178 const char *ifaceName =
2179 interface->Attribute("name");
2180 if (ifaceName != nullptr)
2181 {
2182 interfacesArray.push_back(
2183 {{"name", ifaceName}});
2184 }
2185
2186 interface =
2187 interface->NextSiblingElement("interface");
2188 }
2189
Ed Tanous1abe55e2018-09-05 08:30:59 -07002190 res.end();
2191 },
2192 processName, objectPath,
2193 "org.freedesktop.DBus.Introspectable", "Introspect");
2194 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002195 else if (methodName.empty())
Ed Tanous1abe55e2018-09-05 08:30:59 -07002196 {
2197 crow::connections::systemBus->async_method_call(
2198 [&, processName, objectPath,
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002199 interfaceName{std::move(interfaceName)}](
Ed Tanous1abe55e2018-09-05 08:30:59 -07002200 const boost::system::error_code ec,
2201 const std::string &introspect_xml) {
2202 if (ec)
2203 {
2204 BMCWEB_LOG_ERROR
2205 << "Introspect call failed with error: "
2206 << ec.message()
2207 << " on process: " << processName
2208 << " path: " << objectPath << "\n";
2209 }
2210 else
2211 {
2212 tinyxml2::XMLDocument doc;
2213
2214 doc.Parse(introspect_xml.c_str());
2215 tinyxml2::XMLNode *pRoot =
2216 doc.FirstChildElement("node");
2217 if (pRoot == nullptr)
2218 {
2219 BMCWEB_LOG_ERROR
2220 << "XML document failed to parse "
2221 << processName << " " << objectPath << "\n";
2222 res.result(boost::beast::http::status::
2223 internal_server_error);
2224 }
2225 else
2226 {
2227 tinyxml2::XMLElement *node =
2228 pRoot->FirstChildElement("node");
2229
2230 // if we know we're the only call, build the
2231 // json directly
Ed Tanous1abe55e2018-09-05 08:30:59 -07002232 tinyxml2::XMLElement *interface =
2233 pRoot->FirstChildElement("interface");
2234
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002235 res.jsonValue = {
2236 {"status", "ok"},
2237 {"bus_name", processName},
2238 {"interface", interfaceName},
2239 {"object_path", objectPath},
2240 {"properties", nlohmann::json::object()}};
2241
2242 nlohmann::json &methodsArray =
2243 res.jsonValue["methods"];
2244 methodsArray = nlohmann::json::array();
2245
2246 nlohmann::json &signalsArray =
2247 res.jsonValue["signals"];
2248 signalsArray = nlohmann::json::array();
2249
Ed Tanous1abe55e2018-09-05 08:30:59 -07002250 while (interface != nullptr)
2251 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002252 const char *ifaceName =
Ed Tanous1abe55e2018-09-05 08:30:59 -07002253 interface->Attribute("name");
2254
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002255 if (ifaceName != nullptr &&
2256 ifaceName == interfaceName)
Ed Tanous1abe55e2018-09-05 08:30:59 -07002257 {
2258 tinyxml2::XMLElement *methods =
2259 interface->FirstChildElement(
2260 "method");
2261 while (methods != nullptr)
2262 {
2263 nlohmann::json argsArray =
2264 nlohmann::json::array();
2265 tinyxml2::XMLElement *arg =
2266 methods->FirstChildElement(
2267 "arg");
2268 while (arg != nullptr)
2269 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002270 nlohmann::json thisArg;
2271 for (const char *fieldName :
2272 std::array<const char *,
2273 3>{"name",
2274 "direction",
2275 "type"})
2276 {
2277 const char *fieldValue =
2278 arg->Attribute(
2279 fieldName);
2280 if (fieldValue != nullptr)
2281 {
2282 thisArg[fieldName] =
2283 fieldValue;
2284 }
2285 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07002286 argsArray.push_back(
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002287 std::move(thisArg));
Ed Tanous1abe55e2018-09-05 08:30:59 -07002288 arg = arg->NextSiblingElement(
2289 "arg");
2290 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002291
2292 const char *name =
2293 methods->Attribute("name");
2294 if (name != nullptr)
2295 {
2296 methodsArray.push_back(
2297 {{"name", name},
2298 {"uri", "/bus/system/" +
2299 processName +
2300 objectPath +
2301 "/" +
2302 interfaceName +
2303 "/" + name},
2304 {"args", argsArray}});
2305 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07002306 methods =
2307 methods->NextSiblingElement(
2308 "method");
2309 }
2310 tinyxml2::XMLElement *signals =
2311 interface->FirstChildElement(
2312 "signal");
2313 while (signals != nullptr)
2314 {
2315 nlohmann::json argsArray =
2316 nlohmann::json::array();
2317
2318 tinyxml2::XMLElement *arg =
2319 signals->FirstChildElement(
2320 "arg");
2321 while (arg != nullptr)
2322 {
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002323 const char *name =
Ed Tanous1abe55e2018-09-05 08:30:59 -07002324 arg->Attribute("name");
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002325 const char *type =
Ed Tanous1abe55e2018-09-05 08:30:59 -07002326 arg->Attribute("type");
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002327 if (name != nullptr &&
2328 type != nullptr)
2329 {
2330 argsArray.push_back({
2331 {"name", name},
2332 {"type", type},
2333 });
2334 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07002335 arg = arg->NextSiblingElement(
2336 "arg");
2337 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002338 const char *name =
2339 signals->Attribute("name");
2340 if (name != nullptr)
2341 {
2342 signalsArray.push_back(
2343 {{"name", name},
2344 {"args", argsArray}});
2345 }
2346
Ed Tanous1abe55e2018-09-05 08:30:59 -07002347 signals =
2348 signals->NextSiblingElement(
2349 "signal");
2350 }
2351
Ed Tanous1abe55e2018-09-05 08:30:59 -07002352 break;
2353 }
2354
2355 interface = interface->NextSiblingElement(
2356 "interface");
2357 }
2358 if (interface == nullptr)
2359 {
2360 // if we got to the end of the list and
2361 // never found a match, throw 404
2362 res.result(
2363 boost::beast::http::status::not_found);
2364 }
2365 }
2366 }
2367 res.end();
2368 },
2369 processName, objectPath,
2370 "org.freedesktop.DBus.Introspectable", "Introspect");
2371 }
Ed Tanouse3cb5a32018-08-08 14:16:49 -07002372 else
2373 {
2374 if (req.method() != "POST"_method)
2375 {
2376 res.result(boost::beast::http::status::not_found);
2377 res.end();
2378 return;
2379 }
2380
2381 nlohmann::json requestDbusData =
2382 nlohmann::json::parse(req.body, nullptr, false);
2383
2384 if (requestDbusData.is_discarded())
2385 {
2386 res.result(boost::beast::http::status::bad_request);
2387 res.end();
2388 return;
2389 }
2390 if (!requestDbusData.is_array())
2391 {
2392 res.result(boost::beast::http::status::bad_request);
2393 res.end();
2394 return;
2395 }
2396 auto transaction = std::make_shared<InProgressActionData>(res);
2397
2398 transaction->path = objectPath;
2399 transaction->methodName = methodName;
2400 transaction->arguments = std::move(requestDbusData);
2401
2402 findActionOnInterface(transaction, processName);
2403 }
Ed Tanous1abe55e2018-09-05 08:30:59 -07002404 });
2405}
2406} // namespace openbmc_mapper
2407} // namespace crow