Inheritance diagram for ILIAS\WebDAV\Objects\TreeProxyRepository:

Collaboration diagram for ILIAS\WebDAV\Objects\TreeProxyRepository:

Public Member Functions
	__construct (private Config $config, private Filter $filter)

	createObject (Type $type, Container $parent, string $name)

	createFile (Container $parent, string $name)

	createContainer (Container $parent, string $name)

	get (string $path, ?Container $parent=null, bool $with_recently_deleted=false,)

	analyseProblems (Container $container)
	Inspect raw children of a container and report titles that cannot be exposed via WebDAV. More...

	in (Container $container, bool $with_recently_deleted=false)

	rename (Entity $entity)

	delete (Entity $entity)

Public Member Functions inherited from ILIAS\WebDAV\Objects\ProxyRepository
	createContainer (Container $parent, string $name)

	get (string $path, ?Container $parent=null)

	in (Container $container, bool $with_recently_deleted=false)

	delete (Entity $entity)

Protected Member Functions
	getByNodeData (array $node_data, ?Type $type=null)

	getByRefId (int $by_ref_id, ?Type $type=null)

Private Member Functions
	tree ()

	manager ()

	info ()

Private Attributes
array	$storage = []

ilTree	$tree = null

Manager	$manager = null

ilObjFileInfoRepository	$file_info_repository = null

ResourceStakeholder	$stakeholder

Detailed Description

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 37 of file TreeProxyRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\WebDAV\Objects\TreeProxyRepository::__construct	(	private Config	$config,
		private Filter	$filter
	)

Definition at line 45 of file TreeProxyRepository.php.

      {
        global $DIC; // TODO remove Service Locator
        $this->stakeholder = new \ilObjFileStakeholder();
    }

References $DIC.

Member Function Documentation

◆ analyseProblems()

ILIAS\WebDAV\Objects\TreeProxyRepository::analyseProblems ( Container $container )

Inspect raw children of a container and report titles that cannot be exposed via WebDAV.

Used to populate the virtual ProblemInfoFile.

Returns: array{ duplicates: list<string>, forbidden: list<string>, info_name_collision: bool }

Definition at line 284 of file TreeProxyRepository.php.

                                                         : array
    {
        $ref_id = $container->getObjectProxy()?->getRefId();
        $duplicates = [];
        $forbidden = [];
        $info_name_collision = false;
        if ($ref_id === null) {
            return [
                'duplicates' => $duplicates,
                'forbidden' => $forbidden,
                'info_name_collision' => $info_name_collision,
            ];
        }
 
        $object_types = $this->config->getSupportedObjectTypes();
        $seen = [];
        foreach ($this->tree()->getChildsByTypeFilter($ref_id, $object_types) as $item) {
            $title = (string) ($item['title'] ?? '');
            if ($title === '') {
                continue;
            }
            if ($title === ProblemInfoFile::FILE_NAME) {
                $info_name_collision = true;
                continue;
            }
            if (!$this->filter->checkName($title)) {
                $forbidden[] = $title;
                continue;
            }
            if (isset($seen[$title])) {
                $duplicates[] = $title;
                continue;
            }
            $seen[$title] = true;
        }
 
        return [
            'duplicates' => $duplicates,
            'forbidden' => $forbidden,
            'info_name_collision' => $info_name_collision,
        ];
    }

References $container, $ref_id, ILIAS\WebDAV\Entity\ProblemInfoFile\FILE_NAME, ILIAS\Repository\filter(), and ILIAS\WebDAV\Objects\TreeProxyRepository\tree().

Here is the call graph for this function:

◆ createContainer()

ILIAS\WebDAV\Objects\TreeProxyRepository::createContainer	(	Container	$parent,
		string	$name
	)

Implements ILIAS\WebDAV\Objects\ProxyRepository.

Definition at line 149 of file TreeProxyRepository.php.

                                                                    : ?Proxy
    {
        $parent_type = $parent->getObjectProxy()?->getType() ?? Type::UNKNOWN;
        $new_type = match ($parent_type) {
            Type::COURSE, Type::GROUP, Type::FOLDER => Type::FOLDER,
            Type::CATEGORY => Type::CATEGORY,
            default => Type::UNKNOWN,
        };
 
        if (Type::UNKNOWN === $new_type) {
            return null;
        }
 
        return $this->createObject(
            $new_type,
            $parent,
            $name,
        );
    }

References ILIAS\WebDAV\Objects\TreeProxyRepository\createObject(), ILIAS\WebDAV\Entity\BaseEntity\getObjectProxy(), and ILIAS\WebDAV\Objects\UNKNOWN.

Here is the call graph for this function:

◆ createFile()

ILIAS\WebDAV\Objects\TreeProxyRepository::createFile	(	Container	$parent,
		string	$name
	)

Definition at line 125 of file TreeProxyRepository.php.

                                                               : ?FileProxy
    {
        if (!$this->filter->checkName($name)) {
            return null;
        }
        if (($proxy = $this->get($name, $parent, true)) !== null && $proxy->getType() === Type::FILE) {
            $ref_id = $parent->getObjectProxy()->getRefId();
            if ($this->tree()->isDeleted($ref_id)) {
                // TODO remove this "beauty". But: WebDAV at least on macOS Finder created a file, deleted it and cretes a
                // new one. we pick up the first from trash if possible to prevent shadow objects.
 
                \ilRepUtil::restoreObjects($ref_id, [$proxy->getRefId()]);
            }
 
            return $proxy;
        }
 
        return $this->createObject(
            Type::FILE,
            $parent,
            $name,
        );
    }

References $ref_id, ILIAS\WebDAV\Objects\TreeProxyRepository\createObject(), ILIAS\Repository\filter(), ILIAS\WebDAV\Entity\BaseEntity\getObjectProxy(), ilRepUtil\restoreObjects(), and ILIAS\WebDAV\Objects\TreeProxyRepository\tree().

Here is the call graph for this function:

◆ createObject()

ILIAS\WebDAV\Objects\TreeProxyRepository::createObject	(	Type	$type,
		Container	$parent,
		string	$name
	)

Definition at line 69 of file TreeProxyRepository.php.

                                                                             : ?Proxy
    {
        if (!$this->filter->checkName($name)) {
            return null;
        }
 
        if (!$this->filter->canUserIn(Action::WRITE, $parent)) {
            return null;
        }
 
        $object = match ($type) {
            Type::COURSE => new \ilObjCourse(),
            Type::GROUP => new \ilObjGroup(),
            Type::FOLDER => new \ilObjFolder(),
            Type::CATEGORY => new \ilObjCategory(),
            Type::FILE => new \ilObjFile(),
            default => null,
        };
 
        if (!$this->filter->canUserCreate($type, $parent)) {
            return null;
        }
 
        if ($object === null) {
            throw new \InvalidArgumentException(
                "Cannot create object of type {$type->name}"
            );
        }
 
        $object->setTitle($name);
 
        if ($type === Type::FILE) {
            $rid = $this->manager()->stream(
                Streams::ofString('-'),
                $this->stakeholder,
                '_Empty'
            );
 
            $object->setResourceId($rid->serialize());
            $this->manager()->unpublish(
                $rid,
            );
        }
 
        $object->create();
        $object->createReference();
        $object->putInTree($parent->getObjectProxy()->getRefId());
        $object->setPermissions($parent->getObjectProxy()->getRefId());
 
        $proxy = $this->getByRefId($object->getRefId(), $type);
        if ($proxy === null || !$this->filter->filterProxy($proxy)) {
            return null;
        }
        return $proxy;
    }

References ILIAS\Repository\filter(), ILIAS\WebDAV\Objects\TreeProxyRepository\getByRefId(), ILIAS\WebDAV\Entity\BaseEntity\getObjectProxy(), ILIAS\WebDAV\Objects\TreeProxyRepository\manager(), and ILIAS\Filesystem\Stream\Streams\ofString().

