add CalDAV interface that allows users to re-enable their birthday calendar

Signed-off-by: Georg Ehrke <developer@georgehrke.com>

apps/dav/lib/CalDAV/BirthdayCalendar/EnablePlugin.php

@@ -0,0 +1,130 @@
+<?php
+/**
+ * @copyright 2017, Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\DAV\CalDAV\BirthdayCalendar;
+
+use OCA\DAV\CalDAV\CalendarHome;
+use Sabre\DAV\Server;
+use Sabre\DAV\ServerPlugin;
+use Sabre\HTTP\RequestInterface;
+use Sabre\HTTP\ResponseInterface;
+use OCP\IConfig;
+
+/**
+ * Class EnablePlugin
+ * allows users to re-enable the birthday calendar via CalDAV
+ *
+ * @package OCA\DAV\CalDAV\BirthdayCalendar
+ */
+class EnablePlugin extends ServerPlugin {
+	const NS_Nextcloud = 'http://nextcloud.com/ns';
+
+	/**
+	 * @var IConfig
+	 */
+	protected $config;
+
+	/**
+	 * @var Server
+	 */
+	protected $server;
+
+	/**
+	 * PublishPlugin constructor.
+	 *
+	 * @param IConfig $config
+	 */
+	public function __construct(IConfig $config) {
+		$this->config = $config;
+	}
+
+	/**
+	 * 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[]
+	 */
+	public function getFeatures() {
+		return ['nc-enable-birthday-calendar'];
+	}
+
+	/**
+	 * Returns a plugin name.
+	 *
+	 * Using this name other plugins will be able to access other plugins
+	 * using Sabre\DAV\Server::getPlugin
+	 *
+	 * @return string
+	 */
+	public function getPluginName()	{
+		return 'nc-enable-birthday-calendar';
+	}
+
+	/**
+	 * 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
+	 */
+	public function initialize(Server $server) {
+		$this->server = $server;
+
+		$this->server->on('method:POST', [$this, 'httpPost']);
+	}
+
+	/**
+	 * We intercept this to handle POST requests on calendar homes.
+	 *
+	 * @param RequestInterface $request
+	 * @param ResponseInterface $response
+	 *
+	 * @return bool|void
+	 */
+	public function httpPost(RequestInterface $request, ResponseInterface $response) {
+		$node = $this->server->tree->getNodeForPath($this->server->getRequestUri());
+		if (!($node instanceof CalendarHome)) {
+			return;
+		}
+
+		$requestBody = $request->getBodyAsString();
+		$this->server->xml->parse($requestBody, $request->getUrl(), $documentType);
+		if ($documentType !== '{'.self::NS_Nextcloud.'}enable-birthday-calendar') {
+			return;
+		}
+
+		$principalUri = $node->getOwner();
+		$userId = substr($principalUri, 17);
+
+		$this->config->setUserValue($userId, 'dav', 'generateBirthdayCalendar', 'yes');
+
+		$this->server->httpResponse->setStatus(204);
+
+		return false;
+	}
+}

apps/dav/lib/Server.php

@@ -259,6 +259,9 @@ class Server {
 						$view
 					)));
 				}
+				$this->server->addPlugin(new \OCA\DAV\CalDAV\BirthdayCalendar\EnablePlugin(
+					\OC::$server->getConfig()
+				));
 			}
 
 			// register plugins from apps

apps/dav/tests/unit/CalDAV/BirthdayCalendar/EnablePluginTest.php

