Skip to content

feat(dav): add custom classification levels for events in public calendars #53073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(dav): add custom classification levels for events in public calendars #53073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions apps/dav/lib/CalDAV/CalDavBackend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,8 @@ class CalDavBackend extends AbstractBackend implements SyncSupport, Subscription
public const CLASSIFICATION_PUBLIC = 0;
public const CLASSIFICATION_PRIVATE = 1;
public const CLASSIFICATION_CONFIDENTIAL = 2;
public const CLASSIFICATION_PUBLISHED_PRIVATE = 3;
public const CLASSIFICATION_PUBLISHED_CONFIDENTIAL = 4;

/**
* List of CalDAV properties, and how they map to database field names and their type
Expand Down Expand Up @@ -3133,15 +3135,13 @@ public function getDenormalizedData(string $calendarData): array {
}

if ($component->CLASS) {
$classification = CalDavBackend::CLASSIFICATION_PRIVATE;
switch ($component->CLASS->getValue()) {
case 'PUBLIC':
$classification = CalDavBackend::CLASSIFICATION_PUBLIC;
break;
case 'CONFIDENTIAL':
$classification = CalDavBackend::CLASSIFICATION_CONFIDENTIAL;
break;
}
$classification = match ($component->CLASS->getValue()) {
'PUBLIC' => CalDavBackend::CLASSIFICATION_PUBLIC,
'CONFIDENTIAL' => CalDavBackend::CLASSIFICATION_CONFIDENTIAL,
'X-NEXTCLOUD-CLASS-PUBLISHED-PRIVATE' => CalDavBackend::CLASSIFICATION_PUBLISHED_PRIVATE,
'X-NEXTCLOUD-CLASS-PUBLISHED-CONFIDENTIAL' => CalDavBackend::CLASSIFICATION_PUBLISHED_CONFIDENTIAL,
default => CalDavBackend::CLASSIFICATION_PRIVATE,
};
}
return [
'etag' => md5($calendarData),
Expand Down
6 changes: 3 additions & 3 deletions apps/dav/lib/CalDAV/CalendarObject.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ protected function isShared() {
* @param Component\VCalendar $vObject
* @return void
*/
private function createConfidentialObject(Component\VCalendar $vObject): void {
protected function createConfidentialObject(Component\VCalendar $vObject): void {
/** @var Component $vElement */
$vElements = array_filter($vObject->getComponents(), static function ($vElement) {
return $vElement instanceof Component\VEvent || $vElement instanceof Component\VJournal || $vElement instanceof Component\VTodo;
Expand Down Expand Up @@ -117,7 +117,7 @@ private function createConfidentialObject(Component\VCalendar $vObject): void {
* @param Component\VCalendar $vObject
* @return void
*/
private function removeVAlarms(Component\VCalendar $vObject) {
protected function removeVAlarms(Component\VCalendar $vObject) {
$subcomponents = $vObject->getComponents();

foreach ($subcomponents as $subcomponent) {
Expand All @@ -128,7 +128,7 @@ private function removeVAlarms(Component\VCalendar $vObject) {
/**
* @return bool
*/
private function canWrite() {
protected function canWrite() {
if (isset($this->calendarInfo['{http://owncloud.org/ns}read-only'])) {
return !$this->calendarInfo['{http://owncloud.org/ns}read-only'];
}
Expand Down
18 changes: 15 additions & 3 deletions apps/dav/lib/CalDAV/PublicCalendar.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ public function getChild($name) {
if (!$obj) {
throw new NotFound('Calendar object not found');
}
if ($obj['classification'] === CalDavBackend::CLASSIFICATION_PRIVATE) {
if (in_array($obj['classification'], [CalDavBackend::CLASSIFICATION_PRIVATE, CalDavBackend::CLASSIFICATION_PUBLISHED_PRIVATE], true)) {
throw new NotFound('Calendar object not found');
}
$obj['acl'] = $this->getChildACL();
Expand All @@ -36,7 +36,7 @@ public function getChildren() {
$objs = $this->caldavBackend->getCalendarObjects($this->calendarInfo['id']);
$children = [];
foreach ($objs as $obj) {
if ($obj['classification'] === CalDavBackend::CLASSIFICATION_PRIVATE) {
if (in_array($obj['classification'], [CalDavBackend::CLASSIFICATION_PRIVATE, CalDavBackend::CLASSIFICATION_PUBLISHED_PRIVATE], true)) {
continue;
}
$obj['acl'] = $this->getChildACL();
Expand All @@ -53,7 +53,7 @@ public function getMultipleChildren(array $paths) {
$objs = $this->caldavBackend->getMultipleCalendarObjects($this->calendarInfo['id'], $paths);
$children = [];
foreach ($objs as $obj) {
if ($obj['classification'] === CalDavBackend::CLASSIFICATION_PRIVATE) {
if (in_array($obj['classification'], [CalDavBackend::CLASSIFICATION_PRIVATE, CalDavBackend::CLASSIFICATION_PUBLISHED_PRIVATE], true)) {
continue;
}
$obj['acl'] = $this->getChildACL();
Expand All @@ -62,6 +62,18 @@ public function getMultipleChildren(array $paths) {
return $children;
}

public function childExists($name) {
$obj = $this->caldavBackend->getCalendarObject($this->calendarInfo['id'], $name);
if (!$obj) {
return false;
}
if (in_array($obj['classification'], [CalDavBackend::CLASSIFICATION_PRIVATE, CalDavBackend::CLASSIFICATION_PUBLISHED_PRIVATE], true) && $this->isShared()) {
return false;
}

return true;
}

/**
* public calendars are always shared
* @return bool
Expand Down
27 changes: 27 additions & 0 deletions apps/dav/lib/CalDAV/PublicCalendarObject.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,35 @@
*/
namespace OCA\DAV\CalDAV;

use Sabre\VObject\Reader;

class PublicCalendarObject extends CalendarObject {

/**
* @inheritdoc
*/
public function get() {
$data = parent::get();

if (!$this->isShared()) {
return $data;
}

$vObject = Reader::read($data);

// remove VAlarms if calendar is shared read-only
if (!$this->canWrite()) {
$this->removeVAlarms($vObject);
}

// shows as busy if event is declared confidential or external confidential
if (in_array($this->objectData['classification'], [CalDavBackend::CLASSIFICATION_CONFIDENTIAL, CalDavBackend::CLASSIFICATION_PUBLISHED_CONFIDENTIAL], true)) {
$this->createConfidentialObject($vObject);
}

return $vObject->serialize();
}

/**
* public calendars are always shared
* @return bool
Expand Down
4 changes: 4 additions & 0 deletions apps/dav/tests/unit/CalDAV/CalDavBackendTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -736,6 +736,10 @@ public static function providesCalDataForGetDenormalizedData(): array {

'CLASS:CONFIDENTIAL' => [CalDavBackend::CLASSIFICATION_CONFIDENTIAL, 'classification', "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//dmfs.org//mimedir.icalendar//EN\r\nBEGIN:VTIMEZONE\r\nTZID:Europe/Berlin\r\nX-LIC-LOCATION:Europe/Berlin\r\nBEGIN:DAYLIGHT\r\nTZOFFSETFROM:+0100\r\nTZOFFSETTO:+0200\r\nTZNAME:CEST\r\nDTSTART:19700329T020000\r\nRRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU\r\nEND:DAYLIGHT\r\nBEGIN:STANDARD\r\nTZOFFSETFROM:+0200\r\nTZOFFSETTO:+0100\r\nTZNAME:CET\r\nDTSTART:19701025T030000\r\nRRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU\r\nEND:STANDARD\r\nEND:VTIMEZONE\r\nBEGIN:VEVENT\r\nDTSTART;TZID=Europe/Berlin:20160419T130000\r\nSUMMARY:Test\r\nCLASS:CONFIDENTIAL\r\nTRANSP:OPAQUE\r\nSTATUS:CONFIRMED\r\nDTEND;TZID=Europe/Berlin:20160419T140000\r\nLAST-MODIFIED:20160419T074202Z\r\nDTSTAMP:20160419T074202Z\r\nCREATED:20160419T074202Z\r\nUID:2e468c48-7860-492e-bc52-92fa0daeeccf.1461051722310\r\nEND:VEVENT\r\nEND:VCALENDAR"],

'CLASS:X-NEXTCLOUD-CLASS-PUBLISHED-PRIVATE' => [CalDavBackend::CLASSIFICATION_PUBLISHED_PRIVATE, 'classification', "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//dmfs.org//mimedir.icalendar//EN\r\nBEGIN:VTIMEZONE\r\nTZID:Europe/Berlin\r\nX-LIC-LOCATION:Europe/Berlin\r\nBEGIN:DAYLIGHT\r\nTZOFFSETFROM:+0100\r\nTZOFFSETTO:+0200\r\nTZNAME:CEST\r\nDTSTART:19700329T020000\r\nRRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU\r\nEND:DAYLIGHT\r\nBEGIN:STANDARD\r\nTZOFFSETFROM:+0200\r\nTZOFFSETTO:+0100\r\nTZNAME:CET\r\nDTSTART:19701025T030000\r\nRRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU\r\nEND:STANDARD\r\nEND:VTIMEZONE\r\nBEGIN:VEVENT\r\nDTSTART;TZID=Europe/Berlin:20160419T130000\r\nSUMMARY:Test\r\nCLASS:X-NEXTCLOUD-CLASS-PUBLISHED-PRIVATE\r\nTRANSP:OPAQUE\r\nSTATUS:CONFIRMED\r\nDTEND;TZID=Europe/Berlin:20160419T140000\r\nLAST-MODIFIED:20160419T074202Z\r\nDTSTAMP:20160419T074202Z\r\nCREATED:20160419T074202Z\r\nUID:2e468c48-7860-492e-bc52-92fa0daeeccf.1461051722310\r\nEND:VEVENT\r\nEND:VCALENDAR"],

'CLASS:X-NEXTCLOUD-CLASS-PUBLISHED-CONFIDENTIAL' => [CalDavBackend::CLASSIFICATION_PUBLISHED_CONFIDENTIAL, 'classification', "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//dmfs.org//mimedir.icalendar//EN\r\nBEGIN:VTIMEZONE\r\nTZID:Europe/Berlin\r\nX-LIC-LOCATION:Europe/Berlin\r\nBEGIN:DAYLIGHT\r\nTZOFFSETFROM:+0100\r\nTZOFFSETTO:+0200\r\nTZNAME:CEST\r\nDTSTART:19700329T020000\r\nRRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU\r\nEND:DAYLIGHT\r\nBEGIN:STANDARD\r\nTZOFFSETFROM:+0200\r\nTZOFFSETTO:+0100\r\nTZNAME:CET\r\nDTSTART:19701025T030000\r\nRRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU\r\nEND:STANDARD\r\nEND:VTIMEZONE\r\nBEGIN:VEVENT\r\nDTSTART;TZID=Europe/Berlin:20160419T130000\r\nSUMMARY:Test\r\nCLASS:X-NEXTCLOUD-CLASS-PUBLISHED-CONFIDENTIAL\r\nTRANSP:OPAQUE\r\nSTATUS:CONFIRMED\r\nDTEND;TZID=Europe/Berlin:20160419T140000\r\nLAST-MODIFIED:20160419T074202Z\r\nDTSTAMP:20160419T074202Z\r\nCREATED:20160419T074202Z\r\nUID:2e468c48-7860-492e-bc52-92fa0daeeccf.1461051722310\r\nEND:VEVENT\r\nEND:VCALENDAR"],

'no class set -> public' => [CalDavBackend::CLASSIFICATION_PUBLIC, 'classification', "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//dmfs.org//mimedir.icalendar//EN\r\nBEGIN:VTIMEZONE\r\nTZID:Europe/Berlin\r\nX-LIC-LOCATION:Europe/Berlin\r\nBEGIN:DAYLIGHT\r\nTZOFFSETFROM:+0100\r\nTZOFFSETTO:+0200\r\nTZNAME:CEST\r\nDTSTART:19700329T020000\r\nRRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU\r\nEND:DAYLIGHT\r\nBEGIN:STANDARD\r\nTZOFFSETFROM:+0200\r\nTZOFFSETTO:+0100\r\nTZNAME:CET\r\nDTSTART:19701025T030000\r\nRRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU\r\nEND:STANDARD\r\nEND:VTIMEZONE\r\nBEGIN:VEVENT\r\nDTSTART;TZID=Europe/Berlin:20160419T130000\r\nSUMMARY:Test\r\nTRANSP:OPAQUE\r\nDTEND;TZID=Europe/Berlin:20160419T140000\r\nLAST-MODIFIED:20160419T074202Z\r\nDTSTAMP:20160419T074202Z\r\nCREATED:20160419T074202Z\r\nUID:2e468c48-7860-492e-bc52-92fa0daeeccf.1461051722310\r\nEND:VEVENT\r\nEND:VCALENDAR"],

'unknown class -> private' => [CalDavBackend::CLASSIFICATION_PRIVATE, 'classification', "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//dmfs.org//mimedir.icalendar//EN\r\nBEGIN:VTIMEZONE\r\nTZID:Europe/Berlin\r\nX-LIC-LOCATION:Europe/Berlin\r\nBEGIN:DAYLIGHT\r\nTZOFFSETFROM:+0100\r\nTZOFFSETTO:+0200\r\nTZNAME:CEST\r\nDTSTART:19700329T020000\r\nRRULE:FREQ=YEARLY;BYMONTH=3;BYDAY=-1SU\r\nEND:DAYLIGHT\r\nBEGIN:STANDARD\r\nTZOFFSETFROM:+0200\r\nTZOFFSETTO:+0100\r\nTZNAME:CET\r\nDTSTART:19701025T030000\r\nRRULE:FREQ=YEARLY;BYMONTH=10;BYDAY=-1SU\r\nEND:STANDARD\r\nEND:VTIMEZONE\r\nBEGIN:VEVENT\r\nDTSTART;TZID=Europe/Berlin:20160419T130000\r\nSUMMARY:Test\r\nCLASS:VERTRAULICH\r\nTRANSP:OPAQUE\r\nSTATUS:CONFIRMED\r\nDTEND;TZID=Europe/Berlin:20160419T140000\r\nLAST-MODIFIED:20160419T074202Z\r\nDTSTAMP:20160419T074202Z\r\nCREATED:20160419T074202Z\r\nUID:2e468c48-7860-492e-bc52-92fa0daeeccf.1461051722310\r\nEND:VEVENT\r\nEND:VCALENDAR"],
Expand Down
55 changes: 39 additions & 16 deletions apps/dav/tests/unit/CalDAV/CalendarTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -271,19 +271,26 @@ public function testPrivateClassification(int $expectedChildren, bool $isShared)
$calObject0 = ['uri' => 'event-0', 'classification' => CalDavBackend::CLASSIFICATION_PUBLIC];
$calObject1 = ['uri' => 'event-1', 'classification' => CalDavBackend::CLASSIFICATION_CONFIDENTIAL];
$calObject2 = ['uri' => 'event-2', 'classification' => CalDavBackend::CLASSIFICATION_PRIVATE];
$calObject3 = ['uri' => 'event-3', 'classification' => CalDavBackend::CLASSIFICATION_PUBLISHED_PRIVATE];
$calObject4 = ['uri' => 'event-4', 'classification' => CalDavBackend::CLASSIFICATION_PUBLISHED_CONFIDENTIAL];

/** @var CalDavBackend&MockObject $backend */
$backend = $this->createMock(CalDavBackend::class);
$backend->expects($this->any())->method('getCalendarObjects')->willReturn([
$calObject0, $calObject1, $calObject2
$calObject0, $calObject1, $calObject2, $calObject3, $calObject4
]);
$backend->expects($this->any())->method('getMultipleCalendarObjects')
->with(666, ['event-0', 'event-1', 'event-2'])
->with(666, ['event-0', 'event-1', 'event-2', 'event-3', 'event-4'])
->willReturn([
$calObject0, $calObject1, $calObject2
$calObject0, $calObject1, $calObject2, $calObject3, $calObject4
]);
$backend->expects($this->any())->method('getCalendarObject')
->willReturn($calObject2)->with(666, 'event-2');
$matcher = $this->exactly(2);
$backend->expects($matcher)->method('getCalendarObject')
->willReturnCallback(fn (int $key, string $uri) =>
match ([$key, $uri]) {
[666, 'event-2'] => $calObject2,
[666, 'event-3'] => $calObject3,
});
$backend->expects($this->any())->method('applyShareAcl')->willReturnArgument(1);

$calendarInfo = [
Expand All @@ -297,11 +304,12 @@ public function testPrivateClassification(int $expectedChildren, bool $isShared)
}
$c = new Calendar($backend, $calendarInfo, $this->l10n, $this->config, $this->logger);
$children = $c->getChildren();
$this->assertEquals($expectedChildren, count($children));
$children = $c->getMultipleChildren(['event-0', 'event-1', 'event-2']);
$this->assertEquals($expectedChildren, count($children));
$this->assertCount($expectedChildren, $children);
$children = $c->getMultipleChildren(['event-0', 'event-1', 'event-2', 'event-3', 'event-4']);
$this->assertCount($expectedChildren, $children);

$this->assertEquals(!$isShared, $c->childExists('event-2'));
$this->assertTrue($c->childExists('event-3'));
}

#[\PHPUnit\Framework\Attributes\DataProvider('providesConfidentialClassificationData')]
Expand Down Expand Up @@ -354,19 +362,26 @@ public function testConfidentialClassification(int $expectedChildren, bool $isSh
$calObject0 = ['uri' => 'event-0', 'classification' => CalDavBackend::CLASSIFICATION_PUBLIC];
$calObject1 = ['uri' => 'event-1', 'classification' => CalDavBackend::CLASSIFICATION_CONFIDENTIAL, 'calendardata' => $calData];
$calObject2 = ['uri' => 'event-2', 'classification' => CalDavBackend::CLASSIFICATION_PRIVATE];
$calObject3 = ['uri' => 'event-3', 'classification' => CalDavBackend::CLASSIFICATION_PUBLISHED_CONFIDENTIAL, 'calendardata' => $calData];
$calObject4 = ['uri' => 'event-2', 'classification' => CalDavBackend::CLASSIFICATION_PUBLISHED_PRIVATE];

/** @var CalDavBackend&MockObject $backend */
$backend = $this->createMock(CalDavBackend::class);
$backend->expects($this->any())->method('getCalendarObjects')->willReturn([
$calObject0, $calObject1, $calObject2
$calObject0, $calObject1, $calObject2, $calObject3, $calObject4
]);
$backend->expects($this->any())->method('getMultipleCalendarObjects')
->with(666, ['event-0', 'event-1', 'event-2'])
->with(666, ['event-0', 'event-1', 'event-2', 'event-3', 'event-4'])
->willReturn([
$calObject0, $calObject1, $calObject2
$calObject0, $calObject1, $calObject2, $calObject3, $calObject4
]);
$backend->expects($this->any())->method('getCalendarObject')
->willReturn($calObject1)->with(666, 'event-1');
$matcher = $this->exactly(3);
$backend->expects($matcher)->method('getCalendarObject')
->willReturnCallback(fn (int $key, string $uri) =>
match ([$key, $uri]) {
[666, 'event-1'] => $calObject1,
[666, 'event-3'] => $calObject3,
});
$backend->expects($this->any())->method('applyShareAcl')->willReturnArgument(1);

$calendarInfo = [
Expand All @@ -377,7 +392,7 @@ public function testConfidentialClassification(int $expectedChildren, bool $isSh
];
$c = new Calendar($backend, $calendarInfo, $this->l10n, $this->config, $this->logger);

$this->assertEquals(count($c->getChildren()), $expectedChildren);
$this->assertCount($expectedChildren, $c->getChildren());

// test private event
$privateEvent = $c->getChild('event-1');
Expand All @@ -397,6 +412,14 @@ public function testConfidentialClassification(int $expectedChildren, bool $isSh
$this->assertEquals('Test Event', $event->VEVENT->SUMMARY->getValue());
}

// test published private event
$publishedPrivateEvent = $c->getChild('event-3');
$publishedCalData = $publishedPrivateEvent->get();
$publishedEvent = Reader::read($publishedCalData);

$this->assertNotEquals('Busy', $publishedEvent->VEVENT->SUMMARY->getValue());
$this->assertEquals('Test Event', $publishedEvent->VEVENT->SUMMARY->getValue());

// Test l10n
$l10n = $this->createMock(IL10N::class);
if ($isShared) {
Expand All @@ -422,8 +445,8 @@ public function testConfidentialClassification(int $expectedChildren, bool $isSh

public static function providesConfidentialClassificationData(): array {
return [
[3, false],
[2, true]
[5, false],
[4, true]
];
}

Expand Down
Loading
Loading