ILIAS\FileDelivery\Delivery\StreamDelivery Class Reference

Inheritance diagram for ILIAS\FileDelivery\Delivery\StreamDelivery:

Collaboration diagram for ILIAS\FileDelivery\Delivery\StreamDelivery:

Public Member Functions
	__construct (private DataSigner $data_signer, Services $http, ResponseBuilder $response_builder, ResponseBuilder $fallback_response_builder,)
	attached (FileStream $stream, string $download_file_name, ?string $mime_type=null)
	inline (FileStream $stream, string $download_file_name, ?string $mime_type=null)
	deliver (FileStream $stream, string $download_file_name, ?string $mime_type=null, Disposition $disposition=Disposition::INLINE)
	deliverFromToken (string $token)
Public Member Functions inherited from ILIAS\FileDelivery\Delivery\BaseDelivery
	__construct (protected Services $http, protected ResponseBuilder $response_builder, protected ResponseBuilder $fallback_response_builder,)

Data Fields
const	SUBREQUEST_SEPARATOR = '/-/'

Private Member Functions
	notFound (ResponseInterface $r)
	determineMimeType (string $filename)

Additional Inherited Members
Protected Member Functions inherited from ILIAS\FileDelivery\Delivery\BaseDelivery
	saveAndClose (ResponseInterface $r, string $path_to_delete=null)
	setGeneralHeaders (ResponseInterface $r, string $uri, string $mime_type, string $file_name, Disposition $disposition=Disposition::INLINE)
Protected Attributes inherited from ILIAS\FileDelivery\Delivery\BaseDelivery
const	MIME_TYPE_MAP = __DIR__ . '/../../FileUpload/mime_type_map.php'
array	$mime_type_map

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 36 of file StreamDelivery.php.

Constructor & Destructor Documentation

__construct()

ILIAS\FileDelivery\Delivery\StreamDelivery::__construct	(	private DataSigner	$data_signer,
		Services	$http,
		ResponseBuilder	$response_builder,
		ResponseBuilder	$fallback_response_builder
	)

Definition at line 40 of file StreamDelivery.php.

References ILIAS\MetaData\Repository\Validation\Data\__construct().

      {
        parent::__construct($http, $response_builder, $fallback_response_builder);
    }

Here is the call graph for this function:

Member Function Documentation

attached()

ILIAS\FileDelivery\Delivery\StreamDelivery::attached	(	FileStream	$stream,
		string	$download_file_name,
		?string	$mime_type = null
	)

Definition at line 59 of file StreamDelivery.php.

References ILIAS\FileDelivery\Delivery\$mime_type, and ILIAS\FileDelivery\Delivery\StreamDelivery\deliver().

     : never {
        $this->deliver(
            $stream,
            $download_file_name,
            $mime_type,
            Disposition::ATTACHMENT
        );
    }

Here is the call graph for this function:

deliver()

ILIAS\FileDelivery\Delivery\StreamDelivery::deliver	(	FileStream	$stream,
		string	$download_file_name,
		?string	$mime_type = null,
		Disposition	$disposition = Disposition::INLINE
	)

Definition at line 85 of file StreamDelivery.php.

References ILIAS\FileDelivery\Delivery\$disposition, $r, ILIAS\FileDelivery\http(), ILIAS\FileDelivery\Delivery\BaseDelivery\saveAndClose(), and ILIAS\FileDelivery\Delivery\BaseDelivery\setGeneralHeaders().

