Skip to content

feat(dav): store multiple default calendar alarms as JSON #61832

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
rich0 wants to merge 1 commit into
base: master
Choose a base branch
from
+470 −8
Open

feat(dav): store multiple default calendar alarms as JSON #61832

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
2 changes: 2 additions & 0 deletions apps/dav/composer/composer/autoload_classmap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@
'OCA\\DAV\\CalDAV\\CalendarObject' => $baseDir . '/../lib/CalDAV/CalendarObject.php',
'OCA\\DAV\\CalDAV\\CalendarProvider' => $baseDir . '/../lib/CalDAV/CalendarProvider.php',
'OCA\\DAV\\CalDAV\\CalendarRoot' => $baseDir . '/../lib/CalDAV/CalendarRoot.php',
'OCA\\DAV\\CalDAV\\DefaultCalendarAlarms' => $baseDir . '/../lib/CalDAV/DefaultCalendarAlarms.php',
'OCA\\DAV\\CalDAV\\DefaultCalendarValidator' => $baseDir . '/../lib/CalDAV/DefaultCalendarValidator.php',
'OCA\\DAV\\CalDAV\\EmbeddedCalDavServer' => $baseDir . '/../lib/CalDAV/EmbeddedCalDavServer.php',
'OCA\\DAV\\CalDAV\\EventComparisonService' => $baseDir . '/../lib/CalDAV/EventComparisonService.php',
Expand Down Expand Up @@ -396,6 +397,7 @@
'OCA\\DAV\\Migration\\Version1036Date20251202000000' => $baseDir . '/../lib/Migration/Version1036Date20251202000000.php',
'OCA\\DAV\\Migration\\Version1038Date20260302000000' => $baseDir . '/../lib/Migration/Version1038Date20260302000000.php',
'OCA\\DAV\\Migration\\Version1039Date20260408000000' => $baseDir . '/../lib/Migration/Version1039Date20260408000000.php',
'OCA\\DAV\\Migration\\Version1040Date20260703120000' => $baseDir . '/../lib/Migration/Version1040Date20260703120000.php',
'OCA\\DAV\\Model\\ExampleEvent' => $baseDir . '/../lib/Model/ExampleEvent.php',
'OCA\\DAV\\Paginate\\LimitedCopyIterator' => $baseDir . '/../lib/Paginate/LimitedCopyIterator.php',
'OCA\\DAV\\Paginate\\PaginateCache' => $baseDir . '/../lib/Paginate/PaginateCache.php',
Expand Down
2 changes: 2 additions & 0 deletions apps/dav/composer/composer/autoload_static.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ class ComposerStaticInitDAV
'OCA\\DAV\\CalDAV\\CalendarObject' => __DIR__ . '/..' . '/../lib/CalDAV/CalendarObject.php',
'OCA\\DAV\\CalDAV\\CalendarProvider' => __DIR__ . '/..' . '/../lib/CalDAV/CalendarProvider.php',
'OCA\\DAV\\CalDAV\\CalendarRoot' => __DIR__ . '/..' . '/../lib/CalDAV/CalendarRoot.php',
'OCA\\DAV\\CalDAV\\DefaultCalendarAlarms' => __DIR__ . '/..' . '/../lib/CalDAV/DefaultCalendarAlarms.php',
'OCA\\DAV\\CalDAV\\DefaultCalendarValidator' => __DIR__ . '/..' . '/../lib/CalDAV/DefaultCalendarValidator.php',
'OCA\\DAV\\CalDAV\\EmbeddedCalDavServer' => __DIR__ . '/..' . '/../lib/CalDAV/EmbeddedCalDavServer.php',
'OCA\\DAV\\CalDAV\\EventComparisonService' => __DIR__ . '/..' . '/../lib/CalDAV/EventComparisonService.php',
Expand Down Expand Up @@ -411,6 +412,7 @@ class ComposerStaticInitDAV
'OCA\\DAV\\Migration\\Version1036Date20251202000000' => __DIR__ . '/..' . '/../lib/Migration/Version1036Date20251202000000.php',
'OCA\\DAV\\Migration\\Version1038Date20260302000000' => __DIR__ . '/..' . '/../lib/Migration/Version1038Date20260302000000.php',
'OCA\\DAV\\Migration\\Version1039Date20260408000000' => __DIR__ . '/..' . '/../lib/Migration/Version1039Date20260408000000.php',
'OCA\\DAV\\Migration\\Version1040Date20260703120000' => __DIR__ . '/..' . '/../lib/Migration/Version1040Date20260703120000.php',
'OCA\\DAV\\Model\\ExampleEvent' => __DIR__ . '/..' . '/../lib/Model/ExampleEvent.php',
'OCA\\DAV\\Paginate\\LimitedCopyIterator' => __DIR__ . '/..' . '/../lib/Paginate/LimitedCopyIterator.php',
'OCA\\DAV\\Paginate\\PaginateCache' => __DIR__ . '/..' . '/../lib/Paginate/PaginateCache.php',
Expand Down
115 changes: 107 additions & 8 deletions apps/dav/lib/CalDAV/CalDavBackend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,15 @@ class CalDavBackend extends AbstractBackend implements SyncSupport, Subscription
public const CLASSIFICATION_PRIVATE = 1;
public const CLASSIFICATION_CONFIDENTIAL = 2;

