ILIAS\FileDelivery\Delivery\BaseDelivery Class Reference

Inheritance diagram for ILIAS\FileDelivery\Delivery\BaseDelivery:

Collaboration diagram for ILIAS\FileDelivery\Delivery\BaseDelivery:

Public Member Functions
	__construct (protected GlobalHttpState $http, protected ResponseBuilder $response_builder, protected ResponseBuilder $fallback_response_builder, protected IsolationConfig $isolation=new IsolationConfig(false, null, null),)

Protected Member Functions
	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
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 32 of file BaseDelivery.php.

Constructor & Destructor Documentation

__construct()

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)
	)

Definition at line 38 of file BaseDelivery.php.

      {
        if (is_readable(self::MIME_TYPE_MAP)) {
            $map = include self::MIME_TYPE_MAP;
        }
        $this->mime_type_map = $map ?? [];
    }

References ILIAS\FileDelivery\Delivery\BaseDelivery\MIME_TYPE_MAP.

Member Function Documentation

applyIsolationHeaders()

ILIAS\FileDelivery\Delivery\BaseDelivery::applyIsolationHeaders ( ResponseInterface  $r )

protected

When isolation is active, harden delivery responses:

• prevent MIME sniffing
• mark as cross-origin so the main app may embed assets via , <iframe>, …
• allow CORS access only from the configured ILIAS domain
• strip referrer to avoid leaking the content domain back to the app

Definition at line 153 of file BaseDelivery.php.

                                                                  : ResponseInterface
    {
        if (!$this->isolation->isActivated()) {
            return $r;
        }
 
        $r = $r->withHeader(ResponseHeader::X_CONTENT_TYPE_OPTIONS, 'nosniff');
        $r = $r->withHeader('Cross-Origin-Resource-Policy', 'cross-origin');
        $r = $r->withHeader('Referrer-Policy', 'no-referrer');
 
        if (($ilias_domain = $this->isolation->getIliasDomain()) !== null) {
            $r = $r->withHeader(ResponseHeader::ACCESS_CONTROL_ALLOW_ORIGIN, $ilias_domain);
            $r = $r->withAddedHeader('Vary', 'Origin');
        }
 
        return $r;
    }

isRequestHostAllowed()

ILIAS\FileDelivery\Delivery\BaseDelivery::isRequestHostAllowed ( )

protected

When user content isolation is active, only requests targeting the configured content domain may be served.

Requests reaching the delivery endpoint via the main ILIAS domain are rejected.

Definition at line 55 of file BaseDelivery.php.

                                             : bool
    {
        if (!$this->isolation->isActivated()) {
            return true;
        }
 
        $expected = $this->isolation->getContentHost();
        if ($expected === null) {
            return true;
        }
 
        return strcasecmp($this->http->request()->getUri()->getHost(), $expected) === 0;
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

isRequestOnContentHost()

ILIAS\FileDelivery\Delivery\BaseDelivery::isRequestOnContentHost ( )

protected

Inverse of {.

See also

self::isRequestHostAllowed()} for the legacy/internal delivery path: the content domain is reserved for signed token delivery via deliver.php. Legacy or app-context delivery must never happen on the content host, so callers reject such requests.

Definition at line 75 of file BaseDelivery.php.

                                               : bool
    {
        if (!$this->isolation->isActivated()) {
            return false;
        }
 
        $content_host = $this->isolation->getContentHost();
        if ($content_host === null) {
            return false;
        }
 
        return strcasecmp($this->http->request()->getUri()->getHost(), $content_host) === 0;
    }

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

notFound()

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

protected

Send an empty 404 response and terminate.

Declared never so the type system guarantees callers cannot fall through to actually serving a file after a rejected request.

Definition at line 94 of file BaseDelivery.php.

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

References ILIAS\FileDelivery\http().

Here is the call graph for this function:

saveAndClose()

ILIAS\FileDelivery\Delivery\BaseDelivery::saveAndClose ( ResponseInterface  $r, ?string  $path_to_delete = null  )

protected

Definition at line 101 of file BaseDelivery.php.

     : never {
        if ($path_to_delete !== null && file_exists($path_to_delete)) {
            // close() ends the request, the file can only be deleted by a shutdown function,
            // see https://mantis.ilias.de/view.php?id=48312
            ignore_user_abort(true);
            set_time_limit(0);
            register_shutdown_function(static function () use ($path_to_delete): void {
                if (file_exists($path_to_delete)) {
                    unlink($path_to_delete);
                }
            });
        }
 
        $this->http->saveResponse($r);
        $this->http->sendResponse();
        $this->http->close();
    }

setGeneralHeaders()

ILIAS\FileDelivery\Delivery\BaseDelivery::setGeneralHeaders ( ResponseInterface  $r, string  $uri, string  $mime_type, string  $file_name, Disposition  $disposition = Disposition::INLINE, bool  $isolated = true  )

protected

Definition at line 122 of file BaseDelivery.php.

     : ResponseInterface {
        $r = $r->withHeader('X-ILIAS-FileDelivery-Method', $this->response_builder->getName());
        $r = $r->withHeader(ResponseHeader::CONTENT_TYPE, $mime_type);
        $r = $r->withHeader(
            ResponseHeader::CONTENT_DISPOSITION,
            (new ContentDispositionHeader())->build($disposition->value, $file_name)
        );
        $r = $r->withHeader(ResponseHeader::CACHE_CONTROL, 'max-age=31536000, immutable, private');
        $r = $r->withHeader(
            ResponseHeader::EXPIRES,
            date("D, j M Y H:i:s", strtotime('+5 days')) . " GMT"
        );
 
        // files delivered on the ILIAS domain are same-origin, the cross-origin headers do not apply
        return $isolated ? $this->applyIsolationHeaders($r) : $r;
    }

Field Documentation

$mime_type_map

array ILIAS\FileDelivery\Delivery\BaseDelivery::$mime_type_map

protected

Definition at line 36 of file BaseDelivery.php.

MIME_TYPE_MAP

const ILIAS\FileDelivery\Delivery\BaseDelivery::MIME_TYPE_MAP = __DIR__ . '/../../../FileUpload/src/mime_type_map.php'

protected

Definition at line 34 of file BaseDelivery.php.

Referenced by ILIAS\FileDelivery\Delivery\BaseDelivery\__construct().

---

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

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