Referenced by ILIAS\FileDelivery\Delivery\StreamDelivery\attached(), and ILIAS\FileDelivery\Delivery\StreamDelivery\inline().

     : never {
        $r = $this->http->response();
        $uri = $stream->getMetadata()['uri'];

        if ($stream instanceof ZIPStream || $stream->getMetadata()['uri'] === 'php://memory') {
            $this->response_builder = $this->fallback_response_builder;
        }

        $r = $this->setGeneralHeaders(
            $r,
            $uri,
            $mime_type ?? mime_content_type($uri),
            $download_file_name,
            $disposition
        );

        $r = $this->response_builder->buildForStream(
            $this->http->request(),
            $r,
            $stream
        );
        $this->saveAndClose($r);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deliverFromToken()

ILIAS\FileDelivery\Delivery\StreamDelivery::deliverFromToken

(

string

$token

)

Definition at line 114 of file StreamDelivery.php.

References ILIAS\FileDelivery\Delivery\$disposition, $parts, $payload, $r, ILIAS\FileDelivery\Delivery\StreamDelivery\determineMimeType(), ILIAS\FileDelivery\http(), ILIAS\FileDelivery\Delivery\StreamDelivery\notFound(), ILIAS\Filesystem\Stream\Streams\ofFileInsideZIP(), ILIAS\Filesystem\Stream\Streams\ofResource(), and ILIAS\FileDelivery\Delivery\BaseDelivery\setGeneralHeaders().

                                                   : never
    {
        // check if $token has a sub-request, such as .../index.html
        $parts = explode(self::SUBREQUEST_SEPARATOR, $token);
        $sub_request = null;
        if (count($parts) > 1) {
            $token = $parts[0];
            $sub_request = implode('/', array_slice($parts, 1));
        }

        $r = $this->http->response();
        $payload = $this->data_signer->verifyStreamToken($token);

        switch (true) {
            case $payload instanceof FilePayload:
                $uri = $payload->getUri();
                $mime_type = $payload->getMimeType();
                $file_name = $payload->getFilename();
                $disposition = Disposition::tryFrom($payload->getDisposition()) ?? Disposition::INLINE;
                break;
            case $payload instanceof ShortFilePayload:
                $uri = $payload->getUri();
                $mime_type = $this->determineMimeType($uri);
                $file_name = $payload->getFilename();
                $disposition = Disposition::INLINE;
                break;
            default:
                $this->notFound($r);
        }
        unset($payload);

        // handle direct access to file

        if ($sub_request === null) {
            $r = $this->setGeneralHeaders(
                $r,
                $uri,
                $mime_type,
                $file_name,
                $disposition
            );

            $this->http->saveResponse(
                $this->response_builder->buildForStream(
                    $this->http->request(),
                    $r,
                    Streams::ofResource(fopen($uri, 'rb'))
                )
            );
        } else { // handle subrequest, aka file in a ZIP
            $requested_zip = $uri;
            $sub_request = urldecode($sub_request);
            // remove query
            $sub_request = explode('?', $sub_request)[0];

            try {
                $file_inside_ZIP = Streams::ofFileInsideZIP($requested_zip, $sub_request);
            } catch (\Throwable) {
                $this->notFound($r);
            }
            $file_inside_zip_uri = $file_inside_ZIP->getMetadata()['uri'];
            $file_inside_zip_stream = fopen($file_inside_zip_uri, 'rb');

            if ($file_inside_zip_stream === false) {
                $this->notFound($r);
            }

            // we must use PHPResponseBuilder here, because the streams inside zips cant be delivered using XSendFile or others
            $this->response_builder = $this->fallback_response_builder;

            $mime_type = $this->determineMimeType($file_inside_zip_uri);
            $r = $this->setGeneralHeaders(
                $r,
                $file_inside_zip_uri,
                $mime_type,
                basename($sub_request),
                Disposition::INLINE // subrequests are always inline per default, browsers may change this to download
            );


            $this->http->saveResponse(
                $this->response_builder->buildForStream(
                    $this->http->request(),
                    $r,
                    $file_inside_ZIP
                )
            );
        }
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

determineMimeType()

ILIAS\FileDelivery\Delivery\StreamDelivery::determineMimeType ( string  $filename )

private

Definition at line 206 of file StreamDelivery.php.

Referenced by ILIAS\FileDelivery\Delivery\StreamDelivery\deliverFromToken().

                                                        : string
    {
        $suffix = strtolower(pathinfo($filename, PATHINFO_EXTENSION));
        if (isset($this->mime_type_map[$suffix])) {
            if (is_array($this->mime_type_map[$suffix]) && isset($this->mime_type_map[$suffix][0])) {
                return $this->mime_type_map[$suffix][0];
            }

            return $this->mime_type_map[$suffix];
        }

        $mime_type = mime_content_type($filename);
        if ($mime_type === 'application/octet-stream') {
            $mime_type = mime_content_type(substr($filename, 64));
        }
        return $mime_type ?: 'application/octet-stream';
    }

Here is the caller graph for this function:

inline()

ILIAS\FileDelivery\Delivery\StreamDelivery::inline	(	FileStream	$stream,
		string	$download_file_name,
		?string	$mime_type = null
	)

Definition at line 72 of file StreamDelivery.php.

References ILIAS\FileDelivery\Delivery\StreamDelivery\deliver().

     : never {
        $this->deliver(
            $stream,
            $download_file_name,
            $mime_type,
            Disposition::INLINE
        );
    }

Here is the call graph for this function:

notFound()

ILIAS\FileDelivery\Delivery\StreamDelivery::notFound ( ResponseInterface  $r )

private

Exceptions

Definition at line 52 of file StreamDelivery.php.

References ILIAS\FileDelivery\http().

Referenced by ILIAS\FileDelivery\Delivery\StreamDelivery\deliverFromToken().

                                                   : void
    {
        $this->http->saveResponse($r->withStatus(404));
        $this->http->sendResponse();
        $this->http->close();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

SUBREQUEST_SEPARATOR

const ILIAS\FileDelivery\Delivery\StreamDelivery::SUBREQUEST_SEPARATOR = '/-/'

Definition at line 38 of file StreamDelivery.php.

Referenced by ILIAS\ResourceStorage\Consumer\ContainerURIConsumer\getURI().

---

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

• src/FileDelivery/Delivery/StreamDelivery.php