blob: 1f7774f72915d7c4f3e6ab01c14784b087c832bc [file] [log] [blame]
Ed Tanousf4c99e72021-10-04 17:02:43 -07001#pragma once
2
3#include "utils/query_param.hpp"
4
5#include <bmcweb_config.h>
6
7namespace redfish
8{
9
Nan Zhoua6b91252022-04-04 13:10:40 -070010// Sets up the Redfish Route and delegates some of the query parameter
11// processing. |queryCapabilities| stores which query parameters will be
12// handled by redfish-core/lib codes, then default query parameter handler won't
13// process these parameters.
14[[nodiscard]] inline bool setUpRedfishRouteWithDelegation(
15 crow::App& app, const crow::Request& req, crow::Response& res,
16 query_param::Query& delegated,
17 const query_param::QueryCapabilities& queryCapabilities)
Ed Tanousf4c99e72021-10-04 17:02:43 -070018{
Ed Tanous142ec9a2022-03-24 18:20:45 -070019 BMCWEB_LOG_DEBUG << "setup redfish route";
20
21 // Section 7.4 of the redfish spec "Redfish Services shall process the
22 // [OData-Version header] in the following table as defined by the HTTP 1.1
23 // specification..."
24 // Required to pass redfish-protocol-validator REQ_HEADERS_ODATA_VERSION
25 std::string_view odataHeader = req.getHeaderValue("OData-Version");
26 if (!odataHeader.empty() && odataHeader != "4.0")
27 {
28 messages::preconditionFailed(res);
29 return false;
30 }
31
Ed Tanousc02a74f2022-05-11 14:46:44 -070032 res.addHeader("OData-Version", "4.0");
33
Ed Tanousf4c99e72021-10-04 17:02:43 -070034 std::optional<query_param::Query> queryOpt =
35 query_param::parseParameters(req.urlView.params(), res);
36 if (queryOpt == std::nullopt)
37 {
38 return false;
39 }
40
Ed Tanous7cf436c2022-03-22 23:53:51 -070041 // If this isn't a get, no need to do anything with parameters
42 if (req.method() != boost::beast::http::verb::get)
43 {
44 return true;
45 }
46
Nan Zhoua6b91252022-04-04 13:10:40 -070047 delegated = query_param::delegate(queryCapabilities, *queryOpt);
Ed Tanousf4c99e72021-10-04 17:02:43 -070048 std::function<void(crow::Response&)> handler =
49 res.releaseCompleteRequestHandler();
Ed Tanousf4c99e72021-10-04 17:02:43 -070050 res.setCompleteRequestHandler(
51 [&app, handler(std::move(handler)),
52 query{*queryOpt}](crow::Response& res) mutable {
Ed Tanous002d39b2022-05-31 08:59:27 -070053 processAllParams(app, query, handler, res);
54 });
Ed Tanousf4c99e72021-10-04 17:02:43 -070055 return true;
56}
Nan Zhoua6b91252022-04-04 13:10:40 -070057
58// Sets up the Redfish Route. All parameters are handled by the default handler.
59[[nodiscard]] inline bool setUpRedfishRoute(crow::App& app,
60 const crow::Request& req,
61 crow::Response& res)
62{
63 // This route |delegated| is never used
64 query_param::Query delegated;
65 return setUpRedfishRouteWithDelegation(app, req, res, delegated,
66 query_param::QueryCapabilities{});
67}
Ed Tanousf4c99e72021-10-04 17:02:43 -070068} // namespace redfish