feat(dav): dispatch out-of-office started and ended events

Signed-off-by: Richard Steinmetz <richard@steinmetz.cloud>

apps/dav/composer/composer/autoload_classmap.php

@@ -18,6 +18,7 @@
     'OCA\\DAV\\BackgroundJob\\CleanupInvitationTokenJob' => $baseDir . '/../lib/BackgroundJob/CleanupInvitationTokenJob.php',
     'OCA\\DAV\\BackgroundJob\\EventReminderJob' => $baseDir . '/../lib/BackgroundJob/EventReminderJob.php',
     'OCA\\DAV\\BackgroundJob\\GenerateBirthdayCalendarBackgroundJob' => $baseDir . '/../lib/BackgroundJob/GenerateBirthdayCalendarBackgroundJob.php',
+    'OCA\\DAV\\BackgroundJob\\OutOfOfficeEventDispatcherJob' => $baseDir . '/../lib/BackgroundJob/OutOfOfficeEventDispatcherJob.php',
     'OCA\\DAV\\BackgroundJob\\PruneOutdatedSyncTokensJob' => $baseDir . '/../lib/BackgroundJob/PruneOutdatedSyncTokensJob.php',
     'OCA\\DAV\\BackgroundJob\\RefreshWebcalJob' => $baseDir . '/../lib/BackgroundJob/RefreshWebcalJob.php',
     'OCA\\DAV\\BackgroundJob\\RegisterRegenerateBirthdayCalendars' => $baseDir . '/../lib/BackgroundJob/RegisterRegenerateBirthdayCalendars.php',

apps/dav/composer/composer/autoload_static.php

@@ -33,6 +33,7 @@ class ComposerStaticInitDAV
         'OCA\\DAV\\BackgroundJob\\CleanupInvitationTokenJob' => __DIR__ . '/..' . '/../lib/BackgroundJob/CleanupInvitationTokenJob.php',
         'OCA\\DAV\\BackgroundJob\\EventReminderJob' => __DIR__ . '/..' . '/../lib/BackgroundJob/EventReminderJob.php',
         'OCA\\DAV\\BackgroundJob\\GenerateBirthdayCalendarBackgroundJob' => __DIR__ . '/..' . '/../lib/BackgroundJob/GenerateBirthdayCalendarBackgroundJob.php',
+        'OCA\\DAV\\BackgroundJob\\OutOfOfficeEventDispatcherJob' => __DIR__ . '/..' . '/../lib/BackgroundJob/OutOfOfficeEventDispatcherJob.php',
         'OCA\\DAV\\BackgroundJob\\PruneOutdatedSyncTokensJob' => __DIR__ . '/..' . '/../lib/BackgroundJob/PruneOutdatedSyncTokensJob.php',
         'OCA\\DAV\\BackgroundJob\\RefreshWebcalJob' => __DIR__ . '/..' . '/../lib/BackgroundJob/RefreshWebcalJob.php',
         'OCA\\DAV\\BackgroundJob\\RegisterRegenerateBirthdayCalendars' => __DIR__ . '/..' . '/../lib/BackgroundJob/RegisterRegenerateBirthdayCalendars.php',

apps/dav/lib/BackgroundJob/OutOfOfficeEventDispatcherJob.php

