Inheritance diagram for ILIAS\FileUpload\FileUploadImpl:

Collaboration diagram for ILIAS\FileUpload\FileUploadImpl:

Public Member Functions

__construct (private PreProcessorManager $processorManager, private Filesystems $filesystems, private GlobalHttpState $globalHttpState, private ?PhpUploadLimit $upload_limit=null)

FileUploadImpl constructor. More...

moveOneFileTo (UploadResult $uploadResult, string $destination, int $location=Location::STORAGE, string $file_name='', bool $override_existing=false)

Moves a single File (the attributes, metadata and upload-status of which are contained in UploadResult) to the given destination.The destination is a relative path which refers to the path of the location.

Parameters

UploadResult	$uploadResult	Which upload result do you want to move?
string	$destination	Where do you want to move the file?
int	$location	Location::[STORAGE\|WEB\|CUSTOMIZING]
string	$file_name	Do you want to rename the file?
bool	$override_existing	Override existing file with same name

More...

moveFilesTo (string $destination, int $location=Location::STORAGE)

@inheritDoc More...

uploadSizeLimit ()

@inheritDoc More...

register (PreProcessor $preProcessor)

@inheritDoc More...

process ()

@inheritDoc More...

getResults ()

@inheritDoc More...

hasUploads ()

@inheritDoc More...

hasBeenProcessed ()

Return (bool)true if the current upload has already been processed. More...

moveFilesTo (string $destination, int $location=Location::STORAGE)

Moves all uploaded files to the given destination after the processors had processed the files. More...

moveOneFileTo (UploadResult $uploadResult, string $destination, int $location=Location::STORAGE, string $file_name='', bool $override_existing=false)

Moves a single File (the attributes, metadata and upload-status of which are contained in UploadResult) to the given destination. More...

uploadSizeLimit ()

Returns the current upload size limit in bytes. More...

register (PreProcessor $preProcessor)

Register a new preprocessor instance. More...

process ()

Invokes all preprocessors for each uploaded file in the sequence they got registered. More...

getResults ()

Returns the results of the processing and moving operation of the uploaded files. More...

hasUploads ()

Return (bool)true if one ore more file-uploads are in the current request, (bool)false if not. More...

hasBeenProcessed ()

Return (bool)true if the current upload has already been processed. More...

Private Member Functions
	hardRemoveUpload (string $identifier, ProcessingStatus $status)
	@description This is the very last thing we can do if a preprocessor DENIEs an upload. More...

	regenerateUploadResultWithPath (UploadResult $result, string $path)
	Generate an exact copy of the result with the given path. More...

	regenerateUploadResultWithCopyError (UploadResult $result, string $errorReason)
	Creates a clone of the given result and set the status to rejected with the passed error message. More...

	selectFilesystem (int $location)
	Selects the correct filesystem by the given Location constant. More...

	rejectFailedUpload (Metadata $metadata)
	Reject a failed upload with the given metadata. More...

	flattenUploadedFiles (array $uploadedFiles)

Private Attributes
bool	$processed = false

bool	$moved = false

array	$uploadResult = []

array	$rejectedUploadResult = []

array	$uploadStreams = null

Detailed Description

Class FileUploadImpl.

Author: Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Since: 5.3

Version: 1.0.0

Definition at line 47 of file FileUploadImpl.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\FileUpload\FileUploadImpl::__construct	(	private PreProcessorManager	$processorManager,
		private Filesystems	$filesystems,
		private GlobalHttpState	$globalHttpState,
		private ?PhpUploadLimit	$upload_limit = `null`
	)

FileUploadImpl constructor.

Parameters

PreProcessorManager	$processorManager	The processor manager which should be used.
Filesystems	$filesystems	The Filesystems implementation which should be used.
GlobalHttpState	$globalHttpState	The http implementation which should be used to detect the uploaded files.

Definition at line 74 of file FileUploadImpl.php.

79 {

80 }

Member Function Documentation

◆ flattenUploadedFiles()

ILIAS\FileUpload\FileUploadImpl::flattenUploadedFiles ( array $uploadedFiles )

private

