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
|
/*
Itay Marom
Cisco Systems, Inc.
*/
/*
Copyright (c) 2015-2015 Cisco Systems, Inc.
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.
*/
#include <trex_rpc_exception_api.h>
#include <trex_rpc_jsonrpc_v2_parser.h>
#include <trex_rpc_cmd_api.h>
#include <trex_rpc_cmds_table.h>
#include <json/json.h>
#include <iostream>
/**
* error as described in the RFC
* http://www.jsonrpc.org/specification
*/
enum {
JSONRPC_V2_ERR_PARSE = -32700,
JSONRPC_V2_ERR_INVALID_REQ = -32600,
JSONRPC_V2_ERR_METHOD_NOT_FOUND = -32601,
JSONRPC_V2_ERR_INVALID_PARAMS = -32602,
JSONRPC_V2_ERR_INTERNAL_ERROR = -32603,
/* specific server errors */
JSONRPC_V2_ERR_EXECUTE_ERROR = -32000,
};
/*************** JSON RPC parsed object base type ************/
TrexJsonRpcV2ParsedObject::TrexJsonRpcV2ParsedObject(const Json::Value &msg_id, bool force = false) : m_msg_id(msg_id) {
/* if we have msg_id or a force was issued - write resposne */
m_respond = (msg_id != Json::Value::null) || force;
}
void TrexJsonRpcV2ParsedObject::execute(Json::Value &response) {
/* common fields */
if (m_respond) {
response["jsonrpc"] = "2.0";
response["id"] = m_msg_id;
_execute(response);
} else {
Json::Value dummy;
_execute(dummy);
}
}
/****************** valid method return value **************/
class JsonRpcMethod : public TrexJsonRpcV2ParsedObject {
public:
JsonRpcMethod(const Json::Value &msg_id, TrexRpcCommand *cmd, const Json::Value ¶ms) : TrexJsonRpcV2ParsedObject(msg_id), m_cmd(cmd), m_params(params) {
}
virtual void _execute(Json::Value &response) {
Json::Value result;
trex_rpc_cmd_rc_e rc = m_cmd->run(m_params, result);
switch (rc) {
case TREX_RPC_CMD_OK:
response["result"] = result["result"];
break;
case TREX_RPC_CMD_PARSE_ERR:
response["error"]["code"] = JSONRPC_V2_ERR_INVALID_PARAMS;
response["error"]["message"] = "Bad paramters for method";
response["error"]["specific_err"] = result["specific_err"];
break;
case TREX_RPC_CMD_EXECUTE_ERR:
response["error"]["code"] = JSONRPC_V2_ERR_EXECUTE_ERROR;
response["error"]["message"] = "Failed To Execute Method";
response["error"]["specific_err"] = result["specific_err"];
break;
case TREX_RPC_CMD_INTERNAL_ERR:
response["error"]["code"] = JSONRPC_V2_ERR_INTERNAL_ERROR;
response["error"]["message"] = "Internal Server Error";
response["error"]["specific_err"] = result["specific_err"];
break;
}
}
private:
TrexRpcCommand *m_cmd;
Json::Value m_params;
};
/******************* RPC error **************/
/**
* describes the parser error
*
*/
class JsonRpcError : public TrexJsonRpcV2ParsedObject {
public:
JsonRpcError(const Json::Value &msg_id, int code, const std::string &msg, bool force = false) : TrexJsonRpcV2ParsedObject(msg_id, force), m_code(code), m_msg(msg) {
}
virtual void _execute(Json::Value &response) {
response["error"]["code"] = m_code;
response["error"]["message"] = m_msg;
}
private:
int m_code;
std::string m_msg;
};
/************** JSON RPC V2 parser implementation *************/
TrexJsonRpcV2Parser::TrexJsonRpcV2Parser(const std::string &msg) : m_msg(msg) {
}
/**
* parse a batch of commands
*
* @author imarom (17-Aug-15)
*
* @param commands
*/
void TrexJsonRpcV2Parser::parse(std::vector<TrexJsonRpcV2ParsedObject *> &commands) {
Json::Reader reader;
Json::Value request;
/* basic JSON parsing */
bool rc = reader.parse(m_msg, request, false);
if (!rc) {
commands.push_back(new JsonRpcError(Json::Value::null, JSONRPC_V2_ERR_PARSE, "Bad JSON Format", true));
return;
}
/* request can be an array of requests */
if (request.isArray()) {
/* handle each command */
for (auto single_request : request) {
parse_single_request(single_request, commands);
}
} else {
/* handle single command */
parse_single_request(request, commands);
}
}
void TrexJsonRpcV2Parser::parse_single_request(Json::Value &request,
std::vector<TrexJsonRpcV2ParsedObject *> &commands) {
Json::Value msg_id = request["id"];
/* check version */
if (request["jsonrpc"] != "2.0") {
commands.push_back(new JsonRpcError(msg_id, JSONRPC_V2_ERR_INVALID_REQ, "Invalid JSONRPC Version"));
return;
}
/* check method name */
std::string method_name = request["method"].asString();
if (method_name == "") {
commands.push_back(new JsonRpcError(msg_id, JSONRPC_V2_ERR_INVALID_REQ, "Missing Method Name"));
return;
}
/* lookup the method in the DB */
TrexRpcCommand * rpc_cmd = TrexRpcCommandsTable::get_instance().lookup(method_name);
if (!rpc_cmd) {
std::stringstream err;
err << "Method " << method_name << " not registered";
commands.push_back(new JsonRpcError(msg_id, JSONRPC_V2_ERR_METHOD_NOT_FOUND, err.str()));
return;
}
/* create a method object */
commands.push_back(new JsonRpcMethod(msg_id, rpc_cmd, request["params"]));
}
/**
* tries to pretty a JSON str
*
* @author imarom (03-Sep-15)
*
* @param json_str
*
* @return std::string
*/
std::string TrexJsonRpcV2Parser::pretty_json_str(const std::string &json_str) {
Json::Reader reader;
Json::Value value;
/* basic JSON parsing */
bool rc = reader.parse(json_str, value, false);
if (!rc) {
/* duplicate the soruce */
return json_str;
}
/* successfully parsed */
Json::StyledWriter writer;
return writer.write(value);
}
void
TrexJsonRpcV2Parser::generate_common_error(Json::Value &json, const std::string &specific_err) {
JsonRpcError err(Json::Value::null, JSONRPC_V2_ERR_INTERNAL_ERROR, specific_err, true);
err.execute(json);
}
void
TrexJsonRpcV2Parser::generate_common_error(std::string &response, const std::string &specific_err) {
Json::Value resp_json;
Json::FastWriter writer;
generate_common_error(resp_json, specific_err);
response = writer.write(resp_json);
}
|