@@ -0,0 +1,87 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2023 Richard Steinmetz <richard@steinmetz.cloud>
+ *
+ * @author Richard Steinmetz <richard@steinmetz.cloud>
+ *
+ * @license AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\DAV\BackgroundJob;
+
+use OCA\DAV\Db\AbsenceMapper;
+use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\QueuedJob;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\IUserManager;
+use OCP\User\Events\OutOfOfficeEndedEvent;
+use OCP\User\Events\OutOfOfficeStartedEvent;
+use Psr\Log\LoggerInterface;
+
+class OutOfOfficeEventDispatcherJob extends QueuedJob {
+	public const EVENT_START = 'start';
+	public const EVENT_END = 'end';
+
+	public function __construct(
+		ITimeFactory $time,
+		private AbsenceMapper $absenceMapper,
+		private LoggerInterface $logger,
+		private IEventDispatcher $eventDispatcher,
+		private IUserManager $userManager,
+	) {
+		parent::__construct($time);
+	}
+
+	public function run($argument) {
+		$id = $argument['id'];
+		$event = $argument['event'];
+
+		try {
+			$absence = $this->absenceMapper->findById($id);
+		} catch (DoesNotExistException | \OCP\DB\Exception $e) {
+			$this->logger->error('Failed to dispatch out-of-office event: ' . $e->getMessage(), [
+				'exception' => $e,
+				'argument' => $argument,
+			]);
+			return;
+		}
+
+		$userId = $absence->getUserId();
+		$user = $this->userManager->get($userId);
+		if ($user === null) {
+			$this->logger->error("Failed to dispatch out-of-office event: User $userId does not exist", [
+				'argument' => $argument,
+			]);
+			return;
+		}
+
+		$data = $absence->toOutOufOfficeData($user);
+		if ($event === self::EVENT_START) {
+			$this->eventDispatcher->dispatchTyped(new OutOfOfficeStartedEvent($data));
+		} elseif ($event === self::EVENT_END) {
+			$this->eventDispatcher->dispatchTyped(new OutOfOfficeEndedEvent($data));
+		} else {
+			$this->logger->error("Invalid out-of-office event: $event", [
+				'argument' => $argument,
+			]);
+		}
+	}
+}

apps/dav/lib/Controller/AvailabilitySettingsController.php

@@ -35,11 +35,12 @@
 use OCP\AppFramework\Http\JSONResponse;
 use OCP\AppFramework\Http\Response;
 use OCP\IRequest;
