Addressbook sharing added based on a simplified approach which is based on calendar sharing standard
Thomas Müller
10 years ago
parent
58eaeb267c
commit
4eb15885c9
@ -0,0 +1,58 @@ |
||||
<?php |
||||
|
||||
namespace OCA\DAV\CardDAV; |
||||
|
||||
use OCA\DAV\CardDAV\Sharing\IShareableAddressBook; |
||||
use OCP\IUserManager; |
||||
|
||||
class AddressBook extends \Sabre\CardDAV\AddressBook implements IShareableAddressBook { |
||||
|
||||
/** @var IUserManager */ |
||||
private $userManager; |
||||
|
||||
public function __construct(CardDavBackend $carddavBackend, array $addressBookInfo) { |
||||
parent::__construct($carddavBackend, $addressBookInfo); |
||||
} |
||||
|
||||
/** |
||||
* Updates the list of shares. |
||||
* |
||||
* The first array is a list of people that are to be added to the |
||||
* addressbook. |
||||
* |
||||
* Every element in the add array has the following properties: |
||||
* * href - A url. Usually a mailto: address |
||||
* * commonName - Usually a first and last name, or false |
||||
* * summary - A description of the share, can also be false |
||||
* * readOnly - A boolean value |
||||
* |
||||
* Every element in the remove array is just the address string. |
||||
* |
||||
* @param array $add |
||||
* @param array $remove |
||||
* @return void |
||||
*/ |
||||
function updateShares(array $add, array $remove) { |
||||
/** @var CardDavBackend $carddavBackend */ |
||||
$carddavBackend = $this->carddavBackend; |
||||
$carddavBackend->updateShares($this->getName(), $add, $remove); |
||||
} |
||||
|
||||
/** |
||||
* Returns the list of people whom this addressbook is shared with. |
||||
* |
||||
* Every element in this array should have the following properties: |
||||
* * href - Often a mailto: address |
||||
* * commonName - Optional, for example a first + last name |
||||
* * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants. |
||||
* * readOnly - boolean |
||||
* * summary - Optional, a description for the share |
||||
* |
||||
* @return array |
||||
*/ |
||||
function getShares() { |
||||
/** @var CardDavBackend $carddavBackend */ |
||||
$carddavBackend = $this->carddavBackend; |
||||
$carddavBackend->getShares($this->getName()); |
||||
} |
||||
} |
||||
@ -0,0 +1,23 @@ |
||||
<?php |
||||
|
||||
namespace OCA\DAV\CardDAV; |
||||
|
||||
class AddressBookRoot extends \Sabre\CardDAV\AddressBookRoot { |
||||
|
||||
/** |
||||
* This method returns a node for a principal. |
||||
* |
||||
* The passed array contains principal information, and is guaranteed to |
||||
* at least contain a uri item. Other properties may or may not be |
||||
* supplied by the authentication backend. |
||||
* |
||||
* @param array $principal |
||||
* @return \Sabre\DAV\INode |
||||
*/ |
||||
function getChildForPrincipal(array $principal) { |
||||
|
||||
return new UserAddressBooks($this->carddavBackend, $principal['uri']); |
||||
|
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,46 @@ |
||||
<?php |
||||
|
||||
namespace OCA\DAV\CardDAV\Sharing; |
||||
use Sabre\CardDAV\IAddressBook; |
||||
|
||||
/** |
||||
* This interface represents a Calendar that can be shared with other users. |
||||
* |
||||
*/ |
||||
interface IShareableAddressBook extends IAddressBook { |
||||
|
||||
/** |
||||
* Updates the list of shares. |
||||
* |
||||
* The first array is a list of people that are to be added to the |
||||
* addressbook. |
||||
* |
||||
* Every element in the add array has the following properties: |
||||
* * href - A url. Usually a mailto: address |
||||
* * commonName - Usually a first and last name, or false |
||||
* * summary - A description of the share, can also be false |
||||
* * readOnly - A boolean value |
||||
* |
||||
* Every element in the remove array is just the address string. |
||||
* |
||||
* @param array $add |
||||
* @param array $remove |
||||
* @return void |
||||
*/ |
||||
function updateShares(array $add, array $remove); |
||||
|
||||
/** |
||||
* Returns the list of people whom this addressbook is shared with. |
||||
* |
||||
* Every element in this array should have the following properties: |
||||
* * href - Often a mailto: address |
||||
* * commonName - Optional, for example a first + last name |
||||
* * status - See the Sabre\CalDAV\SharingPlugin::STATUS_ constants. |
||||
* * readOnly - boolean |
||||
* * summary - Optional, a description for the share |
||||
* |
||||
* @return array |
||||
*/ |
||||
function getShares(); |
||||
|
||||
} |
||||
@ -0,0 +1,194 @@ |
||||
<?php |
||||
|
||||
namespace OCA\DAV\CardDAV\Sharing; |
||||
|
||||
use Sabre\DAV\Exception\NotFound; |
||||
use Sabre\DAV\Server; |
||||
use Sabre\DAV\ServerPlugin; |
||||
use Sabre\DAV\XMLUtil; |
||||
use Sabre\HTTP\RequestInterface; |
||||
use Sabre\HTTP\ResponseInterface; |
||||
|
||||
class Plugin extends ServerPlugin { |
||||
|
||||
/** |
||||
* Reference to SabreDAV server object. |
||||
* |
||||
* @var \Sabre\DAV\Server |
||||
*/ |
||||
protected $server; |
||||
|
||||
/** |
||||
* 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. |
||||
* |
||||
* @return array |
||||
*/ |
||||
function getFeatures() { |
||||
|
||||
return ['oc-addressbook-sharing']; |
||||
|
||||
} |
||||
|
||||
/** |
||||
* Returns a plugin name. |
||||
* |
||||
* Using this name other plugins will be able to access other plugins |
||||
* using Sabre\DAV\Server::getPlugin |
||||
* |
||||
* @return string |
||||
*/ |
||||
function getPluginName() { |
||||
|
||||
return 'carddav-sharing'; |
||||
|
||||
} |
||||
|
||||
/** |
||||
* This initializes the plugin. |
||||
* |
||||
* This function is called by Sabre\DAV\Server, after |
||||
* addPlugin is called. |
||||
* |
||||
* This method should set up the required event subscriptions. |
||||
* |
||||
* @param Server $server |
||||
* @return void |
||||
*/ |
||||
function initialize(Server $server) { |
||||
$this->server = $server; |
||||
$server->resourceTypeMapping['OCA\\DAV\CardDAV\\ISharedAddressbook'] = '{' . \Sabre\CardDAV\Plugin::NS_CARDDAV . '}shared'; |
||||
|
||||
$this->server->on('method:POST', [$this, 'httpPost']); |
||||
} |
||||
|
||||
/** |
||||
* We intercept this to handle POST requests on calendars. |
||||
* |
||||
* @param RequestInterface $request |
||||
* @param ResponseInterface $response |
||||
* @return null|bool |
||||
*/ |
||||
function httpPost(RequestInterface $request, ResponseInterface $response) { |
||||
|
||||
$path = $request->getPath(); |
||||
|
||||
// Only handling xml |
||||
$contentType = $request->getHeader('Content-Type'); |
||||
if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) |
||||
return; |
||||
|
||||
// Making sure the node exists |
||||
try { |
||||
$node = $this->server->tree->getNodeForPath($path); |
||||
} catch (NotFound $e) { |
||||
return; |
||||
} |
||||
|
||||
$requestBody = $request->getBodyAsString(); |
||||
|
||||
// If this request handler could not deal with this POST request, it |
||||
// will return 'null' and other plugins get a chance to handle the |
||||
// request. |
||||
// |
||||
// However, we already requested the full body. This is a problem, |
||||
// because a body can only be read once. This is why we preemptively |
||||
// re-populated the request body with the existing data. |
||||
$request->setBody($requestBody); |
||||
|
||||
$dom = XMLUtil::loadDOMDocument($requestBody); |
||||
|
||||
$documentType = XMLUtil::toClarkNotation($dom->firstChild); |
||||
|
||||
switch ($documentType) { |
||||
|
||||
// Dealing with the 'share' document, which modified invitees on a |
||||
// calendar. |
||||
case '{' . \Sabre\CardDAV\Plugin::NS_CARDDAV . '}share' : |
||||
|
||||
// We can only deal with IShareableCalendar objects |
||||
if (!$node instanceof IShareableAddressBook) { |
||||
return; |
||||
} |
||||
|
||||
$this->server->transactionType = 'post-calendar-share'; |
||||
|
||||
// Getting ACL info |
||||
$acl = $this->server->getPlugin('acl'); |
||||
|
||||
// If there's no ACL support, we allow everything |
||||
if ($acl) { |
||||
$acl->checkPrivileges($path, '{DAV:}write'); |
||||
} |
||||
|
||||
$mutations = $this->parseShareRequest($dom); |
||||
|
||||
$node->updateShares($mutations[0], $mutations[1]); |
||||
|
||||
$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; |
||||
} |
||||
} |
||||
|
||||
/** |
||||
* Parses the 'share' POST request. |
||||
* |
||||
* This method returns an array, containing two arrays. |
||||
* The first array is a list of new sharees. Every element is a struct |
||||
* containing a: |
||||
* * href element. (usually a mailto: address) |
||||
* * commonName element (often a first and lastname, but can also be |
||||
* false) |
||||
* * readOnly (true or false) |
||||
* * summary (A description of the share, can also be false) |
||||
* |
||||
* The second array is a list of sharees that are to be removed. This is |
||||
* just a simple array with 'hrefs'. |
||||
* |
||||
* @param \DOMDocument $dom |
||||
* @return array |
||||
*/ |
||||
function parseShareRequest(\DOMDocument $dom) { |
||||
|
||||
$xpath = new \DOMXPath($dom); |
||||
$xpath->registerNamespace('cs', \Sabre\CardDAV\Plugin::NS_CARDDAV); |
||||
$xpath->registerNamespace('d', 'urn:DAV'); |
||||
|
||||
$set = []; |
||||
$elems = $xpath->query('cs:set'); |
||||
|
||||
for ($i = 0; $i < $elems->length; $i++) { |
||||
|
||||
$xset = $elems->item($i); |
||||
$set[] = [ |
||||
'href' => $xpath->evaluate('string(d:href)', $xset), |
||||
'commonName' => $xpath->evaluate('string(cs:common-name)', $xset), |
||||
'summary' => $xpath->evaluate('string(cs:summary)', $xset), |
||||
'readOnly' => $xpath->evaluate('boolean(cs:read)', $xset) !== false |
||||
]; |
||||
|
||||
} |
||||
|
||||
$remove = []; |
||||
$elems = $xpath->query('cs:remove'); |
||||
|
||||
for ($i = 0; $i < $elems->length; $i++) { |
||||
|
||||
$xremove = $elems->item($i); |
||||
$remove[] = $xpath->evaluate('string(d:href)', $xremove); |
||||
|
||||
} |
||||
|
||||
return [$set, $remove]; |
||||
|
||||
} |
||||
|
||||
|
||||
} |
||||
@ -0,0 +1,23 @@ |
||||
<?php |
||||
|
||||
namespace OCA\DAV\CardDAV; |
||||
|
||||
class UserAddressBooks extends \Sabre\CardDAV\UserAddressBooks { |
||||
|
||||
/** |
||||
* Returns a list of addressbooks |
||||
* |
||||
* @return array |
||||
*/ |
||||
function getChildren() { |
||||
|
||||
$addressbooks = $this->carddavBackend->getAddressBooksForUser($this->principalUri); |
||||
$objs = []; |
||||
foreach($addressbooks as $addressbook) { |
||||
$objs[] = new AddressBook($this->carddavBackend, $addressbook); |
||||
} |
||||
return $objs; |
||||
|
||||
} |
||||
|
||||
} |
||||
@ -0,0 +1,7 @@ |
||||
<?xml version="1.0" encoding="utf-8" ?> |
||||
<CS:share xmlns:D="DAV:" xmlns:CS="urn:ietf:params:xml:ns:carddav"> |
||||
<CS:set> |
||||
<D:href>principal:principals/admin</D:href> |
||||
<CS:read-write /> |
||||
</CS:set> |
||||
</CS:share> |
||||
Loading…
Reference in new issue