You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

488 lines
15 KiB

<?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 graph.
*/
class CGraph extends CGraphGeneral {
protected $tableName = 'graphs';
protected $tableAlias = 'g';
protected $sortColumns = ['graphid', 'name', 'graphtype'];
protected const FLAGS = ZBX_FLAG_DISCOVERY_NORMAL;
public function __construct() {
parent::__construct();
$this->errorMessages = array_merge($this->errorMessages, [
self::ERROR_TEMPLATE_HOST_MIX =>
_('Graph "%1$s" with templated items cannot contain items from other hosts.'),
self::ERROR_MISSING_GRAPH_NAME => _('Missing "name" field for graph.'),
self::ERROR_MISSING_GRAPH_ITEMS => _('Missing items for graph "%1$s".'),
self::ERROR_MISSING_REQUIRED_VALUE => _('No "%1$s" given for graph.'),
self::ERROR_GRAPH_SUM => _('Cannot add more than one item with type "Graph sum" on graph "%1$s".')
]);
}
/**
* Get graph data.
*
* @param array $options
*
* @return array
*/
public function get($options = []) {
$result = [];
$sqlParts = [
'select' => ['graphs' => 'g.graphid'],
'from' => ['graphs' => 'graphs g'],
'where' => [],
'group' => [],
'order' => [],
'limit' => null
];
$defOptions = [
'groupids' => null,
'templateids' => null,
'hostids' => null,
'graphids' => null,
'itemids' => null,
'templated' => null,
'inherited' => null,
'editable' => false,
'nopermissions' => null,
// filter
'filter' => null,
'search' => null,
'searchByAny' => null,
'startSearch' => false,
'excludeSearch' => false,
'searchWildcardsEnabled' => null,
// output
'output' => API_OUTPUT_EXTEND,
'selectGroups' => null,
'selectHostGroups' => null,
'selectTemplateGroups' => null,
'selectTemplates' => null,
'selectHosts' => null,
'selectItems' => null,
'selectGraphItems' => null,
'selectDiscoveryRule' => null,
'selectGraphDiscovery' => null,
'countOutput' => false,
'groupCount' => false,
'preservekeys' => false,
'sortfield' => '',
'sortorder' => '',
'limit' => null
];
$options = zbx_array_merge($defOptions, $options);
$this->checkDeprecatedParam($options, 'selectGroups');
// permission check
if (self::$userData['type'] != USER_TYPE_SUPER_ADMIN && !$options['nopermissions']) {
$permission = $options['editable'] ? PERM_READ_WRITE : PERM_READ;
$userGroups = getUserGroupsByUserId(self::$userData['userid']);
// check permissions by graph items
$sqlParts['where'][] = 'NOT EXISTS ('.
'SELECT NULL'.
' FROM graphs_items gi,items i,hosts_groups hgg'.
' LEFT JOIN rights r'.
' ON r.id=hgg.groupid'.
' AND '.dbConditionInt('r.groupid', $userGroups).
' WHERE g.graphid=gi.graphid'.
' AND gi.itemid=i.itemid'.
' AND i.hostid=hgg.hostid'.
' GROUP BY i.hostid'.
' HAVING MAX(permission)<'.zbx_dbstr($permission).
' OR MIN(permission) IS NULL'.
' OR MIN(permission)='.PERM_DENY.
')';
}
// groupids
if (!is_null($options['groupids'])) {
zbx_value2array($options['groupids']);
$sqlParts['from']['graphs_items'] = 'graphs_items gi';
$sqlParts['from']['items'] = 'items i';
$sqlParts['from']['hosts_groups'] = 'hosts_groups hg';
$sqlParts['where'][] = dbConditionInt('hg.groupid', $options['groupids']);
$sqlParts['where'][] = 'hg.hostid=i.hostid';
$sqlParts['where']['gig'] = 'gi.graphid=g.graphid';
$sqlParts['where']['igi'] = 'i.itemid=gi.itemid';
$sqlParts['where']['hgi'] = 'hg.hostid=i.hostid';
if ($options['groupCount']) {
$sqlParts['group']['hg'] = 'hg.groupid';
}
}
// templateids
if (!is_null($options['templateids'])) {
zbx_value2array($options['templateids']);
if (!is_null($options['hostids'])) {
zbx_value2array($options['hostids']);
$options['hostids'] = array_merge($options['hostids'], $options['templateids']);
}
else {
$options['hostids'] = $options['templateids'];
}
}
// hostids
if (!is_null($options['hostids'])) {
zbx_value2array($options['hostids']);
$sqlParts['from']['graphs_items'] = 'graphs_items gi';
$sqlParts['from']['items'] = 'items i';
$sqlParts['where'][] = dbConditionInt('i.hostid', $options['hostids']);
$sqlParts['where']['gig'] = 'gi.graphid=g.graphid';
$sqlParts['where']['igi'] = 'i.itemid=gi.itemid';
if ($options['groupCount']) {
$sqlParts['group']['i'] = 'i.hostid';
}
}
// graphids
if (!is_null($options['graphids'])) {
zbx_value2array($options['graphids']);
$sqlParts['where'][] = dbConditionInt('g.graphid', $options['graphids']);
}
// itemids
if (!is_null($options['itemids'])) {
zbx_value2array($options['itemids']);
$sqlParts['from']['graphs_items'] = 'graphs_items gi';
$sqlParts['where']['gig'] = 'gi.graphid=g.graphid';
$sqlParts['where'][] = dbConditionInt('gi.itemid', $options['itemids']);
if ($options['groupCount']) {
$sqlParts['group']['gi'] = 'gi.itemid';
}
}
// templated
if (!is_null($options['templated'])) {
$sqlParts['from']['graphs_items'] = 'graphs_items gi';
$sqlParts['from']['items'] = 'items i';
$sqlParts['from']['hosts'] = 'hosts h';
$sqlParts['where']['igi'] = 'i.itemid=gi.itemid';
$sqlParts['where']['ggi'] = 'g.graphid=gi.graphid';
$sqlParts['where']['hi'] = 'h.hostid=i.hostid';
if ($options['templated']) {
$sqlParts['where'][] = 'h.status='.HOST_STATUS_TEMPLATE;
}
else {
$sqlParts['where'][] = 'h.status<>'.HOST_STATUS_TEMPLATE;
}
}
// inherited
if (!is_null($options['inherited'])) {
if ($options['inherited']) {
$sqlParts['where'][] = 'g.templateid IS NOT NULL';
}
else {
$sqlParts['where'][] = 'g.templateid IS NULL';
}
}
// search
if (is_array($options['search'])) {
zbx_db_search('graphs g', $options, $sqlParts);
}
// filter
if (is_null($options['filter'])) {
$options['filter'] = [];
}
if (is_array($options['filter'])) {
if (!array_key_exists('flags', $options['filter'])) {
$options['filter']['flags'] = [ZBX_FLAG_DISCOVERY_NORMAL, ZBX_FLAG_DISCOVERY_CREATED];
}
$this->dbFilter('graphs g', $options, $sqlParts);
if (isset($options['filter']['host'])) {
zbx_value2array($options['filter']['host']);
$sqlParts['from']['graphs_items'] = 'graphs_items gi';
$sqlParts['from']['items'] = 'items i';
$sqlParts['from']['hosts'] = 'hosts h';
$sqlParts['where']['gig'] = 'gi.graphid=g.graphid';
$sqlParts['where']['igi'] = 'i.itemid=gi.itemid';
$sqlParts['where']['hi'] = 'h.hostid=i.hostid';
$sqlParts['where']['host'] = dbConditionString('h.host', $options['filter']['host']);
}
if (isset($options['filter']['hostid'])) {
zbx_value2array($options['filter']['hostid']);
$sqlParts['from']['graphs_items'] = 'graphs_items gi';
$sqlParts['from']['items'] = 'items i';
$sqlParts['where']['gig'] = 'gi.graphid=g.graphid';
$sqlParts['where']['igi'] = 'i.itemid=gi.itemid';
$sqlParts['where']['hostid'] = dbConditionInt('i.hostid', $options['filter']['hostid']);
}
}
// limit
if (zbx_ctype_digit($options['limit']) && $options['limit']) {
$sqlParts['limit'] = $options['limit'];
}
$sqlParts = $this->applyQueryOutputOptions($this->tableName(), $this->tableAlias(), $options, $sqlParts);
$sqlParts = $this->applyQuerySortOptions($this->tableName(), $this->tableAlias(), $options, $sqlParts);
$dbRes = DBselect(self::createSelectQueryFromParts($sqlParts), $sqlParts['limit']);
while ($graph = DBfetch($dbRes)) {
if ($options['countOutput']) {
if ($options['groupCount']) {
$result[] = $graph;
}
else {
$result = $graph['rowscount'];
}
}
else {
// Graphs share table with graph prototypes. Therefore remove graph unrelated fields.
unset($graph['discover']);
$result[$graph['graphid']] = $graph;
}
}
if ($options['countOutput']) {
return $result;
}
if (isset($options['expandName'])) {
$result = CMacrosResolverHelper::resolveGraphNameByIds($result);
}
if ($result) {
$result = $this->addRelatedObjects($options, $result);
}
// removing keys (hash -> array)
if (!$options['preservekeys']) {
$result = zbx_cleanHashes($result);
}
return $result;
}
/**
* Delete graphs.
*
* @param array $graphids
*
* @return array
*/
public function delete(array $graphids) {
$this->validateDelete($graphids, $db_graphs);
CGraphManager::delete($graphids);
$this->addAuditBulk(CAudit::ACTION_DELETE, CAudit::RESOURCE_GRAPH, $db_graphs);
return ['graphids' => $graphids];
}
/**
* Validates the input parameters for the delete() method.
*
* @param array $graphids [IN/OUT]
* @param array $db_graphs [OUT]
*
* @throws APIException if the input is invalid.
*/
private function validateDelete(array &$graphids, array &$db_graphs = null) {
$api_input_rules = ['type' => API_IDS, 'flags' => API_NOT_EMPTY, 'uniq' => true];
if (!CApiInputValidator::validate($api_input_rules, $graphids, '/', $error)) {
self::exception(ZBX_API_ERROR_PARAMETERS, $error);
}
$db_graphs = $this->get([
'output' => ['graphid', 'name', 'templateid'],
'graphids' => $graphids,
'editable' => true,
'preservekeys' => true
]);
foreach ($graphids as $graphid) {
if (!array_key_exists($graphid, $db_graphs)) {
self::exception(ZBX_API_ERROR_PERMISSIONS,
_('No permissions to referred object or it does not exist!')
);
}
if ($db_graphs[$graphid]['templateid'] != 0) {
self::exception(ZBX_API_ERROR_PARAMETERS, _('Cannot delete templated graph.'));
}
}
}
protected function addRelatedObjects(array $options, array $result) {
$result = parent::addRelatedObjects($options, $result);
$graphids = array_keys($result);
// adding Items
if ($options['selectItems'] !== null && $options['selectItems'] !== API_OUTPUT_COUNT) {
$relationMap = $this->createRelationMap($result, 'graphid', 'itemid', 'graphs_items');
$items = API::Item()->get([
'output' => $options['selectItems'],
'itemids' => $relationMap->getRelatedIds(),
'webitems' => true,
'nopermissions' => true,
'preservekeys' => true
]);
$result = $relationMap->mapMany($result, $items, 'items');
}
// adding discoveryRule
if ($options['selectDiscoveryRule'] !== null) {
$discoveryRules = [];
$relationMap = new CRelationMap();
$dbRules = DBselect(
'SELECT id.parent_itemid,gd.graphid'.
' FROM graph_discovery gd,item_discovery id,graphs_items gi,items i'.
' WHERE '.dbConditionInt('gd.graphid', $graphids).
' AND gd.parent_graphid=gi.graphid'.
' AND gi.itemid=id.itemid'.
' AND id.parent_itemid=i.itemid'.
' AND i.flags='.ZBX_FLAG_DISCOVERY_RULE
);
while ($relation = DBfetch($dbRules)) {
$relationMap->addRelation($relation['graphid'], $relation['parent_itemid']);
}
$related_ids = $relationMap->getRelatedIds();
if ($related_ids) {
$discoveryRules = API::DiscoveryRule()->get([
'output' => $options['selectDiscoveryRule'],
'itemids' => $related_ids,
'nopermissions' => true,
'preservekeys' => true
]);
}
$result = $relationMap->mapOne($result, $discoveryRules, 'discoveryRule');
}
// adding graph discovery
if ($options['selectGraphDiscovery'] !== null) {
$graphDiscoveries = API::getApiService()->select('graph_discovery', [
'output' => $this->outputExtend($options['selectGraphDiscovery'], ['graphid']),
'filter' => ['graphid' => array_keys($result)],
'preservekeys' => true
]);
$relationMap = $this->createRelationMap($graphDiscoveries, 'graphid', 'graphid');
$graphDiscoveries = $this->unsetExtraFields($graphDiscoveries, ['graphid'],
$options['selectGraphDiscovery']
);
$result = $relationMap->mapOne($result, $graphDiscoveries, 'graphDiscovery');
}
return $result;
}
/**
* @inheritdoc
*/
protected static function checkDuplicates(array $graphs): void {
$_graph_indexes = [];
foreach ($graphs as $i => $graph) {
foreach ($graph['gitems'] as $gitem) {
$_graph_indexes[$gitem['itemid']][] = $i;
}
}
$options = [
'output' => ['itemid', 'hostid'],
'itemids' => array_keys($_graph_indexes),
'filter' => ['flags' => [ZBX_FLAG_DISCOVERY_NORMAL, ZBX_FLAG_DISCOVERY_CREATED]]
];
$result = DBselect(DB::makeSql('items', $options));
$graph_indexes = [];
while ($row = DBfetch($result)) {
foreach ($_graph_indexes[$row['itemid']] as $i) {
if (array_key_exists($row['hostid'], $graph_indexes)
&& array_key_exists($graphs[$i]['name'], $graph_indexes[$row['hostid']])
&& $graph_indexes[$row['hostid']][$graphs[$i]['name']] != $i) {
self::exception(ZBX_API_ERROR_PARAMETERS, _s('Invalid parameter "%1$s": %2$s.', '/'.($i + 1),
_s('value %1$s already exists', '(name)=('.$graphs[$i]['name'].')')
));
}
$graph_indexes[$row['hostid']][$graphs[$i]['name']] = $i;
}
}
$result = DBselect(
'SELECT DISTINCT g.graphid,g.name,i.hostid'.
' FROM graphs g,graphs_items gi,items i'.
' WHERE g.graphid=gi.graphid'.
' AND gi.itemid=i.itemid'.
' AND '.dbConditionString('g.name', array_unique(array_column($graphs, 'name'))).
' AND '.dbConditionInt('g.flags', [ZBX_FLAG_DISCOVERY_NORMAL, ZBX_FLAG_DISCOVERY_CREATED]).
' AND '.dbConditionId('i.hostid', array_keys($graph_indexes))
);
while ($row = DBfetch($result)) {
if (array_key_exists($row['hostid'], $graph_indexes)
&& array_key_exists($row['name'], $graph_indexes[$row['hostid']])) {
$graph = $graphs[$graph_indexes[$row['hostid']][$row['name']]];
if (!array_key_exists('graphid', $graph) || bccomp($row['graphid'], $graph['graphid']) != 0) {
$hosts = DB::select('hosts', [
'output' => ['host', 'status'],
'hostids' => $row['hostid']
]);
$error = in_array($hosts[0]['status'], [HOST_STATUS_MONITORED, HOST_STATUS_NOT_MONITORED])
? _('Graph "%1$s" already exists on the host "%2$s".')
: _('Graph "%1$s" already exists on the template "%2$s".');
self::exception(ZBX_API_ERROR_PARAMETERS, sprintf($error, $graph['name'], $hosts[0]['host']));
}
}
}
}
}