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

<?php

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

namespace Icinga\Web\Dashboard;

use Icinga\Web\Dashboard\Common\DashboardEntries;
use Icinga\Web\Dashboard\Common\DashboardEntry;
use Icinga\Web\Dashboard\Common\DashboardManager;
use ipl\Html\BaseHtmlElement;
use ipl\Html\HtmlElement;
use ipl\Web\Url;
use ipl\Web\Widget\Tabs;

/**
 * Dashboards display multiple views on a single page
 *
 * The terminology is as follows:
 * - Dashlet:           A single view showing a specific url
 * - Pane:              Aggregates one or more dashlets on one page, displays its title as a tab
 * - Dashboard/Home:    Shows all panes belonging to this home
 *
 */
class Dashboard extends BaseHtmlElement implements DashboardEntry
{
    use DashboardManager;
    use DashboardEntries;

    /**
     * Base path of our new dashboards controller
     *
     * @var string
     */
    public const BASE_ROUTE = 'dashboards';

    /**
     * System dashboards are provided by the modules in PHP code and are available to all users
     *
     * @var string
     */
    public const SYSTEM = 'system';

    /**
     * Public dashboards are created by authorized users and are available
     * to specific users, groups, roles or everybody
     *
     * @var string
     */
    public const PUBLIC_DS = 'public';

    /**
     * Private dashboards are created by any user and are only available to this user
     *
     * @var string
     */
    public const PRIVATE_DS = 'private';

    /**
     * Shared dashboards are available to users who have accepted a share or who
     * have been assigned the dashboard by their Admin
     *
     * @var string
     */
    public const SHARED = 'shared';

    protected $tag = 'div';

    protected $defaultAttributes = ['class' => 'dashboard'];

    /**
     * The @see Tabs object for displaying displayable panes
     *
     * @var Tabs
     */
    protected $tabs;

    /**
     * The parameter that will be added to identify panes
     *
     * @var string
     */
    private $tabParam = 'pane';

    /**
     * Set the given tab name as active
     *
     * @param string $name The tab name to activate
     *
     */
    public function activate(string $name)
    {
        $this->getTabs()->activate($name);
    }

    /**
     * Set this dashboard's tabs
     *
     * @param Tabs $tabs
     *
     * @return $this
     */
    public function setTabs(Tabs $tabs)
    {
        $this->tabs = $tabs;

        return $this;
    }

    /**
     * Return the tab object used to navigate through this dashboard
     *
     * @return Tabs
     */
    public function getTabs()
    {
        $activeHome = $this->getActiveEntry();
        if ($activeHome && ! $activeHome->isDefaultHome()) {
            $url = Url::fromPath(self::BASE_ROUTE . '/home')->getUrlWithout(['home', $this->tabParam]);
            $url->addParams(['home' => $activeHome->getName()]);
        } else {
            $url = Url::fromPath(self::BASE_ROUTE)->getUrlWithout($this->tabParam);
        }

        if ($this->tabs === null) {
            $this->tabs = new Tabs();
        }

        $this->tabs->disableLegacyExtensions();
        if (! $activeHome) {
            return $this->tabs;
        }

        /** @var Pane $pane */
        foreach ($activeHome->getEntries() as $pane) {
            if (! $this->tabs->get($pane->getName())) {
                $this->tabs->add(
                    $pane->getName(),
                    [
                        'active'    => $pane->isActive(),
                        'title'     => sprintf(t('Show %s', 'dashboard.pane.tooltip'), $pane->getTitle()),
                        'label'     => $pane->getTitle(),
                        'url'       => clone $url,
                        'urlParams' => [$this->tabParam => $pane->getName()]
                    ]
                );
            }
        }

        return $this->tabs;
    }

    protected function assemble()
    {
        $activeHome = $this->getActiveEntry();
        if (! $activeHome || (! $activeHome->hasEntries() && $activeHome->isDefaultHome())) {
            $this->setAttribute('class', 'dashboard-introduction');

            $this->addHtml(HtmlElement::create('h2', null, t('Welcome to Icinga Web 2!')));
            $this->addHtml(HtmlElement::create(
                'p',
                null,
                t('You will see this screen every time you log in.')
            ));

            $message = t(
                'At the moment this view is empty, but you can populate it with small portions of'
                . ' information called Dashlets.'
            );
            $this->addHtml(HtmlElement::create('p', null, $message));

            $message = t(
                'Now you can either customize which dashlets to display, or use the system default dashlets.'
                . ' You will always be able to edit them afterwards.'
            );
            $this->addHtml(HtmlElement::create('p', null, $message));
        } elseif ($activeHome->hasEntries()) {
            $activePane = $activeHome->getActiveEntry();

            if (! $activePane->hasEntries()) {
                $this->addHtml(HtmlElement::create('h1', null, t('No dashlet added to this pane.')));
            } else {
                foreach ($activePane->getEntries() as $dashlet) {
                    $this->addHtml($dashlet->getHtml());
                }
            }
        } else {
            $this->addHtml(HtmlElement::create('h1', null, t('No dashboard added to this dashboard home.')));
        }
    }
}