tyler.durden
/
icingaweb2
mirror of https://github.com/Icinga/icingaweb2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

BackendConfigForm: Adjust how to process requests 

refs #9516
This commit is contained in:
Johannes Meyer 2015-06-29 14:00:34 +02:00
parent 766ff8ed83
commit db20f2d05a
6 changed files with 212 additions and 160 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
modules/monitoring/application/controllers/ConfigController.php
View File

@ -1,10 +1,11 @@
<?php
/* Icinga Web 2 | (c) 2013-2015 Icinga Development Team | GPLv2+ */
use Icinga\Web\Notification;
use Icinga\Data\ResourceFactory;
use Icinga\Exception\ConfigurationError;
use Icinga\Forms\ConfirmRemovalForm;
use Icinga\Web\Controller;
use Icinga\Web\Notification;
use Icinga\Module\Monitoring\Forms\Config\BackendConfigForm;
use Icinga\Module\Monitoring\Forms\Config\InstanceConfigForm;
use Icinga\Module\Monitoring\Forms\Config\SecurityConfigForm;
@ -25,33 +26,89 @@ class Monitoring_ConfigController extends Controller
}
/**
* Display a form to modify the backend identified by the 'backend' parameter of the request
* Edit a monitoring backend
*/
public function editbackendAction()
{
$backendName = $this->params->getRequired('backend');
$form = new BackendConfigForm();
$form->setTitle($this->translate('Edit Existing Backend'));
$form->setRedirectUrl('monitoring/config');
$form->setTitle(sprintf($this->translate('Edit Monitoring Backend %s'), $backendName));
$form->setIniConfig($this->Config('backends'));
$form->setResourceConfig(ResourceFactory::getResourceConfigs());
$form->setRedirectUrl('monitoring/config');
$form->setOnSuccess(function (BackendConfigForm $form) use ($backendName) {
try {
$form->edit($backendName, 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 backend "%s" successfully updated'), $backendName));
return true;
}
return false;
});
try {
$form->load($backendName);
$form->handleRequest();
} catch (NotFoundError $_) {
$this->httpNotFound(sprintf($this->translate('Monitoring backend "%s" not found'), $backendName));
}
$this->view->form = $form;
$this->render('form');
}
/**
* Display a form to create a new backend
* Create a new monitoring backend
*/
public function createbackendAction()
{
$form = new BackendConfigForm();
$form->setTitle($this->translate('Add New Backend'));
$form->setIniConfig($this->Config('backends'));
$form->setResourceConfig(ResourceFactory::getResourceConfigs());
$form->setRedirectUrl('monitoring/config');
$form->setTitle($this->translate('Create New Monitoring Backend'));
$form->setIniConfig($this->Config('backends'));
try {
$form->setResourceConfig(ResourceFactory::getResourceConfigs());
} catch (ConfigurationError $e) {
if ($this->hasPermission('config/application/resources')) {
Notification::error($e->getMessage());
$this->redirectNow('config/createresource');
}
throw $e; // No permission for resource configuration, show the error
}
$form->setOnSuccess(function (BackendConfigForm $form) {
try {
$form->add(array_filter($form->getValues()));
} catch (Exception $e) {
$form->error($e->getMessage());
return false;
}
if ($form->save()) {
Notification::success(t('Monitoring backend successfully created'));
return true;
}
return false;
});
$form->handleRequest();
$this->view->form = $form;
$this->render('form');
}
/**
@ -59,35 +116,32 @@ class Monitoring_ConfigController extends Controller
*/
public function removebackendAction()
{
$config = $this->Config('backends');
$form = new ConfirmRemovalForm(array(
'onSuccess' => function ($form) use ($config) {
$backendName = $form->getRequest()->getQuery('backend');
$configForm = new BackendConfigForm();
$configForm->setIniConfig($config);
$backendName = $this->params->getRequired('backend');
$backendForm = new BackendConfigForm();
$backendForm->setIniConfig($this->Config('backends'));
$form = new ConfirmRemovalForm();
$form->setRedirectUrl('monitoring/config');
$form->setTitle(sprintf($this->translate('Remove Monitoring Backend %s'), $backendName));
$form->setOnSuccess(function (ConfirmRemovalForm $form) use ($backendName, $backendForm) {
try {
$configForm->remove($backendName);
} catch (InvalidArgumentException $e) {
Notification::error($e->getMessage());
return;
}
if ($configForm->save()) {
Notification::success(sprintf(
$this->translate('Backend "%s" successfully removed.'),
$backendName
));
} else {
$backendForm->delete($backendName);
} catch (Exception $e) {
$form->error($e->getMessage());
return false;
}
if ($backendForm->save()) {
Notification::success(sprintf(t('Monitoring backend "%s" successfully removed'), $backendName));
return true;
}
));
$form->setTitle($this->translate('Remove Existing Backend'));
$form->setRedirectUrl('monitoring/config');
return false;
});
$form->handleRequest();
$this->view->form = $form;
$this->render('form');
}
/**
@ -211,5 +265,6 @@ class Monitoring_ConfigController extends Controller
$this->view->form = $form;
$this->view->tabs = $this->Module()->getConfigTabs()->activate('security');
$this->render('form');
}
}

235
modules/monitoring/application/forms/Config/BackendConfigForm.php
View File

@ -4,17 +4,18 @@
namespace Icinga\Module\Monitoring\Forms\Config;
use Exception;
use Icinga\Data\ConfigObject;
use Icinga\Data\ResourceFactory;
use Icinga\Web\Form;
use InvalidArgumentException;
use Icinga\Application\Config;
use Icinga\Data\ConfigObject;
use Icinga\Data\ResourceFactory;
use Icinga\Exception\ConfigurationError;
use Icinga\Exception\IcingaException;
use Icinga\Exception\NotFoundError;
use Icinga\Forms\ConfigForm;
use Icinga\Web\Notification;
use Icinga\Web\Form;
/**
* Form class for creating/modifying monitoring backends
* Form for managing monitoring backends
*/
class BackendConfigForm extends ConfigForm
{
@ -25,6 +26,13 @@ class BackendConfigForm extends ConfigForm
*/
protected $resources;
/**
* The backend to load when displaying the form for the first time
*
* @var string
*/
protected $backendToLoad;
/**
* Initialize this form
*/
@ -47,16 +55,15 @@ class BackendConfigForm extends ConfigForm
{
$resources = array();
foreach ($resourceConfig as $name => $resource) {
// if ($resource->type === 'db' || $resource->type === 'livestatus') {
// $resources[$resource->type === 'db' ? 'ido' : 'livestatus'][$name] = $name;
// }
if ($resource->type === 'db') {
$resources['ido'][$name] = $name;
}
}
if (empty($resources)) {
throw new ConfigurationError($this->translate('Could not find any valid monitoring backend resources'));
throw new ConfigurationError($this->translate(
'Could not find any valid monitoring backend resources. Please configure a database resource first.'
));
}
$this->resources = $resources;
@ -64,146 +71,109 @@ class BackendConfigForm extends ConfigForm
}
/**
* Add a particular monitoring backend
* Populate the form with the given backend's config
*
* The backend to add is identified by the array-key `name'.
*
* @param array $values The values to extend the configuration with
* @param string $name
*
* @return $this
*
* @throws InvalidArgumentException In case the backend does already exist
* @throws NotFoundError In case no backend with the given name is found
*/
public function add(array $values)
public function load($name)
{
$name = isset($values['name']) ? $values['name'] : '';
if (! $name) {
throw new InvalidArgumentException($this->translate('Monitoring backend name missing'));
} elseif ($this->config->hasSection($name)) {
throw new InvalidArgumentException($this->translate('Monitoring backend already exists'));
if (! $this->config->hasSection($name)) {
throw new NotFoundError('No monitoring backend called "%s" found', $name);
}
unset($values['name']);
$this->config->setSection($name, $values);
$this->backendToLoad = $name;
return $this;
}
/**
* Edit a particular monitoring backend
* Add a new monitoring backend
*
* @param string $name The name of the backend to edit
* @param array $values The values to edit the configuration with
* The backend to add is identified by the array-key `name'.
*
* @return array The edited backend configuration
* @param array $data
*
* @throws InvalidArgumentException In case the backend does not exist
* @return $this
*
* @throws InvalidArgumentException In case $data does not contain a backend name
* @throws IcingaException In case a backend with the same name already exists
*/
public function edit($name, array $values)
public function add(array $data)
{
if (! $name) {
throw new InvalidArgumentException($this->translate('Old monitoring backend name missing'));
} elseif (! ($newName = isset($values['name']) ? $values['name'] : '')) {
throw new InvalidArgumentException($this->translate('New monitoring backend name missing'));
} elseif (! $this->config->hasSection($name)) {
throw new InvalidArgumentException($this->translate('Unknown monitoring backend provided'));
if (! isset($data['name'])) {
throw new InvalidArgumentException('Key \'name\' missing');
}
unset($values['name']);
$this->config->setSection($name, $values);
return $this->config->getSection($name);
$backendName = $data['name'];
if ($this->config->hasSection($backendName)) {
throw new IcingaException('A monitoring backend with the name "%s" does already exist', $backendName);
}
unset($data['name']);
$this->config->setSection($backendName, $data);
return $this;
}
/**
* Remove the given monitoring backend
* Edit a monitoring backend
*
* @param string $name The name of the backend to remove
* @param string $name
* @param array $data
*
* @return array The removed backend configuration
* @return $this
*
* @throws InvalidArgumentException In case the backend does not exist
* @throws NotFoundError In case no backend with the given name is found
*/
public function remove($name)
public function edit($name, array $data)
{
if (! $name) {
throw new InvalidArgumentException($this->translate('Monitoring backend name missing'));
} elseif (! $this->config->hasSection($name)) {
throw new InvalidArgumentException($this->translate('Unknown monitoring backend provided'));
if (! $this->config->hasSection($name)) {
throw new NotFoundError('No monitoring backend called "%s" found', $name);
}
$backendConfig = $this->config->getSection($name);
if (isset($data['name'])) {
if ($data['name'] !== $name) {
$this->config->removeSection($name);
return $backendConfig;
$name = $data['name'];
}
unset($data['name']);
}
$backendConfig->merge($data);
foreach ($backendConfig->toArray() as $k => $v) {
if ($v === null) {
unset($backendConfig->$k);
}
}
$this->config->setSection($name, $backendConfig);
return $this;
}
/**
* Add or edit a monitoring backend and save the configuration
*/
public function onSuccess()
{
$monitoringBackend = $this->request->getQuery('backend');
try {
if ($monitoringBackend === null) { // Create new backend
$this->add($this->getValues());
$message = $this->translate('Monitoring backend "%s" has been successfully created');
} else { // Edit existing backend
$this->edit($monitoringBackend, $this->getValues());
$message = $this->translate('Monitoring backend "%s" has been successfully changed');
}
} catch (InvalidArgumentException $e) {
Notification::error($e->getMessage());
return null;
}
if ($this->save()) {
Notification::success(sprintf($message, $this->getElement('name')->getValue()));
} else {
return false;
}
}
/**
* Populate the form in case a monitoring backend is being edited
* Remove a monitoring backend
*
* @throws ConfigurationError In case the backend name is missing in the request or is invalid
* @param string $name
*
* @return $this
*/
public function onRequest()
public function delete($name)
{
$monitoringBackend = $this->request->getQuery('backend');
if ($monitoringBackend !== null) {
if ($monitoringBackend === '') {
throw new ConfigurationError($this->translate('Monitoring backend name missing'));
} elseif (! $this->config->hasSection($monitoringBackend)) {
throw new ConfigurationError($this->translate('Unknown monitoring backend provided'));
}
$backendConfig = $this->config->getSection($monitoringBackend)->toArray();
$backendConfig['name'] = $monitoringBackend;
$this->populate($backendConfig);
}
$this->config->removeSection($name);
return $this;
}
/**
* (non-PHPDoc)
* @see Form::createElements() For the method documentation.
* Create and add elements to this form
*
* @param array $formData
*/
public function createElements(array $formData)
{
$resourceType = isset($formData['type']) ? $formData['type'] : key($this->resources);
if ($resourceType === 'livestatus') {
throw new ConfigurationError(
'We\'ve disabled livestatus support for now because it\'s not feature complete yet'
);
}
$resourceTypes = array();
if ($resourceType === 'ido' || array_key_exists('ido', $this->resources)) {
$resourceTypes['ido'] = 'IDO Backend';
}
// if ($resourceType === 'livestatus' || array_key_exists('livestatus', $this->resources)) {
// $resourceTypes['livestatus'] = 'Livestatus';
// }
$this->addElement(
'checkbox',
'disabled',
@ -218,9 +188,41 @@ class BackendConfigForm extends ConfigForm
array(
'required' => true,
'label' => $this->translate('Backend Name'),
'description' => $this->translate('The identifier of this backend')
'description' => $this->translate(
'The name of this monitoring backend 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 \':\'.'
)
)
)
)
)
)
);
$resourceType = isset($formData['type']) ? $formData['type'] : null;
$resourceTypes = array();
if ($resourceType === 'ido' || array_key_exists('ido', $this->resources)) {
$resourceTypes['ido'] = 'IDO Backend';
}
if ($resourceType === null) {
$resourceType = key($resourceTypes);
} elseif ($resourceType === 'livestatus') {
throw new ConfigurationError(
'We\'ve disabled livestatus support for now because it\'s not feature complete yet'
);
}
$this->addElement(
'select',
'type',
@ -228,9 +230,10 @@ class BackendConfigForm extends ConfigForm
'required' => true,
'autosubmit' => true,
'label' => $this->translate('Backend Type'),
'description' => $this->translate('The data source used for retrieving monitoring information'),
'multiOptions' => $resourceTypes,
'value' => $resourceType
'description' => $this->translate(
'The type of data source used for retrieving monitoring information'
),
'multiOptions' => $resourceTypes
)
);
@ -276,6 +279,18 @@ class BackendConfigForm extends ConfigForm
);
}
/**
* Populate the configuration of the backend to load
*/
public function onRequest()
{
if ($this->backendToLoad) {
$data = $this->config->getSection($this->backendToLoad)->toArray();
$data['name'] = $this->backendToLoad;
$this->populate($data);
}
}
/**
* Validate the ido instance schema resource
*

6
modules/monitoring/application/views/scripts/config/editbackend.phtml
View File

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

2
modules/monitoring/application/views/scripts/config/createbackend.phtml → modules/monitoring/application/views/scripts/config/form.phtml
View File

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

6
modules/monitoring/application/views/scripts/config/removebackend.phtml
View File

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

6
modules/monitoring/application/views/scripts/config/security.phtml
View File

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