XSendfile.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\FileDelivery\FileDeliveryTypes;

use ILIAS\FileDelivery\ilFileDeliveryType;
use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\HTTP\Services;

final class XSendfile implements ilFileDeliveryType
{
    use HeaderBasedDeliveryHelper;
    public const X_SENDFILE = 'X-Sendfile';
    public const X_SENDFILE_TEMPORARY = 'X-Sendfile-Temporary';


    public function __construct(private Services $httpService)
    {
    }


    public function doesFileExists(string $path_to_file): bool
    {
        return is_readable($path_to_file);
    }


    public function prepare(string $path_to_file, ?FileStream $possible_stream): bool
    {
        //      Nothing has to be done here
        return true;
    }


    public function deliver(string $path_to_file, bool $file_marked_to_delete): void
    {
        $delivery = function () use ($path_to_file): void {
            $response = $this->httpService->response()
                ->withHeader(self::X_SENDFILE, realpath($path_to_file));
            $this->httpService->saveResponse($response);
            $this->httpService->sendResponse();
        };

        if ($file_marked_to_delete) {
            $this->sendFileUnbufferedUsingHeaders($delivery);
        } else {
            $delivery();
        }
    }


    public function supportsInlineDelivery(): bool
    {
        return true;
    }


    public function supportsAttachmentDelivery(): bool
    {
        return true;
    }


    public function supportsStreaming(): bool
    {
        return true;
    }


    public function handleFileDeletion(string $path_to_file): bool
    {
        return unlink($path_to_file);
    }
}