class.ilCertificateSettingsFormRepository.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Exception\FileAlreadyExistsException;
use ILIAS\Filesystem\Exception\FileNotFoundException;
use ILIAS\Filesystem\Exception\IOException;
use ILIAS\Filesystem\Filesystem;
use ILIAS\HTTP\Wrapper\WrapperFactory;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ResourceStorage\Services as IRSS;
use ILIAS\UI\Factory as UiFactory;
use ILIAS\UI\Renderer as UiRenderer;
use ILIAS\ResourceStorage\Flavour\Definition\FitToSquare;

class ilCertificateSettingsFormRepository implements ilCertificateFormRepository
{
    private readonly UiFactory $ui_factory;
    private readonly ilPageFormats $pageFormats;
    private readonly ilCertificateTemplateImportAction $importAction;
    private readonly ilCertificateTemplateRepository $templateRepository;
    private readonly WrapperFactory $httpWrapper;
    private readonly Refinery $refinery;
    private readonly ilObjCertificateSettings $global_certificate_settings;
    private IRSS $irss;
    private Filesystem $filesystem;
    private readonly ilGlobalTemplateInterface $page_template;
    private readonly FitToSquare $tile_image_definition;

    public function __construct(
        private readonly int $objectId,
        string $certificatePath,
        private readonly bool $hasAdditionalElements,
        private readonly ilLanguage $language,
        private readonly ilCtrlInterface $ctrl,
        private readonly ilAccessHandler $access,
        private readonly ilToolbarGUI $toolbar,
        private readonly ilCertificatePlaceholderDescription $placeholderDescriptionObject,
        ?UiFactory $ui_factory = null,
        ?UiRenderer $ui_renderer = null,
        ?ilPageFormats $pageFormats = null,
        private readonly ilFormFieldParser $formFieldParser = new ilFormFieldParser(),
        ?ilCertificateTemplateImportAction $importAction = null,
        ?ilLogger $logger = null,
        ?ilCertificateTemplateRepository $templateRepository = null,
        ?Filesystem $filesystem = null
    ) {
        global $DIC;

        $this->httpWrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
        $this->page_template = $DIC->ui()->mainTemplate();

        $this->ui_factory = $ui_factory ?? $DIC->ui()->factory();

        $this->irss = $DIC->resourceStorage();
        $this->filesystem = $filesystem ?? $DIC->filesystem()->web();

        $this->pageFormats = $pageFormats ?? new ilPageFormats($language);
        $this->importAction = $importAction ?? new ilCertificateTemplateImportAction(
            $objectId,
            $certificatePath,
            $placeholderDescriptionObject,
            $logger ?? $DIC->logger()->cert(),
            $this->filesystem,
            $this->irss
        );
        $this->templateRepository = $templateRepository ?? new ilCertificateTemplateDatabaseRepository(
            $DIC->database(),
            $logger ?? $DIC->logger()->cert()
        );
        $this->tile_image_definition = new FitToSquare(
            true,
            100
        );
        $this->global_certificate_settings = new ilObjCertificateSettings();
    }

    public function createForm(ilCertificateGUI $certificateGUI): ilPropertyFormGUI
    {
        $certificateTemplate = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);

        $command = $this->ctrl->getCmd() ?? '';

        $form = new ilPropertyFormGUI();
        $form->setPreventDoubleSubmission(false);
        $form->setFormAction($this->ctrl->getFormAction($certificateGUI));
        $form->setTitle($this->language->txt('cert_form_sec_availability'));
        $form->setMultipart(true);
        $form->setTableWidth('100%');
        $form->setId('certificate');

        $active = new ilCheckboxInputGUI($this->language->txt('active'), 'active');
        $form->addItem($active);

        $import = new ilFileInputGUI($this->language->txt('import'), 'certificate_import');
        $import->setRequired(false);
        $import->setSuffixes(['zip']);

