This plugin all WebDAV-sync capabilities to the Server. More...

Inheritance diagram for Sabre\DAV\Sync\Plugin:

Collaboration diagram for Sabre\DAV\Sync\Plugin:

Public Member Functions
	getPluginName ()
	Returns a plugin name. More...

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

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

	syncCollection ($uri, SyncCollectionReport $report)
	This method handles the {DAV:}sync-collection HTTP REPORT. More...

	propFind (DAV\PropFind $propFind, DAV\INode $node)
	This method is triggered whenever properties are requested for a node. More...

	validateTokens (RequestInterface $request, &$conditions)
	The validateTokens event is triggered before every request. More...

	getPluginInfo ()
	Returns a bunch of meta-data about the plugin. 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	SYNCTOKEN_PREFIX = 'http://sabre.io/ns/sync/'

Protected Member Functions
	sendSyncCollectionResponse ($syncToken, $collectionUrl, array $added, array $modified, array $deleted, array $properties)
	Sends the response to a sync-collection request. More...

Protected Attributes
	$server

Detailed Description

This plugin all WebDAV-sync capabilities to the Server.

WebDAV-sync is defined by rfc6578

The sync capabilities only work with collections that implement Sabre.

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

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

Definition at line 21 of file Plugin.php.

Member Function Documentation

◆ getPluginInfo()

Sabre\DAV\Sync\Plugin::getPluginInfo ( )

Returns a bunch of meta-data about the plugin.

Providing this information is optional, and is mainly displayed by the Browser plugin.

The description key in the returned array may contain html and will not be sanitized.

Returns: array

Definition at line 267 of file Plugin.php.

References Sabre\DAV\Sync\Plugin\getPluginName().

                              {
 
         return [
             'name'        => $this->getPluginName(),
             'description' => 'Adds support for WebDAV Collection Sync (rfc6578)',
             'link'        => 'http://sabre.io/dav/sync/',
         ];
 
     }

Here is the call graph for this function:

◆ getPluginName()

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

Returns a plugin name.

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

Returns: string

Definition at line 40 of file Plugin.php.

Referenced by Sabre\DAV\Sync\Plugin\getPluginInfo().

                              {
 
         return 'sync';
 
     }

Here is the caller graph for this function:

◆ getSupportedReportSet()

Sabre\DAV\Sync\Plugin::getSupportedReportSet ( $uri )

Returns a list of reports this plugin supports.

This will be used in the {DAV:}supported-report-set property. Note that you still need to subscribe to the 'report' event to actually implement them

Parameters

string $uri

Returns: array

Definition at line 86 of file Plugin.php.

References Sabre\DAV\Sync\ISyncCollection\getSyncToken().

                                          {
 
         $node = $this->server->tree->getNodeForPath($uri);
         if ($node instanceof ISyncCollection && $node->getSyncToken()) {
             return [
                 '{DAV:}sync-collection',
             ];
         }
 
         return [];
 
     }

Here is the call graph for this function:

◆ initialize()

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

Initializes the plugin.

This is when the plugin registers it's hooks.

Parameters

DAV\Server $server

Returns: void

Definition at line 54 of file Plugin.php.

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

                                             {
 
         $this->server = $server;
         $server->xml->elementMap['{DAV:}sync-collection'] = 'Sabre\\DAV\\Xml\\Request\\SyncCollectionReport';
 
         $self = $this;
 
         $server->on('report', function($reportName, $dom, $uri) use ($self) {
 
             if ($reportName === '{DAV:}sync-collection') {
                 $this->server->transactionType = 'report-sync-collection';
                 $self->syncCollection($uri, $dom);
                 return false;
             }
 
         });
 
         $server->on('propFind',       [$this, 'propFind']);
         $server->on('validateTokens', [$this, 'validateTokens']);
 
     }

◆ propFind()

Sabre\DAV\Sync\Plugin::propFind	(	DAV\PropFind	$propFind,
		DAV\INode	$node
	)

This method is triggered whenever properties are requested for a node.

We intercept this to see if we must return a {DAV:}sync-token.

Parameters

DAV\PropFind	$propFind
DAV\INode	$node

Returns: void

Definition at line 208 of file Plugin.php.

References PHPMailer\PHPMailer\$token.

                                                                {
 
         $propFind->handle('{DAV:}sync-token', function() use ($node) {
             if (!$node instanceof ISyncCollection || !$token = $node->getSyncToken()) {
                 return;
             }
             return self::SYNCTOKEN_PREFIX . $token;
         });
 
     }

◆ sendSyncCollectionResponse()

Sabre\DAV\Sync\Plugin::sendSyncCollectionResponse	(		$syncToken,
			$collectionUrl,
		array	$added,
		array	$modified,
		array	$deleted,
		array	$properties
	)

protected

Sends the response to a sync-collection request.

Parameters

string	$syncToken
string	$collectionUrl
array	$added
array	$modified
array	$deleted
array	$properties

Returns: void

Definition at line 160 of file Plugin.php.