Referenced by ILIAS\WebDAV\Objects\TreeProxyRepository\createContainer(), and ILIAS\WebDAV\Objects\TreeProxyRepository\createFile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ILIAS\WebDAV\Objects\TreeProxyRepository::delete ( Entity $entity )

Implements ILIAS\WebDAV\Objects\ProxyRepository.

Definition at line 403 of file TreeProxyRepository.php.

                                          : bool
    {
        $ref_id = $entity->getObjectProxy()?->getRefId();
        if ($ref_id === null) {
            return false;
        }
 
        if (!$this->filter->canUserFor(Action::DELETE, $entity)) {
            return false;
        }
 
        global $DIC;
        $DIC->repository()->internal()->domain()->deletion()->deleteObjectsByRefIds([$ref_id]);
 
        return true;
    }

References $DIC, $ref_id, ILIAS\MetaData\Elements\Markers\DELETE, and ILIAS\Repository\filter().

Here is the call graph for this function:

◆ get()

ILIAS\WebDAV\Objects\TreeProxyRepository::get	(	string	$path,
		?Container	$parent = `null`,
		bool	$with_recently_deleted = `false`
	)

Definition at line 169 of file TreeProxyRepository.php.

     : ?Proxy {
        if (!$this->filter->checkName($path)) {
            return null;
        }
 
        if ($path === '') {
            return null;
        }
        if ($parent !== null) {
            foreach ($this->in($parent, $with_recently_deleted) as $proxy) {
                if (!$this->filter->filterProxy($proxy)) {
                    continue;
                }
 
                if ($proxy->getName() === $path) {
                    return $proxy;
                }
            }
            return null;
        }
 
        if (!str_starts_with($path, $this->config->getRefIdPrefix())) {
            return null;
        }
        $ref_id = (int) substr($path, strlen($this->config->getRefIdPrefix()));
        if ($ref_id < 1) {
            return null;
        }
 
        $proxy = $this->getByRefId($ref_id);
        if ($proxy === null || !$this->filter->filterProxy($proxy)) {
            return null;
        }
        return $proxy;
    }

References $path, $ref_id, ILIAS\Repository\filter(), ILIAS\WebDAV\Objects\TreeProxyRepository\getByRefId(), ILIAS\WebDAV\Objects\TreeProxyRepository\in(), and ILIAS\Repository\int().

Here is the call graph for this function:

◆ getByNodeData()

ILIAS\WebDAV\Objects\TreeProxyRepository::getByNodeData	(	array	$node_data,
		?Type	$type = `null`
	)

protected

Definition at line 209 of file TreeProxyRepository.php.

                                                                          : ?Proxy
    {
        $ref_id = $node_data['ref_id'] ?? 0;
        if ($ref_id < 1) {
            return null;
        }
 
        if (isset($this->storage[$ref_id])) {
            return $this->storage[$ref_id];
        }
 
        $type ??= Type::tryFrom($node_data['type'] ?? '') ?? Type::UNKNOWN;
        $infos = null;
        $stream_resolver = null;
 
        // Check Title for Compatibility
        $title = $node_data['title'] ?? '$';
        if (!$this->filter->checkName($title)) {
            return null;
        }
 
        if ($type === Type::FILE) {
            // aggregate data from IRSS
            $infos = $this->info()->getByRefId((int) $node_data['ref_id']);
            $stream_resolver = new IRSSStreamHandler($infos?->getRID());
 
            $file_tree_proxy = new FileTreeProxy(
                $ref_id,
                $node_data['obj_id'] ?? 0,
                $title,
                strtotime($node_data['last_update'] ?? '') ?: 0,
                $infos?->getMimeType(),
                (int) $infos?->getFileSize()->inBytes(),
                $stream_resolver
            );
            if (!$this->filter->filterProxy($file_tree_proxy)) {
                return null;
            }
 
            return $this->storage[$ref_id] = $file_tree_proxy;
        }
 
        $tree_proxy = new TreeProxy(
            $ref_id,
            $node_data['obj_id'] ?? 0,
            $title,
            strtotime($node_data['last_update'] ?? '') ?: 0,
            $type
        );
 
        if (!$this->filter->filterProxy($tree_proxy)) {
            return null;
        }
 
        return $this->storage[$ref_id] = $tree_proxy;
    }