        // handle the certificate import
        if (!empty($_FILES['certificate_import']['name']) && $import->checkInput()) {
            $result = $this->importAction->import(
                $_FILES['certificate_import']['tmp_name'],
                $_FILES['certificate_import']['name']
            );
            if ($result) {
                $this->page_template->setOnScreenMessage(
                    $this->page_template::MESSAGE_TYPE_SUCCESS,
                    $this->language->txt('saved_successfully'),
                    true
                );
                $this->ctrl->redirect($certificateGUI, 'certificateEditor');
            } else {
                $this->page_template->setOnScreenMessage(
                    $this->page_template::MESSAGE_TYPE_FAILURE,
                    $this->language->txt('certificate_error_import'),
                    true
                );
                $this->ctrl->redirect($certificateGUI, 'certificateEditor');
            }
        }
        $form->addItem($import);

        $formSection = new ilFormSectionHeaderGUI();
        $formSection->setTitle($this->language->txt('cert_form_sec_layout'));
        $form->addItem($formSection);

        $pageformat = new ilRadioGroupInputGUI($this->language->txt('certificate_page_format'), 'pageformat');
        $pageformats = $this->pageFormats->fetchPageFormats();

        foreach ($pageformats as $format) {
            $option = new ilRadioOption($format['name'], $format['value']);

            if (strcmp($format['value'], 'custom') === 0) {
                $pageheight = new ilTextInputGUI($this->language->txt('certificate_pageheight'), 'pageheight');
                $pageheight->setSize(6);
                $pageheight->setValidationRegexp(
                    '/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*)))(cm|mm|in|pt|pc|px|em)$/is'
                );
                $pageheight->setInfo($this->language->txt('certificate_unit_description'));
                $pageheight->setRequired(true);
                $option->addSubItem($pageheight);

                $pagewidth = new ilTextInputGUI($this->language->txt('certificate_pagewidth'), 'pagewidth');
                $pagewidth->setSize(6);
                $pagewidth->setValidationRegexp(
                    '/^(([1-9]+|([1-9]+[0]*[\.,]{0,1}[\d]+))|(0[\.,](0*[1-9]+[\d]*)))(cm|mm|in|pt|pc|px|em)$/is'
                );
                $pagewidth->setInfo($this->language->txt('certificate_unit_description'));
                $pagewidth->setRequired(true);
                $option->addSubItem($pagewidth);
            }

            $pageformat->addOption($option);
        }

        $pageformat->setRequired(true);

        if (strcmp($command, 'certificateSave') === 0) {
            $pageformat->checkInput();
        }

        $form->addItem($pageformat);

        $bgimage = new ilImageFileInputGUI($this->language->txt('certificate_background_image'), 'background');
        $bgimage->setRequired(false);
        $bgimage->setUseCache(false);

        $bgimage->setAllowDeletion(true);
        $bg_image_rid = $certificateTemplate->getBackgroundImageIdentification();
        $bg_image_path = $certificateTemplate->getBackgroundImagePath();
        if (
            (
                $this->global_certificate_settings->getBackgroundImageIdentification() instanceof ResourceIdentification &&
                $bg_image_rid === $this->global_certificate_settings->getBackgroundImageIdentification()->serialize()
            ) ||
            !$certificateTemplate->getBackgroundImageIdentification() ||
            !$this->irss->manage()->find(
                $certificateTemplate->getBackgroundImageIdentification()
            ) instanceof ResourceIdentification
        ) {
            $identification = $this->global_certificate_settings->getBackgroundImageIdentification();
            $bgimage->setAllowDeletion(false);
        } else {
            $identification = $this->irss->manage()->find($bg_image_rid);
        }
        if ($identification instanceof ResourceIdentification) {
            $background_flavour = $this->irss->flavours()->get(
                $identification,
                $this->tile_image_definition
            );
            $flavour_urls = $this->irss->consume()->flavourUrls($background_flavour);
            foreach ($flavour_urls->getURLs(true) as $url) {
                $bgimage->setImage($url);
            }
        } elseif ($bg_image_path !== '' && $this->filesystem->has($bg_image_path)) {
            $bgimage->setImage(
                ilWACSignedPath::signFile(
                    ILIAS_HTTP_PATH . '/' . ILIAS_WEB_DIR . '/' . CLIENT_ID . $bg_image_path
                )
            );
        }

