Main DAV server class. More...

Inheritance diagram for Sabre\DAV\Server:

Collaboration diagram for Sabre\DAV\Server:

Public Member Functions
	__construct ($treeOrNode=null)
	Sets up the server. More...

	exec ()
	Starts the DAV Server. More...

	setBaseUri ($uri)
	Sets the base server uri. More...

	getBaseUri ()
	Returns the base responding uri. More...

	guessBaseUri ()
	This method attempts to detect the base uri. More...

	addPlugin (ServerPlugin $plugin)
	Adds a plugin to the server. More...

	getPlugin ($name)
	Returns an initialized plugin by it's name. More...

	getPlugins ()
	Returns all plugins. More...

	getLogger ()
	Returns the PSR-3 logger object. More...

	invokeMethod (RequestInterface $request, ResponseInterface $response, $sendResponse=true)
	Handles a http request, and execute a method based on its name. More...

	getAllowedMethods ($path)
	Returns an array with all the supported HTTP methods for a specific uri. More...

	getRequestUri ()
	Gets the uri for the request, keeping the base uri into consideration. More...

	calculateUri ($uri)
	Turns a URI such as the REQUEST_URI into a local path. More...

	getHTTPDepth ($default=self::DEPTH_INFINITY)
	Returns the HTTP depth header. More...

	getHTTPRange ()
	Returns the HTTP range header. More...

	getHTTPPrefer ()
	Returns the HTTP Prefer header information. More...

	getCopyAndMoveInfo (RequestInterface $request)
	Returns information about Copy and Move requests. More...

	getProperties ($path, $propertyNames)
	Returns a list of properties for a path. More...

	getPropertiesForChildren ($path, $propertyNames)
	A kid-friendly way to fetch properties for a node's children. More...

	getHTTPHeaders ($path)
	Returns a list of HTTP headers for a particular resource. More...

	getPropertiesForPath ($path, $propertyNames=[], $depth=0)
	Returns a list of properties for a given path. More...

	getPropertiesIteratorForPath ($path, $propertyNames=[], $depth=0)
	Returns a list of properties for a given path. More...

	getPropertiesForMultiplePaths (array $paths, array $propertyNames=[])
	Returns a list of properties for a list of paths. More...

	getPropertiesByNode (PropFind $propFind, INode $node)
	Determines all properties for a node. More...

	createFile ($uri, $data, &$etag=null)
	This method is invoked by sub-systems creating a new file. More...

	updateFile ($uri, $data, &$etag=null)
	This method is invoked by sub-systems updating a file. More...

	createDirectory ($uri)
	This method is invoked by sub-systems creating a new directory. More...

	createCollection ($uri, MkCol $mkCol)
	Use this method to create a new collection. More...

	updateProperties ($path, array $properties)
	This method updates a resource's properties. More...

	checkPreconditions (RequestInterface $request, ResponseInterface $response)
	This method checks the main HTTP preconditions. More...

	getIfConditions (RequestInterface $request)
	This method is created to extract information from the WebDAV HTTP 'If:' header. More...

	getResourceTypeForNode (INode $node)
	Returns an array with resourcetypes for a node. More...

	generateMultiStatus ($fileProperties, $strip404s=false)
	Generates a WebDAV propfind response body based on a list of nodes. More...

Public Member Functions inherited from Sabre\Event\EventEmitterInterface
	on ($eventName, callable $callBack, $priority=100)
	Subscribe to an event. More...

	once ($eventName, callable $callBack, $priority=100)
	Subscribe to an event exactly once. More...

	emit ($eventName, array $arguments=[], callable $continueCallBack=null)
	Emits an event. More...

	listeners ($eventName)
	Returns the list of listeners for an event. More...

	removeListener ($eventName, callable $listener)
	Removes a specific listener from an event. More...

	removeAllListeners ($eventName=null)
	Removes all listeners. More...

Public Member Functions inherited from Psr\Log\LoggerAwareInterface
	setLogger (LoggerInterface $logger)
	Sets a logger instance on the object. More...

Data Fields
const	DEPTH_INFINITY = -1
	Infinity is used for some request supporting the HTTP Depth header and indicates that the operation should traverse the entire tree. More...

const	NS_SABREDAV = 'http://sabredav.org/ns'
	XML namespace for all SabreDAV related elements. More...

	$tree

	$httpResponse

	$httpRequest

	$sapi

	$transactionType

	$protectedProperties

	$debugExceptions = false

	$resourceTypeMapping

	$enablePropfindDepthInfinity = false

	$xml

Static Public Attributes
static	$exposeVersion = true

Protected Attributes
	$baseUri = null

	$plugins = []

Private Member Functions
	generatePathNodes (PropFind $propFind, array $yieldFirst=null)
	Small helper to support PROPFIND with DEPTH_INFINITY. More...

Detailed Description

Main DAV server class.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 23 of file Server.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\DAV\Server::__construct ( $treeOrNode = null )

Sets up the server.

If a Sabre\DAV\Tree object is passed as an argument, it will use it as the directory tree. If a Sabre\DAV\INode is passed, it will create a Sabre\DAV\Tree and use the node as the root.

If nothing is passed, a Sabre\DAV\SimpleCollection is created in a Sabre\DAV\Tree.

If an array is passed, we automatically create a root node, and use the nodes in the array as top-level children.

Parameters

Tree | INode | array | null $treeOrNode The tree object

Definition at line 201 of file Server.php.

                                             {
 
        if ($treeOrNode instanceof Tree) {
            $this->tree = $treeOrNode;
        } elseif ($treeOrNode instanceof INode) {
            $this->tree = new Tree($treeOrNode);
        } elseif (is_array($treeOrNode)) {
 
            // If it's an array, a list of nodes was passed, and we need to
            // create the root node.
            foreach ($treeOrNode as $node) {
                if (!($node instanceof INode)) {
                    throw new Exception('Invalid argument passed to constructor. If you\'re passing an array, all the values must implement Sabre\\DAV\\INode');
                }
            }
 
            $root = new SimpleCollection('root', $treeOrNode);
            $this->tree = new Tree($root);
 
        } elseif (is_null($treeOrNode)) {
            $root = new SimpleCollection('root');
            $this->tree = new Tree($root);
        } else {
            throw new Exception('Invalid argument passed to constructor. Argument must either be an instance of Sabre\\DAV\\Tree, Sabre\\DAV\\INode, an array or null');
        }
 
        $this->xml = new Xml\Service();
        $this->sapi = new HTTP\Sapi();
        $this->httpResponse = new HTTP\Response();
        $this->httpRequest = $this->sapi->getRequest();
        $this->addPlugin(new CorePlugin());
 
    }

References $root, and Sabre\DAV\Server\addPlugin().

Here is the call graph for this function:

Member Function Documentation

◆ addPlugin()

Sabre\DAV\Server::addPlugin ( ServerPlugin $plugin )

Adds a plugin to the server.

For more information, console the documentation of Sabre\DAV\ServerPlugin

Parameters

ServerPlugin $plugin

Returns: void

Definition at line 404 of file Server.php.

                                             {
 
        $this->plugins[$plugin->getPluginName()] = $plugin;
        $plugin->initialize($this);
 
    }

References Sabre\DAV\ServerPlugin\getPluginName(), and Sabre\DAV\ServerPlugin\initialize().

Referenced by Sabre\DAV\Server\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calculateUri()

Sabre\DAV\Server::calculateUri ( $uri )

Turns a URI such as the REQUEST_URI into a local path.

This method:

strips off the base path
normalizes the path
uri-decodes the path

Parameters

string $uri

Exceptions

