ContainerURIConsumer.php

Go to the documentation of this file.

<?php

namespace ILIAS\ResourceStorage\Consumer;

use ILIAS\Filesystem\Util\Archive\Archives;
use ILIAS\ResourceStorage\Resource\StorableResource;
use ILIAS\ResourceStorage\Consumer\StreamAccess\StreamAccess;
use ILIAS\ResourceStorage\Resource\StorableContainerResource;
use ILIAS\Data\URI;
use ILIAS\FileDelivery\Delivery\StreamDelivery;

class ContainerURIConsumer implements ContainerConsumer
{
    use GetRevisionTrait;

    private Archives $archives;
    protected ?int $revision_number = null;
    private StorableResource $resource;

    public function __construct(
        private SrcBuilder $src_builder,
        StorableContainerResource $resource,
        private StreamAccess $stream_access,
        private string $start_file,
        private float $valid_for_at_least_minutes = 60.0
    ) {
        global $DIC;
        $this->resource = $resource;
        $this->archives = $DIC->archives();
    }

    public function getURI(): ?URI
    {
        $filename = basename($this->start_file);
        if ($filename === '') {
            $filename = null;
        }

        $startfile = urlencode($this->start_file); // e.g. for files with " " (spaces)
        $startfile = str_replace(urlencode("/"), "/", $startfile); // we must keep directory sepparators

        $uri_string = $this->src_builder->getRevisionURL(
            $this->stream_access->populateRevision($this->getRevision()),
            true,
            $this->valid_for_at_least_minutes,
            $filename
        ) . StreamDelivery::SUBREQUEST_SEPARATOR . $startfile;

        try {
            return new URI($uri_string);
        } catch (\Throwable) {
            return null;
        }
    }
}