Merge pull request #41957 from nextcloud/feat/41458/add-ocs-endpoint-…

…for-setting-ooo feat(out-of-office): Add OCS endpoint to set and clear absence
nextcloud · Dec 1, 2023 · 1ca7ba7 · 1ca7ba7
2 parents 3267ad7 + 2ff3a3c
commit 1ca7ba7
Show file tree

Hide file tree

Showing 9 changed files with 357 additions and 109 deletions.
diff --git a/apps/dav/appinfo/routes.php b/apps/dav/appinfo/routes.php
@@ -30,11 +30,11 @@
 		['name' => 'invitation_response#decline', 'url' => '/invitation/decline/{token}', 'verb' => 'GET'],
 		['name' => 'invitation_response#options', 'url' => '/invitation/moreOptions/{token}', 'verb' => 'GET'],
 		['name' => 'invitation_response#processMoreOptionsResult', 'url' => '/invitation/moreOptions/{token}', 'verb' => 'POST'],
-		['name' => 'availability_settings#updateAbsence', 'url' => '/settings/absence', 'verb' => 'POST'],
-		['name' => 'availability_settings#clearAbsence', 'url' => '/settings/absence', 'verb' => 'DELETE'],
 	],
 	'ocs' => [
 		['name' => 'direct#getUrl', 'url' => '/api/v1/direct', 'verb' => 'POST'],
 		['name' => 'out_of_office#getCurrentOutOfOfficeData', 'url' => '/api/v1/outOfOffice/{userId}', 'verb' => 'GET'],
+		['name' => 'out_of_office#setOutOfOffice', 'url' => '/api/v1/outOfOffice/{userId}', 'verb' => 'POST'],
+		['name' => 'out_of_office#clearOutOfOffice', 'url' => '/api/v1/outOfOffice/{userId}', 'verb' => 'DELETE'],
 	],
 ];
diff --git a/apps/dav/composer/composer/autoload_classmap.php b/apps/dav/composer/composer/autoload_classmap.php
@@ -193,7 +193,6 @@
     'OCA\\DAV\\Connector\\Sabre\\SharesPlugin' => $baseDir . '/../lib/Connector/Sabre/SharesPlugin.php',
     'OCA\\DAV\\Connector\\Sabre\\TagList' => $baseDir . '/../lib/Connector/Sabre/TagList.php',
     'OCA\\DAV\\Connector\\Sabre\\TagsPlugin' => $baseDir . '/../lib/Connector/Sabre/TagsPlugin.php',
-    'OCA\\DAV\\Controller\\AvailabilitySettingsController' => $baseDir . '/../lib/Controller/AvailabilitySettingsController.php',
     'OCA\\DAV\\Controller\\BirthdayCalendarController' => $baseDir . '/../lib/Controller/BirthdayCalendarController.php',
     'OCA\\DAV\\Controller\\DirectController' => $baseDir . '/../lib/Controller/DirectController.php',
     'OCA\\DAV\\Controller\\InvitationResponseController' => $baseDir . '/../lib/Controller/InvitationResponseController.php',

diff --git a/apps/dav/composer/composer/autoload_static.php b/apps/dav/composer/composer/autoload_static.php
@@ -208,7 +208,6 @@ class ComposerStaticInitDAV
         'OCA\\DAV\\Connector\\Sabre\\SharesPlugin' => __DIR__ . '/..' . '/../lib/Connector/Sabre/SharesPlugin.php',
         'OCA\\DAV\\Connector\\Sabre\\TagList' => __DIR__ . '/..' . '/../lib/Connector/Sabre/TagList.php',
         'OCA\\DAV\\Connector\\Sabre\\TagsPlugin' => __DIR__ . '/..' . '/../lib/Connector/Sabre/TagsPlugin.php',
-        'OCA\\DAV\\Controller\\AvailabilitySettingsController' => __DIR__ . '/..' . '/../lib/Controller/AvailabilitySettingsController.php',
         'OCA\\DAV\\Controller\\BirthdayCalendarController' => __DIR__ . '/..' . '/../lib/Controller/BirthdayCalendarController.php',
         'OCA\\DAV\\Controller\\DirectController' => __DIR__ . '/..' . '/../lib/Controller/DirectController.php',
         'OCA\\DAV\\Controller\\InvitationResponseController' => __DIR__ . '/..' . '/../lib/Controller/InvitationResponseController.php',

