ILIAS\FileUpload\Processor\FilenameSanitizerPreProcessor Class Reference

Class FilenameSanitizerPreProcessor. More...

Inheritance diagram for ILIAS\FileUpload\Processor\FilenameSanitizerPreProcessor:

Collaboration diagram for ILIAS\FileUpload\Processor\FilenameSanitizerPreProcessor:

Public Member Functions
	process (FileStream $stream, Metadata $metadata)
	@inheritDoc More...
	process (FileStream $stream, Metadata $metadata)
	This method gets invoked by the file upload service to process the file with the help of the processor. More...

Private Member Functions
	normalizeRelativePath (string $path)

Detailed Description

Class FilenameSanitizerPreProcessor.

PreProcessor which overrides the filename with a given one

Author

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

Since

5.3

Version

1.0.0

Definition at line 35 of file FilenameSanitizerPreProcessor.php.

Member Function Documentation

normalizeRelativePath()

ILIAS\FileUpload\Processor\FilenameSanitizerPreProcessor::normalizeRelativePath ( string  $path )

private

Definition at line 51 of file FilenameSanitizerPreProcessor.php.

                                                        : string
    {
        $path = str_replace('\\', '/', $path);
        $path = preg_replace('#\p{C}+#u', '', $path);
        $parts = [];
 
        foreach (explode('/', (string) $path) as $part) {
            switch ($part) {
                case '':
                case '.':
                    break;
 
                case '..':
                    if (empty($parts)) {
                        throw new \LogicException(
                            'Path is outside of the defined root, path: [' . $path . ']'
                        );
                    }
                    array_pop($parts);
                    break;
 
                default:
                    $parts[] = $part;
                    break;
            }
        }
 
        return implode('/', $parts);
    }

References $parts, and $path.

process()

ILIAS\FileUpload\Processor\FilenameSanitizerPreProcessor::process	(	FileStream	$stream,
		Metadata	$metadata
	)

@inheritDoc

Implements ILIAS\FileUpload\Processor\PreProcessor.

Definition at line 40 of file FilenameSanitizerPreProcessor.php.

                                                                   : ProcessingStatus
    {
        $filename = $metadata->getFilename();
        // remove some special characters
        $filename = Util::sanitizeFileName($filename);
 
        $metadata->setFilename($filename);
 
        return new ProcessingStatus(ProcessingStatus::OK, 'Filename changed');
    }

References $filename, ILIAS\FileUpload\DTO\Metadata\getFilename(), ILIAS\FileUpload\DTO\ProcessingStatus\OK, ILIAS\Filesystem\Util\sanitizeFileName(), and ILIAS\FileUpload\DTO\Metadata\setFilename().

Here is the call graph for this function:

---

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

• components/ILIAS/FileUpload/src/Processor/FilenameSanitizerPreProcessor.php