Exception

Forbidden A permission denied exception is thrown whenever there was an attempt to supply a uri outside of the base uri

Returns: string

Definition at line 565 of file Server.php.

                                {
 
        if ($uri[0] != '/' && strpos($uri, '://')) {
 
            $uri = parse_url($uri, PHP_URL_PATH);
 
        }
 
        $uri = Uri\normalize(str_replace('//', '/', $uri));
        $baseUri = Uri\normalize($this->getBaseUri());
 
        if (strpos($uri, $baseUri) === 0) {
 
            return trim(URLUtil::decodePath(substr($uri, strlen($baseUri))), '/');
 
        // A special case, if the baseUri was accessed without a trailing
        // slash, we'll accept it as well.
        } elseif ($uri . '/' === $baseUri) {
 
            return '';
 
        } else {
 
            throw new Exception\Forbidden('Requested uri (' . $uri . ') is out of base uri (' . $this->getBaseUri() . ')');
 
        }
 
    }

References Sabre\DAV\Server\$baseUri, Sabre\HTTP\URLUtil\decodePath(), Sabre\DAV\Server\getBaseUri(), and Sabre\Uri\normalize().

Referenced by Sabre\DAV\Server\getCopyAndMoveInfo(), Sabre\DAV\Server\getIfConditions(), and Sabre\DAV\Server\getRequestUri().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPreconditions()

Sabre\DAV\Server::checkPreconditions	(	RequestInterface	$request,
		ResponseInterface	$response
	)

This method checks the main HTTP preconditions.

Currently these are:

If-Match
If-None-Match
If-Modified-Since
If-Unmodified-Since

The method will return true if all preconditions are met The method will return false, or throw an exception if preconditions failed. If false is returned the operation should be aborted, and the appropriate HTTP response headers are already set.

Normally this method will throw 412 Precondition Failed for failures related to If-None-Match, If-Match and If-Unmodified Since. It will set the status to 304 Not Modified for If-Modified_since.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns: bool

Definition at line 1293 of file Server.php.

                                                                                        {
 
        $path = $request->getPath();
        $node = null;
        $lastMod = null;
        $etag = null;
 
        if ($ifMatch = $request->getHeader('If-Match')) {
 
            // If-Match contains an entity tag. Only if the entity-tag
            // matches we are allowed to make the request succeed.
            // If the entity-tag is '*' we are only allowed to make the
            // request succeed if a resource exists at that url.
            try {
                $node = $this->tree->getNodeForPath($path);
            } catch (Exception\NotFound $e) {
                throw new Exception\PreconditionFailed('An If-Match header was specified and the resource did not exist', 'If-Match');
            }
 
            // Only need to check entity tags if they are not *
            if ($ifMatch !== '*') {
 
                // There can be multiple ETags
                $ifMatch = explode(',', $ifMatch);
                $haveMatch = false;
                foreach ($ifMatch as $ifMatchItem) {
 
                    // Stripping any extra spaces
                    $ifMatchItem = trim($ifMatchItem, ' ');
 
                    $etag = $node instanceof IFile ? $node->getETag() : null;
                    if ($etag === $ifMatchItem) {
                        $haveMatch = true;
                    } else {
                        // Evolution has a bug where it sometimes prepends the "
                        // with a \. This is our workaround.
                        if (str_replace('\\"', '"', $ifMatchItem) === $etag) {
                            $haveMatch = true;
                        }
                    }
 
                }
                if (!$haveMatch) {
                    if ($etag) $response->setHeader('ETag', $etag);
                     throw new Exception\PreconditionFailed('An If-Match header was specified, but none of the specified the ETags matched.', 'If-Match');
                }
            }
        }
 
        if ($ifNoneMatch = $request->getHeader('If-None-Match')) {
 
            // The If-None-Match header contains an ETag.
            // Only if the ETag does not match the current ETag, the request will succeed
            // The header can also contain *, in which case the request
            // will only succeed if the entity does not exist at all.
            $nodeExists = true;
            if (!$node) {
                try {
                    $node = $this->tree->getNodeForPath($path);
                } catch (Exception\NotFound $e) {
                    $nodeExists = false;
                }
            }
            if ($nodeExists) {
                $haveMatch = false;
                if ($ifNoneMatch === '*') $haveMatch = true;
                else {
 
                    // There might be multiple ETags
                    $ifNoneMatch = explode(',', $ifNoneMatch);
                    $etag = $node instanceof IFile ? $node->getETag() : null;
 
                    foreach ($ifNoneMatch as $ifNoneMatchItem) {
 
                        // Stripping any extra spaces
                        $ifNoneMatchItem = trim($ifNoneMatchItem, ' ');
 
                        if ($etag === $ifNoneMatchItem) $haveMatch = true;
 
                    }
 
                }
 
                if ($haveMatch) {
                    if ($etag) $response->setHeader('ETag', $etag);
                    if ($request->getMethod() === 'GET') {
                        $response->setStatus(304);
                        return false;
                    } else {
                        throw new Exception\PreconditionFailed('An If-None-Match header was specified, but the ETag matched (or * was specified).', 'If-None-Match');
                    }
                }
            }
 
        }
 
        if (!$ifNoneMatch && ($ifModifiedSince = $request->getHeader('If-Modified-Since'))) {
 
            // The If-Modified-Since header contains a date. We
            // will only return the entity if it has been changed since
            // that date. If it hasn't been changed, we return a 304
            // header
            // Note that this header only has to be checked if there was no If-None-Match header
            // as per the HTTP spec.
            $date = HTTP\Util::parseHTTPDate($ifModifiedSince);
 
            if ($date) {
                if (is_null($node)) {
                    $node = $this->tree->getNodeForPath($path);
                }
                $lastMod = $node->getLastModified();
                if ($lastMod) {
                    $lastMod = new \DateTime('@' . $lastMod);
                    if ($lastMod <= $date) {
                        $response->setStatus(304);
                        $response->setHeader('Last-Modified', HTTP\Util::toHTTPDate($lastMod));
                        return false;
                    }
                }
            }
        }
 
        if ($ifUnmodifiedSince = $request->getHeader('If-Unmodified-Since')) {
 
            // The If-Unmodified-Since will allow allow the request if the
            // entity has not changed since the specified date.
            $date = HTTP\Util::parseHTTPDate($ifUnmodifiedSince);
 
            // We must only check the date if it's valid
            if ($date) {
                if (is_null($node)) {
                    $node = $this->tree->getNodeForPath($path);
                }
                $lastMod = $node->getLastModified();
                if ($lastMod) {
                    $lastMod = new \DateTime('@' . $lastMod);
                    if ($lastMod > $date) {
                        throw new Exception\PreconditionFailed('An If-Unmodified-Since header was specified, but the entity has been changed since the specified date.', 'If-Unmodified-Since');
                    }
                }
            }
 
        }
 
        // Now the hardest, the If: header. The If: header can contain multiple
        // urls, ETags and so-called 'state tokens'.
        //
        // Examples of state tokens include lock-tokens (as defined in rfc4918)
        // and sync-tokens (as defined in rfc6578).
        //
        // The only proper way to deal with these, is to emit events, that a
        // Sync and Lock plugin can pick up.
        $ifConditions = $this->getIfConditions($request);
 
        foreach ($ifConditions as $kk => $ifCondition) {
            foreach ($ifCondition['tokens'] as $ii => $token) {
                $ifConditions[$kk]['tokens'][$ii]['validToken'] = false;
            }
        }
 
        // Plugins are responsible for validating all the tokens.
        // If a plugin deemed a token 'valid', it will set 'validToken' to
        // true.
        $this->emit('validateTokens', [$request, &$ifConditions]);
 
        // Now we're going to analyze the result.
 
        // Every ifCondition needs to validate to true, so we exit as soon as
        // we have an invalid condition.
        foreach ($ifConditions as $ifCondition) {
 
            $uri = $ifCondition['uri'];
            $tokens = $ifCondition['tokens'];
 
            // We only need 1 valid token for the condition to succeed.
            foreach ($tokens as $token) {
 
                $tokenValid = $token['validToken'] || !$token['token'];
 
                $etagValid = false;
                if (!$token['etag']) {
                    $etagValid = true;
                }
                // Checking the ETag, only if the token was already deemed
                // valid and there is one.
                if ($token['etag'] && $tokenValid) {
 
                    // The token was valid, and there was an ETag. We must
                    // grab the current ETag and check it.
                    $node = $this->tree->getNodeForPath($uri);
                    $etagValid = $node instanceof IFile && $node->getETag() == $token['etag'];
 
                }
 
 
                if (($tokenValid && $etagValid) ^ $token['negate']) {
                    // Both were valid, so we can go to the next condition.
                    continue 2;
                }
 
 
            }
 
            // If we ended here, it means there was no valid ETag + token
            // combination found for the current condition. This means we fail!
            throw new Exception\PreconditionFailed('Failed to find a valid token/etag combination for ' . $uri, 'If');
 
        }
 
        return true;
 
    }

