summaryrefslogtreecommitdiff
path: root/src/components/application_manager/rpc_plugins/sdl_rpc_plugin/src/commands/mobile/delete_command_request.cc
blob: 38069c341e71c8d80b8242459636f4ebccbc6e13 (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
/*

 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.
 */

#include "sdl_rpc_plugin/commands/mobile/delete_command_request.h"

#include "application_manager/application_impl.h"
#include "application_manager/message_helper.h"
#include "interfaces/MOBILE_API.h"
#include "interfaces/HMI_API.h"
#include "utils/helpers.h"

namespace sdl_rpc_plugin {
using namespace application_manager;

namespace commands {

DeleteCommandRequest::DeleteCommandRequest(
    const application_manager::commands::MessageSharedPtr& message,
    ApplicationManager& application_manager,
    rpc_service::RPCService& rpc_service,
    HMICapabilities& hmi_capabilities,
    policy::PolicyHandlerInterface& policy_handler)
    : CommandRequestImpl(message,
                         application_manager,
                         rpc_service,
                         hmi_capabilities,
                         policy_handler)
    , is_ui_send_(false)
    , is_vr_send_(false)
    , is_ui_received_(false)
    , is_vr_received_(false)
    , ui_result_(hmi_apis::Common_Result::INVALID_ENUM)
    , vr_result_(hmi_apis::Common_Result::INVALID_ENUM) {}

DeleteCommandRequest::~DeleteCommandRequest() {}

void DeleteCommandRequest::Run() {
  LOG4CXX_AUTO_TRACE(logger_);

  ApplicationSharedPtr application =
      application_manager_.application(connection_key());

  if (!application) {
    LOG4CXX_ERROR(logger_, "Application is not registered");
    SendResponse(false, mobile_apis::Result::APPLICATION_NOT_REGISTERED);
    return;
  }

  const int32_t cmd_id =
      (*message_)[strings::msg_params][strings::cmd_id].asInt();

  smart_objects::SmartObject* command = application->FindCommand(cmd_id);

  if (!command) {
    LOG4CXX_ERROR(logger_, "Command with id " << cmd_id << " is not found.");
    SendResponse(false, mobile_apis::Result::INVALID_ID);
    return;
  }

  smart_objects::SmartObject msg_params =
      smart_objects::SmartObject(smart_objects::SmartType_Map);

  msg_params[strings::cmd_id] =
      (*message_)[strings::msg_params][strings::cmd_id];
  msg_params[strings::app_id] = application->app_id();

  // we should specify amount of required responses in the 1st request
  uint32_t chaining_counter = 0;
  if ((*command).keyExists(strings::menu_params)) {
    ++chaining_counter;
  }

  if ((*command).keyExists(strings::vr_commands)) {
    ++chaining_counter;
  }
  /* Need to set all flags before sending request to HMI
   * for correct processing this flags in method on_event */
  if ((*command).keyExists(strings::menu_params)) {
    is_ui_send_ = true;
  }
  // check vr params
  if ((*command).keyExists(strings::vr_commands)) {
    is_vr_send_ = true;
  }
  if (is_ui_send_) {
    StartAwaitForInterface(HmiInterfaces::HMI_INTERFACE_UI);
    SendHMIRequest(hmi_apis::FunctionID::UI_DeleteCommand, &msg_params, true);
  }
  if (is_vr_send_) {
    // VR params
    msg_params[strings::grammar_id] = application->get_grammar_id();
    msg_params[strings::type] = hmi_apis::Common_VRCommandType::Command;
    StartAwaitForInterface(HmiInterfaces::HMI_INTERFACE_VR);
    SendHMIRequest(hmi_apis::FunctionID::VR_DeleteCommand, &msg_params, true);
  }
}

bool DeleteCommandRequest::PrepareResponseParameters(
    mobile_apis::Result::eType& result_code, std::string& info) {
  using namespace helpers;
  app_mngr::commands::ResponseInfo ui_delete_info(
      ui_result_, HmiInterfaces::HMI_INTERFACE_UI, application_manager_);
  app_mngr::commands::ResponseInfo vr_delete_info(
      vr_result_, HmiInterfaces::HMI_INTERFACE_VR, application_manager_);
  const bool result =
      PrepareResultForMobileResponse(ui_delete_info, vr_delete_info);

  const bool is_vr_or_ui_warning =
      Compare<hmi_apis::Common_Result::eType, EQ, ONE>(
          hmi_apis::Common_Result::WARNINGS, ui_result_, vr_result_);
  info = app_mngr::commands::MergeInfos(
      ui_delete_info, ui_info_, vr_delete_info, vr_info_);
  if (is_vr_or_ui_warning && !ui_delete_info.is_unsupported_resource &&
      !vr_delete_info.is_unsupported_resource) {
    LOG4CXX_DEBUG(logger_, "VR or UI result is warning");
    result_code = mobile_apis::Result::WARNINGS;
    return result;
  }
  result_code = PrepareResultCodeForResponse(ui_delete_info, vr_delete_info);
  LOG4CXX_DEBUG(logger_, "Result is " << (result ? "true" : "false"));
  return result;
}

void DeleteCommandRequest::on_event(const event_engine::Event& event) {
  LOG4CXX_AUTO_TRACE(logger_);

  const smart_objects::SmartObject& message = event.smart_object();
  switch (event.id()) {
    case hmi_apis::FunctionID::UI_DeleteCommand: {
      EndAwaitForInterface(HmiInterfaces::HMI_INTERFACE_UI);
      is_ui_received_ = true;
      ui_result_ = static_cast<hmi_apis::Common_Result::eType>(
          message[strings::params][hmi_response::code].asInt());
      LOG4CXX_DEBUG(logger_,
                    "Received UI_DeleteCommand event with result "
                        << MessageHelper::HMIResultToString(ui_result_));
      GetInfo(message, ui_info_);
      break;
    }
    case hmi_apis::FunctionID::VR_DeleteCommand: {
      EndAwaitForInterface(HmiInterfaces::HMI_INTERFACE_VR);
      is_vr_received_ = true;
      vr_result_ = static_cast<hmi_apis::Common_Result::eType>(
          message[strings::params][hmi_response::code].asInt());
      LOG4CXX_DEBUG(logger_,
                    "Received VR_DeleteCommand event with result "
                        << MessageHelper::HMIResultToString(vr_result_));
      GetInfo(message, vr_info_);
      break;
    }
    default: {
      LOG4CXX_ERROR(logger_, "Received unknown event" << event.id());
      return;
    }
  }

  if (IsPendingResponseExist()) {
    LOG4CXX_DEBUG(logger_, "Still awaiting for other responses.");
    return;
  }

  ApplicationSharedPtr application =
      application_manager_.application(connection_key());

  if (!application) {
    LOG4CXX_ERROR(logger_, "Application is not registered");
    return;
  }
  smart_objects::SmartObject& msg_params = (*message_)[strings::msg_params];

  const uint32_t cmd_id = msg_params[strings::cmd_id].asUInt();

  smart_objects::SmartObject* command = application->FindCommand(cmd_id);

  if (!command) {
    LOG4CXX_ERROR(logger_,
                  "Command id " << cmd_id << " not found for "
                                             "application with connection key "
                                << connection_key());
    return;
  }
  mobile_apis::Result::eType result_code = mobile_apis::Result::INVALID_ENUM;
  std::string info;
  const bool result = PrepareResponseParameters(result_code, info);
  if (result) {
    application->RemoveCommand(cmd_id);
    application->help_prompt_manager().OnVrCommandDeleted(cmd_id, false);
  }
  SendResponse(
      result, result_code, info.empty() ? NULL : info.c_str(), &msg_params);
}

bool DeleteCommandRequest::Init() {
  hash_update_mode_ = HashUpdateMode::kDoHashUpdate;
  return true;
}

bool DeleteCommandRequest::IsPendingResponseExist() {
  LOG4CXX_AUTO_TRACE(logger_);
  return is_ui_send_ != is_ui_received_ || is_vr_send_ != is_vr_received_;
}

}  // namespace commands

}  // namespace application_manager