InstanceConfigForm: Adjust how to process requests

fixes #7486
fixes #7488
fixes #7489
fixes #7490
refs #9516

modules/monitoring/application/controllers/ConfigController.php

@@ -91,82 +91,113 @@ class Monitoring_ConfigController extends Controller
     }
 
     /**
-     * Display a confirmation form to remove the instance identified by the 'instance' parameter
+     * Remove a monitoring instance
      */
     public function removeinstanceAction()
     {
-        $config = $this->Config('instances');
+        $instanceName = $this->params->getRequired('instance');
-        $form = new ConfirmRemovalForm(array(
-            'onSuccess' => function ($form) use ($config) {
-                $instanceName = $form->getRequest()->getQuery('instance');
-                $configForm = new InstanceConfigForm();
-                $configForm->setIniConfig($config);
 
-                try {
+        $instanceForm = new InstanceConfigForm();
-                    $configForm->remove($instanceName);
+        $instanceForm->setIniConfig($this->Config('instances'));
-                } catch (InvalidArgumentException $e) {
+        $form = new ConfirmRemovalForm();
-                    Notification::error($e->getMessage());
+        $form->setRedirectUrl('monitoring/config');
-                    return;
+        $form->setTitle(sprintf($this->translate('Remove Monitoring Instance %s'), $instanceName));
-                }
-
-                if ($configForm->save()) {
-                    Notification::success(sprintf(
-                        $this->translate('Instance "%s" successfully removed.'),
-                        $instanceName
-                    ));
-                } else {
-                    return false;
-                }
-            }
-        ));
-        $form->setTitle($this->translate('Remove Existing Instance'));
         $form->addDescription($this->translate(
             'If you have still any environments or views referring to this instance, '
             . 'you won\'t be able to send commands anymore after deletion.'
         ));
-        $form->addElement(
+        $form->setOnSuccess(function (ConfirmRemovalForm $form) use ($instanceName, $instanceForm) {
-            'note',
+            try {
-            'question',
+                $instanceForm->delete($instanceName);
-            array(
+            } catch (Exception $e) {
-                'value'         => $this->translate('Are you sure you want to remove this instance?'),
+                $form->error($e->getMessage());
-                'decorators'    => array(
+                return false;
-                    'ViewHelper',
+            }
-                    array('HtmlTag', array('tag' => 'p'))
+
-                )
+            if ($instanceForm->save()) {
-            )
+                Notification::success(sprintf(t('Monitoring instance "%s" successfully removed'), $instanceName));
-        );
+                return true;
-        $form->setRedirectUrl('monitoring/config');
+            }
+
+            return false;
+        });
         $form->handleRequest();
 
         $this->view->form = $form;
+        $this->render('form');
     }
 
     /**
-     * Display a form to edit the instance identified by the 'instance' parameter of the request
+     * Edit a monitoring instance
      */
     public function editinstanceAction()
     {
+        $instanceName = $this->params->getRequired('instance');
+
         $form = new InstanceConfigForm();
-        $form->setTitle($this->translate('Edit Existing Instance'));
-        $form->setIniConfig($this->Config('instances'));
         $form->setRedirectUrl('monitoring/config');
-        $form->handleRequest();
+        $form->setTitle(sprintf($this->translate('Edit Monitoring Instance %s'), $instanceName));
+        $form->setIniConfig($this->Config('instances'));
+        $form->setOnSuccess(function (InstanceConfigForm $form) use ($instanceName) {
+            try {
+                $form->edit($instanceName, array_map(
+                    function ($v) {
+                        return $v !== '' ? $v : null;
+                    },
+                    $form->getValues()
+                ));
+            } catch (Exception $e) {
+                $form->error($e->getMessage());
+                return false;
+            }
+
+            if ($form->save()) {
+                Notification::success(sprintf(t('Monitoring instance "%s" successfully updated'), $instanceName));
+                return true;
+            }
+
+            return false;
+        });
+
+        try {
+            $form->load($instanceName);
+            $form->handleRequest();
+        } catch (NotFoundError $_) {
+            $this->httpNotFound(sprintf($this->translate('Monitoring instance "%s" not found'), $instanceName));
+        }
 
         $this->view->form = $form;
+        $this->render('form');
     }
 
     /**
-     * Display a form to create a new instance
+     * Create a new monitoring instance
      */
     public function createinstanceAction()
     {
         $form = new InstanceConfigForm();
-        $form->setTitle($this->translate('Add New Instance'));
-        $form->setIniConfig($this->Config('instances'));
         $form->setRedirectUrl('monitoring/config');
+        $form->setTitle($this->translate('Create New Monitoring Instance'));
+        $form->setIniConfig($this->Config('instances'));
+        $form->setOnSuccess(function (InstanceConfigForm $form) {
+            try {
+                $form->add(array_filter($form->getValues()));
+            } catch (Exception $e) {
+                $form->error($e->getMessage());
+                return false;
+            }
+
+            if ($form->save()) {
+                Notification::success(t('Monitoring instance successfully created'));
+                return true;
+            }
+
+            return false;
+        });
         $form->handleRequest();
 
         $this->view->form = $form;
+        $this->render('form');
     }
 
     /**

modules/monitoring/application/forms/Config/InstanceConfigForm.php

@@ -4,22 +4,28 @@
 namespace Icinga\Module\Monitoring\Forms\Config;
 
 use InvalidArgumentException;
-use Icinga\Exception\ConfigurationError;
+use Icinga\Exception\IcingaException;
+use Icinga\Exception\NotFoundError;
 use Icinga\Forms\ConfigForm;
 use Icinga\Module\Monitoring\Command\Transport\LocalCommandFile;
 use Icinga\Module\Monitoring\Command\Transport\RemoteCommandFile;
 use Icinga\Module\Monitoring\Forms\Config\Instance\LocalInstanceForm;
 use Icinga\Module\Monitoring\Forms\Config\Instance\RemoteInstanceForm;
-use Icinga\Web\Notification;
 
 /**
- * Form for modifying/creating monitoring instances
+ * Form for managing monitoring instances
  */
 class InstanceConfigForm extends ConfigForm
 {
     /**
-     * (non-PHPDoc)
+     * The instance to load when displaying the form for the first time
-     * @see Form::init() For the method documentation.
+     *
+     * @var string
+     */
+    protected $instanceToLoad;
+
+    /**
+     * Initialize this form
      */
     public function init()
     {
@@ -28,11 +34,11 @@ class InstanceConfigForm extends ConfigForm
     }
 
     /**
-     * Get a form object for the given instance type
+     * Return a form object for the given instance type
      *
-     * @param   string $type                The instance type for which to return a form
+     * @param   string  $type               The instance type for which to return a form
      *
-     * @return  LocalInstanceForm|RemoteInstanceForm
+     * @return  Form
      *
      * @throws  InvalidArgumentException    In case the given instance type is invalid
      */
@@ -40,162 +46,157 @@ class InstanceConfigForm extends ConfigForm
     {
         switch (strtolower($type)) {
             case LocalCommandFile::TRANSPORT:
-                $form = new LocalInstanceForm();
+                return new LocalInstanceForm();
-                break;
             case RemoteCommandFile::TRANSPORT;
-                $form = new RemoteInstanceForm();
+                return new RemoteInstanceForm();
-                break;
             default:
                 throw new InvalidArgumentException(
-                    sprintf($this->translate('Invalid instance type "%s" given'), $type)
+                    sprintf($this->translate('Invalid monitoring instance type "%s" given'), $type)
                 );
         }
-        return $form;
+    }
+
+    /**
+     * Populate the form with the given instance's config
+     *
+     * @param   string  $name
+     *
+     * @return  $this
+     *
+     * @throws  NotFoundError   In case no instance with the given name is found
+     */
+    public function load($name)
+    {
+        if (! $this->config->hasSection($name)) {
+            throw new NotFoundError('No monitoring instance called "%s" found', $name);
+        }
+
+        $this->instanceToLoad = $name;
+        return $this;
     }
 
     /**
      * Add a new instance
      *
-     * The resource to add is identified by the array-key `name'.
+     * The instance to add is identified by the array-key `name'.
      *
-     * @param   array   $values             The values to extend the configuration with
+     * @param   array   $data
      *
      * @return  $this
      *
-     * @throws  InvalidArgumentException    In case the resource already exists
+     * @throws  InvalidArgumentException    In case $data does not contain a instance name
+     * @throws  IcingaException             In case a instance with the same name already exists
      */
-    public function add(array $values)
+    public function add(array $data)
     {
-        $name = isset($values['name']) ? $values['name'] : '';
+        if (! isset($data['name'])) {
-        if (! $name) {
+            throw new InvalidArgumentException('Key \'name\' missing');
-            throw new InvalidArgumentException($this->translate('Instance name missing'));
-        }
-        if ($this->config->hasSection($name)) {
-            throw new InvalidArgumentException($this->translate('Instance already exists'));
         }
 
-        unset($values['name']);
+        $instanceName = $data['name'];
-        $this->config->setSection($name, $values);
+        if ($this->config->hasSection($instanceName)) {
+            throw new IcingaException('A monitoring instance with the name "%s" does already exist', $instanceName);
+        }
+
+        unset($data['name']);
+        $this->config->setSection($instanceName, $data);
         return $this;
     }
 
     /**
      * Edit an existing instance
      *
-     * @param   string      $name           The name of the resource to edit
+     * @param   string  $name
-     * @param   array       $values         The values to edit the configuration with
+     * @param   array   $data
      *
-     * @return  array                       The edited resource configuration
+     * @return  $this
      *
-     * @throws  InvalidArgumentException    In case the resource name is missing or invalid
+     * @throws  NotFoundError   In case no instance with the given name is found
      */
-    public function edit($name, array $values)
+    public function edit($name, array $data)
     {
-        if (! $name) {
+        if (! $this->config->hasSection($name)) {
-            throw new InvalidArgumentException($this->translate('Old instance name missing'));
+            throw new NotFoundError('No monitoring instance called "%s" found', $name);
-        } elseif (! ($newName = isset($values['name']) ? $values['name'] : '')) {
-            throw new InvalidArgumentException($this->translate('New instance name missing'));
-        } elseif (! $this->config->hasSection($name)) {
-            throw new InvalidArgumentException($this->translate('Unknown instance name provided'));
         }
 
-        unset($values['name']);
+        $instanceConfig = $this->config->getSection($name);
-        $this->config->setSection($name, $values);
+        if (isset($data['name'])) {
-        return $this->config->getSection($name);
+            if ($data['name'] !== $name) {
+                $this->config->removeSection($name);
+                $name = $data['name'];
+            }
+
+            unset($data['name']);
+        }
+
+        $instanceConfig->merge($data);
+        foreach ($instanceConfig->toArray() as $k => $v) {
+            if ($v === null) {
+                unset($instanceConfig->$k);
+            }
+        }
+
+        $this->config->setSection($name, $instanceConfig);
+        return $this;
     }
 
     /**
      * Remove a instance
      *
-     * @param   string      $name           The name of the resource to remove
+     * @param   string  $name
      *
-     * @return  array                       The removed resource configuration
+     * @return  $this
-     *
-     * @throws  InvalidArgumentException    In case the resource name is missing or invalid
      */
-    public function remove($name)
+    public function delete($name)
     {
-        if (! $name) {
-            throw new InvalidArgumentException($this->translate('Instance name missing'));
-        } elseif (! $this->config->hasSection($name)) {
-            throw new InvalidArgumentException($this->translate('Unknown instance name provided'));
-        }
-
-        $instanceConfig = $this->config->getSection($name);
         $this->config->removeSection($name);
-        return $instanceConfig;
+        return $this;
     }
 
     /**
-     * @see     Form::onRequest()   For the method documentation.
+     * Create and add elements to this form
-     * @throws  ConfigurationError  In case the instance name is missing or invalid
+     *
+     * @param   array   $formData
      */
-    public function onRequest()
+    public function createElements(array $formData)
     {
-        $instanceName = $this->request->getQuery('instance');
+        $this->addElement(
-        if ($instanceName !== null) {
+            'text',
-            if (! $instanceName) {
+            'name',
-                throw new ConfigurationError($this->translate('Instance name missing'));
+            array(
-            }
+                'required'      => true,
-            if (! $this->config->hasSection($instanceName)) {
+                'label'         => $this->translate('Instance Name'),
-                throw new ConfigurationError($this->translate('Unknown instance name given'));
+                'description'   => $this->translate(
-            }
+                    'The name of this monitoring instance that is used to differentiate it from others'
+                ),
+                'validators'    => array(
+                    array(
+                        'Regex',
+                        false,
+                        array(
+                            'pattern'  => '/^[^\\[\\]:]+$/',
+                            'messages' => array(
+                                'regexNotMatch' => $this->translate(
+                                    'The name cannot contain \'[\', \']\' or \':\'.'
+                                )
+                            )
+                        )
+                    )
+                )
+            )
+        );
 
-            $instanceConfig = $this->config->getSection($instanceName)->toArray();
+        $instanceTypes = array(
-            $instanceConfig['name'] = $instanceName;
+            LocalCommandFile::TRANSPORT     => $this->translate('Local Command File'),
+            RemoteCommandFile::TRANSPORT    => $this->translate('Remote Command File')
+        );
 
-            if (isset($instanceConfig['resource'])) {
+        $instanceType = isset($formData['transport']) ? $formData['transport'] : null;
-                $instanceConfig['use_resource'] = true;
+        if ($instanceType === null) {
-            }
+            $instanceType = key($instanceTypes);
-
-            $this->populate($instanceConfig);
         }
-    }
-
-    /**
-     * (non-PHPDoc)
-     * @see Form::onSuccess() For the method documentation.
-     */
-    public function onSuccess()
-    {
-        $instanceName = $this->request->getQuery('instance');
-        try {
-            if ($instanceName === null) { // create new instance
-                $this->add($this->getValues());
-                $message = $this->translate('Instance "%s" created successfully.');
-            } else { // edit existing instance
-                $this->edit($instanceName, $this->getValues());
-                $message = $this->translate('Instance "%s" edited successfully.');
-            }
-        } catch (InvalidArgumentException $e) {
-            Notification::error($e->getMessage());
-            return;
-        }
-
-        if ($this->save()) {
-            Notification::success(sprintf($message, $this->getElement('name')->getValue()));
-        } else {
-            return false;
-        }
-    }
-
-    /**
-     * (non-PHPDoc)
-     * @see Form::createElements() For the method documentation.
-     */
-    public function createElements(array $formData = array())
-    {
-        $instanceType = isset($formData['transport']) ? $formData['transport'] : LocalCommandFile::TRANSPORT;
 
         $this->addElements(array(
-            array(
-                'text',
-                'name',
-                array(
-                    'required'  => true,
-                    'label'     => $this->translate('Instance Name')
-                )
-            ),
             array(
                 'select',
                 'transport',
@@ -203,15 +204,39 @@ class InstanceConfigForm extends ConfigForm
                     'required'      => true,
                     'autosubmit'    => true,
                     'label'         => $this->translate('Instance Type'),
-                    'multiOptions'  => array(
+                    'description'   => $this->translate('The type of transport to use for this monitoring instance'),
-                        LocalCommandFile::TRANSPORT     => $this->translate('Local Command File'),
+                    'multiOptions'  => $instanceTypes
-                        RemoteCommandFile::TRANSPORT    => $this->translate('Remote Command File')
-                    ),
-                    'value' => $instanceType
                 )
             )
         ));
 
-        $this->addElements($this->getInstanceForm($instanceType)->createElements($formData)->getElements());
+        $this->addSubForm($this->getInstanceForm($instanceType)->create($formData), 'instance_form');
+    }
+
+    /**
+     * Populate the configuration of the instance to load
+     */
+    public function onRequest()
+    {
+        if ($this->instanceToLoad) {
+            $data = $this->config->getSection($this->instanceToLoad)->toArray();
+            $data['name'] = $this->instanceToLoad;
+            $this->populate($data);
+        }
+    }
+
+    /**
+     * Retrieve all form element values
+     *
+     * @param   bool    $suppressArrayNotation  Ignored
+     *
+     * @return  array
+     */
+    public function getValues($suppressArrayNotation = false)
+    {
+        $values = parent::getValues();
+        $values = array_merge($values, $values['instance_form']);
+        unset($values['instance_form']);
+        return $values;
     }
 }

modules/monitoring/application/forms/Setup/InstancePage.php

@@ -19,10 +19,6 @@ class InstancePage extends Form
 
     public function createElements(array $formData)
     {
-        if (isset($formData['host'])) {
-            $formData['type'] = 'remote'; // This is necessary as the type element gets ignored by Form::getValues()
-        }
-
         $instanceConfigForm = new InstanceConfigForm();
         $instanceConfigForm->createElements($formData);
         $this->addElements($instanceConfigForm->getElements());

modules/monitoring/application/views/scripts/config/createinstance.phtml

@@ -1,6 +0,0 @@
-<div class="controls">
-    <?= $tabs->showOnlyCloseButton() ?>
-</div>
-<div class="content">
-    <?= $form; ?>
-</div>

modules/monitoring/application/views/scripts/config/editinstance.phtml

@@ -1,6 +0,0 @@
-<div class="controls">
-    <?= $tabs->showOnlyCloseButton() ?>
-</div>
-<div class="content">
-    <?= $form; ?>
-</div>

modules/monitoring/application/views/scripts/config/removeinstance.phtml

@@ -1,6 +0,0 @@
-<div class="controls">
-    <?= $tabs->showOnlyCloseButton() ?>
-</div>
-<div class="content">
-    <?= $form; ?>
-</div>