Referenced by Sabre\DAV\Sync\Plugin\syncCollection().

                                                                                                                                                 {
 
 
         $fullPaths = [];
 
         // Pre-fetching children, if this is possible.
         foreach (array_merge($added, $modified) as $item) {
             $fullPath = $collectionUrl . '/' . $item;
             $fullPaths[] = $fullPath;
         }
 
         $responses = [];
         foreach ($this->server->getPropertiesForMultiplePaths($fullPaths, $properties) as $fullPath => $props) {
 
             // The 'Property_Response' class is responsible for generating a
             // single {DAV:}response xml element.
             $responses[] = new DAV\Xml\Element\Response($fullPath, $props);
 
         }
 
 
 
         // Deleted items also show up as 'responses'. They have no properties,
         // and a single {DAV:}status element set as 'HTTP/1.1 404 Not Found'.
         foreach ($deleted as $item) {
 
             $fullPath = $collectionUrl . '/' . $item;
             $responses[] = new DAV\Xml\Element\Response($fullPath, [], 404);
 
         }
         $multiStatus = new DAV\Xml\Response\MultiStatus($responses, self::SYNCTOKEN_PREFIX . $syncToken);
 
         $this->server->httpResponse->setStatus(207);
         $this->server->httpResponse->setHeader('Content-Type', 'application/xml; charset=utf-8');
         $this->server->httpResponse->setBody(
             $this->server->xml->write('{DAV:}multistatus', $multiStatus, $this->server->getBaseUri())
         );
 
     }

Here is the caller graph for this function:

◆ syncCollection()

Sabre\DAV\Sync\Plugin::syncCollection	(		$uri,
		SyncCollectionReport	$report
	)

This method handles the {DAV:}sync-collection HTTP REPORT.

Parameters

string	$uri
SyncCollectionReport	$report

Returns: void

Definition at line 107 of file Plugin.php.

References PHPMailer\PHPMailer\$token, and Sabre\DAV\Sync\Plugin\sendSyncCollectionResponse().

                                                                 {
 
         // Getting the data
         $node = $this->server->tree->getNodeForPath($uri);
         if (!$node instanceof ISyncCollection) {
             throw new DAV\Exception\ReportNotSupported('The {DAV:}sync-collection REPORT is not supported on this url.');
         }
         $token = $node->getSyncToken();
         if (!$token) {
             throw new DAV\Exception\ReportNotSupported('No sync information is available at this node');
         }
 
         $syncToken = $report->syncToken;
         if (!is_null($syncToken)) {
             // Sync-token must start with our prefix
             if (substr($syncToken, 0, strlen(self::SYNCTOKEN_PREFIX)) !== self::SYNCTOKEN_PREFIX) {
                 throw new DAV\Exception\InvalidSyncToken('Invalid or unknown sync token');
             }
 
             $syncToken = substr($syncToken, strlen(self::SYNCTOKEN_PREFIX));
 
         }
         $changeInfo = $node->getChanges($syncToken, $report->syncLevel, $report->limit);
 
         if (is_null($changeInfo)) {
 
             throw new DAV\Exception\InvalidSyncToken('Invalid or unknown sync token');
 
         }
 
         // Encoding the response
         $this->sendSyncCollectionResponse(
             $changeInfo['syncToken'],
             $uri,
             $changeInfo['added'],
             $changeInfo['modified'],
             $changeInfo['deleted'],
             $report->properties
         );
 
     }

Here is the call graph for this function:

◆ validateTokens()

Sabre\DAV\Sync\Plugin::validateTokens	(	RequestInterface	$request,
		&	$conditions
	)

The validateTokens event is triggered before every request.

It's a moment where this plugin can check all the supplied lock tokens in the If: header, and check if they are valid.

Parameters

RequestInterface	$request
array	$conditions

Returns: void

Definition at line 229 of file Plugin.php.

References $ii, PHPMailer\PHPMailer\$token, and Sabre\DAV\Sync\ISyncCollection\getSyncToken().

                                                                      {
 
         foreach ($conditions as $kk => $condition) {
 
             foreach ($condition['tokens'] as $ii => $token) {
 
                 // Sync-tokens must always start with our designated prefix.
                 if (substr($token['token'], 0, strlen(self::SYNCTOKEN_PREFIX)) !== self::SYNCTOKEN_PREFIX) {
                     continue;
                 }
 
                 // Checking if the token is a match.
                 $node = $this->server->tree->getNodeForPath($condition['uri']);
 
                 if (
                     $node instanceof ISyncCollection &&
                     $node->getSyncToken() == substr($token['token'], strlen(self::SYNCTOKEN_PREFIX))
                 ) {
                     $conditions[$kk]['tokens'][$ii]['validToken'] = true;
                 }
 
             }
 
         }
 
     }

Here is the call graph for this function:

Field Documentation

◆ $server

Sabre\DAV\Sync\Plugin::$server

protected

Definition at line 28 of file Plugin.php.

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

◆ SYNCTOKEN_PREFIX

const Sabre\DAV\Sync\Plugin::SYNCTOKEN_PREFIX = 'http://sabre.io/ns/sync/'

Definition at line 30 of file Plugin.php.

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

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

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getPluginInfo()

◆ getPluginName()

◆ getSupportedReportSet()

◆ initialize()

◆ propFind()

◆ sendSyncCollectionResponse()

◆ syncCollection()

◆ validateTokens()

Field Documentation

◆ $server

◆ SYNCTOKEN_PREFIX