Adding upstream version 2.12.1.upstream/2.12.1upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

3 files changed, 686 insertions, 0 deletions

diff --git a/library/Icinga/Web/Widget/Dashboard/Dashlet.php b/library/Icinga/Web/Widget/Dashboard/Dashlet.php
new file mode 100644
index 0000000..2ba26df
--- /dev/null
+++ b/library/Icinga/Web/Widget/Dashboard/Dashlet.php
@@ -0,0 +1,315 @@
+<?php
+/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Web\Widget\Dashboard;
+
+use Icinga\Web\Url;
+use Icinga\Data\ConfigObject;
+use Icinga\Exception\IcingaException;
+
+/**
+ * A dashboard pane dashlet
+ *
+ * This is the element displaying a specific view in icinga2web
+ *
+ */
+class Dashlet extends UserWidget
+{
+    /**
+     * The url of this Dashlet
+     *
+     * @var Url|null
+     */
+    private $url;
+
+    private $name;
+
+    /**
+     * The title being displayed on top of the dashlet
+     * @var
+     */
+    private $title;
+
+    /**
+     * The pane containing this dashlet, needed for the 'remove button'
+     * @var Pane
+     */
+    private $pane;
+
+    /**
+     * The disabled option is used to "delete" default dashlets provided by modules
+     *
+     * @var bool
+     */
+    private $disabled = false;
+
+    /**
+     * The progress label being used
+     *
+     * @var string
+     */
+    private $progressLabel;
+
+    /**
+     * The template string used for rendering this widget
+     *
+     * @var string
+     */
+    private $template =<<<'EOD'
+
+    <div class="container" data-icinga-url="{URL}">
+        <h1><a href="{FULL_URL}" aria-label="{TOOLTIP}" title="{TOOLTIP}" data-base-target="col1">{TITLE}</a></h1>
+        <p class="progress-label">{PROGRESS_LABEL}<span>.</span><span>.</span><span>.</span></p>
+        <noscript>
+            <div class="iframe-container">
+                <iframe
+                    src="{IFRAME_URL}"
+                    frameborder="no"
+                    title="{TITLE_PREFIX}{TITLE}">
+                </iframe>
+            </div>
+        </noscript>
+    </div>
+EOD;
+
+    /**
+     * The template string used for rendering this widget in case of an error
+     *
+     * @var string
+     */
+    private $errorTemplate = <<<'EOD'
+
+    <div class="container">
+        <h1 title="{TOOLTIP}">{TITLE}</h1>
+        <p class="error-message">{ERROR_MESSAGE}</p>
+    </div>
+EOD;
+
+    /**
+     * Create a new dashlet displaying the given url in the provided pane
+     *
+     * @param string $title     The title to use for this dashlet
+     * @param Url|string $url   The url this dashlet uses for displaying information
+     * @param Pane $pane        The pane this Dashlet will be added to
+     */
+    public function __construct($title, $url, Pane $pane)
+    {
+        $this->name = $title;
+        $this->title = $title;
+        $this->pane = $pane;
+        $this->url = $url;
+    }
+
+    public function setName($name)
+    {
+        $this->name = $name;
+        return $this;
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * Retrieve the dashlets title
+     *
+     * @return string
+     */
+    public function getTitle()
+    {
+        return $this->title;
+    }
+
+    /**
+     * @param string $title
+     */
+    public function setTitle($title)
+    {
+        $this->title = $title;
+    }
+
+    /**
+     * Retrieve the dashlets url
+     *
+     * @return Url|null
+     */
+    public function getUrl()
+    {
+        if ($this->url !== null && ! $this->url instanceof Url) {
+            $this->url = Url::fromPath($this->url);
+        }
+        return $this->url;
+    }
+
+    /**
+     * Set the dashlets URL
+     *
+     * @param  string|Url $url  The url to use, either as an Url object or as a path
+     *
+     * @return $this
+     */
+    public function setUrl($url)
+    {
+        $this->url = $url;
+        return $this;
+    }
+
+    /**
+     * Set the disabled property
+     *
+     * @param boolean $disabled
+     */
+    public function setDisabled($disabled)
+    {
+        $this->disabled = $disabled;
+    }
+
+    /**
+     * Get the disabled property
+     *
+     * @return boolean
+     */
+    public function getDisabled()
+    {
+        return $this->disabled;
+    }
+
+    /**
+     * Set the progress label to use
+     *
+     * @param   string  $label
+     *
+     * @return  $this
+     */
+    public function setProgressLabel($label)
+    {
+        $this->progressLabel = $label;
+        return $this;
+    }
+
+    /**
+     * Return the progress label to use
+     *
+     * @return  string
+     */
+    public function getProgressLabe()
+    {
+        if ($this->progressLabel === null) {
+            return $this->view()->translate('Loading');
+        }
+
+        return $this->progressLabel;
+    }
+
+    /**
+     * Return this dashlet's structure as array
+     *
+     * @return  array
+     */
+    public function toArray()
+    {
+        $array = array(
+            'url'   => $this->getUrl()->getRelativeUrl(),
+            'title' => $this->getTitle()
+        );
+        if ($this->getDisabled() === true) {
+            $array['disabled'] = 1;
+        }
+        return $array;
+    }
+
+    /**
+     * @see Widget::render()
+     */
+    public function render()
+    {
+        if ($this->disabled === true) {
+            return '';
+        }
+
+        $view = $this->view();
+
+        if (! $this->url) {
+            $searchTokens = array(
+                '{TOOLTIP}',
+                '{TITLE}',
+                '{ERROR_MESSAGE}'
+            );
+
+            $replaceTokens = array(
+                sprintf($view->translate('Show %s', 'dashboard.dashlet.tooltip'), $view->escape($this->getTitle())),
+                $view->escape($this->getTitle()),
+                $view->escape(
+                    sprintf($view->translate('Cannot create dashboard dashlet "%s" without valid URL'), $this->title)
+                )
+            );
+
+            return str_replace($searchTokens, $replaceTokens, $this->errorTemplate);
+        }
+
+        $url = $this->getUrl();
+        $url->setParam('showCompact', true);
+        $iframeUrl = clone $url;
+        $iframeUrl->setParam('isIframe');
+
+        $searchTokens = array(
+            '{URL}',
+            '{IFRAME_URL}',
+            '{FULL_URL}',
+            '{TOOLTIP}',
+            '{TITLE}',
+            '{TITLE_PREFIX}',
+            '{PROGRESS_LABEL}'
+        );
+
+        $replaceTokens = array(
+            $url,
+            $iframeUrl,
+            $url->getUrlWithout(['showCompact', 'limit', 'view']),
+            sprintf($view->translate('Show %s', 'dashboard.dashlet.tooltip'), $view->escape($this->getTitle())),
+            $view->escape($this->getTitle()),
+            $view->translate('Dashlet') . ': ',
+            $this->getProgressLabe()
+        );
+
+        return str_replace($searchTokens, $replaceTokens, $this->template);
+    }
+
+    /**
+     * Create a @see Dashlet instance from the given Zend config, using the provided title
+     *
+     * @param $title                The title for this dashlet
+     * @param ConfigObject $config  The configuration defining url, parameters, height, width, etc.
+     * @param Pane $pane            The pane this dashlet belongs to
+     *
+     * @return Dashlet        A newly created Dashlet for use in the Dashboard
+     */
+    public static function fromIni($title, ConfigObject $config, Pane $pane)
+    {
+        $height = null;
+        $width = null;
+        $url = $config->get('url');
+        $parameters = $config->toArray();
+        unset($parameters['url']); // otherwise there's an url = parameter in the Url
+
+        $cmp = new Dashlet($title, Url::fromPath($url, $parameters), $pane);
+        return $cmp;
+    }
+
+    /**
+     * @param \Icinga\Web\Widget\Dashboard\Pane $pane
+     */
+    public function setPane(Pane $pane)
+    {
+        $this->pane = $pane;
+    }
+
+    /**
+     * @return \Icinga\Web\Widget\Dashboard\Pane
+     */
+    public function getPane()
+    {
+        return $this->pane;
+    }
+}
diff --git a/library/Icinga/Web/Widget/Dashboard/Pane.php b/library/Icinga/Web/Widget/Dashboard/Pane.php
new file mode 100644
index 0000000..c8b14c5
--- /dev/null
+++ b/library/Icinga/Web/Widget/Dashboard/Pane.php
@@ -0,0 +1,335 @@
+<?php
+/* Icinga Web 2 | (c) 2013 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Web\Widget\Dashboard;
+
+use Icinga\Data\ConfigObject;
+use Icinga\Web\Widget\AbstractWidget;
+use Icinga\Exception\ProgrammingError;
+use Icinga\Exception\ConfigurationError;
+
+/**
+ * A pane, displaying different Dashboard dashlets
+ */
+class Pane extends UserWidget
+{
+    /**
+     * The name of this pane, as defined in the ini file
+     *
+     * @var string
+     */
+    private $name;
+
+    /**
+     * The title of this pane, as displayed in the dashboard tabs
+     *
+     * @var string
+     */
+    private $title;
+
+    /**
+     * An array of @see Dashlets that are displayed in this pane
+     *
+     * @var array
+     */
+    private $dashlets = array();
+
+    /**
+     * Disabled flag of a pane
+     *
+     * @var bool
+     */
+    private $disabled = false;
+
+    /**
+     * Create a new pane
+     *
+     * @param string $name         The pane to create
+     */
+    public function __construct($name)
+    {
+        $this->name  = $name;
+        $this->title = $name;
+    }
+
+    /**
+     * 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;
+    }
+
+    /**
+     * 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
+        );
+    }
+
+    /**
+     * Removes the dashlet with the given title if it exists in this pane
+     *
+     * @param string $title         The pane
+     * @return Pane $this
+     */
+    public function removeDashlet($title)
+    {
+        if ($this->hasDashlet($title)) {
+            $dashlet = $this->getDashlet($title);
+            if ($dashlet->isUserWidget() === true) {
+                unset($this->dashlets[$title]);
+            } else {
+                $dashlet->setDisabled(true);
+                $dashlet->setUserWidget();
+            }
+        } else {
+            throw new ProgrammingError('Dashlet does not exist: ' . $title);
+        }
+        return $this;
+    }
+
+    /**
+     * Removes all or a given list of dashlets from this pane
+     *
+     * @param array $dashlets Optional list of dashlet titles
+     * @return Pane $this
+     */
+    public function removeDashlets(array $dashlets = null)
+    {
+        if ($dashlets === null) {
+            $this->dashlets = array();
+        } else {
+            foreach ($dashlets as $dashlet) {
+                $this->removeDashlet($dashlet);
+            }
+        }
+        return $this;
+    }
+
+    /**
+     * Return all dashlets added at this pane
+     *
+     * @return array
+     */
+    public function getDashlets()
+    {
+        return $this->dashlets;
+    }
+
+    /**
+     * @see Widget::render
+     */
+    public function render()
+    {
+        $dashlets = array_filter(
+            $this->dashlets,
+            function ($e) {
+                return ! $e->getDisabled();
+            }
+        );
+        return implode("\n", $dashlets) . "\n";
+    }
+
+    /**
+     * 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               The dashlet object or title
+     *                                                  (if a new dashlet will be created)
+     * @param string|null $url                          An Url to be used when dashlet is a string
+     *
+     * @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
+     *
+     * @param $title
+     * @param $url
+     * @return Dashlet
+     *
+     * @see addDashlet()
+     */
+    public function add($title, $url = null)
+    {
+        $this->addDashlet($title, $url);
+
+        return $this->dashlets[$title];
+    }
+
+    /**
+     * Return the this pane's structure as array
+     *
+     * @return  array
+     */
+    public function toArray()
+    {
+        $pane =  array(
+            'title'     => $this->getTitle(),
+        );
+
+        if ($this->getDisabled() === true) {
+            $pane['disabled'] = 1;
+        }
+
+        return $pane;
+    }
+
+    /**
+     * Create a new pane with the title $title from the given configuration
+     *
+     * @param $title                The title for this pane
+     * @param ConfigObject  $config The configuration to use for setup
+     *
+     * @return Pane
+     */
+    public static function fromIni($title, ConfigObject $config)
+    {
+        $pane = new Pane($title);
+        if ($config->get('title', false)) {
+            $pane->setTitle($config->get('title'));
+        }
+        return $pane;
+    }
+
+    /**
+     * Setter for disabled
+     *
+     * @param boolean $disabled
+     */
+    public function setDisabled($disabled = true)
+    {
+        $this->disabled = (bool) $disabled;
+    }
+
+    /**
+     * Getter for disabled
+     *
+     * @return boolean
+     */
+    public function getDisabled()
+    {
+        return $this->disabled;
+    }
+}
diff --git a/library/Icinga/Web/Widget/Dashboard/UserWidget.php b/library/Icinga/Web/Widget/Dashboard/UserWidget.php
new file mode 100644
index 0000000..164d58b
--- /dev/null
+++ b/library/Icinga/Web/Widget/Dashboard/UserWidget.php
@@ -0,0 +1,36 @@
+<?php
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Web\Widget\Dashboard;
+
+use Icinga\Web\Widget\AbstractWidget;
+
+abstract class UserWidget extends AbstractWidget
+{
+    /**
+     * Flag if widget is created by an user
+     *
+     * @var bool
+     */
+    protected $userWidget = false;
+
+    /**
+     * Set the user widget flag
+     *
+     * @param boolean $userWidget
+     */
+    public function setUserWidget($userWidget = true)
+    {
+        $this->userWidget = (bool) $userWidget;
+    }
+
+    /**
+     * Getter for user widget flag
+     *
+     * @return boolean
+     */
+    public function isUserWidget()
+    {
+        return $this->userWidget;
+    }
+}