public const DEFAULT_ALARMS_PART_DAY_PROPERTY = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}default-alarms-part-day';
public const DEFAULT_ALARMS_FULL_DAY_PROPERTY = '{' . \OCA\DAV\DAV\Sharing\Plugin::NS_NEXTCLOUD . '}default-alarms-full-day';

/** @var string[] DB columns for calendar properties outside propertyMap (custom serialization). */
private const SERIALIZED_CALENDAR_DB_COLUMNS = [
'default_alarms_pday',
'default_alarms_fday',
];

/**
* List of CalDAV properties, and how they map to database field names and their type
* Add your own properties by simply adding on to this array.
Expand Down Expand Up @@ -326,7 +335,7 @@ public function getCalendarsForUser($principalUri) {
return $this->atomic(function () use ($principalUri) {
$principalUriOriginal = $principalUri;
$principalUri = $this->convertPrincipal($principalUri, true);
$fields = array_column($this->propertyMap, 0);
$fields = $this->getCalendarMergeSerializedProperties();
$fields[] = 'id';
$fields[] = 'uri';
$fields[] = 'synctoken';
Expand Down Expand Up @@ -382,10 +391,9 @@ public function getCalendarsForUser($principalUri) {
$principals = array_merge($principals, $this->principalBackend->getCircleMembership($principalUriOriginal));
$principals[] = $principalUri;

$fields = array_column($this->propertyMap, 0);
$fields = array_map(function (string $field) {
return 'a.' . $field;
}, $fields);
}, $this->getCalendarMergeSerializedProperties());
$fields[] = 'a.id';
$fields[] = 'a.uri';
$fields[] = 'a.synctoken';
Expand Down Expand Up @@ -468,7 +476,7 @@ public function getCalendarsForUser($principalUri) {
*/
public function getUsersOwnCalendars($principalUri) {
$principalUri = $this->convertPrincipal($principalUri, true);
$fields = array_column($this->propertyMap, 0);
$fields = $this->getCalendarMergeSerializedProperties();
$fields[] = 'id';
$fields[] = 'uri';
$fields[] = 'synctoken';
Expand Down Expand Up @@ -514,7 +522,7 @@ public function getUsersOwnCalendars($principalUri) {
* @return array
*/
public function getPublicCalendars() {
$fields = array_column($this->propertyMap, 0);
$fields = array_map(static fn (string $field): string => 'a.' . $field, $this->getCalendarMergeSerializedProperties());
$fields[] = 'a.id';
$fields[] = 'a.uri';
$fields[] = 'a.synctoken';
Expand Down Expand Up @@ -572,7 +580,7 @@ public function getPublicCalendars() {
* @throws NotFound
*/
public function getPublicCalendar($uri) {
$fields = array_column($this->propertyMap, 0);
$fields = array_map(static fn (string $field): string => 'a.' . $field, $this->getCalendarMergeSerializedProperties());
$fields[] = 'a.id';
$fields[] = 'a.uri';
$fields[] = 'a.synctoken';
Expand Down Expand Up @@ -631,7 +639,7 @@ public function getPublicCalendar($uri) {
* @return array|null
*/
public function getCalendarByUri($principal, $uri) {
$fields = array_column($this->propertyMap, 0);
$fields = $this->getCalendarMergeSerializedProperties();
$fields[] = 'id';
$fields[] = 'uri';
$fields[] = 'synctoken';
Expand Down Expand Up @@ -681,7 +689,7 @@ public function getCalendarByUri($principal, $uri) {
* @return array|null
*/
public function getCalendarById(int $calendarId): ?array {
$fields = array_column($this->propertyMap, 0);
$fields = $this->getCalendarMergeSerializedProperties();
$fields[] = 'id';
$fields[] = 'uri';
$fields[] = 'synctoken';
Expand Down Expand Up @@ -850,9 +858,29 @@ public function createCalendar($principalUri, $calendarUri, array $properties) {
foreach ($this->propertyMap as $xmlName => [$dbName, $type]) {
if (isset($properties[$xmlName])) {
$values[$dbName] = $properties[$xmlName];
if ($dbName === 'default_alarm_pday') {
$values['default_alarms_pday'] = DefaultCalendarAlarms::encodeFromLegacyInt(
$properties[$xmlName] !== null ? (int)$properties[$xmlName] : null,
);
} elseif ($dbName === 'default_alarm_fday') {
$values['default_alarms_fday'] = DefaultCalendarAlarms::encodeFromLegacyInt(
$properties[$xmlName] !== null ? (int)$properties[$xmlName] : null,
);
}
}
}

if (isset($properties[self::DEFAULT_ALARMS_PART_DAY_PROPERTY])) {
$encoded = DefaultCalendarAlarms::validateAndEncode($properties[self::DEFAULT_ALARMS_PART_DAY_PROPERTY]);
$values['default_alarms_pday'] = $encoded;
$values['default_alarm_pday'] = DefaultCalendarAlarms::legacyIntFromJson($encoded);
}
if (isset($properties[self::DEFAULT_ALARMS_FULL_DAY_PROPERTY])) {
$encoded = DefaultCalendarAlarms::validateAndEncode($properties[self::DEFAULT_ALARMS_FULL_DAY_PROPERTY]);
$values['default_alarms_fday'] = $encoded;
$values['default_alarm_fday'] = DefaultCalendarAlarms::legacyIntFromJson($encoded);
}

[$calendarId, $calendarData] = $this->atomic(function () use ($values) {
$query = $this->db->getQueryBuilder();
$query->insert('calendars');
Expand Down Expand Up @@ -891,18 +919,42 @@ public function createCalendar($principalUri, $calendarUri, array $properties) {
public function updateCalendar($calendarId, PropPatch $propPatch) {
$supportedProperties = array_keys($this->propertyMap);
$supportedProperties[] = '{' . Plugin::NS_CALDAV . '}schedule-calendar-transp';
$supportedProperties[] = self::DEFAULT_ALARMS_PART_DAY_PROPERTY;
$supportedProperties[] = self::DEFAULT_ALARMS_FULL_DAY_PROPERTY;

$propPatch->handle($supportedProperties, function ($mutations) use ($calendarId) {
$storedDefaultAlarmsJson = $this->getCalendarDefaultAlarmsJson($calendarId);
$newValues = [];
foreach ($mutations as $propertyName => $propertyValue) {
switch ($propertyName) {
case '{' . Plugin::NS_CALDAV . '}schedule-calendar-transp':
$fieldName = 'transparent';
$newValues[$fieldName] = (int)($propertyValue->getValue() === 'transparent');
break;
case self::DEFAULT_ALARMS_PART_DAY_PROPERTY:
$encoded = DefaultCalendarAlarms::validateAndEncode($propertyValue);
$newValues['default_alarms_pday'] = $encoded;
$newValues['default_alarm_pday'] = DefaultCalendarAlarms::legacyIntFromJson($encoded);
break;
case self::DEFAULT_ALARMS_FULL_DAY_PROPERTY:
$encoded = DefaultCalendarAlarms::validateAndEncode($propertyValue);
$newValues['default_alarms_fday'] = $encoded;
$newValues['default_alarm_fday'] = DefaultCalendarAlarms::legacyIntFromJson($encoded);
break;
default:
$fieldName = $this->propertyMap[$propertyName][0];
$newValues[$fieldName] = $propertyValue;
if ($fieldName === 'default_alarm_pday') {
$newValues['default_alarms_pday'] = DefaultCalendarAlarms::mergeLegacyIntIntoJson(
$storedDefaultAlarmsJson['default_alarms_pday'],
$propertyValue !== null ? (int)$propertyValue : null,
);
} elseif ($fieldName === 'default_alarm_fday') {
$newValues['default_alarms_fday'] = DefaultCalendarAlarms::mergeLegacyIntIntoJson(
$storedDefaultAlarmsJson['default_alarms_fday'],
$propertyValue !== null ? (int)$propertyValue : null,
);
}
break;
}
}
Expand Down Expand Up @@ -3968,9 +4020,56 @@ private function rowToCalendar($row, array $calendar): array {
}
$calendar[$xmlName] = $value;
}

$calendar[self::DEFAULT_ALARMS_PART_DAY_PROPERTY] = DefaultCalendarAlarms::formatForCalDav(
isset($row['default_alarms_pday']) ? (string)$row['default_alarms_pday'] : null,
isset($row['default_alarm_pday']) && $row['default_alarm_pday'] !== null ? (int)$row['default_alarm_pday'] : null,
);
$calendar[self::DEFAULT_ALARMS_FULL_DAY_PROPERTY] = DefaultCalendarAlarms::formatForCalDav(
isset($row['default_alarms_fday']) ? (string)$row['default_alarms_fday'] : null,
isset($row['default_alarm_fday']) && $row['default_alarm_fday'] !== null ? (int)$row['default_alarm_fday'] : null,
);

return $calendar;
}

/**
* calendars-table SELECT columns: propertyMap DB fields plus columns for
* CalDAV properties stored outside propertyMap (custom serialization).
*
* @return string[]
*/
private function getCalendarMergeSerializedProperties(): array {
return array_merge(
array_column($this->propertyMap, 0),
self::SERIALIZED_CALENDAR_DB_COLUMNS,
);
}

/**
* @return array{default_alarms_pday: ?string, default_alarms_fday: ?string}
*/
private function getCalendarDefaultAlarmsJson(int $calendarId): array {
$query = $this->db->getQueryBuilder();
$query->select('default_alarms_pday', 'default_alarms_fday')
->from('calendars')
->where($query->expr()->eq('id', $query->createNamedParameter($calendarId, IQueryBuilder::PARAM_INT)))
->setMaxResults(1);
$row = $query->executeQuery()->fetchAssociative();

if ($row === false) {
return [
'default_alarms_pday' => null,
'default_alarms_fday' => null,
];
}

return [
'default_alarms_pday' => $row['default_alarms_pday'] !== null ? (string)$row['default_alarms_pday'] : null,
'default_alarms_fday' => $row['default_alarms_fday'] !== null ? (string)$row['default_alarms_fday'] : null,
];
}

/**
* Amend the subscription info with database row data
*
Expand Down
Loading