aboutsummaryrefslogtreecommitdiffstats
path: root/core/Controller/AvatarController.php
diff options
context:
space:
mode:
Diffstat (limited to 'core/Controller/AvatarController.php')
-rw-r--r--core/Controller/AvatarController.php322
1 files changed, 177 insertions, 145 deletions
diff --git a/core/Controller/AvatarController.php b/core/Controller/AvatarController.php
index 69ec2f4bffe..b577b2fd460 100644
--- a/core/Controller/AvatarController.php
+++ b/core/Controller/AvatarController.php
@@ -1,50 +1,35 @@
<?php
+
/**
- * @copyright Copyright (c) 2016, ownCloud, Inc.
- *
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Daniel Kesselberg <mail@danielkesselberg.de>
- * @author Joas Schilling <coding@schilljs.com>
- * @author John Molakvoæ (skjnldsv) <skjnldsv@protonmail.com>
- * @author Lukas Reschke <lukas@statuscode.ch>
- * @author Morris Jobke <hey@morrisjobke.de>
- * @author Roeland Jago Douma <roeland@famdouma.nl>
- * @author Thomas Müller <thomas.mueller@tmit.eu>
- * @author Vincent Petry <vincent@nextcloud.com>
- *
- * @license AGPL-3.0
- *
- * This code is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License, version 3,
- * as published by the Free Software Foundation.
- *
- * 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, version 3,
- * along with this program. If not, see <http://www.gnu.org/licenses/>
- *
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-only
*/
-
namespace OC\Core\Controller;
use OC\AppFramework\Utility\TimeFactory;
+use OC\NotSquareException;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\FrontpageRoute;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\OpenAPI;
+use OCP\AppFramework\Http\Attribute\PublicPage;
use OCP\AppFramework\Http\DataDisplayResponse;
use OCP\AppFramework\Http\FileDisplayResponse;
use OCP\AppFramework\Http\JSONResponse;
+use OCP\AppFramework\Http\Response;
use OCP\Files\File;
use OCP\Files\IRootFolder;
+use OCP\Files\NotPermittedException;
use OCP\IAvatarManager;
use OCP\ICache;
use OCP\IL10N;
-use OCP\ILogger;
+use OCP\Image;
use OCP\IRequest;
use OCP\IUserManager;
-use OCP\IUserSession;
+use Psr\Log\LoggerInterface;
/**
* Class AvatarController
@@ -52,73 +37,103 @@ use OCP\IUserSession;
* @package OC\Core\Controller
*/
class AvatarController extends Controller {
+ public function __construct(
+ string $appName,
+ IRequest $request,
+ protected IAvatarManager $avatarManager,
+ protected ICache $cache,
+ protected IL10N $l10n,
+ protected IUserManager $userManager,
+ protected IRootFolder $rootFolder,
+ protected LoggerInterface $logger,
+ protected ?string $userId,
+ protected TimeFactory $timeFactory,
+ protected GuestAvatarController $guestAvatarController,
+ ) {
+ parent::__construct($appName, $request);
+ }
- /** @var IAvatarManager */
- protected $avatarManager;
-
- /** @var ICache */
- protected $cache;
-
- /** @var IL10N */
- protected $l;
-
- /** @var IUserManager */
- protected $userManager;
-
- /** @var IUserSession */
- protected $userSession;
-
- /** @var IRootFolder */
- protected $rootFolder;
-
- /** @var ILogger */
- protected $logger;
-
- /** @var string */
- protected $userId;
-
- /** @var TimeFactory */
- protected $timeFactory;
+ /**
+ * @NoSameSiteCookieRequired
+ *
+ * Get the dark avatar
+ *
+ * @param string $userId ID of the user
+ * @param 64|512 $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, list<empty>, array{}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
+ *
+ * 200: Avatar returned
+ * 201: Avatar returned
+ * 404: Avatar not found
+ */
+ #[NoCSRFRequired]
+ #[PublicPage]
+ #[FrontpageRoute(verb: 'GET', url: '/avatar/{userId}/{size}/dark')]
+ #[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]
+ public function getAvatarDark(string $userId, int $size, bool $guestFallback = false) {
+ if ($size <= 64) {
+ if ($size !== 64) {
+ $this->logger->debug('Avatar requested in deprecated size ' . $size);
+ }
+ $size = 64;
+ } else {
+ if ($size !== 512) {
+ $this->logger->debug('Avatar requested in deprecated size ' . $size);
+ }
+ $size = 512;
+ }
- public function __construct($appName,
- IRequest $request,
- IAvatarManager $avatarManager,
- ICache $cache,
- IL10N $l10n,
- IUserManager $userManager,
- IRootFolder $rootFolder,
- ILogger $logger,
- $userId,
- TimeFactory $timeFactory) {
- parent::__construct($appName, $request);
+ try {
+ $avatar = $this->avatarManager->getAvatar($userId);
+ $avatarFile = $avatar->getFile($size, true);
+ $response = new FileDisplayResponse(
+ $avatarFile,
+ Http::STATUS_OK,
+ ['Content-Type' => $avatarFile->getMimeType(), 'X-NC-IsCustomAvatar' => (int)$avatar->isCustomAvatar()]
+ );
+ } catch (\Exception $e) {
+ if ($guestFallback) {
+ return $this->guestAvatarController->getAvatarDark($userId, $size);
+ }
+ return new JSONResponse([], Http::STATUS_NOT_FOUND);
+ }
- $this->avatarManager = $avatarManager;
- $this->cache = $cache;
- $this->l = $l10n;
- $this->userManager = $userManager;
- $this->rootFolder = $rootFolder;
- $this->logger = $logger;
- $this->userId = $userId;
- $this->timeFactory = $timeFactory;
+ // Cache for 1 day
+ $response->cacheFor(60 * 60 * 24, false, true);
+ return $response;
}
/**
- * @NoAdminRequired
- * @NoCSRFRequired
* @NoSameSiteCookieRequired
- * @PublicPage
*
- * @param string $userId
- * @param int $size
- * @return JSONResponse|FileDisplayResponse
+ * Get the avatar
+ *
+ * @param string $userId ID of the user
+ * @param 64|512 $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, list<empty>, array{}>|Response<Http::STATUS_INTERNAL_SERVER_ERROR, array{}>
+ *
+ * 200: Avatar returned
+ * 201: Avatar returned
+ * 404: Avatar not found
*/
- public function getAvatar($userId, $size) {
- // min/max size
- if ($size > 2048) {
- $size = 2048;
- } elseif ($size <= 0) {
+ #[NoCSRFRequired]
+ #[PublicPage]
+ #[FrontpageRoute(verb: 'GET', url: '/avatar/{userId}/{size}')]
+ #[OpenAPI(scope: OpenAPI::SCOPE_DEFAULT)]
+ public function getAvatar(string $userId, int $size, bool $guestFallback = false) {
+ if ($size <= 64) {
+ if ($size !== 64) {
+ $this->logger->debug('Avatar requested in deprecated size ' . $size);
+ }
$size = 64;
+ } else {
+ if ($size !== 512) {
+ $this->logger->debug('Avatar requested in deprecated size ' . $size);
+ }
+ $size = 512;
}
try {
@@ -130,21 +145,20 @@ class AvatarController extends Controller {
['Content-Type' => $avatarFile->getMimeType(), 'X-NC-IsCustomAvatar' => (int)$avatar->isCustomAvatar()]
);
} catch (\Exception $e) {
+ if ($guestFallback) {
+ return $this->guestAvatarController->getAvatar($userId, $size);
+ }
return new JSONResponse([], Http::STATUS_NOT_FOUND);
}
// Cache for 1 day
- $response->cacheFor(60 * 60 * 24);
+ $response->cacheFor(60 * 60 * 24, false, true);
return $response;
}
- /**
- * @NoAdminRequired
- *
- * @param string $path
- * @return JSONResponse
- */
- public function postAvatar($path) {
+ #[NoAdminRequired]
+ #[FrontpageRoute(verb: 'POST', url: '/avatar/')]
+ public function postAvatar(?string $path = null): JSONResponse {
$files = $this->request->getUploadedFile('files');
if (isset($path)) {
@@ -153,39 +167,38 @@ class AvatarController extends Controller {
/** @var File $node */
$node = $userFolder->get($path);
if (!($node instanceof File)) {
- return new JSONResponse(['data' => ['message' => $this->l->t('Please select a file.')]]);
+ return new JSONResponse(['data' => ['message' => $this->l10n->t('Please select a file.')]]);
}
if ($node->getSize() > 20 * 1024 * 1024) {
return new JSONResponse(
- ['data' => ['message' => $this->l->t('File is too big')]],
+ ['data' => ['message' => $this->l10n->t('File is too big')]],
Http::STATUS_BAD_REQUEST
);
}
if ($node->getMimeType() !== 'image/jpeg' && $node->getMimeType() !== 'image/png') {
return new JSONResponse(
- ['data' => ['message' => $this->l->t('The selected file is not an image.')]],
+ ['data' => ['message' => $this->l10n->t('The selected file is not an image.')]],
Http::STATUS_BAD_REQUEST
);
}
try {
$content = $node->getContent();
- } catch (\OCP\Files\NotPermittedException $e) {
+ } catch (NotPermittedException $e) {
return new JSONResponse(
- ['data' => ['message' => $this->l->t('The selected file cannot be read.')]],
+ ['data' => ['message' => $this->l10n->t('The selected file cannot be read.')]],
Http::STATUS_BAD_REQUEST
);
}
} elseif (!is_null($files)) {
if (
- $files['error'][0] === 0 &&
- is_uploaded_file($files['tmp_name'][0]) &&
- !\OC\Files\Filesystem::isFileBlacklisted($files['tmp_name'][0])
+ $files['error'][0] === 0
+ && is_uploaded_file($files['tmp_name'][0])
) {
if ($files['size'][0] > 20 * 1024 * 1024) {
return new JSONResponse(
- ['data' => ['message' => $this->l->t('File is too big')]],
+ ['data' => ['message' => $this->l10n->t('File is too big')]],
Http::STATUS_BAD_REQUEST
);
}
@@ -193,21 +206,33 @@ class AvatarController extends Controller {
$content = $this->cache->get('avatar_upload');
unlink($files['tmp_name'][0]);
} else {
+ $phpFileUploadErrors = [
+ UPLOAD_ERR_OK => $this->l10n->t('The file was uploaded'),
+ UPLOAD_ERR_INI_SIZE => $this->l10n->t('The uploaded file exceeds the upload_max_filesize directive in php.ini'),
+ UPLOAD_ERR_FORM_SIZE => $this->l10n->t('The uploaded file exceeds the MAX_FILE_SIZE directive that was specified in the HTML form'),
+ UPLOAD_ERR_PARTIAL => $this->l10n->t('The file was only partially uploaded'),
+ UPLOAD_ERR_NO_FILE => $this->l10n->t('No file was uploaded'),
+ UPLOAD_ERR_NO_TMP_DIR => $this->l10n->t('Missing a temporary folder'),
+ UPLOAD_ERR_CANT_WRITE => $this->l10n->t('Could not write file to disk'),
+ UPLOAD_ERR_EXTENSION => $this->l10n->t('A PHP extension stopped the file upload'),
+ ];
+ $message = $phpFileUploadErrors[$files['error'][0]] ?? $this->l10n->t('Invalid file provided');
+ $this->logger->warning($message, ['app' => 'core']);
return new JSONResponse(
- ['data' => ['message' => $this->l->t('Invalid file provided')]],
+ ['data' => ['message' => $message]],
Http::STATUS_BAD_REQUEST
);
}
} else {
//Add imgfile
return new JSONResponse(
- ['data' => ['message' => $this->l->t('No image or file provided')]],
+ ['data' => ['message' => $this->l10n->t('No image or file provided')]],
Http::STATUS_BAD_REQUEST
);
}
try {
- $image = new \OC_Image();
+ $image = new Image();
$image->loadFromData($content);
$image->readExif($content);
$image->fixOrientation();
@@ -216,11 +241,24 @@ class AvatarController extends Controller {
$mimeType = $image->mimeType();
if ($mimeType !== 'image/jpeg' && $mimeType !== 'image/png') {
return new JSONResponse(
- ['data' => ['message' => $this->l->t('Unknown filetype')]],
+ ['data' => ['message' => $this->l10n->t('Unknown filetype')]],
Http::STATUS_OK
);
}
+ if ($image->width() === $image->height()) {
+ try {
+ $avatar = $this->avatarManager->getAvatar($this->userId);
+ $avatar->set($image);
+ // Clean up
+ $this->cache->remove('tmpAvatar');
+ return new JSONResponse(['status' => 'success']);
+ } catch (\Throwable $e) {
+ $this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'core']);
+ return new JSONResponse(['data' => ['message' => $this->l10n->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
+ }
+ }
+
$this->cache->set('tmpAvatar', $image->data(), 7200);
return new JSONResponse(
['data' => 'notsquare'],
@@ -228,85 +266,79 @@ class AvatarController extends Controller {
);
} else {
return new JSONResponse(
- ['data' => ['message' => $this->l->t('Invalid image')]],
+ ['data' => ['message' => $this->l10n->t('Invalid image')]],
Http::STATUS_OK
);
}
} catch (\Exception $e) {
- $this->logger->logException($e, ['app' => 'core']);
- return new JSONResponse(['data' => ['message' => $this->l->t('An error occurred. Please contact your admin.')]], Http::STATUS_OK);
+ $this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'core']);
+ return new JSONResponse(['data' => ['message' => $this->l10n->t('An error occurred. Please contact your admin.')]], Http::STATUS_OK);
}
}
- /**
- * @NoAdminRequired
- *
- * @return JSONResponse
- */
- public function deleteAvatar() {
+ #[NoAdminRequired]
+ #[FrontpageRoute(verb: 'DELETE', url: '/avatar/')]
+ public function deleteAvatar(): JSONResponse {
try {
$avatar = $this->avatarManager->getAvatar($this->userId);
$avatar->remove();
return new JSONResponse();
} catch (\Exception $e) {
- $this->logger->logException($e, ['app' => 'core']);
- return new JSONResponse(['data' => ['message' => $this->l->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
+ $this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'core']);
+ return new JSONResponse(['data' => ['message' => $this->l10n->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
}
}
/**
- * @NoAdminRequired
- *
* @return JSONResponse|DataDisplayResponse
*/
+ #[NoAdminRequired]
+ #[FrontpageRoute(verb: 'GET', url: '/avatar/tmp')]
public function getTmpAvatar() {
$tmpAvatar = $this->cache->get('tmpAvatar');
if (is_null($tmpAvatar)) {
return new JSONResponse(['data' => [
- 'message' => $this->l->t("No temporary profile picture available, try again")
+ 'message' => $this->l10n->t('No temporary profile picture available, try again')
]],
- Http::STATUS_NOT_FOUND);
+ Http::STATUS_NOT_FOUND);
}
- $image = new \OC_Image();
+ $image = new Image();
$image->loadFromData($tmpAvatar);
- $resp = new DataDisplayResponse($image->data(),
- Http::STATUS_OK,
- ['Content-Type' => $image->mimeType()]);
+ $resp = new DataDisplayResponse(
+ $image->data() ?? '',
+ Http::STATUS_OK,
+ ['Content-Type' => $image->mimeType()]);
- $resp->setETag((string)crc32($image->data()));
+ $resp->setETag((string)crc32($image->data() ?? ''));
$resp->cacheFor(0);
$resp->setLastModified(new \DateTime('now', new \DateTimeZone('GMT')));
return $resp;
}
- /**
- * @NoAdminRequired
- *
- * @param array $crop
- * @return JSONResponse
- */
- public function postCroppedAvatar($crop) {
+ #[NoAdminRequired]
+ #[FrontpageRoute(verb: 'POST', url: '/avatar/cropped')]
+ public function postCroppedAvatar(?array $crop = null): JSONResponse {
if (is_null($crop)) {
- return new JSONResponse(['data' => ['message' => $this->l->t("No crop data provided")]],
- Http::STATUS_BAD_REQUEST);
+ return new JSONResponse(['data' => ['message' => $this->l10n->t('No crop data provided')]],
+ Http::STATUS_BAD_REQUEST);
}
if (!isset($crop['x'], $crop['y'], $crop['w'], $crop['h'])) {
- return new JSONResponse(['data' => ['message' => $this->l->t("No valid crop data provided")]],
- Http::STATUS_BAD_REQUEST);
+ return new JSONResponse(['data' => ['message' => $this->l10n->t('No valid crop data provided')]],
+ Http::STATUS_BAD_REQUEST);
}
$tmpAvatar = $this->cache->get('tmpAvatar');
if (is_null($tmpAvatar)) {
return new JSONResponse(['data' => [
- 'message' => $this->l->t("No temporary profile picture available, try again")
+ 'message' => $this->l10n->t('No temporary profile picture available, try again')
]],
- Http::STATUS_BAD_REQUEST);
+ Http::STATUS_BAD_REQUEST);
}
- $image = new \OC_Image();
+ $image = new Image();
$image->loadFromData($tmpAvatar);
$image->crop($crop['x'], $crop['y'], (int)round($crop['w']), (int)round($crop['h']));
try {
@@ -315,12 +347,12 @@ class AvatarController extends Controller {
// Clean up
$this->cache->remove('tmpAvatar');
return new JSONResponse(['status' => 'success']);
- } catch (\OC\NotSquareException $e) {
- return new JSONResponse(['data' => ['message' => $this->l->t('Crop is not square')]],
- Http::STATUS_BAD_REQUEST);
+ } catch (NotSquareException $e) {
+ return new JSONResponse(['data' => ['message' => $this->l10n->t('Crop is not square')]],
+ Http::STATUS_BAD_REQUEST);
} catch (\Exception $e) {
- $this->logger->logException($e, ['app' => 'core']);
- return new JSONResponse(['data' => ['message' => $this->l->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
+ $this->logger->error($e->getMessage(), ['exception' => $e, 'app' => 'core']);
+ return new JSONResponse(['data' => ['message' => $this->l10n->t('An error occurred. Please contact your admin.')]], Http::STATUS_BAD_REQUEST);
}
}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 14:04:25 +0000