2016-07-06 10:19:46 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace OCA\DAV\CalDAV\Publishing;
|
|
|
|
|
|
|
|
use Sabre\DAV\PropFind;
|
|
|
|
use Sabre\DAV\INode;
|
|
|
|
use Sabre\DAV\Server;
|
|
|
|
use Sabre\DAV\ServerPlugin;
|
2016-07-12 14:19:21 +00:00
|
|
|
use Sabre\DAV\Exception\NotFound;
|
2016-07-06 10:19:46 +00:00
|
|
|
use Sabre\HTTP\RequestInterface;
|
|
|
|
use Sabre\HTTP\ResponseInterface;
|
2016-08-15 15:53:58 +00:00
|
|
|
use Sabre\CalDAV\Xml\Property\AllowedSharingModes;
|
2016-07-06 10:19:46 +00:00
|
|
|
use OCA\DAV\CalDAV\Publishing\Xml\Publisher;
|
2016-07-06 10:39:07 +00:00
|
|
|
use OCA\DAV\CalDAV\Calendar;
|
2016-07-07 08:16:56 +00:00
|
|
|
use OCP\IURLGenerator;
|
|
|
|
use OCP\IConfig;
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-08-01 13:10:33 +00:00
|
|
|
class PublishPlugin extends ServerPlugin {
|
2016-07-31 18:18:35 +00:00
|
|
|
const NS_CALENDARSERVER = 'http://calendarserver.org/ns/';
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
/**
|
2016-08-01 08:51:11 +00:00
|
|
|
* Reference to SabreDAV server object.
|
|
|
|
*
|
|
|
|
* @var \Sabre\DAV\Server
|
|
|
|
*/
|
|
|
|
protected $server;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Config instance to get instance secret.
|
|
|
|
*
|
|
|
|
* @var IConfig
|
|
|
|
*/
|
|
|
|
protected $config;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* URL Generator for absolute URLs.
|
|
|
|
*
|
|
|
|
* @var IURLGenerator
|
|
|
|
*/
|
|
|
|
protected $urlGenerator;
|
2016-07-07 08:16:56 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
/**
|
|
|
|
* PublishPlugin constructor.
|
|
|
|
*
|
|
|
|
* @param IConfig $config
|
|
|
|
* @param IURLGenerator $urlGenerator
|
|
|
|
*/
|
2016-08-01 13:10:33 +00:00
|
|
|
public function __construct(IConfig $config, IURLGenerator $urlGenerator) {
|
2016-08-01 08:51:11 +00:00
|
|
|
$this->config = $config;
|
|
|
|
$this->urlGenerator = $urlGenerator;
|
|
|
|
}
|
2016-07-07 08:16:56 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
/**
|
2016-08-01 08:51:11 +00:00
|
|
|
* 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 string[]
|
|
|
|
*/
|
2016-08-01 13:10:33 +00:00
|
|
|
public function getFeatures() {
|
2016-08-01 08:51:11 +00:00
|
|
|
// May have to be changed to be detected
|
2016-08-16 08:03:24 +00:00
|
|
|
return ['oc-calendar-publishing', 'calendarserver-sharing'];
|
2016-08-01 08:51:11 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns a plugin name.
|
|
|
|
*
|
|
|
|
* Using this name other plugins will be able to access other plugins
|
|
|
|
* using Sabre\DAV\Server::getPlugin
|
|
|
|
*
|
|
|
|
* @return string
|
|
|
|
*/
|
2016-08-01 13:10:33 +00:00
|
|
|
public function getPluginName() {
|
2016-08-01 08:51:11 +00:00
|
|
|
return 'oc-calendar-publishing';
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*/
|
2016-08-01 13:10:33 +00:00
|
|
|
public function initialize(Server $server) {
|
2016-08-01 08:51:11 +00:00
|
|
|
$this->server = $server;
|
|
|
|
|
|
|
|
$this->server->on('method:POST', [$this, 'httpPost']);
|
|
|
|
$this->server->on('propFind', [$this, 'propFind']);
|
|
|
|
}
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-08-01 13:10:33 +00:00
|
|
|
public function propFind(PropFind $propFind, INode $node) {
|
2016-08-01 08:51:11 +00:00
|
|
|
if ($node instanceof Calendar) {
|
2016-09-03 08:52:05 +00:00
|
|
|
$propFind->handle('{'.self::NS_CALENDARSERVER.'}publish-url', function () use ($node) {
|
2016-08-01 08:51:11 +00:00
|
|
|
if ($node->getPublishStatus()) {
|
2016-07-31 18:18:35 +00:00
|
|
|
// We return the publish-url only if the calendar is published.
|
2016-09-14 09:34:21 +00:00
|
|
|
$token = $node->getPublishToken();
|
2016-09-03 08:52:05 +00:00
|
|
|
$publishUrl = $this->urlGenerator->getAbsoluteURL($this->server->getBaseUri().'public-calendars/').$token;
|
|
|
|
|
2016-08-01 08:51:11 +00:00
|
|
|
return new Publisher($publishUrl, true);
|
|
|
|
}
|
|
|
|
});
|
2016-07-06 10:39:07 +00:00
|
|
|
|
2016-08-15 15:53:58 +00:00
|
|
|
$propFind->handle('{'.self::NS_CALENDARSERVER.'}allowed-sharing-modes', function() use ($node) {
|
|
|
|
return new AllowedSharingModes(!$node->isSubscription(), !$node->isSubscription());
|
2016-08-12 08:25:26 +00:00
|
|
|
});
|
2016-08-01 08:51:11 +00:00
|
|
|
}
|
|
|
|
}
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
/**
|
|
|
|
* We intercept this to handle POST requests on calendars.
|
|
|
|
*
|
|
|
|
* @param RequestInterface $request
|
|
|
|
* @param ResponseInterface $response
|
|
|
|
*
|
|
|
|
* @return null|bool
|
|
|
|
*/
|
2016-08-01 13:10:33 +00:00
|
|
|
public function httpPost(RequestInterface $request, ResponseInterface $response) {
|
2016-07-31 18:18:35 +00:00
|
|
|
$path = $request->getPath();
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// Only handling xml
|
|
|
|
$contentType = $request->getHeader('Content-Type');
|
|
|
|
if (strpos($contentType, 'application/xml') === false && strpos($contentType, 'text/xml') === false) {
|
|
|
|
return;
|
|
|
|
}
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// Making sure the node exists
|
|
|
|
try {
|
|
|
|
$node = $this->server->tree->getNodeForPath($path);
|
|
|
|
} catch (NotFound $e) {
|
|
|
|
return;
|
|
|
|
}
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
$requestBody = $request->getBodyAsString();
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// 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);
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
$this->server->xml->parse($requestBody, $request->getUrl(), $documentType);
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
switch ($documentType) {
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
case '{'.self::NS_CALENDARSERVER.'}publish-calendar' :
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// We can only deal with IShareableCalendar objects
|
|
|
|
if (!$node instanceof Calendar) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
$this->server->transactionType = 'post-publish-calendar';
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// Getting ACL info
|
|
|
|
$acl = $this->server->getPlugin('acl');
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// If there's no ACL support, we allow everything
|
|
|
|
if ($acl) {
|
|
|
|
$acl->checkPrivileges($path, '{DAV:}write');
|
|
|
|
}
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
$node->setPublishStatus(true);
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// iCloud sends back the 202, so we will too.
|
|
|
|
$response->setStatus(202);
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// 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');
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// Breaking the event chain
|
|
|
|
return false;
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
case '{'.self::NS_CALENDARSERVER.'}unpublish-calendar' :
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// We can only deal with IShareableCalendar objects
|
|
|
|
if (!$node instanceof Calendar) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
$this->server->transactionType = 'post-unpublish-calendar';
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// Getting ACL info
|
|
|
|
$acl = $this->server->getPlugin('acl');
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// If there's no ACL support, we allow everything
|
|
|
|
if ($acl) {
|
|
|
|
$acl->checkPrivileges($path, '{DAV:}write');
|
|
|
|
}
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
$node->setPublishStatus(false);
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
$response->setStatus(200);
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// 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');
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
// Breaking the event chain
|
|
|
|
return false;
|
2016-07-06 10:19:46 +00:00
|
|
|
|
2016-07-31 18:18:35 +00:00
|
|
|
}
|
|
|
|
}
|
2016-07-06 10:19:46 +00:00
|
|
|
}
|