LegacyDelivery.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\FileDelivery\Delivery;
 
use ILIAS\Filesystem\Stream\Streams;
 
final class LegacyDelivery extends BaseDelivery
{
    public function attached(
        string $path_to_file,
        ?string $download_file_name = null,
        ?string $mime_type = null,
        ?bool $delete_file = false
    ): never {
        $this->deliver(
            $path_to_file,
            Disposition::ATTACHMENT,
            $download_file_name,
            $mime_type,
            $delete_file
        );
    }
 
    public function inline(
        string $path_to_file,
        ?string $download_file_name = null,
        ?string $mime_type = null,
        ?bool $delete_file = false
    ): never {
        $this->deliver(
            $path_to_file,
            Disposition::INLINE,
            $download_file_name,
            $mime_type,
            $delete_file
        );
    }
 
    private function deliver(
        string $path_to_file,
        Disposition $disposition,
        ?string $download_file_name = null,
        ?string $mime_type = null,
        ?bool $delete_file = false
    ): never {
        // The content domain is reserved for signed token delivery via deliver.php.
        // Legacy delivery must never serve files on the content host.
        if ($this->isRequestOnContentHost()) {
            $this->notFound($this->http->response());
        }
 
        // Header based delivery (X-Sendfile, X-Accel-Redirect) opens the file only after PHP has
        // finished, when the shutdown function of saveAndClose() has already deleted it.
        // See https://mantis.ilias.de/view.php?id=48312
        if ($delete_file && !$this->response_builder->supportFileDeletion()) {
            $this->response_builder = $this->fallback_response_builder;
        }
        $r = $this->setGeneralHeaders(
            $this->http->response(),
            $path_to_file,
            $mime_type ?? mime_content_type($path_to_file),
            $download_file_name ?? basename($path_to_file),
            $disposition
        );
        $r = $this->response_builder->buildForStream(
            $this->http->request(),
            $r,
            Streams::ofResource(fopen($path_to_file, 'rb'))
        );
        $this->saveAndClose($r, $delete_file ? $path_to_file : null);
    }
}