Partial update plugin (Patch method) More...

Inheritance diagram for Sabre\DAV\PartialUpdate\Plugin:

Collaboration diagram for Sabre\DAV\PartialUpdate\Plugin:

Public Member Functions
	initialize (DAV\Server $server)
	Initializes the plugin. More...

	getPluginName ()
	Returns a plugin name. More...

	getHTTPMethods ($uri)
	Use this method to tell the server this plugin defines additional HTTP methods. More...

	getFeatures ()
	Returns a list of features for the HTTP OPTIONS Dav: header. More...

	httpPatch (RequestInterface $request, ResponseInterface $response)
	Patch an uri. More...

	getHTTPUpdateRange (RequestInterface $request)
	Returns the HTTP custom range update header. More...

Public Member Functions inherited from Sabre\DAV\ServerPlugin
	initialize (Server $server)
	This initializes the plugin. More...

	getFeatures ()
	This method should return a list of server-features. More...

	getHTTPMethods ($path)
	Use this method to tell the server this plugin defines additional HTTP methods. More...

	getPluginName ()
	Returns a plugin name. More...

	getSupportedReportSet ($uri)
	Returns a list of reports this plugin supports. More...

	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. More...

Data Fields
const	RANGE_APPEND = 1

const	RANGE_START = 2

const	RANGE_END = 3

Protected Attributes
	$server

Detailed Description

Partial update plugin (Patch method)

This plugin provides a way to modify only part of a target resource It may bu used to update a file chunk, upload big a file into smaller chunks or resume an upload.

$patchPlugin = new (); $server->addPlugin($patchPlugin);

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

