ILIAS\File\Sanitation\FilePathSanitizer Class Reference

Class FilePathSanitizer. More...

Collaboration diagram for ILIAS\File\Sanitation\FilePathSanitizer:

Public Member Functions
	__construct (ilObjFile $file_object)
	FilePathSanitizer constructor. More...
	needsSanitation ()
	sanitizeIfNeeded ()

Private Member Functions
	log ( $message)
	santitizeFilename ($first_file)
	saveNewNameForFileObject ($valid_filename)

Private Attributes
	$file_object
	$relative_path
	$fs
	$absolute_path

Detailed Description

Class FilePathSanitizer.

Author

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

Definition at line 16 of file FilePathSanitizer.php.

Constructor & Destructor Documentation

__construct()

ILIAS\File\Sanitation\FilePathSanitizer::__construct

(

ilObjFile

$file_object

)

FilePathSanitizer constructor.

Parameters

ilObjFile

$file_object

Definition at line 42 of file FilePathSanitizer.php.

    {
        $this->file_object = $file_object;
        $this->absolute_path = $this->file_object->getDirectory($this->file_object->getVersion()) . "/" . $this->file_object->getFileName();
        $this->relative_path = LegacyPathHelper::createRelativePath($this->absolute_path);
        $this->fs = LegacyPathHelper::deriveFilesystemFrom($this->absolute_path);
    }

References ILIAS\File\Sanitation\FilePathSanitizer\$file_object, ILIAS\Filesystem\Util\LegacyPathHelper\createRelativePath(), and ILIAS\Filesystem\Util\LegacyPathHelper\deriveFilesystemFrom().

Here is the call graph for this function:

Member Function Documentation

log()

ILIAS\File\Sanitation\FilePathSanitizer::log (   $message )

private

Parameters

string

$message

Definition at line 77 of file FilePathSanitizer.php.

    {
        global $DIC;
        $DIC->logger()->root()->debug("FilePathSanitizer: " . $message);
    }

References $DIC, and $message.

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\sanitizeIfNeeded().

Here is the caller graph for this function:

needsSanitation()

ILIAS\File\Sanitation\FilePathSanitizer::needsSanitation

(

)

Returns

bool

Definition at line 54 of file FilePathSanitizer.php.

    {
        try {
            $fs_relative_path_existing = $this->fs->has($this->relative_path);
            $fs_valid_relative_path_existing = $this->fs->has(ilFileUtils::getValidFilename($this->relative_path));
            $native_absolute_path_exists = file_exists($this->absolute_path);
            $native_valid_absolute_path_existing = file_exists(ilFileUtils::getValidFilename($this->absolute_path));
 
            return (
                !$fs_relative_path_existing
                || !$fs_valid_relative_path_existing
                || !$native_absolute_path_exists
                || !$native_valid_absolute_path_existing
            );
        } catch (Exception $e) {
            return false;
        }
    }

References ilFileUtils\getValidFilename().

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\sanitizeIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

sanitizeIfNeeded()

ILIAS\File\Sanitation\FilePathSanitizer::sanitizeIfNeeded

(

)

Returns

bool

Exceptions

ILIAS\Filesystem\Exception\DirectoryNotFoundException

