Browse Source
feat(caldav): expose calendar subscriptions
feat(caldav): expose calendar subscriptions
Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>pull/44752/head
Daniel Kesselberg
2 years ago
No known key found for this signature in database
GPG Key ID: 36E3664E099D0614
18 changed files with 585 additions and 29 deletions
-
2apps/dav/composer/composer/autoload_classmap.php
-
2apps/dav/composer/composer/autoload_static.php
-
2apps/dav/lib/AppInfo/Application.php
-
2apps/dav/lib/CalDAV/AppCalendar/AppCalendarPlugin.php
-
6apps/dav/lib/CalDAV/CachedSubscription.php
-
117apps/dav/lib/CalDAV/CachedSubscriptionImpl.php
-
57apps/dav/lib/CalDAV/CachedSubscriptionProvider.php
-
8apps/dav/lib/CalDAV/CalDavBackend.php
-
14apps/dav/lib/CalDAV/CalendarHome.php
-
13apps/dav/lib/CalDAV/CalendarRoot.php
-
20apps/dav/lib/CalDAV/WebcalCaching/Plugin.php
-
2apps/dav/lib/Connector/Sabre/DavAclPlugin.php
-
96apps/dav/tests/unit/CalDAV/CachedSubscriptionImplTest.php
-
88apps/dav/tests/unit/CalDAV/CachedSubscriptionProviderTest.php
-
5apps/dav/tests/unit/CalDAV/CachedSubscriptionTest.php
-
126apps/dav/tests/unit/CalDAV/CalendarHomeTest.php
-
3apps/dav/tests/unit/CalDAV/CalendarImplTest.php
-
51apps/dav/tests/unit/CalDAV/WebcalCaching/PluginTest.php
@ -0,0 +1,117 @@ |
|||
<?php |
|||
|
|||
declare(strict_types=1); |
|||
|
|||
/** |
|||
* @copyright 2024 Daniel Kesselberg <mail@danielkesselberg.de> |
|||
* |
|||
* @author Daniel Kesselberg <mail@danielkesselberg.de> |
|||
* |
|||
* @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; |
|||
|
|||
use OCP\Calendar\ICalendar; |
|||
use OCP\Constants; |
|||
|
|||
class CachedSubscriptionImpl implements ICalendar { |
|||
private CalDavBackend $backend; |
|||
private CachedSubscription $calendar; |
|||
/** @var array<string, mixed> */ |
|||
private array $calendarInfo; |
|||
|
|||
public function __construct( |
|||
CachedSubscription $calendar, |
|||
array $calendarInfo, |
|||
CalDavBackend $backend |
|||
) { |
|||
$this->calendar = $calendar; |
|||
$this->calendarInfo = $calendarInfo; |
|||
$this->backend = $backend; |
|||
} |
|||
|
|||
/** |
|||
* @return string defining the technical unique key |
|||
* @since 13.0.0 |
|||
*/ |
|||
public function getKey(): string { |
|||
return (string) $this->calendarInfo['id']; |
|||
} |
|||
|
|||
/** |
|||
* {@inheritDoc} |
|||
*/ |
|||
public function getUri(): string { |
|||
return $this->calendarInfo['uri']; |
|||
} |
|||
|
|||
/** |
|||
* In comparison to getKey() this function returns a human readable (maybe translated) name |
|||
* @since 13.0.0 |
|||
*/ |
|||
public function getDisplayName(): ?string { |
|||
return $this->calendarInfo['{DAV:}displayname']; |
|||
} |
|||
|
|||
/** |
|||
* Calendar color |
|||
* @since 13.0.0 |
|||
*/ |
|||
public function getDisplayColor(): ?string { |
|||
return $this->calendarInfo['{http://apple.com/ns/ical/}calendar-color']; |
|||
} |
|||
|
|||
/** |
|||
* @param string $pattern which should match within the $searchProperties |
|||
* @param array $searchProperties defines the properties within the query pattern should match |
|||
* @param array $options - optional parameters: |
|||
* ['timerange' => ['start' => new DateTime(...), 'end' => new DateTime(...)]] |
|||
* @param int|null $limit - limit number of search results |
|||
* @param int|null $offset - offset for paging of search results |
|||
* @return array an array of events/journals/todos which are arrays of key-value-pairs |
|||
* @since 13.0.0 |
|||
*/ |
|||
public function search(string $pattern, array $searchProperties = [], array $options = [], $limit = null, $offset = null): array { |
|||
return $this->backend->search($this->calendarInfo, $pattern, $searchProperties, $options, $limit, $offset); |
|||
} |
|||
|
|||
/** |
|||
* @return int build up using \OCP\Constants |
|||
* @since 13.0.0 |
|||
*/ |
|||
public function getPermissions(): int { |
|||
$permissions = $this->calendar->getACL(); |
|||
$result = 0; |
|||
foreach ($permissions as $permission) { |
|||
switch ($permission['privilege']) { |
|||
case '{DAV:}read': |
|||
$result |= Constants::PERMISSION_READ; |
|||
break; |
|||
} |
|||
} |
|||
|
|||
return $result; |
|||
} |
|||
|
|||
public function isDeleted(): bool { |
|||
return false; |
|||
} |
|||
|
|||
public function getSource(): string { |
|||
return $this->calendarInfo['source']; |
|||
} |
|||
} |
|||
@ -0,0 +1,57 @@ |
|||
<?php |
|||
|
|||
declare(strict_types=1); |
|||
|
|||
/** |
|||
* @copyright 2024 Daniel Kesselberg <mail@danielkesselberg.de> |
|||
* |
|||
* @author Daniel Kesselberg <mail@danielkesselberg.de> |
|||
* |
|||
* @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; |
|||
|
|||
use OCP\Calendar\ICalendarProvider; |
|||
|
|||
class CachedSubscriptionProvider implements ICalendarProvider { |
|||
|
|||
public function __construct( |
|||
private CalDavBackend $calDavBackend |
|||
) { |
|||
} |
|||
|
|||
public function getCalendars(string $principalUri, array $calendarUris = []): array { |
|||
$calendarInfos = $this->calDavBackend->getSubscriptionsForUser($principalUri); |
|||
|
|||
if (count($calendarUris) > 0) { |
|||
$calendarInfos = array_filter($calendarInfos, fn (array $subscription) => in_array($subscription['uri'], $calendarUris)); |
|||
} |
|||
|
|||
$calendarInfos = array_values(array_filter($calendarInfos)); |
|||
|
|||
$iCalendars = []; |
|||
foreach ($calendarInfos as $calendarInfo) { |
|||
$calendar = new CachedSubscription($this->calDavBackend, $calendarInfo); |
|||
$iCalendars[] = new CachedSubscriptionImpl( |
|||
$calendar, |
|||
$calendarInfo, |
|||
$this->calDavBackend, |
|||
); |
|||
} |
|||
return $iCalendars; |
|||
} |
|||
} |
|||
@ -0,0 +1,96 @@ |
|||
<?php |
|||
|
|||
declare(strict_types=1); |
|||
|
|||
/** |
|||
* @copyright 2024 Daniel Kesselberg <mail@danielkesselberg.de> |
|||
* |
|||
* @author Daniel Kesselberg <mail@danielkesselberg.de> |
|||
* |
|||
* @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\Tests\unit\CalDAV; |
|||
|
|||
use OCA\DAV\CalDAV\CachedSubscription; |
|||
use OCA\DAV\CalDAV\CachedSubscriptionImpl; |
|||
use OCA\DAV\CalDAV\CalDavBackend; |
|||
use Test\TestCase; |
|||
|
|||
class CachedSubscriptionImplTest extends TestCase { |
|||
private CachedSubscription $cachedSubscription; |
|||
private array $cachedSubscriptionInfo; |
|||
private CachedSubscriptionImpl $cachedSubscriptionImpl; |
|||
private CalDavBackend $backend; |
|||
|
|||
protected function setUp(): void { |
|||
parent::setUp(); |
|||
|
|||
$this->cachedSubscription = $this->createMock(CachedSubscription::class); |
|||
$this->cachedSubscriptionInfo = [ |
|||
'id' => 'fancy_id_123', |
|||
'{DAV:}displayname' => 'user readable name 123', |
|||
'{http://apple.com/ns/ical/}calendar-color' => '#AABBCC', |
|||
'uri' => '/this/is/a/uri', |
|||
'source' => 'https://test.localhost/calendar1', |
|||
]; |
|||
$this->backend = $this->createMock(CalDavBackend::class); |
|||
|
|||
$this->cachedSubscriptionImpl = new CachedSubscriptionImpl( |
|||
$this->cachedSubscription, |
|||
$this->cachedSubscriptionInfo, |
|||
$this->backend |
|||
); |
|||
} |
|||
|
|||
public function testGetKey(): void { |
|||
$this->assertEquals($this->cachedSubscriptionImpl->getKey(), 'fancy_id_123'); |
|||
} |
|||
|
|||
public function testGetDisplayname(): void { |
|||
$this->assertEquals($this->cachedSubscriptionImpl->getDisplayName(), 'user readable name 123'); |
|||
} |
|||
|
|||
public function testGetDisplayColor(): void { |
|||
$this->assertEquals($this->cachedSubscriptionImpl->getDisplayColor(), '#AABBCC'); |
|||
} |
|||
|
|||
public function testGetSource(): void { |
|||
$this->assertEquals($this->cachedSubscriptionImpl->getSource(), 'https://test.localhost/calendar1'); |
|||
} |
|||
|
|||
public function testSearch(): void { |
|||
$this->backend->expects($this->once()) |
|||
->method('search') |
|||
->with($this->cachedSubscriptionInfo, 'abc', ['def'], ['ghi'], 42, 1337) |
|||
->willReturn(['SEARCHRESULTS']); |
|||
|
|||
$result = $this->cachedSubscriptionImpl->search('abc', ['def'], ['ghi'], 42, 1337); |
|||
$this->assertEquals($result, ['SEARCHRESULTS']); |
|||
} |
|||
|
|||
public function testGetPermissionRead(): void { |
|||
$this->cachedSubscription->expects($this->once()) |
|||
->method('getACL') |
|||
->with() |
|||
->willReturn([ |
|||
['privilege' => '{DAV:}read'] |
|||
]); |
|||
|
|||
$this->assertEquals(1, $this->cachedSubscriptionImpl->getPermissions()); |
|||
} |
|||
} |
|||
@ -0,0 +1,88 @@ |
|||
<?php |
|||
|
|||
declare(strict_types=1); |
|||
|
|||
/** |
|||
* @copyright 2024 Daniel Kesselberg <mail@danielkesselberg.de> |
|||
* |
|||
* @author Daniel Kesselberg <mail@danielkesselberg.de> |
|||
* |
|||
* @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\Tests\unit\CalDAV; |
|||
|
|||
use OCA\DAV\CalDAV\CachedSubscriptionImpl; |
|||
use OCA\DAV\CalDAV\CachedSubscriptionProvider; |
|||
use OCA\DAV\CalDAV\CalDavBackend; |
|||
use Test\TestCase; |
|||
|
|||
class CachedSubscriptionProviderTest extends TestCase { |
|||
|
|||
private CalDavBackend $backend; |
|||
private CachedSubscriptionProvider $provider; |
|||
|
|||
protected function setUp(): void { |
|||
parent::setUp(); |
|||
|
|||
$this->backend = $this->createMock(CalDavBackend::class); |
|||
$this->backend |
|||
->expects(self::once()) |
|||
->method('getSubscriptionsForUser') |
|||
->with('user-principal-123') |
|||
->willReturn([ |
|||
[ |
|||
'id' => 'subscription-1', |
|||
'uri' => 'subscription-1', |
|||
'principaluris' => 'user-principal-123', |
|||
'source' => 'https://localhost/subscription-1', |
|||
// A subscription array has actually more properties.
|
|||
], |
|||
[ |
|||
'id' => 'subscription-2', |
|||
'uri' => 'subscription-2', |
|||
'principaluri' => 'user-principal-123', |
|||
'source' => 'https://localhost/subscription-2', |
|||
// A subscription array has actually more properties.
|
|||
] |
|||
]); |
|||
|
|||
$this->provider = new CachedSubscriptionProvider($this->backend); |
|||
} |
|||
|
|||
public function testGetCalendars() { |
|||
$calendars = $this->provider->getCalendars( |
|||
'user-principal-123', |
|||
[] |
|||
); |
|||
|
|||
$this->assertCount(2, $calendars); |
|||
$this->assertInstanceOf(CachedSubscriptionImpl::class, $calendars[0]); |
|||
$this->assertInstanceOf(CachedSubscriptionImpl::class, $calendars[1]); |
|||
} |
|||
|
|||
public function testGetCalendarsFilterByUri() { |
|||
$calendars = $this->provider->getCalendars( |
|||
'user-principal-123', |
|||
['subscription-1'] |
|||
); |
|||
|
|||
$this->assertCount(1, $calendars); |
|||
$this->assertInstanceOf(CachedSubscriptionImpl::class, $calendars[0]); |
|||
$this->assertEquals('subscription-1', $calendars[0]->getUri()); |
|||
} |
|||
} |
|||
Write
Preview
Loading…
Cancel
Save
Reference in new issue