icingaweb2/library/Icinga/Web/Dashboard/Pane.php

<?php

/* Icinga Web 2 | (c) 2022 Icinga GmbH | GPLv2+ */

namespace Icinga\Web\Dashboard;

use Icinga\Application\Modules;
use Icinga\Exception\AlreadyExistsException;
use Icinga\Web\Dashboard\Common\BaseDashboard;
use Icinga\Exception\ProgrammingError;
use Icinga\Exception\ConfigurationError;
use Icinga\Model;
use Icinga\Web\Dashboard\Common\DashboardEntries;
use Icinga\Util\DBUtils;
use Icinga\Web\Dashboard\Common\DashboardEntry;
use Icinga\Web\Dashboard\Common\Sortable;
use InvalidArgumentException;
use ipl\Stdlib\Filter;
use LogicException;

use function ipl\Stdlib\get_php_type;

/**
 * A Pane or Dashboard Pane organizes various Dashlets/Views into a single panel
 * and can be accessed via the tabs rendered on the upper navigation bar of Icinga Web 2.
 */
class Pane extends BaseDashboard implements DashboardEntry, Sortable
{
    use DashboardEntries;

    public const TABLE = 'icingaweb_dashboard';

    /**
     * A dashboard home this pane is a part of
     *
     * @var DashboardHome
     */
    protected $home;

    /**
     * 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(): ?DashboardHome
    {
        return $this->home;
    }

    /**
     * Set the dashboard home this pane is a part of
     *
     * @param DashboardHome $home
     *
     * @return $this
     */
    public function setHome(DashboardHome $home): self
    {
        $this->home = $home;

        return $this;
    }

    public function createEntry(string $name, $url = null)
    {
        if ($url === null) {
            throw new ConfigurationError('Can\'t create a dashlet "%s" without a valid url', $name);
        }

        $dashlet = new Dashlet($name, $url, $this);
        $this->addEntry($dashlet);

        return $this;
    }

    public function removeEntry($dashlet)
    {
        $name = $dashlet instanceof Dashlet ? $dashlet->getName() : $dashlet;
        if (! $this->hasEntry($name)) {
            throw new ProgrammingError('Trying to remove invalid dashlet: %s', $name);
        }

        if (! $dashlet instanceof Dashlet) {
            $dashlet = $this->getEntry($dashlet);
        }

        DBUtils::getConn()->delete(Dashlet::TABLE, [
            'id = ?'           => $dashlet->getUuid(),
            'dashboard_id = ?' => $this->getUuid()
        ]);

        $this->unsetEntry($dashlet);

        return $this;
    }

    public function loadDashboardEntries(string $name = null)
    {
        $dashlets = Model\Dashlet::on(DBUtils::getConn())
            ->utilize(self::TABLE)
            ->with('icingaweb_module_dashlet');

        $dashlets->filter(Filter::equal('dashboard_id', $this->getUuid()));

        // TODO(yh): Qualify those columns properly??
        $dashlets->getSelectBase()->columns([
            'system_dashlet_id'        => 'icingaweb_dashlet_icingaweb_system_dashlet.dashlet_id',
            'system_module_dashlet_id' => 'icingaweb_dashlet_icingaweb_system_dashlet.module_dashlet_id',
        ]);

        $this->setEntries([]);
        foreach ($dashlets as $dashlet) {
            $newDashlet = new Dashlet($dashlet->name, $dashlet->url, $this);
            $newDashlet
                ->setPane($this)
                ->setUuid($dashlet->id)
                ->setTitle($dashlet->label)
                ->setPriority($dashlet->priority)
                ->setDisabled($dashlet->disabled)
                ->setModule($dashlet->icingaweb_module_dashlet->module ?? '')
                ->setModuleDashlet($dashlet->system_dashlet_id !== null)
                ->setDescription($dashlet->description);

            $this->addEntry($newDashlet);

            if (Modules\DashletManager::isOrphaned($newDashlet)
                || (
                    $newDashlet->isModuleDashlet()
                    && $dashlet->system_module_dashlet_id === null
                )
            ) { // The module from which this dashlet originates doesn't exist anymore
                $this->removeEntry($newDashlet);
            } elseif (! $newDashlet->isDisabled() && ! Modules\DashletManager::isUsable($newDashlet)) {
                // The module from which this dashlet originates is probably disabled,
                // so don't load this dashlet anymore and disable it
                $newDashlet->setDisabled(true);

                $this->manageEntry($newDashlet);
            } elseif ($newDashlet->isDisabled() && Modules\DashletManager::isUsable($newDashlet)) {
                // Dashlet was disabled, but it can be used now, so enabled it again
                $newDashlet->setDisabled(false);

                $this->manageEntry($newDashlet);
            }

            if ($newDashlet->isDisabled()) {
                $this->unsetEntry($newDashlet);
            }
        }

        return $this;
    }

