Current File : /var/www/projetos/suporte.iigd.com.br/src/Dashboard/Dashboard.php
<?php
/**
* ---------------------------------------------------------------------
*
* GLPI - Gestionnaire Libre de Parc Informatique
*
* http://glpi-project.org
*
* @copyright 2015-2024 Teclib' and contributors.
* @copyright 2003-2014 by the INDEPNET Development Team.
* @licence https://www.gnu.org/licenses/gpl-3.0.html
*
* ---------------------------------------------------------------------
*
* LICENSE
*
* This file is part of GLPI.
*
* 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 3 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, see <https://www.gnu.org/licenses/>.
*
* ---------------------------------------------------------------------
*/
namespace Glpi\Dashboard;
use Glpi\Toolbox\Sanitizer;
use Ramsey\Uuid\Uuid;
use Session;
class Dashboard extends \CommonDBTM
{
protected $id = 0;
protected $key = "";
protected $title = "";
protected $embed = false;
protected $items = null;
protected $rights = null;
protected $filters = "";
public static $all_dashboards = [];
public static $rightname = 'dashboard';
public function __construct(string $dashboard_key = "")
{
$this->key = $dashboard_key;
}
public static function getIndexName()
{
return "key";
}
/**
* Retrieve the current dashboard from the DB (or from cache)
* with its rights and items
*
* @param bool $force if true, don't use cache
*
* @return false|int Id of the loaded dashboard, or false on failure
*/
public function load(bool $force = false)
{
$loaded = true;
if (
$force
|| count($this->fields) == 0
|| $this->fields['id'] == 0
|| strlen($this->fields['name']) == 0
) {
$loaded = $this->getFromDB($this->key);
}
if ($loaded) {
if ($force || $this->items === null) {
$this->items = Item::getForDashboard($this->fields['id']);
}
if ($force || $this->rights === null) {
$this->rights = Right::getForDashboard($this->fields['id']);
}
}
return $this->fields['id'] ?? false;
}
public function getFromDB($ID)
{
/** @var \DBmysql $DB */
global $DB;
$iterator = $DB->request([
'FROM' => self::getTable(),
'WHERE' => [
'key' => $ID
],
'LIMIT' => 1
]);
if (count($iterator) == 1) {
$this->fields = $iterator->current();
$this->key = $ID;
$this->post_getFromDB();
return true;
} else if (count($iterator) > 1) {
trigger_error(
sprintf('getFromDB expects to get one result, %1$s found!', count($iterator)),
E_USER_WARNING
);
}
return false;
}
/**
* Return the title of the current dasbhoard
*
* @return string
*/
public function getTitle(): string
{
$this->load();
return $this->fields['name'] ?? "";
}
/**
* Do we have the right to view the current dashboard
*
* @return bool
*/
public function canViewCurrent(): bool
{
$this->load();
if ($this->fields['users_id'] === Session::getLoginUserID()) {
// User is always allowed to view its own dashboards.
return true;
}
// check global (admin) right
if (self::canView() && !$this->isPrivate()) {
return true;
}
// check access rights defined using sharing feature
$this->load();
$rights = self::convertRights($this->rights ?? []);
return self::checkRights($rights);
}
/**
* Check if user has right to update the current dashboard.
*
* @return bool
*/
public function canUpdateCurrent(): bool
{
$this->load();
if ($this->fields['users_id'] === Session::getLoginUserID()) {
// User is always allowed to update its own dashboards.
return true;
}
return self::canUpdate();
}
/**
* Check if user has right to detele the current dashboard.
*
* @return bool
*/
public function canDeleteCurrent(): bool
{
$this->load();
if ($this->fields['users_id'] === Session::getLoginUserID()) {
// User is always allowed to delete its own dashboards.
return true;
}
return self::canPurge();
}
/**
* Save the current dashboard instance to DB
*
* @param string $title label of the dasbhoard, will be suglified to have a corresponding key
* @param string $context of the dasbhoard, filter the dasboard collection by a key
* @param array $items cards for the dashboard
* @param array $rights for the dasbhoard
*
* @return string
*/
public function saveNew(
string $title = "",
string $context = "core",
array $items = [],
array $rights = []
): string {
$this->fields['name'] = $title;
$this->fields['context'] = $context;
$this->fields['users_id'] = Session::getLoginUserID();
$this->key = \Toolbox::slugify($title);
$this->items = $items;
$this->rights = $rights;
$this->save();
return $this->key;
}
/**
* Save current dashboard
*
* @param bool $skip_child skip saving rights and items
*
* @return void
*/
public function save(bool $skip_child = false)
{
/**
* @var \DBmysql $DB
* @var \Psr\SimpleCache\CacheInterface $GLPI_CACHE
*/
global $DB, $GLPI_CACHE;
$DB->updateOrInsert(
self::getTable(),
Sanitizer::dbEscapeRecursive([
'key' => $this->key,
'name' => $this->fields['name'],
'context' => $this->fields['context'],
'users_id' => $this->fields['users_id'],
]),
[
'key' => $this->key
]
);
// reload dashboard
$this->getFromDB($this->key);
//save items
if (!$skip_child && count($this->items) > 0) {
$this->saveItems($this->items);
}
//save rights
if (!$skip_child && count($this->rights) > 0) {
$this->saveRights($this->rights);
}
}
public function cleanDBonPurge()
{
$this->deleteChildrenAndRelationsFromDb([
Item::class,
Right::class,
Filter::class,
]);
}
/**
* Save items in DB for the current dashboard
*
* @param array $items cards of the dashboard, contains:
* - gridstack_id: unique id of the card in the grid, usually build like card_id.uuidv4
* - card_id: key of array return by getAllDasboardCards
* - x: position in grid
* - y: position in grid
* - width: size in grid
* - height: size in grid
* - card_options, sub array, depends on the card, contains at least a key color
*
* @return void
*/
public function saveItems(array $items = [])
{
$this->load();
$this->items = $items;
$this->deleteChildrenAndRelationsFromDb([
Item::class,
]);
Item::addForDashboard($this->fields['id'], $items);
}
/**
* Save title DB for the current dashboard
*
* @param string $title of the current dashboard
*
* @return void
*/
public function saveTitle(string $title = "")
{
if (!strlen($title)) {
return;
}
$this->load();
$this->fields['name'] = $title;
$this->save(true);
}
/**
* Save rights (share) in DB for the current dashboard
*
* @param array $rights contains these data:
* - 'users_id' => [items_id]
* - 'groups_id' => [items_id]
* - 'entities_id' => [items_id]
* - 'profiles_id' => [items_id]
*
* @return void
*/
public function saveRights(array $rights = [])
{
$this->load();
$this->rights = $rights;
$this->deleteChildrenAndRelationsFromDb([
Right::class,
]);
Right::addForDashboard($this->fields['id'], $rights);
}
/**
* Save filter in DB for the curent dashboard
*
* @param string $filter filter parameters in JSON format
*
* @return void
*/
public function saveFilter(string $filters = ''): void
{
$this->load();
$this->filters = $filters;
Filter::addForDashboard($this->fields['id'], $filters);
}
/**
* Save filter in DB for the curent dashboard
*
* @param string $filter filter parameters in JSON format
*
* @return string
*/
public function getFilter(): string
{
$this->load();
$this->filters = Filter::getForDashboard($this->fields['id']);
return $this->filters;
}
/**
* Clone current Dashboard.
* (Clean gridstack_id-id in new one)
*
* @return array with [title, key]
*/
public function cloneCurrent(): array
{
$this->load();
$this->fields['name'] = sprintf(__('Copy of %s'), $this->fields['name']);
$this->fields['users_id'] = Session::getLoginUserID();
$this->key = \Toolbox::slugify($this->fields['name']);
// replace gridstack_id (with uuid V4) in the copy, to avoid cache issue
$this->items = array_map(function (array $item) {
$item['gridstack_id'] = $item['card_id'] . Uuid::uuid4();
return $item;
}, $this->items);
// convert right to the good format
$this->rights = self::convertRights($this->rights);
$this->save();
return [
'title' => $this->fields['name'],
'key' => $this->key
];
}
/**
* Retrieve all dashboards and store them into a static var
*
* @param bool $force don't check dashboard are already loaded and force their load
* @param bool $check_rights use to remove rights checking (use in embed)
* @param ?string $context only dashboard for given context
*
* @return array dasboards
*/
public static function getAll(bool $force = false, bool $check_rights = true, ?string $context = 'core'): array
{
/** @var \DBmysql $DB */
global $DB;
if ($force || count(self::$all_dashboards) == 0) {
self::$all_dashboards = [];
$dashboards = iterator_to_array($DB->request(self::getTable()));
$items = iterator_to_array($DB->request(Item::getTable()));
$rights = iterator_to_array($DB->request(Right::getTable()));
foreach ($dashboards as $dashboard) {
$key = $dashboard['key'];
$id = $dashboard['id'];
$d_rights = array_filter($rights, static function ($right_line) use ($id) {
return $right_line['dashboards_dashboards_id'] == $id;
});
$dashboardItem = new self($key);
if ($check_rights && !$dashboardItem->canViewCurrent()) {
continue;
}
$dashboard['rights'] = self::convertRights($d_rights);
$d_items = array_filter($items, static function ($item) use ($id) {
return $item['dashboards_dashboards_id'] == $id;
});
$d_items = array_map(static function ($item) {
$item['card_options'] = importArrayFromDB($item['card_options']);
return $item;
}, $d_items);
$dashboard['items'] = $d_items;
self::$all_dashboards[$key] = $dashboard;
}
}
// Return dashboards filtered by context (if applicable)
if ($context !== null && $context !== '') {
return array_filter(self::$all_dashboards, static function ($dashboard) use ($context) {
return $dashboard['context'] === $context;
});
}
return self::$all_dashboards;
}
/**
* Convert right from DB entries to a array with type foreign keys.
* Ex:
* IN
* [
* [
* 'itemtype' => 'Entity'
* 'items_id' => yyy
* ], [
* ...
* ],
* ]
*
* OUT
* [
* 'entities_id' => [...]
* 'profiles_id' => [...]
* 'users_id' => [...]
* 'groups_id' => [...]
* ]
*
* @param array $raw_rights right from DB
*
* @return array converter rights
*/
public static function convertRights(array $raw_rights = []): array
{
$rights = [
'entities_id' => [],
'profiles_id' => [],
'users_id' => [],
'groups_id' => [],
];
foreach ($raw_rights as $right_line) {
$fk = getForeignKeyFieldForItemType($right_line['itemtype']);
$rights[$fk][] = $right_line['items_id'];
}
return $rights;
}
/**
* Check a current set of rights
*
* @param array $rights
*
* @return bool
*/
public static function checkRights(array $rights = []): bool
{
$default_rights = [
'entities_id' => [],
'profiles_id' => [],
'users_id' => [],
'groups_id' => [],
];
$rights = array_merge_recursive($default_rights, $rights);
if (!Session::getLoginUserID()) {
return false;
}
// check specific rights
if (
count(array_intersect($rights['entities_id'], $_SESSION['glpiactiveentities']))
|| in_array($_SESSION["glpiactiveprofile"]['id'], $rights['profiles_id'])
|| in_array($_SESSION['glpiID'], $rights['users_id'])
|| count(array_intersect($rights['groups_id'], $_SESSION['glpigroups']))
) {
return true;
}
return false;
}
/**
* Import dashboards from a variable
*
* @param string|array $import json or php array representing the dashboards collection
* [
* dashboard_key => [
* 'title' => '...',
* 'items' => [...],
* 'rights' => [...],
* ], [
* ...
* ]
* ]
*
* @return bool
*/
public static function importFromJson($import = null)
{
if (!is_array($import)) {
if (!\Toolbox::isJSON($import)) {
return false;
}
$import = json_decode($import, true);
}
foreach ($import as $key => $dashboard) {
$dash_object = new self($key);
$dash_object->saveNew(
$dashboard['title'] ?? $key,
$dashboard['context'] ?? "core",
$dashboard['items'] ?? [],
$dashboard['rights'] ?? []
);
}
return true;
}
public function setPrivate($is_private)
{
$this->load();
return $this->update([
'id' => $this->fields['id'],
'key' => $this->fields['key'],
'users_id' => ($is_private ? Session::getLoginUserID() : 0)
]);
}
public function getPrivate()
{
$this->load();
if (!isset($this->fields['users_id'])) {
return '0';
}
return $this->fields['users_id'] != '0' ? '1' : '0';
}
/**
* Is this dashboard private ?
*
* @return bool true if private; false otherwise
*/
public function isPrivate(): bool
{
if ((bool)$this->getPrivate() === false) {
return false;
}
return $this->fields['users_id'] != Session::getLoginUserID();
}
}
Mini Shell