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

 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/set_display_layout_request.h"

#include "application_manager/application_impl.h"
#include "application_manager/message_helper.h"

namespace sdl_rpc_plugin {
using namespace application_manager;

namespace commands {

SDL_CREATE_LOG_VARIABLE("Commands")

SetDisplayLayoutRequest::SetDisplayLayoutRequest(
    const application_manager::commands::MessageSharedPtr& message,
    ApplicationManager& application_manager,
    app_mngr::rpc_service::RPCService& rpc_service,
    app_mngr::HMICapabilities& hmi_capabilities,
    policy::PolicyHandlerInterface& policy_handler)
    : RequestFromMobileImpl(message,
                            application_manager,
                            rpc_service,
                            hmi_capabilities,
                            policy_handler) {}

SetDisplayLayoutRequest::~SetDisplayLayoutRequest() {}

void SetDisplayLayoutRequest::Run() {
  SDL_LOG_AUTO_TRACE();
  ApplicationSharedPtr app = application_manager_.application(connection_key());

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

  const smart_objects::SmartObject& msg_params =
      (*message_)[strings::msg_params];

  std::string old_layout = app->display_layout();
  std::string new_layout = "";

  if (msg_params.keyExists(strings::display_layout)) {
    new_layout = msg_params[strings::display_layout].asString();
  }

  if (new_layout != old_layout && !new_layout.empty()) {
    // Template switched, hence allow any color change
    SDL_LOG_DEBUG("SetDisplayLayoutRequest New Layout: " << new_layout);
    app->set_display_layout(new_layout);
  } else {
    SDL_LOG_DEBUG("SetDisplayLayoutRequest No Layout Change");
    // Template layout is the same as previous layout
    // Reject message if colors are set
    if (msg_params.keyExists(strings::day_color_scheme) &&
        app->day_color_scheme().getType() != smart_objects::SmartType_Null &&
        msg_params[strings::day_color_scheme] != app->day_color_scheme()) {
      // Color scheme param exists and has been previously set,
      // hence do not allow color change
      SDL_LOG_DEBUG("Reject Day Color Scheme Change");
      SendResponse(false, mobile_apis::Result::REJECTED);
      return;
    }

    if (msg_params.keyExists(strings::night_color_scheme) &&
        app->night_color_scheme().getType() != smart_objects::SmartType_Null &&
        msg_params[strings::night_color_scheme] != app->night_color_scheme()) {
      // Color scheme param exists and has been previously set,
      // hence do not allow color change
      SDL_LOG_DEBUG("Reject Night Color Scheme Change");
      SendResponse(false, mobile_apis::Result::REJECTED);
      return;
    }
  }

  if (msg_params.keyExists(strings::day_color_scheme)) {
    SDL_LOG_DEBUG("Allow Day Color Scheme Change");
    app->set_day_color_scheme(msg_params[strings::day_color_scheme]);
  }

  if (msg_params.keyExists(strings::night_color_scheme)) {
    SDL_LOG_DEBUG("Allow Night Color Scheme Change");
    app->set_night_color_scheme(msg_params[strings::night_color_scheme]);
  }

  (*message_)[strings::msg_params][strings::app_id] = app->app_id();
  StartAwaitForInterface(HmiInterfaces::HMI_INTERFACE_UI);
  SendHMIRequest(hmi_apis::FunctionID::UI_SetDisplayLayout,
                 &((*message_)[strings::msg_params]),
                 true);
}

void SetDisplayLayoutRequest::on_event(const event_engine::Event& event) {
  SDL_LOG_AUTO_TRACE();

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

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

  const smart_objects::SmartObject& message = event.smart_object();
  switch (event.id()) {
    case hmi_apis::FunctionID::UI_SetDisplayLayout: {
      SDL_LOG_INFO("Received UI_SetDisplayLayout event");
      EndAwaitForInterface(HmiInterfaces::HMI_INTERFACE_UI);
      hmi_apis::Common_Result::eType result_code =
          static_cast<hmi_apis::Common_Result::eType>(
              message[strings::params][hmi_response::code].asInt());
      const bool response_success = PrepareResultForMobileResponse(
          result_code, HmiInterfaces::HMI_INTERFACE_UI);
      std::string info;
      GetInfo(message, info);
      smart_objects::SmartObject msg_params = message[strings::msg_params];
      if (response_success) {
        HMICapabilities& hmi_capabilities = hmi_capabilities_;

        // In case templates_available is empty copy from hmi capabilities
        if (msg_params.keyExists(hmi_response::display_capabilities)) {
          if (0 == msg_params[hmi_response::display_capabilities]
                             [hmi_response::templates_available]
                                 .length()) {
            auto display_capabilities = hmi_capabilities.display_capabilities();
            if (display_capabilities) {
              msg_params[hmi_response::display_capabilities]
                        [hmi_response::templates_available] =
                            display_capabilities->getElement(
                                hmi_response::templates_available);
            }
          }
        }
        const Version& app_version = app->version();
        if (app_version.max_supported_api_version >= APIVersion::kAPIV6) {
          // In case of successful response warn user that this RPC is
          // deprecated from 6.0 and higher API versions
          result_code = hmi_apis::Common_Result::WARNINGS;
          info =
              "The RPC is deprecated and will be removed in a future version. "
              "The requested display layout is set to the main window. Please "
              "use `Show.templateConfiguration` instead.";
        }
      }

      SendResponse(response_success,
                   MessageHelper::HMIToMobileResult(result_code),
                   info.empty() ? nullptr : info.c_str(),
                   &msg_params);
      break;
    }
    default: {
      SDL_LOG_ERROR("Received unknown event " << event.id());
      return;
    }
  }
}

}  // namespace commands

}  // namespace sdl_rpc_plugin