class.CustomIconUploadHandlerGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\ILIASObject\Properties\UploadSecurityFunctionsTrait;
use ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Custom;
use ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Icon;
use ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler;
use ILIAS\FileUpload\Handler\BasicFileInfoResult;
use ILIAS\FileUpload\Handler\BasicHandlerResult;
use ILIAS\FileUpload\Handler\FileInfoResult;
use ILIAS\FileUpload\Handler\HandlerResult;
use ILIAS\FileUpload\DTO\UploadResult;
use ILIAS\FileUpload\MimeType;

class CustomIconUploadHandlerGUI extends AbstractCtrlAwareUploadHandler implements \ilCtrlBaseClassInterface
{
    use UploadSecurityFunctionsTrait;

    protected \ilLanguage $language;
    protected bool $has_access = false;

    public function __construct(
        protected ?Custom $custom_icon = null
    ) {
        global $DIC;
        $this->language = $DIC->language();

        $ref_id = null;
        if ($DIC->http()->wrapper()->query()->has('ref_id')) {
            $transformation = $DIC->refinery()->kindlyTo()->int();
            $ref_id = $DIC->http()->wrapper()->query()->retrieve('ref_id', $transformation);
        }

        $this->has_access = $this->getAccess(
            $ref_id,
            $DIC->access()
        );

        $DIC->ctrl()->setParameterByClass(self::class, 'ref_id', $ref_id);

        parent::__construct();
    }

    protected function getUploadResult(): HandlerResult
    {
        $tempfile = '';
        if ($this->has_access === false) {
            return $this->getAccessFailureResult(
                $this->getFileIdentifierParameterName(),
                $tempfile,
                $this->language
            );
        }

        $this->upload->process();

        $result_array = $this->upload->getResults();
        $result = end($result_array);

        if ($result instanceof UploadResult
            && in_array($result->getMimeType(), Icon::SUPPORTED_MIME_TYPES)
            && $result->isOK()) {
            $status = HandlerResult::STATUS_OK;
            $message = 'Upload ok';
            $tempfile = \ilFileUtils::ilTempnam();
            rename($result->getPath(), $tempfile);
        } else {
            $status = HandlerResult::STATUS_FAILED;
            $message = $result->getStatus()->getMessage();
        }

        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            $status,
            basename($tempfile),
            $message
        );
    }

    protected function getRemoveResult(string $file_name): HandlerResult
    {
        if ($this->has_access === false) {
            return $this->getAccessFailureResult(
                $this->getFileIdentifierParameterName(),
                $file_name,
                $this->language
            );
        }

        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            HandlerResult::STATUS_OK,
            $file_name,
            'There is nothing to do here.'
        );
    }

    public function getInfoResult(string $file_name): ?FileInfoResult
    {
        if ($this->has_access === false) {
            return null;
        }

        $file_path = $this->custom_icon->getFullPath();

        return new BasicFileInfoResult(
            $this->getFileIdentifierParameterName(),
            'custom_icon',
            $this->language->txt('custom_icon'),
            filesize($file_path),
            MimeType::IMAGE__SVG_XML
        );
    }

    public function getInfoForExistingFiles(array $file_names): array
    {
        return [$this->getInfoResult('custom_icon')];
    }
}