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
|
<?php
/*
** Zabbix
** Copyright (C) 2001-2023 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.
**/
/**
* Class containing methods for operations with auditlog records.
*/
class CAuditLog extends CApiService {
public const ACCESS_RULES = [
'get' => ['min_user_type' => USER_TYPE_SUPER_ADMIN]
];
/**
* @var string Database table name.
*/
protected $tableName = 'auditlog';
/**
* @var string Database table name alias.
*/
protected $tableAlias = 'a';
/**
* @var array Database fields list allowed for sort operation.
*/
protected $sortColumns = ['auditid', 'userid', 'clock'];
/**
* Method auditlog.get, returns audit log records according filtering criteria.
*
* @param array $options Array of API request options.
* @param int|array $options['auditids'] Filter by auditids.
* @param int|array $options['userids'] Filter by userids.
* @param int $options['time_from'] Filter by timestamp, range start time, inclusive.
* @param int $options['time_till'] Filter by timestamp, range end time, inclusive.
* @param string $options['sortfield'] Sorting field: auditid, userid, clock.
* @param string $options['sortorder'] Sorting direction.
* @param array $options['filter'] Filter by fields value, exact match.
* @param array $options['search'] Filter by fields value, case insensitive search of substring.
* @param bool $options['countOutput']
* @param bool $options['excludeSearch']
* @param int $options['limit']
* @param string|array $options['output']
* @param bool $options['preservekeys']
* @param bool $options['searchByAny']
* @param bool $options['searchWildcardsEnabled']
* @param bool $options['startSearch']
*
* @throws APIException
*
* @return array|int
*/
public function get(array $options) {
if (self::$userData['type'] != USER_TYPE_SUPER_ADMIN) {
self::exception(ZBX_API_ERROR_PERMISSIONS, _('You do not have permission to perform this operation.'));
}
$result = [];
$fields = array_keys($this->getTableSchema($this->tableName())['fields']);
$api_input_rules = ['type' => API_OBJECT, 'fields' => [
// filter
'auditids' => ['type' => API_CUIDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],
'userids' => ['type' => API_IDS, 'flags' => API_ALLOW_NULL | API_NORMALIZE, 'default' => null],
'filter' => ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['auditid', 'userid', 'clock', 'action', 'resourcetype', 'ip', 'resourceid', 'resourcename', 'username', 'recordsetid']],
'search' => ['type' => API_FILTER, 'flags' => API_ALLOW_NULL, 'default' => null, 'fields' => ['ip', 'resourcename', 'username', 'details']],
'time_from' => ['type' => API_INT32, 'flags' => API_ALLOW_NULL, 'default' => null],
'time_till' => ['type' => API_INT32, 'flags' => API_ALLOW_NULL, 'default' => null],
'searchByAny' => ['type' => API_BOOLEAN, 'default' => false],
'startSearch' => ['type' => API_FLAG, 'default' => false],
'excludeSearch' => ['type' => API_FLAG, 'default' => false],
'searchWildcardsEnabled' => ['type' => API_BOOLEAN, 'default' => false],
// output
'output' => ['type' => API_OUTPUT, 'in' => implode(',', $fields), 'default' => $fields],
'countOutput' => ['type' => API_FLAG, 'default' => false],
// sort and limit
'sortfield' => ['type' => API_STRINGS_UTF8, 'flags' => API_NORMALIZE, 'in' => implode(',', $this->sortColumns), 'uniq' => true, 'default' => []],
'sortorder' => ['type' => API_SORTORDER, 'default' => []],
'limit' => ['type' => API_INT32, 'flags' => API_ALLOW_NULL, 'in' => '1:'.ZBX_MAX_INT32, 'default' => null],
// flags
'preservekeys' => ['type' => API_BOOLEAN, 'default' => false]
]];
if (!CApiInputValidator::validate($api_input_rules, $options, '/', $error)) {
self::exception(ZBX_API_ERROR_PARAMETERS, $error);
}
$sql_parts = [
'select' => ['auditlog' => 'a.auditid'],
'from' => ['auditlog' => 'auditlog a'],
'where' => [],
'order' => [],
'limit' => null
];
if ($options['output'] === API_OUTPUT_EXTEND) {
$options['output'] = $fields;
}
if ($options['userids'] !== null) {
$sql_parts['where']['userid'] = dbConditionId('a.userid', $options['userids']);
}
if ($options['time_from'] !== null) {
$sql_parts['where'][] = 'a.clock>='.zbx_dbstr($options['time_from']);
}
if ($options['time_till'] !== null) {
$sql_parts['where'][] = 'a.clock<='.zbx_dbstr($options['time_till']);
}
$sql_parts = $this->applyQueryFilterOptions($this->tableName, $this->tableAlias, $options, $sql_parts);
$sql_parts = $this->applyQueryOutputOptions($this->tableName, $this->tableAlias, $options, $sql_parts);
$sql_parts = $this->applyQuerySortOptions($this->tableName, $this->tableAlias, $options, $sql_parts);
$res = DBselect(self::createSelectQueryFromParts($sql_parts), $options['limit']);
while ($audit = DBfetch($res)) {
if (!$options['countOutput']) {
$result[$audit['auditid']] = $audit;
continue;
}
$result = $audit['rowscount'];
}
if ($options['countOutput']) {
return $result;
}
if (!$options['preservekeys']) {
$result = array_values($result);
}
return $this->unsetExtraFields($result, ['auditid'], $options['output']);
}
}
|
