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
|
// Copyright (C) 2009-2015 Internet Systems Consortium, Inc. ("ISC")
//
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
#include <config.h>
#include <exceptions/exceptions.h>
#include <cc/command_interpreter.h>
#include <cc/data.h>
#include <string>
#include <set>
using namespace std;
using isc::data::Element;
using isc::data::ConstElementPtr;
using isc::data::ElementPtr;
using isc::data::JSONError;
namespace isc {
namespace config {
const char *CONTROL_COMMAND = "command";
const char *CONTROL_RESULT = "result";
const char *CONTROL_TEXT = "text";
const char *CONTROL_ARGUMENTS = "arguments";
// Full version, with status, text and arguments
ConstElementPtr
createAnswer(const int status_code, const std::string& text,
const ConstElementPtr& arg) {
if (status_code != 0 && text.empty()) {
isc_throw(CtrlChannelError, "Text has to be provided for status_code != 0");
}
ElementPtr answer = Element::createMap();
ElementPtr result = Element::create(status_code);
answer->set(CONTROL_RESULT, result);
if (!text.empty()) {
answer->set(CONTROL_TEXT, Element::create(text));
}
if (arg) {
answer->set(CONTROL_ARGUMENTS, arg);
}
return (answer);
}
ConstElementPtr
createAnswer() {
return (createAnswer(0, string(""), ConstElementPtr()));
}
ConstElementPtr
createAnswer(const int status_code, const std::string& text) {
return (createAnswer(status_code, text, ElementPtr()));
}
ConstElementPtr
createAnswer(const int status_code, const ConstElementPtr& arg) {
return (createAnswer(status_code, "", arg));
}
ConstElementPtr
parseAnswer(int &rcode, const ConstElementPtr& msg) {
if (!msg) {
isc_throw(CtrlChannelError, "No answer specified");
}
if (msg->getType() != Element::map) {
isc_throw(CtrlChannelError,
"Invalid answer Element specified, expected map");
}
if (!msg->contains(CONTROL_RESULT)) {
isc_throw(CtrlChannelError,
"Invalid answer specified, does not contain mandatory 'result'");
}
ConstElementPtr result = msg->get(CONTROL_RESULT);
if (result->getType() != Element::integer) {
isc_throw(CtrlChannelError,
"Result element in answer message is not a string");
}
rcode = result->intValue();
// If there are arguments, return them.
ConstElementPtr args = msg->get(CONTROL_ARGUMENTS);
if (args) {
return (args);
}
// There are no arguments, let's try to return just the text status
return (msg->get(CONTROL_TEXT));
}
std::string
answerToText(const ConstElementPtr& msg) {
if (!msg) {
isc_throw(CtrlChannelError, "No answer specified");
}
if (msg->getType() != Element::map) {
isc_throw(CtrlChannelError,
"Invalid answer Element specified, expected map");
}
if (!msg->contains(CONTROL_RESULT)) {
isc_throw(CtrlChannelError,
"Invalid answer specified, does not contain mandatory 'result'");
}
ConstElementPtr result = msg->get(CONTROL_RESULT);
if (result->getType() != Element::integer) {
isc_throw(CtrlChannelError,
"Result element in answer message is not a string");
}
stringstream txt;
int rcode = result->intValue();
if (rcode == 0) {
txt << "success(0)";
} else {
txt << "failure(" << rcode << ")";
}
// Was any text provided? If yes, include it.
ConstElementPtr txt_elem = msg->get(CONTROL_TEXT);
if (txt_elem) {
txt << ", text=" << txt_elem->stringValue();
}
return (txt.str());
}
ConstElementPtr
createCommand(const std::string& command) {
return (createCommand(command, ElementPtr()));
}
ConstElementPtr
createCommand(const std::string& command, ConstElementPtr arg) {
ElementPtr query = Element::createMap();
ElementPtr cmd = Element::create(command);
query->set(CONTROL_COMMAND, cmd);
if (arg) {
query->set(CONTROL_ARGUMENTS, arg);
}
return (query);
}
std::string
parseCommand(ConstElementPtr& arg, ConstElementPtr command) {
if (!command) {
isc_throw(CtrlChannelError, "No command specified");
}
if (command->getType() != Element::map) {
isc_throw(CtrlChannelError, "Invalid command Element specified, expected map");
}
if (!command->contains(CONTROL_COMMAND)) {
isc_throw(CtrlChannelError,
"Invalid answer specified, does not contain mandatory 'command'");
}
ConstElementPtr cmd = command->get(CONTROL_COMMAND);
if (cmd->getType() != Element::string) {
isc_throw(CtrlChannelError,
"'command' element in command message is not a string");
}
arg = command->get(CONTROL_ARGUMENTS);
return (cmd->stringValue());
}
ConstElementPtr
combineCommandsLists(const ConstElementPtr& response1,
const ConstElementPtr& response2) {
// Usually when this method is called there should be two non-null
// responses. If there is just a single response, return this
// response.
if (!response1 && response2) {
return (response2);
} else if (response1 && !response2) {
return (response1);
} else if (!response1 && !response2) {
return (ConstElementPtr());
} else {
// Both responses are non-null so we need to combine the lists
// of supported commands if the status codes are 0.
int status_code;
ConstElementPtr args1 = parseAnswer(status_code, response1);
if (status_code != 0) {
return (response1);
}
ConstElementPtr args2 = parseAnswer(status_code, response2);
if (status_code != 0) {
return (response2);
}
const std::vector<ElementPtr> vec1 = args1->listValue();
const std::vector<ElementPtr> vec2 = args2->listValue();
// Storing command names in a set guarantees that the non-unique
// command names are aggregated.
std::set<std::string> combined_set;
for (auto v = vec1.cbegin(); v != vec1.cend(); ++v) {
combined_set.insert((*v)->stringValue());
}
for (auto v = vec2.cbegin(); v != vec2.cend(); ++v) {
combined_set.insert((*v)->stringValue());
}
// Create a combined list of commands.
ElementPtr combined_list = Element::createList();
for (auto s = combined_set.cbegin(); s != combined_set.cend(); ++s) {
combined_list->add(Element::create(*s));
}
return (createAnswer(CONTROL_RESULT_SUCCESS, combined_list));
}
}
}
}
|
