ilObjContainerDAV Class Reference

Class ilObjContainerDAV. More...

Inheritance diagram for ilObjContainerDAV:

Collaboration diagram for ilObjContainerDAV:

Public Member Functions
	__construct (ilContainer $a_obj, ilWebDAVRepositoryHelper $repo_helper, ilWebDAVObjDAVHelper $dav_helper)
	Check if given object has valid type and calls parent constructor. More...
	createFile ($name, $data=null)
	Creates a new file in the directory. More...
	createDirectory ($name)
	Creates a new subdirectory. More...
	getChild ($name)
	Returns a specific child node, referenced by its name. More...
	getChildren ()
	Returns an array with all the child nodes. More...
	childExists ($name)
	Checks if a child-node with the specified name exists. More...
	getChildCollectionType ()
	Return the type for child collections of this collection For courses, groups and folders the type is 'fold' For categories the type is 'cat'. More...
Public Member Functions inherited from ilObjectDAV
	__construct (ilObject $a_obj, ilWebDAVRepositoryHelper $repo_helper, ilWebDAVObjDAVHelper $dav_helper)
	Constructor for DAV Object. More...
	getRefId ()
	Returns the ref id of this object. More...
	getObjectId ()
	Returns the object id of this object. More...
	getLastModified ()
	Returns the last modification time as a unix timestamp. More...
	delete ()
	Deletes the current node. More...
	setName ($a_name)
	Renames the node. More...
	getName ()
	SabreDAV interface function . More...
	getObject ()
	Returns ILIAS Object. More...

Protected Member Functions
	checkReadAndVisibleAccessForObj ($child_ref)

Additional Inherited Members
Protected Attributes inherited from ilObjectDAV
	$ref_id
	$obj
	$request
	$repo_helper
	$dav_helper

Detailed Description

Class ilObjContainerDAV.

Base implementation for container objects to be represented as WebDAV collection.

Author

Raphael Heer rapha.nosp@m.el.h.nosp@m.eer@h.nosp@m.slu..nosp@m.ch $Id$

Definition at line 21 of file class.ilObjContainerDAV.php.

Constructor & Destructor Documentation

__construct()

ilObjContainerDAV::__construct	(	ilContainer	$a_obj,
		ilWebDAVRepositoryHelper	$repo_helper,
		ilWebDAVObjDAVHelper	$dav_helper
	)

Check if given object has valid type and calls parent constructor.

Parameters

ilContainer

$a_obj

Definition at line 28 of file class.ilObjContainerDAV.php.

References ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($a_obj, $repo_helper, $dav_helper);
    }

Here is the call graph for this function:

Member Function Documentation

checkReadAndVisibleAccessForObj()

ilObjContainerDAV::checkReadAndVisibleAccessForObj (   $child_ref )

protected

Definition at line 259 of file class.ilObjContainerDAV.php.

References getChildCollectionType().