Author: Jean-Tiare LE BIGOT (http://www.jtlebi.fr/) http://sabre.io/license/ Modified BSD License

Definition at line 23 of file Plugin.php.

Member Function Documentation

◆ getFeatures()

Sabre\DAV\PartialUpdate\Plugin::getFeatures ( )

Returns a list of features for the HTTP OPTIONS Dav: header.

Returns: array

Definition at line 98 of file Plugin.php.

                            {
 
         return ['sabredav-partialupdate'];
 
     }

◆ getHTTPMethods()

Sabre\DAV\PartialUpdate\Plugin::getHTTPMethods ( $uri )

Use this method to tell the server this plugin defines additional HTTP methods.

This method is passed a uri. It should only return HTTP methods that are available for the specified uri.

We claim to support PATCH method (partirl update) if and only if

the node exist
the node implements our partial update interface

Parameters

string $uri

Returns: array

Definition at line 79 of file Plugin.php.

References $tree.

                                   {
 
         $tree = $this->server->tree;
 
         if ($tree->nodeExists($uri)) {
             $node = $tree->getNodeForPath($uri);
             if ($node instanceof IPatchSupport) {
                 return ['PATCH'];
             }
         }
         return [];
 
     }

◆ getHTTPUpdateRange()

Sabre\DAV\PartialUpdate\Plugin::getHTTPUpdateRange ( RequestInterface $request )

Returns the HTTP custom range update header.

This method returns null if there is no well-formed HTTP range request header. It returns array(1) if it was an append request, array(2, $start, $end) if it's a start and end range, lastly it's array(3, $endoffset) if the offset was negative, and should be calculated from the end of the file.

Examples:

null - invalid [1] - append [2,10,15] - update bytes 10, 11, 12, 13, 14, 15 [2,10,null] - update bytes 10 until the end of the patch body [3,-5] - update from 5 bytes from the end of the file.

Parameters

RequestInterface $request

Returns: array|null

Definition at line 197 of file Plugin.php.

References Sabre\HTTP\MessageInterface\getHeader().

Referenced by Sabre\DAV\PartialUpdate\Plugin\httpPatch().

                                                            {
 
         $range = $request->getHeader('X-Update-Range');
         if (is_null($range)) return null;
 
         // Matching "Range: bytes=1234-5678: both numbers are optional
 
         if (!preg_match('/^(append)|(?:bytes=([0-9]+)-([0-9]*))|(?:bytes=(-[0-9]+))$/i', $range, $matches)) return null;
 
         if ($matches[1] === 'append') {
             return [self::RANGE_APPEND];
         } elseif (strlen($matches[2]) > 0) {
             return [self::RANGE_START, $matches[2], $matches[3] ?: null];
         } else {
             return [self::RANGE_END, $matches[4]];
         }
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginName()

Sabre\DAV\PartialUpdate\Plugin::getPluginName ( )

Returns a plugin name.

Using this name other plugins will be able to access other plugins using DAV::getPlugin

Returns: string

Definition at line 59 of file Plugin.php.

                              {
 
         return 'partialupdate';
 
     }

◆ httpPatch()

Sabre\DAV\PartialUpdate\Plugin::httpPatch	(	RequestInterface	$request,
		ResponseInterface	$response
	)

Patch an uri.

The WebDAV patch request can be used to modify only a part of an existing resource. If the resource does not exist yet and the first offset is not 0, the request fails

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns: void

Definition at line 115 of file Plugin.php.

References $contentType, $path, Sabre\HTTP\MessageInterface\getHeader(), Sabre\DAV\PartialUpdate\Plugin\getHTTPUpdateRange(), Sabre\HTTP\RequestInterface\getPath(), Sabre\HTTP\MessageInterface\setHeader(), and Sabre\HTTP\ResponseInterface\setStatus().

                                                                                {
 
         $path = $request->getPath();
 
         // Get the node. Will throw a 404 if not found
         $node = $this->server->tree->getNodeForPath($path);
         if (!$node instanceof IPatchSupport) {
             throw new DAV\Exception\MethodNotAllowed('The target resource does not support the PATCH method.');
         }
 
         $range = $this->getHTTPUpdateRange($request);
 
         if (!$range) {
             throw new DAV\Exception\BadRequest('No valid "X-Update-Range" found in the headers');
         }
 
         $contentType = strtolower(
             $request->getHeader('Content-Type')
         );
 
         if ($contentType != 'application/x-sabredav-partialupdate') {
             throw new DAV\Exception\UnsupportedMediaType('Unknown Content-Type header "' . $contentType . '"');
         }
 
         $len = $this->server->httpRequest->getHeader('Content-Length');
         if (!$len) throw new DAV\Exception\LengthRequired('A Content-Length header is required');
 
         switch ($range[0]) {
             case self::RANGE_START :
                 // Calculate the end-range if it doesn't exist.
                 if (!$range[2]) {
                     $range[2] = $range[1] + $len - 1;
                 } else {
                     if ($range[2] < $range[1]) {
                         throw new DAV\Exception\RequestedRangeNotSatisfiable('The end offset (' . $range[2] . ') is lower than the start offset (' . $range[1] . ')');
                     }
                     if ($range[2] - $range[1] + 1 != $len) {
                         throw new DAV\Exception\RequestedRangeNotSatisfiable('Actual data length (' . $len . ') is not consistent with begin (' . $range[1] . ') and end (' . $range[2] . ') offsets');
                     }
                 }
                 break;
         }
 
         if (!$this->server->emit('beforeWriteContent', [$path, $node, null]))
             return;
 
         $body = $this->server->httpRequest->getBody();
 
 
         $etag = $node->patch($body, $range[0], isset($range[1]) ? $range[1] : null);
 
         $this->server->emit('afterWriteContent', [$path, $node]);
 
         $response->setHeader('Content-Length', '0');
         if ($etag) $response->setHeader('ETag', $etag);
         $response->setStatus(204);
 
         // Breaks the event chain
         return false;
 
     }

Here is the call graph for this function:

◆ initialize()

Sabre\DAV\PartialUpdate\Plugin::initialize ( DAV\Server $server )

Initializes the plugin.

This method is automatically called by the Server class after addPlugin.

Parameters

DAV\Server $server

Returns: void

Definition at line 44 of file Plugin.php.

References Sabre\DAV\PartialUpdate\Plugin\$server.

                                             {
 
         $this->server = $server;
         $server->on('method:PATCH', [$this, 'httpPatch']);
 
     }

Field Documentation

◆ $server

Sabre\DAV\PartialUpdate\Plugin::$server

protected

Definition at line 34 of file Plugin.php.

Referenced by Sabre\DAV\PartialUpdate\Plugin\initialize().

◆ RANGE_APPEND

const Sabre\DAV\PartialUpdate\Plugin::RANGE_APPEND = 1

Definition at line 25 of file Plugin.php.

◆ RANGE_END

const Sabre\DAV\PartialUpdate\Plugin::RANGE_END = 3

Definition at line 27 of file Plugin.php.

◆ RANGE_START

const Sabre\DAV\PartialUpdate\Plugin::RANGE_START = 2

Definition at line 26 of file Plugin.php.

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

libs/composer/vendor/sabre/dav/lib/DAV/PartialUpdate/Plugin.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Member Function Documentation

◆ getFeatures()

◆ getHTTPMethods()

◆ getHTTPUpdateRange()

◆ getPluginName()

◆ httpPatch()

◆ initialize()

Field Documentation

◆ $server

◆ RANGE_APPEND

◆ RANGE_END

◆ RANGE_START