Definition at line 354 of file FileUploadImpl.php.

                                                               : array
    {
        $recursiveIterator = new RecursiveIteratorIterator(
            new RecursiveArrayIterator(
                $uploadedFiles,
                RecursiveArrayIterator::CHILD_ARRAYS_ONLY
            ),
            RecursiveIteratorIterator::LEAVES_ONLY
        );
 
        return iterator_to_array($recursiveIterator, false);
    }

Referenced by ILIAS\FileUpload\FileUploadImpl\hasUploads(), and ILIAS\FileUpload\FileUploadImpl\process().

Here is the caller graph for this function:

◆ getResults()

ILIAS\FileUpload\FileUploadImpl::getResults ( )

@inheritDoc

Implements ILIAS\FileUpload\FileUpload.

Definition at line 329 of file FileUploadImpl.php.

                                : array
    {
        if ($this->processed) {
            return array_merge($this->uploadResult, $this->rejectedUploadResult);
        }
 
        throw new IllegalStateException('Can not fetch results without processing the uploads.');
    }

◆ hardRemoveUpload()

ILIAS\FileUpload\FileUploadImpl::hardRemoveUpload	(	string	$identifier,
		ProcessingStatus	$status
	)

private

@description This is the very last thing we can do if a preprocessor DENIEs an upload.

This is a hard removal, not beautiful, but it works.

Definition at line 86 of file FileUploadImpl.php.

                                                                                   : never
    {
        // we delete the file from the temporary directory and remove it from the global $_FILES array
        $file_stream = $this->uploadStreams[$identifier];
        $uri = $file_stream->getMetadata('uri');
        $file_stream->close();
        unlink($uri);
        unset($this->uploadStreams[$identifier]);
        unset($_FILES[$identifier]);
        throw new IllegalStateException($status->getMessage());
    }

References ILIAS\FileUpload\DTO\ProcessingStatus\getMessage().

Referenced by ILIAS\FileUpload\FileUploadImpl\process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasBeenProcessed()

ILIAS\FileUpload\FileUploadImpl::hasBeenProcessed ( )

Return (bool)true if the current upload has already been processed.

Since: 5.3

Implements ILIAS\FileUpload\FileUpload.

Definition at line 368 of file FileUploadImpl.php.

                                      : bool
    {
        return $this->processed;
    }

References ILIAS\FileUpload\FileUploadImpl\$processed.

◆ hasUploads()

ILIAS\FileUpload\FileUploadImpl::hasUploads ( )

@inheritDoc

Implements ILIAS\FileUpload\FileUpload.

Definition at line 342 of file FileUploadImpl.php.

                                : bool
    {
        if ($this->moved) {
            return false;
        }
 
        $uploadedFiles = $this->flattenUploadedFiles($this->globalHttpState->request()->getUploadedFiles());
 
        return ($uploadedFiles !== []);
    }

References ILIAS\FileUpload\FileUploadImpl\flattenUploadedFiles().

Here is the call graph for this function:

◆ moveFilesTo()

ILIAS\FileUpload\FileUploadImpl::moveFilesTo	(	string	$destination,
		int	$location = `Location::STORAGE`
	)

@inheritDoc

Implements ILIAS\FileUpload\FileUpload.

Definition at line 131 of file FileUploadImpl.php.

                                                                                     : void
    {
        if (!$this->processed) {
            throw new \RuntimeException('Can not move unprocessed files.');
        }
 
        if ($this->moved) {
            throw new \RuntimeException('Can not move the files a second time.');
        }
 
        $filesystem = $this->selectFilesystem($location);
        $tempResults = [];
 
        foreach ($this->uploadResult as $key => $uploadResult) {
            if ($uploadResult->getStatus()->getCode() === ProcessingStatus::REJECTED) {
                continue;
            }
 
            try {
                $path = $destination . '/' . $uploadResult->getName();
                $filesystem->writeStream($path, Streams::ofPsr7Stream($this->uploadStreams[$key]));
                $tempResults[] = $this->regenerateUploadResultWithPath($uploadResult, $path);
            } catch (IOException $ex) {
                $this->regenerateUploadResultWithCopyError($uploadResult, $ex->getMessage());
            }
        }
 
        $this->uploadResult = $tempResults;
        $this->uploadStreams = null;
        $this->moved = true;
    }

