class.ilDAVContainer.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use Sabre\DAV\Exception\Forbidden;
use Sabre\DAV\INode;
use Sabre\DAV\ICollection;
use Psr\Http\Message\RequestInterface;

class ilDAVContainer implements ICollection
{
    use ilWebDAVCheckValidTitleTrait;
    use ilWebDAVAccessChildrenFunctionsTrait;
    use ilWebDAVCommonINodeFunctionsTrait;
    use ilObjFileSecureString;

    public function __construct(
        protected ilObject $obj,
        protected ilObjUser $current_user,
        protected RequestInterface $request,
        protected ilWebDAVObjFactory $dav_factory,
        protected ilWebDAVRepositoryHelper $repository_helper
    ) {
    }

    public function getName(): string
    {
        return $this->obj->getTitle();
    }

    public function getChild($name): INode
    {
        return $this->getChildByParentRefId(
            $this->repository_helper,
            $this->dav_factory,
            $this->obj->getRefId(),
            $name
        );
    }

    public function getChildren(): array
    {
        return $this->getChildrenByParentRefId(
            $this->repository_helper,
            $this->dav_factory,
            $this->obj->getRefId()
        );
    }

    public function childExists($name): bool
    {
        return $this->checkIfChildExistsByParentRefId(
            $this->repository_helper,
            $this->dav_factory,
            $this->obj->getRefId(),
            $name
        );
    }

    public function setName($name): void
    {
        if (!$this->repository_helper->checkAccess("write", $this->obj->getRefId())) {
            throw new Forbidden('Permission denied');
        }

        if ($this->isDAVableObjTitle($name)) {
            $this->obj->setTitle($name);
            $this->obj->update();
        } else {
            throw new Forbidden('Forbidden characters in title');
        }
    }

    public function createFile($name, $data = null): ?string
    {
        if (!$this->repository_helper->checkCreateAccessForType($this->obj->getRefId(), 'file')) {
            throw new Forbidden('Permission denied');
        }

        $size = (int) ($this->request->getHeader("Content-Length")[0] ?? 0);
        if ($size === 0 && $this->request->hasHeader('X-Expected-Entity-Length')) {
            $size = (int) ($this->request->getHeader('X-Expected-Entity-Length')[0] ?? 0);
        }

        if ($size > ilFileUtils::getPhpUploadSizeLimitInBytes()) {
            throw new Forbidden('File is too big');
        }

        $name = $this->ensureSuffix($name, $this->extractSuffixFromFilename($name));

        if ($this->childExists($name)) {
            $file_dav = $this->getChild($name);
        } else {
            try {
                $file_obj = new ilObjFile();
                $file_obj->setTitle($name);

                $file_dav = $this->dav_factory->createDAVObject($file_obj, $this->obj->getRefId());
            } catch (ilWebDAVNotDavableException) {
                throw new Forbidden('Forbidden characters in title');
            }
        }

        try {
            return $file_dav->put($data, $name);
        } catch (Throwable) {
            return null;
        }
    }

    public function createDirectory($name): void
    {
        $new_obj = $this->getChildCollection();

        if (!$this->repository_helper->checkCreateAccessForType($this->obj->getRefId(), $new_obj->getType())) {
            throw new Forbidden('Permission denied');
        }

        try {
            $new_obj->setOwner($this->current_user->getId());
            $new_obj->setTitle($name);
            $this->dav_factory->createDAVObject($new_obj, $this->obj->getRefId());
        } catch (ilWebDAVNotDavableException) {
            throw new Forbidden('Forbidden characters in title');
        }
    }

    public function delete(): void
    {
        $this->repository_helper->deleteObject($this->obj->getRefId());
    }

    public function getLastModified(): ?int
    {
        return $this->retrieveLastModifiedAsIntFromObjectLastUpdateString($this->obj->getLastUpdateDate());
    }

    protected function getChildCollection(): ilContainer
    {
        if ($this->obj::class === 'ilObjCategory') {
            return new ilObjCategory();
        }

        return new ilObjFolder();
    }
}