cache webcal calendars on server

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

5 files changed, 545 insertions, 0 deletions

diff --git a/apps/dav/tests/unit/CalDAV/AbstractCalDavBackend.php b/apps/dav/tests/unit/CalDAV/AbstractCalDavBackend.php
index d49e3bdc778..63d48910f8b 100644
--- a/apps/dav/tests/unit/CalDAV/AbstractCalDavBackend.php
+++ b/apps/dav/tests/unit/CalDAV/AbstractCalDavBackend.php
@@ -35,6 +35,7 @@ use OCP\IUserSession;
 use OCP\Security\ISecureRandom;
 use OCP\Share\IManager as ShareManager;
 use Sabre\CalDAV\Xml\Property\SupportedCalendarComponentSet;
+use Sabre\DAV\Xml\Property\Href;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Test\TestCase;
 
@@ -151,6 +152,20 @@ abstract class AbstractCalDavBackend extends TestCase {
 		return $calendarId;
 	}
 
+	protected function createTestSubscription() {
+		$this->backend->createSubscription(self::UNIT_TEST_USER, 'Example', [
+			'{http://apple.com/ns/ical/}calendar-color' => '#1C4587FF',
+			'{http://calendarserver.org/ns/}source' => new Href(['foo']),
+		]);
+		$calendars = $this->backend->getSubscriptionsForUser(self::UNIT_TEST_USER);
+		$this->assertEquals(1, count($calendars));
+		$this->assertEquals(self::UNIT_TEST_USER, $calendars[0]['principaluri']);
+		$this->assertEquals('Example', $calendars[0]['uri']);
+		$calendarId = $calendars[0]['id'];
+
+		return $calendarId;
+	}
+
 	protected function createEvent($calendarId, $start = '20130912T130000Z', $end = '20130912T140000Z') {
 
 		$randomPart = self::getUniqueID();
diff --git a/apps/dav/tests/unit/CalDAV/CachedSubscriptionObjectTest.php b/apps/dav/tests/unit/CalDAV/CachedSubscriptionObjectTest.php
new file mode 100644
index 00000000000..131c3011e46
--- /dev/null
+++ b/apps/dav/tests/unit/CalDAV/CachedSubscriptionObjectTest.php
@@ -0,0 +1,95 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Georg Ehrke
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license AGPL-3.0
+ *
+ * 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;
+
+use OCA\DAV\CalDAV\CachedSubscriptionObject;
+use OCA\DAV\CalDAV\CalDavBackend;
+use OCA\DAV\CalDAV\Calendar;
+use OCA\DAV\CalDAV\CalendarImpl;
+
+class CachedSubscriptionObjectTest extends \Test\TestCase {
+
+	public function testGet() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+		$objectData = [
+			'uri' => 'foo123'
+		];
+
+		$backend->expects($this->once())
+			->method('getCalendarObject')
+			->with(666, 'foo123', 1)
+			->will($this->returnValue([
+				'calendardata' => 'BEGIN...',
+			]));
+
+		$calendarObject = new CachedSubscriptionObject($backend, $calendarInfo, $objectData);
+		$this->assertEquals('BEGIN...', $calendarObject->get());
+	}
+
+	/**
+	 * @expectedException \Sabre\DAV\Exception\MethodNotAllowed
+	 * @expectedExceptionMessage Creating objects in a cached subscription is not allowed
+	 */
+	public function testPut() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+		$objectData = [
+			'uri' => 'foo123'
+		];
+
+		$calendarObject = new CachedSubscriptionObject($backend, $calendarInfo, $objectData);
+		$calendarObject->put('');
+	}
+
+	/**
+	 * @expectedException \Sabre\DAV\Exception\MethodNotAllowed
+	 * @expectedExceptionMessage Deleting objects in a cached subscription is not allowed
+	 */
+	public function testDelete() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+		$objectData = [
+			'uri' => 'foo123'
+		];
+
+		$calendarObject = new CachedSubscriptionObject($backend, $calendarInfo, $objectData);
+		$calendarObject->delete();
+	}
+
+}
\ No newline at end of file
diff --git a/apps/dav/tests/unit/CalDAV/CachedSubscriptionTest.php b/apps/dav/tests/unit/CalDAV/CachedSubscriptionTest.php
new file mode 100644
index 00000000000..82f9af364da
--- /dev/null
+++ b/apps/dav/tests/unit/CalDAV/CachedSubscriptionTest.php
@@ -0,0 +1,300 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Georg Ehrke
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license AGPL-3.0
+ *
+ * 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;
+
+use OCA\DAV\CalDAV\CachedSubscription;
+use OCA\DAV\CalDAV\CachedSubscriptionObject;
+use OCA\DAV\CalDAV\CalDavBackend;
+use Sabre\DAV\PropPatch;
+
+class CachedSubscriptionTest extends \Test\TestCase {
+
+	public function testGetACL() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+		$this->assertEquals([
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => 'user1',
+				'protected' => true,
+			],
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => 'user1/calendar-proxy-write',
+				'protected' => true,
+			],
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => 'user1/calendar-proxy-read',
+				'protected' => true,
+			],
+			[
+				'privilege' => '{urn:ietf:params:xml:ns:caldav}read-free-busy',
+				'principal' => '{DAV:}authenticated',
+				'protected' => true,
+			],
+		], $calendar->getACL());
+	}
+
+	public function testGetChildACL() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+		$this->assertEquals([
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => 'user1',
+				'protected' => true,
+			],
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => 'user1/calendar-proxy-write',
+				'protected' => true,
+			],
+			[
+				'privilege' => '{DAV:}read',
+				'principal' => 'user1/calendar-proxy-read',
+				'protected' => true,
+			]
+		], $calendar->getChildACL());
+	}
+
+	public function testGetOwner() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+		$this->assertEquals('user1', $calendar->getOwner());
+	}
+
+	public function testDelete() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$backend->expects($this->once())
+			->method('deleteSubscription')
+			->with(666);
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+		$calendar->delete();
+	}
+
+	public function testPropPatch() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+		$propPatch = $this->createMock(PropPatch::class);
+
+		$backend->expects($this->once())
+			->method('updateSubscription')
+			->with(666, $propPatch);
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+		$calendar->propPatch($propPatch);
+	}
+
+	/**
+	 * @expectedException \Sabre\DAV\Exception\NotFound
+	 * @expectedExceptionMessage Calendar object not found
+	 */
+	public function testGetChild() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$backend->expects($this->at(0))
+			->method('getCalendarObject')
+			->with(666, 'foo1', 1)
+			->will($this->returnValue([
+				'id' => 99,
+				'uri' => 'foo1'
+			]));
+		$backend->expects($this->at(1))
+			->method('getCalendarObject')
+			->with(666, 'foo2', 1)
+			->will($this->returnValue(null));
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+
+		$first = $calendar->getChild('foo1');
+		$this->assertInstanceOf(CachedSubscriptionObject::class, $first);
+
+		$calendar->getChild('foo2');
+	}
+
+	public function testGetChildren() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$backend->expects($this->at(0))
+			->method('getCalendarObjects')
+			->with(666, 1)
+			->will($this->returnValue([
+				[
+					'id' => 99,
+					'uri' => 'foo1'
+				],
+				[
+					'id' => 100,
+					'uri' => 'foo2'
+				],
+			]));
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+
+		$res = $calendar->getChildren();
+		$this->assertCount(2, $res);
+		$this->assertInstanceOf(CachedSubscriptionObject::class, $res[0]);
+		$this->assertInstanceOf(CachedSubscriptionObject::class, $res[1]);
+	}
+
+	public function testGetMultipleChildren() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$backend->expects($this->at(0))
+			->method('getMultipleCalendarObjects')
+			->with(666, ['foo1', 'foo2'], 1)
+			->will($this->returnValue([
+				[
+					'id' => 99,
+					'uri' => 'foo1'
+				],
+				[
+					'id' => 100,
+					'uri' => 'foo2'
+				],
+			]));
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+
+		$res = $calendar->getMultipleChildren(['foo1', 'foo2']);
+		$this->assertCount(2, $res);
+		$this->assertInstanceOf(CachedSubscriptionObject::class, $res[0]);
+		$this->assertInstanceOf(CachedSubscriptionObject::class, $res[1]);
+	}
+
+	/**
+	 * @expectedException \Sabre\DAV\Exception\MethodNotAllowed
+	 * @expectedExceptionMessage Creating objects in cached subscription is not allowed
+	 */
+	public function testCreateFile() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+		$calendar->createFile('foo', []);
+	}
+
+	public function testChildExists() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$backend->expects($this->at(0))
+			->method('getCalendarObject')
+			->with(666, 'foo1', 1)
+			->will($this->returnValue([
+				'id' => 99,
+				'uri' => 'foo1'
+			]));
+		$backend->expects($this->at(1))
+			->method('getCalendarObject')
+			->with(666, 'foo2', 1)
+			->will($this->returnValue(null));
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+
+		$this->assertEquals(true, $calendar->childExists('foo1'));
+		$this->assertEquals(false, $calendar->childExists('foo2'));
+	}
+
+	public function testCalendarQuery() {
+		$backend = $this->createMock(CalDavBackend::class);
+		$calendarInfo = [
+			'{http://owncloud.org/ns}owner-principal' => 'user1',
+			'principaluri' => 'user2',
+			'id' => 666,
+			'uri' => 'cal',
+		];
+
+		$backend->expects($this->once())
+			->method('calendarQuery')
+			->with(666, ['foo'], 1)
+			->will($this->returnValue([99]));
+
+		$calendar = new CachedSubscription($backend, $calendarInfo);
+
+		$this->assertEquals([99], $calendar->calendarQuery(['foo']));
+	}
+}
diff --git a/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php b/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php
index 26439df4a01..44609f2ca6c 100644
--- a/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php
+++ b/apps/dav/tests/unit/CalDAV/CalDavBackendTest.php
@@ -911,4 +911,76 @@ EOD;
 			[true, 2],
 		];
 	}
