";
echo "| ";
diff --git a/inc/dashboard/dashboard.class.php b/inc/dashboard/dashboard.class.php
deleted file mode 100644
index 7227ec1f73..0000000000
--- a/inc/dashboard/dashboard.class.php
+++ /dev/null
@@ -1,490 +0,0 @@
-.
- * ---------------------------------------------------------------------
- */
-
-namespace Glpi\Dashboard;
-
-use Ramsey\Uuid\Uuid;
-
-if (!defined('GLPI_ROOT')) {
- die("Sorry. You can't access this file directly");
-}
-
-class Dashboard extends \CommonDBTM {
- protected $id = 0;
- protected $key = "";
- protected $title = "";
- protected $embed = false;
- protected $items = null;
- protected $rights = null;
-
- static $all_dashboards = [];
- static $rightname = 'dashboard';
-
-
- public function __construct(string $dashboard_key = "") {
- $this->key = $dashboard_key;
- }
-
-
- 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 int
- */
- public function load(bool $force = false): int {
- $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) {
- global $DB;
-
- $iterator = $DB->request([
- 'FROM' => self::getTable(),
- 'WHERE' => [
- 'key' => $ID
- ],
- 'LIMIT' => 1
- ]);
- if (count($iterator) == 1) {
- $this->fields = $iterator->next();
- $this->key = $ID;
- $this->post_getFromDB();
- return true;
- } else if (count($iterator) > 1) {
- \Toolbox::logWarning(
- sprintf(
- 'getFromDB expects to get one result, %1$s found!',
- count($iterator)
- )
- );
- }
-
- 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 {
- // check global (admin) right
- if (self::canView()) {
- return true;
- }
-
- $this->load();
-
- //check shared rights
- $rights = self::convertRights($this->rights ?? []);
- return self::checkRights($rights);
- }
-
-
- /**
- * 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->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) {
- global $DB, $GLPI_CACHE;
-
- $DB->updateOrInsert(self::getTable(), [
- 'key' => $this->key,
- 'name' => $this->fields['name'],
- 'context' => $this->fields['context']
- ], [
- '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);
- }
-
- // invalidate dashboard cache
- $cache_key = "dashboard_card_".$this->key;
- $GLPI_CACHE->delete($cache_key);
- }
-
-
- function cleanDBonPurge() {
- $this->deleteChildrenAndRelationsFromDb([
- Item::class,
- Right::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);
- }
-
-
- /**
- * Clone current Dashboard.
- * (Clean gridstack_id-id in new one)
- *
- * @return array with [title, key]
- */
- function cloneCurrent(): array {
- $this->load();
-
- $this->fields['name'] = sprintf(__('Copy of %s'), $this->fields['name']);
- $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
- */
- static function getAll(
- bool $force = false,
- bool $check_rights = true,
- string $context = 'core'
- ): array {
- global $DB;
-
- if (!$force && count(self::$all_dashboards) > 0) {
- return self::$all_dashboards;
- }
-
- // empty previous data
- self::$all_dashboards = [];
-
- $dashboard_criteria = [];
- if (strlen($context)) {
- $dashboard_criteria['context'] = $context;
- }
-
- $dashboards = iterator_to_array($DB->request(self::getTable(), ['WHERE' => $dashboard_criteria]));
- $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, function($right_line) use($id) {
- return $right_line['dashboards_dashboards_id'] == $id;
- });
- if ($check_rights && !self::checkRights(self::convertRights($d_rights))) {
- continue;
- }
- $dashboard['rights'] = self::convertRights($d_rights);
-
- $d_items = array_filter($items, function($item) use($id) {
- return $item['dashboards_dashboards_id'] == $id;
- });
- $d_items = array_map(function($item) {
- $item['card_options'] = importArrayFromDB($item['card_options']);
- return $item;
- }, $d_items);
- $dashboard['items'] = $d_items;
-
- self::$all_dashboards[$key] = $dashboard;
- }
-
- 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
- */
- 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
- */
- static function checkRights(array $rights = []): bool {
- // check global (admin) right
- if (self::canView()) {
- return true;
- }
-
- $default_rights = [
- 'entities_id' => [],
- 'profiles_id' => [],
- 'users_id' => [],
- 'groups_id' => [],
- ];
- $rights = array_merge_recursive($default_rights, $rights);
-
- // check specific rights
- if (count(array_intersect($rights['entities_id'], $_SESSION['glpiactiveentities']))
- || count(array_intersect($rights['profiles_id'], array_keys($_SESSION['glpiprofiles'])))
- || 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
- */
- static function importFromJson($import = null) {
- if (!is_array($import)) {
- $import = json_decode($import, true);
- if (json_last_error() !== JSON_ERROR_NONE) {
- return false;
- }
- }
-
- 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;
- }
-}
diff --git a/inc/dashboard/filter.class.php b/inc/dashboard/filter.class.php
deleted file mode 100644
index 3f24170d7d..0000000000
--- a/inc/dashboard/filter.class.php
+++ /dev/null
@@ -1,251 +0,0 @@
-.
- * ---------------------------------------------------------------------
- */
-
-namespace Glpi\Dashboard;
-
-use CommonGLPI;
-use ITILCategory;
-use RequestType;
-use Location;
-use Manufacturer;
-use Session;
-use Html;
-use Group;
-use Plugin;
-use User;
-
-if (!defined('GLPI_ROOT')) {
- die("Sorry. You can't access this file directly");
-}
-
-/**
- * Filter class
-**/
-class Filter extends CommonGLPI {
-
- /**
- * Return all available filters
- * Plugins can hooks on this functions to add their own filters
- *
- * @return array of filters
- */
- static function getAll(): array {
- $filters = [
- 'dates' => __("Creation date"),
- 'dates_mod' => __("Last update"),
- 'itilcategory' => ITILCategory::getTypeName(Session::getPluralNumber()),
- 'requesttype' => RequestType::getTypeName(Session::getPluralNumber()),
- 'location' => Location::getTypeName(Session::getPluralNumber()),
- 'manufacturer' => Manufacturer::getTypeName(Session::getPluralNumber()),
- 'group_tech' => __("Technician group"),
- 'user_tech' => __("Technician"),
- ];
-
- $more_filters = Plugin::doHookFunction("dashboard_filters");
- if (is_array($more_filters)) {
- $filters = array_merge($filters, $more_filters);
- }
-
- return $filters;
- }
-
- /**
- * Get HTML for a dates range filter
- *
- * @param string|array $values init the input with these values, will be a string if empty values
- * @param string $fieldname how is named the current date field
- * (used to specify creation date or last update)
- *
- * @return string
- */
- static function dates($values = "", string $fieldname = 'dates'): string {
- // string mean empty value
- if (is_string($values)) {
- $values = [];
- }
-
- $rand = mt_rand();
- $label = self::getAll()[$fieldname];
- $field = Html::showDateField('filter-dates', [
- 'value' => $values,
- 'rand' => $rand,
- 'range' => true,
- 'display' => false,
- 'calendar_btn' => false,
- 'placeholder' => $label,
- 'on_change' => "on_change_{$rand}(selectedDates, dateStr, instance)",
- ]);
-
- $js = << 0);
- }
-
- /**
- * Get HTML for a dates range filter. Same as date but for last update field
- *
- * @param string|array $values init the input with these values, will be a string if empty values
- *
- * @return string
- */
- static function dates_mod($values): string {
- return self::dates($values, "dates_mod");
- }
-
-
- static function itilcategory(string $value = ""): string {
- return self::dropdown($value, 'itilcategory', ItilCategory::class);
- }
-
- static function requesttype(string $value = ""): string {
- return self::dropdown($value, 'requesttype', RequestType::class);
- }
-
- static function location(string $value = ""): string {
- return self::dropdown($value, 'location', Location::class);
- }
-
- static function manufacturer(string $value = ""): string {
- return self::dropdown($value, 'manufacturer', Manufacturer::class);
- }
-
- static function group_tech(string $value = ""): string {
- return self::dropdown($value, 'group_tech', Group::class, ['toadd' => [-1 => __("My groups")]]);
- }
-
- static function user_tech(string $value = ""): string {
- return self::dropdown($value, 'user_tech', User::class, ['right' => 'own_ticket']);
- }
-
- static function dropdown(
- string $value = "",
- string $fieldname = "",
- string $itemtype = "",
- array $add_params = []
- ): string {
- $value = !empty($value) ? (int) $value : null;
- $rand = mt_rand();
- $label = self::getAll()[$fieldname];
- $field = $itemtype::dropdown([
- 'name' => $fieldname,
- 'value' => $value,
- 'rand' => $rand,
- 'display' => false,
- 'display_emptychoice' => false,
- 'emptylabel' => '',
- 'placeholder' => $label,
- 'on_change' => "on_change_{$rand}()",
- 'allowClear' => true,
- 'width' => ''
- ] + $add_params);
-
- $js = << 0)
- };
-
-JAVASCRIPT;
- $js = Html::scriptBlock($js);
-
- return $js.self::field($fieldname, $field, $label, $value > 0);
- }
-
- /**
- * Get generic HTML for a filter
- *
- * @param string $id system name of the filter (ex "dates")
- * @param string $field html of the filter
- * @param string $label displayed label for the filter
- * @param bool $filled
- *
- * @return string the html for the complete field
- */
- static function field(
- string $id = "",
- string $field = "",
- string $label = "",
- bool $filled = false
- ): string {
-
- $rand = mt_rand();
- $class = $filled ? "filled" : "";
- $html = <<
- $field
-
-
-
-HTML;
-
- $js = << 0) {
- $('#filter-{$rand}').addClass('filled');
- } else {
- $('#filter-{$rand}').removeClass('filled');
- }
-
- $(this).width((str_len + 1) * 8 );
- });
-
- $('#filter-{$rand}')
- .hover(function() {
- $('.dashboard .card.filter-{$id}').addClass('filter-impacted');
- }, function() {
- $('.dashboard .card.filter-{$id}').removeClass('filter-impacted');
- });
- });
-JAVASCRIPT;
- $js = Html::scriptBlock($js);
-
- return $html.$js;
- }
-}
diff --git a/inc/dashboard/grid.class.php b/inc/dashboard/grid.class.php
deleted file mode 100644
index 5d72f1c3c4..0000000000
--- a/inc/dashboard/grid.class.php
+++ /dev/null
@@ -1,1524 +0,0 @@
-.
- * ---------------------------------------------------------------------
- */
-
-namespace Glpi\Dashboard;
-
-use Ramsey\Uuid\Uuid;
-
-use Config;
-use CommonGLPI;
-use Dropdown;
-use DBConnection;
-use Entity;
-use Group;
-use Html;
-use Plugin;
-use Profile;
-use Session;
-use ShareDashboardDropdown;
-use Telemetry;
-use Toolbox;
-use User;
-
-if (!defined('GLPI_ROOT')) {
- die("Sorry. You can't access this file directly");
-}
-
-class Grid extends CommonGLPI {
- protected $cell_margin = 6;
- protected $grid_cols = 26;
- protected $grid_rows = 24;
- protected $current = "";
- protected $dashboard = null;
- protected $items = [];
-
- static $embed = false;
- static $context = '';
- static $all_dashboards = [];
-
- public function __construct(
- string $dashboard_key = "central",
- int $grid_cols = 26,
- int $grid_rows = 24,
- string $context = "core"
- ) {
-
- $this->current = $dashboard_key;
- $this->grid_cols = $grid_cols;
- $this->grid_rows = $grid_rows;
-
- $this->dashboard = new Dashboard($dashboard_key);
- self::$context = $context;
- }
-
-
- /**
- * Return the instance of current dasbhoard
- *
- * @return Dashboard
- */
- public function getDashboard() {
- return $this->dashboard;
- }
-
-
- /**
- * load all existing dashboards from DB into a static property for caching data
- *
- * @param bool $force, if false, don't use cache
- *
- * @return bool
- */
- static function loadAllDashboards(bool $force = true): bool {
- if (!is_array(self::$all_dashboards)
- || count(self::$all_dashboards) === 0
- || $force) {
- self::$all_dashboards = Dashboard::getAll($force, !self::$embed, self::$context);
- }
-
- return is_array(self::$all_dashboards);
- }
-
-
- /**
- * Init dashboards cards
- * A define.php constant (GLPI_AJAX_DASHBOARD) exists to control how the cards should be loaded
- * - if true: only the parent block will be initialized and the content will be load by ajax
- * pros: if a widget fails, only this one will crash
- * - else: load all html
- * pros: better perfs
- *
- * @return void
- */
- public function getCards() {
- self::loadAllDashboards();
-
- if (!isset(self::$all_dashboards[$this->current])
- || !isset(self::$all_dashboards[$this->current]['items'])) {
- self::$all_dashboards[$this->current] = [
- 'items' => []
- ];
- }
-
- foreach (self::$all_dashboards[$this->current]['items'] as $specs) {
- $card_id = $specs['card_id'] ?? $specs['gridstack_id'] ?? $specs['id'];
- $gridstack_id = $specs['gridstack_id'] ?? $specs['id'];
- $card_options = ($specs['card_options'] ?? []) + [
- 'card_id' => $card_id
- ];
-
- if (GLPI_AJAX_DASHBOARD) {
- $card_html = <<
-
-
-HTML;
- } else {
- $card_html = $this->getCardHtml($card_id, ['args' => $card_options]);
- }
-
- // manage cache
- $dashboard_key = $this->current;
- $footprint = sha1(serialize($card_options).
- ($_SESSION['glpiactiveentities_string'] ?? "").
- ($_SESSION['glpilanguage']));
- $cache_key = "dashboard_card_{$dashboard_key}_{$footprint}";
- $card_options['cache_key'] = $cache_key;
-
- $this->addGridItem(
- $card_html,
- $gridstack_id,
- $specs['x'] ?? -1,
- $specs['y'] ?? -1,
- $specs['width'] ?? 2,
- $specs['height'] ?? 2,
- $card_options
- );
- }
- }
-
-
- /**
- * Do we have the right to view at least one dashboard int the current collection
- *
- * @return bool
- */
- public function canViewCurrent(): bool {
- // check global (admin) right
- if (Dashboard::canView()) {
- return true;
- }
-
- return $this->dashboard->canViewCurrent();
- }
-
-
- /**
- * Do we have the right to view at least one dashboard in the current collection
- *
- * @return bool
- */
- static function canViewOneDashboard(): bool {
- // check global (admin) right
- if (Dashboard::canView()) {
- return true;
- }
-
- self::loadAllDashboards();
-
- return (count(self::$all_dashboards) > 0);
- }
-
-
- /**
- * Do we have the right to view the specified dashboard int the current collection
- *
- * @param string $key the dashboard to check
- *
- * @return bool
- */
- static function canViewSpecificicDashboard($key): bool {
- // check global (admin) right
- if (Dashboard::canView()) {
- return true;
- }
-
- self::loadAllDashboards();
-
- return isset(self::$all_dashboards[$key]);
- }
-
-
- /**
- * Display grid for the current dashboard
- *
- * @return void display html of the grid
- */
- public function show(bool $mini = false) {
- $rand = mt_rand();
-
- if (!self::$embed && !$this->dashboard->canViewCurrent()) {
- return;
- }
-
- self::loadAllDashboards();
-
- $this->restoreLastDashboard();
-
- if ($mini) {
- $this->cell_margin = 3;
- }
-
- $embed_str = self::$embed ? "true" : "false";
- $embed_class = self::$embed ? "embed" : "";
- $mini_class = $mini ? "mini" : "";
-
- $nb_dashboards = count(self::$all_dashboards);
-
- $can_view_all = Session::haveRight('dashboard', READ) || self::$embed;
- $can_create = Session::haveRight('dashboard', CREATE);
- $can_edit = Session::haveRight('dashboard', UPDATE) && $nb_dashboards;
- $can_purge = Session::haveRight('dashboard', PURGE) && $nb_dashboards;
- $can_clone = $can_create && $nb_dashboards;
-
- // prepare html for add controls
- $add_controls = "";
- for ($y = 0; $y < $this->grid_rows; $y++) {
- for ($x = 0; $x < $this->grid_cols; $x++) {
- $add_controls.= " ";
- }
- }
-
- // prepare all available cards
- $cards = $this->getAllDasboardCards();
- $cards_json = json_encode($cards);
-
- // prepare all available widgets
- $all_widgets = Widget::getAllTypes();
- $all_widgets_json = json_encode($all_widgets);
-
- // prepare labels
- $embed_label = __("Share or embed this dashboard");
- $delete_label = __("Delete this dashboard");
- $history_label = __("Toggle auto-refresh");
- $night_label = __("Toggle night mode");
- $fs_label = __("Toggle fullscreen");
- $clone_label = __("Clone this dashboard");
- $edit_label = __("Toggle edit mode");
- $add_filter_lbl = __("Add filter");
- $add_dash_label = __("Add a new dashboard");
- $save_label = _x('button', "Save");
-
- $gridstack_items = $this->getGridItemsHtml();
-
- $dropdown_dashboards = "";
- if ($nb_dashboards) {
- $dropdown_dashboards = self::dropdownDashboard("", [
- 'value' => $this->current,
- 'display' => false,
- 'class' => 'dashboard_select',
- 'can_view_all' => $can_view_all,
- 'noselect2' => true,
- ]);
- }
-
- $dashboard_title = $this->dashboard->getTitle();
-
- $l_tb_icons = "";
- $r_tb_icons = "";
- $rename = "";
- $left_toolbar = "";
- $grid_guide = "";
-
- if (!self::$embed) {
- if (!$mini && $can_create) {
- $l_tb_icons.= "";
- }
- if (!$mini && $can_clone) {
- $r_tb_icons.= "";
- }
- if (!$mini && $can_edit) {
- $r_tb_icons.= "";
- $rename = "
-
-
-
- ";
- }
- if (!$mini && $can_purge) {
- $r_tb_icons.= "";
- }
- if ($can_edit) {
- $r_tb_icons.= "";
- }
-
- if (!$mini) {
- $r_tb_icons.= "";
- }
-
- if (!$mini) {
- $left_toolbar = <<
-
- $dropdown_dashboards
- $l_tb_icons
-
- $rename
-
-HTML;
- }
-
- $grid_guide = <<
- $add_controls
-
-HTML;
- }
-
- $toolbars = <<
-
-
- $r_tb_icons
-
-HTML;
-
- $filters = "";
- if (!$mini) {
- $filters = <<
-
-
-
- {$add_filter_lbl}
-
-
-
-HTML;
- }
-
- $embed_watermark = "";
- if (self::$embed) {
- $embed_watermark = "";
- }
-
- // display the grid
- $html = <<
- $embed_watermark
- $toolbars
- $filters
- $grid_guide
-
- $gridstack_items
-
-
-HTML;
-
- $ajax_cards = GLPI_AJAX_DASHBOARD;
- $context = self::$context;
- $cache_key = sha1($_SESSION['glpiactiveentities_string '] ?? "");
-
- $js = <<current}',
- cols: {$this->grid_cols},
- rows: {$this->grid_rows},
- cell_margin: {$this->cell_margin},
- rand: '{$rand}',
- embed: {$embed_str},
- ajax_cards: {$ajax_cards},
- all_cards: {$cards_json},
- all_widgets: {$all_widgets_json},
- context: "{$context}",
- cache_key: "{$cache_key}",
- })
- });
-JAVASCRIPT;
- $js = Html::scriptBlock($js);
-
- echo $html.$js;
- }
-
-
- public function showDefault() {
- echo "";
- $this->show();
- echo " ";
- }
-
-
- /**
- * Show an embeded dashboard.
- * We must check token validity to avoid displaying dashboard to invalid users
- *
- * @param array $params contains theses keys:
- * - dashboard: the dashboard system name
- * - entities_id: entity to init in session
- * - is_recursive: do we need to display sub entities
- * - token: the token to check
- *
- * @return void (display)
- */
- public function embed(array $params = []) {
- $defaults = [
- 'dashboard' => '',
- 'entities_id' => 0,
- 'is_recursive' => 0,
- 'token' => ''
- ];
- $params = array_merge($defaults, $params);
-
- if (!self::checkToken($params)) {
- Html::displayRightError();
- exit;
- }
-
- self::$embed = true;
-
- // load minimal session
- $_SESSION["glpiactive_entity"] = $params['entities_id'];
- $_SESSION["glpiactive_entity_recursive"] = $params['is_recursive'];
- $_SESSION["glpiname"] = 'embed_dashboard';
- $_SESSION["glpigroups"] = [];
- if ($params['is_recursive']) {
- $entities = getSonsOf("glpi_entities", $params['entities_id']);
- } else {
- $entities = [$params['entities_id']];
- }
- $_SESSION['glpiactiveentities'] = $entities;
- $_SESSION['glpiactiveentities_string'] = "'".implode("', '", $entities)."'";
-
- // show embeded dashboard
- $this->show(true);
- }
-
- static function getToken(string $dasboard = "", int $entities_id = 0, int $is_recursive = 0): string {
- $seed = $dasboard.$entities_id.$is_recursive.Telemetry::getInstanceUuid();
- $uuid = Uuid::uuid5(Uuid::NAMESPACE_OID, $seed);
- $token = $uuid->toString();
-
- return $token;
- }
-
- /**
- * Check token variables (compare it to `dashboard`, `entities_id` and `is_recursive` paramater)
- *
- * @param array $params contains theses keys:
- * - dashboard: the dashboard system name
- * - entities_id: entity to init in session
- * - is_recursive: do we need to display sub entities
- * - token: the token to check
- *
- * @return bool
- */
- static function checkToken(array $params = []):bool {
- $defaults = [
- 'dashboard' => '',
- 'entities_id' => 0,
- 'is_recursive' => 0,
- 'token' => ''
- ];
- $params = array_merge($defaults, $params);
-
- $token = self::getToken(
- $params['dashboard'],
- $params['entities_id'],
- $params['is_recursive']
- );
-
- if ($token !== $params['token']) {
- return false;
- Html::displayRightError();
- exit;
- }
-
- return true;
- }
-
-
- /**
- * Return the html for all items for the current dashboard
- *
- * @param bool $with_lock if true, return also a locked bottom item (to fix grid height)
- *
- * @return string html of the grid items
- */
- public function getGridItemsHtml(bool $with_lock = true, bool $embed = false): string {
- if ($embed) {
- self::$embed = true;
- }
-
- $this->getCards();
-
- if ($with_lock) {
- $this->items[] = <<
-HTML;
- }
-
- // append all elements to insert them in html
- return implode("", $this->items);
- }
-
-
- /**
- * Add a new grid item
- *
- * @param string $html content of the card
- * @param string $gridstack_id unique id identifying the card (used in gridstack)
- * @param int $x position in the grid
- * @param int $y position in the grid
- * @param int $width size in the grid
- * @param int $height size in the grid
- * @param array $data_option aditional options passed to the widget, contains at least thses keys:
- * - string 'color'
- * @return void
- */
- public function addGridItem(
- string $html = "",
- string $gridstack_id = "",
- int $x = -1,
- int $y = -1,
- int $width = 2,
- int $height = 2,
- array $data_option = []) {
-
- // let grid-stack to autoposition item
- $autoposition = 'data-gs-auto-position="true"';
- $coordinates = '';
- if ((int) $x >= 0 && (int) $y >= 0) {
- $autoposition = "";
- $coordinates = "data-gs-x='$x' data-gs-y='$y'";
- }
-
- $color = $data_option['color'] ?? "#FFFFFF";
- $fg_color = Toolbox::getFgColor($color, 100);
-
- // add card options in data attribute
- $data_option_attr = "";
- if (count($data_option)) {
- $data_option_attr = "data-card-options='".json_encode($data_option, JSON_HEX_APOS)."'";
- }
-
- $refresh_label = __("Refresh this card");
- $edit_label = __("Edit this card");
- $delete_label = __("Delete this card");
-
- $this->items[] = <<
-
-
-
-
-
- {$html}
-
-HTML;
- }
-
-
- /**
- * Display a mini form fo adding a new dashboard
- *
- * @return void (display)
- */
- public function displayAddDashboardForm() {
- $rand = mt_rand();
-
- echo ""; // .card.display-widget-form
- }
-
-
- /**
- * Display mini configuration form to add or edit a widget
- *
- * @param array $params with these keys:
- * - int 'gridstack_id': unique identifier of the card
- * - int 'x': position in the grid
- * - int 'y: position in the grid
- * - int 'width': size in the grid
- * - int 'height': size in the grid
- * - string 'rand': unique identifier for the dom
- * - string 'action': [display_add_widget|display_edit_widget] current action for the form
- * - array 'card_options': aditionnal options for the card, contains at least:
- * - string 'card_id': identifier return by @see self::getAllDasboardCards
- * - string 'color'
- *
- * @return void
- */
- public function displayWidgetForm(array $params = []) {
- $gridstack_id = $params['gridstack_id'] ?? "";
- $old_id = $gridstack_id;
- $x = (int) ($params['x'] ?? 0);
- $y = (int) ($params['y'] ?? 0);
- $width = (int) ($params['width'] ?? 0);
- $height = (int) ($params['height'] ?? 0);
- $cardopt = $params['card_options'] ?? ['color' => "#FAFAFA"];
- $card_id = $cardopt['card_id'] ?? "";
- $widgettypes = Widget::getAllTypes();
- $widgettype = $cardopt['widgettype'] ?? "";
- $widget_def = $widgettypes[$widgettype] ?? [];
- $use_gradient = $cardopt['use_gradient'] ?? 0;
- $point_labels = $cardopt['point_labels'] ?? 0;
- $limit = $cardopt['limit'] ?? 7;
- $color = $cardopt['color'];
- $edit = $params['action'] === "display_edit_widget";
- $rand = $params['rand'] ?? mt_rand();
- $cards = $this->getAllDasboardCards();
- $card = $cards[$card_id] ?? [];
- // append card id to options
- if (!isset($cardopt['card_id'] )) {
- $cardopt['card_id'] = $card_id;
- }
-
- $list_cards = [];
- array_walk($cards, function($data, $index) use (&$list_cards) {
- $group = $data['group'] ?? __("others");
- $list_cards[$group][$index] = $data['label'] ?? $data['itemtype']::getTypeName();
- });
-
- echo ""; // .card.display-widget-form
- }
-
-
- /**
- * Display mini form to add filter to the current dashboard
- *
- * @param array $params default values for
- * - 'used' already used filters
- *
- * @return void
- */
- public function displayFilterForm(array $params = []) {
- $default_params = [
- 'used' => [],
- ];
- $params = array_merge($default_params, $params);
-
- $used = array_flip($params['used']);
- $list_filters = array_diff_key(Filter::getAll(), $used);
-
- $rand = mt_rand();
- echo ""; // form.card.display-filter-form
- }
-
-
- /**
- * Display a mini form for embedding current dashboard in another application.
- * Also, display a select for sharing current dashboard to another users/groups/entities/profiles
- *
- * @return void
- */
- public function displayEmbedForm() {
- global $CFG_GLPI;
-
- $entities_id = $_SESSION['glpiactive_entity'];
- $is_recursive = $_SESSION['glpiactive_entity_recursive'];
- $token = self::getToken($this->current, $entities_id, $is_recursive);
-
- $embed_url = $CFG_GLPI['url_base'].
- "/front/central.php?embed&dashboard=".$this->current.
- "&entities_id=$entities_id".
- "&is_recursive=$is_recursive".
- "&token=$token";
-
- echo "
";
- echo "
";
-
- $this->displayEditRightsForm();
- }
-
-
- /**
- * Display a mini form for sharing current dashboard to another users/groups/entities/profiles.
- *
- * @return void
- */
- public function displayEditRightsForm() {
- self::loadAllDashboards();
- $rand = mt_rand();
- $values = [];
-
- echo " |