Implement Webdriver

application/controllers/ConfigController.php

@@ -6,10 +6,21 @@
 namespace Icinga\Module\Pdfexport\Controllers;
 
 use Icinga\Application\Config;
-use Icinga\Module\Pdfexport\Forms\ChromeBinaryForm;
-use Icinga\Web\Controller;
+use Icinga\Module\Pdfexport\Forms\BackendConfigForm;
+use Icinga\Web\Form\ConfigSectionForm;
+use Icinga\Web\Notification;
+use Icinga\Web\Session;
+use ipl\Html\Attributes;
+use ipl\Html\Contract\Form;
+use ipl\Html\HtmlString;
+use ipl\Html\Table;
+use ipl\Web\Compat\CompatController;
+use Icinga\Web\Widget\Tabs;
+use ipl\Web\Widget\ButtonLink;
+use ipl\Web\Widget\Icon;
+use ipl\Web\Widget\Link;
 
-class ConfigController extends Controller
+class ConfigController extends CompatController
 {
     public function init()
     {
@@ -18,14 +29,97 @@ public function init()
         parent::init();
     }
 
-    public function chromeAction()
+    public function backendsAction(): void
     {
-        $form = (new ChromeBinaryForm())
-            ->setIniConfig(Config::module('pdfexport'));
+        $button = new ButtonLink(
+            $this->translate('Create a New Backend'),
+            'pdfexport/config/createbackend',
+            'plus',
+            ['title' => $this->translate('Create a New Backend')],
+        );
+        $button->setBaseTarget('_next');
+        $this->addContent($button);
 
-        $form->handleRequest();
+        $table = new Table();
+        $table->setAttributes(Attributes::create([
+            'class' => 'table-row-selectable common-table',
+            'data-base-target' => '_next',
+        ]));
+        $table->add(Table::tr([
+            Table::th($this->translate('Backend')),
+            Table::th($this->translate('Priority')),
+        ]));
 
-        $this->view->tabs = $this->Module()->getConfigTabs()->activate('chrome');
-        $this->view->form = $form;
+        $config = Config::module('pdfexport');
+
+        $sections = [];
+        foreach ($config as $name => $data) {
+            $sections[] = [$name, $data, (int) $data->get('priority')];
+        }
+
+        usort($sections, function ($a, $b) {
+            return $a[2] <=> $b[2];
+        });
+
+        foreach ($sections as [$name, $data]) {
+            $table->add(Table::tr([
+                Table::td([
+                    new Icon('print'),
+                    new Link($name, 'pdfexport/config/backend?backend=' . $name),
+                ]),
+                Table::td($data->get('priority')),
+            ], [
+                'class' => 'clickable',
+            ]));
+        }
+
+        $this->mergeTabs($this->Module()->getConfigTabs()->activate('backends'));
+        $this->addContent($table);
+    }
+
+    public function backendAction(): void
+    {
+        $name = $this->params->shiftRequired('backend');
+        $this->addTitleTab($this->translate(sprintf('Edit %s', $name)));
+
+        $form = (new BackendConfigForm(Config::module('pdfexport'), $name))
+            ->setCsrfCounterMeasureId(Session::getSession()->getId())
+            ->on(Form::ON_SUBMIT, function () {
+                Notification::success($this->translate('Updated print backend'));
+                $this->redirectNow('__CLOSE__');
+            })
+            ->on(ConfigSectionForm::ON_DELETE, function () {
+                Notification::success($this->translate('Print backend deleted'));
+                $this->redirectNow('__CLOSE__');
+            })
+            ->on(ConfigSectionForm::ON_RENAME, function () {
+                Notification::success($this->translate('Print backend renamed'));
+                $this->redirectNow('__CLOSE__');
+            })
+            ->handleRequest($this->getServerRequest());
+
+        $this->addContent(HtmlString::create($form->render()));
+    }
+
+    public function createbackendAction(): void
+    {
+        $this->addTitleTab($this->translate('Create Print Backend'));
+
+        $form = (new BackendConfigForm(Config::module('pdfexport'), null))
+            ->setCsrfCounterMeasureId(Session::getSession()->getId())
+            ->on(Form::ON_SUBMIT, function () {
+                Notification::success($this->translate('Created new print backend'));
+                $this->redirectNow('__CLOSE__');
+            })
+            ->handleRequest($this->getServerRequest());
+
+        $this->addContent($form);
+    }
+
+    protected function mergeTabs(Tabs $tabs): void
+    {
+        foreach ($tabs->getTabs() as $tab) {
+            $this->tabs->add($tab->getName(), $tab);
+        }
     }
 }

application/forms/BackendConfigForm.php