Definition at line 88 of file FilePathSanitizer.php.

    {
        if ($this->needsSanitation()) {
            // First Try: using FileSystemService
            $dirname = dirname($this->relative_path);
            if (!$this->fs->has($dirname)) {
                $this->log("FAILED: Sanitizing File Path: {$this->file_object->getFile()}. Message: Directory not found");
 
                return false;
            }
            $first_file = reset($this->fs->listContents($dirname));
            if ($first_file instanceof \ILIAS\Filesystem\DTO\Metadata) {
                try {
                    $valid_filename = $this->santitizeFilename($first_file->getPath());
                    // rename file in filesystem
                    if (!$this->fs->has($valid_filename)) {
                        $this->fs->rename($first_file->getPath(), $valid_filename);
                        // rename file object
 
                        $this->log("Sanitized File Path: {$valid_filename}");
                    }
                    $this->saveNewNameForFileObject($valid_filename);
 
                    return true;
                } catch (Exception $e) {
                    $this->log("FAILED: Sanitizing File Path: {$this->file_object->getFile()}. Message: {$e->getMessage()}. Will try using native PHP");
 
                    try {
                        // Second try: use native php
                        $scandir = scandir(dirname($this->absolute_path));
                        if (isset($scandir[2])) {
                            $first_file = $scandir[2];
                            if (is_file($first_file)) {
                                $valid_filename = $this->santitizeFilename($first_file);
                                if (rename($first_file, $valid_filename)) {
                                    $this->saveNewNameForFileObject($valid_filename);
                                    $this->log("Sanitized File Path: {$valid_filename}");
                                }
                            } else {
                                throw new Exception("is not a file: " . $first_file);
                            }
                        } else {
                            throw new Exception("no File found in " . dirname($this->absolute_path));
                        }
                    } catch (Exception $e) {
                        $this->log("FAILED AGAIN: Sanitizing File Path: {$this->file_object->getFile()}. Message: {$e->getMessage()}");
 
                        try {
                            foreach (new DirectoryIterator(dirname($this->absolute_path)) as $item) {
                                if ($item->isDot()) {
                                    continue;
                                }
                                if ($item->isFile()) {
                                    $valid_filename = $this->santitizeFilename($item->getPathname());
                                    if (rename($item->getPathname(), $valid_filename)) {
                                        $this->saveNewNameForFileObject($valid_filename);
                                        $this->log("Sanitized File Path: {$valid_filename}");
                                    }
                                    break;
                                }
                            }
                        } catch (Exception $e) {
                            $this->log("FAILED AGAIN and AGAIN: Sanitizing File Path: {$this->file_object->getFile()}. Message: {$e->getMessage()}");
                        }
                    }
 
                    return false;
                }
            }
 
            return false;
        }
 
        return true;
    }

References ILIAS\File\Sanitation\FilePathSanitizer\log(), ILIAS\File\Sanitation\FilePathSanitizer\needsSanitation(), ILIAS\File\Sanitation\FilePathSanitizer\santitizeFilename(), and ILIAS\File\Sanitation\FilePathSanitizer\saveNewNameForFileObject().

Here is the call graph for this function:

santitizeFilename()

ILIAS\File\Sanitation\FilePathSanitizer::santitizeFilename (   $first_file )

private

Parameters

$first_file

Returns

string|string[]|null

Exceptions

ilFileUtilsException

Definition at line 171 of file FilePathSanitizer.php.

    {
        $valid_filename = $first_file;
 
        while (preg_match('#\p{C}+|^\./#u', $valid_filename)) {
            $valid_filename = preg_replace('#\p{C}+|^\./#u', '', $valid_filename);
        }
 
        $valid_filename = preg_replace('/[\x00-\x1F\x7F-\xFF]/', '', $valid_filename); // removes all non printable characters (ASCII 7 Bit)
 
        // $valid_filename = \League\Flysystem\Util::normalizeRelativePath($valid_filename);
        // $valid_filename = preg_replace('/[\x00-\x1F\x7F-\xA0\xAD]/u', '', $valid_filename);
        // $valid_filename = iconv(mb_detect_encoding($valid_filename, mb_detect_order(), true), "UTF-8", $valid_filename);
        // $valid_filename = utf8_encode($valid_filename);
 
        $valid_filename = ilFileUtils::getValidFilename($valid_filename);
 
        return $valid_filename;
    }

References ilFileUtils\getValidFilename().

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\sanitizeIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

saveNewNameForFileObject()

ILIAS\File\Sanitation\FilePathSanitizer::saveNewNameForFileObject (   $valid_filename )

private

Parameters

$valid_filename

Definition at line 195 of file FilePathSanitizer.php.

    {
        $sanitized_filename = basename($valid_filename);
        $this->file_object->setFileName($sanitized_filename);
        $this->file_object->update();
    }

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\sanitizeIfNeeded().

Here is the caller graph for this function:

Field Documentation

$absolute_path

ILIAS\File\Sanitation\FilePathSanitizer::$absolute_path

private

Definition at line 34 of file FilePathSanitizer.php.

$file_object

ILIAS\File\Sanitation\FilePathSanitizer::$file_object

private

Definition at line 22 of file FilePathSanitizer.php.

Referenced by ILIAS\File\Sanitation\FilePathSanitizer\__construct().

$fs

ILIAS\File\Sanitation\FilePathSanitizer::$fs

private

Definition at line 30 of file FilePathSanitizer.php.

$relative_path

ILIAS\File\Sanitation\FilePathSanitizer::$relative_path

private

Definition at line 26 of file FilePathSanitizer.php.

---

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

• Modules/File/classes/Sanitation/FilePathSanitizer.php