BaseHTTPResponseBasedConsumer.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\ResourceStorage\Consumer;
 
use ILIAS\FileUpload\MimeType;
use ILIAS\HTTP\Services;
use ILIAS\FileDelivery\Delivery\StreamDelivery;
use ILIAS\ResourceStorage\Consumer\StreamAccess\StreamAccess;
use ILIAS\ResourceStorage\Policy\FileNamePolicy;
use ILIAS\ResourceStorage\Resource\StorableResource;
 
abstract class BaseHTTPResponseBasedConsumer extends BaseConsumer implements DeliveryConsumer
{
    // Firefox determines the content type from the file content anyway for some content.
    private const NON_VALID_EXTENSION_MIME = MimeType::APPLICATION__OCTET_STREAM;
    private Services $http;
    private StreamDelivery $delivery;
 
    public function __construct(
        Services $http,
        StorableResource $resource,
        StreamAccess $stream_access,
        FileNamePolicy $file_name_policy
    ) {
        global $DIC;
        $this->delivery = $DIC->fileDelivery()->delivery();
        parent::__construct($resource, $stream_access, $file_name_policy);
    }
 
    abstract protected function getDisposition(): string;
 
    public function run(): void
    {
        $revision = $this->getRevision();
        $filename_with_extension = $this->file_name ?? $revision->getInformation()->getTitle();
        $extension = pathinfo($filename_with_extension, PATHINFO_EXTENSION);
        $file_name_for_consumer = $this->file_name_policy->prepareFileNameForConsumer($filename_with_extension);
 
        $mime_type = $this->file_name_policy->isValidExtension($extension)
            ? $revision->getInformation()->getMimeType()
            : self::NON_VALID_EXTENSION_MIME;
 
        // Build Response
        $revision = $this->stream_access->populateRevision($revision);
 
        match ($this->getDisposition()) {
            'attachment' => $this->delivery->attached(
                $revision->maybeStreamResolver()?->getStream(),
                $file_name_for_consumer,
                $mime_type
            ),
            'inline' => $this->delivery->inline(
                $revision->maybeStreamResolver()?->getStream(),
                $file_name_for_consumer,
                $mime_type
            ),
            default => throw new \InvalidArgumentException('Invalid disposition'),
        };
    }
}