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
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2018 Zabbix SIA
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
**/
/**
* This class should be used to call API services locally using the CApiService classes.
*/
class CLocalApiClient extends CApiClient {
/**
* Factory for creating API services.
*
* @var CRegistryFactory
*/
protected $serviceFactory;
/**
* Whether debug mode is enabled.
*
* @var bool
*/
protected $debug = false;
/**
* Set service factory.
*
* @param CRegistryFactory $factory
*/
public function setServiceFactory(CRegistryFactory $factory) {
$this->serviceFactory = $factory;
}
/**
* Call the given API service method and return the response.
*
* @param string $requestApi API name
* @param string $requestMethod API method
* @param mixed $params API parameters
* @param string $auth Authentication token
*
* @return CApiClientResponse
*/
public function callMethod($requestApi, $requestMethod, $params, $auth) {
global $DB;
$api = strtolower($requestApi);
$method = strtolower($requestMethod);
$response = new CApiClientResponse();
// check API
if (!$this->isValidApi($api)) {
$response->errorCode = ZBX_API_ERROR_PARAMETERS;
$response->errorMessage = _s('Incorrect API "%1$s".', $requestApi);
return $response;
}
// check method
if (!$this->isValidMethod($api, $method)) {
$response->errorCode = ZBX_API_ERROR_PARAMETERS;
$response->errorMessage = _s('Incorrect method "%1$s.%2$s".', $requestApi, $requestMethod);
return $response;
}
// check params
if (!is_array($params)) {
$response->errorCode = ZBX_API_ERROR_PARAMETERS;
$response->errorMessage = _s('Cannot call method "%1$s.%2$s" without parameters.', $requestApi,
$requestMethod
);
return $response;
}
$requiresAuthentication = $this->requiresAuthentication($api, $method);
// check that no authentication token is passed to methods that don't require it
if (!$requiresAuthentication && $auth !== null) {
$response->errorCode = ZBX_API_ERROR_PARAMETERS;
$response->errorMessage = _s('The "%1$s.%2$s" method must be called without the "auth" parameter.',
$requestApi, $requestMethod
);
return $response;
}
$newTransaction = false;
try {
// authenticate
if ($requiresAuthentication) {
$this->authenticate($auth);
}
// the nopermission parameter must not be available for external API calls.
unset($params['nopermissions']);
// if no transaction has been started yet - start one
if ($DB['TRANSACTIONS'] == 0) {
DBstart();
$newTransaction = true;
}
// call API method
$result = call_user_func_array([$this->serviceFactory->getObject($api), $method], [$params]);
// if the method was called successfully - commit the transaction
if ($newTransaction) {
DBend(true);
}
$response->data = $result;
}
catch (Exception $e) {
if ($newTransaction) {
// if we're calling user.login and authentication failed - commit the transaction to save the
// failed attempt data
if ($api === 'user' && $method === 'login') {
DBend(true);
}
// otherwise - revert the transaction
else {
DBend(false);
}
}
$response->errorCode = ($e instanceof APIException) ? $e->getCode() : ZBX_API_ERROR_INTERNAL;
$response->errorMessage = $e->getMessage();
// add debug data
if ($this->debug) {
$response->debug = $e->getTrace();
}
}
return $response;
}
/**
* Checks if the authentication token is valid.
*
* @param string $auth
*
* @throws APIException
*/
protected function authenticate($auth) {
if (zbx_empty($auth)) {
throw new APIException(ZBX_API_ERROR_NO_AUTH, _('Not authorised.'));
}
$user = $this->serviceFactory->getObject('user')->checkAuthentication(['sessionid' => $auth]);
$this->debug = $user['debug_mode'];
}
/**
* Returns true if the given API is valid.
*
* @param string $api
*
* @return bool
*/
protected function isValidApi($api) {
return $this->serviceFactory->hasObject($api);
}
/**
* Returns true if the given method is valid.
*
* @param string $api
* @param string $method
*
* @return bool
*/
protected function isValidMethod($api, $method) {
$apiService = $this->serviceFactory->getObject($api);
// validate the method
$availableMethods = [];
foreach (get_class_methods($apiService) as $serviceMethod) {
// the comparison must be case insensitive
$availableMethods[strtolower($serviceMethod)] = true;
}
return isset($availableMethods[$method]);
}
/**
* Returns true if calling the given method requires a valid authentication token.
*
* @param $api
* @param $method
*
* @return bool
*/
protected function requiresAuthentication($api, $method) {
return !(($api === 'user' && $method === 'login')
|| ($api === 'user' && $method === 'checkauthentication')
|| ($api === 'apiinfo' && $method === 'version'));
}
}
|