References $ii, $path, $request, $response, PHPMailer\PHPMailer\$token, Sabre\Event\EventEmitterInterface\emit(), Sabre\DAV\IFile\getETag(), Sabre\DAV\Server\getIfConditions(), Sabre\HTTP\Util\parseHTTPDate(), and Sabre\HTTP\Util\toHTTPDate().

Referenced by Sabre\DAV\Server\invokeMethod().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createCollection()

Sabre\DAV\Server::createCollection	(		$uri,
		MkCol	$mkCol
	)

Use this method to create a new collection.

Parameters

string	$uri	The new uri
MkCol	$mkCol

Returns: array|null

If the parent is an instance of IExtendedCollection, it means that we can pass the MkCol object directly as it may be able to store properties immediately.

If the parent is a standard ICollection, it means only 'standard' collections can be created, so we should fail any MKCOL operation that carries extra resourcetypes.

Definition at line 1157 of file Server.php.

                                                  {
 
        list($parentUri, $newName) = URLUtil::splitPath($uri);
 
        // Making sure the parent exists
        try {
            $parent = $this->tree->getNodeForPath($parentUri);
 
        } catch (Exception\NotFound $e) {
            throw new Exception\Conflict('Parent node does not exist');
 
        }
 
        // Making sure the parent is a collection
        if (!$parent instanceof ICollection) {
            throw new Exception\Conflict('Parent node is not a collection');
        }
 
        // Making sure the child does not already exist
        try {
            $parent->getChild($newName);
 
            // If we got here.. it means there's already a node on that url, and we need to throw a 405
            throw new Exception\MethodNotAllowed('The resource you tried to create already exists');
 
        } catch (Exception\NotFound $e) {
            // NotFound is the expected behavior.
        }
 
 
        if (!$this->emit('beforeBind', [$uri])) return;
 
        if ($parent instanceof IExtendedCollection) {
 
            $parent->createExtendedCollection($newName, $mkCol);
 
        } else {
 
            if (count($mkCol->getResourceType()) > 1) {
                throw new Exception\InvalidResourceType('The {DAV:}resourcetype you specified is not supported here.');
            }
 
            $parent->createDirectory($newName);
 
        }
 
        // If there are any properties that have not been handled/stored,
        // we ask the 'propPatch' event to handle them. This will allow for
        // example the propertyStorage system to store properties upon MKCOL.
        if ($mkCol->getRemainingMutations()) {
            $this->emit('propPatch', [$uri, $mkCol]);
        }
        $success = $mkCol->commit();
 
        if (!$success) {
            $result = $mkCol->getResult();
 
            $formattedResult = [
                'href' => $uri,
            ];
 
            foreach ($result as $propertyName => $status) {
 
                if (!isset($formattedResult[$status])) {
                    $formattedResult[$status] = [];
                }
                $formattedResult[$status][$propertyName] = null;
 
            }
            return $formattedResult;
        }
 
        $this->tree->markDirty($parentUri);
        $this->emit('afterBind', [$uri]);
 
    }

References $result, $success, Sabre\DAV\PropPatch\commit(), Sabre\Event\EventEmitterInterface\emit(), Sabre\DAV\PropPatch\getRemainingMutations(), Sabre\DAV\MkCol\getResourceType(), Sabre\DAV\PropPatch\getResult(), and Sabre\HTTP\URLUtil\splitPath().

Referenced by Sabre\DAV\Server\createDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createDirectory()

Sabre\DAV\Server::createDirectory ( $uri )

This method is invoked by sub-systems creating a new directory.

Parameters

string $uri

Returns: void

Definition at line 1144 of file Server.php.

                                   {
 
        $this->createCollection($uri, new MkCol(['{DAV:}collection'], []));
 
    }

References Sabre\DAV\Server\createCollection().

Here is the call graph for this function:

◆ createFile()

Sabre\DAV\Server::createFile	(		$uri,
			$data,
		&	$etag = `null`
	)

This method is invoked by sub-systems creating a new file.

Currently this is done by HTTP PUT and HTTP LOCK (in the Locks_Plugin). It was important to get this done through a centralized function, allowing plugins to intercept this using the beforeCreateFile event.

This method will return true if the file was actually created

Parameters

string	$uri
resource	$data
string	$etag

Returns: bool

Definition at line 1076 of file Server.php.

                                                    {
 
        list($dir, $name) = URLUtil::splitPath($uri);
 
        if (!$this->emit('beforeBind', [$uri])) return false;
 
        $parent = $this->tree->getNodeForPath($dir);
        if (!$parent instanceof ICollection) {
            throw new Exception\Conflict('Files can only be created as children of collections');
        }
 
        // It is possible for an event handler to modify the content of the
        // body, before it gets written. If this is the case, $modified
        // should be set to true.
        //
        // If $modified is true, we must not send back an ETag.
        $modified = false;
        if (!$this->emit('beforeCreateFile', [$uri, &$data, $parent, &$modified])) return false;
 
        $etag = $parent->createFile($name, $data);
 
        if ($modified) $etag = null;
 
        $this->tree->markDirty($dir . '/' . $name);
 
        $this->emit('afterBind', [$uri]);
        $this->emit('afterCreateFile', [$uri, $parent]);
 
        return true;
    }

References $data, $name, Sabre\Event\EventEmitterInterface\emit(), and Sabre\HTTP\URLUtil\splitPath().

Here is the call graph for this function:

◆ exec()

Sabre\DAV\Server::exec ( )

Starts the DAV Server.

Returns: void

