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
|
<?php
/*
** Copyright (C) 2001-2025 Zabbix SIA
**
** This program is free software: you can redistribute it and/or modify it under the terms of
** the GNU Affero General Public License as published by the Free Software Foundation, version 3.
**
** 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 Affero General Public License for more details.
**
** You should have received a copy of the GNU Affero General Public License along with this program.
** If not, see <https://www.gnu.org/licenses/>.
**/
/**
* This class can be used for any pre-processing required for API calls made from the frontend.
*/
class CFrontendApiWrapper extends CApiWrapper {
/**
* Whether to enable debug mode.
*
* @var bool
*/
public $debug = false;
/**
* The profiler class used for profiling API calls.
*
* @var CProfiler
*/
protected $profiler;
/**
* Set the profiler class.
*
* @param CProfiler $profiler
*/
public function setProfiler(CProfiler $profiler) {
$this->profiler = $profiler;
}
/**
* Call the API method with profiling.
*
* If the API call has been unsuccessful - return only the result value.
* If the API call has been unsuccessful - add an error message and return false, instead of an array.
*
* @param string $method
* @param array $params
*
* @return mixed
*/
protected function callMethod($method, array $params) {
API::setWrapper();
$response = parent::callMethod($method, $params);
API::setWrapper($this);
// call profiling
if ($this->debug) {
$this->profiler->profileApiCall($this->api, $method, $params, $response->data);
}
if (!$response->errorCode) {
return $response->data;
}
else {
// add an error message
$trace = $response->errorMessage;
if ($response->debug) {
$trace .= ' ['.$this->profiler->formatCallStack($response->debug).']';
}
error($trace);
return false;
}
}
/**
* Call the client method. Pass the "auth" parameter only to the methods that require it.
*
* @param string $method API method
* @param array $params API parameters
*
* @return CApiClientResponse
*/
protected function callClientMethod($method, $params) {
$auth = ($this->requiresAuthentication($this->api, $method))
? $this->auth
: ['type' => CJsonRpc::AUTH_TYPE_PARAM, 'auth' => null];
return $this->client->callMethod($this->api, $method, $params, $auth);
}
/**
* Returns true if calling the given method requires an 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'));
}
}
|
