ILIAS\FileUpload\FileUploadImpl Class Reference

Class FileUploadImpl. More...

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)
	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)
	uploadSizeLimit ()
	register (PreProcessor $preProcessor)
	process ()
	getResults ()
	hasUploads ()
	hasBeenProcessed ()
	Return (bool)true if the current upload has already been processed. More...

Protected Member Functions
	flattenUploadedFiles (array $uploadedFiles)

Private Member Functions
	hardRemoveUpload (string $identifier, ProcessingStatus $status)
	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...

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 46 of file FileUploadImpl.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileUpload\FileUploadImpl::__construct	(	private PreProcessorManager	$processorManager,
		private Filesystems	$filesystems,
		private GlobalHttpState	$globalHttpState
	)

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 73 of file FileUploadImpl.php.

    {
    }

Member Function Documentation

flattenUploadedFiles()

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

protected

Definition at line 349 of file FileUploadImpl.php.

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

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

        return iterator_to_array($recursiveIterator, false);
    }

Here is the caller graph for this function:

getResults()

ILIAS\FileUpload\FileUploadImpl::getResults

(

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 324 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

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 81 of file FileUploadImpl.php.

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

                                                                                   : 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());
    }

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 363 of file FileUploadImpl.php.

References ILIAS\FileUpload\FileUploadImpl\$processed.

                                      : bool
    {
        return $this->processed;
    }

hasUploads()

ILIAS\FileUpload\FileUploadImpl::hasUploads

(

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 337 of file FileUploadImpl.php.

References ILIAS\FileUpload\FileUploadImpl\flattenUploadedFiles().

                                : bool
    {
        if ($this->moved) {
            return false;
        }

        $uploadedFiles = $this->flattenUploadedFiles($this->globalHttpState->request()->getUploadedFiles());

        return ($uploadedFiles !== []);
    }

Here is the call graph for this function:

moveFilesTo()

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

Implements ILIAS\FileUpload\FileUpload.

Definition at line 126 of file FileUploadImpl.php.

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

                                                                                     : 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;
    }

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 96 of file FileUploadImpl.php.

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

                                                                                                                                                                            : 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;
    }

Here is the call graph for this function:

process()

ILIAS\FileUpload\FileUploadImpl::process

(

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 247 of file FileUploadImpl.php.

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

                             : 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;
    }

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 188 of file FileUploadImpl.php.

References ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

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

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

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 167 of file FileUploadImpl.php.

References $path.

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

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

Here is the caller graph for this function:

register()

ILIAS\FileUpload\FileUploadImpl::register

(

PreProcessor

$preProcessor

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 234 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 303 of file FileUploadImpl.php.

References ILIAS\FileUpload\DTO\ProcessingStatus\REJECTED.

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

                                                           : 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;
    }

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

Definition at line 210 of file FileUploadImpl.php.

References 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().

                                                    : 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\""),
        };
    }

Here is the call graph for this function:

Here is the caller graph for this function:

uploadSizeLimit()

ILIAS\FileUpload\FileUploadImpl::uploadSizeLimit

(

)

Implements ILIAS\FileUpload\FileUpload.

Definition at line 225 of file FileUploadImpl.php.

References ilFileUtils\getPhpUploadSizeLimitInBytes().

                                     : int
    {
        return ilFileUtils::getPhpUploadSizeLimitInBytes();
    }

Here is the call graph for this function:

Field Documentation

$moved

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

private

Definition at line 49 of file FileUploadImpl.php.

$processed

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

private

Definition at line 48 of file FileUploadImpl.php.

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

$rejectedUploadResult

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

private

Definition at line 57 of file FileUploadImpl.php.

$uploadResult

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

private

Definition at line 53 of file FileUploadImpl.php.

$uploadStreams

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

private

Definition at line 61 of file FileUploadImpl.php.

---

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

• components/ILIAS/FileUpload/src/FileUploadImpl.php