aboutsummaryrefslogtreecommitdiffstats
path: root/core/Controller/GuestAvatarController.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/Controller/GuestAvatarController.php')
-rw-r--r--core/Controller/GuestAvatarController.php100
1 files changed, 47 insertions, 53 deletions
diff --git a/core/Controller/GuestAvatarController.php b/core/Controller/GuestAvatarController.php
index 6d14474ed44..711158e0708 100644
--- a/core/Controller/GuestAvatarController.php
+++ b/core/Controller/GuestAvatarController.php
@@ -1,80 +1,56 @@
<?php
+
/**
- * @copyright Copyright (c) 2019, Michael Weimann <mail@michael-weimann.eu>
- *
- * @author Michael Weimann <mail@michael-weimann.eu>
- *
- * @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: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Core\Controller;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\FrontpageRoute;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
+use OCP\AppFramework\Http\Attribute\PublicPage;
use OCP\AppFramework\Http\FileDisplayResponse;
+use OCP\AppFramework\Http\Response;
use OCP\IAvatarManager;
-use OCP\ILogger;
use OCP\IRequest;
+use Psr\Log\LoggerInterface;
/**
* This controller handles guest avatar requests.
*/
class GuestAvatarController extends Controller {
-
- /**
- * @var ILogger
- */
- private $logger;
-
- /**
- * @var IAvatarManager
- */
- private $avatarManager;
-
/**
* GuestAvatarController constructor.
- *
- * @param $appName
- * @param IRequest $request
- * @param IAvatarManager $avatarManager
- * @param ILogger $logger
*/
public function __construct(
- $appName,
+ string $appName,
IRequest $request,
- IAvatarManager $avatarManager,
- ILogger $logger
+ private IAvatarManager $avatarManager,
+ private LoggerInterface $logger,
) {
parent::__construct($appName, $request);
- $this->avatarManager = $avatarManager;
- $this->logger = $logger;
}
/**
- * Returns a guest avatar image response.
- *
- * @PublicPage
- * @NoCSRFRequired
+ * Returns a guest avatar image response
*
* @param string $guestName The guest name, e.g. "Albert"
- * @param string $size The desired avatar size, e.g. 64 for 64x64px
- * @return FileDisplayResponse|Http\Response
+ * @param 64|512 $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, X-NC-IsCustomAvatar: int}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
+ *
+ * 200: Custom avatar returned
+ * 201: Avatar returned
*/
- public function getAvatar($guestName, $size) {
- $size = (int) $size;
+ #[PublicPage]
+ #[NoCSRFRequired]
+ #[FrontpageRoute(verb: 'GET', url: '/avatar/guest/{guestName}/{size}')]
+ #[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]
+ public function getAvatar(string $guestName, int $size, ?bool $darkTheme = false) {
+ $darkTheme = $darkTheme ?? false;
if ($size <= 64) {
if ($size !== 64) {
@@ -90,24 +66,42 @@ class GuestAvatarController extends Controller {
try {
$avatar = $this->avatarManager->getGuestAvatar($guestName);
- $avatarFile = $avatar->getFile($size);
+ $avatarFile = $avatar->getFile($size, $darkTheme);
$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', [
'err' => $e,
]);
- $resp = new Http\Response();
+ $resp = new Response();
$resp->setStatus(Http::STATUS_INTERNAL_SERVER_ERROR);
return $resp;
}
// Cache for 30 minutes
- $resp->cacheFor(1800);
+ $resp->cacheFor(1800, false, true);
return $resp;
}
+
+ /**
+ * Returns a dark guest avatar image response
+ *
+ * @param string $guestName The guest name, e.g. "Albert"
+ * @param 64|512 $size The desired avatar size, e.g. 64 for 64x64px
+ * @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
+ */
+ #[PublicPage]
+ #[NoCSRFRequired]
+ #[FrontpageRoute(verb: 'GET', url: '/avatar/guest/{guestName}/{size}/dark')]
+ #[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]
+ public function getAvatarDark(string $guestName, int $size) {
+ return $this->getAvatar($guestName, $size, true);
+ }
}