MonitoringConnectionForm.php

<?php

namespace Icinga\Module\Vspheredb\Web\Form;

use gipfl\Web\Form\Decorator\DdDtDecorator;
use gipfl\Web\Widget\Hint;
use Icinga\Application\Config;
use Icinga\Data\Db\DbConnection;
use Icinga\Data\ResourceFactory;
use Icinga\Module\Vspheredb\Db;
use Icinga\Module\Vspheredb\Web\QueryParams;
use Icinga\Web\Notification;
use InvalidArgumentException;
use ipl\I18n\Translation;
use gipfl\Web\Form;
use ipl\Html\FormElement\SubmitElement;
use ipl\Html\Html;
use Ramsey\Uuid\Uuid;

class MonitoringConnectionForm extends Form
{
    use Translation;

    protected $db;
    protected bool $hasBeenDeleted = false;
    protected ?int $id = null;

    public function __construct(Db $connection)
    {
        $this->addElementLoader(__NAMESPACE__ . '\\Element');
        $this->db = $connection->getDbAdapter();
    }

    public function hasBeenDeleted(): bool
    {
        return $this->hasBeenDeleted;
    }

    protected function assemble()
    {
        $this->add(Hint::info($this->translate(
            'The vSphereDB module can hook into the Icinga monitoring module.'
            . ' This allows to show context information related to your Virtualization'
            . ' infrastructure next to each monitored Host.'
        )));

        $this->addElement('select', 'vcenter', [
            'label'    => $this->translate('vCenter'),
            'options'  => $this->optionalEnum($this->enumVCenters()),
            'ignore'   => true,
        ]);

        $this->addElement('select', 'source_type', [
            'label'   => $this->translate('Source Type'),
            'options' => $this->optionalEnum([
                'ido' => $this->translate('IDO'),
                // 'icinga2-api' => $this->translate('Icinga 2 API'),
                'icingadb' => $this->translate('Icinga DB')
            ]),
            'class' => 'autosubmit',
        ]);
        $sourceType = $this->getElement('source_type')->getValue();
        if (! $sourceType) {
            return;
        }

        if ($sourceType === 'icingadb') {
            $this->addElement('select', 'source_resource_name', [
                'label'   => $this->translate('Icinga DB Resource'),
                'options' => $this->optionalEnum($this->enumIcingadbResourceNames()),
                'class'   => 'autosubmit'
            ]);
        } else {
            $this->addElement('select', 'source_resource_name', [
                'label'   => $this->translate('IDO Resource'),
                'options' => $this->optionalEnum($this->enumIdoResourceNames()),
                'class'   => 'autosubmit'
            ]);
        }
        $resourceName = $this->getElement('source_resource_name')->getValue();
        if (! $resourceName) {
            $this->addElement('submit', 'submit', [
                'label' => $this->translate('Next')
            ]);
            return;
        }


        if ($sourceType === 'icingadb') {
            try {
                $resource = ResourceFactory::create($resourceName);
                if ($resource instanceof DbConnection) {
                    $icingadbVars = $this->enumIcingadbCustomVars($resource);
                } else {
                    throw new InvalidArgumentException("Resource '$resourceName' is not a DbConnection");
                }
            } catch (\Exception $e) {
                $this->getElement('source_resource_name')->addMessage($e->getMessage());
                return;
            }

            $varOptions = $this->optionalEnum([
                'name'         => $this->translate('Hostname'),
                'display_name' => $this->translate('Display Name'),
                'address'      => $this->translate('Address v4'),
                'address6'     => $this->translate('Address v6'),
            ] + [$this->translate('Custom Variables') => $icingadbVars]);
        } else {
            try {
                $resource = ResourceFactory::create($resourceName);
                if ($resource instanceof DbConnection) {
                    $idoVars = $this->enumIdoCustomVars($resource);
                } else {
                    throw new InvalidArgumentException("Resource '$resourceName' is not a DbConnection");
                }
            } catch (\Exception $e) {
                $this->getElement('source_resource_name')->addMessage($e->getMessage());
                return;
            }

            $varOptions = $this->optionalEnum([
                'host_name'    => $this->translate('Hostname'),
                'display_name' => $this->translate('Display Name'),
                'address'      => $this->translate('Address'),
            ] + [$this->translate('Custom Variables') => $idoVars]);
        }

        $this->add(Html::tag('h2', $this->translate('Host Systems')));
        $this->add(Html::tag('p', $this->translate(
            'Map monitored hosts to physical Host Systems belonging to your'
            . ' VMware environment'
        )));
        $this->addElement('select', 'host_property', [
            'label'       => $this->translate('Host System Property'),
            'description' => $this->translate(
                'Property of the Host System (known by the vSphereDB module)'
            ),
            'options'     => $this->optionalEnum([
                'host_name'    => $this->translate('Hostname'),
                'object_name'  => $this->translate('Object Name'),
                'sysinfo_uuid' => $this->translate('System (BIOS) UUID'),
                'service_tag'  => $this->translate('IP Address'),
            ]),
        ]);
        $this->addElement('select', 'monitoring_host_property', [
            'label'       => $this->translate('Monitored Host Property'),
            'description' => $this->translate(
                'Property of the Host System (as known by Icinga)'
            ),
            'options'     => $varOptions,
        ]);

        $this->add(Html::tag('h2', $this->translate('Virtual Machines')));
        $this->add(Html::tag('p', $this->translate(
            'Map monitored hosts to Virtual Machines belonging to your'
            . ' VMware environment'
        )));
        $this->addElement('select', 'vm_property', [
            'label'       => $this->translate('Virtual Machine Property'),
            'description' => $this->translate(
                'Property of the Virtual Machine (known by the vSphereDB module)'
            ),
            'options'     => $this->optionalEnum([
                'guest_host_name' => $this->translate('Guest Hostname'),
                'object_name'     => $this->translate('Object Name'),
                'bios_uuid'       => $this->translate('BIOS UUID'),
            ]),
        ]);
        $this->addElement('select', 'monitoring_vm_host_property', [
            'label'       => $this->translate('Monitored Host Property'),
            'description' => $this->translate(
                'Property of the Virtual Machine (as known by Icinga)'
            ),
            'options'     => $varOptions,
        ]);

        $submit = new SubmitElement('submit', [
            'label' => $this->translate('Store')
        ]);
        $this->addElement($submit);

        if ($id = $this->getId()) {
            $delete = new SubmitElement('delete', [
                'label' => $this->translate('Delete')
            ]);
            $deco = $submit->getWrapper();
            assert($deco instanceof DdDtDecorator);
            $deco->dd()->add($delete);
            $this->registerElement($delete);
            if ($delete->hasBeenPressed()) {
                $this->db->delete(
                    'monitoring_connection',
                    $this->db->quoteInto('id = ?', $id)
                );
                Notification::success($this->translate('Monitoring Integration has been deleted'));
                $this->hasBeenDeleted = true;
            }
        }
    }

    public function getId(): ?int
    {
        if ($this->id === null) {
            if ($id = QueryParams::fromRequest($this->getRequest())->get('id')) {
                $this->id = (int) $id;
            }
        }

        return $this->id;
    }

    public function onSuccess()
    {
        $values = $this->getValues();
        $db = $this->db;
        $id = $this->getId();
        $vCenterUuid = $this->getValue('vcenter');
        if ($vCenterUuid === null) {
            $values['vcenter_uuid'] = null;
        } else {
            $values['vcenter_uuid'] = Uuid::fromString($vCenterUuid)->getBytes();
        }
        if ($id) {
            $db->update(
                'monitoring_connection',
                $values,
                $db->quoteInto('id = ?', $id)
            );
            Notification::success($this->translate('Monitoring Integration has been modified'));
        } else {
            $priority = (int) $db->fetchOne(
                $db->select()->from('monitoring_connection', 'MAX(priority)')
            ) + 1;
            $db->insert('monitoring_connection', $values + [
                    'priority'     => $priority,
                ]);
            $this->id = (int) $db->lastInsertId();
            Notification::success($this->translate('Monitoring Integration has been created'));
        }
    }

    protected function enumIcingadbCustomVars(DbConnection $db)
    {
        $dba = $db->getDbAdapter();

        $vars = $dba->fetchPairs(
            $dba->select()->from(
                ['cvs' => 'customvar'],
                [
                    'varname'   => 'cvs.name',
                    'varcount' => 'COUNT(*)'
                ]
            )->join(
                ['o' => 'host_customvar'],
                'o.customvar_id = cvs.id',
                []
            )
                ->group('varname')
                ->order('varname')
        );

        $result = [];
        foreach ($vars as $name => $count) {
            $result["vars.$name"] = "vars.$name ({$count}x)";
        }

        return $result;
    }

    protected function enumIdoCustomVars(DbConnection $db)
    {
        $dba = $db->getDbAdapter();

        $vars = $dba->fetchPairs(
            $dba->select()->from(
                ['cvs' => 'icinga_customvariablestatus'],
                [
                    'varname'   => 'cvs.varname',
                    'varcount' => 'COUNT(*)'
                ]
            )->join(
                ['o' => 'icinga_objects'],
                'o.object_id = cvs.object_id AND o.is_active = 1',
                []
            )
            ->group('varname')
            ->order('varname')
        );

        $result = [];
        foreach ($vars as $name => $count) {
            $result["vars.$name"] = "vars.$name ({$count}x)";
        }

        return $result;
    }

    /**
     * UNUSED
     * @return array
     */
    protected function enumHostParents(): array
    {
        $db = $this->db;
        $query = $db->select()->from(
            ['p' => 'object'],
            ['p.uuid', 'p.object_name']
        )->join(
            ['c' => 'object'],
            'c.parent_uuid = p.uuid AND '
            . $db->quoteInto('c.object_type = ?', 'HostSystem')
            . ' AND '
            . $db->quoteInto('p.object_type = ?', 'ClusterComputeResource'),
            []
        )->group('p.uuid')->order('p.object_name');

        return $this->makeNiceUuidKeys($db->fetchPairs($query));
    }

    protected function enumIcingadbResourceNames(): array
    {
        $resource = Config::module('icingadb')->get('icingadb', 'resource');

        return [$resource ?? '' => $resource];
    }

    protected function enumIdoResourceNames(): array
    {
        $resources = [];
        foreach (Config::module('monitoring', 'backends') as $name => $config) {
            if ((bool) $config->get('disabled', false) === false) {
                $resourceName = $config->get('resource');
                if ($name !== $resourceName) {
                    $name = sprintf('%s (%s)', $name, $resourceName);
                }
                $resources[$resourceName ?? ''] = $name;
            }
        }

        return $resources;
    }

    protected function enumVCenters(): array
    {
        return $this->makeNiceUuidKeys($this->db->fetchPairs(
            $this->db->select()->from(['vc' => 'vcenter'], [
                'uuid' => 'vc.instance_uuid',
                'name' => 'vc.name',
            ])->order('vc.name')
        ));
    }

    protected function makeNiceUuidKeys(array $enum): array
    {
        $result = [];
        foreach ($enum as $k => $v) {
            $result[Uuid::fromBytes($k)->toString()] = $v;
        }

        return $result;
    }

    protected function optionalEnum($values): array
    {
        return ['' => $this->translate('- please choose -')] + $values;
    }
}