summaryrefslogtreecommitdiff
path: root/src/components/application_manager/rpc_plugins/sdl_rpc_plugin/include/sdl_rpc_plugin/commands/mobile/set_global_properties_request.h
blob: fbf3056e58a1e63825a8b9863d5f74bf43d8cbc8 (plain)
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
/*
 Copyright (c) 2018, 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_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_SET_GLOBAL_PROPERTIES_REQUEST_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_SET_GLOBAL_PROPERTIES_REQUEST_H_
#include <string>
#include "application_manager/application.h"
#include "application_manager/commands/command_request_impl.h"
#include "utils/macro.h"

namespace sdl_rpc_plugin {
namespace app_mngr = application_manager;

namespace commands {

/**
 * @brief Register app interface request  command class
 **/
class SetGlobalPropertiesRequest
    : public app_mngr::commands::CommandRequestImpl {
 public:
  /**
   * @brief SetGlobalPropertiesRequest class constructor
   *
   * @param message Incoming SmartObject message
   **/
  SetGlobalPropertiesRequest(
      const app_mngr::commands::MessageSharedPtr& message,
      app_mngr::ApplicationManager& application_manager,
      app_mngr::rpc_service::RPCService& rpc_service,
      app_mngr::HMICapabilities& hmi_capabilities,
      policy::PolicyHandlerInterface& policy_handler);

  /**
   * @brief SetGlobalPropertiesRequest class destructor
   **/
  ~SetGlobalPropertiesRequest();

  /**
   * @brief Execute command
   **/
  void Run() FINAL;

  /**
   * @brief Interface method that is called whenever new event received
   *
   * @param event The received event
   */
  void on_event(const app_mngr::event_engine::Event& event) FINAL;

  /**
   * @brief Init sets hash update mode for request
   */
  bool Init() FINAL;

  void onTimeOut() OVERRIDE;

  /**
   * @brief Prepares total result for mobile according to three results:
   * ui_properties_result, tts_properties_result, rc_properties_result.
   * @param first ResponseInfo as first argument
   * @param second ResponseInfo as secondargument
   * @param third ResponseInfo as third argument
   * @return total result
   */
  bool PrepareResultForMobileResponse(
      const app_mngr::commands::ResponseInfo& first,
      const app_mngr::commands::ResponseInfo& second,
      const app_mngr::commands::ResponseInfo& third) const;

  /**
   * @brief Prepare result code for sending to mobile application
   * @param first contains result_code from HMI response and
   * interface that returns response
   * @param second contains result_code from HMI response and
   * interface that returns response.
   * * @param third contains result_code from HMI response and
   * interface that returns response.
   * @return resulting code for sending to mobile application.
   */
  mobile_apis::Result::eType PrepareResultCodeForResponse(
      const app_mngr::commands::ResponseInfo& first,
      const app_mngr::commands::ResponseInfo& second,
      const app_mngr::commands::ResponseInfo& third);

  /**
   * @brief Resolves if the return code must be
   * UNSUPPORTED_RESOURCE
   * @param first contains result_code from HMI response and
   * interface that returns response
   * @param second contains result_code from HMI response and
   * interface that returns response.
   * * @param third contains result_code from HMI response and
   * interface that returns response.
   * @return True, if the communication return code must be
   * UNSUPPORTED_RESOURCE, otherwise false.
   */
  bool IsResultCodeUnsupported(
      const app_mngr::commands::ResponseInfo& first,
      const app_mngr::commands::ResponseInfo& second,
      const app_mngr::commands::ResponseInfo& third) const;

 private:
  /**
   * @brief MergeInfos merge 2 infos into one string with info
   * @param first_info -contains result_code from HMI response and
   * interface that returns response
   * @param first_str - info string that should be first in result info
   * @param second_info -contains result_code from HMI response and
   * interface that returns response
   * @param second_str - info string that should be second in result info
   * @param third_info - contains result_code from HMI response and
   * interface that returns response
   * @param third_str - info string that should be third in result info
   * @return if first_info is not available and second_str and third_info not
   * empty return second if second_info is not available and first_str and
   * third_info not empty return first if third_info is not available and
   * first_str and second_str not empty return first other cases return result
   * MergeInfos for 2 params
   */
  std::string MergeInfos(const app_mngr::commands::ResponseInfo& first_info,
                         const std::string& first_str,
                         const app_mngr::commands::ResponseInfo& second_info,
                         const std::string& second_str,
                         const app_mngr::commands::ResponseInfo& third_info,
                         const std::string& third_str);

  // prepare UI sending data (VrHelps, Menus, Keyboard) to SmartObject
  static void PrepareUIRequestVRHelpData(
      const app_mngr::ApplicationSharedPtr app,
      const smart_objects::SmartObject& msg_params,
      smart_objects::SmartObject& out_params);

  static void PrepareUIRequestMenuAndKeyboardData(
      const app_mngr::ApplicationSharedPtr app,
      const smart_objects::SmartObject& msg_params,
      smart_objects::SmartObject& out_params);

  // Send TTS request to HMI
  void SendTTSRequest(const smart_objects::SmartObject& params,
                      bool use_events);

  // Send UI request to HMI
  void SendUIRequest(const smart_objects::SmartObject& params, bool use_events);

  // Send SetGlobalProperties with userLocation parameter
  void SendRCRequest(const smart_objects::SmartObject& params, bool use_events);

  // VRHelp shall contain sequential positions and start from 1
  static bool CheckVrHelpItemsOrder(const smart_objects::SmartObject& vr_help);

  /**
   * @brief Check if there some not delivered hmi responses exist
   *
   * @return true if all responses received
   */
  bool IsPendingResponseExist();

  /**
   * @brief Checks if request has at least one parameter
   *
   * @param params request parameters
   *
   * @returns true if at least one parameter is present in object
   */
  static bool ValidateConditionalMandatoryParameters(
      const smart_objects::SmartObject& params);

  /**
   * @brief Checks set global properties params(helpPrompt, timeoutPrompt, ...).
   * When type is String there is a check on the contents \t\n \\t \\n
   * @return if set global properties contains \t\n \\t \\n return TRUE,
   * FALSE otherwise
   */
  bool IsWhiteSpaceExist();

  /**
   * @brief helps to determine layout of interest. Returns keyboard layout,
   * mentioned in current request. If not, returns saved keyboard layout for
   * current app. If such layout wasn't saved, returns default keyboard layout
   * (QWERTY)
   * @return KeyboardLayout enum value
   */
  hmi_apis::Common_KeyboardLayout::eType GetKeyboardLayout() const;

  /**
   * @brief Returns allowed number of configurable keys for certain layout
   * @return allowed number of configurable keys, if provided, and zero
   * otherwise
   */
  uint32_t GetAllowedNumberOfConfigurableKeys() const;

  /**
   * @brief Checks provided custom keys against capabilities.
   * @return true if the specified keyboard layout supports the number of
   * custom keys provided.
   */
  bool ValidateCustomKeys() const;

  /**
   * @brief Prepare result code and result for sending to mobile application
   * @param result_code contains result code for sending to mobile application
   * @param info contains info for sending to mobile applicaion
   * @return result for sending to mobile application.
   */
  bool PrepareResponseParameters(mobile_apis::Result::eType& result_code,
                                 std::string& info);

  bool is_ui_send_;
  bool is_tts_send_;
  bool is_rc_send_;

  bool is_ui_received_;
  bool is_tts_received_;
  bool is_rc_received_;

  hmi_apis::Common_Result::eType ui_result_;
  hmi_apis::Common_Result::eType tts_result_;
  hmi_apis::Common_Result::eType rc_result_;
  std::string ui_response_info_;
  std::string tts_response_info_;
  std::string rc_response_info_;

  bool is_menu_layout_available_ = true;

  DISALLOW_COPY_AND_ASSIGN(SetGlobalPropertiesRequest);
};

}  // namespace commands
}  // namespace sdl_rpc_plugin

#endif  // SRC_COMPONENTS_APPLICATION_MANAGER_RPC_PLUGINS_SDL_RPC_PLUGIN_INCLUDE_SDL_RPC_PLUGIN_COMMANDS_MOBILE_SET_GLOBAL_PROPERTIES_REQUEST_H_