AbstractCtrlAwareIRSSUploadHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\FileUpload\Handler;

use ILIAS\ResourceStorage\Services;
use ILIAS\Filesystem\Filesystem;
use ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder;
use ILIAS\FileUpload\DTO\UploadResult;

abstract class AbstractCtrlAwareIRSSUploadHandler extends AbstractCtrlAwareUploadHandler
{
    protected \ilFileServicesFilenameSanitizer $sanitizer;
    protected \ilLanguage $language;
    protected Services $irss;
    protected ResourceStakeholder $stakeholder;
    protected Filesystem $temp_filesystem;
    protected array $class_path;

    public function __construct()
    {
        global $DIC;

        $this->irss = $DIC->resourceStorage();
        $this->stakeholder = $this->getStakeholder();
        $this->temp_filesystem = $DIC->filesystem()->temp();
        $this->class_path = $this->getClassPath();
        $this->language = $DIC->language();
        $this->sanitizer = new \ilFileServicesFilenameSanitizer(
            $DIC->fileServiceSettings()
        );

        parent::__construct();
    }

    abstract protected function getStakeholder(): ResourceStakeholder;

    abstract protected function getClassPath(): array;

    protected function getUploadResult(): HandlerResult
    {
        $this->upload->process(); // Process the uploads to rund things like PreProcessors

        $result_array = $this->upload->getResults();
        $result = end($result_array); // get the last result aka the Upload of the user

        if ($result instanceof UploadResult && $result->isOK()) {
            if ($this->is_chunked) {
                return $this->processChunckedUpload($result);
            }

            $identifier = $this->irss->manage()->upload($result, $this->stakeholder)->serialize();
            $status = HandlerResult::STATUS_OK;
            $message = "file upload OK";
        } else {
            $identifier = '';
            $status = HandlerResult::STATUS_FAILED;
            $message = $this->language->txt(
                'msg_info_blacklisted'
            ); // this is the most common reason for a failed upload
        }

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

    protected function processChunckedUpload(UploadResult $result): HandlerResult
    {
        $temp_path = $this->sanitizer->sanitize("$this->chunk_id/{$result->getName()}");

        try {
            if ($this->temp_filesystem->has($temp_path)) {
                $stream = fopen($this->temp_filesystem->readStream($temp_path)->getMetadata()['uri'], 'ab');
                fwrite($stream, file_get_contents($result->getPath()));
            } else {
                $this->temp_filesystem->write($temp_path, file_get_contents($result->getPath()));
            }
        } catch (\Throwable $t) {
            return new BasicHandlerResult(
                $this->getFileIdentifierParameterName(),
                HandlerResult::STATUS_FAILED,
                '',
                $t->getMessage()
            );
        }

        if (($this->chunk_index + 1) === $this->amount_of_chunks) {
            $whole_file = $this->temp_filesystem->readStream($temp_path);
            $id = $this->irss->manage()->stream($whole_file, $this->stakeholder, $result->getName());

            return new BasicHandlerResult(
                $this->getFileIdentifierParameterName(),
                HandlerResult::STATUS_OK,
                $id->serialize(),
                "file upload OK"
            );
        }

        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            HandlerResult::STATUS_PARTIAL,
            '',
            "chunk upload OK"
        );
    }

    #[\Override]
    public function getUploadURL(): string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_UPLOAD, null, true);
    }

    #[\Override]
    public function getExistingFileInfoURL(): string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_INFO, null, true);
    }

    #[\Override]
    public function getFileRemovalURL(): string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_REMOVE, null, true);
    }

    protected function getRemoveResult(string $identifier): HandlerResult
    {
        if (null !== ($id = $this->irss->manage()->find($identifier))) {
            $this->irss->manage()->remove($id, $this->stakeholder);
            $status = HandlerResult::STATUS_OK;
            $message = "file removal OK";
        } else {
            $status = HandlerResult::STATUS_OK;
            $message = "file with identifier '$identifier' doesn't exist, nothing to do.";
        }

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

    public function getInfoResult(string $identifier): ?FileInfoResult
    {
        if (null !== ($id = $this->irss->manage()->find($identifier))) {
            $revision = $this->irss->manage()->getCurrentRevision($id)->getInformation();
            $title = $revision->getTitle();
            $size = $revision->getSize();
            $mime = $revision->getMimeType();
        } else {
            $title = $mime = 'unknown';
            $size = 0;
        }

        return new BasicFileInfoResult($this->getFileIdentifierParameterName(), $identifier, $title, $size, $mime);
    }

    public function getInfoForExistingFiles(array $file_ids): array
    {
        return array_map(fn($file_id): FileInfoResult => $this->getInfoResult($file_id), $file_ids);
    }
}