Merge pull request #33251 from cneukom/feature/birthday-calendar-reminder-settings

Birthday Calendar Reminder Setting

1 files changed, 58 insertions, 13 deletions

diff --git a/apps/dav/lib/CalDAV/BirthdayService.php b/apps/dav/lib/CalDAV/BirthdayService.php
index 6e60f9d932e..be6b0911538 100644
--- a/apps/dav/lib/CalDAV/BirthdayService.php
+++ b/apps/dav/lib/CalDAV/BirthdayService.php
@@ -14,6 +14,7 @@ declare(strict_types=1);
  * @author Sven Strickroth <email@cs-ware.de>
  * @author Thomas Müller <thomas.mueller@tmit.eu>
  * @author Valdnet <47037905+Valdnet@users.noreply.github.com>
+ * @author Cédric Neukom <github@webguy.ch>
  *
  * @license AGPL-3.0
  *
@@ -86,6 +87,9 @@ class BirthdayService {
 
 		$targetPrincipals = $this->getAllAffectedPrincipals($addressBookId);
 		$book = $this->cardDavBackEnd->getAddressBookById($addressBookId);
+		if ($book === null) {
+			return;
+		}
 		$targetPrincipals[] = $book['principaluri'];
 		$datesToSync = [
 			['postfix' => '', 'field' => 'BDAY'],
@@ -98,9 +102,14 @@ class BirthdayService {
 				continue;
 			}
 
+			$reminderOffset = $this->getReminderOffsetForUser($principalUri);
+
 			$calendar = $this->ensureCalendarExists($principalUri);
+			if ($calendar === null) {
+				return;
+			}
 			foreach ($datesToSync as $type) {
-				$this->updateCalendar($cardUri, $cardData, $book, (int) $calendar['id'], $type);
+				$this->updateCalendar($cardUri, $cardData, $book, (int) $calendar['id'], $type, $reminderOffset);
 			}
 		}
 	}
@@ -148,12 +157,14 @@ class BirthdayService {
 	 * @param $cardData
 	 * @param $dateField
 	 * @param $postfix
+	 * @param $reminderOffset
 	 * @return VCalendar|null
 	 * @throws InvalidDataException
 	 */
-	public function buildDateFromContact(string $cardData,
-										 string $dateField,
-										 string $postfix):?VCalendar {
+	public function buildDateFromContact(string  $cardData,
+										 string  $dateField,
+										 string  $postfix,
+										 ?string $reminderOffset):?VCalendar {
 		if (empty($cardData)) {
 			return null;
 		}
@@ -258,11 +269,13 @@ class BirthdayService {
 		if ($originalYear !== null) {
 			$vEvent->{'X-NEXTCLOUD-BC-YEAR'} = (string) $originalYear;
 		}
-		$alarm = $vCal->createComponent('VALARM');
-		$alarm->add($vCal->createProperty('TRIGGER', '-PT0M', ['VALUE' => 'DURATION']));
-		$alarm->add($vCal->createProperty('ACTION', 'DISPLAY'));
-		$alarm->add($vCal->createProperty('DESCRIPTION', $vEvent->{'SUMMARY'}));
-		$vEvent->add($alarm);
+		if ($reminderOffset) {
+			$alarm = $vCal->createComponent('VALARM');
+			$alarm->add($vCal->createProperty('TRIGGER', $reminderOffset, ['VALUE' => 'DURATION']));
+			$alarm->add($vCal->createProperty('ACTION', 'DISPLAY'));
+			$alarm->add($vCal->createProperty('DESCRIPTION', $vEvent->{'SUMMARY'}));
+			$vEvent->add($alarm);
+		}
 		$vCal->add($vEvent);
 		return $vCal;
 	}
@@ -344,6 +357,7 @@ class BirthdayService {
 	 * @param array $book
 	 * @param int $calendarId
 	 * @param array $type
+	 * @param string $reminderOffset
 	 * @throws InvalidDataException
 	 * @throws \Sabre\DAV\Exception\BadRequest
 	 */
@@ -351,9 +365,10 @@ class BirthdayService {
 									string $cardData,
 									array $book,
 									int $calendarId,
-									array $type):void {
+									array $type,
+									?string $reminderOffset):void {
 		$objectUri = $book['uri'] . '-' . $cardUri . $type['postfix'] . '.ics';
-		$calendarData = $this->buildDateFromContact($cardData, $type['field'], $type['postfix']);
+		$calendarData = $this->buildDateFromContact($cardData, $type['field'], $type['postfix'], $reminderOffset);
 		$existing = $this->calDavBackEnd->getCalendarObject($calendarId, $objectUri);
 		if ($calendarData === null) {
 			if ($existing !== null) {
@@ -394,14 +409,27 @@ class BirthdayService {
 	}
 
 	/**
+	 * Extracts the userId part of a principal
+	 *
+	 * @param string $userPrincipal
+	 * @return string|null
+	 */
+	private function principalToUserId(string $userPrincipal):?string {
+		if (substr($userPrincipal, 0, 17) === 'principals/users/') {
+			return substr($userPrincipal, 17);
+		}
+		return null;
+	}
+
+	/**
 	 * Checks if the user opted-out of birthday calendars
 	 *
 	 * @param string $userPrincipal The user principal to check for
 	 * @return bool
 	 */
 	private function isUserEnabled(string $userPrincipal):bool {
-		if (strpos($userPrincipal, 'principals/users/') === 0) {
-			$userId = substr($userPrincipal, 17);
+		$userId = $this->principalToUserId($userPrincipal);
+		if ($userId !== null) {
 			$isEnabled = $this->config->getUserValue($userId, 'dav', 'generateBirthdayCalendar', 'yes');
 			return $isEnabled === 'yes';
 		}
@@ -411,6 +439,23 @@ class BirthdayService {
 	}
 
 	/**
+	 * Get the reminder offset value for a user. This is a duration string (e.g.
+	 * PT9H) or null if no reminder is wanted.
+	 *
+	 * @param string $userPrincipal
+	 * @return string|null
+	 */
+	private function getReminderOffsetForUser(string $userPrincipal):?string {
+		$userId = $this->principalToUserId($userPrincipal);
+		if ($userId !== null) {
+			return $this->config->getUserValue($userId, 'dav', 'birthdayCalendarReminderOffset', 'PT9H') ?: null;
+		}
+
+		// not sure how we got here, just be on the safe side and return the default value
+		return 'PT9H';
+	}
+
+	/**
 	 * Formats title of Birthday event
 	 *
 	 * @param string $field Field name like BDAY, ANNIVERSARY, ...