class.ImportUploadHandlerGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

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\Filesystem\Filesystem;
use ILIAS\Data\DataSize;

class ImportUploadHandlerGUI extends AbstractCtrlAwareUploadHandler implements \ilCtrlBaseClassInterface
{
    protected Filesystem $temp_system;
    protected array $supported_mime_types;

    public function __construct()
    {
        global $DIC;
        $this->temp_system = $DIC->filesystem()->temp();
        $this->supported_mime_types = ilObjectGUI::SUPPORTED_IMPORT_MIME_TYPES;
        parent::__construct();
    }

    final protected function getUploadResult(): HandlerResult
    {
        $this->upload->process();

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

        $tempname = '';
        if ($result instanceof UploadResult
            && in_array($result->getMimeType(), $this->supported_mime_types)
            && $result->isOK()) {
            $status = HandlerResult::STATUS_OK;
            $message = 'Upload ok';
            $tempname = $this->moveUploadedFileToTemp($result);
        } else {
            $status = HandlerResult::STATUS_FAILED;
            $message = $result->getStatus()->getMessage();
        }

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

    final protected function getRemoveResult(string $filename): HandlerResult
    {
        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            HandlerResult::STATUS_OK,
            $filename,
            "We just don't do anything here."
        );
    }

    final public function getInfoResult(string $file_name): ?FileInfoResult
    {
        if ($this->temp_system->hasDir($file_name)
            && ($files = $this->temp_system->listContents($file_name))) {
            $path = $files[0]->getPath();
            $filename = basename($path);
            $title = $filename;
            $mime = $this->temp_system->getMimeType($path);
            $size = intval($this->temp_system->getSize($path, DataSize::Byte)->inBytes());

        } else {
            $title = $mime = 'unknown';
            $size = 0;
        }

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

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

    final protected function moveUploadedFileToTemp(UploadResult $result): string
    {
        $tempfile_path = uniqid('tmp');
        $this->temp_system->createDir($tempfile_path);
        $this->temp_system->put(
            $tempfile_path . DIRECTORY_SEPARATOR . ilFileUtils::getValidFilename($result->getName()),
            file_get_contents($result->getPath())
        );
        return $tempfile_path;
    }
}