class.ilChatroomAuthInputGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\HTTP\Response\ResponseHeader;
 
class ilChatroomAuthInputGUI extends ilSubEnabledFormPropertyGUI
{
    private const string NAME_AUTH_PROP_1 = 'key';
    private const string NAME_AUTH_PROP_2 = 'secret';
    private const array DEFAULT_SHAPE = [
        self::NAME_AUTH_PROP_1 => '',
        self::NAME_AUTH_PROP_2 => ''
    ];
    protected array $ctrl_path = [];
    protected int $size = 10;
    protected array $values = self::DEFAULT_SHAPE;
    protected bool $isReadOnly = false;
 
    public function __construct(string $title, string $httpPostVariableName, protected \ILIAS\HTTP\Services $http)
    {
        parent::__construct($title, $httpPostVariableName);
    }
 
    public function setIsReadOnly(bool $isReadOnly): void
    {
        $this->isReadOnly = $isReadOnly;
    }
 
    protected function getRandomValues(): void
    {
        $response = new stdClass();
 
        $response->{self::NAME_AUTH_PROP_1} = $this->uuidV4();
        $response->{self::NAME_AUTH_PROP_2} = $this->uuidV4();
 
        $responseStream = \ILIAS\Filesystem\Stream\Streams::ofString(json_encode($response, JSON_THROW_ON_ERROR));
        $this->http->saveResponse(
            $this->http->response()
                ->withBody($responseStream)
                ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
        );
        $this->http->sendResponse();
        $this->http->close();
    }
 
    private function uuidV4(): string
    {
        return sprintf(
            '%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
            // 32 bits for "time_low"
            random_int(0, 0xffff),
            random_int(0, 0xffff),
            // 16 bits for "time_mid"
            random_int(0, 0xffff),
            // 16 bits for "time_high_and_version",
            // four most significant bits holds version number 4
            random_int(0, 0x0fff) | 0x4000,
            // 16 bits, 8 bits for "clk_seq_hi_res",
            // 8 bits for "clk_seq_low",
            // two most significant bits holds zero and one for variant DCE1.1
            random_int(0, 0x3fff) | 0x8000,
            // 48 bits for "node"
            random_int(0, 0xffff),
            random_int(0, 0xffff),
            random_int(0, 0xffff)
        );
    }
 
    public function setCtrlPath(array $ctrl_path): void
    {
        $this->ctrl_path = $ctrl_path;
    }
 
    public function setValueByArray(array $a_values): void
    {
        $this->values = [
            self::NAME_AUTH_PROP_1 => $a_values[$this->getPostVar()][self::NAME_AUTH_PROP_1] ?? '',
            self::NAME_AUTH_PROP_2 => $a_values[$this->getPostVar()][self::NAME_AUTH_PROP_2] ?? ''
        ];
 
        foreach ($this->getSubItems() as $item) {
            $item->setValueByArray($a_values);
        }
    }
 
    public function checkInput(): bool
    {
        $post = $this->http->request()->getParsedBody()[$this->getPostVar()] ?? [];
 
        if ($this->getRequired() && 2 > count(array_filter(array_map('trim', $post)))) {
            $this->setAlert($this->lng->txt('msg_input_is_required'));
            return false;
        }
 
        return $this->checkSubItemsInput();
    }
 
    public function getInput(): array
    {
        $input = self::DEFAULT_SHAPE;
 
        $as_sanizited_string = $this->refinery->custom()->transformation(function (string $value): string {
            return $this->stripSlashesAddSpaceFallback($value);
        });
 
        $null_to_empty_string = $this->refinery->custom()->transformation(static function ($value): string {
            if ($value === null) {
                return '';
            }
 
            throw new ilException('Expected null in transformation');
        });
 
        $sanizite_as_string = $this->refinery->in()->series([
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $null_to_empty_string
            ]),
            $as_sanizited_string
        ]);
 
        if ($this->http->wrapper()->post()->has($this->getPostVar())) {
            $input = $this->http->wrapper()->post()->retrieve(
                $this->getPostVar(),
                $this->refinery->kindlyTo()->recordOf([
                    self::NAME_AUTH_PROP_1 => $sanizite_as_string,
                    self::NAME_AUTH_PROP_2 => $sanizite_as_string
                ])
            );
        }
 
        return $input;
    }
 
    public function insert(ilTemplate $a_tpl): void
    {
        $a_tpl->setCurrentBlock('prop_generic');
        $a_tpl->setVariable('PROP_GENERIC', $this->render());
        $a_tpl->parseCurrentBlock();
    }
 
    public function render(): string
    {
        global $DIC;
 
        $tpl = new ilTemplate('tpl.chatroom_auth_input.html', true, true, 'components/ILIAS/Chatroom');
 
        for ($i = 1, $iMax = count($this->values); $i <= $iMax; $i++) {
            $const = 'NAME_AUTH_PROP_' . $i;
            $const_val = constant('self::' . $const);
 
            $tpl->setVariable('TXT_AUTH_PROP_' . $i, $DIC->language()->txt('chatroom_auth_' . $const_val));
            $tpl->setVariable('ID_AUTH_PROP_' . $i, $const_val);
            $tpl->setVariable('NAME_AUTH_PROP_' . $i, $const_val);
            $tpl->setVariable('VALUE_AUTH_PROP_' . $i, $this->values[$const_val]);
        }
 
        if (!$this->isReadOnly && !$this->getDisabled()) {
            for ($i = 1, $iMax = count($this->values); $i <= $iMax; $i++) {
                $const = 'NAME_AUTH_PROP_' . $i;
                $const_val = constant('self::' . $const);
 
                $tpl->setVariable('ID_AUTH_PROP_' . $i . '_BTN', $const_val);
            }
 
            $DIC->ctrl()->setParameterByClass('ilformpropertydispatchgui', 'postvar', $this->getPostVar());
            $tpl->setVariable(
                'URL',
                $DIC->ctrl()->getLinkTargetByClass($this->ctrl_path, 'getRandomValues', '', true)
            );
            $tpl->setVariable('ID_BTN', $this->getFieldId() . '_btn');
            $tpl->setVariable('TXT_BTN', $DIC->language()->txt('chatroom_auth_btn_txt'));
        }
 
        $tpl->setVariable('POST_VAR', $this->getPostVar());
        $tpl->setVariable('SIZE', $this->getSize());
 
        if ($this->getDisabled()) {
            $tpl->setVariable('DISABLED', ' disabled="disabled"');
        }
 
        return $tpl->get();
    }
 
    public function getSize(): int
    {
        return $this->size;
    }
 
    public function setSize(int $size): void
    {
        $this->size = $size;
    }
}