From 8ca6cc32b2c789a3149861159ad258f2cb9491e3 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Sun, 28 Apr 2024 14:39:39 +0200
Subject: Adding upstream version 2.11.4.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .../application/forms/DatabaseCreationPage.php     | 208 +++++++++++++++++++++
 1 file changed, 208 insertions(+)
 create mode 100644 modules/setup/application/forms/DatabaseCreationPage.php

(limited to 'modules/setup/application/forms/DatabaseCreationPage.php')

diff --git a/modules/setup/application/forms/DatabaseCreationPage.php b/modules/setup/application/forms/DatabaseCreationPage.php
new file mode 100644
index 0000000..8660a21
--- /dev/null
+++ b/modules/setup/application/forms/DatabaseCreationPage.php
@@ -0,0 +1,208 @@
+<?php
+/* Icinga Web 2 | (c) 2014 Icinga Development Team | GPLv2+ */
+
+namespace Icinga\Module\Setup\Forms;
+
+use PDOException;
+use Icinga\Web\Form;
+use Icinga\Module\Setup\Utils\DbTool;
+
+/**
+ * Wizard page to define a database user that is able to create databases and tables
+ */
+class DatabaseCreationPage extends Form
+{
+    /**
+     * The resource configuration to use
+     *
+     * @var array
+     */
+    protected $config;
+
+    /**
+     * The required privileges to setup the database
+     *
+     * @var array
+     */
+    protected $databaseSetupPrivileges;
+
+    /**
+     * The required privileges to operate the database
+     *
+     * @var array
+     */
+    protected $databaseUsagePrivileges;
+
+    /**
+     * Initialize this page
+     */
+    public function init()
+    {
+        $this->setTitle($this->translate('Database Setup', 'setup.page.title'));
+        $this->addDescription($this->translate(
+            'It seems that either the database you defined earlier does not yet exist and cannot be created'
+            . ' using the provided access credentials, the database does not have the required schema to be'
+            . ' operated by Icinga Web 2 or the provided access credentials do not have the sufficient '
+            . 'permissions to access the database. Please provide appropriate access credentials to solve this.'
+        ));
+    }
+
+    /**
+     * Set the resource configuration to use
+     *
+     * @param   array   $config
+     *
+     * @return  $this
+     */
+    public function setResourceConfig(array $config)
+    {
+        $this->config = $config;
+        return $this;
+    }
+
+    /**
+     * Set the required privileges to setup the database
+     *
+     * @param   array   $privileges     The privileges
+     *
+     * @return  $this
+     */
+    public function setDatabaseSetupPrivileges(array $privileges)
+    {
+        $this->databaseSetupPrivileges = $privileges;
+        return $this;
+    }
+
+    /**
+     * Set the required privileges to operate the database
+     *
+     * @param   array   $privileges     The privileges
+     *
+     * @return  $this
+     */
+    public function setDatabaseUsagePrivileges(array $privileges)
+    {
+        $this->databaseUsagePrivileges = $privileges;
+        return $this;
+    }
+
+    /**
+     * @see Form::createElements()
+     */
+    public function createElements(array $formData)
+    {
+        $skipValidation = isset($formData['skip_validation']) && $formData['skip_validation'];
+        $this->addElement(
+            'text',
+            'username',
+            array(
+                'required'      => false === $skipValidation,
+                'label'         => $this->translate('Username'),
+                'description'   => $this->translate(
+                    'A user which is able to create databases and/or touch the database schema'
+                )
+            )
+        );
+        $this->addElement(
+            'password',
+            'password',
+            array(
+                'renderPassword'    => true,
+                'label'             => $this->translate('Password'),
+                'description'       => $this->translate('The password for the database user defined above')
+            )
+        );
+
+        if ($skipValidation) {
+            $this->addSkipValidationCheckbox();
+        } else {
+            $this->addElement(
+                'hidden',
+                'skip_validation',
+                array(
+                    'required'  => true,
+                    'value'     => 0
+                )
+            );
+        }
+    }
+
+    /**
+     * Validate the given form data and check whether the defined user has sufficient access rights
+     *
+     * @param   array   $data   The data to validate
+     *
+     * @return  bool
+     */
+    public function isValid($data)
+    {
+        if (false === parent::isValid($data)) {
+            return false;
+        }
+
+        if (isset($data['skip_validation']) && $data['skip_validation']) {
+            return true;
+        }
+
+        $config = $this->config;
+        $config['username'] = $this->getValue('username');
+        $config['password'] = $this->getValue('password');
+        $db = new DbTool($config);
+
+        try {
+            $db->connectToDb(); // Are we able to login on the database?
+        } catch (PDOException $_) {
+            try {
+                $db->connectToHost(); // Are we able to login on the server?
+            } catch (PDOException $e) {
+                // We are NOT able to login on the server..
+                $this->error($e->getMessage());
+                $this->addSkipValidationCheckbox();
+                return false;
+            }
+        }
+
+        // In case we are connected the credentials filled into this
+        // form need to be granted to create databases, users...
+        if (false === $db->checkPrivileges($this->databaseSetupPrivileges)) {
+            $this->error(
+                $this->translate('The provided credentials cannot be used to create the database and/or the user.')
+            );
+            $this->addSkipValidationCheckbox();
+            return false;
+        }
+
+        // ...and to grant all required usage privileges to others
+        if (false === $db->isGrantable($this->databaseUsagePrivileges)) {
+            $this->error(sprintf(
+                $this->translate(
+                    'The provided credentials cannot be used to grant all required privileges to the login "%s".'
+                ),
+                $this->config['username']
+            ));
+            $this->addSkipValidationCheckbox();
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Add a checkbox to the form by which the user can skip the login and privilege validation
+     */
+    protected function addSkipValidationCheckbox()
+    {
+        $this->addElement(
+            'checkbox',
+            'skip_validation',
+            array(
+                'order'         => 0,
+                'required'      => true,
+                'label'         => $this->translate('Skip Validation'),
+                'description'   => $this->translate(
+                    'Check this to not to validate the ability to login and required privileges'
+                )
+            )
+        );
+    }
+}
-- 
cgit v1.2.3