+
+	public function testSameUriSameIdForDifferentCalendarTypes() {
+		$calendarId = $this->createTestCalendar();
+		$subscriptionId = $this->createTestSubscription();
+
+		$uri = static::getUniqueID('calobj');
+		$calData = <<<EOD
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:ownCloud Calendar
+BEGIN:VEVENT
+CREATED;VALUE=DATE-TIME:20130910T125139Z
+UID:47d15e3ec8
+LAST-MODIFIED;VALUE=DATE-TIME:20130910T125139Z
+DTSTAMP;VALUE=DATE-TIME:20130910T125139Z
+SUMMARY:Test Event
+DTSTART;VALUE=DATE-TIME:20130912T130000Z
+DTEND;VALUE=DATE-TIME:20130912T140000Z
+CLASS:PUBLIC
+END:VEVENT
+END:VCALENDAR
+EOD;
+
+		$calData2 = <<<EOD
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:ownCloud Calendar
+BEGIN:VEVENT
+CREATED;VALUE=DATE-TIME:20130910T125139Z
+UID:47d15e3ec8
+LAST-MODIFIED;VALUE=DATE-TIME:20130910T125139Z
+DTSTAMP;VALUE=DATE-TIME:20130910T125139Z
+SUMMARY:Test Event 123
+DTSTART;VALUE=DATE-TIME:20130912T130000Z
+DTEND;VALUE=DATE-TIME:20130912T140000Z
+CLASS:PUBLIC
+END:VEVENT
+END:VCALENDAR
+EOD;
+
+		$this->backend->createCalendarObject($calendarId, $uri, $calData);
+		$this->backend->createCalendarObject($subscriptionId, $uri, $calData2, CalDavBackend::CALENDAR_TYPE_SUBSCRIPTION);
+
+		$this->assertEquals($calData, $this->backend->getCalendarObject($calendarId, $uri, CalDavBackend::CALENDAR_TYPE_CALENDAR)['calendardata']);
+		$this->assertEquals($calData2, $this->backend->getCalendarObject($subscriptionId, $uri, CalDavBackend::CALENDAR_TYPE_SUBSCRIPTION)['calendardata']);
+	}
+
+	public function testPurgeAllCachedEventsForSubscription() {
+		$subscriptionId = $this->createTestSubscription();
+		$uri = static::getUniqueID('calobj');
+		$calData = <<<EOD
+BEGIN:VCALENDAR
+VERSION:2.0
+PRODID:ownCloud Calendar
+BEGIN:VEVENT
+CREATED;VALUE=DATE-TIME:20130910T125139Z
+UID:47d15e3ec8
+LAST-MODIFIED;VALUE=DATE-TIME:20130910T125139Z
+DTSTAMP;VALUE=DATE-TIME:20130910T125139Z
+SUMMARY:Test Event
+DTSTART;VALUE=DATE-TIME:20130912T130000Z
+DTEND;VALUE=DATE-TIME:20130912T140000Z
+CLASS:PUBLIC
+END:VEVENT
+END:VCALENDAR
+EOD;
+
+		$this->backend->createCalendarObject($subscriptionId, $uri, $calData, CalDavBackend::CALENDAR_TYPE_SUBSCRIPTION);
+		$this->backend->purgeAllCachedEventsForSubscription($subscriptionId);
+
+		$this->assertEquals(null, $this->backend->getCalendarObject($subscriptionId, $uri, CalDavBackend::CALENDAR_TYPE_SUBSCRIPTION));
+	}
 }
