This plugin implements HTTP requests and properties related to: More...

Inheritance diagram for Sabre\DAV\Sharing\Plugin:

Collaboration diagram for Sabre\DAV\Sharing\Plugin:

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

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

	initialize (Server $server)
	This initializes the plugin. More...

	shareResource ($path, array $sharees)
	Updates the list of sharees on a shared resource. More...

	propFind (PropFind $propFind, INode $node)
	This event is triggered when properties are requested for nodes. More...

	httpPost (RequestInterface $request, ResponseInterface $response)
	We intercept this to handle POST requests on shared resources. More...

	getSupportedPrivilegeSet (INode $node, array &$supportedPrivilegeSet)
	This method is triggered whenever a subsystem reqeuests the privileges hat are supported on a particular node. More...

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

	htmlActionsPanel (INode $node, &$output, $path)
	This method is used to generate HTML output for the DAV. More...

	browserPostAction ($path, $action, $postVars)
	This method is triggered for POST actions generated by the browser 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	ACCESS_NOTSHARED = 0

const	ACCESS_SHAREDOWNER = 1

const	ACCESS_READ = 2

const	ACCESS_READWRITE = 3

const	ACCESS_NOACCESS = 4

const	INVITE_NORESPONSE = 1

const	INVITE_ACCEPTED = 2

const	INVITE_DECLINED = 3

const	INVITE_INVALID = 4

Protected Attributes
	$server

Detailed Description

This plugin implements HTTP requests and properties related to:

draft-pot-webdav-resource-sharing

This specification allows people to share webdav resources with others.

