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
|
// Copyright (c) 2013, Ford Motor Company
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following
// disclaimer in the documentation and/or other materials provided with the
// distribution.
//
// Neither the name of the Ford Motor Company nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 'A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
#ifndef SRC_COMPONENTS_FORMATTERS_INCLUDE_FORMATTERS_CFORMATTERJSONSDLRPCV1_H_
#define SRC_COMPONENTS_FORMATTERS_INCLUDE_FORMATTERS_CFORMATTERJSONSDLRPCV1_H_
#include "json/json.h"
#include "smart_objects/smart_object.h"
#include "smart_objects/enum_schema_item.h"
#include "CFormatterJsonBase.h"
#include "formatters/CSmartFactory.h"
#include "formatters/meta_formatter.h"
namespace NsSmartDeviceLink {
namespace NsJSONHandler {
namespace Formatters {
/**
* @brief Class is used to convert SmartObjects to JSON string and vice versa.
*
* JSON strings is in SDLRPCv1 format.
*/
class CFormatterJsonSDLRPCv1 : public CFormatterJsonBase {
private:
/**
* @brief Hidden constructor.
*
* The class contains only static methods. Should not be instantiated.
*/
CFormatterJsonSDLRPCv1();
/**
* @brief Hidden copy constructor.
*
* The class contains only static methods. Should not be instantiated.
*/
CFormatterJsonSDLRPCv1(const CFormatterJsonSDLRPCv1&);
/**
* @brief Extracts a message type from the SmartObject
*/
static const std::string getMessageType(
const NsSmartDeviceLink::NsSmartObjects::SmartObject& obj);
/**
* @brief Extracts a message type from the root JSON object.
*
* @return Type or empty string if there's no type in the JSON object.
*/
static const std::string getMessageType(const Json::Value& root);
// SDLRPCv1 string consts
/**
* @brief String constant for REQUEST.
*/
static const std::string S_REQUEST;
/**
* @brief String constant for RESPONSE.
*/
static const std::string S_RESPONSE;
/**
* @brief String constant for NOTIFICATION.
*/
static const std::string S_NOTIFICATION;
/**
* @brief String constant for PARAMETERS.
*/
static const std::string S_PARAMETERS;
/**
* @brief String constant for NAME.
*/
static const std::string S_NAME;
/**
* @brief String constant for CORRELATION_ID.
*/
static const std::string S_CORRELATION_ID;
public:
static const int32_t kSuccess;
static const int32_t kParsingError;
static const int32_t kFunctionIdNotFound;
static const int32_t kMessageTypeNotFound;
static const int32_t kCorrelationIdNotFound;
typedef NsSmartDeviceLink::NsJSONHandler::Formatters::
meta_formatter_error_code::tMetaFormatterErrorCode
tMetaFormatterErrorCode;
/**
* @brief Creates a JSON string from a SmartObject.
*
* @param obj input SmartObject
* @param outStr resulting JSON string
* @return true if success, false otherwise
*/
static bool toString(
const NsSmartDeviceLink::NsSmartObjects::SmartObject& obj,
std::string& outStr);
/**
* @brief Creates a SmartObject from a JSON string.
*
* @param str input JSON string
* @param out The resulting SmartObject
* @return true if success, otherwise - false
*/
template <typename FunctionId, typename MessageType>
static int32_t fromString(
const std::string& str,
NsSmartDeviceLink::NsSmartObjects::SmartObject& out);
/**
* @brief Converts to string the smart object against the given schema
*
* @param object Original smart object
* @param schema Smart schema which describes 'fake' smart object to be
*formatted
* @param outStr Resulting JSON string
* @return formatting error code
*/
static tMetaFormatterErrorCode MetaFormatToString(
const NsSmartDeviceLink::NsSmartObjects::SmartObject& object,
const NsSmartDeviceLink::NsSmartObjects::CSmartSchema& schema,
std::string& outStr);
};
// ----------------------------------------------------------------------------
template <typename FunctionId, typename MessageType>
int32_t Formatters::CFormatterJsonSDLRPCv1::fromString(
const std::string& str,
NsSmartDeviceLink::NsSmartObjects::SmartObject& out) {
int32_t result = kSuccess;
try {
Json::Value root;
Json::Reader reader;
std::string type;
if (false == reader.parse(str, root)) {
result = kParsingError | kMessageTypeNotFound | kFunctionIdNotFound |
kCorrelationIdNotFound;
}
if (kSuccess == result) {
type = getMessageType(root);
if (true == type.empty()) {
result =
kMessageTypeNotFound | kFunctionIdNotFound | kCorrelationIdNotFound;
}
}
FunctionId functionId = FunctionId::INVALID_ENUM;
MessageType messageType = MessageType::INVALID_ENUM;
if (kSuccess == result) {
if (!NsSmartObjects::EnumConversionHelper<MessageType>::StringToEnum(
type, &messageType)) {
// If MessageType is not found than FunctionId and CorrelationId can not
// be found either
result =
kMessageTypeNotFound | kFunctionIdNotFound | kCorrelationIdNotFound;
}
}
if (kSuccess == result) {
if (!NsSmartObjects::EnumConversionHelper<FunctionId>::StringToEnum(
root[type][S_NAME].asString(), &functionId)) {
result = kFunctionIdNotFound;
functionId = FunctionId::INVALID_ENUM;
}
}
namespace S = NsSmartDeviceLink::NsJSONHandler::strings;
if (!(result & kMessageTypeNotFound)) {
jsonValueToObj(root[type][S_PARAMETERS], out[S::S_MSG_PARAMS]);
out[S::S_PARAMS][S::S_MESSAGE_TYPE] = messageType;
out[S::S_PARAMS][S::S_FUNCTION_ID] = functionId;
if (true == root[type][S_CORRELATION_ID].empty()) {
if (type !=
S_NOTIFICATION) { // Notification may not have CorrelationId
result |= kCorrelationIdNotFound;
out[S::S_PARAMS][S::S_CORRELATION_ID] = -1;
}
} else {
out[S::S_PARAMS][S::S_CORRELATION_ID] =
root[type][S_CORRELATION_ID].asInt();
}
out[S::S_PARAMS][S::S_PROTOCOL_TYPE] = 0;
out[S::S_PARAMS][S::S_PROTOCOL_VERSION] = 1;
}
} catch (...) {
result = kParsingError;
}
return result;
}
}
}
} // namespace NsSmartDeviceLink::NsJSONHandler::Formatters
#endif // SRC_COMPONENTS_FORMATTERS_INCLUDE_FORMATTERS_CFORMATTERJSONSDLRPCV1_H_
|
