diff options
Diffstat (limited to 'application/controllers/BasketController.php')
| -rw-r--r-- | application/controllers/BasketController.php | 416 |
1 files changed, 416 insertions, 0 deletions
diff --git a/application/controllers/BasketController.php b/application/controllers/BasketController.php new file mode 100644 index 0000000..8733d16 --- /dev/null +++ b/application/controllers/BasketController.php @@ -0,0 +1,416 @@ +<?php + +namespace Icinga\Module\Director\Controllers; + +use Exception; +use gipfl\Diff\HtmlRenderer\InlineDiff; +use gipfl\Diff\PhpDiff; +use gipfl\IcingaWeb2\Link; +use gipfl\Web\Table\NameValueTable; +use gipfl\Web\Widget\Hint; +use Icinga\Date\DateFormatter; +use Icinga\Module\Director\Core\Json; +use Icinga\Module\Director\Data\Exporter; +use Icinga\Module\Director\Db; +use Icinga\Module\Director\DirectorObject\Automation\Basket; +use Icinga\Module\Director\DirectorObject\Automation\BasketSnapshot; +use Icinga\Module\Director\DirectorObject\Automation\BasketSnapshotFieldResolver; +use Icinga\Module\Director\DirectorObject\Automation\CompareBasketObject; +use Icinga\Module\Director\Forms\AddToBasketForm; +use Icinga\Module\Director\Forms\BasketCreateSnapshotForm; +use Icinga\Module\Director\Forms\BasketForm; +use Icinga\Module\Director\Forms\BasketUploadForm; +use Icinga\Module\Director\Forms\RestoreBasketForm; +use Icinga\Module\Director\Web\Controller\ActionController; +use ipl\Html\Html; +use Icinga\Module\Director\Web\Table\BasketSnapshotTable; + +class BasketController extends ActionController +{ + protected $isApified = true; + + protected function basketTabs() + { + $name = $this->params->get('name'); + return $this->tabs()->add('show', [ + 'label' => $this->translate('Basket'), + 'url' => 'director/basket', + 'urlParams' => ['name' => $name] + ])->add('snapshots', [ + 'label' => $this->translate('Snapshots'), + 'url' => 'director/basket/snapshots', + 'urlParams' => ['name' => $name] + ]); + } + + /** + * @throws \Icinga\Exception\NotFoundError + * @throws \Icinga\Exception\MissingParameterException + */ + public function indexAction() + { + $this->actions()->add( + Link::create( + $this->translate('Back'), + 'director/baskets', + null, + ['class' => 'icon-left-big'] + ) + ); + $basket = $this->requireBasket(); + $this->basketTabs()->activate('show'); + $this->addTitle($basket->get('basket_name')); + if ($basket->isEmpty()) { + $this->content()->add(Hint::info($this->translate('This basket is empty'))); + } + $this->content()->add( + (new BasketForm())->setObject($basket)->handleRequest() + ); + } + + /** + * @throws \Icinga\Exception\MissingParameterException + */ + public function addAction() + { + $this->actions()->add( + Link::create( + $this->translate('Baskets'), + 'director/baskets', + null, + ['class' => 'icon-tag'] + ) + ); + $this->addSingleTab($this->translate('Add to Basket')); + $this->addTitle($this->translate('Add chosen objects to a Configuration Basket')); + $form = new AddToBasketForm(); + $form->setDb($this->db()) + ->setType($this->params->getRequired('type')) + ->setNames($this->url()->getParams()->getValues('names')) + ->handleRequest(); + $this->content()->add($form); + } + + public function createAction() + { + $this->actions()->add( + Link::create( + $this->translate('back'), + 'director/baskets', + null, + ['class' => 'icon-left-big'] + ) + ); + $this->addSingleTab($this->translate('Create Basket')); + $this->addTitle($this->translate('Create a new Configuration Basket')); + $form = (new BasketForm()) + ->setDb($this->db()) + ->handleRequest(); + $this->content()->add($form); + } + + public function uploadAction() + { + $this->actions()->add( + Link::create( + $this->translate('back'), + 'director/baskets', + null, + ['class' => 'icon-left-big'] + ) + ); + $this->addSingleTab($this->translate('Upload a Basket')); + $this->addTitle($this->translate('Upload a Configuration Basket')); + $form = (new BasketUploadForm()) + ->setDb($this->db()) + ->handleRequest(); + $this->content()->add($form); + } + + /** + * @throws \Icinga\Exception\NotFoundError + */ + public function snapshotsAction() + { + $name = $this->params->get('name'); + if ($name === null || $name === '') { + $basket = null; + } else { + $basket = Basket::load($name, $this->db()); + } + if ($basket === null) { + $this->addTitle($this->translate('Basket Snapshots')); + $this->addSingleTab($this->translate('Snapshots')); + } else { + $this->addTitle(sprintf( + $this->translate('%s: Snapshots'), + $basket->get('basket_name') + )); + $this->basketTabs()->activate('snapshots'); + } + if ($basket !== null) { + $this->content()->add( + (new BasketCreateSnapshotForm()) + ->setBasket($basket) + ->handleRequest() + ); + } + $table = new BasketSnapshotTable($this->db()); + if ($basket !== null) { + $table->setBasket($basket); + } + + $table->renderTo($this); + } + + /** + * @throws \Icinga\Exception\MissingParameterException + * @throws \Icinga\Exception\NotFoundError + */ + public function snapshotAction() + { + $basket = $this->requireBasket(); + $snapshot = BasketSnapshot::load([ + 'basket_uuid' => $basket->get('uuid'), + 'ts_create' => $this->params->getRequired('ts'), + ], $this->db()); + $snapSum = bin2hex($snapshot->get('content_checksum')); + + if ($this->params->get('action') === 'download') { + $this->getResponse()->setHeader('Content-Type', 'application/json', true); + $this->getResponse()->setHeader('Content-Disposition', sprintf( + 'attachment; filename=Director-Basket_%s_%s.json', + str_replace([' ', '"'], ['_', '_'], iconv( + 'UTF-8', + 'ISO-8859-1//IGNORE', + $basket->get('basket_name') + )), + substr($snapSum, 0, 7) + )); + echo $snapshot->getJsonDump(); + return; + } + + $this->addTitle( + $this->translate('%s: %s (Snapshot)'), + $basket->get('basket_name'), + substr($snapSum, 0, 7) + ); + + $this->actions()->add([ + Link::create( + $this->translate('Show Basket'), + 'director/basket', + ['name' => $basket->get('basket_name')], + ['data-base-target' => '_next'] + ), + Link::create( + $this->translate('Restore'), + $this->url()->with('action', 'restore'), + null, + ['class' => 'icon-rewind'] + ), + Link::create( + $this->translate('Download'), + $this->url() + ->with([ + 'action' => 'download', + 'dbResourceName' => $this->getDbResourceName() + ]), + null, + [ + 'class' => 'icon-download', + 'target' => '_blank' + ] + ), + ]); + + $properties = new NameValueTable(); + $properties->addNameValuePairs([ + $this->translate('Created') => DateFormatter::formatDateTime($snapshot->get('ts_create') / 1000), + $this->translate('Content Checksum') => bin2hex($snapshot->get('content_checksum')), + ]); + $this->content()->add($properties); + + if ($this->params->get('action') === 'restore') { + $form = new RestoreBasketForm(); + $form + ->setSnapshot($snapshot) + ->handleRequest(); + $this->content()->add($form); + $targetDbName = $form->getValue('target_db'); + $connection = $form->getDb(); + } else { + $targetDbName = null; + $connection = $this->db(); + } + + $json = $snapshot->getJsonDump(); + $this->addSingleTab($this->translate('Snapshot')); + $all = Json::decode($json); + $exporter = new Exporter($this->db()); + $fieldResolver = new BasketSnapshotFieldResolver($all, $connection); + foreach ($all as $type => $objects) { + if ($type === 'Datafield') { + // TODO: we should now be able to show all fields and link + // to a "diff" for the ones that should be created + // $this->content()->add(Html::tag('h2', sprintf('+%d Datafield(s)', count($objects)))); + continue; + } + $table = new NameValueTable(); + $table->addAttributes([ + 'class' => ['table-basket-changes', 'table-row-selectable'], + 'data-base-target' => '_next', + ]); + foreach ($objects as $key => $object) { + $linkParams = [ + 'name' => $basket->get('basket_name'), + 'checksum' => $this->params->get('checksum'), + 'ts' => $this->params->get('ts'), + 'type' => $type, + 'key' => $key, + ]; + if ($targetDbName !== null) { + $linkParams['target_db'] = $targetDbName; + } + try { + $current = BasketSnapshot::instanceByIdentifier($type, $key, $connection); + if ($current === null) { + $table->addNameValueRow( + $key, + Link::create( + Html::tag('strong', ['style' => 'color: green'], $this->translate('new')), + 'director/basket/snapshotobject', + $linkParams + ) + ); + continue; + } + $currentExport = $exporter->export($current); + $fieldResolver->tweakTargetIds($currentExport); + + // Ignore originalId + if (isset($currentExport->originalId)) { + unset($currentExport->originalId); + } + if (isset($object->originalId)) { + unset($object->originalId); + } + $hasChanged = ! CompareBasketObject::equals($currentExport, $object); + $table->addNameValueRow( + $key, + $hasChanged + ? Link::create( + Html::tag('strong', ['style' => 'color: orange'], $this->translate('modified')), + 'director/basket/snapshotobject', + $linkParams + ) + : Html::tag('span', ['style' => 'color: green'], $this->translate('unchanged')) + ); + } catch (Exception $e) { + $table->addNameValueRow( + $key, + Html::tag('a', sprintf( + '%s (%s:%d)', + $e->getMessage(), + basename($e->getFile()), + $e->getLine() + )) + ); + } + } + $this->content()->add(Html::tag('h2', $type)); + $this->content()->add($table); + } + $this->content()->add(Html::tag('div', ['style' => 'height: 5em'])); + } + + /** + * @throws \Icinga\Exception\MissingParameterException + * @throws \Icinga\Exception\NotFoundError + */ + public function snapshotobjectAction() + { + $basket = $this->requireBasket(); + $snapshot = BasketSnapshot::load([ + 'basket_uuid' => $basket->get('uuid'), + 'ts_create' => $this->params->getRequired('ts'), + ], $this->db()); + $snapshotUrl = $this->url()->without('type')->without('key')->setPath('director/basket/snapshot'); + $type = $this->params->get('type'); + $key = $this->params->get('key'); + + $this->addTitle($this->translate('Single Object Diff')); + $this->content()->add(Hint::info(Html::sprintf( + $this->translate('Comparing %s "%s" from Snapshot "%s" to current config'), + $type, + $key, + Link::create( + substr(bin2hex($snapshot->get('content_checksum')), 0, 7), + $snapshotUrl, + null, + ['data-base-target' => '_next'] + ) + ))); + $this->actions()->add([ + Link::create( + $this->translate('back'), + $snapshotUrl, + null, + ['class' => 'icon-left-big'] + ), + /* + Link::create( + $this->translate('Restore'), + $this->url()->with('action', 'restore'), + null, + ['class' => 'icon-rewind'] + ) + */ + ]); + $exporter = new Exporter($this->db()); + $json = $snapshot->getJsonDump(); + $this->addSingleTab($this->translate('Snapshot')); + $objects = Json::decode($json); + $targetDbName = $this->params->get('target_db'); + if ($targetDbName === null) { + $connection = $this->db(); + } else { + $connection = Db::fromResourceName($targetDbName); + } + $fieldResolver = new BasketSnapshotFieldResolver($objects, $connection); + $objectFromBasket = $objects->$type->$key; + unset($objectFromBasket->originalId); + CompareBasketObject::normalize($objectFromBasket); + $objectFromBasket = Json::encode($objectFromBasket, JSON_PRETTY_PRINT); + $current = BasketSnapshot::instanceByIdentifier($type, $key, $connection); + if ($current === null) { + $current = ''; + } else { + $exported = $exporter->export($current); + $fieldResolver->tweakTargetIds($exported); + unset($exported->originalId); + CompareBasketObject::normalize($exported); + $current = Json::encode($exported, JSON_PRETTY_PRINT); + } + + if ($current === $objectFromBasket) { + $this->content()->add([ + Hint::ok('Basket equals current object'), + Html::tag('pre', $current) + ]); + } else { + $this->content()->add(new InlineDiff(new PhpDiff($current, $objectFromBasket))); + } + } + + /** + * @return Basket + * @throws \Icinga\Exception\MissingParameterException + * @throws \Icinga\Exception\NotFoundError + */ + protected function requireBasket() + { + return Basket::load($this->params->getRequired('name'), $this->db()); + } +} |