@@ -0,0 +1,181 @@
+<?php
+
+// SPDX-FileCopyrightText: 2019 Icinga GmbH <https://icinga.com>
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+namespace Icinga\Module\Pdfexport\Forms;
+
+use Exception;
+use Icinga\Module\Pdfexport\Backend\Chromedriver;
+use Icinga\Module\Pdfexport\Backend\Geckodriver;
+use Icinga\Module\Pdfexport\Backend\HeadlessChromeBackend;
+use Icinga\Web\Form\ConfigSectionForm;
+use ipl\Validator\CallbackValidator;
+use ipl\Web\Common\CsrfCounterMeasure;
+
+class BackendConfigForm extends ConfigSectionForm
+{
+    use CsrfCounterMeasure;
+
+    public function assemble(): void
+    {
+        $this->addElement('number', 'priority', [
+            'label'       => $this->translate('Priority'),
+            'required'    => true,
+            'placeholder' => 100,
+            'min'         => 0,
+            'description' => $this->translate('The priority of the backend. A lower priority will be used first.'),
+        ]);
+
+        $this->addElement('checkbox', 'enabled', [
+            'label' => $this->translate('Enabled'),
+            'value' => true,
+            'description' => $this->translate('If the backend is not enabled, it will be ignored for PDF generation.'),
+        ]);
+
+        $this->addElement('select', 'type', [
+            'label' => $this->translate('Type'),
+            'multiOptions' => [
+                '' => sprintf(' - %s - ', t('Please choose')),
+                'chrome_webdriver' => t('Chrome WebDriver'),
+                'firefox_webdriver' => t('Firefox WebDriver'),
+                'remote_chrome' => t('Headless Chrome (Remote)'),
+                'local_chrome' => t('Headless Chrome (Local)'),
+            ],
+            'required' => true,
+            'class' => 'autosubmit',
+            'value' => 'local_chrome',
+        ]);
+
+        $type = $this->getValue('type');
+
+        switch ($type) {
+            case 'remote_chrome':
+                $this->addElement('text', 'host', [
+                    'label'       => $this->translate('Host'),
+                    'description' => $this->translate('Host address of the server with the running web browser.'),
+                    'required'    => true,
+                    'validators'  => [
+                        new CallbackValidator(function ($value, CallbackValidator $validator) {
+                            $port = $this->getValue('port') ?: 9222;
+
+                            try {
+                                $chrome = HeadlessChromeBackend::createRemote($value, $port);
+                                $version = $chrome->getVersion();
+                            } catch (Exception $e) {
+                                $validator->addMessage($e->getMessage());
+                                return false;
+                            }
+
+                            if ($version < HeadlessChromeBackend::MIN_SUPPORTED_CHROME_VERSION) {
+                                $validator->addMessage(t(
+                                    'Chrome/Chromium supporting headless mode required'
+                                    . ' which is provided since version %s. Version detected: %s',
+                                ));
+                                return false;
+                            }
+
+                            return true;
+                        }),
+                    ],
+                ]);
+
+                $this->addElement('number', 'port', [
+                    'label'       => $this->translate('Port'),
+                    'description' => $this->translate('Port of the chrome developer tools. (Default: 9222)'),
+                    'placeholder' => 9222,
+                    'min'         => 1,
+                    'max'         => 65535,
+                ]);
+
+                break;
+
+            case 'local_chrome':
+                $this->addElement('text', 'binary', [
+                    'label'       => $this->translate('Binary'),
+                    'placeholder' => '/usr/bin/google-chrome',
+                    'description' => $this->translate('Path to the binary of the web browser.'),
+                    'validators'  => [
+                        new CallbackValidator(function ($value, CallbackValidator $validator) {
+                            if (empty($value)) {
+                                return true;
+                            }
+
+                            try {
+                                $chrome = (HeadlessChromeBackend::createLocal($value));
+                                $version = $chrome->getVersion();
+                            } catch (Exception $e) {
+                                $validator->addMessage($e->getMessage());
+                                return false;
+                            }
+
+                            if ($version < HeadlessChromeBackend::MIN_SUPPORTED_CHROME_VERSION) {
+                                $validator->addMessage(t(
+                                    'Chrome/Chromium supporting headless mode required'
+                                    . ' which is provided since version %s. Version detected: %s',
+                                ));
+                            }
+
+                            return true;
+                        }),
+                    ],
+                ]);
+
+                $this->addElement('checkbox', 'force_temp_storage', [
+                    'label'          => $this->translate('Use temp storage'),
+                    'description'    => $this->translate(
+                        'Use temp storage to transfer the html to the local chrome instance.'
+                    ),
+                    'checkedValue'   => '1',
+                    'uncheckedValue' => '0',
+                ]);
+
+                break;
+
+            case 'firefox_webdriver':
+            case 'chrome_webdriver':
+                $this->addElement('text', 'host', [
+                    'label'       => $this->translate('Host'),
+                    'description' => $this->translate('Host address of the webdriver server'),
+                    'required'    => true,
+                    'validators'  => [
+                        new CallbackValidator(function ($value, CallbackValidator $validator) use ($type) {
+                            $port = $this->getValue('port') ?: 4444;
+
+                            try {
+                                $url = "$value:$port";
+                                $backend = match ($type) {
+                                    'chrome_webdriver' => new Chromedriver($url),
+                                    'firefox_webdriver' => new Geckodriver($url),
+                                    default => throw new Exception("Invalid webdriver type $type"),
+                                };
+
+                                if (! $backend->isSupported()) {
+                                    $validator->addMessage(
+                                        t('The webdriver server reports that it is unable to generate PDFs'),
+                                    );
+                                    return false;
+                                }
+                            } catch (Exception $e) {
+                                $validator->addMessage($e->getMessage());
+                                return false;
+                            }
+                            return true;
+                        }),
+                    ],
+                ]);
+
+                $this->addElement('number', 'port', [
+                    'label'       => $this->translate('Port'),
+                    'description' => $this->translate('Port of the webdriver instance. (Default: 4444)'),
+                    'placeholder' => 4444,
+                    'min'         => 1,
+                    'max'         => 65535,
+                ]);
+
+                break;
+        }
+
+        $this->addCsrfCounterMeasure();
+    }
+}