From 674db6da88eee4d9eba71c9b0270e9ca3a262318 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 17 Sep 2020 15:06:50 +0200 Subject: [PATCH] add event to allow apps to overwrite user quota Signed-off-by: Robin Appelman --- lib/private/User/User.php | 11 +++++- lib/public/User/GetQuotaEvent.php | 64 +++++++++++++++++++++++++++++++ 2 files changed, 74 insertions(+), 1 deletion(-) create mode 100644 lib/public/User/GetQuotaEvent.php diff --git a/lib/private/User/User.php b/lib/private/User/User.php index 2d27b204d090b..365b8ae33a1c0 100644 --- a/lib/private/User/User.php +++ b/lib/private/User/User.php @@ -50,6 +50,7 @@ use OCP\IURLGenerator; use OCP\IUser; use OCP\IUserBackend; +use OCP\User\GetQuotaEvent; use OCP\UserInterface; use Symfony\Component\EventDispatcher\EventDispatcherInterface; use Symfony\Component\EventDispatcher\GenericEvent; @@ -406,7 +407,15 @@ public function getEMailAddress() { * @since 9.0.0 */ public function getQuota() { - $quota = $this->config->getUserValue($this->uid, 'files', 'quota', 'default'); + // allow apps to modify the user quota by hooking into the event + $event = new GetQuotaEvent($this); + $this->dispatcher->dispatchTyped($event); + $overwriteQuota = $event->getQuota(); + if ($overwriteQuota) { + $quota = $overwriteQuota; + } else { + $quota = $this->config->getUserValue($this->uid, 'files', 'quota', 'default'); + } if ($quota === 'default') { $quota = $this->config->getAppValue('files', 'default_quota', 'none'); } diff --git a/lib/public/User/GetQuotaEvent.php b/lib/public/User/GetQuotaEvent.php new file mode 100644 index 0000000000000..e7706db1730fc --- /dev/null +++ b/lib/public/User/GetQuotaEvent.php @@ -0,0 +1,64 @@ + + * + * @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 . + * + */ + +namespace OCP\User; + +use OCP\EventDispatcher\Event; +use OCP\IUser; + +/** + * Event to allow apps to + */ +class GetQuotaEvent extends Event { + /** @var IUser */ + private $user; + /** @var string|null */ + private $quota = null; + + public function __construct(IUser $user) { + parent::__construct(); + $this->user = $user; + } + + public function getUser(): IUser { + return $this->user; + } + + /** + * Get the set quota as human readable string, or null if no overwrite is set + * + * @return string|null + */ + public function getQuota(): ?string { + return $this->quota; + } + + /** + * Set the quota overwrite as human readable string + * + * @param string $quota + */ + public function setQuota(string $quota): void { + $this->quota = $quota; + } +}