KickstartForm: rework form, handle db resources

application/forms/KickstartForm.php

@@ -3,34 +3,85 @@
 namespace Icinga\Module\Director\Forms;
 
 use Exception;
+use Icinga\Application\Config;
+use Icinga\Data\ResourceFactory;
+use Icinga\Module\Director\Db;
 use Icinga\Module\Director\Db\Migrations;
 use Icinga\Module\Director\KickstartHelper;
 use Icinga\Module\Director\Web\Form\QuickForm;
 
 class KickstartForm extends QuickForm
 {
-    protected $db;
+    protected $config;
+
+    protected $storeConfigLabel;
 
     protected $createDbLabel;
 
+    protected $migrateDbLabel;
+
     public function setup()
     {
-        $this->createDbLabel = $this->translate('Create database schema');
+        $this->storeConfigLabel = $this->translate('Store configuration');
+        $this->createDbLabel    = $this->translate('Create database schema');
+        $this->migrateDbLabel   = $this->translate('Apply schema migrations');
+
+        $this->addResourceConfigElements();
+        if (!$this->config()->get('db', 'resource')
+            || ($this->config()->get('db', 'resource') !== $this->getResourceName())) {
+            $this->addResourceDisplayGroup();
+            return;
+        }
+
         if (!$this->migrations()->hasSchema()) {
 
             $this->addHtmlHint($this->translate(
                 'No database schema has been created yet'
+            ), array('name' => 'HINT_schema'));
+
+            $this->addResourceDisplayGroup();
+            $this->setSubmitLabel($this->createDbLabel);
+            return;
+        }
+
+        if ($this->migrations()->hasPendingMigrations()) {
+
+            $this->addHtmlHint($this->translate(
+                'There are pending database migrations'
+            ), array('name' => 'HINT_schema'));
+
+            $this->addResourceDisplayGroup();
+            $this->setSubmitLabel($this->migrateDbLabel);
+            return;
+        }
+
+        if ($this->getDb()->hasDeploymentEndpoint()) {
+            $hint = sprintf($this->translate(
+                'Your database looks good, you are ready to %s'
+            ), $this->getView()->qlink(
+                'start working with the Icinga Director',
+                'director',
+                null,
+                array('data-base-target' => '_main')
             ));
 
-            $this->setSubmitLabel($this->createDbLabel);
+            $this->addHtmlHint($hint, array('name' => 'HINT_ready'));
-            return ;
+
+            return;
         }
 
+        $this->addResourceDisplayGroup();
+
         $this->addHtmlHint(
             $this->translate(
-                'Your installation of Icinga Director has not yet been prepared for deployments.'
+                'Your installation of Icinga Director has not yet been prepared for'
-                . ' This kickstart wizard will assist you with setting up the connection to your Icinga 2 server'
+                . ' deployments. This kickstart wizard will assist you with setting'
+                . ' up the connection to your Icinga 2 server.'
             )
+            /*
+            . $this->translate(
+                http://docs.icinga.org/icinga2/latest/doc/module/icinga2/chapter/object-types#objecttype-apilistener
+            )*/, array('name' => 'HINT_kickstart')
         );
 
         $this->addElement('text', 'endpoint', array(
@@ -76,41 +127,232 @@ class KickstartForm extends QuickForm
         ));
 
         $this->addElement('password', 'password', array(
-            'label'    => $this->translate('Password'),
+            'label'       => $this->translate('Password'),
             'description' => $this->translate(
                 'The corresponding password'
             ),
-            'required' => true,
+            'required'    => true,
         ));
+
+        $this->addKickstartDisplayGroup();
+        $this->setSubmitLabel($this->translate('Run import'));
+    }
+
+    protected function onSetup()
+    {
+        if ($this->hasBeenSubmitted()) {
+            // Do not hinder the form from being stored
+            return;
+        }
+        if ($resourceName = $this->getResourceName()) {
+            $resourceConfig = ResourceFactory::getResourceConfig($resourceName);
+            if (! isset($resourceConfig->charset)
+                || $resourceConfig->charset !== 'utf8'
+            ) {
+                $this->getElement('resource')
+                    ->addError('Please change the encoding for the director database to utf8');
+            }
+
+            $resource = $this->getResource();
+            $db = $resource->getDbAdapter();
+
+            try {
+                $query = $db->select()->from('dual', '(1)');
+                $db->fetchOne($query);
+
+            } catch (Exception $e) {
+                $this->getElement('resource')
+                    ->addError('Could not connect to database: ' . $e->getMessage());
+
+                $hint = $this->translate(
+                    'Please make sure that your database grants enough permissions'
+                    . ' and that you deployed the correct %s.'
+                );
+
+                $this->addHtmlHint($hint, array('name' => 'HINT_db_perms'));
+            }
+
+        }
+    }
+
+    protected function addResourceConfigElements()
+    {
+        $config = $this->config();
+        $resources = $this->enumResources();
+
+        if (!$this->getResourceName()) {
+            $this->addHtmlHint($this->translate(
+                'No database resource has been configured yet. Please choose a'
+                . ' resource to complete your config'
+            ), array('name' => 'HINT_no_resource'));
+        }
+
+        $this->addElement('select', 'resource', array(
+            'required'      => true,
+            'label'         => $this->translate('DB Resource'),
+            'multiOptions'  => $this->optionalEnum($resources),
+            'class'         => 'autosubmit',
+            'value'         => $config->get('db', 'resource')
+        ));
+
+        if (empty($resources)) {
+            $this->getElement('resource')->addError(
+                $this->translate('This has to be a MySQL or PostgreSQL database')
+            );
+
+            $hint = $this->translate('Please click %s to create new DB resources');
+            $link = $this->getView()->qlink(
+                $this->translate('here'),
+                'config/resource',
+                null,
+                array('data-base-target' => '_main')
+            );
+            $this->addHtmlHint(sprintf($hint, $link));
+        }
+
+        $this->setSubmitLabel($this->storeConfigLabel);
+    }
+
+    protected function addResourceDisplayGroup()
+    {
+        $elements = array(
+            'HINT_no_resource',
+            'HINT_ready',
+            'resource',
+            'HINT_schema',
+            'HINT_db_perms'
+        );
+
+        $this->addDisplayGroup($elements, 'config', array(
+            'decorators' => array(
+                'FormElements',
+                array('HtmlTag', array('tag' => 'dl')),
+                'Fieldset',
+            ),
+            'order' => 40,
+            'legend' => $this->translate('Database backend')
+        ));
+    }
+
+    protected function addKickstartDisplayGroup()
+    {
+        $elements = array(
+            'HINT_kickstart', 'endpoint', 'host', 'port', 'username', 'password'
+        );
+
+        $this->addDisplayGroup($elements, 'wizard', array(
+            'decorators' => array(
+                'FormElements',
+                array('HtmlTag', array('tag' => 'dl')),
+                'Fieldset',
+            ),
+            'order' => 60,
+            'legend' => $this->translate('Kickstart wizard')
+        ));
+    }
+
+    protected function storeResourceConfig()
+    {
+        $config = $this->config();
+        $value = $this->getValue('resource');
+
+        $config->setSection('db', array('resource' => $value));
+
+        try {
+            $config->saveIni();
+            $this->setSuccessMessage($this->translate('Configuration has been stored'));
+        } catch (Exception $e) {
+            $this->getElement('resource')->addError(
+                sprintf(
+                    $this->translate('Unable to store the configuration to "%s"'),
+                    $config->getConfigFile()
+                )
+            )->removeDecorator('description');
+            $this->addHtmlHint(
+                '<pre>' . $config . '</pre>'
+            );
+        }
+
     }
 
     public function onSuccess()
     {
         try {
-            if ($this->getSubmitLabel() === $this->createDbLabel) {
+            if ($this->getSubmitLabel() === $this->storeConfigLabel) {
+                $this->storeResourceConfig();
+                return parent::onSuccess();
+            }
+
+            if ($this->getSubmitLabel() === $this->createDbLabel
+                || $this->getSubmitLabel() === $this->migrateDbLabel) {
                 $this->migrations()->applyPendingMigrations();
                 return parent::onSuccess();
             }
-            $kickstart = new KickstartHelper($this->db);
+
-            $kickstart->setConfig($this->getValues())->run();
+            $values = $this->getValues();
+            $kickstart = new KickstartHelper($this->getDb());
+            unset($values['resource']);
+            $kickstart->setConfig($values)->run();
             parent::onSuccess();
         } catch (Exception $e) {
             $this->addError($e->getMessage());
         }
     }
 
-    public function setDb($db)
+    protected function getResourceName()
     {
-        $this->db = $db;
+        if ($this->hasBeenSent()) {
-        if ($this->object !== null) {
+            $resource = $this->getSentValue('resource');
-            $this->object->setConnection($db);
+            $resources = $this->enumResources();
+            if (in_array($resource, $resources)) {
+                return $resource;
+            }
+        } else {
+            return $this->config()->get('db', 'resource');
         }
+    }
 
-        return $this;
+    protected function getDb()
+    {
+        return Db::fromResourceName($this->getResourceName());
+    }
+
+    protected function getResource()
+    {
+        return ResourceFactory::create($this->getResourceName());
     }
 
     protected function migrations()
     {
-        return new Migrations($this->db);
+        return new Migrations($this->getDb());
+    }
+
+    public function setModuleConfig(Config $config)
+    {
+        $this->config = $config;
+        return $this;
+    }
+
+    protected function config()
+    {
+        if ($this->config === null) {
+            $this->config = Config::module('director');
+        }
+
+        return $this->config;
+    }
+
+    protected function enumResources()
+    {
+        $resources = array();
+        $allowed = array('mysql', 'pgsql');
+
+        foreach (ResourceFactory::getResourceConfigs() as $name => $resource) {
+            if ($resource->type === 'db' && in_array($resource->db, $allowed)) {
+                $resources[$name] = $name;
+            }
+        }
+
+        return $resources;
     }
 }