@@ -0,0 +1,171 @@
+<?php
+/**
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @copyright Copyright (c) 2017 Georg Ehrke <oc.list@georgehrke.com>
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+
+namespace OCA\DAV\Tests\unit\CalDAV\BirthdayCalendar;
+
+use OCA\DAV\CalDAV\BirthdayCalendar\EnablePlugin;
+use OCA\DAV\CalDAV\Calendar;
+use OCA\DAV\CalDAV\CalendarHome;
+use OCP\IConfig;
+use Test\TestCase;
+
+class EnablePluginTest extends TestCase {
+
+	/** @var \Sabre\DAV\Server|\PHPUnit_Framework_MockObject_MockObject */
+	protected $server;
+
+	/** @var \OCP\IConfig|\PHPUnit_Framework_MockObject_MockObject */
+	protected $config;
+
+	/** @var \OCA\DAV\CalDAV\BirthdayCalendar\EnablePlugin $plugin */
+	protected $plugin;
+
+	protected $request;
+
+	protected $response;
+
+	public function setUp() {
+		parent::setUp();
+
+		$this->server = $this->createMock(\Sabre\DAV\Server::class);
+		$this->server->tree = $this->createMock(\Sabre\DAV\Tree::class);
+		$this->server->httpResponse = $this->createMock(\Sabre\HTTP\Response::class);
+		$this->server->xml = $this->createMock(\Sabre\DAV\Xml\Service::class);
+
+		$this->config = $this->createMock(IConfig::class);
+
+		$this->plugin = new EnablePlugin($this->config);
+		$this->plugin->initialize($this->server);
+
+		$this->request = $this->createMock(\Sabre\HTTP\RequestInterface::class);
+		$this->response = $this->createMock(\Sabre\HTTP\ResponseInterface::class);
+	}
+
+	public function testGetFeatures() {
+		$this->assertEquals(['nc-enable-birthday-calendar'], $this->plugin->getFeatures());
+	}
+
+	public function testGetName() {
+		$this->assertEquals('nc-enable-birthday-calendar', $this->plugin->getPluginName());
+	}
+
+	public function testInitialize() {
+		$server = $this->createMock(\Sabre\DAV\Server::class);
+
+		$plugin = new EnablePlugin($this->config);
+
+		$server->expects($this->at(0))
+			->method('on')
+			->with('method:POST', [$plugin, 'httpPost']);
+
+		$plugin->initialize($server);
+	}
+
+	public function testHttpPostNoCalendarHome() {
+		$calendar = $this->createMock(Calendar::class);
+
+		$this->server->expects($this->once())
+			->method('getRequestUri')
+			->will($this->returnValue('/bar/foo'));
+		$this->server->tree->expects($this->once())
+			->method('getNodeForPath')
+			->with('/bar/foo')
+			->will($this->returnValue($calendar));
+
+		$this->config->expects($this->never())
+			->method('setUserValue');
+
+		$this->plugin->httpPost($this->request, $this->response);
+	}
+
+	public function testHttpPostWrongRequest() {
+		$calendarHome = $this->createMock(CalendarHome::class);
+
+		$this->server->expects($this->once())
+			->method('getRequestUri')
+			->will($this->returnValue('/bar/foo'));
+		$this->server->tree->expects($this->once())
+			->method('getNodeForPath')
+			->with('/bar/foo')
+			->will($this->returnValue($calendarHome));
+
+		$this->request->expects($this->at(0))
+			->method('getBodyAsString')
+			->will($this->returnValue('<nc:disable-birthday-calendar xmlns:nc="http://nextcloud.com/ns"/>'));
+
+		$this->request->expects($this->at(1))
+			->method('getUrl')
+			->will($this->returnValue('url_abc'));
+
+		$this->server->xml->expects($this->once())
+			->method('parse')
+			->will($this->returnCallback(function($requestBody, $url, &$documentType) {
+				$documentType =  '{http://nextcloud.com/ns}disable-birthday-calendar';
+			}));
+
+		$this->config->expects($this->never())
+			->method('setUserValue');
+
+		$this->plugin->httpPost($this->request, $this->response);
+	}
+
+	public function testHttpPost() {
+		$calendarHome = $this->createMock(CalendarHome::class);
+
+		$this->server->expects($this->once())
+			->method('getRequestUri')
+			->will($this->returnValue('/bar/foo'));
+		$this->server->tree->expects($this->once())
+			->method('getNodeForPath')
+			->with('/bar/foo')
+			->will($this->returnValue($calendarHome));
+
+		$calendarHome->expects($this->once())
+			->method('getOwner')
+			->will($this->returnValue('principals/users/BlaBlub'));
+
+		$this->request->expects($this->at(0))
+			->method('getBodyAsString')
+			->will($this->returnValue('<nc:enable-birthday-calendar xmlns:nc="http://nextcloud.com/ns"/>'));
+
+		$this->request->expects($this->at(1))
+			->method('getUrl')
+			->will($this->returnValue('url_abc'));
+
+		$this->server->xml->expects($this->once())
+			->method('parse')
+			->will($this->returnCallback(function($requestBody, $url, &$documentType) {
+				$documentType = '{http://nextcloud.com/ns}enable-birthday-calendar';
+			}));
+
+		$this->config->expects($this->once())
+			->method('setUserValue')
+			->with('BlaBlub', 'dav', 'generateBirthdayCalendar', 'yes');
+
+		$this->server->httpResponse->expects($this->once())
+			->method('setStatus')
+			->with(204);
+
+		$result = $this->plugin->httpPost($this->request, $this->response);
+
+		$this->assertEquals(false, $result);
+	}
+}