summaryrefslogtreecommitdiffstats
path: root/lib/private/Avatar/AvatarManager.php
diff options
context:
space:
mode:
authorMichael Weimann <mail@michael-weimann.eu>2019-01-20 11:13:41 +0100
committerMorris Jobke <hey@morrisjobke.de>2019-02-07 14:23:16 +0100
commitbf1253cb49a4931244a6bbde4dfa44bf084f4377 (patch)
tree6faacd5110c029778ed56554e27a5d73c4e888db /lib/private/Avatar/AvatarManager.php
parentb69b17f29fd518495a6495e0f90f60c70ef0fc73 (diff)
downloadnextcloud-server-bf1253cb49a4931244a6bbde4dfa44bf084f4377.tar.gz
nextcloud-server-bf1253cb49a4931244a6bbde4dfa44bf084f4377.zip
Implement guest avatar endpoint
Signed-off-by: Michael Weimann <mail@michael-weimann.eu>
Diffstat (limited to 'lib/private/Avatar/AvatarManager.php')
-rw-r--r--lib/private/Avatar/AvatarManager.php133
1 files changed, 133 insertions, 0 deletions
diff --git a/lib/private/Avatar/AvatarManager.php b/lib/private/Avatar/AvatarManager.php
new file mode 100644
index 00000000000..567ed3aec1e
--- /dev/null
+++ b/lib/private/Avatar/AvatarManager.php
@@ -0,0 +1,133 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2016, ownCloud, Inc.
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ * @author Lukas Reschke <lukas@statuscode.ch>
+ * @author Morris Jobke <hey@morrisjobke.de>
+ * @author Robin Appelman <robin@icewind.nl>
+ * @author Roeland Jago Douma <roeland@famdouma.nl>
+ * @author Thomas Müller <thomas.mueller@tmit.eu>
+ *
+ * @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/>
+ *
+ */
+
+namespace OC\Avatar;
+
+use OC\User\Manager;
+use OCP\Files\IAppData;
+use OCP\Files\NotFoundException;
+use OCP\IAvatar;
+use OCP\IAvatarManager;
+use OCP\IConfig;
+use OCP\ILogger;
+use OCP\IL10N;
+
+/**
+ * This class implements methods to access Avatar functionality
+ */
+class AvatarManager implements IAvatarManager {
+
+ /** @var Manager */
+ private $userManager;
+
+ /** @var IAppData */
+ private $appData;
+
+ /** @var IL10N */
+ private $l;
+
+ /** @var ILogger */
+ private $logger;
+
+ /** @var IConfig */
+ private $config;
+
+ /**
+ * AvatarManager constructor.
+ *
+ * @param Manager $userManager
+ * @param IAppData $appData
+ * @param IL10N $l
+ * @param ILogger $logger
+ * @param IConfig $config
+ */
+ public function __construct(
+ Manager $userManager,
+ IAppData $appData,
+ IL10N $l,
+ ILogger $logger,
+ IConfig $config) {
+ $this->userManager = $userManager;
+ $this->appData = $appData;
+ $this->l = $l;
+ $this->logger = $logger;
+ $this->config = $config;
+ }
+
+ /**
+ * return a user specific instance of \OCP\IAvatar
+ * @see \OCP\IAvatar
+ * @param string $userId the ownCloud user id
+ * @return \OCP\IAvatar
+ * @throws \Exception In case the username is potentially dangerous
+ * @throws NotFoundException In case there is no user folder yet
+ */
+ public function getAvatar(string $userId) : IAvatar {
+ $user = $this->userManager->get($userId);
+ if ($user === null) {
+ throw new \Exception('user does not exist');
+ }
+
+ // sanitize userID - fixes casing issue (needed for the filesystem stuff that is done below)
+ $userId = $user->getUID();
+
+ try {
+ $folder = $this->appData->getFolder($userId);
+ } catch (NotFoundException $e) {
+ $folder = $this->appData->newFolder($userId);
+ }
+
+ return new UserAvatar($folder, $this->l, $user, $this->logger, $this->config);
+ }
+
+ /**
+ * Clear generated avatars
+ */
+ public function clearCachedAvatars() {
+ $users = $this->config->getUsersForUserValue('avatar', 'generated', 'true');
+ foreach($users as $userId) {
+ try {
+ $folder = $this->appData->getFolder($userId);
+ $folder->delete();
+ } catch (NotFoundException $e) {
+ $this->logger->debug("No cache for the user $userId. Ignoring...");
+ }
+ $this->config->setUserValue($userId, 'avatar', 'generated', 'false');
+ }
+ }
+
+ /**
+ * Returns a GuestAvatar.
+ *
+ * @param string $name The guest name, e.g. "Albert".
+ * @return IAvatar
+ */
+ public function getGuestAvatar(string $name): IAvatar {
+ return new GuestAvatar($name, $this->logger);
+ }
+}