File.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\UI\Implementation\Component\Input\Field;

use ILIAS\UI\Implementation\Component\Input\UploadLimitResolver;
use ILIAS\UI\Component\Input\Field\UploadHandler;
use ILIAS\UI\Component\Input\Field\FileUpload;
use ILIAS\UI\Component\Input\Container\Form\FormInput;
use ILIAS\Data\Factory as DataFactory;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\UI\Component as C;
use ILIAS\Refinery\Constraint;
use Closure;
use ilLanguage;

class File extends HasDynamicInputsBase implements C\Input\Field\File
{
    // ===============================================
    // BEGIN IMPLEMENTATION OF FileUpload
    // ===============================================

    protected UploadLimitResolver $upload_limit_resolver;
    protected UploadHandler $upload_handler;
    protected array $accepted_mime_types = [];
    protected bool $has_metadata_inputs = false;
    protected int $max_file_amount = 1;
    protected int $max_file_size_in_bytes;

    public function __construct(
        ilLanguage $language,
        DataFactory $data_factory,
        Refinery $refinery,
        UploadLimitResolver $upload_limit_resolver,
        C\Input\Field\UploadHandler $handler,
        string $label,
        ?FormInput $metadata_input,
        ?string $byline
    ) {
        $this->upload_limit_resolver = $upload_limit_resolver;
        $this->max_file_size_in_bytes = $upload_limit_resolver->getBestPossibleUploadLimitInBytes($handler);
        $this->language = $language;
        $this->data_factory = $data_factory;
        $this->refinery = $refinery;
        $this->upload_handler = $handler;
        $this->value = [];

        parent::__construct(
            $language,
            $data_factory,
            $refinery,
            $label,
            $this->createDynamicInputsTemplate($metadata_input),
            $byline
        );
    }

    public function getUploadHandler(): UploadHandler
    {
        return $this->upload_handler;
    }

    public function withMaxFileSize(int $size_in_bytes): FileUpload
    {
        $clone = clone $this;
        $clone->max_file_size_in_bytes = $clone->upload_limit_resolver->getBestPossibleUploadLimitInBytes(
            $clone->upload_handler,
            $size_in_bytes
        );

        return $clone;
    }

    public function getMaxFileSize(): int
    {
        return $this->max_file_size_in_bytes;
    }

    public function withMaxFiles(int $max_file_amount): FileUpload
    {
        $clone = clone $this;
        $clone->max_file_amount = $max_file_amount;

        return $clone;
    }

    public function getMaxFiles(): int
    {
        return $this->max_file_amount;
    }

    public function withAcceptedMimeTypes(array $mime_types): FileUpload
    {
        $clone = clone $this;
        $clone->accepted_mime_types = $mime_types;

        return $clone;
    }

    public function getAcceptedMimeTypes(): array
    {
        return $this->accepted_mime_types;
    }

    // ===============================================
    // END IMPLEMENTATION OF FileUpload
    // ===============================================

    // ===============================================
    // BEGIN OVERWRITTEN METHODS OF HasDynamicInputs
    // ===============================================

    public function withValue($value): HasDynamicInputsBase
    {
        $this->checkArg("value", $this->isClientSideValueOk($value), "Display value does not match input type.");

        $clone = clone $this;
        $identifier_key = $clone->upload_handler->getFileIdentifierParameterName();
        foreach ($value as $data) {
            $file_id = ($clone->hasMetadataInputs()) ? $data[$identifier_key] : $data;

            // that was not implicitly intended, but mapping dynamic inputs
            // to the file-id is also a duplicate protection.
            $clone->dynamic_inputs[$file_id] = $clone->dynamic_input_template->withValue($data);
        }

        return $clone;
    }

    // ===============================================
    // END OVERWRITTEN METHODS OF HasDynamicInputs
    // ===============================================

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

    public function getTranslations(): array
    {
        return [
            'invalid_mime' => $this->language->txt('ui_file_input_invalid_mime'),
            'invalid_size' => $this->language->txt('ui_file_input_invalid_size'),
            'invalid_amount' => $this->language->txt('ui_file_input_invalid_amount'),
            'general_error' => $this->language->txt('ui_file_input_general_error'),
        ];
    }

    public function getUpdateOnLoadCode(): Closure
    {
        return static function () {
        };
    }

    protected function getConstraintForRequirement(): ?Constraint
    {
        if ($this->requirement_constraint !== null) {
            return $this->requirement_constraint;
        }

        return $this->refinery->custom()->constraint(
            function ($value) {
                return (is_array($value) && count($value) > 0);
            },
            function ($txt, $value) {
                return $txt("msg_no_files_selected");
            },
        );
    }

    protected function isClientSideValueOk($value): bool
    {
        if (!is_array($value)) {
            return false;
        }

        foreach ($value as $data) {
            // if no dynamic input template was provided, the values
            // must all be strings (possibly file-ids).
            if (!is_string($data) && !$this->hasMetadataInputs()) {
                return false;
            }

            if ($this->hasMetadataInputs()) {
                // if a dynamic input template was provided, the values
                // must all contain the file-id as an array entry.
                if (!array_key_exists($this->upload_handler->getFileIdentifierParameterName(), $data)) {
                    return false;
                }

                // if a dynamic input template was provided, the values
                // must be valid for the template input.
                if (!$this->dynamic_input_template->isClientSideValueOk($data)) {
                    return false;
                }
            }
        }

        return true;
    }

    protected function createDynamicInputsTemplate(?FormInput $metadata_input): FormInput
    {
        $default_metadata_input = new Hidden(
            $this->data_factory,
            $this->refinery
        );

        if (null === $metadata_input) {
            return $default_metadata_input;
        }

        $inputs = ($metadata_input instanceof C\Input\Field\Group) ?
            $metadata_input->getInputs() : [
                $metadata_input,
            ];

        // map the file-id input to the UploadHandlers identifier key.
        $inputs[$this->upload_handler->getFileIdentifierParameterName()] = $default_metadata_input;

        // tell the input that it contains actual metadata inputs.
        $this->has_metadata_inputs = true;

        return new Group(
            $this->data_factory,
            $this->refinery,
            $this->language,
            $inputs,
            ''
        );
    }
}