References $ref_id, ILIAS\Repository\filter(), ILIAS\WebDAV\Objects\TreeProxyRepository\info(), and ILIAS\WebDAV\Objects\UNKNOWN.

Referenced by ILIAS\WebDAV\Objects\TreeProxyRepository\getByRefId(), and ILIAS\WebDAV\Objects\TreeProxyRepository\in().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getByRefId()

ILIAS\WebDAV\Objects\TreeProxyRepository::getByRefId	(	int	$by_ref_id,
		?Type	$type = `null`
	)

protected

Definition at line 266 of file TreeProxyRepository.php.

                                                                     : ?Proxy
    {
        return $this->getByNodeData(
            $this->tree()->getNodeData($by_ref_id),
            $type
        );
    }

References ILIAS\WebDAV\Objects\TreeProxyRepository\getByNodeData(), and ILIAS\WebDAV\Objects\TreeProxyRepository\tree().

Referenced by ILIAS\WebDAV\Objects\TreeProxyRepository\createObject(), and ILIAS\WebDAV\Objects\TreeProxyRepository\get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ in()

ILIAS\WebDAV\Objects\TreeProxyRepository::in	(	Container	$container,
		bool	$with_recently_deleted = `false`
	)

Implements ILIAS\WebDAV\Objects\ProxyRepository.

Definition at line 327 of file TreeProxyRepository.php.

                                                                                 : \Generator|Proxy
    {
        $ref_id = $container->getObjectProxy()?->getRefId();
        if ($ref_id === null) {
            return;
        }
 
        $object_types = $this->config->getSupportedObjectTypes();
 
        foreach (
            $this->tree()->getChildsByTypeFilter($ref_id, $object_types) as $item
        ) {
            // check title for compatibility
            if (!$this->filter->checkName($item['title'] ?? '$')) {
                continue;
            }
 
            $proxy = $this->getByNodeData($item);
            if ($proxy === null) {
                continue;
            }
            if (!$this->filter->filterProxy($proxy)) {
                continue;
            }
            yield $proxy;
        }
 
        // check for deleted objects
        if ($with_recently_deleted) {
            foreach ($this->tree()->getSavedNodeData($ref_id) as $saved_node) {
                if (Type::tryFrom($saved_node['type'] ?? '') !== Type::FILE) {
                    continue;
                }
 
                $deleted = new \DateTimeImmutable($saved_node['deleted'] ?? 'now');
                // check if deleted in the last 30 seconds
                $threshold = (new \DateTimeImmutable())->modify(
                    "-{$this->config->getDeletedObjectsRetentionPeriod()} seconds"
                );
                if ($deleted < $threshold) {
                    continue;
                }
 
                $proxy = $this->getByNodeData($saved_node);
                if ($proxy === null) {
                    continue;
                }
                if (!$this->filter->filterProxy($proxy)) {
                    continue;
                }
                yield $proxy;
            }
        }
    }

References $container, $ref_id, ILIAS\Repository\filter(), ILIAS\WebDAV\Objects\TreeProxyRepository\getByNodeData(), and ILIAS\WebDAV\Objects\TreeProxyRepository\tree().

Referenced by ILIAS\WebDAV\Objects\TreeProxyRepository\get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ info()

ILIAS\WebDAV\Objects\TreeProxyRepository::info ( )

private

