class.ilCertificateGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Refinery\Factory;
use ILIAS\Filesystem\Filesystem;
use ILIAS\FileUpload\FileUpload;
use ILIAS\HTTP\Wrapper\WrapperFactory;
use ILIAS\Filesystem\Exception\IOException;
use ILIAS\ResourceStorage\Services as IRSS;
use ILIAS\Certificate\CertificateResourceHandler;
use ILIAS\Filesystem\Exception\FileNotFoundException;
use ILIAS\Filesystem\Exception\FileAlreadyExistsException;
use ILIAS\Certificate\File\ilCertificateTemplateStakeholder;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;

class ilCertificateGUI
{
    protected ilCtrlInterface $ctrl;
    protected ilTree $tree;
    protected ILIAS $ilias;
    protected ilGlobalPageTemplate $tpl;
    protected ilLanguage $lng;
    protected int $ref_id;
    protected ilAccessHandler $access;
    protected ilToolbarGUI $toolbar;
    private readonly WrapperFactory $httpWrapper;
    private readonly Factory $refinery;
    private IRSS $irss;
    private ilCertificateTemplateStakeholder $stakeholder;
    private ilCertificateTemplateDatabaseRepository $certificate_repo;
    private readonly ilCertificateTemplateRepository $templateRepository;
    private readonly ilCertificateFormRepository $settingsFormFactory;
    private readonly ilXlsFoParser $xlsFoParser;
    private readonly ilCertificateDeleteAction $deleteAction;
    private readonly ilCertificateTemplateExportAction $exportAction;
    private readonly ilCertificateTemplatePreviewAction $previewAction;
    private readonly FileUpload $fileUpload;
    private readonly Filesystem $file_system;
    private readonly string $certificatePath;
    private readonly ilPageFormats $pageFormats;
    private readonly ilLogger $logger;
    private readonly ilObjCertificateSettings $global_certificate_settings;
    private readonly ilDBInterface $database;

    public function __construct(
        private readonly ilCertificatePlaceholderDescription $placeholderDescriptionObject,
        ilCertificatePlaceholderValues $placeholderValuesObject,
        private readonly int $objectId,
        string $certificatePath,
        ?ilCertificateFormRepository $settingsFormFactory = null,
        ?ilCertificateDeleteAction $deleteAction = null,
        ?ilCertificateTemplateRepository $templateRepository = null,
        ?ilPageFormats $pageFormats = null,
        ?ilXlsFoParser $xlsFoParser = null,
        ?ilCertificateTemplateExportAction $exportAction = null,
        ?ilCertificateTemplatePreviewAction $previewAction = null,
        ?FileUpload $fileUpload = null,
        private readonly ilSetting $settings = new ilSetting('certificate'),
        ?Filesystem $file_system = null,
        ?Filesystem $tmp_file_system = null
    ) {
        global $DIC;

        $this->httpWrapper = $DIC->http()->wrapper();
        $this->refinery = $DIC->refinery();
        $this->lng = $DIC['lng'];
        $this->tpl = $DIC['tpl'];
        $this->ctrl = $DIC['ilCtrl'];
        $this->ilias = $DIC['ilias'];

        $this->irss = $DIC->resourceStorage();
        $this->stakeholder = new ilCertificateTemplateStakeholder($this->objectId);

        $this->tree = $DIC['tree'];
        $this->access = $DIC['ilAccess'];
        $this->toolbar = $DIC['ilToolbar'];

        $this->global_certificate_settings = new ilObjCertificateSettings();
        $this->lng->loadLanguageModule('certificate');
        $this->lng->loadLanguageModule('cert');
        $this->lng->loadLanguageModule('trac');

        $this->ref_id = (int) $DIC->http()->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int());

        $this->logger = $DIC->logger()->cert();