Referenced by childExists(), getChild(), and getChildren().

    {
        return $this->repo_helper->checkAccess("visible", $child_ref) && $this->repo_helper->checkAccess("read", $child_ref);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

childExists()

ilObjContainerDAV::childExists

(

$name

)

Checks if a child-node with the specified name exists.

Parameters

string

$name

Returns

bool

Definition at line 235 of file class.ilObjContainerDAV.php.

References $name, and checkReadAndVisibleAccessForObj().

Referenced by createFile().

    {
        foreach ($this->repo_helper->getChildrenOfRefId($this->obj->getRefId()) as $child_ref) {
            // Only davable object types
            if ($this->dav_helper->isDAVableObject($child_ref, true)) {
                // Check if names are the same
                if ($this->repo_helper->getObjectTitleFromRefId($child_ref, true) == $name) {
                    // Check if read permission is given
                    if ($this->checkReadAndVisibleAccessForObj($child_ref)) {
                        return true;
                    } else {
                        /*
                         * This is an interesting edge case. What happens if there are 2 objects with the same name
                         * but User1 only has access to the first and user2 has only access to the second?
                         */
                        return false;
                    }
                }
            }
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createDirectory()

ilObjContainerDAV::createDirectory

(

$name

)

Creates a new subdirectory.

Parameters

string

$name

Returns

void

Exceptions

NotImplemented

Definition at line 106 of file class.ilObjContainerDAV.php.

References $DIC, $name, $type, getChildCollectionType(), and ilLoggerFactory\getLogger().

    {
        global $DIC;

        $type = $this->getChildCollectionType();
        if ($this->repo_helper->checkCreateAccessForType($this->getRefId(), $type) && $this->dav_helper->isDAVableObjTitle($name)) {
            switch ($type) {
                case 'cat':
                    $new_obj = new ilObjCategory();
                    break;

                case 'fold':
                    $new_obj = new ilObjFolder();
                    break;

                default:
                    ilLoggerFactory::getLogger('WebDAV')->info(get_class($this) . ' ' . $this->obj->getTitle() . " -> $type is not supported as webdav directory");
                    throw new NotImplemented("Create type '$type' as collection is not implemented yet");
            }

            $new_obj->setType($type);
            $new_obj->setOwner($DIC->user()->getId());
            $new_obj->setTitle($name);
            $new_obj->create();

            $new_obj->createReference();
            $new_obj->putInTree($this->obj->getRefId());
            $new_obj->setPermissions($this->obj->getRefId());
            $new_obj->update();
        } else {
            throw new Forbidden();
        }
    }

Here is the call graph for this function:

createFile()

ilObjContainerDAV::createFile	(		$name,
			$data = null
	)

Creates a new file in the directory.

Data will either be supplied as a stream resource, or in certain cases as a string. Keep in mind that you may have to support either.

After successful creation of the file, you may choose to return the ETag of the new file here.

The returned ETag must be surrounded by double-quotes (The quotes should be part of the actual string).

If you cannot accurately determine the ETag, you should not return it. If you don't store the file exactly as-is (you're transforming it somehow) you should also not return an ETag.

This means that if a subsequent GET to this new file does not exactly return the same contents of what was submitted here, you are strongly recommended to omit the ETag.

Parameters

string	$name	Name of the file
resource | string	$data	Initial payload

Returns

null|string

Exceptions

Exception

Definition at line 60 of file class.ilObjContainerDAV.php.

References $data, $name, $size, childExists(), getChild(), and ilUtil\getUploadSizeLimitBytes().

    {
        if ($this->repo_helper->checkCreateAccessForType($this->obj->getRefId(), 'file')) {
            $size = $this->request->getHeader("Content-Length")[0] ?? 0;
            if ($size > ilUtil::getUploadSizeLimitBytes()) {
                throw new Exception\Forbidden('File is too big');
            }

            // Check if file has valid extension
            if ($this->dav_helper->isValidFileNameWithValidFileExtension($name)) {
                if ($this->childExists($name)) {
                    $file_dav = $this->getChild($name);
                    return $file_dav->put($data);
                } else {
                    $file_obj = new ilObjFile();
                    $file_obj->setTitle($name);
                    $file_obj->setFileName($name);
                    $file_obj->setVersion(1);
                    $file_obj->setMaxVersion(1);
                    $file_obj->createDirectory();
                    $file_obj->create();

                    $file_obj->createReference();
                    $file_obj->putInTree($this->obj->getRefId());
                    $file_obj->setPermissions($this->ref_id);

                    $file_dav = new ilObjFileDAV($file_obj, $this->repo_helper, $this->dav_helper);
                    return $file_dav->handleFileUpload($data, "create");
                }
            } else {
                // Throw forbidden if invalid extension or filename. As far as we know, it is sadly not
                // possible to inform the user why his upload was "forbidden".
                throw new Forbidden('Invalid file name or file extension');
            }
        } else {
            throw new Forbidden('No write access');
        }
    }

Here is the call graph for this function:

getChild()

ilObjContainerDAV::getChild

(

$name

)

Returns a specific child node, referenced by its name.

This method must throw Sabre if the node does not exist.

Exceptions

Exception

Definition at line 150 of file class.ilObjContainerDAV.php.

References $name, checkReadAndVisibleAccessForObj(), and ilProblemInfoFileDAV\PROBLEM_INFO_FILE_NAME.

Referenced by createFile().

    {
        $child_node = null;
        $child_exists = false;

        // Early exit if the problem info file is opened
        if ($name == ilProblemInfoFileDAV::PROBLEM_INFO_FILE_NAME) {
            return new ilProblemInfoFileDAV($this, $this->repo_helper, $this->dav_helper);
        }

        // Search for the desired file
        foreach ($this->repo_helper->getChildrenOfRefId($this->obj->getRefId()) as $child_ref) {
            // Check if a DAV Object exists for this type
            if ($this->dav_helper->isDAVableObject($child_ref, true)) {
                // Check if names matches
                if ($this->repo_helper->getObjectTitleFromRefId($child_ref, true) == $name) {
                    $child_exists = true;

                    // Check if user has permission to read this object
                    if ($this->checkReadAndVisibleAccessForObj($child_ref)) {
                        $child_node = $this->dav_helper->createDAVObjectForRefId($child_ref);
                    }
                }
            }
        }

        // There exists 1 or more nodes with this name. Return last found node.
        if (!is_null($child_node)) {
            return $child_node;
        }

        // There is no davable object with the same name. Sorry for you...
        throw new Sabre\DAV\Exception\NotFound("$name not found");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildCollectionType()

ilObjContainerDAV::getChildCollectionType ( )

abstract

Return the type for child collections of this collection For courses, groups and folders the type is 'fold' For categories the type is 'cat'.

Returns

string $type

Referenced by checkReadAndVisibleAccessForObj(), and createDirectory().

Here is the caller graph for this function:

getChildren()

ilObjContainerDAV::getChildren

(

)

Returns an array with all the child nodes.

Returns

ilObject[]

Definition at line 190 of file class.ilObjContainerDAV.php.

References checkReadAndVisibleAccessForObj().

    {
        $child_nodes = array();
        $already_seen_titles = array();
        $problem_info_file_needed = false;

        foreach ($this->repo_helper->getChildrenOfRefId($this->obj->getRefId()) as $child_ref) {
            // Check if is davable object types
            if ($this->dav_helper->isDAVableObject($child_ref, true)) {
                // Check for duplicates
                $title = $this->repo_helper->getObjectTitleFromRefId($child_ref);
                if (in_array($title, $already_seen_titles)) {
                    $problem_info_file_needed = true;
                    continue;
                }

                $already_seen_titles[] = $title;

                // Check if read permission is given
                if ($this->checkReadAndVisibleAccessForObj($child_ref)) {
                    // Create DAV-object out of ILIAS-object
                    $child_nodes[$child_ref] = $this->dav_helper->createDAVObjectForRefId($child_ref);
                }
            }
            // if title is not davable because of forbidden characters in title -> problem info file will be created
            elseif (!$problem_info_file_needed
                && $this->dav_helper->isDAVableObjType($this->repo_helper->getObjectTypeFromRefId($child_ref))
                && $this->dav_helper->hasTitleForbiddenChars($this->repo_helper->getObjectTitleFromRefId($child_ref))) {
                $problem_info_file_needed = true;
            }
        }

        if ($problem_info_file_needed) {
            $child_nodes[] = new ilProblemInfoFileDAV($this, $this->repo_helper, $this->dav_helper);
        }

        return $child_nodes;
    }

Here is the call graph for this function:

---

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

• Services/WebDAV/classes/dav/class.ilObjContainerDAV.php