Definition at line 240 of file Server.php.

                    {
 
        try {
 
            // If nginx (pre-1.2) is used as a proxy server, and SabreDAV as an
            // origin, we must make sure we send back HTTP/1.0 if this was
            // requested.
            // This is mainly because nginx doesn't support Chunked Transfer
            // Encoding, and this forces the webserver SabreDAV is running on,
            // to buffer entire responses to calculate Content-Length.
            $this->httpResponse->setHTTPVersion($this->httpRequest->getHTTPVersion());
 
            // Setting the base url
            $this->httpRequest->setBaseUrl($this->getBaseUri());
            $this->invokeMethod($this->httpRequest, $this->httpResponse);
 
        } catch (\Exception $e) {
 
            try {
                $this->emit('exception', [$e]);
            } catch (\Exception $ignore) {
            }
            $DOM = new \DOMDocument('1.0', 'utf-8');
            $DOM->formatOutput = true;
 
            $error = $DOM->createElementNS('DAV:', 'd:error');
            $error->setAttribute('xmlns:s', self::NS_SABREDAV);
            $DOM->appendChild($error);
 
            $h = function($v) {
 
                return htmlspecialchars($v, ENT_NOQUOTES, 'UTF-8');
 
            };
 
            if (self::$exposeVersion) {
                $error->appendChild($DOM->createElement('s:sabredav-version', $h(Version::VERSION)));
            }
 
            $error->appendChild($DOM->createElement('s:exception', $h(get_class($e))));
            $error->appendChild($DOM->createElement('s:message', $h($e->getMessage())));
            if ($this->debugExceptions) {
                $error->appendChild($DOM->createElement('s:file', $h($e->getFile())));
                $error->appendChild($DOM->createElement('s:line', $h($e->getLine())));
                $error->appendChild($DOM->createElement('s:code', $h($e->getCode())));
                $error->appendChild($DOM->createElement('s:stacktrace', $h($e->getTraceAsString())));
            }
 
            if ($this->debugExceptions) {
                $previous = $e;
                while ($previous = $previous->getPrevious()) {
                    $xPrevious = $DOM->createElement('s:previous-exception');
                    $xPrevious->appendChild($DOM->createElement('s:exception', $h(get_class($previous))));
                    $xPrevious->appendChild($DOM->createElement('s:message', $h($previous->getMessage())));
                    $xPrevious->appendChild($DOM->createElement('s:file', $h($previous->getFile())));
                    $xPrevious->appendChild($DOM->createElement('s:line', $h($previous->getLine())));
                    $xPrevious->appendChild($DOM->createElement('s:code', $h($previous->getCode())));
                    $xPrevious->appendChild($DOM->createElement('s:stacktrace', $h($previous->getTraceAsString())));
                    $error->appendChild($xPrevious);
                }
            }
 
 
            if ($e instanceof Exception) {
 
                $httpCode = $e->getHTTPCode();
                $e->serialize($this, $error);
                $headers = $e->getHTTPHeaders($this);
 
            } else {
 
                $httpCode = 500;
                $headers = [];
 
            }
            $headers['Content-Type'] = 'application/xml; charset=utf-8';
 
            $this->httpResponse->setStatus($httpCode);
            $this->httpResponse->setHeaders($headers);
            $this->httpResponse->setBody($DOM->saveXML());
            $this->sapi->sendResponse($this->httpResponse);
 
        }
 
    }

References $h, $ignore, Sabre\Event\EventEmitterInterface\emit(), Sabre\DAV\Server\getBaseUri(), Sabre\DAV\Exception\getHTTPCode(), Sabre\DAV\Exception\getHTTPHeaders(), Sabre\DAV\Server\invokeMethod(), Sabre\DAV\Exception\serialize(), and Sabre\DAV\Version\VERSION.

Here is the call graph for this function:

◆ generateMultiStatus()

Sabre\DAV\Server::generateMultiStatus	(	$fileProperties,
		$strip404s = `false`
	)

Generates a WebDAV propfind response body based on a list of nodes.

If 'strip404s' is set to true, all 404 responses will be removed.

Parameters

array \| \Traversable	$fileProperties	The list with nodes
bool	$strip404s

Returns: string

Definition at line 1656 of file Server.php.

                                                                      {
 
        $w = $this->xml->getWriter();
        $w->openMemory();
        $w->contextUri = $this->baseUri;
        $w->startDocument();
 
        $w->startElement('{DAV:}multistatus');
 
        foreach ($fileProperties as $entry) {
 
            $href = $entry['href'];
            unset($entry['href']);
            if ($strip404s) {
                unset($entry[404]);
            }
            $response = new Xml\Element\Response(
                ltrim($href, '/'),
                $entry
            );
            $w->write([
                'name'  => '{DAV:}response',
                'value' => $response
            ]);
        }
        $w->endElement();
 
        return $w->outputMemory();
 
    }

References Sabre\DAV\Server\$baseUri, $response, and $w.

◆ generatePathNodes()

Sabre\DAV\Server::generatePathNodes	(	PropFind	$propFind,
		array	$yieldFirst = `null`
	)

private

Small helper to support PROPFIND with DEPTH_INFINITY.

Parameters

PropFind	$propFind
array	$yieldFirst

Returns: \Iterator

Definition at line 885 of file Server.php.

                                                                                     {
        if ($yieldFirst !== null) {
            yield $yieldFirst;
        }
        $newDepth = $propFind->getDepth();
        $path = $propFind->getPath();
 
        if ($newDepth !== self::DEPTH_INFINITY) {
            $newDepth--;
        }
 
        foreach ($this->tree->getChildren($path) as $childNode) {
            $subPropFind = clone $propFind;
            $subPropFind->setDepth($newDepth);
            if ($path !== '') {
                $subPath = $path . '/' . $childNode->getName();
            } else {
                $subPath = $childNode->getName();
            }
            $subPropFind->setPath($subPath);
 
            yield [
                $subPropFind,
                $childNode
            ];
 
            if (($newDepth === self::DEPTH_INFINITY || $newDepth >= 1) && $childNode instanceof ICollection) {
                foreach ($this->generatePathNodes($subPropFind) as $subItem) {
                    yield $subItem;
                }
            }
 
        }
    }

References $path, Sabre\DAV\Server\generatePathNodes(), Sabre\DAV\PropFind\getDepth(), Sabre\DAV\PropFind\getPath(), and Sabre\DAV\PropFind\setDepth().

Referenced by Sabre\DAV\Server\generatePathNodes(), and Sabre\DAV\Server\getPropertiesIteratorForPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllowedMethods()

Sabre\DAV\Server::getAllowedMethods ( $path )

Returns an array with all the supported HTTP methods for a specific uri.

Parameters

string $path

Returns: array

Definition at line 512 of file Server.php.

                                      {
 
        $methods = [
            'OPTIONS',
            'GET',
            'HEAD',
            'DELETE',
            'PROPFIND',
            'PUT',
            'PROPPATCH',
            'COPY',
            'MOVE',
            'REPORT'
        ];
 
        // The MKCOL is only allowed on an unmapped uri
        try {
            $this->tree->getNodeForPath($path);
        } catch (Exception\NotFound $e) {
            $methods[] = 'MKCOL';
        }
 
        // We're also checking if any of the plugins register any new methods
        foreach ($this->plugins as $plugin) $methods = array_merge($methods, $plugin->getHTTPMethods($path));
        array_unique($methods);
 
        return $methods;
 
    }

References $path.

◆ getBaseUri()

Sabre\DAV\Server::getBaseUri ( )

Returns the base responding uri.

Returns: string

Definition at line 347 of file Server.php.

                          {
 
        if (is_null($this->baseUri)) $this->baseUri = $this->guessBaseUri();
        return $this->baseUri;
 
    }

References Sabre\DAV\Server\$baseUri, and Sabre\DAV\Server\guessBaseUri().

Referenced by Sabre\DAV\Server\calculateUri(), and Sabre\DAV\Server\exec().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCopyAndMoveInfo()

Sabre\DAV\Server::getCopyAndMoveInfo ( RequestInterface $request )

Returns information about Copy and Move requests.

This function is created to help getting information about the source and the destination for the WebDAV MOVE and COPY HTTP request. It also validates a lot of information and throws proper exceptions

The returned value is an array with the following keys:

