General.php

Go to the documentation of this file.

<?php
 
namespace ILIAS\components\File\Settings;
 
use ILIAS\FileServices\Download\DownloadLimit;
 
class General implements DownloadLimit
{
    public const MODULE_NAME = 'file_access';
    public const F_BG_LIMIT = 'bg_limit';
    public const F_INLINE_FILE_EXTENSIONS = 'inline_file_extensions';
    public const F_SHOW_AMOUNT_OF_DOWNLOADS = 'show_amount_of_downloads';
    public const F_DOWNLOAD_ASCII_FILENAME = 'download_ascii_filename';
    private const SEPARATOR = ' ';
 
    private array $default_inline_extensions = [
        'gif',
        'jpg',
        'jpeg',
        'mp3',
        'pdf',
        'png',
    ];
 
    private ?array $setting = null;
 
    public function __construct(private readonly \ilDBInterface $db)
    {
    }
 
    public function read(): void
    {
        $this->setting = [];
 
        $res = $this->db->queryF(
            "SELECT keyword, value FROM settings WHERE module = %s",
            ['text'],
            [self::MODULE_NAME]
        );
 
        while ($row = $this->db->fetchAssoc($res)) {
            $this->setting[$row["keyword"]] = $row["value"];
        }
    }
 
    public function get(
        string $keyword,
        ?string $default_value = null
    ): ?string {
        if ($this->setting === null) {
            $this->read();
        }
 
        return $this->setting[$keyword] ?? $default_value;
    }
 
    public function set(string $keyword, string $value): void
    {
        if ($this->setting === null) {
            $this->read();
        }
 
        $this->db->replace(
            'settings',
            [
                'module' => ['text', self::MODULE_NAME],
                'keyword' => ['text', $keyword],
            ],
            [
                'value' => ['text', $value],
            ]
        );
 
        $this->setting[$keyword] = $value;
    }
 
 
    public function isDownloadWithAsciiFileName(): bool
    {
        return $this->strToBool($this->get(self::F_DOWNLOAD_ASCII_FILENAME, '1'));
    }
 
    public function setDownloadWithAsciiFileName(bool $value): void
    {
        $this->set(self::F_DOWNLOAD_ASCII_FILENAME, $this->boolToStr($value));
    }
 
    public function isShowAmountOfDownloads(): bool
    {
        return $this->strToBool($this->get(self::F_SHOW_AMOUNT_OF_DOWNLOADS, '1'));
    }
 
    public function setShowAmountOfDownloads(bool $value): void
    {
        $this->set(self::F_SHOW_AMOUNT_OF_DOWNLOADS, $this->boolToStr($value));
    }
 
    public function setInlineFileExtensions(array $extensions): void
    {
        $extensions = array_map(
            fn(string $extension): string => strtolower(trim($extension, " \t\n\r\0\x0B,")),
            $extensions
        );
 
        $this->set(self::F_INLINE_FILE_EXTENSIONS, $this->arrayToStr($extensions));
    }
 
    public function getInlineFileExtensions(): array
    {
        return $this->strToArray(
            $this->get(
                self::F_INLINE_FILE_EXTENSIONS,
                $this->arrayToStr($this->default_inline_extensions)
            )
        );
    }
 
    public function getDownloadLimitinMB(): int
    {
        return $this->strToInt($this->get(self::F_BG_LIMIT, '200'));
    }
 
    public function setDownloadLimitInMB(int $limit): void
    {
        $this->set(self::F_BG_LIMIT, $this->intToStr($limit));
    }
 
    // HELPERS
 
    private function strToBool(?string $value): bool
    {
        return $value === '1';
    }
 
    private function boolToStr(bool $value): string
    {
        return $value ? '1' : '0';
    }
 
    private function intToStr(int $int): string
    {
        return (string) $int;
    }
 
    private function strToInt(?string $str): int
    {
        return (int) $str;
    }
 
    private function arrayToStr(array $array): string
    {
        return implode(self::SEPARATOR, $array);
    }
 
    private function strToArray(?string $str): array
    {
        return explode(self::SEPARATOR, (string) $str);
    }
}