class.ilWebDAVObjDAVHelper.php

Go to the documentation of this file.

<?php
 
class ilWebDAVObjDAVHelper
{
    protected $repo_helper;
 
    public function __construct(ilWebDAVRepositoryHelper $repo_helper)
    {
        $this->repo_helper = $repo_helper;
    }
 
    public function isDAVableObject($id, $is_reference = true, bool $do_name_check = true)
    {
        $obj_id = $is_reference ? $this->repo_helper->getObjectIdFromRefId($id) : $id;
 
        $type = $this->repo_helper->getObjectTypeFromObjId($obj_id);
        $title = $this->repo_helper->getObjectTitleFromObjId($obj_id);
 
        if($do_name_check) {
            $is_davable = $this->isDAVableObjType($type) && $this->isDAVableObjTitle($title);
        } else {
            $is_davable = $this->isDAVableObjType($type);
        }
 
        return $is_davable;
    }
 
    public function isDAVableObjType(string $type) : bool
    {
        switch ($type) {
            case 'cat':
            case 'crs':
            case 'grp':
            case 'fold':
            case 'file':
                return true;
 
            default:
                return false;
        }
    }
 
    public function isDAVableObjTitle(string $title) : bool
    {
        if ($this->hasTitleForbiddenChars($title)) {
            return false;
        }
        if ($this->hasInvalidPrefixInTitle($title)) {
            return false;
        }
        return true;
    }
 
    public function hasTitleForbiddenChars(string $title) : bool
    {
        foreach (str_split('\\<>/:*?"|#') as $forbidden_character) {
            if (strpos($title, $forbidden_character) !== false) {
                return true;
            }
        }
 
        return false;
    }
 
    public function hasInvalidPrefixInTitle(string $title)
    {
        $prefix = substr($title, 0, 1);
        return $prefix === '.';
    }
 
    public function createDAVObjectForRefId(int $ref_id, string $type = '') : ilObjectDAV
    {
        if ($type == '') {
            $type = $this->repo_helper->getObjectTypeFromRefId($ref_id);
        }
 
        if ($this->repo_helper->objectWithRefIdExists($ref_id)) {
            switch ($type) {
                case 'cat':
                    return new ilObjCategoryDAV(new ilObjCategory($ref_id, true), $this->repo_helper, $this);
 
                case 'crs':
                    return new ilObjCourseDAV(new ilObjCourse($ref_id, true), $this->repo_helper, $this);
 
                case 'grp':
                    return new ilObjGroupDAV(new ilObjGroup($ref_id, true), $this->repo_helper, $this);
 
                case 'fold':
                    return new ilObjFolderDAV(new ilObjFolder($ref_id, true), $this->repo_helper, $this);
 
                case 'file':
                    return new ilObjFileDAV(new ilObjFile($ref_id, true), $this->repo_helper, $this);
            }
        }
        throw new BadRequest('Unknown filetype');
    }
 
 
    public function isValidFileNameWithValidFileExtension(string $a_title) : bool
    {
        return $a_title == ilFileUtils::getValidFilename($a_title) && $this->isDAVableObjTitle($a_title);
    }
}