class.ilWebDAVObjFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use Sabre\DAV\Exception\NotFound;
use ILIAS\ResourceStorage\Services;
use Sabre\DAV\INode;
use Sabre\DAV\Exception\Forbidden;
use Psr\Http\Message\RequestInterface;

class ilWebDAVObjFactory
{
    use ilWebDAVCheckValidTitleTrait;

    private array $davable_object_types = [
        'cat',
        'crs',
        'fold',
        'file',
        'grp'
    ];

    protected array $_cache = [];

    public function __construct(
        protected ilWebDAVRepositoryHelper $repository_helper,
        protected ilObjUser $current_user,
        protected Services $resource_storage,
        protected RequestInterface $request,
        protected ilLanguage $language,
        protected string $client_id,
        protected bool $versioning_enabled
    ) {
    }

    public function retrieveDAVObjectByRefID(int $ref_id): INode
    {
        if (!$this->checkReadAndVisibleAccessForObj($ref_id)) {
            throw new Forbidden("No read permission for object with reference ID $ref_id");
        }

        if (isset($this->_cache[$ref_id])) {
            return $this->_cache[$ref_id];
        }

        $ilias_object = ilObjectFactory::getInstanceByRefId($ref_id);

        if ($ilias_object === null) {
            throw new NotFound();
        }

        $ilias_object_type = $ilias_object->getType();

        if (!in_array($ilias_object_type, $this->davable_object_types)) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TYPE_NOT_DAVABLE);
        }

        if ($this->isHiddenFile($ilias_object->getTitle())) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_HIDDEN);
        }

        if ($this->hasTitleForbiddenChars($ilias_object->getTitle())) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE);
        }

        if ($ilias_object_type === 'file') {
            return $this->_cache[$ref_id] = new ilDAVFile(
                $ilias_object,
                $this->repository_helper,
                $this->resource_storage,
                $this->request,
                $this,
                $this->versioning_enabled
            );
        }

        return $this->_cache[$ref_id] = new ilDAVContainer(
            $ilias_object,
            $this->current_user,
            $this->request,
            $this,
            $this->repository_helper
        );
    }

    public function createDAVObject(ilObject $ilias_object, int $parent_ref_id): INode
    {
        if (!$this->isDAVableObjTitle($ilias_object->getTitle())) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE);
        }

        if ($ilias_object->getType() === 'file' &&
            !$this->hasValidFileExtension($ilias_object->getTitle())) {
            throw new ilWebDAVNotDavableException(ilWebDAVNotDavableException::OBJECT_TITLE_NOT_DAVABLE);
        }

        if ($ilias_object->getRefId() === 0) {
            $ilias_object->create();
            $ilias_object->createReference();
            $ilias_object->putInTree($parent_ref_id);
            $ilias_object->setPermissions($parent_ref_id);
        }

        $ref_id = $ilias_object->getRefId();

        if ($ilias_object->getType() === 'file') {
            return $this->_cache[$ref_id] = new ilDAVFile(
                $ilias_object,
                $this->repository_helper,
                $this->resource_storage,
                $this->request,
                $this,
                $this->versioning_enabled
            );
        }

        return $this->_cache[$ref_id] = new ilDAVContainer(
            $ilias_object,
            $this->current_user,
            $this->request,
            $this,
            $this->repository_helper
        );
    }

    public function getProblemInfoFile(int $container_ref_id): ilDAVProblemInfoFile
    {
        return new ilDAVProblemInfoFile($container_ref_id, $this->repository_helper, $this, $this->language);
    }

    public function getMountPoint(): ilDAVMountPoint
    {
        return new ilDAVMountPoint($this->client_id, $this, $this->repository_helper, $this->current_user);
    }

    public function getClientNode(string $name): ilDAVClientNode
    {
        if ($name !== $this->client_id) {
            throw new NotFound();
        }

        return new ilDAVClientNode($this->client_id, $this, $this->repository_helper);
    }

    protected function checkReadAndVisibleAccessForObj(int $child_ref): bool
    {
        return $this->repository_helper->checkAccess("visible", $child_ref) && $this->repository_helper->checkAccess(
            "read",
            $child_ref
        );
    }
}