        $form->addItem($bgimage);

        $tile_image = new ilImageFileInputGUI(
            $this->language->txt('certificate_card_tile_image'),
            'certificate_card_tile_image'
        );
        $tile_image->setRequired(false);
        $tile_image->setUseCache(false);
        $tile_image->setSuffixes(['svg']);

        $allow_tile_image_deletion = false;

        $tile_image_identification = $certificateTemplate->getTileImageIdentification();
        $old_tile_image_path = $certificateTemplate->getTileImagePath();
        if ('' !== $tile_image_identification) {
            $identification = $this->irss->manage()->find($tile_image_identification);
            if ($identification instanceof ResourceIdentification) {
                $tile_image->setImage($this->irss->consume()->src($identification)->getSrc(true));
                $allow_tile_image_deletion = true;
            }
        } elseif ($old_tile_image_path !== '' && $this->filesystem->has($old_tile_image_path)) {
            $tile_image->setImage(
                ilWACSignedPath::signFile(
                    ILIAS_HTTP_PATH . '/' . ILIAS_WEB_DIR . '/' . CLIENT_ID . $old_tile_image_path
                )
            );
            $allow_tile_image_deletion = true;
        }

        $tile_image->setAllowDeletion($allow_tile_image_deletion);

        $form->addItem($tile_image);

        $rect = new ilCSSRectInputGUI($this->language->txt('certificate_margin_body'), 'margin_body');
        $rect->setRequired(true);
        $rect->setUseUnits(true);
        $rect->setInfo($this->language->txt('certificate_unit_description'));

        if (strcmp($command, 'certificateSave') === 0) {
            $rect->checkInput();
        }

        $form->addItem($rect);

        $certificate = new ilTextAreaInputGUI($this->language->txt('certificate_text'), 'certificate_text');
        $certificate->setRequired(true);
        $certificate->setRows(20);
        $certificate->setCols(80);

        $certificate->setInfo(
            $this->language->txt('certificate_text_info') . $this->placeholderDescriptionObject->createPlaceholderHtmlDescription()
        );

        $certificate->setUseRte(true, '3.4.7');

        $tags = [
            'br',
            'em',
            'font',
            'li',
            'ol',
            'p',
            'span',
            'strong',
            'u',
            'ul'
        ];

        $certificate->setRteTags($tags);

        if (strcmp($command, 'certificateSave') === 0) {
            $certificate->checkInput();
        }

        $form->addItem($certificate);

        if ($this->hasAdditionalElements) {
            $formSection = new ilFormSectionHeaderGUI();
            $formSection->setTitle($this->language->txt('cert_form_sec_add_features'));
            $form->addItem($formSection);
        }

        if ($this->access->checkAccess(
            'write',
            '',
            $this->httpWrapper->query()->retrieve('ref_id', $this->refinery->kindlyTo()->int())
        )) {
            if ($certificateTemplate->isCurrentlyActive()) {
                $preview_button = $this->ui_factory->button()->standard(
                    $this->language->txt('certificate_preview'),
                    $this->ctrl->getLinkTarget($certificateGUI, 'certificatePreview')
                );
                $export_button = $this->ui_factory->button()->standard(
                    $this->language->txt('certificate_export'),
                    $this->ctrl->getLinkTarget($certificateGUI, 'certificateExportFO')
                );
                $delete_button = $this->ui_factory->button()->standard(
                    $this->language->txt('delete'),
                    $this->ctrl->getLinkTarget($certificateGUI, 'certificateDelete')
                );

                $this->toolbar->addStickyItem($preview_button);
                $this->toolbar->addComponent($export_button);
                $this->toolbar->addComponent($delete_button);
            }
            $form->addCommandButton('certificateSave', $this->language->txt('save'));
        }

        return $form;
    }

    public function save(array $formFields): void
    {
    }

    public function fetchFormFieldData(string $content): array
    {
        return $this->formFieldParser->fetchDefaultFormFields($content);
    }
}