diff --git a/apps/dav/tests/unit/CalDAV/WebcalCaching/PluginTest.php b/apps/dav/tests/unit/CalDAV/WebcalCaching/PluginTest.php
new file mode 100644
index 00000000000..87f11a5c29d
--- /dev/null
+++ b/apps/dav/tests/unit/CalDAV/WebcalCaching/PluginTest.php
@@ -0,0 +1,63 @@
+<?php
+/**
+ * @copyright Copyright (c) 2018 Georg Ehrke
+ *
+ * @author Georg Ehrke <oc.list@georgehrke.com>
+ *
+ * @license AGPL-3.0
+ *
+ * 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\WebcalCaching;
+
+use OCA\DAV\CalDAV\WebcalCaching\Plugin;
+use OCP\IRequest;
+
+class PluginTest extends \Test\TestCase {
+
+	public function testDisabled() {
+		$request = $this->createMock(IRequest::class);
+		$request->expects($this->at(0))
+			->method('isUserAgent')
+			->with([])
+			->will($this->returnValue(false));
+
+		$request->expects($this->at(1))
+			->method('getHeader')
+			->with('X-NC-CalDAV-Webcal-Caching')
+			->will($this->returnValue(''));
+
+		$plugin = new Plugin($request);
+
+		$this->assertEquals(false, $plugin->isCachingEnabledForThisRequest());
+	}
+
+	public function testEnabled() {
+		$request = $this->createMock(IRequest::class);
+		$request->expects($this->at(0))
+			->method('isUserAgent')
+			->with([])
+			->will($this->returnValue(false));
+
+		$request->expects($this->at(1))
+			->method('getHeader')
+			->with('X-NC-CalDAV-Webcal-Caching')
+			->will($this->returnValue('On'));
+
+		$plugin = new Plugin($request);
+
+		$this->assertEquals(true, $plugin->isCachingEnabledForThisRequest());
+	}
+}