mirror of
https://github.com/Icinga/icingaweb2.git
synced 2025-09-25 18:59:04 +02:00
Introduce new Pane widget
This commit is contained in:
Yonas Habteab
parent
a216d5f956
commit
b11a692780
545
library/Icinga/Web/Dashboard/Pane.php
Normal file
545
library/Icinga/Web/Dashboard/Pane.php
Normal file
@ -0,0 +1,545 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
/* Icinga Web 2 | (c) 2022 Icinga GmbH | GPLv2+ */
|
||||||
|
|
||||||
|
namespace Icinga\Web\Dashboard;
|
||||||
|
|
||||||
|
use Icinga\Common\DataExtractor;
|
||||||
|
use Icinga\Web\Dashboard\Common\DisableWidget;
|
||||||
|
use Icinga\Web\Dashboard\Common\OrderWidget;
|
||||||
|
use Icinga\Exception\ProgrammingError;
|
||||||
|
use Icinga\Exception\ConfigurationError;
|
||||||
|
use Icinga\Model;
|
||||||
|
use Icinga\Web\Navigation\DashboardHome;
|
||||||
|
use ipl\Stdlib\Filter;
|
||||||
|
use ipl\Web\Url;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A pane, displaying different Dashboard dashlets
|
||||||
|
*/
|
||||||
|
class Pane implements OverridingWidget
|
||||||
|
{
|
||||||
|
use DisableWidget;
|
||||||
|
use OrderWidget;
|
||||||
|
use DataExtractor;
|
||||||
|
|
||||||
|
const TABLE = 'dashboard';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The name of this pane
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
private $name;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The title of this pane, as displayed in the dashboard tabs
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
private $title;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* An array of @see Dashlet that are displayed in this pane
|
||||||
|
*
|
||||||
|
* @var array
|
||||||
|
*/
|
||||||
|
private $dashlets = [];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Whether this widget overrides another widget
|
||||||
|
*
|
||||||
|
* @var bool
|
||||||
|
*/
|
||||||
|
private $override;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unique identifier of this pane
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
private $uuid;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Name of the owner/creator of this pane
|
||||||
|
*
|
||||||
|
* @var string
|
||||||
|
*/
|
||||||
|
private $owner;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Number of users who have subscribed to this pane if (public)
|
||||||
|
*
|
||||||
|
* @var int
|
||||||
|
*/
|
||||||
|
private $acceptance;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A dashboard home this pane is a part of
|
||||||
|
*
|
||||||
|
* @var DashboardHome
|
||||||
|
*/
|
||||||
|
private $home;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new pane
|
||||||
|
*
|
||||||
|
* @param string $name The pane to create
|
||||||
|
* @param array $properties
|
||||||
|
*/
|
||||||
|
public function __construct($name, array $properties = [])
|
||||||
|
{
|
||||||
|
$this->name = $name;
|
||||||
|
$this->title = $name;
|
||||||
|
|
||||||
|
if (! empty($properties)) {
|
||||||
|
$this->fromArray($properties);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the name of this pane
|
||||||
|
*
|
||||||
|
* @param string $name
|
||||||
|
*/
|
||||||
|
public function setName($name)
|
||||||
|
{
|
||||||
|
$this->name = $name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the name of this pane
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getName()
|
||||||
|
{
|
||||||
|
return $this->name;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the title of this pane
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getTitle()
|
||||||
|
{
|
||||||
|
return $this->title;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Overwrite the title of this pane
|
||||||
|
*
|
||||||
|
* @param string $title The new title to use for this pane
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setTitle($title)
|
||||||
|
{
|
||||||
|
$this->title = $title;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function override(bool $override)
|
||||||
|
{
|
||||||
|
$this->override = $override;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function isOverriding()
|
||||||
|
{
|
||||||
|
return $this->override;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set this pane's unique identifier
|
||||||
|
*
|
||||||
|
* @param string $uuid
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setUuid($uuid)
|
||||||
|
{
|
||||||
|
$this->uuid = $uuid;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get this pane's unique identifier
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getUuid()
|
||||||
|
{
|
||||||
|
return $this->uuid;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the owner of this dashboard
|
||||||
|
*
|
||||||
|
* @param string $owner
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setOwner($owner)
|
||||||
|
{
|
||||||
|
$this->owner = $owner;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get owner of this dashboard
|
||||||
|
*
|
||||||
|
* @return string
|
||||||
|
*/
|
||||||
|
public function getOwner()
|
||||||
|
{
|
||||||
|
return $this->owner;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the number of users who have subscribed to this pane if (public)
|
||||||
|
*
|
||||||
|
* @param int $acceptance
|
||||||
|
*/
|
||||||
|
public function setAcceptance($acceptance)
|
||||||
|
{
|
||||||
|
$this->acceptance = $acceptance;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the number of users who have subscribed to this pane if (public)
|
||||||
|
*
|
||||||
|
* @return int
|
||||||
|
*/
|
||||||
|
public function getAcceptance()
|
||||||
|
{
|
||||||
|
return $this->acceptance;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the dashboard home this pane is a part of
|
||||||
|
*
|
||||||
|
* This may return null if it wasn't set before (should never happen for DB dashboards)
|
||||||
|
*
|
||||||
|
* @return ?DashboardHome
|
||||||
|
*/
|
||||||
|
public function getHome()
|
||||||
|
{
|
||||||
|
return $this->home;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set the dashboard home this pane is a part of
|
||||||
|
*
|
||||||
|
* @param DashboardHome $home
|
||||||
|
*/
|
||||||
|
public function setHome(DashboardHome $home)
|
||||||
|
{
|
||||||
|
$this->home = $home;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return true if a dashlet with the given title exists in this pane
|
||||||
|
*
|
||||||
|
* @param string $title The title of the dashlet to check for existence
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function hasDashlet($title)
|
||||||
|
{
|
||||||
|
return array_key_exists($title, $this->dashlets);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks if the current pane has any dashlets
|
||||||
|
*
|
||||||
|
* @return bool
|
||||||
|
*/
|
||||||
|
public function hasDashlets()
|
||||||
|
{
|
||||||
|
return ! empty($this->dashlets);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return a dashlet with the given name if existing
|
||||||
|
*
|
||||||
|
* @param string $title The title of the dashlet to return
|
||||||
|
*
|
||||||
|
* @return Dashlet The dashlet with the given title
|
||||||
|
* @throws ProgrammingError If the dashlet doesn't exist
|
||||||
|
*/
|
||||||
|
public function getDashlet($title)
|
||||||
|
{
|
||||||
|
if ($this->hasDashlet($title)) {
|
||||||
|
return $this->dashlets[$title];
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new ProgrammingError('Trying to access invalid dashlet: %s', $title);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get all dashlets belongs to this pane
|
||||||
|
*
|
||||||
|
* @return Dashlet[]
|
||||||
|
*/
|
||||||
|
public function getDashlets()
|
||||||
|
{
|
||||||
|
uasort($this->dashlets, function (Dashlet $x, Dashlet $y) {
|
||||||
|
return $x->getPriority() - $y->getPriority();
|
||||||
|
});
|
||||||
|
|
||||||
|
return $this->dashlets;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Set dashlets of this pane
|
||||||
|
*
|
||||||
|
* @param Dashlet[] $dashlets
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function setDashlets(array $dashlets)
|
||||||
|
{
|
||||||
|
$this->dashlets = $dashlets;
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create, add and return a new dashlet
|
||||||
|
*
|
||||||
|
* @param string $title
|
||||||
|
* @param string $url
|
||||||
|
*
|
||||||
|
* @return Dashlet
|
||||||
|
*/
|
||||||
|
public function createDashlet($title, $url = null)
|
||||||
|
{
|
||||||
|
$dashlet = new Dashlet($title, $url, $this);
|
||||||
|
$this->addDashlet($dashlet);
|
||||||
|
|
||||||
|
return $dashlet;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add a dashlet to this pane, optionally creating it if $dashlet is a string
|
||||||
|
*
|
||||||
|
* @param string|Dashlet $dashlet
|
||||||
|
* @param ?string $url
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
* @throws \Icinga\Exception\ConfigurationError
|
||||||
|
*/
|
||||||
|
public function addDashlet($dashlet, $url = null)
|
||||||
|
{
|
||||||
|
if ($dashlet instanceof Dashlet) {
|
||||||
|
$this->dashlets[$dashlet->getName()] = $dashlet;
|
||||||
|
} elseif (is_string($dashlet) && $url !== null) {
|
||||||
|
$this->createDashlet($dashlet, $url);
|
||||||
|
} else {
|
||||||
|
throw new ConfigurationError('Invalid dashlet added: %s', $dashlet);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add new dashlets to existing dashlets
|
||||||
|
*
|
||||||
|
* @param array $dashlets
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function addDashlets(array $dashlets)
|
||||||
|
{
|
||||||
|
/* @var $dashlet Dashlet */
|
||||||
|
foreach ($dashlets as $dashlet) {
|
||||||
|
if (array_key_exists($dashlet->getName(), $this->dashlets)) {
|
||||||
|
if (preg_match('/_(\d+)$/', $dashlet->getName(), $m)) {
|
||||||
|
$name = preg_replace('/_\d+$/', $m[1]++, $dashlet->getName());
|
||||||
|
} else {
|
||||||
|
$name = $dashlet->getName() . '_2';
|
||||||
|
}
|
||||||
|
$this->dashlets[$name] = $dashlet;
|
||||||
|
} else {
|
||||||
|
$this->dashlets[$dashlet->getName()] = $dashlet;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add a dashlet to the current pane @see addDashlet()
|
||||||
|
*
|
||||||
|
* @param string $title
|
||||||
|
* @param Url|string $url
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function add($title, $url, $priority = 0)
|
||||||
|
{
|
||||||
|
$dashlet = $this->createDashlet($title, $url);
|
||||||
|
$dashlet->setPriority($priority);
|
||||||
|
$this->addDashlet($dashlet);
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove the dashlet the given dashlet if it exists in this pane
|
||||||
|
*
|
||||||
|
* @param Dashlet|string $dashlet
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function removeDashlet($dashlet)
|
||||||
|
{
|
||||||
|
$name = $dashlet instanceof Dashlet ? $dashlet->getName() : $dashlet;
|
||||||
|
if (! $this->hasDashlet($name)) {
|
||||||
|
throw new ProgrammingError('Trying to remove invalid dashlet: %s', $name);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (! $dashlet instanceof Dashlet) {
|
||||||
|
$dashlet = $this->getDashlet($dashlet);
|
||||||
|
}
|
||||||
|
|
||||||
|
Dashboard::getConn()->delete(Dashlet::TABLE, [
|
||||||
|
'id = ?' => $dashlet->getUuid(),
|
||||||
|
'dashboard_id = ?' => $this->getUuid()
|
||||||
|
]);
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes all or a given list of dashlets from this pane
|
||||||
|
*
|
||||||
|
* @param array $dashlets Optional list of dashlets
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function removeDashlets(array $dashlets = [])
|
||||||
|
{
|
||||||
|
if (empty($dashlets)) {
|
||||||
|
$dashlets = $this->getDashlets();
|
||||||
|
}
|
||||||
|
|
||||||
|
foreach ($dashlets as $dashlet) {
|
||||||
|
$this->removeDashlet($dashlet);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Load all dashlets this dashboard is assigned to
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function loadDashletsFromDB()
|
||||||
|
{
|
||||||
|
if ($this->isDisabled()) {
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->dashlets = [];
|
||||||
|
$dashlets = Model\Dashlet::on(Dashboard::getConn());
|
||||||
|
$dashlets->filter(Filter::equal('dashboard_id', $this->getUuid()));
|
||||||
|
|
||||||
|
foreach ($dashlets as $dashlet) {
|
||||||
|
$newDashlet = new Dashlet($dashlet->name, $dashlet->url, $this);
|
||||||
|
$newDashlet->fromArray([
|
||||||
|
'uuid' => $dashlet->id,
|
||||||
|
'title' => t($dashlet->label),
|
||||||
|
'priority' => $dashlet->priority,
|
||||||
|
'pane' => $this
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->addDashlet($newDashlet);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Manage the given dashlet(s)
|
||||||
|
*
|
||||||
|
* If you want to move the dashlet(s) from another to this pane,
|
||||||
|
* you have to also pass the origin pane
|
||||||
|
*
|
||||||
|
* @param Dashlet|Dashlet[] $dashlets
|
||||||
|
* @param ?Pane $origin
|
||||||
|
*
|
||||||
|
* @return $this
|
||||||
|
*/
|
||||||
|
public function manageDashlets($dashlets, Pane $origin = null)
|
||||||
|
{
|
||||||
|
$user = Dashboard::getUser();
|
||||||
|
$conn = Dashboard::getConn();
|
||||||
|
|
||||||
|
$dashlets = is_array($dashlets) ? $dashlets : [$dashlets];
|
||||||
|
$order = count($this->getDashlets()) + 1;
|
||||||
|
|
||||||
|
foreach ($dashlets as $dashlet) {
|
||||||
|
if (is_array($dashlet)) {
|
||||||
|
$this->manageDashlets($dashlet, $origin);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (! $dashlet instanceof Dashlet) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
$uuid = $dashlet->isModuleDashlet()
|
||||||
|
? Dashboard::getSHA1($dashlet->getModule() . $this->getName() . $dashlet->getName())
|
||||||
|
: Dashboard::getSHA1(
|
||||||
|
$user->getUsername() . $this->getHome()->getName() . $this->getName() . $dashlet->getName()
|
||||||
|
);
|
||||||
|
|
||||||
|
if (! $this->hasDashlet($dashlet->getName()) && (! $origin || ! $origin->hasDashlet($dashlet->getName()))) {
|
||||||
|
$conn->insert(Dashlet::TABLE, [
|
||||||
|
'id' => $uuid,
|
||||||
|
'dashboard_id' => $this->getUuid(),
|
||||||
|
'name' => $dashlet->getName(),
|
||||||
|
'label' => $dashlet->getTitle(),
|
||||||
|
'url' => $dashlet->getUrl()->getRelativeUrl(),
|
||||||
|
'priority' => $order++
|
||||||
|
]);
|
||||||
|
|
||||||
|
$dashlet->setUuid($uuid);
|
||||||
|
} else {
|
||||||
|
$conn->update(Dashlet::TABLE, [
|
||||||
|
'id' => $uuid,
|
||||||
|
'dashboard_id' => $this->getUuid(),
|
||||||
|
'label' => $dashlet->getTitle(),
|
||||||
|
'url' => $dashlet->getUrl()->getRelativeUrl(),
|
||||||
|
'priority' => $this->getPriority()
|
||||||
|
], ['id = ?' => $dashlet->getUuid()]);
|
||||||
|
}
|
||||||
|
|
||||||
|
$dashlet->setPane($this);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $this;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function toArray()
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'id' => $this->getUuid(),
|
||||||
|
'name' => $this->getName(),
|
||||||
|
'label' => $this->getTitle(),
|
||||||
|
'home' => $this->getHome() ? $this->getHome()->getName() : null,
|
||||||
|
'priority' => $this->getPriority(),
|
||||||
|
'disabled' => (int) $this->isDisabled()
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user