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 DataSigning $data_signer, GlobalHttpState $http, ResponseBuilder $response_builder, ResponseBuilder $fallback_response_builder, IsolationConfig $isolation=new IsolationConfig(false, null, null),)
	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 GlobalHttpState $http, protected ResponseBuilder $response_builder, protected ResponseBuilder $fallback_response_builder, protected IsolationConfig $isolation=new IsolationConfig(false, null, null),)

Data Fields
const	SUBREQUEST_SEPARATOR = '/-/'

Private Member Functions
	isTemporaryFile (string $uri)
	determineMimeType (string $filename)

Additional Inherited Members
Protected Member Functions inherited from ILIAS\FileDelivery\Delivery\BaseDelivery
	isRequestHostAllowed ()
	When user content isolation is active, only requests targeting the configured content domain may be served. More...
	isRequestOnContentHost ()
	Inverse of {. More...
	notFound (ResponseInterface $r)
	Send an empty 404 response and terminate. More...
	saveAndClose (ResponseInterface $r, ?string $path_to_delete=null)
	setGeneralHeaders (ResponseInterface $r, string $uri, string $mime_type, string $file_name, Disposition $disposition=Disposition::INLINE, bool $isolated=true)
	applyIsolationHeaders (ResponseInterface $r)
	When isolation is active, harden delivery responses: More...
Protected Attributes inherited from ILIAS\FileDelivery\Delivery\BaseDelivery
const	MIME_TYPE_MAP = __DIR__ . '/../../../FileUpload/src/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 DataSigning	$data_signer,
		GlobalHttpState	$http,
		ResponseBuilder	$response_builder,
		ResponseBuilder	$fallback_response_builder,
		IsolationConfig	$isolation = new IsolationConfig(false, null, null)
	)

Definition at line 43 of file StreamDelivery.php.

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

References ILIAS\BookingManager\Common\Table\$http, and ILIAS\GlobalScreen\Provider\__construct().

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 53 of file StreamDelivery.php.

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

deliver()

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

Definition at line 79 of file StreamDelivery.php.

     : never {
        $r = $this->http->response();
        $uri = $stream->getMetadata()['uri'];
 
        // Temporary files (e.g. ZIPs built by ILIAS\Filesystem\Util\Archive\Zip) are removed by a
        // shutdown function as soon as this request exits. Header based delivery (X-Sendfile,
        // X-Accel-Redirect) opens the file only after PHP has finished, so it would no longer exist.
        // Such files must be streamed by PHP itself, see https://mantis.ilias.de/view.php?id=48367
        if (
            $stream instanceof ZIPStream
            || $uri === 'php://memory'
            || $this->isTemporaryFile((string) $uri)
        ) {
            $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);
    }

deliverFromToken()

ILIAS\FileDelivery\Delivery\StreamDelivery::deliverFromToken

(

string

$token

)

Definition at line 134 of file StreamDelivery.php.

                                                   : never
    {
        $r = $this->http->response();
 
        // 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));
        }
 
        $payload = $this->data_signer->verifyStreamToken($token);
 
        // a token signed for the ILIAS domain is served there only, all others only on the content domain
        $isolated = !$payload instanceof ShortFilePayload || $payload->isIsolated();
        $host_allowed = $isolated ? $this->isRequestHostAllowed() : !$this->isRequestOnContentHost();
        if (!$host_allowed) {
            $this->notFound($r);
        }
 
        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,
                $isolated
            );
 
            $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
                $isolated
            );
 
 
            $this->http->saveResponse(
                $this->response_builder->buildForStream(
                    $this->http->request(),
                    $r,
                    $file_inside_ZIP
                )
            );
        }
        $this->http->sendResponse();
        $this->http->close();
    }

References $token, ILIAS\FileDelivery\Token\Signer\Payload\FilePayload\getUri(), ILIAS\FileDelivery\Token\Signer\Payload\ShortFilePayload\getUri(), ILIAS\FileDelivery\http(), and ILIAS\FileDelivery\Token\Signer\Payload\ShortFilePayload\isIsolated().

Referenced by ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryIsolationTest\deliverFromToken().

Here is the call graph for this function:

Here is the caller graph for this function:

determineMimeType()

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

private

Definition at line 236 of file StreamDelivery.php.

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

References $filename.

inline()

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

Definition at line 66 of file StreamDelivery.php.

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

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

Here is the call graph for this function:

isTemporaryFile()

ILIAS\FileDelivery\Delivery\StreamDelivery::isTemporaryFile ( string  $uri )

private

Definition at line 116 of file StreamDelivery.php.

                                                 : bool
    {
        $real_path = realpath($uri);
        if ($real_path === false) {
            return false;
        }
        $temp_dirs = array_filter([
            defined('CLIENT_DATA_DIR') ? realpath(\CLIENT_DATA_DIR . '/temp') : false,
            realpath(sys_get_temp_dir()),
        ]);
        foreach ($temp_dirs as $temp_dir) {
            if (str_starts_with($real_path, rtrim($temp_dir, '/') . '/')) {
                return true;
            }
        }
        return false;
    }

References CLIENT_DATA_DIR.

Field Documentation

SUBREQUEST_SEPARATOR

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

Definition at line 41 of file StreamDelivery.php.

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

---

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

• components/ILIAS/FileDelivery/src/Delivery/StreamDelivery.php