Definition at line 64 of file TreeProxyRepository.php.

                           : \ilObjFileInfoRepository
    {
        return $this->file_info_repository ?? $this->file_info_repository = new \ilObjFileInfoRepository();
    }

Referenced by ILIAS\WebDAV\Objects\TreeProxyRepository\getByNodeData().

Here is the caller graph for this function:

◆ manager()

ILIAS\WebDAV\Objects\TreeProxyRepository::manager ( )

private

Definition at line 58 of file TreeProxyRepository.php.

                              : Manager
    {
        global $DIC;
        return $this->manager ?? $this->manager = $DIC->resourceStorage()->manage();
    }

References $DIC, and ILIAS\WebDAV\Objects\TreeProxyRepository\manager().

Referenced by ILIAS\WebDAV\Objects\TreeProxyRepository\createObject(), and ILIAS\WebDAV\Objects\TreeProxyRepository\manager().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rename()

ILIAS\WebDAV\Objects\TreeProxyRepository::rename ( Entity $entity )

Definition at line 382 of file TreeProxyRepository.php.

                                          : bool
    {
        $ref_id = $entity->getObjectProxy()?->getRefId();
        if ($ref_id === null) {
            return false;
        }
        if (!$this->filter->checkName($entity->getName())) {
            return false;
        }
 
        if (!$this->filter->canUserFor(Action::WRITE, $entity)) {
            return false;
        }
 
        $object = \ilObjectFactory::getInstanceByRefId($ref_id);
        $object->setTitle($entity->getName());
        $object->update();
 
        return true;
    }

References $ref_id, ILIAS\Repository\filter(), ilObjectFactory\getInstanceByRefId(), and ILIAS\WebDAV\Entity\Entity\getObjectProxy().

Here is the call graph for this function:

◆ tree()

ILIAS\WebDAV\Objects\TreeProxyRepository::tree ( )

private

Definition at line 53 of file TreeProxyRepository.php.

                           : \ilTree
    {
        return $this->tree ?? $this->tree = $GLOBALS['DIC']->repositoryTree();
    }

References $GLOBALS, and ILIAS\WebDAV\Objects\TreeProxyRepository\tree().

Referenced by ILIAS\WebDAV\Objects\TreeProxyRepository\analyseProblems(), ILIAS\WebDAV\Objects\TreeProxyRepository\createFile(), ILIAS\WebDAV\Objects\TreeProxyRepository\getByRefId(), ILIAS\WebDAV\Objects\TreeProxyRepository\in(), and ILIAS\WebDAV\Objects\TreeProxyRepository\tree().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $file_info_repository

ilObjFileInfoRepository ILIAS\WebDAV\Objects\TreeProxyRepository::$file_info_repository = null

private

Definition at line 42 of file TreeProxyRepository.php.

◆ $manager

Manager ILIAS\WebDAV\Objects\TreeProxyRepository::$manager = null

private

Definition at line 41 of file TreeProxyRepository.php.

◆ $stakeholder

ResourceStakeholder ILIAS\WebDAV\Objects\TreeProxyRepository::$stakeholder

private

Definition at line 43 of file TreeProxyRepository.php.

◆ $storage

array ILIAS\WebDAV\Objects\TreeProxyRepository::$storage = []

private

Definition at line 39 of file TreeProxyRepository.php.

◆ $tree

ilTree ILIAS\WebDAV\Objects\TreeProxyRepository::$tree = null

private

Definition at line 40 of file TreeProxyRepository.php.

The documentation for this class was generated from the following file:

components/ILIAS/WebDAV/src/Objects/TreeProxyRepository.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ analyseProblems()

◆ createContainer()

◆ createFile()

◆ createObject()

◆ delete()

◆ get()

◆ getByNodeData()

◆ getByRefId()

◆ in()

◆ info()

◆ manager()

◆ rename()

◆ tree()

Field Documentation

◆ $file_info_repository

◆ $manager

◆ $stakeholder

◆ $storage

◆ $tree