destination - Destination path
destinationExists - Whether or not the destination is an existing url (and should therefore be overwritten)

Parameters

RequestInterface $request

Exceptions

Exception

BadRequest upon missing or broken request headers

Exceptions

Exception

UnsupportedMediaType when trying to copy into a non-collection.

Exceptions

Exception

PreconditionFailed If overwrite is set to false, but the destination exists.

Exceptions

Exception

Forbidden when source and destination paths are identical.

Exceptions

Exception

Conflict When trying to copy a node into its own subtree.

Returns: array

Definition at line 729 of file Server.php.

                                                           {
 
        // Collecting the relevant HTTP headers
        if (!$request->getHeader('Destination')) throw new Exception\BadRequest('The destination header was not supplied');
        $destination = $this->calculateUri($request->getHeader('Destination'));
        $overwrite = $request->getHeader('Overwrite');
        if (!$overwrite) $overwrite = 'T';
        if (strtoupper($overwrite) == 'T') $overwrite = true;
        elseif (strtoupper($overwrite) == 'F') $overwrite = false;
        // We need to throw a bad request exception, if the header was invalid
        else throw new Exception\BadRequest('The HTTP Overwrite header should be either T or F');
 
        list($destinationDir) = URLUtil::splitPath($destination);
 
        try {
            $destinationParent = $this->tree->getNodeForPath($destinationDir);
            if (!($destinationParent instanceof ICollection)) throw new Exception\UnsupportedMediaType('The destination node is not a collection');
        } catch (Exception\NotFound $e) {
 
            // If the destination parent node is not found, we throw a 409
            throw new Exception\Conflict('The destination node is not found');
        }
 
        try {
 
            $destinationNode = $this->tree->getNodeForPath($destination);
 
            // If this succeeded, it means the destination already exists
            // we'll need to throw precondition failed in case overwrite is false
            if (!$overwrite) throw new Exception\PreconditionFailed('The destination node already exists, and the overwrite header is set to false', 'Overwrite');
 
        } catch (Exception\NotFound $e) {
 
            // Destination didn't exist, we're all good
            $destinationNode = false;
 
        }
 
        $requestPath = $request->getPath();
        if ($destination === $requestPath) {
            throw new Exception\Forbidden('Source and destination uri are identical.');
        }
        if (substr($destination, 0, strlen($requestPath) + 1) === $requestPath . '/') {
            throw new Exception\Conflict('The destination may not be part of the same subtree as the source path.');
        }
 
        // These are the three relevant properties we need to return
        return [
            'destination'       => $destination,
            'destinationExists' => !!$destinationNode,
            'destinationNode'   => $destinationNode,
        ];
 
    }

References $destination, $request, Sabre\DAV\Server\calculateUri(), Sabre\HTTP\MessageInterface\getHeader(), and Sabre\HTTP\URLUtil\splitPath().

Here is the call graph for this function:

◆ getHTTPDepth()

Sabre\DAV\Server::getHTTPDepth ( $default = self::DEPTH_INFINITY )

Returns the HTTP depth header.

This method returns the contents of the HTTP depth request header. If the depth header was 'infinity' it will return the Sabre\DAV\Server::DEPTH_INFINITY object It is possible to supply a default depth value, which is used when the depth header has invalid content, or is completely non-existent

Parameters

mixed $default

Returns: int

Definition at line 603 of file Server.php.

                                                         {
 
        // If its not set, we'll grab the default
        $depth = $this->httpRequest->getHeader('Depth');
 
        if (is_null($depth)) return $default;
 
        if ($depth == 'infinity') return self::DEPTH_INFINITY;
 
        // If its an unknown value. we'll grab the default
        if (!ctype_digit($depth)) return $default;
 
        return (int)$depth;
 
    }

References $default, and Sabre\DAV\Server\DEPTH_INFINITY.

◆ getHTTPHeaders()

Sabre\DAV\Server::getHTTPHeaders ( $path )

Returns a list of HTTP headers for a particular resource.

The generated http headers are based on properties provided by the resource. The method basically provides a simple mapping between DAV property and HTTP header.

The headers are intended to be used for HEAD and GET requests.

Parameters

string $path

Returns: array

Definition at line 849 of file Server.php.

                                   {
 
        $propertyMap = [
            '{DAV:}getcontenttype'   => 'Content-Type',
            '{DAV:}getcontentlength' => 'Content-Length',
            '{DAV:}getlastmodified'  => 'Last-Modified',
            '{DAV:}getetag'          => 'ETag',
        ];
 
        $properties = $this->getProperties($path, array_keys($propertyMap));
 
        $headers = [];
        foreach ($propertyMap as $property => $header) {
            if (!isset($properties[$property])) continue;
 
            if (is_scalar($properties[$property])) {
                $headers[$header] = $properties[$property];
 
            // GetLastModified gets special cased
            } elseif ($properties[$property] instanceof Xml\Property\GetLastModified) {
                $headers[$header] = HTTP\Util::toHTTPDate($properties[$property]->getTime());
            }
 
        }
 
        return $headers;
 
    }

References $header, $path, Sabre\DAV\Server\getProperties(), getTime(), and Sabre\HTTP\Util\toHTTPDate().

Here is the call graph for this function:

◆ getHTTPPrefer()

Sabre\DAV\Server::getHTTPPrefer ( )

Returns the HTTP Prefer header information.

The prefer header is defined in: http://tools.ietf.org/html/draft-snell-http-prefer-14

This method will return an array with options.

Currently, the following options may be returned: [ 'return-asynch' => true, 'return-minimal' => true, 'return-representation' => true, 'wait' => 30, 'strict' => true, 'lenient' => true, ]

This method also supports the Brief header, and will also return 'return-minimal' if the brief header was set to 't'.

For the boolean options, false will be returned if the headers are not specified. For the integer options it will be 'null'.

Returns: array

Definition at line 678 of file Server.php.

                             {
 
        $result = [
            // can be true or false
            'respond-async' => false,
            // Could be set to 'representation' or 'minimal'.
            'return' => null,
            // Used as a timeout, is usually a number.
            'wait' => null,
            // can be 'strict' or 'lenient'.
            'handling' => false,
        ];
 
        if ($prefer = $this->httpRequest->getHeader('Prefer')) {
 
            $result = array_merge(
                $result,
                HTTP\parsePrefer($prefer)
            );
 
        } elseif ($this->httpRequest->getHeader('Brief') == 't') {
            $result['return'] = 'minimal';
        }
 
        return $result;
 
    }

References $result, and Sabre\HTTP\parsePrefer().

Here is the call graph for this function:

◆ getHTTPRange()

Sabre\DAV\Server::getHTTPRange ( )

Returns the HTTP range header.

This method returns null if there is no well-formed HTTP range request header or array($start, $end).

The first number is the offset of the first byte in the range. The second number is the offset of the last byte in the range.

If the second offset is null, it should be treated as the offset of the last byte of the entity If the first offset is null, the second offset should be used to retrieve the last x bytes of the entity

Returns: array|null

Definition at line 634 of file Server.php.

                            {
 
        $range = $this->httpRequest->getHeader('range');
        if (is_null($range)) return null;
 
        // Matching "Range: bytes=1234-5678: both numbers are optional
 
        if (!preg_match('/^bytes=([0-9]*)-([0-9]*)$/i', $range, $matches)) return null;
 
        if ($matches[1] === '' && $matches[2] === '') return null;
 
        return [
            $matches[1] !== '' ? $matches[1] : null,
            $matches[2] !== '' ? $matches[2] : null,
        ];
 
    }

◆ getIfConditions()

