class.ilLTIConsumeProviderIcon.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLTIConsumeProviderIcon
{
    public const MAX_ICON_SIZE = 32;

    protected static array $RELATIVE_DIRECTORY_PATH = [
        'lti_data', 'provider_icon'
    ];

    protected static array $SUPPORTED_FILE_EXTENSIONS = [
        'png', 'jpg', 'jpeg', 'svg'
    ];

    protected int $providerId;

    protected string $filename;

    public function __construct(int $providerId, string $filename = '')
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        $this->providerId = $providerId;
        $this->filename = $filename;

        $this->ensureExistingRelativeDirectory();
    }

    public function buildFilename(string $fileExtension): string
    {
        return $this->providerId . "." . $fileExtension;
    }

    public function getFilename(): string
    {
        return $this->filename;
    }

    public function setFilename(string $filename): void
    {
        $this->filename = $filename;
    }

    public function getRelativeDirectory(): string
    {
        return implode(DIRECTORY_SEPARATOR, self::$RELATIVE_DIRECTORY_PATH);
    }

    public function getRelativeFilePath(): string
    {
        return implode(DIRECTORY_SEPARATOR, [
            $this->getRelativeDirectory(), $this->getFilename()
        ]);
    }

    public function getAbsoluteFilePath(): string
    {
        return implode(DIRECTORY_SEPARATOR, [
            ilFileUtils::getWebspaceDir(), $this->getRelativeFilePath()
        ]);
    }

    protected function ensureExistingRelativeDirectory(): void
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        if (!$DIC->filesystem()->web()->has($this->getRelativeDirectory())) {
            $DIC->filesystem()->web()->createDir($this->getRelativeDirectory());
        }
    }

    public function exists(): bool
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        if ($this->getFilename() === '') {
            return false;
        }

        return $DIC->filesystem()->web()->has($this->getRelativeFilePath());
    }

    protected function delete(): void
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        if ($DIC->filesystem()->web()->has($this->getRelativeFilePath())) {
            $DIC->filesystem()->web()->delete($this->getRelativeFilePath());
        }

        $this->setFilename('');
    }

    protected function convert(): void
    {
        // convert to square with same side length (optimal for tile view)

        list($width, $height, $type, $attr) = getimagesize($this->getAbsoluteFilePath());
        $minSize = min($width, $height);

        if (self::MAX_ICON_SIZE) {
            $minSize = min($minSize, self::MAX_ICON_SIZE);
        }

        $convertCmd = "{$this->getAbsoluteFilePath()}[0]";
        $convertCmd .= " -geometry {$minSize}x{$minSize}^ -gravity center";
        $convertCmd .= " -extent {$minSize}x{$minSize}";
        $convertCmd .= " {$this->getAbsoluteFilePath()}";

        ilShellUtil::execConvert($convertCmd);
    }

    protected function save(string $uploadFile): void
    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */

        if ($DIC->upload()->hasUploads()) {
            if (!$DIC->upload()->hasBeenProcessed()) {
                $DIC->upload()->process();
            }

            /* @var \ILIAS\FileUpload\DTO\UploadResult $result */

            $results = $DIC->upload()->getResults();

            if (isset($results[$uploadFile])) {
                $result = $results[$uploadFile];

                if ($result->isOK()) {
                    $fileExtentsion = pathinfo($result->getName(), PATHINFO_EXTENSION);
                    $this->setFilename($this->buildFilename($fileExtentsion));

                    $DIC->upload()->moveOneFileTo(
                        $result,
                        $this->getRelativeDirectory(),
                        \ILIAS\FileUpload\Location::WEB,
                        $this->getFileName(),
                        true
                    );

                    if ($fileExtentsion !== "svg") {
                        $this->convert();
                    }
                }
            }
        }
    }

    public function handleUploadInputSubission(ilImageFileInputGUI $fileInput, array $fileData): void
    {
        global $DIC;

        if ($fileInput->getDeletionFlag()) {
            $this->delete();
        }

        if ($fileData['tmp_name']) {
            $this->save($fileData['tmp_name']);
        }
    }

    public static function getSupportedFileExtensions(): array
    {
        return self::$SUPPORTED_FILE_EXTENSIONS;
    }
}