pandorafms/pandora_console/include/class/TreeGroup.class.php

656 lines
20 KiB
PHP

<?php
/**
* Tree view.
*
* @category Tree
* @package Pandora FMS
* @subpackage Community
* @version 1.0.0
* @license See below
*
* ______ ___ _______ _______ ________
* | __ \.-----.--.--.--| |.-----.----.-----. | ___| | | __|
* | __/| _ | | _ || _ | _| _ | | ___| |__ |
* |___| |___._|__|__|_____||_____|__| |___._| |___| |__|_|__|_______|
*
* ============================================================================
* Copyright (c) 2005-2023 Pandora FMS
* Please see https://pandorafms.com/community/ for full contribution list
* 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 for version 2.
* 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.
* ============================================================================
*/
global $config;
require_once $config['homedir'].'/include/class/Tree.class.php';
/**
* Tree group class.
*/
class TreeGroup extends Tree
{
/**
* Propagate ACL.
*
* @var boolean
*/
protected $propagateCounters = true;
/**
* Display all groups.
*
* @var boolean
*/
protected $displayAllGroups = false;
/**
* Construct.
*
* @param string $type Type.
* @param string $rootType Root.
* @param integer $id Id.
* @param integer $rootID Root Id.
* @param boolean $serverID Server.
* @param string $childrenMethod Method children.
* @param string $access Access ACL.
*/
public function __construct(
$type,
$rootType='',
$id=-1,
$rootID=-1,
$serverID=false,
$childrenMethod='on_demand',
$access='AR'
) {
global $config;
parent::__construct(
$type,
$rootType,
$id,
$rootID,
$serverID,
$childrenMethod,
$access
);
$this->L1fieldName = 'id_group';
$this->L1extraFields = [
'tg.nombre AS `name`',
'tg.icon',
'tg.id_grupo AS gid',
];
$this->L2conditionInside = 'AND (
ta.id_grupo = '.$this->id.'
OR tasg.id_group = '.$this->id.'
)';
}
/**
* Setter propagate counters.
*
* @param boolean $value True or ffalse.
*
* @return void
*/
public function setPropagateCounters($value)
{
$this->propagateCounters = (bool) $value;
}
/**
* Setter all groups.
*
* @param boolean $value True or ffalse.
*
* @return void
*/
public function setDisplayAllGroups($value)
{
$this->displayAllGroups = (bool) $value;
}
/**
* Get data.
*
* @return void
*/
protected function getData()
{
if ($this->id == -1) {
$this->getFirstLevel();
} else if ($this->type == 'group') {
$this->getSecondLevel();
} else if ($this->type == 'agent') {
$this->getThirdLevel();
}
}
/**
* Filter search groups.
*
* @return string
*/
protected function getGroupSearchFilter()
{
return '';
}
/**
* First level tree.
*
* @return void
*/
protected function getFirstLevel()
{
$processed_items = $this->getProcessedGroups();
if (empty($processed_items) === false) {
if (empty($this->filter['searchGroup']) === false) {
$parentGroup = [
'name' => '',
'children' => $processed_items,
];
if (isset($this->filter['searchHirearchy']) === true
&& (bool) $this->filter['searchHirearchy'] === true
) {
self::getFullHierarchyGroups($parentGroup, $this->filter['searchGroup']);
$result = $parentGroup['children'];
} else {
$result = self::pruneHierarchyGroups($parentGroup, $this->filter['searchGroup']);
}
$processed_items = ($result === false) ? [] : $result;
}
// GroupID filter. To access the view from tactical views f.e.
if (empty($this->filter['groupID']) === false) {
$result = self::extractItemWithID(
$processed_items,
$this->filter['groupID'],
'group',
false
);
$processed_items = ($result === false) ? [] : [$result];
}
}
$this->tree = $processed_items;
}
/**
* Process group
*
* @return mixed
*/
protected function getProcessedGroups()
{
$processed_groups = [];
// Index and process the groups.
$groups = $this->getGroupCounters();
// If user have not permissions in parent, set parent node to 0 (all)
// Avoid to do foreach for admins.
if (users_can_manage_group_all('AR') === false) {
foreach ($groups as $id => $group) {
if (isset($this->userGroups[$groups[$id]['parent']]) === false) {
$groups[$id]['parent'] = 0;
}
}
}
// Build the group hierarchy.
foreach ($groups as $id => $group) {
if (isset($groups[$id]['parent']) === true
&& ($groups[$id]['parent'] != 0)
) {
$parent = $groups[$id]['parent'];
// Parent exists.
if (isset($groups[$parent]['children']) === false) {
$groups[$parent]['children'] = [];
}
// Store a reference to the group into the parent.
$groups[$parent]['children'][] = &$groups[$id];
// This group was introduced into a parent.
$groups[$id]['have_parent'] = true;
}
}
// Sort the children groups.
foreach ($groups as $id => $group) {
if (isset($groups[$id]['children']) === true) {
usort($groups[$id]['children'], ['Tree', 'cmpSortNames']);
}
}
// Filter groups and eliminates the reference to
// children groups out of her parent.
$groups = array_filter(
$groups,
function ($group) {
return !($group['have_parent'] ?? false);
}
);
// Propagate child counters to her parents.
if ($this->propagateCounters === true) {
self::processCounters($groups);
// Filter groups and eliminates the reference to empty groups.
$groups = $this->deleteEmptyGroups($groups);
} else {
$groups = $this->deleteEmptyGroupsNotPropagate($groups);
}
usort($groups, ['Tree', 'cmpSortNames']);
return $groups;
}
protected function getGroupCounters()
{
$fields = $this->getFirstLevelFields();
$inside_fields = $this->getFirstLevelFieldsInside();
$group_acl = '';
$secondary_group_acl = '';
if (!users_can_manage_group_all('AR')) {
$user_groups_str = implode(',', $this->userGroupsArray);
$group_acl = " AND ta.id_grupo IN ($user_groups_str)";
$secondary_group_acl = " AND tasg.id_group IN ($user_groups_str)";
}
$agent_search_filter = $this->getAgentSearchFilter();
$agent_search_filter = preg_replace('/%/', '%%', $agent_search_filter);
$agent_status_filter = $this->getAgentStatusFilter();
$module_status_filter = $this->getModuleStatusFilter();
$module_search_inner = '';
$module_search_filter = '';
if (!empty($this->filter['searchModule'])) {
$module_search_inner = '
INNER JOIN tagente_modulo tam
ON ta.id_agente = tam.id_agente
INNER JOIN tagente_estado tae
ON tae.id_agente_modulo = tam.id_agente_modulo';
$module_search_filter = "AND tam.disabled = 0
AND tam.nombre LIKE '%%".$this->filter['searchModule']."%%' ".$this->getModuleStatusFilterFromTestado();
}
$table = is_metaconsole() ? 'tmetaconsole_agent' : 'tagente';
$table_sec = is_metaconsole() ? 'tmetaconsole_agent_secondary_group' : 'tagent_secondary_group';
$only_disabled = (is_metaconsole() === true) ? (int) $this->filter['show_disabled'] : 0;
$sql_model = "SELECT %s FROM
(
SELECT COUNT(DISTINCT(ta.id_agente)) AS total, id_grupo AS g
FROM $table ta
$module_search_inner
WHERE ta.disabled = $only_disabled
%s
$agent_search_filter
$agent_status_filter
$module_status_filter
$module_search_filter
$group_acl
GROUP BY id_grupo
UNION ALL
SELECT COUNT(DISTINCT(ta.id_agente)) AS total, id_group AS g
FROM $table ta INNER JOIN $table_sec tasg
ON ta.id_agente = tasg.id_agent
$module_search_inner
WHERE ta.disabled = $only_disabled
%s
$agent_search_filter
$agent_status_filter
$module_status_filter
$module_search_filter
$secondary_group_acl
GROUP BY id_group
) x GROUP BY g";
$sql_array = [];
foreach ($inside_fields as $inside_field) {
$sql_array[] = sprintf(
$sql_model,
$inside_field['header'],
$inside_field['condition'],
$inside_field['condition']
);
}
$sql = "SELECT $fields FROM (".implode(' UNION ALL ', $sql_array).') x2
RIGHT JOIN tgrupo tg
ON x2.g = tg.id_grupo
GROUP BY tg.id_grupo';
$stats = db_get_all_rows_sql($sql);
$group_stats = [];
foreach ($stats as $group) {
$group_stats[$group['gid']]['total_count'] = (int) $group['total_count'];
$group_stats[$group['gid']]['total_critical_count'] = (int) $group['total_critical_count'];
$group_stats[$group['gid']]['total_unknown_count'] = (int) $group['total_unknown_count'];
$group_stats[$group['gid']]['total_warning_count'] = (int) $group['total_warning_count'];
$group_stats[$group['gid']]['total_not_init_count'] = (int) $group['total_not_init_count'];
$group_stats[$group['gid']]['total_normal_count'] = (int) $group['total_normal_count'];
$group_stats[$group['gid']]['total_fired_count'] = (int) $group['total_alerts_count'];
$group_stats[$group['gid']]['name'] = $group['name'];
$group_stats[$group['gid']]['parent'] = $group['parent'];
$group_stats[$group['gid']]['icon'] = $group['icon'];
$group_stats[$group['gid']]['id'] = $group['gid'];
$group_stats[$group['gid']] = $this->getProcessedItem($group_stats[$group['gid']]);
}
return $group_stats;
}
protected function getFirstLevelFields()
{
$fields = parent::getFirstLevelFields();
$parent = $this->getDisplayHierarchy() ? 'tg.parent' : '0 as parent';
return "$fields, $parent";
}
protected function getProcessedModules($modules_tree)
{
$groups = [];
foreach ($modules_tree as $group) {
$groups[$group['id']] = $group;
}
// Build the module hierarchy.
foreach ($groups as $id => $group) {
if (isset($groups[$id]['parent']) === true && ($groups[$id]['parent'] != 0)) {
$parent = $groups[$id]['parent'];
// Parent exists.
if (isset($groups[$parent]['children']) === true) {
$groups[$parent]['children'] = [];
}
// Store a reference to the group into the parent.
$groups[$parent]['children'][] = &$groups[$id];
// This group was introduced into a parent.
$groups[$id]['have_parent'] = true;
}
}
// Sort the children groups.
foreach ($groups as $id => $group) {
if (isset($groups[$id]['children']) === true) {
usort($groups[$id]['children'], ['Tree', 'cmpSortNames']);
}
}
return array_values($groups);
}
// FIXME: Hierarchy lops is broken
protected function getProcessedModules_old($modules_tree)
{
$tree_modules = [];
$new_modules_root = array_filter(
$modules_tree,
function ($module) {
return (isset($module['parent']) && ($module['parent'] == 0));
}
);
$new_modules_child = array_filter(
$modules_tree,
function ($module) {
return (isset($module['parent']) && ($module['parent'] != 0));
}
);
$i = 0;
while (!empty($new_modules_child)) {
foreach ($new_modules_child as $i => $child) {
self::recursive_modules_tree_view($new_modules_root, $new_modules_child, $i, $child);
}
}
foreach ($new_modules_root as $m) {
$tree_modules[] = $m;
}
return $tree_modules;
}
// FIXME with getProcessedModules_old
static function recursive_modules_tree_view(&$new_modules, &$new_modules_child, $i, $child)
{
foreach ($new_modules as $index => $module) {
if ($module['id'] == $child['parent']) {
$new_modules[$index]['children'][] = $child;
unset($new_modules_child[$i]);
break;
} else if (isset($new_modules[$index]['children'])) {
self::recursive_modules_tree_view($new_modules[$index]['children'], $new_modules_child, $i, $child);
}
}
}
static function processCounters(&$groups)
{
$all_counters = [];
foreach ($groups as $id => $group) {
$child_counters = [];
if (!empty($groups[$id]['children'])) {
$child_counters = self::processCounters($groups[$id]['children']);
}
if (!empty($child_counters)) {
foreach ($child_counters as $type => $value) {
$groups[$id]['counters'][$type] += $value;
}
}
foreach ($groups[$id]['counters'] as $type => $value) {
if (isset($all_counters[$type]) === false) {
$all_counters[$type] = 0;
}
$all_counters[$type] += $value;
}
}
return $all_counters;
}
/**
* @brief Recursive function to remove the empty groups
*
* @param groups All groups structure
*
* @return new_groups A new groups structure without empty groups
*/
protected function deleteEmptyGroups($groups)
{
if ($this->displayAllGroups) {
return $groups;
}
$new_groups = [];
foreach ($groups as $group) {
// If a group is empty, do not add to new_groups.
if (!isset($group['counters']['total']) || $group['counters']['total'] == 0) {
continue;
}
// Tray to remove the children groups
if (!empty($group['children'])) {
$children = $this->deleteEmptyGroups($group['children']);
if (empty($children)) {
unset($group['children']);
} else {
$group['children'] = $children;
}
}
$new_groups[] = $group;
}
return $new_groups;
}
protected function deleteEmptyGroupsNotPropagate($groups)
{
if ($this->displayAllGroups) {
return $groups;
}
$new_groups = [];
foreach ($groups as $group) {
// Tray to remove the children groups
if (!empty($group['children'])) {
$children = $this->deleteEmptyGroupsNotPropagate($group['children']);
if (empty($children)) {
unset($group['children']);
// If a group is empty, do not add to new_groups.
if (isset($group['counters']['total']) && $group['counters']['total'] != 0) {
$new_groups[] = $group;
}
} else {
$group['children'] = $children;
$new_groups[] = $group;
}
} else {
// If a group is empty, do not add to new_groups.
if (isset($group['counters']['total']) && $group['counters']['total'] != 0) {
$new_groups[] = $group;
}
}
}
return $new_groups;
}
/**
* Get all hierarchy groups.
*
* @param array $group Groups.
* @param string $search Serach.
*
* @return boolean
*/
protected static function getFullHierarchyGroups(&$group, $search): bool
{
if (stripos($group['name'], $search) !== false) {
return true;
}
if (empty($group['children'] ?? []) === true) {
return false;
}
$has_occurrences = false;
$count_children = count($group['children']);
for ($i = 0; $i < $count_children; $i++) {
if (self::getFullHierarchyGroups($group['children'][$i], $search) === false) {
unset($group['children'][$i]);
} else {
$has_occurrences = true;
}
}
return $has_occurrences;
}
/**
* Get prune groups.
*
* @param array $group Groups.
* @param string $search Serach.
*
* @return array
*/
protected static function pruneHierarchyGroups($group, $search): array
{
$matches = [];
foreach (($group['children'] ?? []) as $child) {
if (stripos($child['name'], $search) !== false) {
$matches[] = $child;
} else {
$matches = [
...$matches,
...self::pruneHierarchyGroups($child, $search),
];
}
}
return $matches;
}
private static function extractItemWithID($items, $item_id, $item_type='group', $strictACL=false)
{
foreach ($items as $item) {
if ($item['type'] != $item_type) {
continue;
}
// Item found
if ($strictACL && is_metaconsole()) {
foreach ($item['id'] as $server_id => $id) {
if ($id == $item_id) {
return $item;
}
}
} else {
if ($item['id'] == $item_id) {
return $item;
}
}
if ($item['type'] == 'group' && !empty($item['children'])) {
$result = self::extractItemWithID($item['children'], $item_id, $item_type, $strictACL);
// Item found on children
if ($result !== false) {
return $result;
}
}
}
// Item not found
return false;
}
protected function getDisplayHierarchy()
{
if (isset($this->filter['searchHirearchy']) === false) {
$this->filter['searchHirearchy'] = false;
}
return $this->filter['searchHirearchy'] ||
(empty($this->filter['searchAgent']) && empty($this->filter['searchModule']));
}
}