Adding upstream version 1.10.2.upstream/1.10.2

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

1 files changed, 641 insertions, 0 deletions

diff --git a/library/Director/Web/Form/QuickForm.php b/library/Director/Web/Form/QuickForm.php
new file mode 100644
index 0000000..91c8f00
--- /dev/null
+++ b/library/Director/Web/Form/QuickForm.php
@@ -0,0 +1,641 @@
+<?php
+
+namespace Icinga\Module\Director\Web\Form;
+
+use Icinga\Application\Icinga;
+use Icinga\Web\Notification;
+use Icinga\Web\Request;
+use Icinga\Web\Response;
+use Icinga\Web\Url;
+use InvalidArgumentException;
+use Exception;
+use RuntimeException;
+
+/**
+ * QuickForm wants to be a base class for simple forms
+ */
+abstract class QuickForm extends QuickBaseForm
+{
+    const ID = '__FORM_NAME';
+
+    const CSRF = '__FORM_CSRF';
+
+    /**
+     * The name of this form
+     */
+    protected $formName;
+
+    /**
+     * Whether the form has been sent
+     */
+    protected $hasBeenSent;
+
+    /**
+     * Whether the form has been sent
+     */
+    protected $hasBeenSubmitted;
+
+    /**
+     * The submit caption, element - still tbd
+     */
+    // protected $submit;
+
+    /**
+     * Our request
+     */
+    protected $request;
+
+    protected $successUrl;
+
+    protected $successMessage;
+
+    protected $submitLabel;
+
+    protected $submitButtonName;
+
+    protected $deleteButtonName;
+
+    protected $fakeSubmitButtonName;
+
+    /**
+     * Whether form elements have already been created
+     */
+    protected $didSetup = false;
+
+    protected $isApiRequest = false;
+
+    protected $successCallbacks = [];
+
+    protected $calledSuccessCallbacks = false;
+
+    protected $onRequestCallbacks = [];
+
+    protected $calledOnRequestCallbacks = false;
+
+    public function __construct($options = null)
+    {
+        parent::__construct($options);
+
+        $this->setMethod('post');
+        $this->getActionFromRequest()
+            ->createIdElement()
+            ->regenerateCsrfToken()
+            ->setPreferredDecorators();
+    }
+
+    protected function getActionFromRequest()
+    {
+        $this->setAction(Url::fromRequest());
+        return $this;
+    }
+
+    protected function setPreferredDecorators()
+    {
+        $current = $this->getAttrib('class');
+        $current .= ' director-form';
+        if ($current) {
+            $this->setAttrib('class', "$current autofocus");
+        } else {
+            $this->setAttrib('class', 'autofocus');
+        }
+        $this->setDecorators(
+            array(
+                'Description',
+                array('FormErrors', array('onlyCustomFormErrors' => true)),
+                'FormElements',
+                'Form'
+            )
+        );
+
+        return $this;
+    }
+
+    protected function addSubmitButton($label, $options = [])
+    {
+        $el = $this->createElement('submit', $label, $options)
+            ->setLabel($label)
+            ->setDecorators(array('ViewHelper'));
+        $this->submitButtonName = $el->getName();
+        $this->setSubmitLabel($label);
+        $this->addElement($el);
+    }
+
+    protected function addStandaloneSubmitButton($label, $options = [])
+    {
+        $this->addSubmitButton($label, $options);
+        $this->addDisplayGroup([$this->submitButtonName], 'buttons', array(
+            'decorators' => array(
+                'FormElements',
+                array('HtmlTag', array('tag' => 'p')),
+            ),
+            'order' => 1000,
+        ));
+    }
+
+    protected function addSubmitButtonIfSet()
+    {
+        if (false === ($label = $this->getSubmitLabel())) {
+            return;
+        }
+
+        if ($this->submitButtonName && $el = $this->getElement($this->submitButtonName)) {
+            return;
+        }
+
+        $this->addSubmitButton($label);
+
+        $fakeEl = $this->createElement('submit', '_FAKE_SUBMIT', array(
+            'role' => 'none',
+            'tabindex' => '-1',
+        ))
+            ->setLabel($label)
+            ->setDecorators(array('ViewHelper'));
+        $this->fakeSubmitButtonName = $fakeEl->getName();
+        $this->addElement($fakeEl);
+
+        $this->addDisplayGroup(
+            array($this->fakeSubmitButtonName),
+            'fake_button',
+            array(
+                'decorators' => array('FormElements'),
+                'order' => 1,
+            )
+        );
+
+        $this->addButtonDisplayGroup();
+    }
+
+    protected function addButtonDisplayGroup()
+    {
+        $grp = array(
+            $this->submitButtonName,
+            $this->deleteButtonName
+        );
+        $this->addDisplayGroup($grp, 'buttons', array(
+            'decorators' => array(
+                'FormElements',
+                array('HtmlTag', array('tag' => 'dl')),
+                'DtDdWrapper',
+            ),
+            'order' => 1000,
+        ));
+    }
+
+    protected function addSimpleDisplayGroup($elements, $name, $options)
+    {
+        if (! array_key_exists('decorators', $options)) {
+            $options['decorators'] = array(
+                'FormElements',
+                array('HtmlTag', array('tag' => 'dl')),
+                'Fieldset',
+            );
+        }
+
+        return $this->addDisplayGroup($elements, $name, $options);
+    }
+
+    protected function createIdElement()
+    {
+        if ($this->isApiRequest()) {
+            return $this;
+        }
+        $this->detectName();
+        $this->addHidden(self::ID, $this->getName());
+        $this->getElement(self::ID)->setIgnore(true);
+        return $this;
+    }
+
+    public function getSentValue($name, $default = null)
+    {
+        $request = $this->getRequest();
+        if ($request->isPost() && $this->hasBeenSent()) {
+            return $request->getPost($name);
+        } else {
+            return $default;
+        }
+    }
+
+    public function getSubmitLabel()
+    {
+        if ($this->submitLabel === null) {
+            return $this->translate('Submit');
+        }
+
+        return $this->submitLabel;
+    }
+
+    public function setSubmitLabel($label)
+    {
+        $this->submitLabel = $label;
+        return $this;
+    }
+
+    public function setApiRequest($isApiRequest = true)
+    {
+        $this->isApiRequest = $isApiRequest;
+        return $this;
+    }
+
+    public function isApiRequest()
+    {
+        if ($this->isApiRequest === null) {
+            if ($this->request === null) {
+                throw new RuntimeException(
+                    'Early access to isApiRequest(). This is not possible, sorry'
+                );
+            }
+
+            return $this->getRequest()->isApiRequest();
+        } else {
+            return $this->isApiRequest;
+        }
+    }
+
+    public function regenerateCsrfToken()
+    {
+        if ($this->isApiRequest()) {
+            return $this;
+        }
+        if (! $element = $this->getElement(self::CSRF)) {
+            $this->addHidden(self::CSRF, CsrfToken::generate());
+            $element = $this->getElement(self::CSRF);
+        }
+        $element->setIgnore(true);
+
+        return $this;
+    }
+
+    public function removeCsrfToken()
+    {
+        $this->removeElement(self::CSRF);
+        return $this;
+    }
+
+    public function setSuccessUrl($url, $params = null)
+    {
+        if (! $url instanceof Url) {
+            $url = Url::fromPath($url);
+        }
+        if ($params !== null) {
+            $url->setParams($params);
+        }
+        $this->successUrl = $url;
+        return $this;
+    }
+
+    public function getSuccessUrl()
+    {
+        $url = $this->successUrl ?: $this->getAction();
+        if (! $url instanceof Url) {
+            $url = Url::fromPath($url);
+        }
+
+        return $url;
+    }
+
+    protected function beforeSetup()
+    {
+    }
+
+    public function setup()
+    {
+    }
+
+    protected function onSetup()
+    {
+    }
+
+    public function setAction($action)
+    {
+        if ($action instanceof Url) {
+            $action = $action->getAbsoluteUrl('&');
+        }
+
+        return parent::setAction($action);
+    }
+
+    public function hasBeenSubmitted()
+    {
+        if ($this->hasBeenSubmitted === null) {
+            $req = $this->getRequest();
+            if ($req->isApiRequest()) {
+                return $this->hasBeenSubmitted = true;
+            }
+            if ($req->isPost()) {
+                if (! $this->hasSubmitButton()) {
+                    return $this->hasBeenSubmitted = $this->hasBeenSent();
+                }
+
+                $this->hasBeenSubmitted = $this->pressedButton(
+                    $this->fakeSubmitButtonName,
+                    $this->getSubmitLabel()
+                ) || $this->pressedButton(
+                    $this->submitButtonName,
+                    $this->getSubmitLabel()
+                );
+            } else {
+                $this->hasBeenSubmitted = false;
+            }
+        }
+
+        return $this->hasBeenSubmitted;
+    }
+
+    protected function hasSubmitButton()
+    {
+        return $this->submitButtonName !== null;
+    }
+
+    protected function pressedButton($name, $label)
+    {
+        $req = $this->getRequest();
+        if (! $req->isPost()) {
+            return false;
+        }
+
+        $req = $this->getRequest();
+        $post = $req->getPost();
+
+        return array_key_exists($name, $post)
+            && $post[$name] === $label;
+    }
+
+    protected function beforeValidation($data = array())
+    {
+    }
+
+    public function prepareElements()
+    {
+        if (! $this->didSetup) {
+            $this->beforeSetup();
+            $this->setup();
+            $this->onSetup();
+            $this->didSetup = true;
+        }
+
+        return $this;
+    }
+
+    public function handleRequest(Request $request = null)
+    {
+        if ($request === null) {
+            $request = $this->getRequest();
+        } else {
+            $this->setRequest($request);
+        }
+
+        $this->prepareElements();
+        $this->addSubmitButtonIfSet();
+
+        if ($this->hasBeenSent()) {
+            $post = $request->getPost();
+            if ($this->hasBeenSubmitted()) {
+                $this->beforeValidation($post);
+                if ($this->isValid($post)) {
+                    try {
+                        $this->onSuccess();
+                        $this->callOnSuccessCallables();
+                    } catch (Exception $e) {
+                        $this->addException($e);
+                        $this->onFailure();
+                    }
+                } else {
+                    $this->onFailure();
+                }
+            } else {
+                $this->setDefaults($post);
+            }
+        }
+
+        return $this;
+    }
+
+    public function addException(Exception $e, $elementName = null)
+    {
+        $msg = $this->getErrorMessageForException($e);
+        if ($el = $this->getElement($elementName)) {
+            $el->addError($msg);
+        } else {
+            $this->addError($msg);
+        }
+    }
+
+    public function addUniqueErrorMessage($msg)
+    {
+        if (! in_array($msg, $this->getErrorMessages())) {
+            $this->addErrorMessage($msg);
+        }
+
+        return $this;
+    }
+
+    public function addUniqueException(Exception $e)
+    {
+        $msg = $this->getErrorMessageForException($e);
+
+        if (! in_array($msg, $this->getErrorMessages())) {
+            $this->addErrorMessage($msg);
+        }
+
+        return $this;
+    }
+
+    protected function getErrorMessageForException(Exception $e)
+    {
+        $file = preg_split('/[\/\\\]/', $e->getFile(), -1, PREG_SPLIT_NO_EMPTY);
+        $file = array_pop($file);
+        return sprintf(
+            '%s (%s:%d)',
+            $e->getMessage(),
+            $file,
+            $e->getLine()
+        );
+    }
+
+    public function onSuccess()
+    {
+        $this->redirectOnSuccess();
+    }
+
+    /**
+     * @param callable $callable
+     * @return $this
+     */
+    public function callOnRequest($callable)
+    {
+        if (! is_callable($callable)) {
+            throw new InvalidArgumentException(
+                'callOnRequest() expects a callable'
+            );
+        }
+        $this->onRequestCallbacks[] = $callable;
+
+        return $this;
+    }
+
+    protected function callOnRequestCallables()
+    {
+        if (! $this->calledOnRequestCallbacks) {
+            $this->calledOnRequestCallbacks = true;
+            foreach ($this->onRequestCallbacks as $callable) {
+                $callable($this);
+            }
+        }
+    }
+
+    /**
+     * @param callable $callable
+     * @return $this
+     */
+    public function callOnSuccess($callable)
+    {
+        if (! is_callable($callable)) {
+            throw new InvalidArgumentException(
+                'callOnSuccess() expects a callable'
+            );
+        }
+        $this->successCallbacks[] = $callable;
+
+        return $this;
+    }
+
+    protected function callOnSuccessCallables()
+    {
+        if (! $this->calledSuccessCallbacks) {
+            $this->calledSuccessCallbacks = true;
+            foreach ($this->successCallbacks as $callable) {
+                $callable($this);
+            }
+        }
+    }
+
+    public function setSuccessMessage($message)
+    {
+        $this->successMessage = $message;
+        return $this;
+    }
+
+    public function getSuccessMessage($message = null)
+    {
+        if ($message !== null) {
+            return $message;
+        }
+        if ($this->successMessage === null) {
+            return t('Form has successfully been sent');
+        }
+        return $this->successMessage;
+    }
+
+    public function redirectOnSuccess($message = null)
+    {
+        if ($this->isApiRequest()) {
+            // TODO: Set the status line message?
+            $this->successMessage = $this->getSuccessMessage($message);
+            $this->callOnSuccessCallables();
+            return;
+        }
+
+        $url = $this->getSuccessUrl();
+        $this->callOnSuccessCallables();
+        $this->notifySuccess($this->getSuccessMessage($message));
+        $this->redirectAndExit($url);
+    }
+
+    public function onFailure()
+    {
+    }
+
+    public function notifySuccess($message = null)
+    {
+        if ($message === null) {
+            $message = t('Form has successfully been sent');
+        }
+        Notification::success($message);
+        return $this;
+    }
+
+    public function notifyError($message)
+    {
+        Notification::error($message);
+        return $this;
+    }
+
+    protected function redirectAndExit($url)
+    {
+        /** @var Response $response */
+        $response = Icinga::app()->getFrontController()->getResponse();
+        $response->redirectAndExit($url);
+    }
+
+    protected function setHttpResponseCode($code)
+    {
+        Icinga::app()->getFrontController()->getResponse()->setHttpResponseCode($code);
+        return $this;
+    }
+
+    protected function onRequest()
+    {
+        $this->callOnRequestCallables();
+    }
+
+    public function setRequest(Request $request)
+    {
+        if ($this->request !== null) {
+            throw new RuntimeException('Unable to set request twice');
+        }
+
+        $this->request = $request;
+        $this->prepareElements();
+        $this->onRequest();
+        $this->callOnRequestCallables();
+
+        return $this;
+    }
+
+    /**
+     * @return Request
+     */
+    public function getRequest()
+    {
+        if ($this->request === null) {
+            /** @var Request $request */
+            $request = Icinga::app()->getFrontController()->getRequest();
+            $this->setRequest($request);
+        }
+        return $this->request;
+    }
+
+    public function hasBeenSent()
+    {
+        if ($this->hasBeenSent === null) {
+
+            /** @var Request $req */
+            if ($this->request === null) {
+                $req = Icinga::app()->getFrontController()->getRequest();
+            } else {
+                $req = $this->request;
+            }
+
+            if ($req->isApiRequest()) {
+                $this->hasBeenSent = true;
+            } elseif ($req->isPost()) {
+                $post = $req->getPost();
+                $this->hasBeenSent = array_key_exists(self::ID, $post) &&
+                    $post[self::ID] === $this->getName();
+            } else {
+                $this->hasBeenSent = false;
+            }
+        }
+
+        return $this->hasBeenSent;
+    }
+
+    protected function detectName()
+    {
+        if ($this->formName !== null) {
+            $this->setName($this->formName);
+        } else {
+            $this->setName(get_class($this));
+        }
+    }
+}