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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
/*
// Copyright (c) 2018 Intel Corporation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
*/
#pragma once
#include <http_request.h>
#include <http_response.h>
#include <bitset>
#include <error_messages.hpp>
#include <nlohmann/json.hpp>
namespace redfish
{
namespace json_util
{
/**
* @brief Processes request to extract JSON from its body. If it fails, adds
* MalformedJSON message to response and ends it.
*
* @param[io] res Response object
* @param[in] req Request object
* @param[out] reqJson JSON object extracted from request's body
*
* @return true if JSON is valid, false when JSON is invalid and response has
* been filled with message and ended.
*/
bool processJsonFromRequest(crow::Response& res, const crow::Request& req,
nlohmann::json& reqJson);
namespace details
{
template <typename Type> struct is_optional : std::false_type
{
};
template <typename Type>
struct is_optional<std::optional<Type>> : std::true_type
{
};
template <typename Type>
constexpr bool is_optional_v = is_optional<Type>::value;
template <typename Type> struct is_vector : std::false_type
{
};
template <typename Type> struct is_vector<std::vector<Type>> : std::true_type
{
};
template <typename Type> constexpr bool is_vector_v = is_vector<Type>::value;
template <typename Type> struct is_std_array : std::false_type
{
};
template <typename Type, std::size_t size>
struct is_std_array<std::array<Type, size>> : std::true_type
{
};
template <typename Type>
constexpr bool is_std_array_v = is_std_array<Type>::value;
template <typename ToType, typename FromType>
bool checkRange(const FromType& from, const std::string& key,
nlohmann::json& jsonValue, crow::Response& res)
{
if (from > std::numeric_limits<ToType>::max())
{
BMCWEB_LOG_DEBUG << "Value for key " << key
<< " was greater than max: " << __PRETTY_FUNCTION__;
messages::propertyValueNotInList(res, jsonValue.dump(), key);
return false;
}
if (from < std::numeric_limits<ToType>::lowest())
{
BMCWEB_LOG_DEBUG << "Value for key " << key
<< " was less than min: " << __PRETTY_FUNCTION__;
messages::propertyValueNotInList(res, jsonValue.dump(), key);
return false;
}
if constexpr (std::is_floating_point_v<ToType>)
{
if (std::isnan(from))
{
BMCWEB_LOG_DEBUG << "Value for key " << key << " was NAN";
messages::propertyValueNotInList(res, jsonValue.dump(), key);
return false;
}
}
return true;
}
template <typename Type>
bool unpackValue(nlohmann::json& jsonValue, const std::string& key,
crow::Response& res, Type& value)
{
bool ret = true;
if constexpr (std::is_floating_point_v<Type>)
{
double helper = 0;
double* jsonPtr = jsonValue.get_ptr<double*>();
if (jsonPtr == nullptr)
{
int64_t* intPtr = jsonValue.get_ptr<int64_t*>();
if (intPtr != nullptr)
{
helper = static_cast<double>(*intPtr);
jsonPtr = &helper;
}
}
if (jsonPtr == nullptr)
{
messages::propertyValueTypeError(res, jsonValue.dump(), key);
return false;
}
if (!checkRange<Type>(*jsonPtr, key, jsonValue, res))
{
return false;
}
value = static_cast<Type>(*jsonPtr);
}
else if constexpr (std::is_signed_v<Type>)
{
int64_t* jsonPtr = jsonValue.get_ptr<int64_t*>();
if (jsonPtr == nullptr)
{
messages::propertyValueTypeError(res, jsonValue.dump(), key);
return false;
}
if (!checkRange<Type>(*jsonPtr, key, jsonValue, res))
{
return false;
}
value = static_cast<Type>(*jsonPtr);
}
else if constexpr ((std::is_unsigned_v<Type>)&&(
!std::is_same_v<bool, Type>))
{
uint64_t* jsonPtr = jsonValue.get_ptr<uint64_t*>();
if (jsonPtr == nullptr)
{
messages::propertyValueTypeError(res, jsonValue.dump(), key);
return false;
}
if (!checkRange<Type>(*jsonPtr, key, jsonValue, res))
{
return false;
}
value = static_cast<Type>(*jsonPtr);
}
else if constexpr (is_optional_v<Type>)
{
value.emplace();
ret = unpackValue<typename Type::value_type>(jsonValue, key, res,
*value) &&
ret;
}
else if constexpr (std::is_same_v<nlohmann::json, Type>)
{
// Must be a complex type. Simple types (int string etc) should be
// unpacked directly
if (!jsonValue.is_object() && !jsonValue.is_array() &&
!jsonValue.is_null())
{
messages::propertyValueTypeError(res, jsonValue.dump(), key);
return false;
}
value = std::move(jsonValue);
}
else if constexpr (is_std_array_v<Type>)
{
if (!jsonValue.is_array())
{
messages::propertyValueTypeError(res, res.jsonValue.dump(), key);
return false;
}
if (jsonValue.size() != value.size())
{
messages::propertyValueTypeError(res, res.jsonValue.dump(), key);
return false;
}
size_t index = 0;
for (const auto& val : jsonValue.items())
{
ret = unpackValue<typename Type::value_type>(val.value(), key, res,
value[index++]) &&
ret;
}
}
else if constexpr (is_vector_v<Type>)
{
if (!jsonValue.is_array())
{
messages::propertyValueTypeError(res, res.jsonValue.dump(), key);
return false;
}
for (const auto& val : jsonValue.items())
{
value.emplace_back();
ret = unpackValue<typename Type::value_type>(val.value(), key, res,
value.back()) &&
ret;
}
}
else
{
using JsonType = std::add_const_t<std::add_pointer_t<Type>>;
JsonType jsonPtr = jsonValue.get_ptr<JsonType>();
if (jsonPtr == nullptr)
{
BMCWEB_LOG_DEBUG
<< "Value for key " << key
<< " was incorrect type: " << jsonValue.type_name();
messages::propertyValueTypeError(res, jsonValue.dump(), key);
return false;
}
value = std::move(*jsonPtr);
}
return ret;
}
template <size_t Count, size_t Index>
bool readJsonValues(const std::string& key, nlohmann::json& jsonValue,
crow::Response& res, std::bitset<Count>& handled)
{
BMCWEB_LOG_DEBUG << "Unable to find variable for key" << key;
messages::propertyUnknown(res, key);
return false;
}
template <size_t Count, size_t Index, typename ValueType,
typename... UnpackTypes>
bool readJsonValues(const std::string& key, nlohmann::json& jsonValue,
crow::Response& res, std::bitset<Count>& handled,
const char* keyToCheck, ValueType& valueToFill,
UnpackTypes&... in)
{
bool ret = true;
if (key != keyToCheck)
{
ret = readJsonValues<Count, Index + 1>(key, jsonValue, res, handled,
in...) &&
ret;
return ret;
}
handled.set(Index);
return unpackValue<ValueType>(jsonValue, key, res, valueToFill) && ret;
}
template <size_t Index = 0, size_t Count>
bool handleMissing(std::bitset<Count>& handled, crow::Response& res)
{
return true;
}
template <size_t Index = 0, size_t Count, typename ValueType,
typename... UnpackTypes>
bool handleMissing(std::bitset<Count>& handled, crow::Response& res,
const char* key, ValueType& unused, UnpackTypes&... in)
{
bool ret = true;
if (!handled.test(Index) && !is_optional_v<ValueType>)
{
ret = false;
messages::propertyMissing(res, key);
}
return details::handleMissing<Index + 1, Count>(handled, res, in...) && ret;
}
} // namespace details
template <typename... UnpackTypes>
bool readJson(nlohmann::json& jsonRequest, crow::Response& res, const char* key,
UnpackTypes&... in)
{
bool result = true;
if (!jsonRequest.is_object())
{
BMCWEB_LOG_DEBUG << "Json value is not an object";
messages::unrecognizedRequestBody(res);
return false;
}
if (jsonRequest.empty())
{
BMCWEB_LOG_DEBUG << "Json value is empty";
messages::emptyJSON(res);
return false;
}
std::bitset<(sizeof...(in) + 1) / 2> handled(0);
for (const auto& item : jsonRequest.items())
{
result =
details::readJsonValues<(sizeof...(in) + 1) / 2, 0, UnpackTypes...>(
item.key(), item.value(), res, handled, key, in...) &&
result;
}
BMCWEB_LOG_DEBUG << "JSON result is: " << result;
return details::handleMissing(handled, res, key, in...) && result;
}
template <typename... UnpackTypes>
bool readJson(const crow::Request& req, crow::Response& res, const char* key,
UnpackTypes&... in)
{
nlohmann::json jsonRequest;
if (!json_util::processJsonFromRequest(res, req, jsonRequest))
{
BMCWEB_LOG_DEBUG << "Json value not readable";
return false;
}
return readJson(jsonRequest, res, key, in...);
}
} // namespace json_util
} // namespace redfish
|