1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
|
<?php
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\Objects\IcingaEndpoint;
use Icinga\Module\Director\KickstartHelper;
use Icinga\Module\Director\Web\Form\DirectorForm;
use ipl\Html\Html;
use gipfl\IcingaWeb2\Link;
class KickstartForm extends DirectorForm
{
private $config;
private $storeConfigLabel;
private $createDbLabel;
private $migrateDbLabel;
/** @var IcingaEndpoint */
private $endpoint;
private $dbResourceName;
/**
* @throws \Zend_Form_Exception
*/
public function setup()
{
$this->storeConfigLabel = $this->translate('Store configuration');
$this->createDbLabel = $this->translate('Create database schema');
$this->migrateDbLabel = $this->translate('Apply schema migrations');
if ($this->dbResourceName === null) {
$this->addResourceConfigElements();
$this->addResourceDisplayGroup();
if (
!$this->config()->get('db', 'resource')
|| ($this->config()->get('db', 'resource') !== $this->getResourceName())
) {
return;
}
}
if (!$this->hasBeenSent() && !$this->tryDbConnection()) {
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->endpoint && $this->getDb()->hasDeploymentEndpoint()) {
$hint = Html::sprintf(
$this->translate('Your database looks good, you are ready to %s'),
Link::create(
$this->translate('start working with the Icinga Director'),
'director',
null,
['data-base-target' => '_main']
)
);
$this->addHtmlHint($hint, ['name' => 'HINT_ready']);
$this->getDisplayGroup('config')->addElements(
array($this->getElement('HINT_ready'))
);
return;
}
$this->addResourceDisplayGroup();
if ($this->getDb()->hasDeploymentEndpoint()) {
$this->addHtmlHint(
$this->translate(
'Your configuration looks good. Still, you might want to re-run'
. ' this kickstart wizard to (re-)import modified or new manually'
. ' defined Command definitions or to get fresh new ITL commands'
. ' after an Icinga 2 Core upgrade.'
),
array('name' => 'HINT_kickstart')
// http://docs.icinga.com/icinga2/latest/doc/module/icinga2/chapter/
// ... object-types#objecttype-apilistener
);
} else {
$this->addHtmlHint(
$this->translate(
'Your installation of Icinga Director has not yet been prepared for'
. ' deployments. This kickstart wizard will assist you with setting'
. ' up the connection to your Icinga 2 server.'
),
array('name' => 'HINT_kickstart')
// http://docs.icinga.com/icinga2/latest/doc/module/icinga2/chapter/
// ... object-types#objecttype-apilistener
);
}
$this->addElement('text', 'endpoint', array(
'label' => $this->translate('Endpoint Name'),
'description' => $this->translate(
'This is the name of the Endpoint object (and certificate name) you'
. ' created for your ApiListener object. In case you are unsure what'
. ' this means please make sure to read the documentation first'
),
'required' => true,
));
$this->addElement('text', 'host', array(
'label' => $this->translate('Icinga Host'),
'description' => $this->translate(
'IP address / hostname of your Icinga node. Please note that this'
. ' information will only be used for the very first connection to'
. ' your Icinga instance. The Director then relies on a correctly'
. ' configured Endpoint object. Correctly configures means that either'
. ' it\'s name is resolvable or that it\'s host property contains'
. ' either an IP address or a resolvable host name. Your Director must'
. ' be able to reach this endpoint'
),
'required' => false,
));
$this->addElement('text', 'port', array(
'label' => $this->translate('Port'),
'value' => '5665',
'description' => $this->translate(
'The port you are going to use. The default port 5665 will be used'
. ' if none is set'
),
'required' => false,
));
$this->addElement('text', 'username', array(
'label' => $this->translate('API user'),
'description' => $this->translate(
'Your Icinga 2 API username'
),
'required' => true,
));
$this->addElement('password', 'password', array(
'label' => $this->translate('Password'),
'description' => $this->translate(
'The corresponding password'
),
'required' => true,
));
if ($ep = $this->endpoint) {
$user = $ep->getApiUser();
$this->setDefaults(array(
'endpoint' => $ep->get('object_name'),
'host' => $ep->get('host'),
'port' => $ep->get('port'),
'username' => $user->get('object_name'),
'password' => $user->get('password'),
));
if (! empty($user->password)) {
$this->getElement('password')->setAttrib(
'placeholder',
'(use stored password)'
)->setRequired(false);
}
}
$this->addKickstartDisplayGroup();
$this->setSubmitLabel($this->translate('Run import'));
}
/**
* @throws \Icinga\Exception\ConfigurationError
*/
protected function onSetup()
{
if ($this->hasBeenSubmitted()) {
// Do not hinder the form from being stored
return;
}
$this->tryDbConnection();
}
/**
* @throws \Zend_Form_Exception
*/
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')
);
$this->addHtmlHint(Html::sprintf(
$this->translate('Please click %s to create new DB resources'),
Link::create(
$this->translate('here'),
'config/resource',
null,
['data-base-target' => '_main']
)
));
}
$this->setSubmitLabel($this->storeConfigLabel);
}
/**
* @throws \Zend_Form_Exception
*/
protected function addResourceDisplayGroup()
{
if ($this->dbResourceName !== null) {
return;
}
$elements = array(
'HINT_no_resource',
'resource',
'HINT_ready',
'HINT_schema',
'HINT_db_perms',
'HINT_config_store'
);
$this->addDisplayGroup($elements, 'config', array(
'decorators' => array(
'FormElements',
array('HtmlTag', array('tag' => 'dl')),
'Fieldset',
),
'order' => 40,
'legend' => $this->translate('Database backend')
));
}
/**
* @throws \Zend_Form_Exception
*/
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')
));
}
/**
* @return bool
* @throws \Zend_Form_Exception
*/
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'));
return true;
} catch (Exception $e) {
$this->getElement('resource')->addError(
sprintf(
$this->translate(
'Unable to store the configuration to "%s". Please check'
. ' file permissions or manually store the content shown below'
),
$config->getConfigFile()
)
);
$this->addHtmlHint(
Html::tag('pre', null, (string) $config),
array('name' => 'HINT_config_store')
);
$this->getDisplayGroup('config')->addElements(
array($this->getElement('HINT_config_store'))
);
$this->removeElement('HINT_ready');
return false;
}
}
public function setEndpoint(IcingaEndpoint $endpoint)
{
$this->endpoint = $endpoint;
return $this;
}
/**
* @throws \Icinga\Exception\ProgrammingError
* @throws \Zend_Form_Exception
*/
public function onSuccess()
{
if ($this->getSubmitLabel() === $this->storeConfigLabel) {
if ($this->storeResourceConfig()) {
parent::onSuccess();
} else {
return;
}
}
if (
$this->getSubmitLabel() === $this->createDbLabel
|| $this->getSubmitLabel() === $this->migrateDbLabel
) {
$this->migrations()->applyPendingMigrations();
parent::onSuccess();
}
$values = $this->getValues();
if ($this->endpoint && empty($values['password'])) {
$values['password'] = $this->endpoint->getApiUser()->password;
}
$kickstart = new KickstartHelper($this->getDb());
unset($values['resource']);
$kickstart->setConfig($values)->run();
parent::onSuccess();
}
public function setDbResourceName($name)
{
$this->dbResourceName = $name;
return $this;
}
protected function getResourceName()
{
if ($this->dbResourceName !== null) {
return $this->dbResourceName;
}
if ($this->hasBeenSent()) {
$resource = $this->getSentValue('resource');
$resources = $this->enumResources();
if (in_array($resource, $resources)) {
return $resource;
} else {
return null;
}
} else {
return $this->config()->get('db', 'resource');
}
}
public function getDb()
{
return Db::fromResourceName($this->getResourceName());
}
protected function getResource()
{
return ResourceFactory::create($this->getResourceName());
}
/**
* @return Migrations
*/
protected function migrations()
{
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->get('type') === 'db' && in_array($resource->get('db'), $allowed)) {
$resources[$name] = $name;
}
}
return $resources;
}
protected function tryDbConnection()
{
if ($resourceName = $this->getResourceName()) {
$resourceConfig = ResourceFactory::getResourceConfig($resourceName);
if (
!isset($resourceConfig->charset)
|| !in_array($resourceConfig->charset, array('utf8', 'utf8mb4', 'UTF8', 'UTF-8'))
) {
if ($resource = $this->getElement('resource')) {
$resource->addError('Please change the encoding for the director database to utf8');
} else {
$this->addError('Please change the encoding for the director database to utf8');
}
}
$resource = $this->getResource();
$db = $resource->getDbAdapter();
try {
$db->fetchOne('SELECT 1');
return true;
} catch (Exception $e) {
$this->getElement('resource')
->addError('Could not connect to database: ' . $e->getMessage());
$hint = $this->translate(
'Please make sure that your database exists and your user has'
. ' been granted enough permissions'
);
$this->addHtmlHint($hint, array('name' => 'HINT_db_perms'));
}
}
return false;
}
}
|