References $location, ILIAS\FileUpload\FileUploadImpl\$uploadResult, ILIAS\Filesystem\Stream\Streams\ofPsr7Stream(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath(), ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED, and ILIAS\FileUpload\FileUploadImpl\selectFilesystem().

Here is the call graph for this function:

◆ moveOneFileTo()

ILIAS\FileUpload\FileUploadImpl::moveOneFileTo	(	UploadResult	$uploadResult,
		string	$destination,
		int	$location = `Location::STORAGE`,
		string	$file_name = `''`,
		bool	$override_existing = `false`
	)

Moves a single File (the attributes, metadata and upload-status of which are contained in UploadResult) to the given destination.The destination is a relative path which refers to the path of the location.

Parameters

UploadResult	$uploadResult	Which upload result do you want to move?
string	$destination	Where do you want to move the file?
int	$location	Location::[STORAGE\|WEB\|CUSTOMIZING]
string	$file_name	Do you want to rename the file?
bool	$override_existing	Override existing file with same name

Implements ILIAS\FileUpload\FileUpload.

Definition at line 101 of file FileUploadImpl.php.

                                                                                                                                                                            : bool
    {
        if (!$this->processed) {
            throw new \RuntimeException('Can not move unprocessed files.');
        }
        $filesystem = $this->selectFilesystem($location);
        $tempResults = [];
 
        if ($uploadResult->getStatus()->getCode() === ProcessingStatus::REJECTED) {
            return false;
        }
 
        try {
            $path = rtrim($destination, "/") . '/' . ($file_name === "" ? $uploadResult->getName() : $file_name);
            if ($override_existing && $filesystem->has($path)) {
                $filesystem->delete($path);
            }
            $filesystem->writeStream($path, Streams::ofPsr7Stream($this->uploadStreams[$uploadResult->getPath()]));
            $tempResults[] = $this->regenerateUploadResultWithPath($uploadResult, $path);
        } catch (IOException $ex) {
            $this->regenerateUploadResultWithCopyError($uploadResult, $ex->getMessage());
        }
 
        return true;
    }

References $location, ILIAS\FileUpload\FileUploadImpl\$uploadResult, ILIAS\Filesystem\Stream\Streams\ofPsr7Stream(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithCopyError(), ILIAS\FileUpload\FileUploadImpl\regenerateUploadResultWithPath(), ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED, and ILIAS\FileUpload\FileUploadImpl\selectFilesystem().

Here is the call graph for this function:

◆ process()

ILIAS\FileUpload\FileUploadImpl::process ( )

@inheritDoc

Implements ILIAS\FileUpload\FileUpload.

Definition at line 252 of file FileUploadImpl.php.

                             : void
    {
        if ($this->processed) {
            throw new IllegalStateException('Can not reprocess the uploaded files.');
        }
 
        $uploadedFiles = $this->globalHttpState->request()->getUploadedFiles();
        $collectFilesFromNestedFields = $this->flattenUploadedFiles($uploadedFiles);
        foreach ($collectFilesFromNestedFields as $file) {
            $metadata = new Metadata($file->getClientFilename(), $file->getSize(), $file->getClientMediaType());
            try {
                $stream = Streams::ofPsr7Stream($file->getStream());
            } catch (\RuntimeException) {
                $this->rejectFailedUpload($metadata);
                continue;
            }
 
            // we take the temporary file name as an identifier as it is the only unique attribute.
            $identifier = $file->getStream()->getMetadata('uri');
 
            $identifier = is_array($identifier) ? '' : $identifier;
 
            $this->uploadStreams[$identifier] = $stream;
 
            if ($file->getError() === UPLOAD_ERR_OK) {
                $processingResult = $this->processorManager->process($stream, $metadata);
 
                // we do discard if the result is a DENIED that there is no further pissibility to process the file.
                if ($processingResult->getCode() === ProcessingStatus::DENIED) {
                    $this->hardRemoveUpload($identifier, $processingResult);
                    continue;
                }
 
                $result = new UploadResult(
                    $metadata->getFilename(),
                    $metadata->getUploadSize(),
                    $metadata->getMimeType(),
                    $metadata->additionalMetaData(),
                    $processingResult,
                    is_string($identifier) ? $identifier : ''
                );
                $this->uploadResult[$identifier] = $result;
            } else {
                $this->rejectFailedUpload($metadata);
            }
        }
 
        $this->processed = true;
    }

References ILIAS\FileUpload\DTO\ProcessingStatus\DENIED, ILIAS\FileUpload\FileUploadImpl\flattenUploadedFiles(), ILIAS\FileUpload\FileUploadImpl\hardRemoveUpload(), ILIAS\Filesystem\Stream\Streams\ofPsr7Stream(), and ILIAS\FileUpload\FileUploadImpl\rejectFailedUpload().

Here is the call graph for this function:

◆ regenerateUploadResultWithCopyError()

ILIAS\FileUpload\FileUploadImpl::regenerateUploadResultWithCopyError	(	UploadResult	$result,
		string	$errorReason
	)

private

Creates a clone of the given result and set the status to rejected with the passed error message.

Parameters

UploadResult	$result	The result which should be cloned.
string	$errorReason	The reason why the error occurred.

Returns: UploadResult The newly cloned rejected result.

Definition at line 193 of file FileUploadImpl.php.

                                                                                                   : UploadResult
    {
        return new UploadResult(
            $result->getName(),
            $result->getSize(),
            $result->getMimeType(),
            $result->getMetaData(),
            new ProcessingStatus(ProcessingStatus::REJECTED, $errorReason),
            ''
        );
    }

References ILIAS\FileUpload\DTO\UploadResult\getMetaData(), ILIAS\FileUpload\DTO\UploadResult\getMimeType(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getSize(), and ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

Referenced by ILIAS\FileUpload\FileUploadImpl\moveFilesTo(), and ILIAS\FileUpload\FileUploadImpl\moveOneFileTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ regenerateUploadResultWithPath()

ILIAS\FileUpload\FileUploadImpl::regenerateUploadResultWithPath	(	UploadResult	$result,
		string	$path
	)

private

Generate an exact copy of the result with the given path.

Parameters

UploadResult	$result	The result which should be cloned.
string	$path	The path which should be set on the result clone.

Returns: UploadResult The cloned result with the given path.

Definition at line 172 of file FileUploadImpl.php.

                                                                                       : UploadResult
    {
        return new UploadResult(
            $result->getName(),
            $result->getSize(),
            $result->getMimeType(),
            $result->getMetaData(),
            $result->getStatus(),
            $path
        );
    }

References ILIAS\FileUpload\DTO\UploadResult\getMetaData(), ILIAS\FileUpload\DTO\UploadResult\getMimeType(), ILIAS\FileUpload\DTO\UploadResult\getName(), ILIAS\FileUpload\DTO\UploadResult\getSize(), and ILIAS\FileUpload\DTO\UploadResult\getStatus().

Referenced by ILIAS\FileUpload\FileUploadImpl\moveFilesTo(), and ILIAS\FileUpload\FileUploadImpl\moveOneFileTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ register()

ILIAS\FileUpload\FileUploadImpl::register ( PreProcessor $preProcessor )

@inheritDoc

Implements ILIAS\FileUpload\FileUpload.

Definition at line 239 of file FileUploadImpl.php.

                                                        : void
    {
        if (!$this->processed) {
            $this->processorManager->with($preProcessor);
        } else {
            throw new IllegalStateException('Can not register processor after the upload was processed.');
        }
    }

◆ rejectFailedUpload()

ILIAS\FileUpload\FileUploadImpl::rejectFailedUpload ( Metadata $metadata )

private

Reject a failed upload with the given metadata.

Parameters

Metadata $metadata The metadata used to create the rejected result.

Definition at line 308 of file FileUploadImpl.php.

                                                           : void
    {
        //reject failed upload
        $processingStatus = new ProcessingStatus(ProcessingStatus::REJECTED, 'Upload failed');
        $extraMetadata = new ImmutableMapWrapper(new EntryLockingStringMap());
        $result = new UploadResult(
            $metadata->getFilename(),
            $metadata->getUploadSize(),
            $metadata->getMimeType(),
            $extraMetadata,
            $processingStatus,
            ''
        );
 
        $this->rejectedUploadResult[] = $result;
    }

References ILIAS\FileUpload\DTO\Metadata\getFilename(), ILIAS\FileUpload\DTO\Metadata\getMimeType(), ILIAS\FileUpload\DTO\Metadata\getUploadSize(), and ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

Referenced by ILIAS\FileUpload\FileUploadImpl\process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectFilesystem()

ILIAS\FileUpload\FileUploadImpl::selectFilesystem ( int $location )

private

Selects the correct filesystem by the given Location constant.

Parameters

int $location The storage location constant defined within the Location interface.

See also: Location

Exceptions

InvalidArgumentException Thrown if the location is not a valid Location constant.

Definition at line 215 of file FileUploadImpl.php.

                                                    : Filesystem
    {
        return match ($location) {
            Location::CUSTOMIZING => $this->filesystems->customizing(),
            Location::STORAGE => $this->filesystems->storage(),
            Location::WEB => $this->filesystems->web(),
            Location::TEMPORARY => $this->filesystems->temp(),
            default => throw new \InvalidArgumentException("No filesystem found for location code \"$location\""),
        };
    }

References $location, ILIAS\FileUpload\Location\CUSTOMIZING, ILIAS\Filesystem\filesystems(), ILIAS\FileUpload\Location\STORAGE, ILIAS\FileUpload\Location\TEMPORARY, and ILIAS\FileUpload\Location\WEB.

Referenced by ILIAS\FileUpload\FileUploadImpl\moveFilesTo(), and ILIAS\FileUpload\FileUploadImpl\moveOneFileTo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uploadSizeLimit()

ILIAS\FileUpload\FileUploadImpl::uploadSizeLimit ( )

@inheritDoc

Implements ILIAS\FileUpload\FileUpload.

Definition at line 230 of file FileUploadImpl.php.

                                     : int
    {
        return $this->upload_limit?->getPhpUploadLimitInBytes() ?? ilFileUtils::getPhpUploadSizeLimitInBytes();
    }

References ilFileUtils\getPhpUploadSizeLimitInBytes().

Here is the call graph for this function:

Field Documentation

◆ $moved

bool ILIAS\FileUpload\FileUploadImpl::$moved = false

private

Definition at line 50 of file FileUploadImpl.php.

◆ $processed

bool ILIAS\FileUpload\FileUploadImpl::$processed = false

private

Definition at line 49 of file FileUploadImpl.php.

Referenced by ILIAS\FileUpload\FileUploadImpl\hasBeenProcessed().

◆ $rejectedUploadResult

array ILIAS\FileUpload\FileUploadImpl::$rejectedUploadResult = []

private

Definition at line 58 of file FileUploadImpl.php.

◆ $uploadResult

UploadResult[] ILIAS\FileUpload\FileUploadImpl::$uploadResult = []

private

Definition at line 54 of file FileUploadImpl.php.

Referenced by ILIAS\FileUpload\FileUploadImpl\moveFilesTo(), and ILIAS\FileUpload\FileUploadImpl\moveOneFileTo().

◆ $uploadStreams

array ILIAS\FileUpload\FileUploadImpl::$uploadStreams = null

private

Definition at line 62 of file FileUploadImpl.php.

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

components/ILIAS/FileUpload/src/FileUploadImpl.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ flattenUploadedFiles()

◆ getResults()

◆ hardRemoveUpload()

◆ hasBeenProcessed()

◆ hasUploads()

◆ moveFilesTo()

◆ moveOneFileTo()

◆ process()

◆ regenerateUploadResultWithCopyError()

◆ regenerateUploadResultWithPath()

◆ register()

◆ rejectFailedUpload()

◆ selectFilesystem()

◆ uploadSizeLimit()

Field Documentation

◆ $moved

◆ $processed

◆ $rejectedUploadResult

◆ $uploadResult

◆ $uploadStreams