Sabre\DAV\Server::getIfConditions ( RequestInterface $request )

This method is created to extract information from the WebDAV HTTP 'If:' header.

The If header can be quite complex, and has a bunch of features. We're using a regex to extract all relevant information The function will return an array, containing structs with the following keys

uri - the uri the condition applies to.
tokens - The lock token. another 2 dimensional array containing 3 elements

Example 1:

If: (<opaquelocktoken:181d4fae-7d8c-11d0-a765-00a0c91e6bf2>)

Would result in:

[ [ 'uri' => '/request/uri', 'tokens' => [ [ [ 'negate' => false, 'token' => 'opaquelocktoken:181d4fae-7d8c-11d0-a765-00a0c91e6bf2', 'etag' => "" ] ] ], ] ]

Example 2:

If: </path> (Not <opaquelocktoken:181d4fae-7d8c-11d0-a765-00a0c91e6bf2> ["Im An ETag"]) (["Another ETag"]) </path2> (Not ["Path2 ETag"])

Would result in:

[ [ 'uri' => 'path', 'tokens' => [ [ [ 'negate' => true, 'token' => 'opaquelocktoken:181d4fae-7d8c-11d0-a765-00a0c91e6bf2', 'etag' => '"Im An ETag"' ], [ 'negate' => false, 'token' => '', 'etag' => '"Another ETag"' ] ] ], ], [ 'uri' => 'path2', 'tokens' => [ [ [ 'negate' => true, 'token' => '', 'etag' => '"Path2 ETag"' ] ] ], ], ]

Parameters

RequestInterface $request

Returns: array

Definition at line 1577 of file Server.php.

                                                        {
 
        $header = $request->getHeader('If');
        if (!$header) return [];
 
        $matches = [];
 
        $regex = '/(?:<(?P<uri>.*?)>\s)?\‍((?P<not>Not\s)?(?:<(?P<token>[^>]*)>)?(?:\s?)(?:\[(?P<etag>[^\]]*)\])?\‍)/im';
        preg_match_all($regex, $header, $matches, PREG_SET_ORDER);
 
        $conditions = [];
 
        foreach ($matches as $match) {
 
            // If there was no uri specified in this match, and there were
            // already conditions parsed, we add the condition to the list of
            // conditions for the previous uri.
            if (!$match['uri'] && count($conditions)) {
                $conditions[count($conditions) - 1]['tokens'][] = [
                    'negate' => $match['not'] ? true : false,
                    'token'  => $match['token'],
                    'etag'   => isset($match['etag']) ? $match['etag'] : ''
                ];
            } else {
 
                if (!$match['uri']) {
                    $realUri = $request->getPath();
                } else {
                    $realUri = $this->calculateUri($match['uri']);
                }
 
                $conditions[] = [
                    'uri'    => $realUri,
                    'tokens' => [
                        [
                            'negate' => $match['not'] ? true : false,
                            'token'  => $match['token'],
                            'etag'   => isset($match['etag']) ? $match['etag'] : ''
                        ]
                    ],
 
                ];
            }
 
        }
 
        return $conditions;
 
    }

References $header, $request, and Sabre\DAV\Server\calculateUri().

Referenced by Sabre\DAV\Server\checkPreconditions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogger()

Sabre\DAV\Server::getLogger ( )

Returns the PSR-3 logger object.

Returns: LoggerInterface

Definition at line 444 of file Server.php.

                         {
 
        if (!$this->logger) {
            $this->logger = new NullLogger();
        }
        return $this->logger;
 
    }

◆ getPlugin()

Sabre\DAV\Server::getPlugin ( $name )

Returns an initialized plugin by it's name.

This function returns null if the plugin was not found.

Parameters

string $name

Returns: ServerPlugin

Definition at line 419 of file Server.php.

                              {
 
        if (isset($this->plugins[$name]))
            return $this->plugins[$name];
 
        return null;
 
    }

References $name.

◆ getPlugins()

Sabre\DAV\Server::getPlugins ( )

Returns all plugins.

Returns: array

Definition at line 433 of file Server.php.

                          {
 
        return $this->plugins;
 
    }

References Sabre\DAV\Server\$plugins.

◆ getProperties()

Sabre\DAV\Server::getProperties	(	$path,
		$propertyNames
	)

Returns a list of properties for a path.

This is a simplified version getPropertiesForPath. If you aren't interested in status codes, but you just want to have a flat list of properties, use this method.

Please note though that any problems related to retrieving properties, such as permission issues will just result in an empty array being returned.

Parameters

string	$path
array	$propertyNames

Returns: array

Definition at line 799 of file Server.php.

                                                  {
 
        $result = $this->getPropertiesForPath($path, $propertyNames, 0);
        if (isset($result[0][200])) {
            return $result[0][200];
        } else {
            return [];
        }
 
    }

References $path, $result, and Sabre\DAV\Server\getPropertiesForPath().

Referenced by Sabre\DAV\Server\getHTTPHeaders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPropertiesByNode()

Sabre\DAV\Server::getPropertiesByNode	(	PropFind	$propFind,
		INode	$node
	)

Determines all properties for a node.

This method tries to grab all properties for a node. This method is used internally getPropertiesForPath and a few others.

It could be useful to call this, if you already have an instance of your target node and simply want to run through the system to get a correct list of properties.

Parameters

PropFind	$propFind
INode	$node

Returns: bool

Definition at line 1056 of file Server.php.

                                                                  {
 
        return $this->emit('propFind', [$propFind, $node]);
 
    }

References Sabre\Event\EventEmitterInterface\emit().

Referenced by Sabre\DAV\Server\getPropertiesForMultiplePaths(), and Sabre\DAV\Server\getPropertiesIteratorForPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPropertiesForChildren()

Sabre\DAV\Server::getPropertiesForChildren	(	$path,
		$propertyNames
	)

A kid-friendly way to fetch properties for a node's children.

The returned array will be indexed by the path of the of child node. Only properties that are actually found will be returned.

The parent node will not be returned.

Parameters

string	$path
array	$propertyNames

Returns: array

Definition at line 822 of file Server.php.

                                                             {
 
        $result = [];
        foreach ($this->getPropertiesForPath($path, $propertyNames, 1) as $k => $row) {
 
            // Skipping the parent path
            if ($k === 0) continue;
 
            $result[$row['href']] = $row[200];
 
        }
        return $result;
 
    }

References $path, $result, $row, and Sabre\DAV\Server\getPropertiesForPath().

Here is the call graph for this function:

◆ getPropertiesForMultiplePaths()

Sabre\DAV\Server::getPropertiesForMultiplePaths	(	array	$paths,
		array	$propertyNames = `[]`
	)

Returns a list of properties for a list of paths.

The path that should be supplied should have the baseUrl stripped out The list of properties should be supplied in Clark notation. If the list is empty 'allprops' is assumed.

The result is returned as an array, with paths for it's keys. The result may be returned out of order.

Parameters

array	$paths
array	$propertyNames

Returns: array

Definition at line 1014 of file Server.php.

                                                                                    {
 
        $result = [
        ];
 
        $nodes = $this->tree->getMultipleNodes($paths);
 
        foreach ($nodes as $path => $node) {
 
            $propFind = new PropFind($path, $propertyNames);
            $r = $this->getPropertiesByNode($propFind, $node);
            if ($r) {
                $result[$path] = $propFind->getResultForMultiStatus();
                $result[$path]['href'] = $path;
 
                $resourceType = $this->getResourceTypeForNode($node);
                if (in_array('{DAV:}collection', $resourceType) || in_array('{DAV:}principal', $resourceType)) {
                    $result[$path]['href'] .= '/';
                }
            }
 
        }
 
        return $result;
 
    }

