ilWebDAVLockBackend Class Reference

Class ilWebDAVLockBackend. More...

Inheritance diagram for ilWebDAVLockBackend:

Collaboration diagram for ilWebDAVLockBackend:

Public Member Functions
	__construct ($db_manager=null, ilWebDAVRepositoryHelper $repo_helper=null)
	Constructor with dependency injection. More...
	getLocks ($uri, $returnChildLocks)
	This function returns all locks and child locks as SabreDAV lock objects It is needed for sabreDAV to see if there are any locks. More...
	unlock ($uri, Sabre\DAV\Locks\LockInfo $lockInfo)
	lock ($uri, Sabre\DAV\Locks\LockInfo $lock_info)
	Function for the sabreDAV interface. More...
	getLocksOnObjectId (int $obj_id)
	Returns lock on given object. More...
Public Member Functions inherited from Sabre\DAV\Locks\Backend\BackendInterface
	getLocks ($uri, $returnChildLocks)
	Returns a list of Sabre\DAV\Locks\LockInfo objects. More...
	lock ($uri, Locks\LockInfo $lockInfo)
	Locks a uri. More...
	unlock ($uri, Locks\LockInfo $lockInfo)
	Removes a lock from a uri. More...

Protected Member Functions
	getLocksRecursive ($sabre_locks, $ref_id, $uri)
	Iterates recursive through the ilias tree to search for locked objects. More...

Protected Attributes
	$db_manager
	$repo_helper
	$obj_dav_helper
	$uri_path_resolver

Detailed Description

Class ilWebDAVLockBackend.

Implementation for WebDAV locking mechanism. Extends the LockBackend from sabreDAV and saves sabreDAV locks as ILIAS locks to DB and returns ILIAS locks in DB as sabreDAV locks. Also removes existing locks

Author

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

\DAV\Locks\Backend\AbstractBackend

Definition at line 24 of file class.ilWebDAVLockBackend.php.

Constructor & Destructor Documentation

__construct()

ilWebDAVLockBackend::__construct	(		$db_manager = null,
		ilWebDAVRepositoryHelper	$repo_helper = null
	)

Constructor with dependency injection.

Parameters

unknown	$db_manager
ilWebDAVRepositoryHelper | null	$repo_helper

Definition at line 43 of file class.ilWebDAVLockBackend.php.

    {
        global $DIC;
 
        $this->db_manager = $db_manager == null ? new ilWebDAVDBManager($DIC->database()) : $db_manager;
        $this->repo_helper = $repo_helper == null ? new ilWebDAVRepositoryHelper($DIC->access(), $DIC->repositoryTree()) : $repo_helper;
        $this->obj_dav_helper = new ilWebDAVObjDAVHelper($this->repo_helper);
        $this->uri_path_resolver = new ilWebDAVUriPathResolver($this->repo_helper);
        $this->user = $DIC->user();
    }

References $db_manager, $DIC, $repo_helper, and user().

Here is the call graph for this function:

Member Function Documentation

getLocks()

ilWebDAVLockBackend::getLocks	(		$uri,
			$returnChildLocks
	)

This function returns all locks and child locks as SabreDAV lock objects It is needed for sabreDAV to see if there are any locks.

Returns a list of Sabre\DAV\Locks\LockInfo objects.This method should return all the locks for a particular uri, including locks that might be set on a parent uri.If returnChildLocks is set to true, this method should also look for any locks in the subtree of the uri for locks.

Parameters

string	$uri
bool	$returnChildLocks

Returns

array

See also

\Sabre\DAV\Locks\Backend\BackendInterface::getLocks()

Implements Sabre\DAV\Locks\Backend\BackendInterface.

Definition at line 61 of file class.ilWebDAVLockBackend.php.

    {
        $sabre_locks = array();
 
        // Get locks on given uri
        try {
            $ref_id = $this->uri_path_resolver->getRefIdForWebDAVPath($uri);
 
            $obj_id = $this->repo_helper->getObjectIdFromRefId($ref_id);
            $lock_on_obj = $this->getLocksOnObjectId($obj_id);
 
            if ($lock_on_obj != false) {
                $sabre_locks[] = $lock_on_obj->getAsSabreDavLock($uri);
            }
 
            // Get locks on childs
            if ($returnChildLocks) {
                $sabre_locks = $this->getLocksRecursive($sabre_locks, $ref_id, $uri);
            }
        } catch (Exception\NotFound $e) {
            return $sabre_locks;
        }
 
        return $sabre_locks;
    }

References getLocksOnObjectId(), and getLocksRecursive().

