1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
|
#pragma once
#include "app.hpp"
#include "error_messages.hpp"
#include "http_request.hpp"
#include "http_response.hpp"
#include "query.hpp"
#include "registries/privilege_registry.hpp"
#include "schemas.hpp"
#include "utility.hpp"
#include <boost/url/format.hpp>
#include <string>
namespace redfish
{
inline void redfishGet(App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
asyncResp->res.jsonValue["v1"] = "/redfish/v1/";
}
inline void redfish404(App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& path)
{
asyncResp->res.addHeader(boost::beast::http::field::allow, "");
// If we fall to this route, we didn't have a more specific route, so return
// 404
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
BMCWEB_LOG_WARNING << "404 on path " << path;
std::string name = req.url().segments().back();
// Note, if we hit the wildcard route, we don't know the "type" the user was
// actually requesting, but giving them a return with an empty string is
// still better than nothing.
messages::resourceNotFound(asyncResp->res, "", name);
}
inline void redfish405(App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& path)
{
// If we fall to this route, we didn't have a more specific route, so return
// 405
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
BMCWEB_LOG_WARNING << "405 on path " << path;
asyncResp->res.result(boost::beast::http::status::method_not_allowed);
if (req.method() == boost::beast::http::verb::delete_)
{
messages::resourceCannotBeDeleted(asyncResp->res);
}
else
{
messages::operationNotAllowed(asyncResp->res);
}
}
inline void
jsonSchemaIndexGet(App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
nlohmann::json& json = asyncResp->res.jsonValue;
json["@odata.id"] = "/redfish/v1/JsonSchemas";
json["@odata.type"] = "#JsonSchemaFileCollection.JsonSchemaFileCollection";
json["Name"] = "JsonSchemaFile Collection";
json["Description"] = "Collection of JsonSchemaFiles";
nlohmann::json::array_t members;
for (std::string_view schema : schemas)
{
nlohmann::json::object_t member;
member["@odata.id"] = boost::urls::format("/redfish/v1/JsonSchemas/{}",
schema);
members.emplace_back(std::move(member));
}
json["Members"] = std::move(members);
json["Members@odata.count"] = schemas.size();
}
inline void jsonSchemaGet(App& app, const crow::Request& req,
const std::shared_ptr<bmcweb::AsyncResp>& asyncResp,
const std::string& schema)
{
if (!redfish::setUpRedfishRoute(app, req, asyncResp))
{
return;
}
if (std::find(schemas.begin(), schemas.end(), schema) == schemas.end())
{
messages::resourceNotFound(asyncResp->res, "JsonSchemaFile", schema);
return;
}
nlohmann::json& json = asyncResp->res.jsonValue;
json["@odata.id"] = boost::urls::format("/redfish/v1/JsonSchemas/{}",
schema);
json["@odata.type"] = "#JsonSchemaFile.v1_0_2.JsonSchemaFile";
json["Name"] = schema + " Schema File";
json["Description"] = schema + " Schema File Location";
json["Id"] = schema;
std::string schemaName = "#";
schemaName += schema;
schemaName += ".";
schemaName += schema;
json["Schema"] = std::move(schemaName);
constexpr std::array<std::string_view, 1> languages{"en"};
json["Languages"] = languages;
json["Languages@odata.count"] = languages.size();
nlohmann::json::array_t locationArray;
nlohmann::json::object_t locationEntry;
locationEntry["Language"] = "en";
locationEntry["PublicationUri"] = "http://redfish.dmtf.org/schemas/v1/" +
schema + ".json";
locationEntry["Uri"] = boost::urls::format(
"/redfish/v1/JsonSchemas/{}/{}", schema, std::string(schema) + ".json");
locationArray.emplace_back(locationEntry);
json["Location"] = std::move(locationArray);
json["Location@odata.count"] = 1;
}
inline void requestRoutesRedfish(App& app)
{
BMCWEB_ROUTE(app, "/redfish/")
.methods(boost::beast::http::verb::get)(
std::bind_front(redfishGet, std::ref(app)));
BMCWEB_ROUTE(app, "/redfish/v1/JsonSchemas/<str>/")
.privileges(redfish::privileges::getJsonSchemaFileCollection)
.methods(boost::beast::http::verb::get)(
std::bind_front(jsonSchemaGet, std::ref(app)));
BMCWEB_ROUTE(app, "/redfish/v1/JsonSchemas/")
.privileges(redfish::privileges::getJsonSchemaFile)
.methods(boost::beast::http::verb::get)(
std::bind_front(jsonSchemaIndexGet, std::ref(app)));
// Note, this route must always be registered last
BMCWEB_ROUTE(app, "/redfish/<path>")
.notFound()
.privileges(redfish::privileges::privilegeSetLogin)(
std::bind_front(redfish404, std::ref(app)));
BMCWEB_ROUTE(app, "/redfish/<path>")
.methodNotAllowed()
.privileges(redfish::privileges::privilegeSetLogin)(
std::bind_front(redfish405, std::ref(app)));
}
} // namespace redfish
|
