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
|
/**
* 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_CORE_SERVICE_H_
#define SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_CORE_SERVICE_H_
#include <string>
#include <vector>
#include "application_manager/service.h"
#include "application_manager/application.h"
#include "policy/policy_types.h"
namespace Json {
class Value;
}
namespace application_manager {
struct CommandParametersPermissions;
/**
* @brief Class through which the plug-in can interact with the core
*/
class CoreService : public Service {
public:
/**
* @brief CoreService class destructor
*/
explicit CoreService(ApplicationManager& application_manager);
/**
* @brief CoreService class destructor
*/
virtual ~CoreService();
/**
* @brief Checks message permissions and cuts parameters according
* to policy table permissions
* @param msg message to cut disallowed parameters
* @return result according by mobile API
*/
mobile_apis::Result::eType CheckPolicyPermissions(MessagePtr msg) FINAL;
/**
* Checks if module for application is present in policy table
* @param app_id id of application
* @param module type
* @return true if module is present, otherwise - false
*/
bool CheckModule(const ApplicationId& app_id,
const std::string& module) FINAL;
/**
* Checks if application has remote control functions
* @param app application
* @return true if application has remote control functions
*/
bool IsRemoteControlApplication(ApplicationSharedPtr app) const FINAL;
/**
* @brief Gets current state of the specified interface
* @param interface which state to get
* @return true if specified interface available otherwise false
*/
bool IsInterfaceAvailable(
const HmiInterfaces::InterfaceID interface) const FINAL;
/**
* Removes fake parameters from request to HMI
* @param message message to handle
*/
void RemoveHMIFakeParameters(application_manager::MessagePtr& message) FINAL;
/**
* @brief Get pointer to application by application id
* @param app_id application id
* return pointer to application
*/
ApplicationSharedPtr GetApplication(ApplicationId app_id) FINAL;
/**
* @brief Send message to HMI
* @param message Message to HMI
*/
void SendMessageToHMI(const MessagePtr& message) FINAL;
/**
* @brief Send message to mobile device
* @param message Message to mobile
*/
void SendMessageToMobile(const MessagePtr& message) FINAL;
/**
* @brief Returns unique correlation ID for next HMI request
*
* @return Unique correlation ID
*/
uint32_t GetNextCorrelationID() FINAL;
/**
* @brief Returns all applications
*
* @return List with shared pointers to applications
*/
std::vector<ApplicationSharedPtr> GetApplications(AppExtensionUID uid) FINAL;
/**
* @brief Change hmi level of app and notify it
* @param app Application to be changed and notified
* @param level New HMI level of app
*/
void ChangeNotifyHMILevel(ApplicationSharedPtr app,
mobile_apis::HMILevel::eType level) FINAL;
const smart_objects::SmartObject* GetRCCapabilities() const FINAL;
/**
* @brief Notify HMI about app changing HMI Level
* only NONE, BACKGROUND and LIMITED levels are sent
* @param app Application to be changed and notified
* @param level New HMI level of app
*/
void NotifyHMIAboutHMILevel(ApplicationSharedPtr app,
mobile_apis::HMILevel::eType level) FINAL;
/**
* Gets all allowed module types
* @param app_id unique identifier of application
* @param list of allowed module types
* @return true if application has allowed modules
*/
bool GetModuleTypes(const std::string& policy_app_id,
std::vector<std::string>* modules) const FINAL;
/**
* @brief ValidateMessageBySchema Checks whether message is valid according
* to API
* @param message Message to check
* @return Check result
*/
MessageValidationResult ValidateMessageBySchema(const Message& message) FINAL;
/**
* @brief Gets application manager settings structure
* @return reference to application manager settings structure
*/
const ApplicationManagerSettings& GetSettings() const FINAL;
private:
/**
* @brief AreParametersAllowed Checks message parameters across current policy
* permissions
* @param msg Message having parameters
* @param params Parameters sorted by permissions
* @return True if allowed, otherwise - false
*/
bool AreParametersAllowed(MessagePtr msg,
const CommandParametersPermissions& params);
/**
* @brief CheckParams Checks object params with allowed parameters received
* from policy
* @param object Message object
* @param allowed_params Parameters allowed by policy
* @return True if all parameters allowed, otherwise - false
*/
bool CheckParams(const Json::Value& object,
const policy::RPCParams& allowed_params);
/**
* @brief IsAllowed Checks particular parameter among allowed list
* @param name Parameter name
* @param allowed_params List of allowed parameters
* @return True if found, otherwise - false
*/
bool IsAllowed(const std::string& name,
const policy::RPCParams& allowed_params);
ApplicationManager& application_manager_;
DISALLOW_COPY_AND_ASSIGN(CoreService);
};
} // namespace application_manager
#endif // SRC_COMPONENTS_APPLICATION_MANAGER_INCLUDE_APPLICATION_MANAGER_CORE_SERVICE_H_
|
