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
|
/*
// 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 <crow/http_request.h>
#include <crow/http_response.h>
#include <nlohmann/json.hpp>
namespace redfish
{
namespace json_util
{
/**
* @brief Defines JSON utils operation status
*/
enum class Result
{
SUCCESS,
NOT_EXIST,
WRONG_TYPE,
NULL_POINTER
};
/**
* @brief Describes JSON utils messages requirement
*/
enum class MessageSetting
{
NONE = 0x0, ///< No messages will be added
MISSING = 0x1, ///< PropertyMissing message will be added
TYPE_ERROR = 0x2 ///< PropertyValueTypeError message will be added
};
/**
* @brief Wrapper function for extracting string from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getString(const char* fieldName, const nlohmann::json& json,
const std::string*& output);
/**
* @brief Wrapper function for extracting object from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getObject(const char* fieldName, const nlohmann::json& json,
nlohmann::json* output);
/**
* @brief Wrapper function for extracting array from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getArray(const char* fieldName, const nlohmann::json& json,
nlohmann::json* output);
/**
* @brief Wrapper function for extracting int from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getInt(const char* fieldName, const nlohmann::json& json,
int64_t& output);
/**
* @brief Wrapper function for extracting uint from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getUnsigned(const char* fieldName, const nlohmann::json& json,
uint64_t& output);
/**
* @brief Wrapper function for extracting bool from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getBool(const char* fieldName, const nlohmann::json& json, bool& output);
/**
* @brief Wrapper function for extracting float from JSON object without
* throwing exceptions (nlohmann stores JSON floats as C++ doubles)
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getDouble(const char* fieldName, const nlohmann::json& json,
double& output);
/**
* @brief Wrapper function for extracting string from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
* @param[in] msgCfgMap Map for message addition settings
* @param[out] msgJson JSON to which error messages will be added
* @param[in] fieldPath Field path in JSON
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getString(const char* fieldName, const nlohmann::json& json,
const std::string*& output, uint8_t msgCfgMap,
nlohmann::json& msgJson, const std::string&& fieldPath);
/**
* @brief Wrapper function for extracting object from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
* @param[in] msgCfgMap Map for message addition settings
* @param[out] msgJson JSON to which error messages will be added
* @param[in] fieldPath Field path in JSON
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getObject(const char* fieldName, const nlohmann::json& json,
nlohmann::json* output, uint8_t msgCfgMap,
nlohmann::json& msgJson, const std::string&& fieldPath);
/**
* @brief Wrapper function for extracting array from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
* @param[in] msgCfgMap Map for message addition settings
* @param[out] msgJson JSON to which error messages will be added
* @param[in] fieldPath Field path in JSON
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getArray(const char* fieldName, const nlohmann::json& json,
nlohmann::json* output, uint8_t msgCfgMap,
nlohmann::json& msgJson, const std::string&& fieldPath);
/**
* @brief Wrapper function for extracting int from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
* @param[in] msgCfgMap Map for message addition settings
* @param[out] msgJson JSON to which error messages will be added
* @param[in] fieldPath Field path in JSON
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getInt(const char* fieldName, const nlohmann::json& json,
int64_t& output, uint8_t msgCfgMap, nlohmann::json& msgJson,
const std::string&& fieldPath);
/**
* @brief Wrapper function for extracting uint from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
* @param[in] msgCfgMap Map for message addition settings
* @param[out] msgJson JSON to which error messages will be added
* @param[in] fieldPath Field path in JSON
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getUnsigned(const char* fieldName, const nlohmann::json& json,
uint64_t& output, uint8_t msgCfgMap, nlohmann::json& msgJson,
const std::string&& fieldPath);
/**
* @brief Wrapper function for extracting bool from JSON object without
* throwing exceptions
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
* @param[in] msgCfgMap Map for message addition settings
* @param[out] msgJson JSON to which error messages will be added
* @param[in] fieldPath Field path in JSON
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getBool(const char* fieldName, const nlohmann::json& json, bool& output,
uint8_t msgCfgMap, nlohmann::json& msgJson,
const std::string&& fieldPath);
/**
* @brief Wrapper function for extracting float from JSON object without
* throwing exceptions (nlohmann stores JSON floats as C++ doubles)
*
* @param[in] fieldName Name of requested field
* @param[in] json JSON object from which field should be extracted
* @param[out] output Variable to which extracted will be written in case
* of success
* @param[in] msgCfgMap Map for message addition settings
* @param[out] msgJson JSON to which error messages will be added
* @param[in] fieldPath Field path in JSON
*
* @return Result informing about operation status, output will be
* written only in case of Result::SUCCESS
*/
Result getDouble(const char* fieldName, const nlohmann::json& json,
double& output, uint8_t msgCfgMap, nlohmann::json& msgJson,
const std::string&& fieldPath);
/**
* @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 json_util
} // namespace redfish
|