diff --git a/apps/dav/lib/Controller/AvailabilitySettingsController.php b/apps/dav/lib/Controller/AvailabilitySettingsController.php
diff --git a/apps/dav/lib/Controller/OutOfOfficeController.php b/apps/dav/lib/Controller/OutOfOfficeController.php
@@ -26,14 +26,18 @@
 
 namespace OCA\DAV\Controller;
 
+use DateTimeImmutable;
 use OCA\DAV\Db\AbsenceMapper;
 use OCA\DAV\ResponseDefinitions;
+use OCA\DAV\Service\AbsenceService;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\Attribute\NoAdminRequired;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCSController;
 use OCP\IRequest;
+use OCP\IUserSession;
+use OCP\User\IAvailabilityCoordinator;
 
 /**
  * @psalm-import-type DAVOutOfOfficeData from ResponseDefinitions
@@ -44,6 +48,9 @@ public function __construct(
 		string $appName,
 		IRequest $request,
 		private AbsenceMapper $absenceMapper,
+		private ?IUserSession $userSession,
+		private AbsenceService $absenceService,
+		private IAvailabilityCoordinator $coordinator,
 	) {
 		parent::__construct($appName, $request);
 	}
@@ -74,4 +81,74 @@ public function getCurrentOutOfOfficeData(string $userId): DataResponse {
 			'message' => $data->getMessage(),
 		]);
 	}
+
+	/**
+	 * Set out-of-office absence
+	 *
+	 * @param string $firstDay First day of the absence in format `YYYY-MM-DD`
+	 * @param string $lastDay Last day of the absence in format `YYYY-MM-DD`
+	 * @param string $status Short text that is set as user status during the absence
+	 * @param string $message Longer multiline message that is shown to others during the absence
+	 * @return DataResponse<Http::STATUS_OK, DAVOutOfOfficeData, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, array{error: 'firstDay'}, array{}>|DataResponse<Http::STATUS_UNAUTHORIZED, null, array{}>
+	 *
+	 * 200: Absence data
+	 * 400: When the first day is not before the last day
+	 * 401: When the user is not logged in
+	 */
+	#[NoAdminRequired]
+	public function setOutOfOffice(
+		string $firstDay,
+		string $lastDay,
+		string $status,
+		string $message,
+	): DataResponse {
+		$user = $this->userSession?->getUser();
+		if ($user === null) {
+			return new DataResponse(null, Http::STATUS_UNAUTHORIZED);
+		}
+
+		$parsedFirstDay = new DateTimeImmutable($firstDay);
+		$parsedLastDay = new DateTimeImmutable($lastDay);
+		if ($parsedFirstDay->getTimestamp() > $parsedLastDay->getTimestamp()) {
+			return new DataResponse(['error' => 'firstDay'], Http::STATUS_BAD_REQUEST);
+		}
+
+		$data = $this->absenceService->createOrUpdateAbsence(
+			$user,
+			$firstDay,
+			$lastDay,
+			$status,
+			$message,
+		);
+		$this->coordinator->clearCache($user->getUID());
+
+		return new DataResponse([
+			'id' => $data->getId(),
+			'userId' => $data->getUserId(),
+			'firstDay' => $data->getFirstDay(),
+			'lastDay' => $data->getLastDay(),
+			'status' => $data->getStatus(),
+			'message' => $data->getMessage(),
+		]);
+	}
+
+	/**
+	 * Clear the out-of-office
+	 *
+	 * @return DataResponse<Http::STATUS_OK|Http::STATUS_UNAUTHORIZED, null, array{}>
+	 *
+	 * 200: When the absence was cleared successfully
+	 * 401: When the user is not logged in
+	 */
+	#[NoAdminRequired]
+	public function clearOutOfOffice(): DataResponse {
+		$user = $this->userSession?->getUser();
+		if ($user === null) {
+			return new DataResponse(null, Http::STATUS_UNAUTHORIZED);
+		}
+
+		$this->absenceService->clearAbsence($user);
+		$this->coordinator->clearCache($user->getUID());
+		return new DataResponse(null);
+	}
 }