    public function manageEntry($entryOrEntries, BaseDashboard $origin = null, bool $manageRecursive = false)
    {
        if ($origin && ! $origin instanceof Pane) {
            throw new InvalidArgumentException(sprintf(
                __METHOD__ . ' expects parameter "$origin" to be an instance of "%s". Got "%s" instead.',
                get_php_type($this),
                get_php_type($origin)
            ));
        }

        if (! $this->getHome()) {
            throw new LogicException(
                'Dashlet(s) cannot be managed without a valid Dashboard Home. Please make sure to set' .
                ' the current dashboard home beforehand.'
            );
        }

        $home = $this->getHome();
        $user = Dashboard::getUser()->getUsername();
        $conn = DBUtils::getConn();

        $dashlets = is_array($entryOrEntries) ? $entryOrEntries : [$entryOrEntries];
        // Highest priority is 0, so count($entries) are always lowest prio + 1
        $order = $this->countEntries();

        /** @var Dashlet $dashlet */
        foreach ($dashlets as $dashlet) {
            if (is_array($dashlet)) {
                $this->manageEntry($dashlet, $origin, $manageRecursive);
                continue;
            }

            $url = $dashlet->getUrl();
            $url = is_string($url ?? '') ?: $url->getRelativeUrl();
            $uuid = Dashboard::getSHA1($user . $home->getName() . $this->getName() . $dashlet->getName());
            $moveDashlet = $origin && $origin->hasEntry($dashlet->getName()) && $this->getHome() !== $origin->getName();

            if (! $this->hasEntry($dashlet->getName()) && ! $moveDashlet) {
                $conn->insert(Dashlet::TABLE, [
                    'id'           => $uuid,
                    'dashboard_id' => $this->getUuid(),
                    'name'         => $dashlet->getName(),
                    'label'        => $dashlet->getTitle(),
                    'url'          => $url,
                    'priority'     => $order++,
                    'disabled'     => DBUtils::bool2BoolEnum($dashlet->isDisabled()),
                    'description'  => $dashlet->getDescription()
                ]);

                if ($dashlet->isModuleDashlet()) {
                    $systemUuid = $dashlet->getUuid();
                    if (! $systemUuid) {
                        $data = $dashlet->getModule();
                        if (($pane = $dashlet->getPane())) {
                            $data .= $pane->getName();
                        }

                        $systemUuid = Dashboard::getSHA1($data . $dashlet->getName());
                    }

                    $conn->insert('icingaweb_system_dashlet', [
                        'dashlet_id'        => $uuid,
                        'module_dashlet_id' => $systemUuid
                    ]);
                }

                $this->addEntry($dashlet);
            } elseif (! $this->hasEntry($dashlet->getName()) || ! $moveDashlet) {
                $filterCondition = [
                    'id = ?'           => $dashlet->getUuid(),
                    'dashboard_id = ?' => $this->getUuid()
                ];

                if ($origin && $origin->hasEntry($dashlet->getName())) {
                    $filterCondition = [
                        'id = ?'           => $origin->getEntry($dashlet->getName())->getUuid(),
                        'dashboard_id = ?' => $origin->getUuid()
                    ];

                    $this->addEntry($dashlet);
                }

                $conn->update(Dashlet::TABLE, [
                    'id'           => $uuid,
                    'dashboard_id' => $this->getUuid(),
                    'label'        => $dashlet->getTitle(),
                    'url'          => $url,
                    'priority'     => $moveDashlet ? $order++ : $dashlet->getPriority(),
                    'disabled'     => DBUtils::bool2BoolEnum($dashlet->isDisabled()),
                    'description'  => $dashlet->getDescription()
                ], $filterCondition);
            } else {
                // Failed to move the dashlet! Should have already been handled by the caller,
                // though I think it's better that we raise an exception here!!
                throw new AlreadyExistsException(
                    'Failed to successfully manage the Dashlet. Pane "%s" has already a Dashlet called "%s"!',
                    $this->getTitle(),
                    $dashlet->getTitle()
                );
            }

            $dashlet->setPane($this);
        }

        return $this;
    }

    public function toArray(bool $stringify = true): array
    {
        $arr = parent::toArray($stringify);
        $home = $this->getHome();
        $arr['home'] = ! $stringify ? $home : ($home ? $home->getName() : null);

        return $arr;
    }
}