Here is the call graph for this function:

getLocksOnObjectId()

ilWebDAVLockBackend::getLocksOnObjectId

(

int

$obj_id

)

Returns lock on given object.

Parameters

int

$obj_id

Returns

array

Definition at line 167 of file class.ilWebDAVLockBackend.php.

    {
        try {
            return $this->db_manager->getLockObjectWithObjIdFromDB($obj_id);
        } catch (Exception $e) {
        }
    }

Referenced by getLocks(), and getLocksRecursive().

Here is the caller graph for this function:

getLocksRecursive()

ilWebDAVLockBackend::getLocksRecursive (   $sabre_locks,   $ref_id,   $uri  )

protected

Iterates recursive through the ilias tree to search for locked objects.

Parameters

array	$sabre_locks
integer	$ref_id
string	$uri

Returns

array

Definition at line 95 of file class.ilWebDAVLockBackend.php.

    {
        foreach ($this->repo_helper->getChildrenOfRefId($ref_id) as $child_ref) {
            // Only get locks of DAVable objects. Because not DAVable objects won't be lockable anyway
            $child_obj_id = $this->repo_helper->getObjectIdFromRefId($child_ref);
            if ($this->obj_dav_helper->isDAVableObject($child_obj_id, false)) {
                // Get Locks of this object
                $title = $this->repo_helper->getObjectTitleFromObjId($child_obj_id, true);
                $child_ilias_locks = $this->getLocksOnObjectId($child_obj_id);
                if ($child_ilias_locks != false) {
                    foreach ($child_ilias_locks as $lock) {
                        $sabre_locks[] = $lock->getAsSabreDavLock($uri . '/' . $title);
                    }
                }
 
                // Get locks of child objects
                $sabre_locks = $this->getLocksRecursive($sabre_locks, $child_ref, $uri . $title . '/');
            }
        }
        
        return $sabre_locks;
    }

References $title, getLocksOnObjectId(), and getLocksRecursive().

Referenced by getLocks(), and getLocksRecursive().

Here is the call graph for this function:

Here is the caller graph for this function:

lock()

ilWebDAVLockBackend::lock	(		$uri,
		Sabre\DAV\Locks\LockInfo	$lock_info
	)

Function for the sabreDAV interface.

See also

\Sabre\DAV\Locks\Backend\BackendInterface::lock()

Definition at line 139 of file class.ilWebDAVLockBackend.php.

    {
        try {
            $ref_id = $this->uri_path_resolver->getRefIdForWebDAVPath($uri);
 
            if ($ref_id > 0 && $this->repo_helper->checkAccess('write', $ref_id)) {
                $obj_id = $this->repo_helper->getObjectIdFromRefId($ref_id);
                $ilias_lock = ilWebDAVLockObject::createFromSabreLock($lock_info, $obj_id);
                $this->db_manager->saveLockToDB($ilias_lock);
            } else {
                throw new Exception\Forbidden();
            }
        } catch (Exception\NotFound $e) {
            if ($e->getCode() == -1) {
                return;
            } else {
                throw $e;
            }
        }
    }

References ilWebDAVLockObject\createFromSabreLock().

Here is the call graph for this function:

unlock()

ilWebDAVLockBackend::unlock	(		$uri,
		Sabre\DAV\Locks\LockInfo	$lockInfo
	)

See also

\Sabre\DAV\Locks\Backend\BackendInterface::unlock()

Definition at line 122 of file class.ilWebDAVLockBackend.php.

    {
        $ilias_lock = $this->db_manager->getLockObjectWithTokenFromDB($lockInfo->token);
 
        if ($ilias_lock && $ilias_lock->getIliasOwner() == $this->user->getId()) {
            $this->db_manager->removeLockWithTokenFromDB($lockInfo->token);
        } else {
            throw new Exception\Forbidden();
        }
    }

Field Documentation

$db_manager

ilWebDAVLockBackend::$db_manager

protected

Definition at line 27 of file class.ilWebDAVLockBackend.php.

Referenced by __construct().

$obj_dav_helper

ilWebDAVLockBackend::$obj_dav_helper

protected

Definition at line 33 of file class.ilWebDAVLockBackend.php.

$repo_helper

ilWebDAVLockBackend::$repo_helper

protected

Definition at line 30 of file class.ilWebDAVLockBackend.php.

Referenced by __construct().

$uri_path_resolver

ilWebDAVLockBackend::$uri_path_resolver

protected

Definition at line 36 of file class.ilWebDAVLockBackend.php.

---

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

• Services/WebDAV/classes/lock/class.ilWebDAVLockBackend.php