ContainerManager.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\ResourceStorage\Manager;
 
use ILIAS\Filesystem\Stream\FileStream;
use ILIAS\FileUpload\DTO\UploadResult;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder;
use ILIAS\ResourceStorage\Resource\ResourceType;
 
final class ContainerManager extends BaseManager
{
    private function normalizePath(string $path_inside_container): string
    {
        // Paths inside a ZIP container must be relative (no leading slash).
        // Some extraction tools (e.g. Windows Explorer) hide entries whose
        // names start with "/". See Mantis 0045580 / 0047237.
        return rtrim(ltrim($path_inside_container, './'), '/');
    }
 
    public function containerFromUpload(
        UploadResult $result,
        ResourceStakeholder $stakeholder,
        ?string $revision_title = null
    ): ResourceIdentification {
        // check if stream is a ZIP
        $this->checkZIP(mime_content_type($result->getMimeType()));
 
        return $this->upload($result, $stakeholder, $revision_title);
    }
 
    public function containerFromStream(
        FileStream $stream,
        ResourceStakeholder $stakeholder,
        ?string $revision_title = null
    ): ResourceIdentification {
        // check if stream is a ZIP
        $this->checkZIP(mime_content_type($stream->getMetadata()['uri']));
 
        return $this->newStreamBased(
            $stream,
            $stakeholder,
            ResourceType::CONTAINER,
            $revision_title
        );
    }
 
    public function createDirectoryInsideContainer(
        ResourceIdentification $container,
        string $path_inside_container
    ): bool {
        $path_inside_container = $this->normalizePath($path_inside_container);
        if (empty($path_inside_container)) {
            return false;
        }
        return $this->resource_builder->createDirectoryInsideContainer(
            $this->getResource($container),
            $path_inside_container
        );
    }
 
    public function removePathInsideContainer(
        ResourceIdentification $container,
        string $path_inside_container
    ): bool {
        if (empty($path_inside_container)) {
            return false;
        }
        return $this->resource_builder->removePathInsideContainer(
            $this->getResource($container),
            $path_inside_container
        );
    }
 
    public function addUploadToContainer(
        ResourceIdentification $container,
        UploadResult $result,
        string $parent_path_inside_container,
    ): bool {
        $parent_path_inside_container = $this->normalizePath($parent_path_inside_container);
        return $this->resource_builder->addUploadToContainer(
            $this->getResource($container),
            $result,
            $parent_path_inside_container
        );
    }
 
    public function addStreamToContainer(
        ResourceIdentification $container,
        FileStream $stream,
        string $path_inside_container,
    ): bool {
        $path_inside_container = $this->normalizePath($path_inside_container);
        if (empty($path_inside_container)) {
            return false;
        }
        return $this->resource_builder->addStreamToContainer(
            $this->getResource($container),
            $stream,
            $path_inside_container
        );
    }
 
}