Merge pull request #34941 from nextcloud/enh/33654/add-group-displayname-cache
Add a Group display name cachepull/35471/head
Simon L
GitHub
commit
c4157e4653
@ -0,0 +1,87 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* @copyright 2022 Anna Larch <anna.larch@gmx.net>
|
||||
* @author Anna Larch <anna.larch@gmx.net>
|
||||
*
|
||||
* @license AGPL-3.0-or-later
|
||||
*
|
||||
* 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\Group;
|
||||
|
||||
use OCP\Cache\CappedMemoryCache;
|
||||
use OCP\EventDispatcher\Event;
|
||||
use OCP\EventDispatcher\IEventListener;
|
||||
use OCP\Group\Events\GroupChangedEvent;
|
||||
use OCP\ICache;
|
||||
use OCP\ICacheFactory;
|
||||
use OCP\IGroupManager;
|
||||
|
||||
/**
|
||||
* Class that cache the relation Group ID -> Display name
|
||||
*
|
||||
* This saves fetching the group from the backend for "just" the display name
|
||||
*/
|
||||
class DisplayNameCache implements IEventListener {
|
||||
private CappedMemoryCache $cache;
|
||||
private ICache $memCache;
|
||||
private IGroupManager $groupManager;
|
||||
|
||||
public function __construct(ICacheFactory $cacheFactory, IGroupManager $groupManager) {
|
||||
$this->cache = new CappedMemoryCache();
|
||||
$this->memCache = $cacheFactory->createDistributed('groupDisplayNameMappingCache');
|
||||
$this->groupManager = $groupManager;
|
||||
}
|
||||
|
||||
public function getDisplayName(string $groupId): ?string {
|
||||
if (isset($this->cache[$groupId])) {
|
||||
return $this->cache[$groupId];
|
||||
}
|
||||
$displayName = $this->memCache->get($groupId);
|
||||
if ($displayName) {
|
||||
$this->cache[$groupId] = $displayName;
|
||||
return $displayName;
|
||||
}
|
||||
|
||||
$group = $this->groupManager->get($groupId);
|
||||
if ($group) {
|
||||
$displayName = $group->getDisplayName();
|
||||
} else {
|
||||
$displayName = null;
|
||||
}
|
||||
$this->cache[$groupId] = $displayName;
|
||||
$this->memCache->set($groupId, $displayName, 60 * 10); // 10 minutes
|
||||
|
||||
return $displayName;
|
||||
}
|
||||
|
||||
public function clear(): void {
|
||||
$this->cache = new CappedMemoryCache();
|
||||
$this->memCache->clear();
|
||||
}
|
||||
|
||||
public function handle(Event $event): void {
|
||||
if ($event instanceof GroupChangedEvent && $event->getFeature() === 'displayName') {
|
||||
$groupId = $event->getGroup()->getGID();
|
||||
$newDisplayName = $event->getValue();
|
||||
$this->cache[$groupId] = $newDisplayName;
|
||||
$this->memCache->set($groupId, $newDisplayName, 60 * 10); // 10 minutes
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,94 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
/**
|
||||
* @copyright 2022 Anna Larch <anna.larch@gmx.net>
|
||||
*
|
||||
* @author Anna Larch <anna.larch@gmx.net>
|
||||
*
|
||||
* @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 OCP\Group\Events;
|
||||
|
||||
use OCP\EventDispatcher\Event;
|
||||
use OCP\IGroup;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
class GroupChangedEvent extends Event {
|
||||
private IGroup $group;
|
||||
private string $feature;
|
||||
/** @var mixed */
|
||||
private $value;
|
||||
/** @var mixed */
|
||||
private $oldValue;
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*/
|
||||
public function __construct(IGroup $group,
|
||||
string $feature,
|
||||
$value,
|
||||
$oldValue = null) {
|
||||
parent::__construct();
|
||||
$this->group = $group;
|
||||
$this->feature = $feature;
|
||||
$this->value = $value;
|
||||
$this->oldValue = $oldValue;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @since 26.0.0
|
||||
*
|
||||
* @return IGroup
|
||||
*/
|
||||
public function getGroup(): IGroup {
|
||||
return $this->group;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @since 26.0.0
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function getFeature(): string {
|
||||
return $this->feature;
|
||||
}
|
||||
|
||||
/**
|
||||
* @since 26.0.0
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function getValue() {
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @since 26.0.0
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
public function getOldValue() {
|
||||
return $this->oldValue;
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue