XAccelResponseBuilder.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\FileDelivery\Delivery\ResponseBuilder;
 
use Psr\Http\Message\ResponseInterface;
use ILIAS\Filesystem\Stream\FileStream;
use Psr\Http\Message\ServerRequestInterface;
 
class XAccelResponseBuilder implements ResponseBuilder
{
    private const DATA = 'data';
    private const SECURED_DATA = 'secured-data';
    private const SECURED_EXT_DATA = 'secured-ext-data';
    private const X_ACCEL_REDIRECT_HEADER = 'X-Accel-Redirect';
 
    public function __construct(private string $external_data_dir)
    {
        $this->external_data_dir = rtrim($this->external_data_dir, '/') . '/';
    }
 
    public function getName(): string
    {
        return 'x-accel';
    }
 
    public function buildForStream(
        ServerRequestInterface $request,
        ResponseInterface $response,
        FileStream $stream,
    ): ResponseInterface {
        $path_to_file = $stream->getMetadata('uri');
        if (str_starts_with((string) $path_to_file, './' . self::DATA . '/')) {
            $path_to_file = str_replace(
                './' . self::DATA . '/',
                '/' . self::SECURED_DATA
                . '/',
                $path_to_file
            );
        } elseif (str_starts_with((string) $path_to_file, $this->external_data_dir)) {
            $path_to_file = str_replace(
                $this->external_data_dir,
                '/' . self::SECURED_EXT_DATA . '/',
                $path_to_file
            );
        }
 
        return $response->withHeader(
            self::X_ACCEL_REDIRECT_HEADER,
            $path_to_file
        );
    }
 
    public function supportPartial(): bool
    {
        return true;
    }
 
    public function supportStreaming(): bool
    {
        return true;
    }
 
    public function supportFileDeletion(): bool
    {
        return false;
    }
 
    public function supportsInlineDelivery(): bool
    {
        return true;
    }
 
    public function supportsAttachmentDelivery(): bool
    {
        return true;
    }
}