        $this->settingsFormFactory = $settingsFormFactory ?? new ilCertificateSettingsFormRepository(
            $this->objectId,
            $certificatePath,
            $this->lng,
            $this->tpl,
            $this->ctrl,
            $this->access,
            $this->toolbar,
            $placeholderDescriptionObject,
            $DIC->ui()->factory(),
            $DIC->ui()->renderer()
        );
        $this->templateRepository = $templateRepository ?? new ilCertificateTemplateDatabaseRepository(
            $DIC->database(),
            $this->logger
        );
        $this->deleteAction = $deleteAction ?? new ilCertificateTemplateDeleteAction($this->templateRepository);
        $this->pageFormats = $pageFormats ?? new ilPageFormats($DIC->language());
        $this->xlsFoParser = $xlsFoParser ?? new ilXlsFoParser($DIC->settings(), $this->pageFormats);
        $this->exportAction = $exportAction ?? new ilCertificateTemplateExportAction(
            $this->objectId,
            $certificatePath,
            $this->templateRepository,
            $this->irss
        );
        $this->previewAction = $previewAction ?? new ilCertificateTemplatePreviewAction(
            $this->templateRepository,
            $placeholderValuesObject,
            $this->irss
        );
        $this->fileUpload = $fileUpload ?? $DIC->upload();
        $this->file_system = $file_system ?? $DIC->filesystem()->web();
        $this->database = $DIC->database();
    }

    public function executeCommand()
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);

        $ret = null;

        $cmd = $this->getCommand($cmd);
        switch ($next_class) {
            case 'ilpropertyformgui':
                $form = $this->getEditorForm();
                $this->ctrl->forwardCommand($form);

                break;
            default:
                $ret = $this->$cmd();

                break;
        }

        return $ret;
    }

    public function getCommand($cmd)
    {
        return $cmd;
    }

    public function certificateImport(): void
    {
        $this->certificateEditor();
    }

    public function certificatePreview(): void
    {
        try {
            $this->previewAction->createPreviewPdf($this->objectId);
        } catch (Exception) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('error_creating_certificate_pdf'));
            $this->certificateEditor();
        }
    }

    public function certificateExportFO(): void
    {
        $this->exportAction->export();
    }

    public function certificateDelete(): void
    {
        // display confirmation message
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($this->ctrl->getFormAction($this, 'certificateEditor'));
        $cgui->setHeaderText($this->lng->txt('certificate_confirm_deletion_text'));
        $cgui->setCancel($this->lng->txt('no'), 'certificateEditor');
        $cgui->setConfirm($this->lng->txt('yes'), 'certificateDeleteConfirm');

        $this->tpl->setContent($cgui->getHTML());
    }

    public function certificateDeleteConfirm(): void
    {
        $template = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);
        $templateId = $template->getId();

        $this->deleteAction->delete($templateId, $this->objectId);
        $this->ctrl->redirect($this, 'certificateEditor');
    }

    public function certificateSave(): void
    {
        global $DIC;

        $form = $this->settingsFormFactory->createForm(
            $this
        );

        $form->setValuesByPost();

        $request = $DIC->http()->request();

        $formFields = $request->getParsedBody();

        $this->tpl->setVariable('ADM_CONTENT', $form->getHTML());

        $this->saveCertificate($form, $formFields, $this->objectId);
    }

    public function certificateUpload(): void
    {
        $this->certificateEditor();
    }

    public function certificateEditor(): void
    {
        $form = $this->getEditorForm();
        $enabledGlobalLearningProgress = ilObjUserTracking::_enabledLearningProgress();

        $messageBoxHtml = '';
        if ($enabledGlobalLearningProgress) {
            $objectLearningProgressSettings = new ilLPObjSettings($this->objectId);
            $mode = $objectLearningProgressSettings->getMode();

            $object = ilObjectFactory::getInstanceByObjId($this->objectId);
            if (ilLPObjSettings::LP_MODE_DEACTIVATED === $mode && $object->getType() !== 'crs') {
                global $DIC;

                $renderer = $DIC->ui()->renderer();
                $messageBox = $DIC->ui()
                    ->factory()
                    ->messageBox()
                    ->info($this->lng->txt('learning_progress_deactivated'))
                ;

                $messageBoxHtml = $renderer->render($messageBox);
                $form->clearCommandButtons();
            }
        }

        $formHtml = $form->getHTML();

        $this->tpl->setVariable('ADM_CONTENT', $messageBoxHtml . $formHtml);
    }

    private function getEditorForm(): ilPropertyFormGUI
    {
        $certificateTemplate = $this->templateRepository->fetchCurrentlyUsedCertificate($this->objectId);

        $form = $this->settingsFormFactory->createForm(
            $this
        );

        $formFields = $this->createFormatArray($certificateTemplate);

        $formFields['active'] = $certificateTemplate->isCurrentlyActive();

        $form->setValuesByArray($formFields);

        return $form;
    }

    private function saveCertificate(ilPropertyFormGUI $form, array $form_fields, int $objId): void
    {
        $certificate_handler = new CertificateResourceHandler(
            new ilUserCertificateRepository($this->database),
            new ilCertificateTemplateDatabaseRepository($this->database),
            $this->irss,
            $this->global_certificate_settings,
            $this->stakeholder,
        );
        $current_template = $this->templateRepository->fetchPreviousCertificate($objId);
        $currentVersion = $current_template->getVersion();
        $nextVersion = $currentVersion + 1;
        $current_background_rid = $this->irss->manageContainer()->find(
            $current_template->getBackgroundImageIdentification()
        );
        $current_tile_image_rid = $this->irss->manageContainer()->find(
            $current_template->getTileImageIdentification()
        );
        $old_background_image = $current_background_rid === null
            ? $current_template->getBackgroundImagePath() :
            '';
        $old_tile_image = $current_tile_image_rid === null
            ? $current_template->getTileImagePath() :
            '';

        $should_delete_background =
            $this->httpWrapper->post()->retrieve(
                'background_delete',
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->bool(),
                    $this->refinery->always(false)
                ])
            );
        $should_delete_tile_image =
            $this->httpWrapper->post()->retrieve(
                'certificate_card_tile_image_delete',
                $this->refinery->byTrying([
                    $this->refinery->kindlyTo()->bool(),
                    $this->refinery->always(false)
                ])
            );

        $new_background_rid = $current_background_rid && !$should_delete_background ? $current_background_rid :
            $this->global_certificate_settings->getBackgroundImageIdentification();
        if (
            is_string($new_background_rid) &&
            is_string($this->global_certificate_settings->getBackgroundImageIdentification()) &&
            $new_background_rid === $this->global_certificate_settings->getBackgroundImageIdentification()
        ) {
            if ($this->file_system->has($new_background_rid)) {
                $new_background_rid = $this->irss->manage()->stream(
                    $this->file_system->readStream($new_background_rid),
                    $this->stakeholder
                );
            } else {
                $old_background_image = $new_background_rid;
                $new_background_rid = null;
            }
        }

        $new_tile_rid = !$should_delete_tile_image ? $current_tile_image_rid : null;
        if ($form->checkInput()) {
            try {
                $this->settingsFormFactory->save($form_fields);

                $templateValues = $this->placeholderDescriptionObject->getPlaceholderDescriptions();

                if ($this->fileUpload->hasUploads()) {
                    if (!$this->fileUpload->hasBeenProcessed()) {
                        $this->fileUpload->process();
                    }
                    $new_background = $form->getInput('background')['tmp_name'] ?? '';
                    $new_tile_image = $form->getInput('certificate_card_tile_image')['tmp_name'] ?? '';
                    $results = $this->fileUpload->getResults();

                    if ($new_background !== '') {
                        $new_background_rid = $this->irss->manage()->upload(
                            $results[$new_background],
                            $this->stakeholder
                        );
                    }

                    if ($new_tile_image !== '') {
                        $new_tile_rid = $this->irss->manage()->upload(
                            $results[$new_tile_image],
                            $this->stakeholder
                        );
                    }
                }

                $jsonEncodedTemplateValues = json_encode($templateValues, JSON_THROW_ON_ERROR);

                if (isset($new_background_rid)) {
                    $old_background_image = '';
                }
                if (isset($new_tile_rid)) {
                    $old_tile_image = '';
                }

                $xslfo = $this->xlsFoParser->parse($form_fields);
                $newHashValue = hash(
                    'sha256',
                    implode('', [
                        $xslfo,
                        isset($new_background_rid) ? $new_background_rid->serialize() : '',
                        $jsonEncodedTemplateValues,
                        isset($new_tile_rid) ? $new_background_rid->serialize() : '',
                        $old_background_image, $old_tile_image
                    ])
                );

                $active = (bool) ($form_fields['active'] ?? false);

                if ($newHashValue !== $current_template->getCertificateHash()) {
                    $certificateTemplate = new ilCertificateTemplate(
                        $objId,
                        ilObject::_lookupType($objId),
                        $xslfo,
                        $newHashValue,
                        $jsonEncodedTemplateValues,
                        $nextVersion,
                        ILIAS_VERSION_NUMERIC,
                        time(),
                        $active,
                        $old_background_image,
                        $old_tile_image,
                        isset($new_background_rid) ? $new_background_rid->serialize() : '',
                        isset($new_tile_rid) ? $new_tile_rid->serialize() : '',
                    );
                    $this->templateRepository->save($certificateTemplate);

                    if ($current_background_rid instanceof ResourceIdentification) {
                        $certificate_handler->handleResourceChange($current_background_rid);
                    }
                    if ($current_tile_image_rid instanceof ResourceIdentification) {
                        $certificate_handler->handleResourceChange($current_tile_image_rid);
                    }

                    $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
                    $this->ctrl->redirect($this, 'certificateEditor');
                }

                if (
                    $current_template->getId() !== null &&
                    $current_template->isCurrentlyActive() !== $active
                ) {
                    $this->templateRepository->updateActivity($current_template, $active);
                    $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_change_active_status'), true);
                    $this->ctrl->redirect($this, 'certificateEditor');
                }

                $this->tpl->setOnScreenMessage('info', $this->lng->txt('certificate_same_not_saved'), true);
                $this->ctrl->redirect($this, 'certificateEditor');
            } catch (Exception $e) {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $e->getMessage()
                );
                $this->logger->error($e->getTraceAsString());
            }
        }

        $form->setValuesByPost();

        $this->tpl->setVariable('ADM_CONTENT', $form->getHTML());
    }

    private function createFormatArray(ilCertificateTemplate $certificateTemplate): array
    {
        if ('' === $certificateTemplate->getCertificateHash()) {
            $format = $this->settings->get('pageformat', '');
            $formats = $this->pageFormats->fetchPageFormats();

            return [
                'pageformat' => $format,
                'pagewidth' => $formats['width'] ?? '',
                'pageheight' => $formats['height'] ?? '',
                'margin_body_top' => ilPageFormats::DEFAULT_MARGIN_BODY_TOP,
                'margin_body_right' => ilPageFormats::DEFAULT_MARGIN_BODY_RIGHT,
                'margin_body_bottom' => ilPageFormats::DEFAULT_MARGIN_BODY_BOTTOM,
                'margin_body_left' => ilPageFormats::DEFAULT_MARGIN_BODY_LEFT,
                'certificate_text' => $certificateTemplate->getCertificateContent()
            ];
        }

        return $this->settingsFormFactory->fetchFormFieldData($certificateTemplate->getCertificateContent());
    }
}