-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #41701 from nextcloud/feat/dav/out-of-office-job-s…
…table28 [stable28] feat(dav): dispatch out-of-office started and ended events
- Loading branch information
Showing
20 changed files
with
920 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
92 changes: 92 additions & 0 deletions
92
apps/dav/lib/BackgroundJob/OutOfOfficeEventDispatcherJob.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,92 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2023 Richard Steinmetz <[email protected]> | ||
| * | ||
| * @author Richard Steinmetz <[email protected]> | ||
| * | ||
| * @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\CalDAV\TimezoneService; | ||
| 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, | ||
| private TimezoneService $timezoneService, | ||
| ) { | ||
| parent::__construct($time); | ||
| } | ||
|
|
||
| public function run($argument): void { | ||
| $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, | ||
| $this->timezoneService->getUserTimezone($userId) ?? $this->timezoneService->getDefaultTimezone(), | ||
| ); | ||
| 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, | ||
| ]); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /* | ||
| * @copyright 2023 Christoph Wurst <[email protected]> | ||
| * | ||
| * @author 2023 Christoph Wurst <[email protected]> | ||
| * | ||
| * @license GNU AGPL version 3 or any later version | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero 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 Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| namespace OCA\DAV\CalDAV; | ||
|
|
||
| use OCA\DAV\Db\PropertyMapper; | ||
| use OCP\Calendar\ICalendar; | ||
| use OCP\Calendar\IManager; | ||
| use OCP\IConfig; | ||
| use Sabre\VObject\Component\VCalendar; | ||
| use Sabre\VObject\Component\VTimeZone; | ||
| use Sabre\VObject\Reader; | ||
| use function array_reduce; | ||
|
|
||
| class TimezoneService { | ||
|
|
||
| public function __construct(private IConfig $config, | ||
| private PropertyMapper $propertyMapper, | ||
| private IManager $calendarManager) { | ||
| } | ||
|
|
||
| public function getUserTimezone(string $userId): ?string { | ||
| $availabilityPropPath = 'calendars/' . $userId . '/inbox'; | ||
| $availabilityProp = '{' . Plugin::NS_CALDAV . '}calendar-availability'; | ||
| $availabilities = $this->propertyMapper->findPropertyByPathAndName($userId, $availabilityPropPath, $availabilityProp); | ||
| if (!empty($availabilities)) { | ||
| $availability = $availabilities[0]->getPropertyvalue(); | ||
| /** @var VCalendar $vCalendar */ | ||
| $vCalendar = Reader::read($availability); | ||
| /** @var VTimeZone $vTimezone */ | ||
| $vTimezone = $vCalendar->VTIMEZONE; | ||
| // Sabre has a fallback to date_default_timezone_get | ||
| return $vTimezone->getTimeZone()->getName(); | ||
| } | ||
|
|
||
| $principal = 'principals/users/' . $userId; | ||
| $uri = $this->config->getUserValue($userId, 'dav', 'defaultCalendar', CalDavBackend::PERSONAL_CALENDAR_URI); | ||
| $calendars = $this->calendarManager->getCalendarsForPrincipal($principal); | ||
|
|
||
| /** @var ?VTimeZone $personalCalendarTimezone */ | ||
| $personalCalendarTimezone = array_reduce($calendars, function (?VTimeZone $acc, ICalendar $calendar) use ($uri) { | ||
| if ($acc !== null) { | ||
| return $acc; | ||
| } | ||
| if ($calendar->getUri() === $uri && !$calendar->isDeleted() && $calendar instanceof CalendarImpl) { | ||
| return $calendar->getSchedulingTimezone(); | ||
| } | ||
| return null; | ||
| }); | ||
| if ($personalCalendarTimezone !== null) { | ||
| return $personalCalendarTimezone->getTimeZone()->getName(); | ||
| } | ||
|
|
||
| // No timezone in the personalCalendarTimezone calendar or no personalCalendarTimezone calendar | ||
| // Loop through all calendars until we find a timezone. | ||
| /** @var ?VTimeZone $firstTimezone */ | ||
| $firstTimezone = array_reduce($calendars, function (?VTimeZone $acc, ICalendar $calendar) { | ||
| if ($acc !== null) { | ||
| return $acc; | ||
| } | ||
| if (!$calendar->isDeleted() && $calendar instanceof CalendarImpl) { | ||
| return $calendar->getSchedulingTimezone(); | ||
| } | ||
| return null; | ||
| }); | ||
| if ($firstTimezone !== null) { | ||
| return $firstTimezone->getTimeZone()->getName(); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| public function getDefaultTimezone(): string { | ||
| return $this->config->getSystemValueString('default_timezone', 'UTC'); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.