1 files changed, 35 insertions, 54 deletions

diff --git a/apps/user_status/lib/Controller/HeartbeatController.php b/apps/user_status/lib/Controller/HeartbeatController.php
index c11a63b4420..30f4af6572a 100644
--- a/apps/user_status/lib/Controller/HeartbeatController.php
+++ b/apps/user_status/lib/Controller/HeartbeatController.php
@@ -3,34 +3,19 @@
 declare(strict_types=1);
 
 /**
- * @copyright Copyright (c) 2020, Georg Ehrke
- *
- * @author Georg Ehrke <oc.list@georgehrke.com>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 namespace OCA\UserStatus\Controller;
 
 use OCA\UserStatus\Db\UserStatus;
+use OCA\UserStatus\ResponseDefinitions;
 use OCA\UserStatus\Service\StatusService;
-use OCP\AppFramework\Controller;
-use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Http;
-use OCP\AppFramework\Http\JSONResponse;
+use OCP\AppFramework\Http\Attribute\ApiRoute;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\AppFramework\OCSController;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\IRequest;
@@ -38,47 +23,43 @@ use OCP\IUserSession;
 use OCP\User\Events\UserLiveStatusEvent;
 use OCP\UserStatus\IUserStatus;
 
-class HeartbeatController extends Controller {
-
-	/** @var IEventDispatcher */
-	private $eventDispatcher;
-
-	/** @var IUserSession */
-	private $userSession;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/** @var StatusService */
-	private $service;
-
-	public function __construct(string $appName,
-								IRequest $request,
-								IEventDispatcher $eventDispatcher,
-								IUserSession $userSession,
-								ITimeFactory $timeFactory,
-								StatusService $service) {
+/**
+ * @psalm-import-type UserStatusPrivate from ResponseDefinitions
+ */
+class HeartbeatController extends OCSController {
+
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		private IEventDispatcher $eventDispatcher,
+		private IUserSession $userSession,
+		private ITimeFactory $timeFactory,
+		private StatusService $service,
+	) {
 		parent::__construct($appName, $request);
-		$this->eventDispatcher = $eventDispatcher;
-		$this->userSession = $userSession;
-		$this->timeFactory = $timeFactory;
-		$this->service = $service;
 	}
 
 	/**
-	 * @NoAdminRequired
+	 * Keep the status alive
+	 *
+	 * @param string $status Only online, away
+	 *
+	 * @return DataResponse<Http::STATUS_OK, UserStatusPrivate, array{}>|DataResponse<Http::STATUS_BAD_REQUEST|Http::STATUS_INTERNAL_SERVER_ERROR|Http::STATUS_NO_CONTENT, list<empty>, array{}>
 	 *
-	 * @param string $status
-	 * @return JSONResponse
+	 * 200: Status successfully updated
+	 * 204: User has no status to keep alive
+	 * 400: Invalid status to update
 	 */
-	public function heartbeat(string $status): JSONResponse {
+	#[NoAdminRequired]
+	#[ApiRoute(verb: 'PUT', url: '/api/v1/heartbeat')]
+	public function heartbeat(string $status): DataResponse {
 		if (!\in_array($status, [IUserStatus::ONLINE, IUserStatus::AWAY], true)) {
-			return new JSONResponse([], Http::STATUS_BAD_REQUEST);
+			return new DataResponse([], Http::STATUS_BAD_REQUEST);
 		}
 
 		$user = $this->userSession->getUser();
 		if ($user === null) {
-			return new JSONResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
+			return new DataResponse([], Http::STATUS_INTERNAL_SERVER_ERROR);
 		}
 
 		$event = new UserLiveStatusEvent(
@@ -91,11 +72,11 @@ class HeartbeatController extends Controller {
 
 		$userStatus = $event->getUserStatus();
 		if (!$userStatus) {
-			return new JSONResponse([], Http::STATUS_NO_CONTENT);
+			return new DataResponse([], Http::STATUS_NO_CONTENT);
 		}
 
 		/** @psalm-suppress UndefinedInterfaceMethod */
-		return new JSONResponse($this->formatStatus($userStatus->getInternal()));
+		return new DataResponse($this->formatStatus($userStatus->getInternal()));
 	}
 
 	private function formatStatus(UserStatus $status): array {