Copyright: Copyright (C) 2007-2015 fruux GmbH. (https://fruux.com/)

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

Definition at line 27 of file Plugin.php.

Member Function Documentation

◆ browserPostAction()

Sabre\DAV\Sharing\Plugin::browserPostAction	(	$path,
		$action,
		$postVars
	)

This method is triggered for POST actions generated by the browser plugin.

Parameters

string	$path
string	$action
array	$postVars

Definition at line 307 of file Plugin.php.

References $action, $path, and Sabre\DAV\Sharing\Plugin\shareResource().

                                                           {
 
         if ($action !== 'share') {
             return;
         }
 
         if (empty($postVars['href'])) {
             throw new BadRequest('The "href" POST parameter is required');
         }
         if (empty($postVars['access'])) {
             throw new BadRequest('The "access" POST parameter is required');
         }
 
         $accessMap = [
             'readwrite' => self::ACCESS_READWRITE,
             'read'      => self::ACCESS_READ,
             'no-access' => self::ACCESS_NOACCESS,
         ];
 
         if (!isset($accessMap[$postVars['access']])) {
             throw new BadRequest('The "access" POST must be readwrite, read or no-access');
         }
         $sharee = new Sharee([
             'href'   => $postVars['href'],
             'access' => $accessMap[$postVars['access']],
         ]);
 
         $this->shareResource(
             $path,
             [$sharee]
         );
         return false;
 
     }

Here is the call graph for this function:

◆ getFeatures()

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

This method should return a list of server-features.

This is for example 'versioning' and is added to the DAV: header in an OPTIONS response.

Returns: array

Definition at line 55 of file Plugin.php.

                            {
 
         return ['resource-sharing'];
 
     }

◆ getPluginInfo()

Sabre\DAV\Sharing\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 250 of file Plugin.php.

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

                              {
 
         return [
             'name'        => $this->getPluginName(),
             'description' => 'This plugin implements WebDAV resource sharing',
             'link'        => 'https://github.com/evert/webdav-sharing'
         ];
 
     }

Here is the call graph for this function:

◆ getPluginName()

Sabre\DAV\Sharing\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 69 of file Plugin.php.

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

                              {
 
         return 'sharing';
 
     }

Here is the caller graph for this function:

◆ getSupportedPrivilegeSet()

Sabre\DAV\Sharing\Plugin::getSupportedPrivilegeSet	(	INode	$node,
		array &	$supportedPrivilegeSet
	)

This method is triggered whenever a subsystem reqeuests the privileges hat are supported on a particular node.

We need to add a number of privileges for scheduling purposes.

Parameters

INode	$node
array	$supportedPrivilegeSet

Definition at line 229 of file Plugin.php.

                                                                                   {
 
         if ($node instanceof ISharedNode) {
             $supportedPrivilegeSet['{DAV:}share'] = [
                 'abstract'   => false,
                 'aggregates' => [],
             ];
         }
     }

◆ htmlActionsPanel()

Sabre\DAV\Sharing\Plugin::htmlActionsPanel	(	INode	$node,
		&	$output,
			$path
	)

This method is used to generate HTML output for the DAV.

Parameters

INode	$node
string	$output
string	$path

Returns: bool|null

Definition at line 269 of file Plugin.php.

References $aclPlugin, Sabre\VObject\$output, and $path.

                                                             {
 
         if (!$node instanceof ISharedNode) {
             return;
         }
 
         $aclPlugin = $this->server->getPlugin('acl');
         if ($aclPlugin) {
             if (!$aclPlugin->checkPrivileges($path, '{DAV:}share', \Sabre\DAVACL\Plugin::R_PARENT, false)) {
                 // Sharing is not permitted, we will not draw this interface.
                 return;
             }
         }
 
         $output .= '<tr><td colspan="2"><form method="post" action="">
             <h3>Share this resource</h3>
             <input type="hidden" name="sabreAction" value="share" />
             <label>Share with (uri):</label> <input type="text" name="href" placeholder="mailto:user@example.org"/><br />
             <label>Access</label>
                 <select name="access">
                     <option value="readwrite">Read-write</option>
                     <option value="read">Read-only</option>
                     <option value="no-access">Revoke access</option>
                 </select><br />
              <input type="submit" value="share" />
             </form>
             </td></tr>';
 
     }

◆ httpPost()

Sabre\DAV\Sharing\Plugin::httpPost	(	RequestInterface	$request,
		ResponseInterface	$response
	)

We intercept this to handle POST requests on shared resources.

Parameters

RequestInterface	$request
ResponseInterface	$response

Returns: null|bool

Definition at line 184 of file Plugin.php.

References $contentType, $message, $path, Sabre\HTTP\MessageInterface\getBody(), Sabre\HTTP\MessageInterface\getHeader(), Sabre\HTTP\RequestInterface\getPath(), Sabre\HTTP\RequestInterface\getUrl(), Sabre\HTTP\MessageInterface\setHeader(), Sabre\HTTP\ResponseInterface\setStatus(), and Sabre\DAV\Sharing\Plugin\shareResource().

                                                                               {
 
         $path = $request->getPath();
         $contentType = $request->getHeader('Content-Type');
 
         // We're only interested in the davsharing content type.
         if (strpos($contentType, 'application/davsharing+xml') === false) {
             return;
         }
 
         $message = $this->server->xml->parse(
             $request->getBody(),
             $request->getUrl(),
             $documentType
         );
 
         switch ($documentType) {
 
             case '{DAV:}share-resource':
 
                 $this->shareResource($path, $message->sharees);
                 $response->setStatus(200);
                 // Adding this because sending a response body may cause issues,
                 // and I wanted some type of indicator the response was handled.
                 $response->setHeader('X-Sabre-Status', 'everything-went-well');
 
                 // Breaking the event chain
                 return false;
 
             default :
                 throw new BadRequest('Unexpected document type: ' . $documentType . ' for this Content-Type');
 
         }
 
     }

Here is the call graph for this function:

◆ initialize()

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

This initializes the plugin.

This function is called by Sabre, after addPlugin is called.

This method should set up the required event subscriptions.

Parameters

Server $server

Returns: void

Definition at line 86 of file Plugin.php.

References Sabre\DAV\Sharing\Plugin\$server, and Sabre\Event\EventEmitterInterface\on().

                                         {
 
         $this->server = $server;
 
         $server->xml->elementMap['{DAV:}share-resource'] = 'Sabre\\DAV\\Xml\\Request\\ShareResource';
 
         array_push(
             $server->protectedProperties,
             '{DAV:}share-mode'
         );
 
         $server->on('method:POST',              [$this, 'httpPost']);
         $server->on('propFind',                 [$this, 'propFind']);
         $server->on('getSupportedPrivilegeSet', [$this, 'getSupportedPrivilegeSet']);
         $server->on('onHTMLActionsPanel',       [$this, 'htmlActionsPanel']);
         $server->on('onBrowserPostAction',      [$this, 'browserPostAction']);
 
     }

Here is the call graph for this function:

◆ propFind()

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

This event is triggered when properties are requested for nodes.

This allows us to inject any sharings-specific properties.

Parameters

PropFind	$propFind
INode	$node

Returns: void

Definition at line 153 of file Plugin.php.

References Sabre\DAV\PropFind\handle().

                                                        {
 
         if ($node instanceof ISharedNode) {
 
             $propFind->handle('{DAV:}share-access', function() use ($node) {
 
                 return new Property\ShareAccess($node->getShareAccess());
 
             });
             $propFind->handle('{DAV:}invite', function() use ($node) {
 
                 return new Property\Invite($node->getInvites());
 
             });
             $propFind->handle('{DAV:}share-resource-uri', function() use ($node) {
 
                 return new Property\Href($node->getShareResourceUri());
 
             });
 
         }
 
     }

Here is the call graph for this function:

◆ shareResource()

Sabre\DAV\Sharing\Plugin::shareResource	(		$path,
		array	$sharees
	)

Updates the list of sharees on a shared resource.

The sharees array is a list of people that are to be added modified or removed in the list of shares.

Parameters

string	$path
	Sharee[]	$sharees

Returns: void

Definition at line 115 of file Plugin.php.

References $path.

Referenced by Sabre\DAV\Sharing\Plugin\browserPostAction(), and Sabre\DAV\Sharing\Plugin\httpPost().

                                                   {
 
         $node = $this->server->tree->getNodeForPath($path);
 
         if (!$node instanceof ISharedNode) {
 
             throw new Forbidden('Sharing is not allowed on this node');
 
         }
 
         // Getting ACL info
         $acl = $this->server->getPlugin('acl');
 
         // If there's no ACL support, we allow everything
         if ($acl) {
             $acl->checkPrivileges($path, '{DAV:}share');
         }
 
         foreach ($sharees as $sharee) {
             // We're going to attempt to get a local principal uri for a share
             // href by emitting the getPrincipalByUri event.
             $principal = null;
             $this->server->emit('getPrincipalByUri', [$sharee->href, &$principal]);
             $sharee->principal = $principal;
         }
         $node->updateInvites($sharees);
 
     }