ilFileServicesPolicy Class Reference

Class ilFileServicesPolicy. More...

Inheritance diagram for ilFileServicesPolicy:

Collaboration diagram for ilFileServicesPolicy:

Public Member Functions
	__construct (protected ilFileServicesSettings $settings)
	prepareFileNameForConsumer (string $filename_with_extension)
	ascii (string $filename)
	isBlockedExtension (string $extension)
Public Member Functions inherited from ILIAS\ResourceStorage\Policy\WhiteAndBlacklistedFileNamePolicy
	__construct (protected array $blacklisted=[], protected array $whitelisted=[])
	WhiteAndBlacklistedFileNamePolicy constructor. More...
	isValidExtension (string $extension)
	isBlockedExtension (string $extension)
	check (string $extension)

Data Fields
array	Ö

Protected Attributes
int	$file_admin_ref_id
bool	$as_ascii = true
ilFileServicesFilenameSanitizer	$sanitizer
bool	$bypass = null

Private Attributes
array	$umlaut_mapping

Detailed Description

Class ilFileServicesPolicy.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 26 of file class.ilFileServicesPolicy.php.

Constructor & Destructor Documentation

__construct()

ilFileServicesPolicy::__construct

(

protected ilFileServicesSettings

$settings

)

Definition at line 46 of file class.ilFileServicesPolicy.php.

References ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\settings().

    {
        parent::__construct($this->settings->getBlackListedSuffixes(), $this->settings->getWhiteListedSuffixes());
        $this->sanitizer = new ilFileServicesFilenameSanitizer($this->settings);
        $this->as_ascii = $this->settings->isASCIIConvertionEnabled();
    }

Here is the call graph for this function:

Member Function Documentation

ascii()

ilFileServicesPolicy::ascii

(

string

$filename

)

Definition at line 65 of file class.ilFileServicesPolicy.php.

Referenced by ilFileUtils\getASCIIFilename(), and prepareFileNameForConsumer().

                                           : string
    {
        foreach ($this->umlaut_mapping as $src => $tgt) {
            $filename = str_replace($src, $tgt, $filename);
        }

        $ascii_filename = htmlentities($filename, ENT_NOQUOTES, 'UTF-8');
        $ascii_filename = preg_replace('/\&(.)[^;]*;/', '\\1', $ascii_filename);
        $ascii_filename = preg_replace('/[\x7f-\xff]/', '_', (string) $ascii_filename);

        // OS do not allow the following characters in filenames: \/:*?"<>|
        $ascii_filename = preg_replace(
            '/[:\x5c\/\*\?\"<>\|]/',
            '_',
            (string) $ascii_filename
        );
        return $ascii_filename;
    }

Here is the caller graph for this function:

isBlockedExtension()

ilFileServicesPolicy::isBlockedExtension

(

string

$extension

)

Implements ILIAS\ResourceStorage\Policy\FileNamePolicy.

Definition at line 85 of file class.ilFileServicesPolicy.php.

References ILIAS\Repository\settings().

                                                         : bool
    {
        if ($this->settings->isByPassAllowedForCurrentUser()) {
            return false;
        }
        return parent::isBlockedExtension($extension);
    }

Here is the call graph for this function:

prepareFileNameForConsumer()

ilFileServicesPolicy::prepareFileNameForConsumer

(

string

$filename_with_extension

)

Implements ILIAS\ResourceStorage\Policy\FileNamePolicy.

Definition at line 53 of file class.ilFileServicesPolicy.php.

References $filename, and ascii().

                                                                               : string
    {
        $filename = $this->sanitizer->sanitize(basename($filename_with_extension));
        if ($this->as_ascii) {
            $filename = $this->ascii($filename);
        }
        // remove all control characters, see https://mantis.ilias.de/view.php?id=34975
        $filename = preg_replace('/&#.*;/U', '_', $filename, 1);

        return $filename;
    }

Here is the call graph for this function:

Field Documentation

$as_ascii

bool ilFileServicesPolicy::$as_ascii = true

protected

Definition at line 42 of file class.ilFileServicesPolicy.php.

$bypass

bool ilFileServicesPolicy::$bypass = null

protected

Definition at line 44 of file class.ilFileServicesPolicy.php.

$file_admin_ref_id

int ilFileServicesPolicy::$file_admin_ref_id

protected

Definition at line 41 of file class.ilFileServicesPolicy.php.

$sanitizer

ilFileServicesFilenameSanitizer ilFileServicesPolicy::$sanitizer

protected

Definition at line 43 of file class.ilFileServicesPolicy.php.

$umlaut_mapping

array ilFileServicesPolicy::$umlaut_mapping

private

Initial value:

= [
        "Ä" => "Ae"

Definition at line 28 of file class.ilFileServicesPolicy.php.

Ö

array ilFileServicesPolicy::Ö

Initial value:

=> "Oe",
        "Ü" => "Ue",
        "ä" => "ae",
        "ö" => "oe",
        "ü" => "ue",
        "é" => "e",
        "è" => "e",
        "é" => "e",
        "ê" => "e",
        "ß" => "ss"
    ]

Definition at line 30 of file class.ilFileServicesPolicy.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/FileServices/classes/StorageService/class.ilFileServicesPolicy.php