Skip to content

Commit

Permalink
add event to allow apps to overwrite user quota
Browse files Browse the repository at this point in the history
Signed-off-by: Robin Appelman <[email protected]>
  • Loading branch information
icewind1991 committed Sep 17, 2020
1 parent ec07ca2 commit a1db6b6
Show file tree
Hide file tree
Showing 2 changed files with 73 additions and 1 deletion.
64 changes: 64 additions & 0 deletions lib/private/User/GetQuotaEvent.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
<?php

declare(strict_types=1);
/**
* @copyright Copyright (c) 2020 Robin Appelman <robin@icewind.nl>
*
* @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/>.
*
*/

namespace OC\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;
}
}
10 changes: 9 additions & 1 deletion lib/private/User/User.php
Original file line number Diff line number Diff line change
Expand Up @@ -406,7 +406,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');
}
Expand Down

0 comments on commit a1db6b6

Please sign in to comment.