BaseDelivery.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\FileDelivery\Delivery;
 
use ILIAS\FileDelivery\Delivery\ResponseBuilder\ResponseBuilder;
use ILIAS\FileDelivery\Isolation\IsolationConfig;
use ILIAS\HTTP\Response\ResponseHeader;
use Psr\Http\Message\ResponseInterface;
use ILIAS\HTTP\GlobalHttpState;
 
abstract class BaseDelivery
{
    protected const MIME_TYPE_MAP = __DIR__ . '/../../../FileUpload/src/mime_type_map.php';
 
    protected array $mime_type_map;
 
    public function __construct(
        protected GlobalHttpState $http,
        protected ResponseBuilder $response_builder,
        protected ResponseBuilder $fallback_response_builder,
        protected IsolationConfig $isolation = new IsolationConfig(false, null, null),
    ) {
        if (is_readable(self::MIME_TYPE_MAP)) {
            $map = include self::MIME_TYPE_MAP;
        }
        $this->mime_type_map = $map ?? [];
    }
 
    protected function isRequestHostAllowed(): 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;
    }
 
    protected function isRequestOnContentHost(): 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;
    }
 
    protected function notFound(ResponseInterface $r): never
    {
        $this->http->saveResponse($r->withStatus(404));
        $this->http->sendResponse();
        $this->http->close();
    }
 
    protected function saveAndClose(
        ResponseInterface $r,
        ?string $path_to_delete = null
    ): 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();
    }
 
    protected function setGeneralHeaders(
        ResponseInterface $r,
        string $uri,
        string $mime_type,
        string $file_name,
        Disposition $disposition = Disposition::INLINE,
        bool $isolated = true
    ): 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;
    }
 
    protected function applyIsolationHeaders(ResponseInterface $r): 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;
    }
}