nextcloud / server

apps/dav/lib/CalDAV/Reminder/INotificationProvider.php

Indentation +11 added lines, -11 removed lines

@@ -33,15 +33,15 @@
  */
 interface INotificationProvider {
 
-	/**
-	 * Send notification
-	 *
-	 * @param VEvent $vevent
-	 * @param string $calendarDisplayName
-	 * @param IUser[] $users
-	 * @return void
-	 */
-	public function send(VEvent $vevent,
-						 string $calendarDisplayName,
-						 array $users=[]): void;
+    /**
+     * Send notification
+     *
+     * @param VEvent $vevent
+     * @param string $calendarDisplayName
+     * @param IUser[] $users
+     * @return void
+     */
+    public function send(VEvent $vevent,
+                            string $calendarDisplayName,
+                            array $users=[]): void;
 }
\ No newline at end of file

apps/dav/lib/CalDAV/Reminder/ReminderService.php

Indentation +718 added lines, -718 removed lines

@@ -40,722 +40,722 @@
 
 class ReminderService {
 
-	/** @var Backend */
-	private $backend;
-
-	/** @var NotificationProviderManager */
-	private $notificationProviderManager;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	/** @var IGroupManager */
-	private $groupManager;
-
-	/** @var CalDavBackend */
-	private $caldavBackend;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	public const REMINDER_TYPE_EMAIL = 'EMAIL';
-	public const REMINDER_TYPE_DISPLAY = 'DISPLAY';
-	public const REMINDER_TYPE_AUDIO = 'AUDIO';
-
-	/**
-	 * @var String[]
-	 *
-	 * Official RFC5545 reminder types
-	 */
-	public const REMINDER_TYPES = [
-		self::REMINDER_TYPE_EMAIL,
-		self::REMINDER_TYPE_DISPLAY,
-		self::REMINDER_TYPE_AUDIO
-	];
-
-	/**
-	 * ReminderService constructor.
-	 *
-	 * @param Backend $backend
-	 * @param NotificationProviderManager $notificationProviderManager
-	 * @param IUserManager $userManager
-	 * @param IGroupManager $groupManager
-	 * @param CalDavBackend $caldavBackend
-	 * @param ITimeFactory $timeFactory
-	 */
-	public function __construct(Backend $backend,
-								NotificationProviderManager $notificationProviderManager,
-								IUserManager $userManager,
-								IGroupManager $groupManager,
-								CalDavBackend $caldavBackend,
-								ITimeFactory $timeFactory) {
-		$this->backend = $backend;
-		$this->notificationProviderManager = $notificationProviderManager;
-		$this->userManager = $userManager;
-		$this->groupManager = $groupManager;
-		$this->caldavBackend = $caldavBackend;
-		$this->timeFactory = $timeFactory;
-	}
-
-	/**
-	 * Process reminders to activate
-	 *
-	 * @throws NotificationProvider\ProviderNotAvailableException
-	 * @throws NotificationTypeDoesNotExistException
-	 */
-	public function processReminders():void {
-		$reminders = $this->backend->getRemindersToProcess();
-
-		foreach($reminders as $reminder) {
-			$vcalendar = $this->parseCalendarData($reminder['calendardata']);
-			if (!$vcalendar) {
-				$this->backend->removeReminder($reminder['id']);
-				continue;
-			}
-
-			$vevent = $this->getVEventByRecurrenceId($vcalendar, $reminder['recurrence_id'], $reminder['is_recurrence_exception']);
-			if (!$vevent) {
-				$this->backend->removeReminder($reminder['id']);
-				continue;
-			}
-
-			if ($this->wasEventCancelled($vevent)) {
-				$this->deleteOrProcessNext($reminder, $vevent);
-				continue;
-			}
-
-			if (!$this->notificationProviderManager->hasProvider($reminder['type'])) {
-				$this->deleteOrProcessNext($reminder, $vevent);
-				continue;
-			}
-
-			$users = $this->getAllUsersWithWriteAccessToCalendar($reminder['calendar_id']);
-			$user = $this->getUserFromPrincipalURI($reminder['principaluri']);
-			if ($user) {
-				$users[] = $user;
-			}
-
-			$notificationProvider = $this->notificationProviderManager->getProvider($reminder['type']);
-			$notificationProvider->send($vevent, $reminder['displayname'], $users);
-
-			$this->deleteOrProcessNext($reminder, $vevent);
-		}
-	}
-
-	/**
-	 * @param string $action
-	 * @param array $objectData
-	 * @throws VObject\InvalidDataException
-	 */
-	public function onTouchCalendarObject(string $action,
-										  array $objectData):void {
-		// We only support VEvents for now
-		if (strcasecmp($objectData['component'], 'vevent') !== 0) {
-			return;
-		}
-
-		switch($action) {
-			case '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject':
-				$this->onCalendarObjectCreate($objectData);
-				break;
-
-			case '\OCA\DAV\CalDAV\CalDavBackend::updateCalendarObject':
-				$this->onCalendarObjectEdit($objectData);
-				break;
-
-			case '\OCA\DAV\CalDAV\CalDavBackend::deleteCalendarObject':
-				$this->onCalendarObjectDelete($objectData);
-				break;
-
-			default:
-				break;
-		}
-	}
-
-	/**
-	 * @param array $objectData
-	 */
-	private function onCalendarObjectCreate(array $objectData):void {
-		/** @var VObject\Component\VCalendar $vcalendar */
-		$vcalendar = $this->parseCalendarData($objectData['calendardata']);
-		if (!$vcalendar) {
-			return;
-		}
-
-		$vevents = $this->getAllVEventsFromVCalendar($vcalendar);
-		if (count($vevents) === 0) {
-			return;
-		}
-
-		$uid = (string) $vevents[0]->UID;
-		$recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
-		$masterItem = $this->getMasterItemFromListOfVEvents($vevents);
-		$now = $this->timeFactory->getDateTime();
-		$isRecurring = $masterItem ? $this->isRecurring($masterItem) : false;
-
-		foreach($recurrenceExceptions as $recurrenceException) {
-			$eventHash = $this->getEventHash($recurrenceException);
-
-			foreach($recurrenceException->VALARM as $valarm) {
-				/** @var VAlarm $valarm */
-				$alarmHash = $this->getAlarmHash($valarm);
-				$triggerTime = $valarm->getEffectiveTriggerTime();
-				$diff = $now->diff($triggerTime);
-				if ($diff->invert === 1) {
-					continue;
-				}
-
-				$alarms = $this->getRemindersForVAlarm($valarm, $objectData,
-					$eventHash, $alarmHash, true, true);
-				$this->writeRemindersToDatabase($alarms);
-			}
-		}
-
-		if ($masterItem) {
-			$processedAlarms = [];
-			$masterAlarms = [];
-			$masterHash = $this->getEventHash($masterItem);
-
-			foreach($masterItem->VALARM as $valarm) {
-				$masterAlarms[] = $this->getAlarmHash($valarm);
-			}
-
-			try {
-				$iterator = new EventIterator($vevents, $uid);
-			} catch (NoInstancesException $e) {
-				// This event is recurring, but it doesn't have a single
-				// instance. We are skipping this event from the output
-				// entirely.
-				return;
-			}
-
-			while($iterator->valid() && count($processedAlarms) < count($masterAlarms)) {
-				$event = $iterator->getEventObject();
-
-				// Recurrence-exceptions are handled separately, so just ignore them here
-				if (\in_array($event, $recurrenceExceptions, true)) {
-					$iterator->next();
-					continue;
-				}
-
-				foreach($event->VALARM as $valarm) {
-					/** @var VAlarm $valarm */
-					$alarmHash = $this->getAlarmHash($valarm);
-					if (\in_array($alarmHash, $processedAlarms, true)) {
-						continue;
-					}
-
-					if (!\in_array((string) $valarm->ACTION, self::REMINDER_TYPES, true)) {
-						// Action allows x-name, we don't insert reminders
-						// into the database if they are not standard
-						$processedAlarms[] = $alarmHash;
-						continue;
-					}
-
-					$triggerTime = $valarm->getEffectiveTriggerTime();
-
-					// If effective trigger time is in the past
-					// just skip and generate for next event
-					$diff = $now->diff($triggerTime);
-					if ($diff->invert === 1) {
-						// If an absolute alarm is in the past,
-						// just add it to processedAlarms, so
-						// we don't extend till eternity
-						if (!$this->isAlarmRelative($valarm)) {
-							$processedAlarms[] = $alarmHash;
-						}
-
-						continue;
-					}
-
-					$alarms = $this->getRemindersForVAlarm($valarm, $objectData, $masterHash, $alarmHash, $isRecurring, false);
-					$this->writeRemindersToDatabase($alarms);
-					$processedAlarms[] = $alarmHash;
-				}
-
-				$iterator->next();
-			}
-		}
-	}
-
-	/**
-	 * @param array $objectData
-	 */
-	private function onCalendarObjectEdit(array $objectData):void {
-		// TODO - this can be vastly improved
-		//  - get cached reminders
-		//  - ...
-
-		$this->onCalendarObjectDelete($objectData);
-		$this->onCalendarObjectCreate($objectData);
-	}
-
-	/**
-	 * @param array $objectData
-	 */
-	private function onCalendarObjectDelete(array $objectData):void {
-		$this->backend->cleanRemindersForEvent((int) $objectData['id']);
-	}
-
-	/**
-	 * @param VAlarm $valarm
-	 * @param array $objectData
-	 * @param string|null $eventHash
-	 * @param string|null $alarmHash
-	 * @param bool $isRecurring
-	 * @param bool $isRecurrenceException
-	 * @return array
-	 */
-	private function getRemindersForVAlarm(VAlarm $valarm,
-										   array $objectData,
-										   string $eventHash=null,
-										   string $alarmHash=null,
-										   bool $isRecurring=false,
-										   bool $isRecurrenceException=false):array {
-		if ($eventHash === null) {
-			$eventHash = $this->getEventHash($valarm->parent);
-		}
-		if ($alarmHash === null) {
-			$alarmHash = $this->getAlarmHash($valarm);
-		}
-
-		$recurrenceId = $this->getEffectiveRecurrenceIdOfVEvent($valarm->parent);
-		$isRelative = $this->isAlarmRelative($valarm);
-		/** @var DateTimeImmutable $notificationDate */
-		$notificationDate = $valarm->getEffectiveTriggerTime();
-		$clonedNotificationDate = new \DateTime('now', $notificationDate->getTimezone());
-		$clonedNotificationDate->setTimestamp($notificationDate->getTimestamp());
-
-		$alarms = [];
-
-		$alarms[] = [
-			'calendar_id' => $objectData['calendarid'],
-			'object_id' => $objectData['id'],
-			'uid' => (string) $valarm->parent->UID,
-			'is_recurring' => $isRecurring,
-			'recurrence_id' => $recurrenceId,
-			'is_recurrence_exception' => $isRecurrenceException,
-			'event_hash' => $eventHash,
-			'alarm_hash' => $alarmHash,
-			'type' => (string) $valarm->ACTION,
-			'is_relative' => $isRelative,
-			'notification_date' => $notificationDate->getTimestamp(),
-			'is_repeat_based' => false,
-		];
-
-		$repeat = isset($valarm->REPEAT) ? (int) $valarm->REPEAT->getValue() : 0;
-		for($i = 0; $i < $repeat; $i++) {
-			if ($valarm->DURATION === null) {
-				continue;
-			}
-
-			$clonedNotificationDate->add($valarm->DURATION->getDateInterval());
-			$alarms[] = [
-				'calendar_id' => $objectData['calendarid'],
-				'object_id' => $objectData['id'],
-				'uid' => (string) $valarm->parent->UID,
-				'is_recurring' => $isRecurring,
-				'recurrence_id' => $recurrenceId,
-				'is_recurrence_exception' => $isRecurrenceException,
-				'event_hash' => $eventHash,
-				'alarm_hash' => $alarmHash,
-				'type' => (string) $valarm->ACTION,
-				'is_relative' => $isRelative,
-				'notification_date' => $clonedNotificationDate->getTimestamp(),
-				'is_repeat_based' => true,
-			];
-		}
-
-		return $alarms;
-	}
-
-	/**
-	 * @param array $reminders
-	 */
-	private function writeRemindersToDatabase(array $reminders): void {
-		foreach($reminders as $reminder) {
-			$this->backend->insertReminder(
-				(int) $reminder['calendar_id'],
-				(int) $reminder['object_id'],
-				$reminder['uid'],
-				$reminder['is_recurring'],
-				(int) $reminder['recurrence_id'],
-				$reminder['is_recurrence_exception'],
-				$reminder['event_hash'],
-				$reminder['alarm_hash'],
-				$reminder['type'],
-				$reminder['is_relative'],
-				(int) $reminder['notification_date'],
-				$reminder['is_repeat_based']
-			);
-		}
-	}
-
-	/**
-	 * @param array $reminder
-	 * @param VEvent $vevent
-	 */
-	private function deleteOrProcessNext(array $reminder,
-										 VObject\Component\VEvent $vevent):void {
-		if ($reminder['is_repeat_based'] ||
-			!$reminder['is_recurring'] ||
-			!$reminder['is_relative'] ||
-			$reminder['is_recurrence_exception']) {
-
-			$this->backend->removeReminder($reminder['id']);
-			return;
-		}
-
-		$vevents = $this->getAllVEventsFromVCalendar($vevent->parent);
-		$recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
-		$now = $this->timeFactory->getDateTime();
-
-		try {
-			$iterator = new EventIterator($vevents, $reminder['uid']);
-		} catch (NoInstancesException $e) {
-			// This event is recurring, but it doesn't have a single
-			// instance. We are skipping this event from the output
-			// entirely.
-			return;
-		}
-
-		while($iterator->valid()) {
-			$event = $iterator->getEventObject();
-
-			// Recurrence-exceptions are handled separately, so just ignore them here
-			if (\in_array($event, $recurrenceExceptions, true)) {
-				$iterator->next();
-				continue;
-			}
-
-			$recurrenceId = $this->getEffectiveRecurrenceIdOfVEvent($event);
-			if ($reminder['recurrence_id'] >= $recurrenceId) {
-				$iterator->next();
-				continue;
-			}
-
-			foreach($event->VALARM as $valarm) {
-				/** @var VAlarm $valarm */
-				$alarmHash = $this->getAlarmHash($valarm);
-				if ($alarmHash !== $reminder['alarm_hash']) {
-					continue;
-				}
-
-				$triggerTime = $valarm->getEffectiveTriggerTime();
-
-				// If effective trigger time is in the past
-				// just skip and generate for next event
-				$diff = $now->diff($triggerTime);
-				if ($diff->invert === 1) {
-					continue;
-				}
-
-				$this->backend->removeReminder($reminder['id']);
-				$alarms = $this->getRemindersForVAlarm($valarm, [
-					'calendarid' => $reminder['calendar_id'],
-					'id' => $reminder['object_id'],
-				], $reminder['event_hash'], $alarmHash, true, false);
-				$this->writeRemindersToDatabase($alarms);
-
-				// Abort generating reminders after creating one successfully
-				return;
-			}
-
-			$iterator->next();
-		}
-
-		$this->backend->removeReminder($reminder['id']);
-	}
-
-	/**
-	 * @param int $calendarId
-	 * @return IUser[]
-	 */
-	private function getAllUsersWithWriteAccessToCalendar(int $calendarId):array {
-		$shares = $this->caldavBackend->getShares($calendarId);
-
-		$users = [];
-		$userIds = [];
-		$groups = [];
-		foreach ($shares as $share) {
-			// Only consider writable shares
-			if ($share['readOnly']) {
-				continue;
-			}
-
-			$principal = explode('/', $share['{http://owncloud.org/ns}principal']);
-			if ($principal[1] === 'users') {
-				$user = $this->userManager->get($principal[2]);
-				if ($user) {
-					$users[] = $user;
-					$userIds[] = $principal[2];
-				}
-			} else if ($principal[1] === 'groups') {
-				$groups[] = $principal[2];
-			}
-		}
-
-		foreach ($groups as $gid) {
-			$group = $this->groupManager->get($gid);
-			if ($group instanceof IGroup) {
-				foreach ($group->getUsers() as $user) {
-					if (!\in_array($user->getUID(), $userIds, true)) {
-						$users[] = $user;
-						$userIds[] = $user->getUID();
-					}
-				}
-			}
-		}
-
-		return $users;
-	}
-
-	/**
-	 * Gets a hash of the event.
-	 * If the hash changes, we have to update all relative alarms.
-	 *
-	 * @param VEvent $vevent
-	 * @return string
-	 */
-	private function getEventHash(VEvent $vevent):string {
-		$properties = [
-			(string) $vevent->DTSTART->serialize(),
-		];
-
-		if ($vevent->DTEND) {
-			$properties[] = (string) $vevent->DTEND->serialize();
-		}
-		if ($vevent->DURATION) {
-			$properties[] = (string) $vevent->DURATION->serialize();
-		}
-		if ($vevent->{'RECURRENCE-ID'}) {
-			$properties[] = (string) $vevent->{'RECURRENCE-ID'}->serialize();
-		}
-		if ($vevent->RRULE) {
-			$properties[] = (string) $vevent->RRULE->serialize();
-		}
-		if ($vevent->EXDATE) {
-			$properties[] = (string) $vevent->EXDATE->serialize();
-		}
-		if ($vevent->RDATE) {
-			$properties[] = (string) $vevent->RDATE->serialize();
-		}
-
-		return md5(implode('::', $properties));
-	}
-
-	/**
-	 * Gets a hash of the alarm.
-	 * If the hash changes, we have to update oc_dav_reminders.
-	 *
-	 * @param VAlarm $valarm
-	 * @return string
-	 */
-	private function getAlarmHash(VAlarm $valarm):string {
-		$properties = [
-			(string) $valarm->ACTION->serialize(),
-			(string) $valarm->TRIGGER->serialize(),
-		];
-
-		if ($valarm->DURATION) {
-			$properties[] = (string) $valarm->DURATION->serialize();
-		}
-		if ($valarm->REPEAT) {
-			$properties[] = (string) $valarm->REPEAT->serialize();
-		}
-
-		return md5(implode('::', $properties));
-	}
-
-	/**
-	 * @param VObject\Component\VCalendar $vcalendar
-	 * @param int $recurrenceId
-	 * @param bool $isRecurrenceException
-	 * @return VEvent|null
-	 */
-	private function getVEventByRecurrenceId(VObject\Component\VCalendar $vcalendar,
-											 int $recurrenceId,
-											 bool $isRecurrenceException):?VEvent {
-		$vevents = $this->getAllVEventsFromVCalendar($vcalendar);
-		if (count($vevents) === 0) {
-			return null;
-		}
-
-		$uid = (string) $vevents[0]->UID;
-		$recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
-		$masterItem = $this->getMasterItemFromListOfVEvents($vevents);
-
-		// Handle recurrence-exceptions first, because recurrence-expansion is expensive
-		if ($isRecurrenceException) {
-			foreach($recurrenceExceptions as $recurrenceException) {
-				if ($this->getEffectiveRecurrenceIdOfVEvent($recurrenceException) === $recurrenceId) {
-					return $recurrenceException;
-				}
-			}
-
-			return null;
-		}
-
-		if ($masterItem) {
-			try {
-				$iterator = new EventIterator($vevents, $uid);
-			} catch (NoInstancesException $e) {
-				// This event is recurring, but it doesn't have a single
-				// instance. We are skipping this event from the output
-				// entirely.
-				return null;
-			}
-
-			while ($iterator->valid()) {
-				$event = $iterator->getEventObject();
-
-				// Recurrence-exceptions are handled separately, so just ignore them here
-				if (\in_array($event, $recurrenceExceptions, true)) {
-					$iterator->next();
-					continue;
-				}
-
-				if ($this->getEffectiveRecurrenceIdOfVEvent($event) === $recurrenceId) {
-					return $event;
-				}
-
-				$iterator->next();
-			}
-		}
-
-		return null;
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return string
-	 */
-	private function getStatusOfEvent(VEvent $vevent):string {
-		if ($vevent->STATUS) {
-			return (string) $vevent->STATUS;
-		}
-
-		// Doesn't say so in the standard,
-		// but we consider events without a status
-		// to be confirmed
-		return 'CONFIRMED';
-	}
-
-	/**
-	 * @param VObject\Component\VEvent $vevent
-	 * @return bool
-	 */
-	private function wasEventCancelled(VObject\Component\VEvent $vevent):bool {
-		return $this->getStatusOfEvent($vevent) === 'CANCELLED';
-	}
-
-	/**
-	 * @param string $calendarData
-	 * @return VObject\Component\VCalendar|null
-	 */
-	private function parseCalendarData(string $calendarData):?VObject\Component\VCalendar {
-		try {
-			return VObject\Reader::read($calendarData,
-				VObject\Reader::OPTION_FORGIVING);
-		} catch(ParseException $ex) {
-			return null;
-		}
-	}
-
-	/**
-	 * @param string $principalUri
-	 * @return IUser|null
-	 */
-	private function getUserFromPrincipalURI(string $principalUri):?IUser {
-		if (!$principalUri) {
-			return null;
-		}
-
-		if (stripos($principalUri, 'principals/users/') !== 0) {
-			return null;
-		}
-
-		$userId = substr($principalUri, 17);
-		return $this->userManager->get($userId);
-	}
-
-	/**
-	 * @param VObject\Component\VCalendar $vcalendar
-	 * @return VObject\Component\VEvent[]
-	 */
-	private function getAllVEventsFromVCalendar(VObject\Component\VCalendar $vcalendar):array {
-		$vevents = [];
-
-		foreach($vcalendar->children() as $child) {
-			if (!($child instanceof VObject\Component)) {
-				continue;
-			}
-
-			if ($child->name !== 'VEVENT') {
-				continue;
-			}
-
-			$vevents[] = $child;
-		}
-
-		return $vevents;
-	}
-
-	/**
-	 * @param array $vevents
-	 * @return VObject\Component\VEvent[]
-	 */
-	private function getRecurrenceExceptionFromListOfVEvents(array $vevents):array {
-		return array_values(array_filter($vevents, function(VEvent $vevent) {
-			return $vevent->{'RECURRENCE-ID'} !== null;
-		}));
-	}
-
-	/**
-	 * @param array $vevents
-	 * @return VEvent|null
-	 */
-	private function getMasterItemFromListOfVEvents(array $vevents):?VEvent {
-		$elements = array_values(array_filter($vevents, function(VEvent $vevent) {
-			return $vevent->{'RECURRENCE-ID'} === null;
-		}));
-
-		if (count($elements) === 0) {
-			return null;
-		}
-		if (count($elements) > 1) {
-			throw new \TypeError('Multiple master objects');
-		}
-
-		return $elements[0];
-	}
-
-	/**
-	 * @param VAlarm $valarm
-	 * @return bool
-	 */
-	private function isAlarmRelative(VAlarm $valarm):bool {
-		$trigger = $valarm->TRIGGER;
-		return $trigger instanceof VObject\Property\ICalendar\Duration;
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return int
-	 */
-	private function getEffectiveRecurrenceIdOfVEvent(VEvent $vevent):int {
-		if (isset($vevent->{'RECURRENCE-ID'})) {
-			return $vevent->{'RECURRENCE-ID'}->getDateTime()->getTimestamp();
-		}
-
-		return $vevent->DTSTART->getDateTime()->getTimestamp();
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return bool
-	 */
-	private function isRecurring(VEvent $vevent):bool {
-		return isset($vevent->RRULE) || isset($vevent->RDATE);
-	}
+    /** @var Backend */
+    private $backend;
+
+    /** @var NotificationProviderManager */
+    private $notificationProviderManager;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    /** @var IGroupManager */
+    private $groupManager;
+
+    /** @var CalDavBackend */
+    private $caldavBackend;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    public const REMINDER_TYPE_EMAIL = 'EMAIL';
+    public const REMINDER_TYPE_DISPLAY = 'DISPLAY';
+    public const REMINDER_TYPE_AUDIO = 'AUDIO';
+
+    /**
+     * @var String[]
+     *
+     * Official RFC5545 reminder types
+     */
+    public const REMINDER_TYPES = [
+        self::REMINDER_TYPE_EMAIL,
+        self::REMINDER_TYPE_DISPLAY,
+        self::REMINDER_TYPE_AUDIO
+    ];
+
+    /**
+     * ReminderService constructor.
+     *
+     * @param Backend $backend
+     * @param NotificationProviderManager $notificationProviderManager
+     * @param IUserManager $userManager
+     * @param IGroupManager $groupManager
+     * @param CalDavBackend $caldavBackend
+     * @param ITimeFactory $timeFactory
+     */
+    public function __construct(Backend $backend,
+                                NotificationProviderManager $notificationProviderManager,
+                                IUserManager $userManager,
+                                IGroupManager $groupManager,
+                                CalDavBackend $caldavBackend,
+                                ITimeFactory $timeFactory) {
+        $this->backend = $backend;
+        $this->notificationProviderManager = $notificationProviderManager;
+        $this->userManager = $userManager;
+        $this->groupManager = $groupManager;
+        $this->caldavBackend = $caldavBackend;
+        $this->timeFactory = $timeFactory;
+    }
+
+    /**
+     * Process reminders to activate
+     *
+     * @throws NotificationProvider\ProviderNotAvailableException
+     * @throws NotificationTypeDoesNotExistException
+     */
+    public function processReminders():void {
+        $reminders = $this->backend->getRemindersToProcess();
+
+        foreach($reminders as $reminder) {
+            $vcalendar = $this->parseCalendarData($reminder['calendardata']);
+            if (!$vcalendar) {
+                $this->backend->removeReminder($reminder['id']);
+                continue;
+            }
+
+            $vevent = $this->getVEventByRecurrenceId($vcalendar, $reminder['recurrence_id'], $reminder['is_recurrence_exception']);
+            if (!$vevent) {
+                $this->backend->removeReminder($reminder['id']);
+                continue;
+            }
+
+            if ($this->wasEventCancelled($vevent)) {
+                $this->deleteOrProcessNext($reminder, $vevent);
+                continue;
+            }
+
+            if (!$this->notificationProviderManager->hasProvider($reminder['type'])) {
+                $this->deleteOrProcessNext($reminder, $vevent);
+                continue;
+            }
+
+            $users = $this->getAllUsersWithWriteAccessToCalendar($reminder['calendar_id']);
+            $user = $this->getUserFromPrincipalURI($reminder['principaluri']);
+            if ($user) {
+                $users[] = $user;
+            }
+
+            $notificationProvider = $this->notificationProviderManager->getProvider($reminder['type']);
+            $notificationProvider->send($vevent, $reminder['displayname'], $users);
+
+            $this->deleteOrProcessNext($reminder, $vevent);
+        }
+    }
+
+    /**
+     * @param string $action
+     * @param array $objectData
+     * @throws VObject\InvalidDataException
+     */
+    public function onTouchCalendarObject(string $action,
+                                            array $objectData):void {
+        // We only support VEvents for now
+        if (strcasecmp($objectData['component'], 'vevent') !== 0) {
+            return;
+        }
+
+        switch($action) {
+            case '\OCA\DAV\CalDAV\CalDavBackend::createCalendarObject':
+                $this->onCalendarObjectCreate($objectData);
+                break;
+
+            case '\OCA\DAV\CalDAV\CalDavBackend::updateCalendarObject':
+                $this->onCalendarObjectEdit($objectData);
+                break;
+
+            case '\OCA\DAV\CalDAV\CalDavBackend::deleteCalendarObject':
+                $this->onCalendarObjectDelete($objectData);
+                break;
+
+            default:
+                break;
+        }
+    }
+
+    /**
+     * @param array $objectData
+     */
+    private function onCalendarObjectCreate(array $objectData):void {
+        /** @var VObject\Component\VCalendar $vcalendar */
+        $vcalendar = $this->parseCalendarData($objectData['calendardata']);
+        if (!$vcalendar) {
+            return;
+        }
+
+        $vevents = $this->getAllVEventsFromVCalendar($vcalendar);
+        if (count($vevents) === 0) {
+            return;
+        }
+
+        $uid = (string) $vevents[0]->UID;
+        $recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
+        $masterItem = $this->getMasterItemFromListOfVEvents($vevents);
+        $now = $this->timeFactory->getDateTime();
+        $isRecurring = $masterItem ? $this->isRecurring($masterItem) : false;
+
+        foreach($recurrenceExceptions as $recurrenceException) {
+            $eventHash = $this->getEventHash($recurrenceException);
+
+            foreach($recurrenceException->VALARM as $valarm) {
+                /** @var VAlarm $valarm */
+                $alarmHash = $this->getAlarmHash($valarm);
+                $triggerTime = $valarm->getEffectiveTriggerTime();
+                $diff = $now->diff($triggerTime);
+                if ($diff->invert === 1) {
+                    continue;
+                }
+
+                $alarms = $this->getRemindersForVAlarm($valarm, $objectData,
+                    $eventHash, $alarmHash, true, true);
+                $this->writeRemindersToDatabase($alarms);
+            }
+        }
+
+        if ($masterItem) {
+            $processedAlarms = [];
+            $masterAlarms = [];
+            $masterHash = $this->getEventHash($masterItem);
+
+            foreach($masterItem->VALARM as $valarm) {
+                $masterAlarms[] = $this->getAlarmHash($valarm);
+            }
+
+            try {
+                $iterator = new EventIterator($vevents, $uid);
+            } catch (NoInstancesException $e) {
+                // This event is recurring, but it doesn't have a single
+                // instance. We are skipping this event from the output
+                // entirely.
+                return;
+            }
+
+            while($iterator->valid() && count($processedAlarms) < count($masterAlarms)) {
+                $event = $iterator->getEventObject();
+
+                // Recurrence-exceptions are handled separately, so just ignore them here
+                if (\in_array($event, $recurrenceExceptions, true)) {
+                    $iterator->next();
+                    continue;
+                }
+
+                foreach($event->VALARM as $valarm) {
+                    /** @var VAlarm $valarm */
+                    $alarmHash = $this->getAlarmHash($valarm);
+                    if (\in_array($alarmHash, $processedAlarms, true)) {
+                        continue;
+                    }
+
+                    if (!\in_array((string) $valarm->ACTION, self::REMINDER_TYPES, true)) {
+                        // Action allows x-name, we don't insert reminders
+                        // into the database if they are not standard
+                        $processedAlarms[] = $alarmHash;
+                        continue;
+                    }
+
+                    $triggerTime = $valarm->getEffectiveTriggerTime();
+
+                    // If effective trigger time is in the past
+                    // just skip and generate for next event
+                    $diff = $now->diff($triggerTime);
+                    if ($diff->invert === 1) {
+                        // If an absolute alarm is in the past,
+                        // just add it to processedAlarms, so
+                        // we don't extend till eternity
+                        if (!$this->isAlarmRelative($valarm)) {
+                            $processedAlarms[] = $alarmHash;
+                        }
+
+                        continue;
+                    }
+
+                    $alarms = $this->getRemindersForVAlarm($valarm, $objectData, $masterHash, $alarmHash, $isRecurring, false);
+                    $this->writeRemindersToDatabase($alarms);
+                    $processedAlarms[] = $alarmHash;
+                }
+
+                $iterator->next();
+            }
+        }
+    }
+
+    /**
+     * @param array $objectData
+     */
+    private function onCalendarObjectEdit(array $objectData):void {
+        // TODO - this can be vastly improved
+        //  - get cached reminders
+        //  - ...
+
+        $this->onCalendarObjectDelete($objectData);
+        $this->onCalendarObjectCreate($objectData);
+    }
+
+    /**
+     * @param array $objectData
+     */
+    private function onCalendarObjectDelete(array $objectData):void {
+        $this->backend->cleanRemindersForEvent((int) $objectData['id']);
+    }
+
+    /**
+     * @param VAlarm $valarm
+     * @param array $objectData
+     * @param string|null $eventHash
+     * @param string|null $alarmHash
+     * @param bool $isRecurring
+     * @param bool $isRecurrenceException
+     * @return array
+     */
+    private function getRemindersForVAlarm(VAlarm $valarm,
+                                            array $objectData,
+                                            string $eventHash=null,
+                                            string $alarmHash=null,
+                                            bool $isRecurring=false,
+                                            bool $isRecurrenceException=false):array {
+        if ($eventHash === null) {
+            $eventHash = $this->getEventHash($valarm->parent);
+        }
+        if ($alarmHash === null) {
+            $alarmHash = $this->getAlarmHash($valarm);
+        }
+
+        $recurrenceId = $this->getEffectiveRecurrenceIdOfVEvent($valarm->parent);
+        $isRelative = $this->isAlarmRelative($valarm);
+        /** @var DateTimeImmutable $notificationDate */
+        $notificationDate = $valarm->getEffectiveTriggerTime();
+        $clonedNotificationDate = new \DateTime('now', $notificationDate->getTimezone());
+        $clonedNotificationDate->setTimestamp($notificationDate->getTimestamp());
+
+        $alarms = [];
+
+        $alarms[] = [
+            'calendar_id' => $objectData['calendarid'],
+            'object_id' => $objectData['id'],
+            'uid' => (string) $valarm->parent->UID,
+            'is_recurring' => $isRecurring,
+            'recurrence_id' => $recurrenceId,
+            'is_recurrence_exception' => $isRecurrenceException,
+            'event_hash' => $eventHash,
+            'alarm_hash' => $alarmHash,
+            'type' => (string) $valarm->ACTION,
+            'is_relative' => $isRelative,
+            'notification_date' => $notificationDate->getTimestamp(),
+            'is_repeat_based' => false,
+        ];
+
+        $repeat = isset($valarm->REPEAT) ? (int) $valarm->REPEAT->getValue() : 0;
+        for($i = 0; $i < $repeat; $i++) {
+            if ($valarm->DURATION === null) {
+                continue;
+            }
+
+            $clonedNotificationDate->add($valarm->DURATION->getDateInterval());
+            $alarms[] = [
+                'calendar_id' => $objectData['calendarid'],
+                'object_id' => $objectData['id'],
+                'uid' => (string) $valarm->parent->UID,
+                'is_recurring' => $isRecurring,
+                'recurrence_id' => $recurrenceId,
+                'is_recurrence_exception' => $isRecurrenceException,
+                'event_hash' => $eventHash,
+                'alarm_hash' => $alarmHash,
+                'type' => (string) $valarm->ACTION,
+                'is_relative' => $isRelative,
+                'notification_date' => $clonedNotificationDate->getTimestamp(),
+                'is_repeat_based' => true,
+            ];
+        }
+
+        return $alarms;
+    }
+
+    /**
+     * @param array $reminders
+     */
+    private function writeRemindersToDatabase(array $reminders): void {
+        foreach($reminders as $reminder) {
+            $this->backend->insertReminder(
+                (int) $reminder['calendar_id'],
+                (int) $reminder['object_id'],
+                $reminder['uid'],
+                $reminder['is_recurring'],
+                (int) $reminder['recurrence_id'],
+                $reminder['is_recurrence_exception'],
+                $reminder['event_hash'],
+                $reminder['alarm_hash'],
+                $reminder['type'],
+                $reminder['is_relative'],
+                (int) $reminder['notification_date'],
+                $reminder['is_repeat_based']
+            );
+        }
+    }
+
+    /**
+     * @param array $reminder
+     * @param VEvent $vevent
+     */
+    private function deleteOrProcessNext(array $reminder,
+                                            VObject\Component\VEvent $vevent):void {
+        if ($reminder['is_repeat_based'] ||
+            !$reminder['is_recurring'] ||
+            !$reminder['is_relative'] ||
+            $reminder['is_recurrence_exception']) {
+
+            $this->backend->removeReminder($reminder['id']);
+            return;
+        }
+
+        $vevents = $this->getAllVEventsFromVCalendar($vevent->parent);
+        $recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
+        $now = $this->timeFactory->getDateTime();
+
+        try {
+            $iterator = new EventIterator($vevents, $reminder['uid']);
+        } catch (NoInstancesException $e) {
+            // This event is recurring, but it doesn't have a single
+            // instance. We are skipping this event from the output
+            // entirely.
+            return;
+        }
+
+        while($iterator->valid()) {
+            $event = $iterator->getEventObject();
+
+            // Recurrence-exceptions are handled separately, so just ignore them here
+            if (\in_array($event, $recurrenceExceptions, true)) {
+                $iterator->next();
+                continue;
+            }
+
+            $recurrenceId = $this->getEffectiveRecurrenceIdOfVEvent($event);
+            if ($reminder['recurrence_id'] >= $recurrenceId) {
+                $iterator->next();
+                continue;
+            }
+
+            foreach($event->VALARM as $valarm) {
+                /** @var VAlarm $valarm */
+                $alarmHash = $this->getAlarmHash($valarm);
+                if ($alarmHash !== $reminder['alarm_hash']) {
+                    continue;
+                }
+
+                $triggerTime = $valarm->getEffectiveTriggerTime();
+
+                // If effective trigger time is in the past
+                // just skip and generate for next event
+                $diff = $now->diff($triggerTime);
+                if ($diff->invert === 1) {
+                    continue;
+                }
+
+                $this->backend->removeReminder($reminder['id']);
+                $alarms = $this->getRemindersForVAlarm($valarm, [
+                    'calendarid' => $reminder['calendar_id'],
+                    'id' => $reminder['object_id'],
+                ], $reminder['event_hash'], $alarmHash, true, false);
+                $this->writeRemindersToDatabase($alarms);
+
+                // Abort generating reminders after creating one successfully
+                return;
+            }
+
+            $iterator->next();
+        }
+
+        $this->backend->removeReminder($reminder['id']);
+    }
+
+    /**
+     * @param int $calendarId
+     * @return IUser[]
+     */
+    private function getAllUsersWithWriteAccessToCalendar(int $calendarId):array {
+        $shares = $this->caldavBackend->getShares($calendarId);
+
+        $users = [];
+        $userIds = [];
+        $groups = [];
+        foreach ($shares as $share) {
+            // Only consider writable shares
+            if ($share['readOnly']) {
+                continue;
+            }
+
+            $principal = explode('/', $share['{http://owncloud.org/ns}principal']);
+            if ($principal[1] === 'users') {
+                $user = $this->userManager->get($principal[2]);
+                if ($user) {
+                    $users[] = $user;
+                    $userIds[] = $principal[2];
+                }
+            } else if ($principal[1] === 'groups') {
+                $groups[] = $principal[2];
+            }
+        }
+
+        foreach ($groups as $gid) {
+            $group = $this->groupManager->get($gid);
+            if ($group instanceof IGroup) {
+                foreach ($group->getUsers() as $user) {
+                    if (!\in_array($user->getUID(), $userIds, true)) {
+                        $users[] = $user;
+                        $userIds[] = $user->getUID();
+                    }
+                }
+            }
+        }
+
+        return $users;
+    }
+
+    /**
+     * Gets a hash of the event.
+     * If the hash changes, we have to update all relative alarms.
+     *
+     * @param VEvent $vevent
+     * @return string
+     */
+    private function getEventHash(VEvent $vevent):string {
+        $properties = [
+            (string) $vevent->DTSTART->serialize(),
+        ];
+
+        if ($vevent->DTEND) {
+            $properties[] = (string) $vevent->DTEND->serialize();
+        }
+        if ($vevent->DURATION) {
+            $properties[] = (string) $vevent->DURATION->serialize();
+        }
+        if ($vevent->{'RECURRENCE-ID'}) {
+            $properties[] = (string) $vevent->{'RECURRENCE-ID'}->serialize();
+        }
+        if ($vevent->RRULE) {
+            $properties[] = (string) $vevent->RRULE->serialize();
+        }
+        if ($vevent->EXDATE) {
+            $properties[] = (string) $vevent->EXDATE->serialize();
+        }
+        if ($vevent->RDATE) {
+            $properties[] = (string) $vevent->RDATE->serialize();
+        }
+
+        return md5(implode('::', $properties));
+    }
+
+    /**
+     * Gets a hash of the alarm.
+     * If the hash changes, we have to update oc_dav_reminders.
+     *
+     * @param VAlarm $valarm
+     * @return string
+     */
+    private function getAlarmHash(VAlarm $valarm):string {
+        $properties = [
+            (string) $valarm->ACTION->serialize(),
+            (string) $valarm->TRIGGER->serialize(),
+        ];
+
+        if ($valarm->DURATION) {
+            $properties[] = (string) $valarm->DURATION->serialize();
+        }
+        if ($valarm->REPEAT) {
+            $properties[] = (string) $valarm->REPEAT->serialize();
+        }
+
+        return md5(implode('::', $properties));
+    }
+
+    /**
+     * @param VObject\Component\VCalendar $vcalendar
+     * @param int $recurrenceId
+     * @param bool $isRecurrenceException
+     * @return VEvent|null
+     */
+    private function getVEventByRecurrenceId(VObject\Component\VCalendar $vcalendar,
+                                                int $recurrenceId,
+                                                bool $isRecurrenceException):?VEvent {
+        $vevents = $this->getAllVEventsFromVCalendar($vcalendar);
+        if (count($vevents) === 0) {
+            return null;
+        }
+
+        $uid = (string) $vevents[0]->UID;
+        $recurrenceExceptions = $this->getRecurrenceExceptionFromListOfVEvents($vevents);
+        $masterItem = $this->getMasterItemFromListOfVEvents($vevents);
+
+        // Handle recurrence-exceptions first, because recurrence-expansion is expensive
+        if ($isRecurrenceException) {
+            foreach($recurrenceExceptions as $recurrenceException) {
+                if ($this->getEffectiveRecurrenceIdOfVEvent($recurrenceException) === $recurrenceId) {
+                    return $recurrenceException;
+                }
+            }
+
+            return null;
+        }
+
+        if ($masterItem) {
+            try {
+                $iterator = new EventIterator($vevents, $uid);
+            } catch (NoInstancesException $e) {
+                // This event is recurring, but it doesn't have a single
+                // instance. We are skipping this event from the output
+                // entirely.
+                return null;
+            }
+
+            while ($iterator->valid()) {
+                $event = $iterator->getEventObject();
+
+                // Recurrence-exceptions are handled separately, so just ignore them here
+                if (\in_array($event, $recurrenceExceptions, true)) {
+                    $iterator->next();
+                    continue;
+                }
+
+                if ($this->getEffectiveRecurrenceIdOfVEvent($event) === $recurrenceId) {
+                    return $event;
+                }
+
+                $iterator->next();
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return string
+     */
+    private function getStatusOfEvent(VEvent $vevent):string {
+        if ($vevent->STATUS) {
+            return (string) $vevent->STATUS;
+        }
+
+        // Doesn't say so in the standard,
+        // but we consider events without a status
+        // to be confirmed
+        return 'CONFIRMED';
+    }
+
+    /**
+     * @param VObject\Component\VEvent $vevent
+     * @return bool
+     */
+    private function wasEventCancelled(VObject\Component\VEvent $vevent):bool {
+        return $this->getStatusOfEvent($vevent) === 'CANCELLED';
+    }
+
+    /**
+     * @param string $calendarData
+     * @return VObject\Component\VCalendar|null
+     */
+    private function parseCalendarData(string $calendarData):?VObject\Component\VCalendar {
+        try {
+            return VObject\Reader::read($calendarData,
+                VObject\Reader::OPTION_FORGIVING);
+        } catch(ParseException $ex) {
+            return null;
+        }
+    }
+
+    /**
+     * @param string $principalUri
+     * @return IUser|null
+     */
+    private function getUserFromPrincipalURI(string $principalUri):?IUser {
+        if (!$principalUri) {
+            return null;
+        }
+
+        if (stripos($principalUri, 'principals/users/') !== 0) {
+            return null;
+        }
+
+        $userId = substr($principalUri, 17);
+        return $this->userManager->get($userId);
+    }
+
+    /**
+     * @param VObject\Component\VCalendar $vcalendar
+     * @return VObject\Component\VEvent[]
+     */
+    private function getAllVEventsFromVCalendar(VObject\Component\VCalendar $vcalendar):array {
+        $vevents = [];
+
+        foreach($vcalendar->children() as $child) {
+            if (!($child instanceof VObject\Component)) {
+                continue;
+            }
+
+            if ($child->name !== 'VEVENT') {
+                continue;
+            }
+
+            $vevents[] = $child;
+        }
+
+        return $vevents;
+    }
+
+    /**
+     * @param array $vevents
+     * @return VObject\Component\VEvent[]
+     */
+    private function getRecurrenceExceptionFromListOfVEvents(array $vevents):array {
+        return array_values(array_filter($vevents, function(VEvent $vevent) {
+            return $vevent->{'RECURRENCE-ID'} !== null;
+        }));
+    }
+
+    /**
+     * @param array $vevents
+     * @return VEvent|null
+     */
+    private function getMasterItemFromListOfVEvents(array $vevents):?VEvent {
+        $elements = array_values(array_filter($vevents, function(VEvent $vevent) {
+            return $vevent->{'RECURRENCE-ID'} === null;
+        }));
+
+        if (count($elements) === 0) {
+            return null;
+        }
+        if (count($elements) > 1) {
+            throw new \TypeError('Multiple master objects');
+        }
+
+        return $elements[0];
+    }
+
+    /**
+     * @param VAlarm $valarm
+     * @return bool
+     */
+    private function isAlarmRelative(VAlarm $valarm):bool {
+        $trigger = $valarm->TRIGGER;
+        return $trigger instanceof VObject\Property\ICalendar\Duration;
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return int
+     */
+    private function getEffectiveRecurrenceIdOfVEvent(VEvent $vevent):int {
+        if (isset($vevent->{'RECURRENCE-ID'})) {
+            return $vevent->{'RECURRENCE-ID'}->getDateTime()->getTimestamp();
+        }
+
+        return $vevent->DTSTART->getDateTime()->getTimestamp();
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return bool
+     */
+    private function isRecurring(VEvent $vevent):bool {
+        return isset($vevent->RRULE) || isset($vevent->RDATE);
+    }
 }

apps/dav/lib/CalDAV/Reminder/NotificationProviderManager.php

Indentation +42 added lines, -42 removed lines

@@ -31,51 +31,51 @@
  */
 class NotificationProviderManager {
 
-	/** @var INotificationProvider[] */
-	private $providers = [];
+    /** @var INotificationProvider[] */
+    private $providers = [];
 
-	/**
-	 * Checks whether a provider for a given ACTION exists
-	 *
-	 * @param string $type
-	 * @return bool
-	 */
-	public function hasProvider(string $type):bool {
-		return (\in_array($type, ReminderService::REMINDER_TYPES, true)
-			&& isset($this->providers[$type]));
-	}
+    /**
+     * Checks whether a provider for a given ACTION exists
+     *
+     * @param string $type
+     * @return bool
+     */
+    public function hasProvider(string $type):bool {
+        return (\in_array($type, ReminderService::REMINDER_TYPES, true)
+            && isset($this->providers[$type]));
+    }
 
-	/**
-	 * Get provider for a given ACTION
-	 *
-	 * @param string $type
-	 * @return INotificationProvider
-	 * @throws NotificationProvider\ProviderNotAvailableException
-	 * @throws NotificationTypeDoesNotExistException
-	 */
-	public function getProvider(string $type):INotificationProvider {
-		if (in_array($type, ReminderService::REMINDER_TYPES, true)) {
-			if (isset($this->providers[$type])) {
-				return $this->providers[$type];
-			}
-			throw new NotificationProvider\ProviderNotAvailableException($type);
-		}
-		throw new NotificationTypeDoesNotExistException($type);
-	}
+    /**
+     * Get provider for a given ACTION
+     *
+     * @param string $type
+     * @return INotificationProvider
+     * @throws NotificationProvider\ProviderNotAvailableException
+     * @throws NotificationTypeDoesNotExistException
+     */
+    public function getProvider(string $type):INotificationProvider {
+        if (in_array($type, ReminderService::REMINDER_TYPES, true)) {
+            if (isset($this->providers[$type])) {
+                return $this->providers[$type];
+            }
+            throw new NotificationProvider\ProviderNotAvailableException($type);
+        }
+        throw new NotificationTypeDoesNotExistException($type);
+    }
 
-	/**
-	 * Registers a new provider
-	 *
-	 * @param string $providerClassName
-	 * @throws \OCP\AppFramework\QueryException
-	 */
-	public function registerProvider(string $providerClassName):void {
-		$provider = \OC::$server->query($providerClassName);
+    /**
+     * Registers a new provider
+     *
+     * @param string $providerClassName
+     * @throws \OCP\AppFramework\QueryException
+     */
+    public function registerProvider(string $providerClassName):void {
+        $provider = \OC::$server->query($providerClassName);
 
-		if (!$provider instanceof INotificationProvider) {
-			throw new \InvalidArgumentException('Invalid notification provider registered');
-		}
+        if (!$provider instanceof INotificationProvider) {
+            throw new \InvalidArgumentException('Invalid notification provider registered');
+        }
 
-		$this->providers[$provider::NOTIFICATION_TYPE] = $provider;
-	}
+        $this->providers[$provider::NOTIFICATION_TYPE] = $provider;
+    }
 }

apps/dav/lib/CalDAV/Reminder/NotificationTypeDoesNotExistException.php

Indentation +10 added lines, -10 removed lines

@@ -26,15 +26,15 @@
 
 class NotificationTypeDoesNotExistException extends \Exception {
 
-	/**
-	 * NotificationTypeDoesNotExistException constructor.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $type ReminderType
-	 */
-	public function __construct(string $type) {
-		parent::__construct("Type $type is not an accepted type of notification");
-	}
+    /**
+     * NotificationTypeDoesNotExistException constructor.
+     *
+     * @since 16.0.0
+     *
+     * @param string $type ReminderType
+     */
+    public function __construct(string $type) {
+        parent::__construct("Type $type is not an accepted type of notification");
+    }
 
 }

apps/dav/lib/CalDAV/Reminder/NotificationProvider/AbstractProvider.php

Indentation +142 added lines, -142 removed lines

@@ -43,146 +43,146 @@
  */
 abstract class AbstractProvider implements INotificationProvider  {
 
-	/** @var string */
-	public const NOTIFICATION_TYPE = '';
-
-	/** @var ILogger */
-	protected $logger;
-
-	/** @var L10NFactory */
-	private $l10nFactory;
-
-	/** @var IL10N[] */
-	private $l10ns;
-
-	/** @var string */
-	private $fallbackLanguage;
-
-	/** @var IURLGenerator */
-	protected $urlGenerator;
-
-	/** @var IConfig */
-	protected $config;
-
-	/**
-	 * @param ILogger $logger
-	 * @param L10NFactory $l10nFactory
-	 * @param IConfig $config
-	 * @param IUrlGenerator $urlGenerator
-	 */
-	public function __construct(ILogger $logger,
-								L10NFactory $l10nFactory,
-								IURLGenerator $urlGenerator,
-								IConfig $config) {
-		$this->logger = $logger;
-		$this->l10nFactory = $l10nFactory;
-		$this->urlGenerator = $urlGenerator;
-		$this->config = $config;
-	}
-
-	/**
-	 * Send notification
-	 *
-	 * @param VEvent $vevent
-	 * @param string $calendarDisplayName
-	 * @param IUser[] $users
-	 * @return void
-	 */
-	abstract public function send(VEvent $vevent,
-						   string $calendarDisplayName,
-						   array $users=[]): void;
-
-	/**
-	 * @return string
-	 */
-	protected function getFallbackLanguage():string {
-		if ($this->fallbackLanguage) {
-			return $this->fallbackLanguage;
-		}
-
-		$fallbackLanguage = $this->l10nFactory->findLanguage();
-		$this->fallbackLanguage = $fallbackLanguage;
-
-		return $fallbackLanguage;
-	}
-
-	/**
-	 * @param string $lang
-	 * @return bool
-	 */
-	protected function hasL10NForLang(string $lang):bool {
-		return $this->l10nFactory->languageExists('dav', $lang);
-	}
-
-	/**
-	 * @param string $lang
-	 * @return IL10N
-	 */
-	protected function getL10NForLang(string $lang):IL10N {
-		if (isset($this->l10ns[$lang])) {
-			return $this->l10ns[$lang];
-		}
-
-		$l10n = $this->l10nFactory->get('dav', $lang);
-		$this->l10ns[$lang] = $l10n;
-
-		return $l10n;
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return string
-	 */
-	private function getStatusOfEvent(VEvent $vevent):string {
-		if ($vevent->STATUS) {
-			return (string) $vevent->STATUS;
-		}
-
-		// Doesn't say so in the standard,
-		// but we consider events without a status
-		// to be confirmed
-		return 'CONFIRMED';
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return bool
-	 */
-	protected function isEventTentative(VEvent $vevent):bool {
-		return $this->getStatusOfEvent($vevent) === 'TENTATIVE';
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return Property\ICalendar\DateTime
-	 */
-	protected function getDTEndFromEvent(VEvent $vevent):Property\ICalendar\DateTime {
-		if (isset($vevent->DTEND)) {
-			return $vevent->DTEND;
-		}
-
-		if (isset($vevent->DURATION)) {
-			$isFloating = $vevent->DTSTART->isFloating();
-			/** @var Property\ICalendar\DateTime $end */
-			$end = clone $vevent->DTSTART;
-			$endDateTime = $end->getDateTime();
-			$endDateTime = $endDateTime->add(DateTimeParser::parse($vevent->DURATION->getValue()));
-			$end->setDateTime($endDateTime, $isFloating);
-
-			return $end;
-		}
-
-		if (!$vevent->DTSTART->hasTime()) {
-			$isFloating = $vevent->DTSTART->isFloating();
-			/** @var Property\ICalendar\DateTime $end */
-			$end = clone $vevent->DTSTART;
-			$endDateTime = $end->getDateTime();
-			$endDateTime = $endDateTime->modify('+1 day');
-			$end->setDateTime($endDateTime, $isFloating);
-
-			return $end;
-		}
-
-		return clone $vevent->DTSTART;
-	}
+    /** @var string */
+    public const NOTIFICATION_TYPE = '';
+
+    /** @var ILogger */
+    protected $logger;
+
+    /** @var L10NFactory */
+    private $l10nFactory;
+
+    /** @var IL10N[] */
+    private $l10ns;
+
+    /** @var string */
+    private $fallbackLanguage;
+
+    /** @var IURLGenerator */
+    protected $urlGenerator;
+
+    /** @var IConfig */
+    protected $config;
+
+    /**
+     * @param ILogger $logger
+     * @param L10NFactory $l10nFactory
+     * @param IConfig $config
+     * @param IUrlGenerator $urlGenerator
+     */
+    public function __construct(ILogger $logger,
+                                L10NFactory $l10nFactory,
+                                IURLGenerator $urlGenerator,
+                                IConfig $config) {
+        $this->logger = $logger;
+        $this->l10nFactory = $l10nFactory;
+        $this->urlGenerator = $urlGenerator;
+        $this->config = $config;
+    }
+
+    /**
+     * Send notification
+     *
+     * @param VEvent $vevent
+     * @param string $calendarDisplayName
+     * @param IUser[] $users
+     * @return void
+     */
+    abstract public function send(VEvent $vevent,
+                            string $calendarDisplayName,
+                            array $users=[]): void;
+
+    /**
+     * @return string
+     */
+    protected function getFallbackLanguage():string {
+        if ($this->fallbackLanguage) {
+            return $this->fallbackLanguage;
+        }
+
+        $fallbackLanguage = $this->l10nFactory->findLanguage();
+        $this->fallbackLanguage = $fallbackLanguage;
+
+        return $fallbackLanguage;
+    }
+
+    /**
+     * @param string $lang
+     * @return bool
+     */
+    protected function hasL10NForLang(string $lang):bool {
+        return $this->l10nFactory->languageExists('dav', $lang);
+    }
+
+    /**
+     * @param string $lang
+     * @return IL10N
+     */
+    protected function getL10NForLang(string $lang):IL10N {
+        if (isset($this->l10ns[$lang])) {
+            return $this->l10ns[$lang];
+        }
+
+        $l10n = $this->l10nFactory->get('dav', $lang);
+        $this->l10ns[$lang] = $l10n;
+
+        return $l10n;
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return string
+     */
+    private function getStatusOfEvent(VEvent $vevent):string {
+        if ($vevent->STATUS) {
+            return (string) $vevent->STATUS;
+        }
+
+        // Doesn't say so in the standard,
+        // but we consider events without a status
+        // to be confirmed
+        return 'CONFIRMED';
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return bool
+     */
+    protected function isEventTentative(VEvent $vevent):bool {
+        return $this->getStatusOfEvent($vevent) === 'TENTATIVE';
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return Property\ICalendar\DateTime
+     */
+    protected function getDTEndFromEvent(VEvent $vevent):Property\ICalendar\DateTime {
+        if (isset($vevent->DTEND)) {
+            return $vevent->DTEND;
+        }
+
+        if (isset($vevent->DURATION)) {
+            $isFloating = $vevent->DTSTART->isFloating();
+            /** @var Property\ICalendar\DateTime $end */
+            $end = clone $vevent->DTSTART;
+            $endDateTime = $end->getDateTime();
+            $endDateTime = $endDateTime->add(DateTimeParser::parse($vevent->DURATION->getValue()));
+            $end->setDateTime($endDateTime, $isFloating);
+
+            return $end;
+        }
+
+        if (!$vevent->DTSTART->hasTime()) {
+            $isFloating = $vevent->DTSTART->isFloating();
+            /** @var Property\ICalendar\DateTime $end */
+            $end = clone $vevent->DTSTART;
+            $endDateTime = $end->getDateTime();
+            $endDateTime = $endDateTime->modify('+1 day');
+            $end->setDateTime($endDateTime, $isFloating);
+
+            return $end;
+        }
+
+        return clone $vevent->DTSTART;
+    }
 }

apps/dav/lib/CalDAV/Reminder/NotificationProvider/EmailProvider.php

Indentation +454 added lines, -454 removed lines

@@ -46,458 +46,458 @@
  */
 class EmailProvider extends AbstractProvider {
 
-	/** @var string */
-	public const NOTIFICATION_TYPE = 'EMAIL';
-
-	/** @var IMailer */
-	private $mailer;
-
-	/**
-	 * @param IConfig $config
-	 * @param IMailer $mailer
-	 * @param ILogger $logger
-	 * @param L10NFactory $l10nFactory
-	 * @param IUrlGenerator $urlGenerator
-	 */
-	public function __construct(IConfig $config,
-								IMailer $mailer,
-								ILogger $logger,
-								L10NFactory $l10nFactory,
-								IURLGenerator $urlGenerator) {
-		parent::__construct($logger, $l10nFactory, $urlGenerator, $config);
-		$this->mailer = $mailer;
-	}
-
-	/**
-	 * Send out notification via email
-	 *
-	 * @param VEvent $vevent
-	 * @param string $calendarDisplayName
-	 * @param array $users
-	 * @throws \Exception
-	 */
-	public function send(VEvent $vevent,
-						 string $calendarDisplayName,
-						 array $users=[]):void {
-		$fallbackLanguage = $this->getFallbackLanguage();
-
-		$emailAddressesOfSharees = $this->getEMailAddressesOfAllUsersWithWriteAccessToCalendar($users);
-		$emailAddressesOfAttendees = $this->getAllEMailAddressesFromEvent($vevent);
-
-		// Quote from php.net:
-		// If the input arrays have the same string keys, then the later value for that key will overwrite the previous one.
-		// => if there are duplicate email addresses, it will always take the system value
-		$emailAddresses = array_merge(
-			$emailAddressesOfAttendees,
-			$emailAddressesOfSharees
-		);
-
-		$sortedByLanguage = $this->sortEMailAddressesByLanguage($emailAddresses, $fallbackLanguage);
-		$organizer = $this->getOrganizerEMailAndNameFromEvent($vevent);
-
-		foreach($sortedByLanguage as $lang => $emailAddresses) {
-			if (!$this->hasL10NForLang($lang)) {
-				$lang = $fallbackLanguage;
-			}
-			$l10n = $this->getL10NForLang($lang);
-			$fromEMail = \OCP\Util::getDefaultEmailAddress('reminders-noreply');
-
-			$template = $this->mailer->createEMailTemplate('dav.calendarReminder');
-			$template->addHeader();
-			$this->addSubjectAndHeading($template, $l10n, $vevent);
-			$this->addBulletList($template, $l10n, $calendarDisplayName, $vevent);
-			$template->addFooter();
-
-			foreach ($emailAddresses as $emailAddress) {
-				$message = $this->mailer->createMessage();
-				$message->setFrom([$fromEMail]);
-				if ($organizer) {
-					$message->setReplyTo($organizer);
-				}
-				$message->setTo([$emailAddress]);
-				$message->useTemplate($template);
-
-				try {
-					$failed = $this->mailer->send($message);
-					if ($failed) {
-						$this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' => implode(', ', $failed)]);
-					}
-				} catch (\Exception $ex) {
-					$this->logger->logException($ex, ['app' => 'dav']);
-				}
-			}
-		}
-	}
-
-	/**
-	 * @param IEMailTemplate $template
-	 * @param IL10N $l10n
-	 * @param VEvent $vevent
-	 */
-	private function addSubjectAndHeading(IEMailTemplate $template, IL10N $l10n, VEvent $vevent):void {
-		$template->setSubject('Notification: ' . $this->getTitleFromVEvent($vevent, $l10n));
-		$template->addHeading($this->getTitleFromVEvent($vevent, $l10n));
-	}
-
-	/**
-	 * @param IEMailTemplate $template
-	 * @param IL10N $l10n
-	 * @param string $calendarDisplayName
-	 * @param array $eventData
-	 */
-	private function addBulletList(IEMailTemplate $template,
-								   IL10N $l10n,
-								   string $calendarDisplayName,
-								   VEvent $vevent):void {
-		$template->addBodyListItem($calendarDisplayName, $l10n->t('Calendar:'),
-			$this->getAbsoluteImagePath('actions/info.svg'));
-
-		$template->addBodyListItem($this->generateDateString($l10n, $vevent), $l10n->t('Date:'),
-			$this->getAbsoluteImagePath('places/calendar.svg'));
-
-		if (isset($vevent->LOCATION)) {
-			$template->addBodyListItem((string) $vevent->LOCATION, $l10n->t('Where:'),
-				$this->getAbsoluteImagePath('actions/address.svg'));
-		}
-		if (isset($vevent->DESCRIPTION)) {
-			$template->addBodyListItem((string) $vevent->DESCRIPTION, $l10n->t('Description:'),
-				$this->getAbsoluteImagePath('actions/more.svg'));
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return string
-	 */
-	private function getAbsoluteImagePath(string $path):string {
-		return $this->urlGenerator->getAbsoluteURL(
-			$this->urlGenerator->imagePath('core', $path)
-		);
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return array|null
-	 */
-	private function getOrganizerEMailAndNameFromEvent(VEvent $vevent):?array {
-		if (!$vevent->ORGANIZER) {
-			return null;
-		}
-
-		$organizer = $vevent->ORGANIZER;
-		if (strcasecmp($organizer->getValue(), 'mailto:') !== 0) {
-			return null;
-		}
-
-		$organizerEMail = substr($organizer->getValue(), 7);
-
-		$name = $organizer->offsetGet('CN');
-		if ($name instanceof Parameter) {
-			return [$organizerEMail => $name];
-		}
-
-		return [$organizerEMail];
-	}
-
-	/**
-	 * @param array $emails
-	 * @param string $defaultLanguage
-	 * @return array
-	 */
-	private function sortEMailAddressesByLanguage(array $emails,
-												  string $defaultLanguage):array {
-		$sortedByLanguage = [];
-
-		foreach($emails as $emailAddress => $parameters) {
-			if (isset($parameters['LANG'])) {
-				$lang = $parameters['LANG'];
-			} else {
-				$lang = $defaultLanguage;
-			}
-
-			if (!isset($sortedByLanguage[$lang])) {
-				$sortedByLanguage[$lang] = [];
-			}
-
-			$sortedByLanguage[$lang][] = $emailAddress;
-		}
-
-		return $sortedByLanguage;
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return array
-	 */
-	private function getAllEMailAddressesFromEvent(VEvent $vevent):array {
-		$emailAddresses = [];
-
-		if (isset($vevent->ATTENDEE)) {
-			foreach ($vevent->ATTENDEE as $attendee) {
-				if (!($attendee instanceof VObject\Property)) {
-					continue;
-				}
-
-				$cuType = $this->getCUTypeOfAttendee($attendee);
-				if (\in_array($cuType, ['RESOURCE', 'ROOM', 'UNKNOWN'])) {
-					// Don't send emails to things
-					continue;
-				}
-
-				$partstat = $this->getPartstatOfAttendee($attendee);
-				if ($partstat === 'DECLINED') {
-					// Don't send out emails to people who declined
-					continue;
-				}
-				if ($partstat === 'DELEGATED') {
-					$delegates = $attendee->offsetGet('DELEGATED-TO');
-					if (!($delegates instanceof VObject\Parameter)) {
-						continue;
-					}
-
-					$emailAddressesOfDelegates = $delegates->getParts();
-					foreach($emailAddressesOfDelegates as $addressesOfDelegate) {
-						if (strcasecmp($addressesOfDelegate, 'mailto:') === 0) {
-							$emailAddresses[substr($addressesOfDelegate, 7)] = [];
-						}
-					}
-
-					continue;
-				}
-
-				$emailAddressOfAttendee = $this->getEMailAddressOfAttendee($attendee);
-				if ($emailAddressOfAttendee !== null) {
-					$properties = [];
-
-					$langProp = $attendee->offsetGet('LANG');
-					if ($langProp instanceof VObject\Parameter) {
-						$properties['LANG'] = $langProp->getValue();
-					}
-
-					$emailAddresses[$emailAddressOfAttendee] = $properties;
-				}
-			}
-		}
-
-		if (isset($vevent->ORGANIZER) && $this->hasAttendeeMailURI($vevent->ORGANIZER)) {
-			$emailAddresses[$this->getEMailAddressOfAttendee($vevent->ORGANIZER)] = [];
-		}
-
-		return $emailAddresses;
-	}
-
-
-
-	/**
-	 * @param VObject\Property $attendee
-	 * @return string
-	 */
-	private function getCUTypeOfAttendee(VObject\Property $attendee):string {
-		$cuType = $attendee->offsetGet('CUTYPE');
-		if ($cuType instanceof VObject\Parameter) {
-			return strtoupper($cuType->getValue());
-		}
-
-		return 'INDIVIDUAL';
-	}
-
-	/**
-	 * @param VObject\Property $attendee
-	 * @return string
-	 */
-	private function getPartstatOfAttendee(VObject\Property $attendee):string {
-		$partstat = $attendee->offsetGet('PARTSTAT');
-		if ($partstat instanceof VObject\Parameter) {
-			return strtoupper($partstat->getValue());
-		}
-
-		return 'NEEDS-ACTION';
-	}
-
-	/**
-	 * @param VObject\Property $attendee
-	 * @return bool
-	 */
-	private function hasAttendeeMailURI(VObject\Property $attendee):bool {
-		return stripos($attendee->getValue(), 'mailto:') === 0;
-	}
-
-	/**
-	 * @param VObject\Property $attendee
-	 * @return string|null
-	 */
-	private function getEMailAddressOfAttendee(VObject\Property $attendee):?string {
-		if (!$this->hasAttendeeMailURI($attendee)) {
-			return null;
-		}
-
-		return substr($attendee->getValue(), 7);
-	}
-
-	/**
-	 * @param array $users
-	 * @return array
-	 */
-	private function getEMailAddressesOfAllUsersWithWriteAccessToCalendar(array $users):array {
-		$emailAddresses = [];
-
-		foreach($users as $user) {
-			$emailAddress = $user->getEMailAddress();
-			if ($emailAddress) {
-				$lang = $this->getLangForUser($user);
-				if ($lang) {
-					$emailAddresses[$emailAddress] = [
-						'LANG' => $lang,
-					];
-				} else {
-					$emailAddresses[$emailAddress] = [];
-				}
-			}
-		}
-
-		return $emailAddresses;
-	}
-
-	/**
-	 * @param IUser $user
-	 * @return string
-	 */
-	private function getLangForUser(IUser $user): ?string {
-		return $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
-	}
-
-	/**
-	 * @param IL10N $l10n
-	 * @param VEvent $vevent
-	 * @return string
-	 * @throws \Exception
-	 */
-	private function generateDateString(IL10N $l10n, VEvent $vevent):string {
-		$isAllDay = $vevent->DTSTART instanceof Property\ICalendar\Date;
-
-		/** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtstart */
-		/** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtend */
-		/** @var \DateTimeImmutable $dtstartDt */
-		$dtstartDt = $vevent->DTSTART->getDateTime();
-		/** @var \DateTimeImmutable $dtendDt */
-		$dtendDt = $this->getDTEndFromEvent($vevent)->getDateTime();
-
-		$diff = $dtstartDt->diff($dtendDt);
-
-		/** @phan-suppress-next-line PhanUndeclaredClassMethod */
-		$dtstartDt = new \DateTime($dtstartDt->format(\DateTime::ATOM));
-		/** @phan-suppress-next-line PhanUndeclaredClassMethod */
-		$dtendDt = new \DateTime($dtendDt->format(\DateTime::ATOM));
-
-		if ($isAllDay) {
-			// One day event
-			if ($diff->days === 1) {
-				return $this->getDateString($l10n, $dtstartDt);
-			}
-
-			return implode(' - ', [
-				$this->getDateString($l10n, $dtstartDt),
-				$this->getDateString($l10n, $dtendDt),
-			]);
-		}
-
-		$startTimezone = $endTimezone = null;
-		if (!$vevent->DTSTART->isFloating()) {
-			/** @phan-suppress-next-line PhanUndeclaredClassMethod */
-			$startTimezone = $vevent->DTSTART->getDateTime()->getTimezone()->getName();
-			/** @phan-suppress-next-line PhanUndeclaredClassMethod */
-			$endTimezone = $this->getDTEndFromEvent($vevent)->getDateTime()->getTimezone()->getName();
-		}
-
-		$localeStart = implode(', ', [
-			$this->getWeekDayName($l10n, $dtstartDt),
-			$this->getDateTimeString($l10n, $dtstartDt)
-		]);
-
-		// always show full date with timezone if timezones are different
-		if ($startTimezone !== $endTimezone) {
-			$localeEnd = implode(', ', [
-				$this->getWeekDayName($l10n, $dtendDt),
-				$this->getDateTimeString($l10n, $dtendDt)
-			]);
-
-			return $localeStart
-				. ' (' . $startTimezone . ') '
-				. ' - '
-				. $localeEnd
-				. ' (' . $endTimezone . ')';
-		}
-
-		// Show only the time if the day is the same
-		$localeEnd = $this->isDayEqual($dtstartDt, $dtendDt)
-			? $this->getTimeString($l10n, $dtendDt)
-			: implode(', ', [
-				$this->getWeekDayName($l10n, $dtendDt),
-				$this->getDateTimeString($l10n, $dtendDt)
-			]);
-
-		return $localeStart
-			. ' - '
-			. $localeEnd
-			. ' (' . $startTimezone . ')';
-	}
-
-	/**
-	 * @param DateTime $dtStart
-	 * @param DateTime $dtEnd
-	 * @return bool
-	 */
-	private function isDayEqual(DateTime $dtStart,
-								DateTime $dtEnd):bool {
-		return $dtStart->format('Y-m-d') === $dtEnd->format('Y-m-d');
-	}
-
-	/**
-	 * @param IL10N $l10n
-	 * @param DateTime $dt
-	 * @return string
-	 */
-	private function getWeekDayName(IL10N $l10n, DateTime $dt):string {
-		return $l10n->l('weekdayName', $dt, ['width' => 'abbreviated']);
-	}
-
-	/**
-	 * @param IL10N $l10n
-	 * @param DateTime $dt
-	 * @return string
-	 */
-	private function getDateString(IL10N $l10n, DateTime $dt):string {
-		return $l10n->l('date', $dt, ['width' => 'medium']);
-	}
-
-	/**
-	 * @param IL10N $l10n
-	 * @param DateTime $dt
-	 * @return string
-	 */
-	private function getDateTimeString(IL10N $l10n, DateTime $dt):string {
-		return $l10n->l('datetime', $dt, ['width' => 'medium|short']);
-	}
-
-	/**
-	 * @param IL10N $l10n
-	 * @param DateTime $dt
-	 * @return string
-	 */
-	private function getTimeString(IL10N $l10n, DateTime $dt):string {
-		return $l10n->l('time', $dt, ['width' => 'short']);
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @param IL10N $l10n
-	 * @return string
-	 */
-	private function getTitleFromVEvent(VEvent $vevent, IL10N $l10n):string {
-		if (isset($vevent->SUMMARY)) {
-			return (string)$vevent->SUMMARY;
-		}
-
-		return $l10n->t('Untitled event');
-	}
+    /** @var string */
+    public const NOTIFICATION_TYPE = 'EMAIL';
+
+    /** @var IMailer */
+    private $mailer;
+
+    /**
+     * @param IConfig $config
+     * @param IMailer $mailer
+     * @param ILogger $logger
+     * @param L10NFactory $l10nFactory
+     * @param IUrlGenerator $urlGenerator
+     */
+    public function __construct(IConfig $config,
+                                IMailer $mailer,
+                                ILogger $logger,
+                                L10NFactory $l10nFactory,
+                                IURLGenerator $urlGenerator) {
+        parent::__construct($logger, $l10nFactory, $urlGenerator, $config);
+        $this->mailer = $mailer;
+    }
+
+    /**
+     * Send out notification via email
+     *
+     * @param VEvent $vevent
+     * @param string $calendarDisplayName
+     * @param array $users
+     * @throws \Exception
+     */
+    public function send(VEvent $vevent,
+                            string $calendarDisplayName,
+                            array $users=[]):void {
+        $fallbackLanguage = $this->getFallbackLanguage();
+
+        $emailAddressesOfSharees = $this->getEMailAddressesOfAllUsersWithWriteAccessToCalendar($users);
+        $emailAddressesOfAttendees = $this->getAllEMailAddressesFromEvent($vevent);
+
+        // Quote from php.net:
+        // If the input arrays have the same string keys, then the later value for that key will overwrite the previous one.
+        // => if there are duplicate email addresses, it will always take the system value
+        $emailAddresses = array_merge(
+            $emailAddressesOfAttendees,
+            $emailAddressesOfSharees
+        );
+
+        $sortedByLanguage = $this->sortEMailAddressesByLanguage($emailAddresses, $fallbackLanguage);
+        $organizer = $this->getOrganizerEMailAndNameFromEvent($vevent);
+
+        foreach($sortedByLanguage as $lang => $emailAddresses) {
+            if (!$this->hasL10NForLang($lang)) {
+                $lang = $fallbackLanguage;
+            }
+            $l10n = $this->getL10NForLang($lang);
+            $fromEMail = \OCP\Util::getDefaultEmailAddress('reminders-noreply');
+
+            $template = $this->mailer->createEMailTemplate('dav.calendarReminder');
+            $template->addHeader();
+            $this->addSubjectAndHeading($template, $l10n, $vevent);
+            $this->addBulletList($template, $l10n, $calendarDisplayName, $vevent);
+            $template->addFooter();
+
+            foreach ($emailAddresses as $emailAddress) {
+                $message = $this->mailer->createMessage();
+                $message->setFrom([$fromEMail]);
+                if ($organizer) {
+                    $message->setReplyTo($organizer);
+                }
+                $message->setTo([$emailAddress]);
+                $message->useTemplate($template);
+
+                try {
+                    $failed = $this->mailer->send($message);
+                    if ($failed) {
+                        $this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' => implode(', ', $failed)]);
+                    }
+                } catch (\Exception $ex) {
+                    $this->logger->logException($ex, ['app' => 'dav']);
+                }
+            }
+        }
+    }
+
+    /**
+     * @param IEMailTemplate $template
+     * @param IL10N $l10n
+     * @param VEvent $vevent
+     */
+    private function addSubjectAndHeading(IEMailTemplate $template, IL10N $l10n, VEvent $vevent):void {
+        $template->setSubject('Notification: ' . $this->getTitleFromVEvent($vevent, $l10n));
+        $template->addHeading($this->getTitleFromVEvent($vevent, $l10n));
+    }
+
+    /**
+     * @param IEMailTemplate $template
+     * @param IL10N $l10n
+     * @param string $calendarDisplayName
+     * @param array $eventData
+     */
+    private function addBulletList(IEMailTemplate $template,
+                                    IL10N $l10n,
+                                    string $calendarDisplayName,
+                                    VEvent $vevent):void {
+        $template->addBodyListItem($calendarDisplayName, $l10n->t('Calendar:'),
+            $this->getAbsoluteImagePath('actions/info.svg'));
+
+        $template->addBodyListItem($this->generateDateString($l10n, $vevent), $l10n->t('Date:'),
+            $this->getAbsoluteImagePath('places/calendar.svg'));
+
+        if (isset($vevent->LOCATION)) {
+            $template->addBodyListItem((string) $vevent->LOCATION, $l10n->t('Where:'),
+                $this->getAbsoluteImagePath('actions/address.svg'));
+        }
+        if (isset($vevent->DESCRIPTION)) {
+            $template->addBodyListItem((string) $vevent->DESCRIPTION, $l10n->t('Description:'),
+                $this->getAbsoluteImagePath('actions/more.svg'));
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return string
+     */
+    private function getAbsoluteImagePath(string $path):string {
+        return $this->urlGenerator->getAbsoluteURL(
+            $this->urlGenerator->imagePath('core', $path)
+        );
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return array|null
+     */
+    private function getOrganizerEMailAndNameFromEvent(VEvent $vevent):?array {
+        if (!$vevent->ORGANIZER) {
+            return null;
+        }
+
+        $organizer = $vevent->ORGANIZER;
+        if (strcasecmp($organizer->getValue(), 'mailto:') !== 0) {
+            return null;
+        }
+
+        $organizerEMail = substr($organizer->getValue(), 7);
+
+        $name = $organizer->offsetGet('CN');
+        if ($name instanceof Parameter) {
+            return [$organizerEMail => $name];
+        }
+
+        return [$organizerEMail];
+    }
+
+    /**
+     * @param array $emails
+     * @param string $defaultLanguage
+     * @return array
+     */
+    private function sortEMailAddressesByLanguage(array $emails,
+                                                    string $defaultLanguage):array {
+        $sortedByLanguage = [];
+
+        foreach($emails as $emailAddress => $parameters) {
+            if (isset($parameters['LANG'])) {
+                $lang = $parameters['LANG'];
+            } else {
+                $lang = $defaultLanguage;
+            }
+
+            if (!isset($sortedByLanguage[$lang])) {
+                $sortedByLanguage[$lang] = [];
+            }
+
+            $sortedByLanguage[$lang][] = $emailAddress;
+        }
+
+        return $sortedByLanguage;
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return array
+     */
+    private function getAllEMailAddressesFromEvent(VEvent $vevent):array {
+        $emailAddresses = [];
+
+        if (isset($vevent->ATTENDEE)) {
+            foreach ($vevent->ATTENDEE as $attendee) {
+                if (!($attendee instanceof VObject\Property)) {
+                    continue;
+                }
+
+                $cuType = $this->getCUTypeOfAttendee($attendee);
+                if (\in_array($cuType, ['RESOURCE', 'ROOM', 'UNKNOWN'])) {
+                    // Don't send emails to things
+                    continue;
+                }
+
+                $partstat = $this->getPartstatOfAttendee($attendee);
+                if ($partstat === 'DECLINED') {
+                    // Don't send out emails to people who declined
+                    continue;
+                }
+                if ($partstat === 'DELEGATED') {
+                    $delegates = $attendee->offsetGet('DELEGATED-TO');
+                    if (!($delegates instanceof VObject\Parameter)) {
+                        continue;
+                    }
+
+                    $emailAddressesOfDelegates = $delegates->getParts();
+                    foreach($emailAddressesOfDelegates as $addressesOfDelegate) {
+                        if (strcasecmp($addressesOfDelegate, 'mailto:') === 0) {
+                            $emailAddresses[substr($addressesOfDelegate, 7)] = [];
+                        }
+                    }
+
+                    continue;
+                }
+
+                $emailAddressOfAttendee = $this->getEMailAddressOfAttendee($attendee);
+                if ($emailAddressOfAttendee !== null) {
+                    $properties = [];
+
+                    $langProp = $attendee->offsetGet('LANG');
+                    if ($langProp instanceof VObject\Parameter) {
+                        $properties['LANG'] = $langProp->getValue();
+                    }
+
+                    $emailAddresses[$emailAddressOfAttendee] = $properties;
+                }
+            }
+        }
+
+        if (isset($vevent->ORGANIZER) && $this->hasAttendeeMailURI($vevent->ORGANIZER)) {
+            $emailAddresses[$this->getEMailAddressOfAttendee($vevent->ORGANIZER)] = [];
+        }
+
+        return $emailAddresses;
+    }
+
+
+
+    /**
+     * @param VObject\Property $attendee
+     * @return string
+     */
+    private function getCUTypeOfAttendee(VObject\Property $attendee):string {
+        $cuType = $attendee->offsetGet('CUTYPE');
+        if ($cuType instanceof VObject\Parameter) {
+            return strtoupper($cuType->getValue());
+        }
+
+        return 'INDIVIDUAL';
+    }
+
+    /**
+     * @param VObject\Property $attendee
+     * @return string
+     */
+    private function getPartstatOfAttendee(VObject\Property $attendee):string {
+        $partstat = $attendee->offsetGet('PARTSTAT');
+        if ($partstat instanceof VObject\Parameter) {
+            return strtoupper($partstat->getValue());
+        }
+
+        return 'NEEDS-ACTION';
+    }
+
+    /**
+     * @param VObject\Property $attendee
+     * @return bool
+     */
+    private function hasAttendeeMailURI(VObject\Property $attendee):bool {
+        return stripos($attendee->getValue(), 'mailto:') === 0;
+    }
+
+    /**
+     * @param VObject\Property $attendee
+     * @return string|null
+     */
+    private function getEMailAddressOfAttendee(VObject\Property $attendee):?string {
+        if (!$this->hasAttendeeMailURI($attendee)) {
+            return null;
+        }
+
+        return substr($attendee->getValue(), 7);
+    }
+
+    /**
+     * @param array $users
+     * @return array
+     */
+    private function getEMailAddressesOfAllUsersWithWriteAccessToCalendar(array $users):array {
+        $emailAddresses = [];
+
+        foreach($users as $user) {
+            $emailAddress = $user->getEMailAddress();
+            if ($emailAddress) {
+                $lang = $this->getLangForUser($user);
+                if ($lang) {
+                    $emailAddresses[$emailAddress] = [
+                        'LANG' => $lang,
+                    ];
+                } else {
+                    $emailAddresses[$emailAddress] = [];
+                }
+            }
+        }
+
+        return $emailAddresses;
+    }
+
+    /**
+     * @param IUser $user
+     * @return string
+     */
+    private function getLangForUser(IUser $user): ?string {
+        return $this->config->getUserValue($user->getUID(), 'core', 'lang', null);
+    }
+
+    /**
+     * @param IL10N $l10n
+     * @param VEvent $vevent
+     * @return string
+     * @throws \Exception
+     */
+    private function generateDateString(IL10N $l10n, VEvent $vevent):string {
+        $isAllDay = $vevent->DTSTART instanceof Property\ICalendar\Date;
+
+        /** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtstart */
+        /** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtend */
+        /** @var \DateTimeImmutable $dtstartDt */
+        $dtstartDt = $vevent->DTSTART->getDateTime();
+        /** @var \DateTimeImmutable $dtendDt */
+        $dtendDt = $this->getDTEndFromEvent($vevent)->getDateTime();
+
+        $diff = $dtstartDt->diff($dtendDt);
+
+        /** @phan-suppress-next-line PhanUndeclaredClassMethod */
+        $dtstartDt = new \DateTime($dtstartDt->format(\DateTime::ATOM));
+        /** @phan-suppress-next-line PhanUndeclaredClassMethod */
+        $dtendDt = new \DateTime($dtendDt->format(\DateTime::ATOM));
+
+        if ($isAllDay) {
+            // One day event
+            if ($diff->days === 1) {
+                return $this->getDateString($l10n, $dtstartDt);
+            }
+
+            return implode(' - ', [
+                $this->getDateString($l10n, $dtstartDt),
+                $this->getDateString($l10n, $dtendDt),
+            ]);
+        }
+
+        $startTimezone = $endTimezone = null;
+        if (!$vevent->DTSTART->isFloating()) {
+            /** @phan-suppress-next-line PhanUndeclaredClassMethod */
+            $startTimezone = $vevent->DTSTART->getDateTime()->getTimezone()->getName();
+            /** @phan-suppress-next-line PhanUndeclaredClassMethod */
+            $endTimezone = $this->getDTEndFromEvent($vevent)->getDateTime()->getTimezone()->getName();
+        }
+
+        $localeStart = implode(', ', [
+            $this->getWeekDayName($l10n, $dtstartDt),
+            $this->getDateTimeString($l10n, $dtstartDt)
+        ]);
+
+        // always show full date with timezone if timezones are different
+        if ($startTimezone !== $endTimezone) {
+            $localeEnd = implode(', ', [
+                $this->getWeekDayName($l10n, $dtendDt),
+                $this->getDateTimeString($l10n, $dtendDt)
+            ]);
+
+            return $localeStart
+                . ' (' . $startTimezone . ') '
+                . ' - '
+                . $localeEnd
+                . ' (' . $endTimezone . ')';
+        }
+
+        // Show only the time if the day is the same
+        $localeEnd = $this->isDayEqual($dtstartDt, $dtendDt)
+            ? $this->getTimeString($l10n, $dtendDt)
+            : implode(', ', [
+                $this->getWeekDayName($l10n, $dtendDt),
+                $this->getDateTimeString($l10n, $dtendDt)
+            ]);
+
+        return $localeStart
+            . ' - '
+            . $localeEnd
+            . ' (' . $startTimezone . ')';
+    }
+
+    /**
+     * @param DateTime $dtStart
+     * @param DateTime $dtEnd
+     * @return bool
+     */
+    private function isDayEqual(DateTime $dtStart,
+                                DateTime $dtEnd):bool {
+        return $dtStart->format('Y-m-d') === $dtEnd->format('Y-m-d');
+    }
+
+    /**
+     * @param IL10N $l10n
+     * @param DateTime $dt
+     * @return string
+     */
+    private function getWeekDayName(IL10N $l10n, DateTime $dt):string {
+        return $l10n->l('weekdayName', $dt, ['width' => 'abbreviated']);
+    }
+
+    /**
+     * @param IL10N $l10n
+     * @param DateTime $dt
+     * @return string
+     */
+    private function getDateString(IL10N $l10n, DateTime $dt):string {
+        return $l10n->l('date', $dt, ['width' => 'medium']);
+    }
+
+    /**
+     * @param IL10N $l10n
+     * @param DateTime $dt
+     * @return string
+     */
+    private function getDateTimeString(IL10N $l10n, DateTime $dt):string {
+        return $l10n->l('datetime', $dt, ['width' => 'medium|short']);
+    }
+
+    /**
+     * @param IL10N $l10n
+     * @param DateTime $dt
+     * @return string
+     */
+    private function getTimeString(IL10N $l10n, DateTime $dt):string {
+        return $l10n->l('time', $dt, ['width' => 'short']);
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @param IL10N $l10n
+     * @return string
+     */
+    private function getTitleFromVEvent(VEvent $vevent, IL10N $l10n):string {
+        if (isset($vevent->SUMMARY)) {
+            return (string)$vevent->SUMMARY;
+        }
+
+        return $l10n->t('Untitled event');
+    }
 }

apps/dav/lib/CalDAV/Reminder/NotificationProvider/PushProvider.php

Indentation +84 added lines, -84 removed lines

@@ -44,96 +44,96 @@
  */
 class PushProvider extends AbstractProvider {
 
-	/** @var string */
-	public const NOTIFICATION_TYPE = 'DISPLAY';
+    /** @var string */
+    public const NOTIFICATION_TYPE = 'DISPLAY';
 
-	/** @var IManager */
-	private $manager;
+    /** @var IManager */
+    private $manager;
 
-	/** @var ITimeFactory */
-	private $timeFactory;
+    /** @var ITimeFactory */
+    private $timeFactory;
 
-	/**
-	 * @param IConfig $config
-	 * @param IManager $manager
-	 * @param ILogger $logger
-	 * @param L10NFactory $l10nFactory
-	 * @param IUrlGenerator $urlGenerator
-	 * @param ITimeFactory $timeFactory
-	 */
-	public function __construct(IConfig $config,
-								IManager $manager,
-								ILogger $logger,
-								L10NFactory $l10nFactory,
-								IURLGenerator $urlGenerator,
-								ITimeFactory $timeFactory) {
-		parent::__construct($logger, $l10nFactory, $urlGenerator, $config);
-		$this->manager = $manager;
-		$this->timeFactory = $timeFactory;
-	}
+    /**
+     * @param IConfig $config
+     * @param IManager $manager
+     * @param ILogger $logger
+     * @param L10NFactory $l10nFactory
+     * @param IUrlGenerator $urlGenerator
+     * @param ITimeFactory $timeFactory
+     */
+    public function __construct(IConfig $config,
+                                IManager $manager,
+                                ILogger $logger,
+                                L10NFactory $l10nFactory,
+                                IURLGenerator $urlGenerator,
+                                ITimeFactory $timeFactory) {
+        parent::__construct($logger, $l10nFactory, $urlGenerator, $config);
+        $this->manager = $manager;
+        $this->timeFactory = $timeFactory;
+    }
 
-	/**
-	 * Send push notification to all users.
-	 *
-	 * @param VEvent $vevent
-	 * @param string $calendarDisplayName
-	 * @param IUser[] $users
-	 * @throws \Exception
-	 */
-	public function send(VEvent $vevent,
-						 string $calendarDisplayName=null,
-						 array $users=[]):void {
-		$eventDetails = $this->extractEventDetails($vevent);
-		$eventDetails['calendar_displayname'] = $calendarDisplayName;
+    /**
+     * Send push notification to all users.
+     *
+     * @param VEvent $vevent
+     * @param string $calendarDisplayName
+     * @param IUser[] $users
+     * @throws \Exception
+     */
+    public function send(VEvent $vevent,
+                            string $calendarDisplayName=null,
+                            array $users=[]):void {
+        $eventDetails = $this->extractEventDetails($vevent);
+        $eventDetails['calendar_displayname'] = $calendarDisplayName;
 
-		foreach($users as $user) {
-			/** @var INotification $notification */
-			$notification = $this->manager->createNotification();
-			$notification->setApp(Application::APP_ID)
-				->setUser($user->getUID())
-				->setDateTime($this->timeFactory->getDateTime())
-				->setObject(Application::APP_ID, (string) $vevent->UID)
-				->setSubject('calendar_reminder', [
-					'title' => $eventDetails['title'],
-					'start_atom' => $eventDetails['start_atom']
-				])
-				->setMessage('calendar_reminder', $eventDetails);
+        foreach($users as $user) {
+            /** @var INotification $notification */
+            $notification = $this->manager->createNotification();
+            $notification->setApp(Application::APP_ID)
+                ->setUser($user->getUID())
+                ->setDateTime($this->timeFactory->getDateTime())
+                ->setObject(Application::APP_ID, (string) $vevent->UID)
+                ->setSubject('calendar_reminder', [
+                    'title' => $eventDetails['title'],
+                    'start_atom' => $eventDetails['start_atom']
+                ])
+                ->setMessage('calendar_reminder', $eventDetails);
 
-			$this->manager->notify($notification);
-		}
-	}
+            $this->manager->notify($notification);
+        }
+    }
 
-	/**
-	 * @var VEvent $vevent
-	 * @return array
-	 * @throws \Exception
-	 */
-	protected function extractEventDetails(VEvent $vevent):array {
-		/** @var Property\ICalendar\DateTime $start */
-		$start = $vevent->DTSTART;
-		$end = $this->getDTEndFromEvent($vevent);
+    /**
+     * @var VEvent $vevent
+     * @return array
+     * @throws \Exception
+     */
+    protected function extractEventDetails(VEvent $vevent):array {
+        /** @var Property\ICalendar\DateTime $start */
+        $start = $vevent->DTSTART;
+        $end = $this->getDTEndFromEvent($vevent);
 
-		return [
-			'title' => isset($vevent->SUMMARY)
-				? ((string) $vevent->SUMMARY)
-				: null,
-			'description' => isset($vevent->DESCRIPTION)
-				? ((string) $vevent->DESCRIPTION)
-				: null,
-			'location' => isset($vevent->LOCATION)
-				? ((string) $vevent->LOCATION)
-				: null,
-			'all_day' => $start instanceof Property\ICalendar\Date,
-			/** @phan-suppress-next-line PhanUndeclaredClassMethod */
-			'start_atom' => $start->getDateTime()->format(\DateTime::ATOM),
-			'start_is_floating' => $start->isFloating(),
-			/** @phan-suppress-next-line PhanUndeclaredClassMethod */
-			'start_timezone' => $start->getDateTime()->getTimezone()->getName(),
-			/** @phan-suppress-next-line PhanUndeclaredClassMethod */
-			'end_atom' => $end->getDateTime()->format(\DateTime::ATOM),
-			'end_is_floating' => $end->isFloating(),
-			/** @phan-suppress-next-line PhanUndeclaredClassMethod */
-			'end_timezone' => $end->getDateTime()->getTimezone()->getName(),
-		];
-	}
+        return [
+            'title' => isset($vevent->SUMMARY)
+                ? ((string) $vevent->SUMMARY)
+                : null,
+            'description' => isset($vevent->DESCRIPTION)
+                ? ((string) $vevent->DESCRIPTION)
+                : null,
+            'location' => isset($vevent->LOCATION)
+                ? ((string) $vevent->LOCATION)
+                : null,
+            'all_day' => $start instanceof Property\ICalendar\Date,
+            /** @phan-suppress-next-line PhanUndeclaredClassMethod */
+            'start_atom' => $start->getDateTime()->format(\DateTime::ATOM),
+            'start_is_floating' => $start->isFloating(),
+            /** @phan-suppress-next-line PhanUndeclaredClassMethod */
+            'start_timezone' => $start->getDateTime()->getTimezone()->getName(),
+            /** @phan-suppress-next-line PhanUndeclaredClassMethod */
+            'end_atom' => $end->getDateTime()->format(\DateTime::ATOM),
+            'end_is_floating' => $end->isFloating(),
+            /** @phan-suppress-next-line PhanUndeclaredClassMethod */
+            'end_timezone' => $end->getDateTime()->getTimezone()->getName(),
+        ];
+    }
 }

apps/dav/lib/CalDAV/Reminder/NotificationProvider/ProviderNotAvailableException.php

Indentation +10 added lines, -10 removed lines

@@ -25,15 +25,15 @@
 
 class ProviderNotAvailableException extends \Exception {
 
-	/**
-	 * ProviderNotAvailableException constructor.
-	 *
-	 * @since 16.0.0
-	 *
-	 * @param string $type ReminderType
-	 */
-	public function __construct(string $type) {
-		parent::__construct("No notification provider for type $type available");
-	}
+    /**
+     * ProviderNotAvailableException constructor.
+     *
+     * @since 16.0.0
+     *
+     * @param string $type ReminderType
+     */
+    public function __construct(string $type) {
+        parent::__construct("No notification provider for type $type available");
+    }
 
 }

apps/dav/lib/CalDAV/Reminder/NotificationProvider/AudioProvider.php

Indentation +2 added lines, -2 removed lines

@@ -32,6 +32,6 @@
  */
 class AudioProvider extends PushProvider {
 
-	/** @var string */
-	public const NOTIFICATION_TYPE = 'AUDIO';
+    /** @var string */
+    public const NOTIFICATION_TYPE = 'AUDIO';
 }