+use OCP\IUserSession;
 
 class AvailabilitySettingsController extends Controller {
 	public function __construct(
 		IRequest $request,
-		private ?string $userId,
+		private ?IUserSession $userSession,
 		private AbsenceService $absenceService,
 	) {
 		parent::__construct(Application::APP_ID, $request);
@@ -56,8 +57,8 @@ public function updateAbsence(
 		string $status,
 		string $message,
 	): Response {
-		$userId = $this->userId;
-		if ($userId === null) {
+		$user = $this->userSession->getUser();
+		if ($user === null) {
 			return new JSONResponse([], Http::STATUS_FORBIDDEN);
 		}
 
@@ -68,7 +69,7 @@ public function updateAbsence(
 		}
 
 		$absence = $this->absenceService->createOrUpdateAbsence(
-			$userId,
+			$user,
 			$firstDay,
 			$lastDay,
 			$status,
@@ -82,12 +83,12 @@ public function updateAbsence(
 	 */
 	#[NoAdminRequired]
 	public function clearAbsence(): Response {
-		$userId = $this->userId;
-		if ($userId === null) {
+		$user = $this->userSession->getUser();
+		if ($user === null) {
 			return new JSONResponse([], Http::STATUS_FORBIDDEN);
 		}
 
-		$this->absenceService->clearAbsence($userId);
+		$this->absenceService->clearAbsence($user);
 		return new JSONResponse([]);
 	}
 

apps/dav/lib/Db/AbsenceMapper.php

@@ -40,6 +40,31 @@ public function __construct(IDBConnection $db) {
 		parent::__construct($db, 'dav_absence', Absence::class);
 	}
 
+	/**
+	 * @throws DoesNotExistException
+	 * @throws \OCP\DB\Exception
+	 */
+	public function findById(int $id): Absence {
+		$qb = $this->db->getQueryBuilder();
+		$qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq(
+				'id',
+				$qb->createNamedParameter($id, IQueryBuilder::PARAM_INT),
+				IQueryBuilder::PARAM_INT),
+			);
+		try {
+			return $this->findEntity($qb);
+		} catch (MultipleObjectsReturnedException $e) {
+			// Won't happen as id is the primary key
+			throw new \RuntimeException(
+				'The impossible has happened! The query returned multiple absence settings for one user.',
+				0,
+				$e,
+			);
+		}
+	}
+
 	/**
 	 * @throws DoesNotExistException
 	 * @throws \OCP\DB\Exception

apps/dav/lib/Service/AbsenceService.php

@@ -27,11 +27,13 @@
 namespace OCA\DAV\Service;
 
 use InvalidArgumentException;
+use OCA\DAV\BackgroundJob\OutOfOfficeEventDispatcherJob;
 use OCA\DAV\Db\Absence;
 use OCA\DAV\Db\AbsenceMapper;
 use OCP\AppFramework\Db\DoesNotExistException;
+use OCP\BackgroundJob\IJobList;
 use OCP\EventDispatcher\IEventDispatcher;
-use OCP\IUserManager;
+use OCP\IUser;
 use OCP\User\Events\OutOfOfficeChangedEvent;
 use OCP\User\Events\OutOfOfficeClearedEvent;
 use OCP\User\Events\OutOfOfficeScheduledEvent;
@@ -40,7 +42,7 @@ class AbsenceService {
 	public function __construct(
 		private AbsenceMapper $absenceMapper,
 		private IEventDispatcher $eventDispatcher,
-		private IUserManager $userManager,
+		private IJobList $jobList,
 	) {
 	}
 
@@ -52,60 +54,66 @@ public function __construct(
 	 * @throws InvalidArgumentException If no user with the given user id exists.
 	 */
 	public function createOrUpdateAbsence(
-		string $userId,
+		IUser $user,
 		string $firstDay,
 		string $lastDay,
 		string $status,
 		string $message,
 	): Absence {
 		try {
-			$absence = $this->absenceMapper->findByUserId($userId);
+			$absence = $this->absenceMapper->findByUserId($user->getUID());
 		} catch (DoesNotExistException) {
 			$absence = new Absence();
 		}
 
-		$absence->setUserId($userId);
+		$absence->setUserId($user->getUID());
 		$absence->setFirstDay($firstDay);
 		$absence->setLastDay($lastDay);
 		$absence->setStatus($status);
 		$absence->setMessage($message);
 
-		// TODO: this method should probably just take a IUser instance
-		$user = $this->userManager->get($userId);
-		if ($user === null) {
-			throw new InvalidArgumentException("User $userId does not exist");
-		}
-
 		if ($absence->getId() === null) {
-			$persistedAbsence = $this->absenceMapper->insert($absence);
-			$this->eventDispatcher->dispatchTyped(new OutOfOfficeScheduledEvent(
-				$persistedAbsence->toOutOufOfficeData($user)
-			));
-			return $persistedAbsence;
+			$absence = $this->absenceMapper->insert($absence);
+			$eventData = $absence->toOutOufOfficeData($user);
+			$this->eventDispatcher->dispatchTyped(new OutOfOfficeScheduledEvent($eventData));
+		} else {
+			$absence = $this->absenceMapper->update($absence);
+			$eventData = $absence->toOutOufOfficeData($user);
+			$this->eventDispatcher->dispatchTyped(new OutOfOfficeChangedEvent($eventData));
 		}
 
-		$this->eventDispatcher->dispatchTyped(new OutOfOfficeChangedEvent(
-			$absence->toOutOufOfficeData($user)
-		));
-		return $this->absenceMapper->update($absence);
+		$this->jobList->scheduleAfter(
+			OutOfOfficeEventDispatcherJob::class,
+			$eventData->getStartDate(),
+			[
+				'id' => $absence->getId(),
+				'event' => OutOfOfficeEventDispatcherJob::EVENT_START,
+			],
+		);
+		$this->jobList->scheduleAfter(
+			OutOfOfficeEventDispatcherJob::class,
+			$eventData->getEndDate(),
+			[
+				'id' => $absence->getId(),
+				'event' => OutOfOfficeEventDispatcherJob::EVENT_END,
+			],
+		);
+
+		return $absence;
 	}
 
 	/**
 	 * @throws \OCP\DB\Exception
 	 */
-	public function clearAbsence(string $userId): void {
+	public function clearAbsence(IUser $user): void {
 		try {
-			$absence = $this->absenceMapper->findByUserId($userId);
+			$absence = $this->absenceMapper->findByUserId($user->getUID());
 		} catch (DoesNotExistException $e) {
 			// Nothing to clear
 			return;
 		}
 		$this->absenceMapper->delete($absence);
-		// TODO: this method should probably just take a IUser instance
-		$user = $this->userManager->get($userId);
-		if ($user === null) {
-			throw new InvalidArgumentException("User $userId does not exist");
-		}
+		$this->jobList->remove(OutOfOfficeEventDispatcherJob::class);
 		$eventData = $absence->toOutOufOfficeData($user);
 		$this->eventDispatcher->dispatchTyped(new OutOfOfficeClearedEvent($eventData));
 	}