fix(core): Return X-NC-IsCustomAvatar for guest avatars too

Signed-off-by: provokateurin <kate@provokateurin.de>
nextcloud · Jun 12, 2024 · 0f9e5dd · 0f9e5dd
1 parent f1f2f5c
commit 0f9e5dd
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/core/Controller/AvatarController.php b/core/Controller/AvatarController.php
@@ -80,9 +80,10 @@ public function __construct(
 	 * @param string $userId ID of the user
 	 * @param int $size Size of the avatar
 	 * @param bool $guestFallback Fallback to guest avatar if not found
-	 * @return FileDisplayResponse<Http::STATUS_OK|Http::STATUS_CREATED, array{Content-Type: string, X-NC-IsCustomAvatar?: int}>|JSONResponse<Http::STATUS_NOT_FOUND, array<empty>, array{}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
+	 * @return FileDisplayResponse<Http::STATUS_OK|Http::STATUS_CREATED, array{Content-Type: string, X-NC-IsCustomAvatar: int}>|JSONResponse<Http::STATUS_NOT_FOUND, array<empty>, array{}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
 	 *
 	 * 200: Avatar returned
+	 * 201: Avatar returned
 	 * 404: Avatar not found
 	 */
 	public function getAvatarDark(string $userId, int $size, bool $guestFallback = false) {
@@ -130,9 +131,10 @@ public function getAvatarDark(string $userId, int $size, bool $guestFallback = f
 	 * @param string $userId ID of the user
 	 * @param int $size Size of the avatar
 	 * @param bool $guestFallback Fallback to guest avatar if not found
-	 * @return FileDisplayResponse<Http::STATUS_OK|Http::STATUS_CREATED, array{Content-Type: string, X-NC-IsCustomAvatar?: int}>|JSONResponse<Http::STATUS_NOT_FOUND, array<empty>, array{}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
+	 * @return FileDisplayResponse<Http::STATUS_OK|Http::STATUS_CREATED, array{Content-Type: string, X-NC-IsCustomAvatar: int}>|JSONResponse<Http::STATUS_NOT_FOUND, array<empty>, array{}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
 	 *
 	 * 200: Avatar returned
+	 * 201: Avatar returned
 	 * 404: Avatar not found
 	 */
 	public function getAvatar(string $userId, int $size, bool $guestFallback = false) {

diff --git a/core/Controller/GuestAvatarController.php b/core/Controller/GuestAvatarController.php
@@ -56,7 +56,7 @@ public function __construct(
 	 * @param string $guestName The guest name, e.g. "Albert"
 	 * @param string $size The desired avatar size, e.g. 64 for 64x64px
 	 * @param bool|null $darkTheme Return dark avatar
-	 * @return FileDisplayResponse<Http::STATUS_OK|Http::STATUS_CREATED, array{Content-Type: string}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
+	 * @return FileDisplayResponse<Http::STATUS_OK|Http::STATUS_CREATED, array{Content-Type: string, X-NC-IsCustomAvatar: int}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
 	 *
 	 * 200: Custom avatar returned
 	 * 201: Avatar returned
@@ -84,7 +84,7 @@ public function getAvatar(string $guestName, string $size, ?bool $darkTheme = fa
 			$resp = new FileDisplayResponse(
 				$avatarFile,
 				$avatar->isCustomAvatar() ? Http::STATUS_OK : Http::STATUS_CREATED,
-				['Content-Type' => $avatarFile->getMimeType()]
+				['Content-Type' => $avatarFile->getMimeType(), 'X-NC-IsCustomAvatar' => (int)$avatar->isCustomAvatar()]
 			);
 		} catch (\Exception $e) {
 			$this->logger->error('error while creating guest avatar', [
@@ -108,7 +108,7 @@ public function getAvatar(string $guestName, string $size, ?bool $darkTheme = fa
 	 *
 	 * @param string $guestName The guest name, e.g. "Albert"
 	 * @param string $size The desired avatar size, e.g. 64 for 64x64px
-	 * @return FileDisplayResponse<Http::STATUS_OK|Http::STATUS_CREATED, array{Content-Type: string}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
+	 * @return FileDisplayResponse<Http::STATUS_OK|Http::STATUS_CREATED, array{Content-Type: string, X-NC-IsCustomAvatar: int}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
 	 *
 	 * 200: Custom avatar returned
 	 * 201: Avatar returned