References $nodes, $path, $paths, $r, $result, Sabre\DAV\Server\getPropertiesByNode(), and Sabre\DAV\Server\getResourceTypeForNode().

Here is the call graph for this function:

◆ getPropertiesForPath()

Sabre\DAV\Server::getPropertiesForPath	(	$path,
		$propertyNames = `[]`,
		$depth = `0`
	)

Returns a list of properties for a given path.

The path that should be supplied should have the baseUrl stripped out The list of properties should be supplied in Clark notation. If the list is empty 'allprops' is assumed.

If a depth of 1 is requested child elements will also be returned.

Parameters

string	$path
array	$propertyNames
int	$depth

Returns: array

Deprecated:: Use getPropertiesIteratorForPath() instead (as it's more memory efficient)

See also: getPropertiesIteratorForPath()

Definition at line 937 of file Server.php.

                                                                          {
 
        return iterator_to_array($this->getPropertiesIteratorForPath($path, $propertyNames, $depth));
 
    }

References $path, and Sabre\DAV\Server\getPropertiesIteratorForPath().

Referenced by Sabre\DAV\Server\getProperties(), and Sabre\DAV\Server\getPropertiesForChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPropertiesIteratorForPath()

Sabre\DAV\Server::getPropertiesIteratorForPath	(	$path,
		$propertyNames = `[]`,
		$depth = `0`
	)

Returns a list of properties for a given path.

The path that should be supplied should have the baseUrl stripped out The list of properties should be supplied in Clark notation. If the list is empty 'allprops' is assumed.

If a depth of 1 is requested child elements will also be returned.

Parameters

string	$path
array	$propertyNames
int	$depth

Returns: \Iterator

Definition at line 956 of file Server.php.

                                                                                  {
 
        // The only two options for the depth of a propfind is 0 or 1 - as long as depth infinity is not enabled
        if (!$this->enablePropfindDepthInfinity && $depth != 0) $depth = 1;
 
        $path = trim($path, '/');
 
        $propFindType = $propertyNames ? PropFind::NORMAL : PropFind::ALLPROPS;
        $propFind = new PropFind($path, (array)$propertyNames, $depth, $propFindType);
 
        $parentNode = $this->tree->getNodeForPath($path);
 
        $propFindRequests = [[
            $propFind,
            $parentNode
        ]];
 
        if (($depth > 0 || $depth === self::DEPTH_INFINITY) && $parentNode instanceof ICollection) {
            $propFindRequests = $this->generatePathNodes(clone $propFind, current($propFindRequests));
        }
 
        foreach ($propFindRequests as $propFindRequest) {
 
            list($propFind, $node) = $propFindRequest;
            $r = $this->getPropertiesByNode($propFind, $node);
            if ($r) {
                $result = $propFind->getResultForMultiStatus();
                $result['href'] = $propFind->getPath();
 
                // WebDAV recommends adding a slash to the path, if the path is
                // a collection.
                // Furthermore, iCal also demands this to be the case for
                // principals. This is non-standard, but we support it.
                $resourceType = $this->getResourceTypeForNode($node);
                if (in_array('{DAV:}collection', $resourceType) || in_array('{DAV:}principal', $resourceType)) {
                    $result['href'] .= '/';
                }
                yield $result;
            }
 
        }
 
    }

References $path, $r, $result, Sabre\DAV\PropFind\ALLPROPS, Sabre\DAV\Server\generatePathNodes(), Sabre\DAV\Server\getPropertiesByNode(), Sabre\DAV\Server\getResourceTypeForNode(), and Sabre\DAV\PropFind\NORMAL.

Referenced by Sabre\DAV\Server\getPropertiesForPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRequestUri()

Sabre\DAV\Server::getRequestUri ( )

Gets the uri for the request, keeping the base uri into consideration.

Returns: string

Definition at line 547 of file Server.php.

                             {
 
        return $this->calculateUri($this->httpRequest->getUrl());
 
    }

References Sabre\DAV\Server\calculateUri().

Here is the call graph for this function:

◆ getResourceTypeForNode()

Sabre\DAV\Server::getResourceTypeForNode ( INode $node )

Returns an array with resourcetypes for a node.

Parameters

INode $node

Returns: array

Definition at line 1633 of file Server.php.

                                                 {
 
        $result = [];
        foreach ($this->resourceTypeMapping as $className => $resourceType) {
            if ($node instanceof $className) $result[] = $resourceType;
        }
        return $result;
 
    }

References $result.

Referenced by Sabre\DAV\Server\getPropertiesForMultiplePaths(), and Sabre\DAV\Server\getPropertiesIteratorForPath().

Here is the caller graph for this function:

◆ guessBaseUri()

Sabre\DAV\Server::guessBaseUri ( )

This method attempts to detect the base uri.

Only the PATH_INFO variable is considered.

If this variable is not set, the root (/) is assumed.

Returns: string

Definition at line 362 of file Server.php.

                            {
 
        $pathInfo = $this->httpRequest->getRawServerValue('PATH_INFO');
        $uri = $this->httpRequest->getRawServerValue('REQUEST_URI');
 
        // If PATH_INFO is found, we can assume it's accurate.
        if (!empty($pathInfo)) {
 
            // We need to make sure we ignore the QUERY_STRING part
            if ($pos = strpos($uri, '?'))
                $uri = substr($uri, 0, $pos);
 
            // PATH_INFO is only set for urls, such as: /example.php/path
            // in that case PATH_INFO contains '/path'.
            // Note that REQUEST_URI is percent encoded, while PATH_INFO is
            // not, Therefore they are only comparable if we first decode
            // REQUEST_INFO as well.
            $decodedUri = URLUtil::decodePath($uri);
 
            // A simple sanity check:
            if (substr($decodedUri, strlen($decodedUri) - strlen($pathInfo)) === $pathInfo) {
                $baseUri = substr($decodedUri, 0, strlen($decodedUri) - strlen($pathInfo));
                return rtrim($baseUri, '/') . '/';
            }
 
            throw new Exception('The REQUEST_URI (' . $uri . ') did not end with the contents of PATH_INFO (' . $pathInfo . '). This server might be misconfigured.');
 
        }
 
        // The last fallback is that we're just going to assume the server root.
        return '/';
 
    }

References Sabre\DAV\Server\$baseUri, and Sabre\HTTP\URLUtil\decodePath().

Referenced by Sabre\DAV\Server\getBaseUri().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ invokeMethod()

Sabre\DAV\Server::invokeMethod	(	RequestInterface	$request,
		ResponseInterface	$response,
			$sendResponse = `true`
	)

Handles a http request, and execute a method based on its name.

Parameters

RequestInterface	$request
ResponseInterface	$response
bool	$sendResponse	Whether to send the HTTP response to the DAV client.

Returns: void

Definition at line 461 of file Server.php.

                                                                                                        {
 
        $method = $request->getMethod();
 
        if (!$this->emit('beforeMethod:' . $method, [$request, $response])) return;
        if (!$this->emit('beforeMethod', [$request, $response])) return;
 
        if (self::$exposeVersion) {
            $response->setHeader('X-Sabre-Version', Version::VERSION);
        }
 
        $this->transactionType = strtolower($method);
 
        if (!$this->checkPreconditions($request, $response)) {
            $this->sapi->sendResponse($response);
            return;
        }
 
        if ($this->emit('method:' . $method, [$request, $response])) {
            if ($this->emit('method', [$request, $response])) {
                $exMessage = "There was no plugin in the system that was willing to handle this " . $method . " method.";
                if ($method === "GET") {
                    $exMessage .= " Enable the Browser plugin to get a better result here.";
                }
 
                // Unsupported method
                throw new Exception\NotImplemented($exMessage);
            }
        }
 
        if (!$this->emit('afterMethod:' . $method, [$request, $response])) return;
        if (!$this->emit('afterMethod', [$request, $response])) return;
 
        if ($response->getStatus() === null) {
            throw new Exception('No subsystem set a valid HTTP status code. Something must have interrupted the request without providing further detail.');
        }
        if ($sendResponse) {
            $this->sapi->sendResponse($response);
            $this->emit('afterResponse', [$request, $response]);
        }
 
    }

References $request, $response, Sabre\DAV\Server\checkPreconditions(), Sabre\Event\EventEmitterInterface\emit(), and Sabre\DAV\Version\VERSION.

Referenced by Sabre\DAV\Server\exec().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBaseUri()

Sabre\DAV\Server::setBaseUri ( $uri )

Sets the base server uri.

Parameters

string $uri

Returns: void

Definition at line 332 of file Server.php.

                              {
 
        // If the baseUri does not end with a slash, we must add it
        if ($uri[strlen($uri) - 1] !== '/')
            $uri .= '/';
 
        $this->baseUri = $uri;
 
    }

◆ updateFile()

Sabre\DAV\Server::updateFile	(		$uri,
			$data,
		&	$etag = `null`
	)

This method is invoked by sub-systems updating a file.

This method will return true if the file was actually updated

Parameters

string	$uri
resource	$data
string	$etag

Returns: bool

Definition at line 1117 of file Server.php.

                                                    {
 
        $node = $this->tree->getNodeForPath($uri);
 
        // It is possible for an event handler to modify the content of the
        // body, before it gets written. If this is the case, $modified
        // should be set to true.
        //
        // If $modified is true, we must not send back an ETag.
        $modified = false;
        if (!$this->emit('beforeWriteContent', [$uri, $node, &$data, &$modified])) return false;
 
        $etag = $node->put($data);
        if ($modified) $etag = null;
        $this->emit('afterWriteContent', [$uri, $node]);
 
        return true;
    }

References $data, and Sabre\Event\EventEmitterInterface\emit().

Here is the call graph for this function:

◆ updateProperties()

Sabre\DAV\Server::updateProperties	(		$path,
		array	$properties
	)

This method updates a resource's properties.

The properties array must be a list of properties. Array-keys are property names in clarknotation, array-values are it's values. If a property must be deleted, the value should be null.

Note that this request should either completely succeed, or completely fail.

The response is an array with properties for keys, and http status codes as their values.

Parameters

string	$path
array	$properties

Returns: array

Definition at line 1261 of file Server.php.

                                                        {
 
        $propPatch = new PropPatch($properties);
        $this->emit('propPatch', [$path, $propPatch]);
        $propPatch->commit();
 
        return $propPatch->getResult();
 
    }

References $path, and Sabre\Event\EventEmitterInterface\emit().

Here is the call graph for this function:

Field Documentation

◆ $baseUri

Sabre\DAV\Server::$baseUri = null

protected

Definition at line 49 of file Server.php.

Referenced by Sabre\DAV\Server\calculateUri(), Sabre\DAV\Server\generateMultiStatus(), Sabre\DAV\Server\getBaseUri(), and Sabre\DAV\Server\guessBaseUri().

◆ $debugExceptions

Sabre\DAV\Server::$debugExceptions = false

Definition at line 141 of file Server.php.

◆ $enablePropfindDepthInfinity

Sabre\DAV\Server::$enablePropfindDepthInfinity = false

Definition at line 167 of file Server.php.

◆ $exposeVersion

Sabre\DAV\Server::$exposeVersion = true

static

Definition at line 184 of file Server.php.

Referenced by Sabre\DAV\Browser\Plugin\generateFooter(), Sabre\DAV\Browser\Plugin\generateHeader(), Sabre\CalDAV\ICSExportPlugin\mergeObjects(), and Sabre\CalDAV\Schedule\IMipPlugin\schedule().

◆ $httpRequest

Sabre\DAV\Server::$httpRequest

Definition at line 63 of file Server.php.

◆ $httpResponse

Sabre\DAV\Server::$httpResponse

Definition at line 56 of file Server.php.

◆ $plugins

Sabre\DAV\Server::$plugins = []

protected

Definition at line 77 of file Server.php.

Referenced by Sabre\DAV\Server\getPlugins().

◆ $protectedProperties

Sabre\DAV\Server::$protectedProperties

Definition at line 100 of file Server.php.

◆ $resourceTypeMapping

Sabre\DAV\Server::$resourceTypeMapping

Initial value:

= [
        'Sabre\\DAV\\ICollection' => '{DAV:}collection',
    ]

Definition at line 152 of file Server.php.

◆ $sapi

Sabre\DAV\Server::$sapi

Definition at line 70 of file Server.php.

◆ $transactionType

Sabre\DAV\Server::$transactionType

Definition at line 90 of file Server.php.

◆ $tree

Sabre\DAV\Server::$tree

Definition at line 42 of file Server.php.

◆ $xml

Sabre\DAV\Server::$xml

Definition at line 174 of file Server.php.

◆ DEPTH_INFINITY

const Sabre\DAV\Server::DEPTH_INFINITY = -1

Infinity is used for some request supporting the HTTP Depth header and indicates that the operation should traverse the entire tree.

Definition at line 30 of file Server.php.

Referenced by Sabre\DAV\Server\getHTTPDepth(), Sabre\DAV\Xml\Request\SyncCollectionTest\testDeserializeInfinity(), Sabre\DAV\Locks\Backend\AbstractTest\testGetLocksParent(), Sabre\DAV\Xml\Request\SyncCollectionReport\xmlDeserialize(), and Sabre\DAV\Xml\Property\LockDiscovery\xmlSerialize().

◆ NS_SABREDAV

const Sabre\DAV\Server::NS_SABREDAV = 'http://sabredav.org/ns'

XML namespace for all SabreDAV related elements.

Definition at line 35 of file Server.php.

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

libs/composer/vendor/sabre/dav/lib/DAV/Server.php

Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addPlugin()

◆ calculateUri()

◆ checkPreconditions()

◆ createCollection()

◆ createDirectory()

◆ createFile()

◆ exec()

◆ generateMultiStatus()

◆ generatePathNodes()

◆ getAllowedMethods()

◆ getBaseUri()

◆ getCopyAndMoveInfo()

◆ getHTTPDepth()

◆ getHTTPHeaders()

◆ getHTTPPrefer()

◆ getHTTPRange()

◆ getIfConditions()

◆ getLogger()

◆ getPlugin()

◆ getPlugins()

◆ getProperties()

◆ getPropertiesByNode()

◆ getPropertiesForChildren()

◆ getPropertiesForMultiplePaths()

◆ getPropertiesForPath()

◆ getPropertiesIteratorForPath()

◆ getRequestUri()

◆ getResourceTypeForNode()

◆ guessBaseUri()

◆ invokeMethod()

◆ setBaseUri()

◆ updateFile()

◆ updateProperties()

Field Documentation

◆ $baseUri

◆ $debugExceptions

◆ $enablePropfindDepthInfinity

◆ $exposeVersion

◆ $httpRequest

◆ $httpResponse

◆ $plugins

◆ $protectedProperties

◆ $resourceTypeMapping

◆ $sapi

◆ $transactionType

◆ $tree

◆ $xml

◆ DEPTH_INFINITY

◆ NS_SABREDAV