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
|
/*
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_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_MOBILE_REGISTER_APP_INTERFACE_REQUEST_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_MOBILE_REGISTER_APP_INTERFACE_REQUEST_H_
#include <string.h>
#include "application_manager/commands/command_request_impl.h"
#include "utils/macro.h"
namespace policy {
struct DeviceInfo;
}
namespace application_manager {
class Application;
namespace commands {
/**
* @brief Register app interface request command class
**/
class RegisterAppInterfaceRequest : public CommandRequestImpl {
public:
/**
* \brief RegisterAppInterfaceRequest class constructor
**/
explicit RegisterAppInterfaceRequest(const MessageSharedPtr& message);
/**
* @brief RegisterAppInterfaceRequest class destructor
**/
virtual ~RegisterAppInterfaceRequest();
/**
* @brief Init required by command resources
**/
virtual bool Init();
/**
* @brief Execute command
**/
virtual void Run();
/**
* @brief Sends RegisterAppInterface response to mobile
*
*@param application_impl application
*
**/
void SendRegisterAppInterfaceResponseToMobile(
mobile_apis::Result::eType result = mobile_apis::Result::SUCCESS);
private:
/*
* @brief Check new ID along with known mobile application ID
*
* return TRUE if ID is known already, otherwise - FALSE
*/
bool IsApplicationWithSameAppIdRegistered();
/*
* @brief Check new application parameters (name, tts, vr) for
* coincidence with already known parameters of registered applications
*
* return SUCCESS if there is no coincidence of app.name/TTS/VR synonyms,
* otherwise appropriate error code returns
*/
mobile_apis::Result::eType CheckCoincidence();
/*
* @brief Predicate for using with CheckCoincidence method to compare with VR synonym SO
*
* return TRUE if there is coincidence of VR, otherwise FALSE
*/
struct CoincidencePredicateVR {
explicit CoincidencePredicateVR(const std::string &newItem)
:newItem_(newItem)
{};
bool operator()(smart_objects::SmartObject obj) {
const std::string vr_synonym = obj.asString();
return !(strcasecmp(vr_synonym.c_str(), newItem_.c_str()));
};
const std::string &newItem_;
};
/**
* @brief Check request parameters against policy table data
* @return SUCCESS if check ok, otherwise return appropriate error code
*/
mobile_apis::Result::eType CheckWithPolicyData();
/**
* @brief Fill DeviceInfo struct with data from request, if any
* @param device_info Struct for device params from request
*/
void FillDeviceInfo(policy::DeviceInfo* device_info);
/**
* @brief Checks register app interface params(ttsName, ...).
* When type is String there is a check on the contents \t\n \\t \\n
* @return if register app interface contains \t\n \\t \\n return TRUE,
* FALSE otherwise
*/
bool IsWhiteSpaceExist();
/**
* @brief Checks vehicle type params (model, year etc.) and in case of absense
* replaces with policy table backup values
* @param vehicle_type VehicleType struct
* @param param Vehicle param
* @param backup_value Backup value
*/
void CheckResponseVehicleTypeParam(smart_objects::SmartObject& vehicle_type,
const std::string& param,
const std::string& backup_value);
/**
* @brief Sends ButtonSubscription notification at start up
* to notify HMI that app subscribed on the custom button by default.
*/
void SendSubscribeCustomButtonNotification();
private:
std::string response_info_;
mobile_apis::Result::eType result_checking_app_hmi_type_;
DISALLOW_COPY_AND_ASSIGN(RegisterAppInterfaceRequest);
};
} // namespace commands
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_COMMANDS_MOBILE_REGISTER_APP_INTERFACE_REQUEST_H_
|
