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
|
/**
Copyright (c) 2014, 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_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_REQUEST_IMPL_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_REQUEST_IMPL_H_
#include "application_manager/commands/command_impl.h"
#include "interfaces/MOBILE_API.h"
#include "interfaces/HMI_API.h"
#include "utils/lock.h"
namespace NsSmartDeviceLink {
namespace NsSmartObjects {
class SmartObject;
}
}
namespace application_manager {
namespace commands {
namespace NsSmart = NsSmartDeviceLink::NsSmartObjects;
class CommandRequestImpl : public CommandImpl,
public event_engine::EventObserver {
public:
enum RequestState {
kAwaitingHMIResponse = 0,
kTimedOut,
kCompleted
};
explicit CommandRequestImpl(const MessageSharedPtr& message);
virtual ~CommandRequestImpl();
virtual bool CheckPermissions();
virtual bool Init();
virtual bool CleanUp();
virtual void Run();
/*
* @brief Function is called by RequestController when request execution time
* has exceed it's limit
*
*/
virtual void onTimeOut();
/**
* @brief Default EvenObserver's pure virtual method implementation
*
* @param event The received event
*/
virtual void on_event(const event_engine::Event& event);
/*
* @brief Creates Mobile response
*
* @param success true if successful; false, if failed
* @param result_code Result code (SUCCESS, INVALID_DATA, e.t.c)
* @param info Provides additional human readable info regarding the result
* @param response_params Additional params in response
*/
void SendResponse(const bool success,
const mobile_apis::Result::eType& result_code,
const char* info = NULL,
const NsSmart::SmartObject* response_params = NULL);
/**
* @brief Check syntax of string from mobile
* @param str - string that need to be checked
* @param allow_empty_string if true methods allow empty sting
* @return true if success otherwise return false
*/
bool CheckSyntax(std::string str, bool allow_empty_line = false);
/*
* @brief Sends HMI request
*
* @param function_id HMI request ID
* @param msg_params HMI request msg params
* @param use_events true if we need subscribe on event(HMI request)
*
*/
void SendHMIRequest(const hmi_apis::FunctionID::eType& function_id,
const NsSmart::SmartObject* msg_params = NULL,
bool use_events = false);
/*
* @brief Creates HMI request
*
* @param function_id HMI request ID
* @param msg_params HMI request msg params
*/
void CreateHMINotification(const hmi_apis::FunctionID::eType& function_id,
const NsSmart::SmartObject& msg_params) const;
/**
* @brief Converts HMI result code to Mobile result code
*
* @param hmi_code HMI result code
* @return Mobile result code
*/
mobile_apis::Result::eType GetMobileResultCode(
const hmi_apis::Common_Result::eType& hmi_code) const;
protected:
/**
* @brief Checks message permissions and parameters according to policy table
* permissions
*/
bool CheckAllowedParameters();
/**
* @brief Remove from current message parameters disallowed by policy table
* @param params_permissions Parameters permissions from policy table
*/
void RemoveDisallowedParameters(
const CommandParametersPermissions& params_permissions);
/**
* @brief Adds disallowed parameters back to response with appropriate
* reasons
* @param response Response message, which should be extended with blocked
* parameters reasons
*/
void AddDisallowedParameters(smart_objects::SmartObject& response);
/**
* @brief Checks if any request param was marked as disallowed by policy
* @return true if any param was marked as disallowed
*/
bool HasDisallowedParams() const;
protected:
RequestState current_state_;
sync_primitives::Lock state_lock_;
CommandParametersPermissions parameters_permissions_;
private:
DISALLOW_COPY_AND_ASSIGN(CommandRequestImpl);
/**
* @brief Adds param to disallowed parameters enumeration
* @param info string with disallowed params enumeration
* @param param disallowed param
*/
void AddDissalowedParameterToInfoString(std::string& info,
const std::string& param) const;
/**
* @brief Adds disallowed parameters to response info
* @param response Response message, which info should be extended
*/
void AddDisallowedParametersToInfo(smart_objects::SmartObject& response) const;
};
} // namespace commands
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_COMMAND_REQUEST_IMPL_H_
|
