nextcloud / server

apps/user_status/lib/BackgroundJob/ClearOldStatusesBackgroundJob.php

Indentation +24 added lines, -24 removed lines

@@ -20,28 +20,28 @@
  */
 class ClearOldStatusesBackgroundJob extends TimedJob {
 
-	/**
-	 * ClearOldStatusesBackgroundJob constructor.
-	 *
-	 * @param ITimeFactory $time
-	 * @param UserStatusMapper $mapper
-	 */
-	public function __construct(
-		ITimeFactory $time,
-		private UserStatusMapper $mapper,
-	) {
-		parent::__construct($time);
-
-		$this->setInterval(60);
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	protected function run($argument) {
-		$now = $this->time->getTime();
-
-		$this->mapper->clearOlderThanClearAt($now);
-		$this->mapper->clearStatusesOlderThan($now - StatusService::INVALIDATE_STATUS_THRESHOLD, $now);
-	}
+    /**
+     * ClearOldStatusesBackgroundJob constructor.
+     *
+     * @param ITimeFactory $time
+     * @param UserStatusMapper $mapper
+     */
+    public function __construct(
+        ITimeFactory $time,
+        private UserStatusMapper $mapper,
+    ) {
+        parent::__construct($time);
+
+        $this->setInterval(60);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function run($argument) {
+        $now = $this->time->getTime();
+
+        $this->mapper->clearOlderThanClearAt($now);
+        $this->mapper->clearStatusesOlderThan($now - StatusService::INVALIDATE_STATUS_THRESHOLD, $now);
+    }
 }

apps/dav/lib/Listener/UserEventsListener.php

Indentation +148 added lines, -148 removed lines

@@ -35,152 +35,152 @@
 /** @template-implements IEventListener<UserFirstTimeLoggedInEvent|UserIdAssignedEvent|BeforeUserIdUnassignedEvent|UserIdUnassignedEvent|BeforeUserDeletedEvent|UserDeletedEvent|UserCreatedEvent|UserChangedEvent|UserUpdatedEvent> */
 class UserEventsListener implements IEventListener {
 
-	/** @var IUser[] */
-	private array $usersToDelete = [];
-
-	private array $calendarsToDelete = [];
-	private array $subscriptionsToDelete = [];
-	private array $addressBooksToDelete = [];
-
-	public function __construct(
-		private IUserManager $userManager,
-		private SyncService $syncService,
-		private CalDavBackend $calDav,
-		private CardDavBackend $cardDav,
-		private Defaults $themingDefaults,
-		private ExampleContactService $exampleContactService,
-		private ExampleEventService $exampleEventService,
-		private LoggerInterface $logger,
-		private IJobList $jobList,
-	) {
-	}
-
-	public function handle(Event $event): void {
-		if ($event instanceof UserCreatedEvent) {
-			$this->postCreateUser($event->getUser());
-		} elseif ($event instanceof UserIdAssignedEvent) {
-			$user = $this->userManager->get($event->getUserId());
-			if ($user !== null) {
-				$this->postCreateUser($user);
-			}
-		} elseif ($event instanceof BeforeUserDeletedEvent) {
-			$this->preDeleteUser($event->getUser());
-		} elseif ($event instanceof BeforeUserIdUnassignedEvent) {
-			$this->preUnassignedUserId($event->getUserId());
-		} elseif ($event instanceof UserDeletedEvent) {
-			$this->postDeleteUser($event->getUid());
-		} elseif ($event instanceof UserIdUnassignedEvent) {
-			$this->postDeleteUser($event->getUserId());
-		} elseif ($event instanceof UserChangedEvent) {
-			$this->changeUser($event->getUser(), $event->getFeature());
-		} elseif ($event instanceof UserFirstTimeLoggedInEvent) {
-			$this->firstLogin($event->getUser());
-		} elseif ($event instanceof UserUpdatedEvent) {
-			$this->updateUser($event->getUser());
-		}
-	}
-
-	public function postCreateUser(IUser $user): void {
-		$this->syncService->updateUser($user);
-	}
-
-	public function updateUser(IUser $user): void {
-		$this->syncService->updateUser($user);
-	}
-
-	public function preDeleteUser(IUser $user): void {
-		$uid = $user->getUID();
-		$userPrincipalUri = 'principals/users/' . $uid;
-		$this->usersToDelete[$uid] = $user;
-		$this->calendarsToDelete[$uid] = $this->calDav->getUsersOwnCalendars($userPrincipalUri);
-		$this->subscriptionsToDelete[$uid] = $this->calDav->getSubscriptionsForUser($userPrincipalUri);
-		$this->addressBooksToDelete[$uid] = $this->cardDav->getUsersOwnAddressBooks($userPrincipalUri);
-	}
-
-	public function preUnassignedUserId(string $uid): void {
-		$user = $this->userManager->get($uid);
-		if ($user !== null) {
-			$this->usersToDelete[$uid] = $user;
-		}
-	}
-
-	public function postDeleteUser(string $uid): void {
-		if (isset($this->usersToDelete[$uid])) {
-			$this->syncService->deleteUser($this->usersToDelete[$uid]);
-		}
-
-		foreach ($this->calendarsToDelete[$uid] as $calendar) {
-			$this->calDav->deleteCalendar(
-				$calendar['id'],
-				true // Make sure the data doesn't go into the trashbin, a new user with the same UID would later see it otherwise
-			);
-		}
-
-		foreach ($this->subscriptionsToDelete[$uid] as $subscription) {
-			$this->calDav->deleteSubscription(
-				$subscription['id'],
-			);
-		}
-		$this->calDav->deleteAllSharesByUser('principals/users/' . $uid);
-
-		foreach ($this->addressBooksToDelete[$uid] as $addressBook) {
-			$this->cardDav->deleteAddressBook($addressBook['id']);
-		}
-
-		$this->jobList->remove(UserStatusAutomation::class, ['userId' => $uid]);
-
-		unset($this->calendarsToDelete[$uid]);
-		unset($this->subscriptionsToDelete[$uid]);
-		unset($this->addressBooksToDelete[$uid]);
-	}
-
-	public function changeUser(IUser $user, string $feature): void {
-		// This case is already covered by the account manager firing up a signal
-		// later on
-		if ($feature !== 'eMailAddress' && $feature !== 'displayName') {
-			$this->syncService->updateUser($user);
-		}
-	}
-
-	public function firstLogin(IUser $user): void {
-		$principal = 'principals/users/' . $user->getUID();
-
-		$calendarId = null;
-		if ($this->calDav->getCalendarsForUserCount($principal) === 0) {
-			try {
-				$calendarId = $this->calDav->createCalendar($principal, CalDavBackend::PERSONAL_CALENDAR_URI, [
-					'{DAV:}displayname' => CalDavBackend::PERSONAL_CALENDAR_NAME,
-					'{http://apple.com/ns/ical/}calendar-color' => $this->themingDefaults->getColorPrimary(),
-					'components' => 'VEVENT'
-				]);
-			} catch (\Exception $e) {
-				$this->logger->error($e->getMessage(), ['exception' => $e]);
-			}
-		}
-		if ($calendarId !== null) {
-			try {
-				$this->exampleEventService->createExampleEvent($calendarId);
-			} catch (\Exception $e) {
-				$this->logger->error('Failed to create example event: ' . $e->getMessage(), [
-					'exception' => $e,
-					'userId' => $user->getUID(),
-					'calendarId' => $calendarId,
-				]);
-			}
-		}
-
-		$addressBookId = null;
-		if ($this->cardDav->getAddressBooksForUserCount($principal) === 0) {
-			try {
-				$addressBookId = $this->cardDav->createAddressBook($principal, CardDavBackend::PERSONAL_ADDRESSBOOK_URI, [
-					'{DAV:}displayname' => CardDavBackend::PERSONAL_ADDRESSBOOK_NAME,
-				]);
-			} catch (\Exception $e) {
-				$this->logger->error($e->getMessage(), ['exception' => $e]);
-			}
-		}
-		if ($addressBookId) {
-			$this->exampleContactService->createDefaultContact($addressBookId);
-		}
-	}
+    /** @var IUser[] */
+    private array $usersToDelete = [];
+
+    private array $calendarsToDelete = [];
+    private array $subscriptionsToDelete = [];
+    private array $addressBooksToDelete = [];
+
+    public function __construct(
+        private IUserManager $userManager,
+        private SyncService $syncService,
+        private CalDavBackend $calDav,
+        private CardDavBackend $cardDav,
+        private Defaults $themingDefaults,
+        private ExampleContactService $exampleContactService,
+        private ExampleEventService $exampleEventService,
+        private LoggerInterface $logger,
+        private IJobList $jobList,
+    ) {
+    }
+
+    public function handle(Event $event): void {
+        if ($event instanceof UserCreatedEvent) {
+            $this->postCreateUser($event->getUser());
+        } elseif ($event instanceof UserIdAssignedEvent) {
+            $user = $this->userManager->get($event->getUserId());
+            if ($user !== null) {
+                $this->postCreateUser($user);
+            }
+        } elseif ($event instanceof BeforeUserDeletedEvent) {
+            $this->preDeleteUser($event->getUser());
+        } elseif ($event instanceof BeforeUserIdUnassignedEvent) {
+            $this->preUnassignedUserId($event->getUserId());
+        } elseif ($event instanceof UserDeletedEvent) {
+            $this->postDeleteUser($event->getUid());
+        } elseif ($event instanceof UserIdUnassignedEvent) {
+            $this->postDeleteUser($event->getUserId());
+        } elseif ($event instanceof UserChangedEvent) {
+            $this->changeUser($event->getUser(), $event->getFeature());
+        } elseif ($event instanceof UserFirstTimeLoggedInEvent) {
+            $this->firstLogin($event->getUser());
+        } elseif ($event instanceof UserUpdatedEvent) {
+            $this->updateUser($event->getUser());
+        }
+    }
+
+    public function postCreateUser(IUser $user): void {
+        $this->syncService->updateUser($user);
+    }
+
+    public function updateUser(IUser $user): void {
+        $this->syncService->updateUser($user);
+    }
+
+    public function preDeleteUser(IUser $user): void {
+        $uid = $user->getUID();
+        $userPrincipalUri = 'principals/users/' . $uid;
+        $this->usersToDelete[$uid] = $user;
+        $this->calendarsToDelete[$uid] = $this->calDav->getUsersOwnCalendars($userPrincipalUri);
+        $this->subscriptionsToDelete[$uid] = $this->calDav->getSubscriptionsForUser($userPrincipalUri);
+        $this->addressBooksToDelete[$uid] = $this->cardDav->getUsersOwnAddressBooks($userPrincipalUri);
+    }
+
+    public function preUnassignedUserId(string $uid): void {
+        $user = $this->userManager->get($uid);
+        if ($user !== null) {
+            $this->usersToDelete[$uid] = $user;
+        }
+    }
+
+    public function postDeleteUser(string $uid): void {
+        if (isset($this->usersToDelete[$uid])) {
+            $this->syncService->deleteUser($this->usersToDelete[$uid]);
+        }
+
+        foreach ($this->calendarsToDelete[$uid] as $calendar) {
+            $this->calDav->deleteCalendar(
+                $calendar['id'],
+                true // Make sure the data doesn't go into the trashbin, a new user with the same UID would later see it otherwise
+            );
+        }
+
+        foreach ($this->subscriptionsToDelete[$uid] as $subscription) {
+            $this->calDav->deleteSubscription(
+                $subscription['id'],
+            );
+        }
+        $this->calDav->deleteAllSharesByUser('principals/users/' . $uid);
+
+        foreach ($this->addressBooksToDelete[$uid] as $addressBook) {
+            $this->cardDav->deleteAddressBook($addressBook['id']);
+        }
+
+        $this->jobList->remove(UserStatusAutomation::class, ['userId' => $uid]);
+
+        unset($this->calendarsToDelete[$uid]);
+        unset($this->subscriptionsToDelete[$uid]);
+        unset($this->addressBooksToDelete[$uid]);
+    }
+
+    public function changeUser(IUser $user, string $feature): void {
+        // This case is already covered by the account manager firing up a signal
+        // later on
+        if ($feature !== 'eMailAddress' && $feature !== 'displayName') {
+            $this->syncService->updateUser($user);
+        }
+    }
+
+    public function firstLogin(IUser $user): void {
+        $principal = 'principals/users/' . $user->getUID();
+
+        $calendarId = null;
+        if ($this->calDav->getCalendarsForUserCount($principal) === 0) {
+            try {
+                $calendarId = $this->calDav->createCalendar($principal, CalDavBackend::PERSONAL_CALENDAR_URI, [
+                    '{DAV:}displayname' => CalDavBackend::PERSONAL_CALENDAR_NAME,
+                    '{http://apple.com/ns/ical/}calendar-color' => $this->themingDefaults->getColorPrimary(),
+                    'components' => 'VEVENT'
+                ]);
+            } catch (\Exception $e) {
+                $this->logger->error($e->getMessage(), ['exception' => $e]);
+            }
+        }
+        if ($calendarId !== null) {
+            try {
+                $this->exampleEventService->createExampleEvent($calendarId);
+            } catch (\Exception $e) {
+                $this->logger->error('Failed to create example event: ' . $e->getMessage(), [
+                    'exception' => $e,
+                    'userId' => $user->getUID(),
+                    'calendarId' => $calendarId,
+                ]);
+            }
+        }
+
+        $addressBookId = null;
+        if ($this->cardDav->getAddressBooksForUserCount($principal) === 0) {
+            try {
+                $addressBookId = $this->cardDav->createAddressBook($principal, CardDavBackend::PERSONAL_ADDRESSBOOK_URI, [
+                    '{DAV:}displayname' => CardDavBackend::PERSONAL_ADDRESSBOOK_NAME,
+                ]);
+            } catch (\Exception $e) {
+                $this->logger->error($e->getMessage(), ['exception' => $e]);
+            }
+        }
+        if ($addressBookId) {
+            $this->exampleContactService->createDefaultContact($addressBookId);
+        }
+    }
 }

apps/dav/lib/BackgroundJob/UserStatusAutomation.php

Indentation +212 added lines, -212 removed lines

@@ -28,216 +28,216 @@
 use Sabre\VObject\Recur\RRuleIterator;
 
 class UserStatusAutomation extends TimedJob {
-	public function __construct(
-		private ITimeFactory $timeFactory,
-		private IDBConnection $connection,
-		private IJobList $jobList,
-		private LoggerInterface $logger,
-		private IManager $manager,
-		private IConfig $config,
-		private IAvailabilityCoordinator $coordinator,
-		private IUserManager $userManager,
-	) {
-		parent::__construct($timeFactory);
-
-		// interval = 0 might look odd, but it's intentional. last_run is set to
-		// the user's next available time, so the job runs immediately when
-		// that time comes.
-		$this->setInterval(0);
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	protected function run($argument) {
-		if (!isset($argument['userId'])) {
-			$this->jobList->remove(self::class, $argument);
-			$this->logger->info('Removing invalid ' . self::class . ' background job');
-			return;
-		}
-
-		$userId = $argument['userId'];
-		$user = $this->userManager->get($userId);
-		if ($user === null) {
-			return;
-		}
-
-		$ooo = $this->coordinator->getCurrentOutOfOfficeData($user);
-
-		$continue = $this->processOutOfOfficeData($user, $ooo);
-		if ($continue === false) {
-			return;
-		}
-
-		$property = $this->getAvailabilityFromPropertiesTable($userId);
-		$hasDndForOfficeHours = $this->config->getUserValue($userId, 'dav', 'user_status_automation', 'no') === 'yes';
-
-		if (!$property) {
-			// We found no ooo data and no availability settings, so we need to delete the job because there is no next runtime
-			$this->logger->info('Removing ' . self::class . ' background job for user "' . $userId . '" because the user has no valid availability rules and no OOO data set');
-			$this->jobList->remove(self::class, $argument);
-			$this->manager->revertUserStatus($user->getUID(), IUserStatus::MESSAGE_AVAILABILITY, IUserStatus::DND);
-			$this->manager->revertUserStatus($user->getUID(), IUserStatus::MESSAGE_OUT_OF_OFFICE, IUserStatus::DND);
-			return;
-		}
-
-		$this->processAvailability($property, $user->getUID(), $hasDndForOfficeHours);
-	}
-
-	protected function setLastRunToNextToggleTime(string $userId, int $timestamp): void {
-		$query = $this->connection->getQueryBuilder();
-
-		$query->update('jobs')
-			->set('last_run', $query->createNamedParameter($timestamp, IQueryBuilder::PARAM_INT))
-			->where($query->expr()->eq('id', $query->createNamedParameter($this->getId(), IQueryBuilder::PARAM_INT)));
-		$query->executeStatement();
-
-		$this->logger->debug('Updated user status automation last_run to ' . $timestamp . ' for user ' . $userId);
-	}
-
-	/**
-	 * @param string $userId
-	 * @return false|string
-	 */
-	protected function getAvailabilityFromPropertiesTable(string $userId) {
-		$propertyPath = 'calendars/' . $userId . '/inbox';
-		$propertyName = '{' . Plugin::NS_CALDAV . '}calendar-availability';
-
-		$query = $this->connection->getQueryBuilder();
-		$query->select('propertyvalue')
-			->from('properties')
-			->where($query->expr()->eq('userid', $query->createNamedParameter($userId)))
-			->andWhere($query->expr()->eq('propertypath', $query->createNamedParameter($propertyPath)))
-			->andWhere($query->expr()->eq('propertyname', $query->createNamedParameter($propertyName)))
-			->setMaxResults(1);
-
-		$result = $query->executeQuery();
-		$property = $result->fetchOne();
-		$result->closeCursor();
-
-		return $property;
-	}
-
-	/**
-	 * @param string $property
-	 * @param $userId
-	 * @param $argument
-	 * @return void
-	 */
-	private function processAvailability(string $property, string $userId, bool $hasDndForOfficeHours): void {
-		$isCurrentlyAvailable = false;
-		$nextPotentialToggles = [];
-
-		$now = $this->time->getDateTime();
-		$lastMidnight = (clone $now)->setTime(0, 0);
-
-		$vObject = Reader::read($property);
-		foreach ($vObject->getComponents() as $component) {
-			if ($component->name !== 'VAVAILABILITY') {
-				continue;
-			}
-			/** @var VAvailability $component */
-			$availables = $component->getComponents();
-			foreach ($availables as $available) {
-				/** @var Available $available */
-				if ($available->name === 'AVAILABLE') {
-					/** @var \DateTimeImmutable $originalStart */
-					/** @var \DateTimeImmutable $originalEnd */
-					[$originalStart, $originalEnd] = $available->getEffectiveStartEnd();
-
-					// Little shenanigans to fix the automation on the day the rules were adjusted
-					// Otherwise the $originalStart would match rules for Thursdays on a Friday, etc.
-					// So we simply wind back a week and then fastForward to the next occurrence
-					// since today's midnight, which then also accounts for the week days.
-					$effectiveStart = \DateTime::createFromImmutable($originalStart)->sub(new \DateInterval('P7D'));
-					$effectiveEnd = \DateTime::createFromImmutable($originalEnd)->sub(new \DateInterval('P7D'));
-
-					try {
-						$it = new RRuleIterator((string)$available->RRULE, $effectiveStart);
-						$it->fastForward($lastMidnight);
-
-						$startToday = $it->current();
-						if ($startToday && $startToday <= $now) {
-							$duration = $effectiveStart->diff($effectiveEnd);
-							$endToday = $startToday->add($duration);
-							if ($endToday > $now) {
-								// User is currently available
-								// Also queuing the end time as next status toggle
-								$isCurrentlyAvailable = true;
-								$nextPotentialToggles[] = $endToday->getTimestamp();
-							}
-
-							// Availability enabling already done for today,
-							// so jump to the next recurrence to find the next status toggle
-							$it->next();
-						}
-
-						if ($it->current()) {
-							$nextPotentialToggles[] = $it->current()->getTimestamp();
-						}
-					} catch (\Exception $e) {
-						$this->logger->error($e->getMessage(), ['exception' => $e]);
-					}
-				}
-			}
-		}
-
-		if (empty($nextPotentialToggles)) {
-			$this->logger->info('Removing ' . self::class . ' background job for user "' . $userId . '" because the user has no valid availability rules set');
-			$this->jobList->remove(self::class, ['userId' => $userId]);
-			$this->manager->revertUserStatus($userId, IUserStatus::MESSAGE_AVAILABILITY, IUserStatus::DND);
-			return;
-		}
-
-		$nextAutomaticToggle = min($nextPotentialToggles);
-		$this->setLastRunToNextToggleTime($userId, $nextAutomaticToggle - 1);
-
-		if ($isCurrentlyAvailable) {
-			$this->logger->debug('User is currently available, reverting DND status if applicable');
-			$this->manager->revertUserStatus($userId, IUserStatus::MESSAGE_AVAILABILITY, IUserStatus::DND);
-			$this->logger->debug('User status automation ran');
-			return;
-		}
-
-		if (!$hasDndForOfficeHours) {
-			// Office hours are not set to DND, so there is nothing to do.
-			return;
-		}
-
-		$this->logger->debug('User is currently NOT available, reverting call and meeting status if applicable and then setting DND');
-		$this->manager->setUserStatus($userId, IUserStatus::MESSAGE_AVAILABILITY, IUserStatus::DND, true);
-		$this->logger->debug('User status automation ran');
-	}
-
-	private function processOutOfOfficeData(IUser $user, ?IOutOfOfficeData $ooo): bool {
-		if (empty($ooo)) {
-			// Reset the user status if the absence doesn't exist
-			$this->logger->debug('User has no OOO period in effect, reverting DND status if applicable');
-			$this->manager->revertUserStatus($user->getUID(), IUserStatus::MESSAGE_OUT_OF_OFFICE, IUserStatus::DND);
-			// We need to also run the availability automation
-			return true;
-		}
-
-		if (!$this->coordinator->isInEffect($ooo)) {
-			// Reset the user status if the absence is (no longer) in effect
-			$this->logger->debug('User has no OOO period in effect, reverting DND status if applicable');
-			$this->manager->revertUserStatus($user->getUID(), IUserStatus::MESSAGE_OUT_OF_OFFICE, IUserStatus::DND);
-
-			if ($ooo->getStartDate() > $this->time->getTime()) {
-				// Set the next run to take place at the start of the ooo period if it is in the future
-				// This might be overwritten if there is an availability setting, but we can't determine
-				// if this is the case here
-				$this->setLastRunToNextToggleTime($user->getUID(), $ooo->getStartDate());
-			}
-			return true;
-		}
-
-		$this->logger->debug('User is currently in an OOO period, reverting other automated status and setting OOO DND status');
-		$this->manager->setUserStatus($user->getUID(), IUserStatus::MESSAGE_OUT_OF_OFFICE, IUserStatus::DND, true, $ooo->getShortMessage());
-
-		// Run at the end of an ooo period to return to availability / regular user status
-		// If it's overwritten by a custom status in the meantime, there's nothing we can do about it
-		$this->setLastRunToNextToggleTime($user->getUID(), $ooo->getEndDate());
-		return false;
-	}
+    public function __construct(
+        private ITimeFactory $timeFactory,
+        private IDBConnection $connection,
+        private IJobList $jobList,
+        private LoggerInterface $logger,
+        private IManager $manager,
+        private IConfig $config,
+        private IAvailabilityCoordinator $coordinator,
+        private IUserManager $userManager,
+    ) {
+        parent::__construct($timeFactory);
+
+        // interval = 0 might look odd, but it's intentional. last_run is set to
+        // the user's next available time, so the job runs immediately when
+        // that time comes.
+        $this->setInterval(0);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    protected function run($argument) {
+        if (!isset($argument['userId'])) {
+            $this->jobList->remove(self::class, $argument);
+            $this->logger->info('Removing invalid ' . self::class . ' background job');
+            return;
+        }
+
+        $userId = $argument['userId'];
+        $user = $this->userManager->get($userId);
+        if ($user === null) {
+            return;
+        }
+
+        $ooo = $this->coordinator->getCurrentOutOfOfficeData($user);
+
+        $continue = $this->processOutOfOfficeData($user, $ooo);
+        if ($continue === false) {
+            return;
+        }
+
+        $property = $this->getAvailabilityFromPropertiesTable($userId);
+        $hasDndForOfficeHours = $this->config->getUserValue($userId, 'dav', 'user_status_automation', 'no') === 'yes';
+
+        if (!$property) {
+            // We found no ooo data and no availability settings, so we need to delete the job because there is no next runtime
+            $this->logger->info('Removing ' . self::class . ' background job for user "' . $userId . '" because the user has no valid availability rules and no OOO data set');
+            $this->jobList->remove(self::class, $argument);
+            $this->manager->revertUserStatus($user->getUID(), IUserStatus::MESSAGE_AVAILABILITY, IUserStatus::DND);
+            $this->manager->revertUserStatus($user->getUID(), IUserStatus::MESSAGE_OUT_OF_OFFICE, IUserStatus::DND);
+            return;
+        }
+
+        $this->processAvailability($property, $user->getUID(), $hasDndForOfficeHours);
+    }
+
+    protected function setLastRunToNextToggleTime(string $userId, int $timestamp): void {
+        $query = $this->connection->getQueryBuilder();
+
+        $query->update('jobs')
+            ->set('last_run', $query->createNamedParameter($timestamp, IQueryBuilder::PARAM_INT))
+            ->where($query->expr()->eq('id', $query->createNamedParameter($this->getId(), IQueryBuilder::PARAM_INT)));
+        $query->executeStatement();
+
+        $this->logger->debug('Updated user status automation last_run to ' . $timestamp . ' for user ' . $userId);
+    }
+
+    /**
+     * @param string $userId
+     * @return false|string
+     */
+    protected function getAvailabilityFromPropertiesTable(string $userId) {
+        $propertyPath = 'calendars/' . $userId . '/inbox';
+        $propertyName = '{' . Plugin::NS_CALDAV . '}calendar-availability';
+
+        $query = $this->connection->getQueryBuilder();
+        $query->select('propertyvalue')
+            ->from('properties')
+            ->where($query->expr()->eq('userid', $query->createNamedParameter($userId)))
+            ->andWhere($query->expr()->eq('propertypath', $query->createNamedParameter($propertyPath)))
+            ->andWhere($query->expr()->eq('propertyname', $query->createNamedParameter($propertyName)))
+            ->setMaxResults(1);
+
+        $result = $query->executeQuery();
+        $property = $result->fetchOne();
+        $result->closeCursor();
+
+        return $property;
+    }
+
+    /**
+     * @param string $property
+     * @param $userId
+     * @param $argument
+     * @return void
+     */
+    private function processAvailability(string $property, string $userId, bool $hasDndForOfficeHours): void {
+        $isCurrentlyAvailable = false;
+        $nextPotentialToggles = [];
+
+        $now = $this->time->getDateTime();
+        $lastMidnight = (clone $now)->setTime(0, 0);
+
+        $vObject = Reader::read($property);
+        foreach ($vObject->getComponents() as $component) {
+            if ($component->name !== 'VAVAILABILITY') {
+                continue;
+            }
+            /** @var VAvailability $component */
+            $availables = $component->getComponents();
+            foreach ($availables as $available) {
+                /** @var Available $available */
+                if ($available->name === 'AVAILABLE') {
+                    /** @var \DateTimeImmutable $originalStart */
+                    /** @var \DateTimeImmutable $originalEnd */
+                    [$originalStart, $originalEnd] = $available->getEffectiveStartEnd();
+
+                    // Little shenanigans to fix the automation on the day the rules were adjusted
+                    // Otherwise the $originalStart would match rules for Thursdays on a Friday, etc.
+                    // So we simply wind back a week and then fastForward to the next occurrence
+                    // since today's midnight, which then also accounts for the week days.
+                    $effectiveStart = \DateTime::createFromImmutable($originalStart)->sub(new \DateInterval('P7D'));
+                    $effectiveEnd = \DateTime::createFromImmutable($originalEnd)->sub(new \DateInterval('P7D'));
+
+                    try {
+                        $it = new RRuleIterator((string)$available->RRULE, $effectiveStart);
+                        $it->fastForward($lastMidnight);
+
+                        $startToday = $it->current();
+                        if ($startToday && $startToday <= $now) {
+                            $duration = $effectiveStart->diff($effectiveEnd);
+                            $endToday = $startToday->add($duration);
+                            if ($endToday > $now) {
+                                // User is currently available
+                                // Also queuing the end time as next status toggle
+                                $isCurrentlyAvailable = true;
+                                $nextPotentialToggles[] = $endToday->getTimestamp();
+                            }
+
+                            // Availability enabling already done for today,
+                            // so jump to the next recurrence to find the next status toggle
+                            $it->next();
+                        }
+
+                        if ($it->current()) {
+                            $nextPotentialToggles[] = $it->current()->getTimestamp();
+                        }
+                    } catch (\Exception $e) {
+                        $this->logger->error($e->getMessage(), ['exception' => $e]);
+                    }
+                }
+            }
+        }
+
+        if (empty($nextPotentialToggles)) {
+            $this->logger->info('Removing ' . self::class . ' background job for user "' . $userId . '" because the user has no valid availability rules set');
+            $this->jobList->remove(self::class, ['userId' => $userId]);
+            $this->manager->revertUserStatus($userId, IUserStatus::MESSAGE_AVAILABILITY, IUserStatus::DND);
+            return;
+        }
+
+        $nextAutomaticToggle = min($nextPotentialToggles);
+        $this->setLastRunToNextToggleTime($userId, $nextAutomaticToggle - 1);
+
+        if ($isCurrentlyAvailable) {
+            $this->logger->debug('User is currently available, reverting DND status if applicable');
+            $this->manager->revertUserStatus($userId, IUserStatus::MESSAGE_AVAILABILITY, IUserStatus::DND);
+            $this->logger->debug('User status automation ran');
+            return;
+        }
+
+        if (!$hasDndForOfficeHours) {
+            // Office hours are not set to DND, so there is nothing to do.
+            return;
+        }
+
+        $this->logger->debug('User is currently NOT available, reverting call and meeting status if applicable and then setting DND');
+        $this->manager->setUserStatus($userId, IUserStatus::MESSAGE_AVAILABILITY, IUserStatus::DND, true);
+        $this->logger->debug('User status automation ran');
+    }
+
+    private function processOutOfOfficeData(IUser $user, ?IOutOfOfficeData $ooo): bool {
+        if (empty($ooo)) {
+            // Reset the user status if the absence doesn't exist
+            $this->logger->debug('User has no OOO period in effect, reverting DND status if applicable');
+            $this->manager->revertUserStatus($user->getUID(), IUserStatus::MESSAGE_OUT_OF_OFFICE, IUserStatus::DND);
+            // We need to also run the availability automation
+            return true;
+        }
+
+        if (!$this->coordinator->isInEffect($ooo)) {
+            // Reset the user status if the absence is (no longer) in effect
+            $this->logger->debug('User has no OOO period in effect, reverting DND status if applicable');
+            $this->manager->revertUserStatus($user->getUID(), IUserStatus::MESSAGE_OUT_OF_OFFICE, IUserStatus::DND);
+
+            if ($ooo->getStartDate() > $this->time->getTime()) {
+                // Set the next run to take place at the start of the ooo period if it is in the future
+                // This might be overwritten if there is an availability setting, but we can't determine
+                // if this is the case here
+                $this->setLastRunToNextToggleTime($user->getUID(), $ooo->getStartDate());
+            }
+            return true;
+        }
+
+        $this->logger->debug('User is currently in an OOO period, reverting other automated status and setting OOO DND status');
+        $this->manager->setUserStatus($user->getUID(), IUserStatus::MESSAGE_OUT_OF_OFFICE, IUserStatus::DND, true, $ooo->getShortMessage());
+
+        // Run at the end of an ooo period to return to availability / regular user status
+        // If it's overwritten by a custom status in the meantime, there's nothing we can do about it
+        $this->setLastRunToNextToggleTime($user->getUID(), $ooo->getEndDate());
+        return false;
+    }
 }

apps/dav/tests/unit/DAV/Listener/UserEventsListenerTest.php

Indentation +154 added lines, -154 removed lines

@@ -26,158 +26,158 @@
 use Test\TestCase;
 
 class UserEventsListenerTest extends TestCase {
-	private IUserManager&MockObject $userManager;
-	private SyncService&MockObject $syncService;
-	private CalDavBackend&MockObject $calDavBackend;
-	private CardDavBackend&MockObject $cardDavBackend;
-	private Defaults&MockObject $defaults;
-	private ExampleContactService&MockObject $exampleContactService;
-	private ExampleEventService&MockObject $exampleEventService;
-	private LoggerInterface&MockObject $logger;
-
-	private UserEventsListener $userEventsListener;
-
-	protected function setUp(): void {
-		parent::setUp();
-
-		$this->userManager = $this->createMock(IUserManager::class);
-		$this->syncService = $this->createMock(SyncService::class);
-		$this->calDavBackend = $this->createMock(CalDavBackend::class);
-		$this->cardDavBackend = $this->createMock(CardDavBackend::class);
-		$this->defaults = $this->createMock(Defaults::class);
-		$this->exampleContactService = $this->createMock(ExampleContactService::class);
-		$this->exampleEventService = $this->createMock(ExampleEventService::class);
-		$this->logger = $this->createMock(LoggerInterface::class);
-		$this->jobList = $this->createMock(IJobList::class);
-
-		$this->userEventsListener = new UserEventsListener(
-			$this->userManager,
-			$this->syncService,
-			$this->calDavBackend,
-			$this->cardDavBackend,
-			$this->defaults,
-			$this->exampleContactService,
-			$this->exampleEventService,
-			$this->logger,
-			$this->jobList,
-		);
-	}
-
-	public function test(): void {
-		$user = $this->createMock(IUser::class);
-		$user->expects($this->once())->method('getUID')->willReturn('newUser');
-
-		$this->defaults->expects($this->once())->method('getColorPrimary')->willReturn('#745bca');
-
-		$this->calDavBackend->expects($this->once())->method('getCalendarsForUserCount')->willReturn(0);
-		$this->calDavBackend->expects($this->once())->method('createCalendar')->with(
-			'principals/users/newUser',
-			'personal', [
-				'{DAV:}displayname' => 'Personal',
-				'{http://apple.com/ns/ical/}calendar-color' => '#745bca',
-				'components' => 'VEVENT'
-			])
-			->willReturn(1000);
-		$this->calDavBackend->expects(self::never())
-			->method('getCalendarsForUser');
-		$this->exampleEventService->expects(self::once())
-			->method('createExampleEvent')
-			->with(1000);
-
-		$this->cardDavBackend->expects($this->once())->method('getAddressBooksForUserCount')->willReturn(0);
-		$this->cardDavBackend->expects($this->once())->method('createAddressBook')->with(
-			'principals/users/newUser',
-			'contacts', ['{DAV:}displayname' => 'Contacts']);
-
-		$this->userEventsListener->firstLogin($user);
-	}
-
-	public function testWithExisting(): void {
-		$user = $this->createMock(IUser::class);
-		$user->expects($this->once())->method('getUID')->willReturn('newUser');
-
-		$this->calDavBackend->expects($this->once())->method('getCalendarsForUserCount')->willReturn(1);
-		$this->calDavBackend->expects($this->never())->method('createCalendar');
-		$this->calDavBackend->expects(self::never())
-			->method('createCalendar');
-		$this->exampleEventService->expects(self::never())
-			->method('createExampleEvent');
-
-		$this->cardDavBackend->expects($this->once())->method('getAddressBooksForUserCount')->willReturn(1);
-		$this->cardDavBackend->expects($this->never())->method('createAddressBook');
-
-		$this->userEventsListener->firstLogin($user);
-	}
-
-	public function testWithBirthdayCalendar(): void {
-		$user = $this->createMock(IUser::class);
-		$user->expects($this->once())->method('getUID')->willReturn('newUser');
-
-		$this->defaults->expects($this->once())->method('getColorPrimary')->willReturn('#745bca');
-
-		$this->calDavBackend->expects($this->once())->method('getCalendarsForUserCount')->willReturn(0);
-		$this->calDavBackend->expects($this->once())->method('createCalendar')->with(
-			'principals/users/newUser',
-			'personal', [
-				'{DAV:}displayname' => 'Personal',
-				'{http://apple.com/ns/ical/}calendar-color' => '#745bca',
-				'components' => 'VEVENT'
-			]);
-
-		$this->cardDavBackend->expects($this->once())->method('getAddressBooksForUserCount')->willReturn(0);
-		$this->cardDavBackend->expects($this->once())->method('createAddressBook')->with(
-			'principals/users/newUser',
-			'contacts', ['{DAV:}displayname' => 'Contacts']);
-
-		$this->userEventsListener->firstLogin($user);
-	}
-
-	public function testDeleteCalendar(): void {
-		$user = $this->createMock(IUser::class);
-		$user->expects($this->once())->method('getUID')->willReturn('newUser');
-
-		$this->syncService->expects($this->once())
-			->method('deleteUser');
-
-		$this->calDavBackend->expects($this->once())->method('getUsersOwnCalendars')->willReturn([
-			['id' => 'personal']
-		]);
-		$this->calDavBackend->expects($this->once())->method('getSubscriptionsForUser')->willReturn([
-			['id' => 'some-subscription']
-		]);
-		$this->calDavBackend->expects($this->once())->method('deleteCalendar')->with('personal');
-		$this->calDavBackend->expects($this->once())->method('deleteSubscription')->with('some-subscription');
-		$this->calDavBackend->expects($this->once())->method('deleteAllSharesByUser');
-
-		$this->cardDavBackend->expects($this->once())->method('getUsersOwnAddressBooks')->willReturn([
-			['id' => 'personal']
-		]);
-		$this->cardDavBackend->expects($this->once())->method('deleteAddressBook');
-
-		$this->userEventsListener->preDeleteUser($user);
-		$this->userEventsListener->postDeleteUser('newUser');
-	}
-
-	public function testDeleteUserAutomationEvent(): void {
-		$user = $this->createMock(IUser::class);
-		$user->expects($this->once())->method('getUID')->willReturn('newUser');
-
-		$this->syncService->expects($this->once())
-			->method('deleteUser');
-
-		$this->calDavBackend->expects($this->once())->method('getUsersOwnCalendars')->willReturn([
-			['id' => []]
-		]);
-		$this->calDavBackend->expects($this->once())->method('getSubscriptionsForUser')->willReturn([
-			['id' => []]
-		]);
-		$this->cardDavBackend->expects($this->once())->method('getUsersOwnAddressBooks')->willReturn([
-			['id' => []]
-		]);
-
-		$this->jobList->expects(self::once())->method('remove')->with(UserStatusAutomation::class, ['userId' => 'newUser']);
-
-		$this->userEventsListener->preDeleteUser($user);
-		$this->userEventsListener->postDeleteUser('newUser');
-	}
+    private IUserManager&MockObject $userManager;
+    private SyncService&MockObject $syncService;
+    private CalDavBackend&MockObject $calDavBackend;
+    private CardDavBackend&MockObject $cardDavBackend;
+    private Defaults&MockObject $defaults;
+    private ExampleContactService&MockObject $exampleContactService;
+    private ExampleEventService&MockObject $exampleEventService;
+    private LoggerInterface&MockObject $logger;
+
+    private UserEventsListener $userEventsListener;
+
+    protected function setUp(): void {
+        parent::setUp();
+
+        $this->userManager = $this->createMock(IUserManager::class);
+        $this->syncService = $this->createMock(SyncService::class);
+        $this->calDavBackend = $this->createMock(CalDavBackend::class);
+        $this->cardDavBackend = $this->createMock(CardDavBackend::class);
+        $this->defaults = $this->createMock(Defaults::class);
+        $this->exampleContactService = $this->createMock(ExampleContactService::class);
+        $this->exampleEventService = $this->createMock(ExampleEventService::class);
+        $this->logger = $this->createMock(LoggerInterface::class);
+        $this->jobList = $this->createMock(IJobList::class);
+
+        $this->userEventsListener = new UserEventsListener(
+            $this->userManager,
+            $this->syncService,
+            $this->calDavBackend,
+            $this->cardDavBackend,
+            $this->defaults,
+            $this->exampleContactService,
+            $this->exampleEventService,
+            $this->logger,
+            $this->jobList,
+        );
+    }
+
+    public function test(): void {
+        $user = $this->createMock(IUser::class);
+        $user->expects($this->once())->method('getUID')->willReturn('newUser');
+
+        $this->defaults->expects($this->once())->method('getColorPrimary')->willReturn('#745bca');
+
+        $this->calDavBackend->expects($this->once())->method('getCalendarsForUserCount')->willReturn(0);
+        $this->calDavBackend->expects($this->once())->method('createCalendar')->with(
+            'principals/users/newUser',
+            'personal', [
+                '{DAV:}displayname' => 'Personal',
+                '{http://apple.com/ns/ical/}calendar-color' => '#745bca',
+                'components' => 'VEVENT'
+            ])
+            ->willReturn(1000);
+        $this->calDavBackend->expects(self::never())
+            ->method('getCalendarsForUser');
+        $this->exampleEventService->expects(self::once())
+            ->method('createExampleEvent')
+            ->with(1000);
+
+        $this->cardDavBackend->expects($this->once())->method('getAddressBooksForUserCount')->willReturn(0);
+        $this->cardDavBackend->expects($this->once())->method('createAddressBook')->with(
+            'principals/users/newUser',
+            'contacts', ['{DAV:}displayname' => 'Contacts']);
+
+        $this->userEventsListener->firstLogin($user);
+    }
+
+    public function testWithExisting(): void {
+        $user = $this->createMock(IUser::class);
+        $user->expects($this->once())->method('getUID')->willReturn('newUser');
+
+        $this->calDavBackend->expects($this->once())->method('getCalendarsForUserCount')->willReturn(1);
+        $this->calDavBackend->expects($this->never())->method('createCalendar');
+        $this->calDavBackend->expects(self::never())
+            ->method('createCalendar');
+        $this->exampleEventService->expects(self::never())
+            ->method('createExampleEvent');
+
+        $this->cardDavBackend->expects($this->once())->method('getAddressBooksForUserCount')->willReturn(1);
+        $this->cardDavBackend->expects($this->never())->method('createAddressBook');
+
+        $this->userEventsListener->firstLogin($user);
+    }
+
+    public function testWithBirthdayCalendar(): void {
+        $user = $this->createMock(IUser::class);
+        $user->expects($this->once())->method('getUID')->willReturn('newUser');
+
+        $this->defaults->expects($this->once())->method('getColorPrimary')->willReturn('#745bca');
+
+        $this->calDavBackend->expects($this->once())->method('getCalendarsForUserCount')->willReturn(0);
+        $this->calDavBackend->expects($this->once())->method('createCalendar')->with(
+            'principals/users/newUser',
+            'personal', [
+                '{DAV:}displayname' => 'Personal',
+                '{http://apple.com/ns/ical/}calendar-color' => '#745bca',
+                'components' => 'VEVENT'
+            ]);
+
+        $this->cardDavBackend->expects($this->once())->method('getAddressBooksForUserCount')->willReturn(0);
+        $this->cardDavBackend->expects($this->once())->method('createAddressBook')->with(
+            'principals/users/newUser',
+            'contacts', ['{DAV:}displayname' => 'Contacts']);
+
+        $this->userEventsListener->firstLogin($user);
+    }
+
+    public function testDeleteCalendar(): void {
+        $user = $this->createMock(IUser::class);
+        $user->expects($this->once())->method('getUID')->willReturn('newUser');
+
+        $this->syncService->expects($this->once())
+            ->method('deleteUser');
+
+        $this->calDavBackend->expects($this->once())->method('getUsersOwnCalendars')->willReturn([
+            ['id' => 'personal']
+        ]);
+        $this->calDavBackend->expects($this->once())->method('getSubscriptionsForUser')->willReturn([
+            ['id' => 'some-subscription']
+        ]);
+        $this->calDavBackend->expects($this->once())->method('deleteCalendar')->with('personal');
+        $this->calDavBackend->expects($this->once())->method('deleteSubscription')->with('some-subscription');
+        $this->calDavBackend->expects($this->once())->method('deleteAllSharesByUser');
+
+        $this->cardDavBackend->expects($this->once())->method('getUsersOwnAddressBooks')->willReturn([
+            ['id' => 'personal']
+        ]);
+        $this->cardDavBackend->expects($this->once())->method('deleteAddressBook');
+
+        $this->userEventsListener->preDeleteUser($user);
+        $this->userEventsListener->postDeleteUser('newUser');
+    }
+
+    public function testDeleteUserAutomationEvent(): void {
+        $user = $this->createMock(IUser::class);
+        $user->expects($this->once())->method('getUID')->willReturn('newUser');
+
+        $this->syncService->expects($this->once())
+            ->method('deleteUser');
+
+        $this->calDavBackend->expects($this->once())->method('getUsersOwnCalendars')->willReturn([
+            ['id' => []]
+        ]);
+        $this->calDavBackend->expects($this->once())->method('getSubscriptionsForUser')->willReturn([
+            ['id' => []]
+        ]);
+        $this->cardDavBackend->expects($this->once())->method('getUsersOwnAddressBooks')->willReturn([
+            ['id' => []]
+        ]);
+
+        $this->jobList->expects(self::once())->method('remove')->with(UserStatusAutomation::class, ['userId' => 'newUser']);
+
+        $this->userEventsListener->preDeleteUser($user);
+        $this->userEventsListener->postDeleteUser('newUser');
+    }
 }