From 905f9f8d355b6673af0e08f7770e255cd4f6327a Mon Sep 17 00:00:00 2001 From: Carl Schwan Date: Fri, 17 Jun 2022 11:23:03 +0200 Subject: [PATCH] Add batch methods in user backends This allows for faster group search with significantly less DB traffic Signed-off-by: Carl Schwan --- apps/user_ldap/lib/Group_LDAP.php | 5 +- apps/user_ldap/lib/Group_Proxy.php | 29 +++++++ lib/private/Group/Database.php | 81 ++++++++++++++++++- lib/private/Group/Manager.php | 61 +++++++++++--- lib/public/Group/Backend/ABackend.php | 30 +++++++ .../Group/Backend/IGroupDetailsBackend.php | 8 ++ lib/public/GroupInterface.php | 32 +++++++- 7 files changed, 232 insertions(+), 14 deletions(-) diff --git a/apps/user_ldap/lib/Group_LDAP.php b/apps/user_ldap/lib/Group_LDAP.php index 8fcb10cb850d0..31432b54e87de 100644 --- a/apps/user_ldap/lib/Group_LDAP.php +++ b/apps/user_ldap/lib/Group_LDAP.php @@ -47,12 +47,13 @@ use OC; use OC\Cache\CappedMemoryCache; use OC\ServerNotAvailableException; +use OCP\Group\Backend\ABackend; use OCP\Group\Backend\IGetDisplayNameBackend; use OCP\Group\Backend\IDeleteGroupBackend; use OCP\GroupInterface; use Psr\Log\LoggerInterface; -class Group_LDAP extends BackendUtility implements GroupInterface, IGroupLDAP, IGetDisplayNameBackend, IDeleteGroupBackend { +class Group_LDAP extends ABackend implements GroupInterface, IGroupLDAP, IGetDisplayNameBackend, IDeleteGroupBackend { protected $enabled = false; /** @var CappedMemoryCache $cachedGroupMembers array of users with gid as key */ @@ -72,7 +73,7 @@ class Group_LDAP extends BackendUtility implements GroupInterface, IGroupLDAP, I protected $ldapGroupMemberAssocAttr; public function __construct(Access $access, GroupPluginManager $groupPluginManager) { - parent::__construct($access); + $this->access = $access; $filter = $this->access->connection->ldapGroupFilter; $gAssoc = $this->access->connection->ldapGroupMemberAssocAttr; if (!empty($filter) && !empty($gAssoc)) { diff --git a/apps/user_ldap/lib/Group_Proxy.php b/apps/user_ldap/lib/Group_Proxy.php index ea2fcce679c4a..a15c29ee1ab52 100644 --- a/apps/user_ldap/lib/Group_Proxy.php +++ b/apps/user_ldap/lib/Group_Proxy.php @@ -229,6 +229,21 @@ public function getGroupDetails($gid) { $gid, 'getGroupDetails', [$gid]); } + /** + * {@inheritdoc} + */ + public function getGroupsDetails(array $gids): array { + if (!($this instanceof IGroupDetailsBackend || $this->implementsActions(GroupInterface::GROUP_DETAILS))) { + throw new \Exception("Should not have been called"); + } + + $groupData = []; + foreach ($gids as $gid) { + $groupData[$gid] = $this->handleRequest($gid, 'getGroupDetails', [$gid]); + } + return $groupData; + } + /** * get a list of all groups * @@ -259,6 +274,20 @@ public function groupExists($gid) { return $this->handleRequest($gid, 'groupExists', [$gid]); } + /** + * {@inheritdoc} + */ + public function groupsExists(array $gids): array { + $existingGroups = []; + foreach ($gids as $gid) { + $exits = $this->handleRequest($gid, 'groupExists', [$gid]); + if ($exits) { + $existingGroups[] = $gid; + } + } + return $existingGroups; + } + /** * Check if backend implements actions * diff --git a/lib/private/Group/Database.php b/lib/private/Group/Database.php index 7b7ee41def9b2..2facb79b9bb51 100644 --- a/lib/private/Group/Database.php +++ b/lib/private/Group/Database.php @@ -267,7 +267,7 @@ public function getGroups($search = '', $limit = null, $offset = null) { $this->fixDI(); $query = $this->dbConn->getQueryBuilder(); - $query->select('gid') + $query->select('gid', 'displayname') ->from('groups') ->orderBy('gid', 'ASC'); @@ -286,6 +286,10 @@ public function getGroups($search = '', $limit = null, $offset = null) { $groups = []; while ($row = $result->fetch()) { + $this->groupCache[$row['gid']] = [ + 'displayname' => $row['displayname'], + 'gid' => $row['gid'], + ]; $groups[] = $row['gid']; } $result->closeCursor(); @@ -324,6 +328,44 @@ public function groupExists($gid) { return false; } + /** + * {@inheritdoc} + */ + public function groupsExists(array $gids): array { + $notFounsGids = [] + $existingGroups = []; + + // In case the data is already locally accessible, not need to do SQL query + // or do a SQL query but with a smaller in clause + foreach ($gids as $gid) { + if (isset($this->groupCache[$gid])) { + $existingGroups[] = $gid; + } else { + $notFounsGids[] = $gid; + } + } + + foreach (array_chunk($gids, 1000) as $chunk) { + $qb = $this->dbConn->getQueryBuilder(); + $result = $qb->select('gid', 'displayname') + ->from('groups') + ->where($qb->expr()->in('gid', $qb->createNamedParameter($chunk, IQueryBuilder::PARAM_STR_ARRAY))) + ->executeQuery(); + while ($row = $result->fetch()) { + while ($row = $result->fetch()) { + $details[$row['gid']] = $row['displayname']; + $this->groupCache[$row['gid']] = [ + 'displayname' => $row['displayname'], + 'gid' => $row['gid'], + ]; + $existingGroups[] = $gid; + } + $result->closeCursor(); + } + + return $existingGroups; + } + /** * get a list of all users in a group * @param string $gid @@ -474,6 +516,43 @@ public function getGroupDetails(string $gid): array { return []; } + /** + * {@inheritdoc} + */ + public function getGroupsDetails(array $gids): array { + $notFounsGids = [] + $details = []; + + // In case the data is already locally accessible, not need to do SQL query + // or do a SQL query but with a smaller in clause + foreach ($gids as $gid) { + if (isset($this->groupCache[$gid])) { + $details[$gid] = $this->groupCache[$gid]['displayname']; + } else { + $notFounsGids[] = $gid; + } + } + + foreach (array_chunk($gids, 1000) as $chunk) { + $query = $this->dbConn->getQueryBuilder(); + $query->select('gid', 'displayname') + ->from('groups') + ->where($query->expr()->in('gid', $query->createNamedParameter($chunk, IQueryBuilder::PARAM_STR_ARRAY))); + + $result = $query->executeQuery(); + while ($row = $result->fetch()) { + $details[$row['gid']] = $row['displayname']; + $this->groupCache[$row['gid']] = [ + 'displayname' => $row['displayname'], + 'gid' => $row['gid'], + ]; + } + $result->closeCursor(); + } + + return $details; + } + public function setDisplayName(string $gid, string $displayName): bool { if (!$this->groupExists($gid)) { return false; diff --git a/lib/private/Group/Manager.php b/lib/private/Group/Manager.php index 28f7a400b41dd..ae7ef6a313d82 100644 --- a/lib/private/Group/Manager.php +++ b/lib/private/Group/Manager.php @@ -21,6 +21,7 @@ * @author Vincent Petry * @author Vinicius Cubas Brand * @author voxsim "Simon Vocella" + * @author Carl Schwan * * @license AGPL-3.0 * @@ -73,10 +74,10 @@ class Manager extends PublicEmitter implements IGroupManager { private $dispatcher; private LoggerInterface $logger; - /** @var \OC\Group\Group[] */ + /** @var array */ private $cachedGroups = []; - /** @var (string[])[] */ + /** @var array> */ private $cachedUserGroups = []; /** @var \OC\SubAdmin */ @@ -193,10 +194,56 @@ protected function getGroupObject($gid, $displayName = null) { if (count($backends) === 0) { return null; } + /** @var GroupInterface[] $backends */ $this->cachedGroups[$gid] = new Group($gid, $backends, $this->dispatcher, $this->userManager, $this, $displayName); return $this->cachedGroups[$gid]; } + /** + * @brief Batch method to create group objects + * + * @param list $gids List of groupIds for which we want to create a IGroup object + * @param array $displayNames Array containing already know display name for a groupId + * @return array + */ + protected function getGroupsObject(array $gids, array $displayNames = []): array { + $backends = []; + $groups = []; + foreach ($gids as $gid) { + $backends[$gid] = []; + if (!isset($displayNames[$gid])) { + $displayNames[$gid] = null; + } + } + foreach ($this->backends as $backend) { + if ($backend instanceof IGroupDetailsBackend || $backend->implementsActions(GroupInterface::GROUP_DETAILS)) { + $groupDatas = $backend->getGroupsDetails($gids); + foreach ($groupDatas as $gid => $groupData) { + if (!empty($groupData)) { + // take the display name from the first backend that has a non-null one + if (isset($groupData['displayName'])) { + $displayNames[$gid] = $groupData['displayName']; + } + $backends[$gid][] = $backend; + } + } + } else { + $existingGroups = $backend->groupsExists($gids); + foreach ($existingGroups as $group) { + $backends[$group][] = $backend; + } + } + } + foreach ($gids as $gid) { + if (count($backends[$gid]) === 0) { + continue; + } + $this->cachedGroups[$gid] = new Group($gid, $backends[$gid], $this->dispatcher, $this->userManager, $this, $displayNames[$gid]); + $groups[$gid] = $this->cachedGroups[$gid]; + } + return $groups; + } + /** * @param string $gid * @return bool @@ -239,13 +286,9 @@ public function search($search, $limit = null, $offset = null) { $groups = []; foreach ($this->backends as $backend) { $groupIds = $backend->getGroups($search, $limit, $offset); - foreach ($groupIds as $groupId) { - $aGroup = $this->get($groupId); - if ($aGroup instanceof IGroup) { - $groups[$groupId] = $aGroup; - } else { - $this->logger->debug('Group "' . $groupId . '" was returned by search but not found through direct access', ['app' => 'core']); - } + $newGroups = $this->getGroupsObject($groupIds); + foreach ($newGroups as $groupId => $group) { + $groups[$groupId] = $group; } if (!is_null($limit) and $limit <= 0) { return array_values($groups); diff --git a/lib/public/Group/Backend/ABackend.php b/lib/public/Group/Backend/ABackend.php index 2d611c27b4f38..2357680e4129b 100644 --- a/lib/public/Group/Backend/ABackend.php +++ b/lib/public/Group/Backend/ABackend.php @@ -6,6 +6,7 @@ * @copyright Copyright (c) 2018 Roeland Jago Douma * * @author Roeland Jago Douma + * @author Carl Schwan * * @license GNU AGPL version 3 or any later version * @@ -65,4 +66,33 @@ public function implementsActions($actions): bool { return (bool)($actions & $implements); } + + /** + * @since 25.0.0 + */ + public function groupsExists(array $gids): array { + $existingGroups = []; + foreach ($gids as $gid) { + $exists = $this->groupExists($gid); + if ($exists) { + $existringGroups[] = $gid; + } + } + return $existingGroups; + } + + /** + * @since 25.0.0 + */ + public function getGroupsDetails(array $gids): array { + if (!($this instanceof IGroupDetailsBackend || $this->implementsActions(GroupInterface::GROUP_DETAILS))) { + throw new \Exception("Should not have been called"); + } + /** @var IGroupDetailsBackend $this */ + $groupData = []; + foreach ($gids as $gid) { + $groupData[$gid] = $this->getGroupDetails($gid); + } + return $groupData; + } } diff --git a/lib/public/Group/Backend/IGroupDetailsBackend.php b/lib/public/Group/Backend/IGroupDetailsBackend.php index 56241d5538b81..520250d4a54e6 100644 --- a/lib/public/Group/Backend/IGroupDetailsBackend.php +++ b/lib/public/Group/Backend/IGroupDetailsBackend.php @@ -6,6 +6,7 @@ * @copyright Copyright (c) 2018 Roeland Jago Douma * * @author Roeland Jago Douma + * @author Carl Schwan * * @license GNU AGPL version 3 or any later version * @@ -26,11 +27,18 @@ namespace OCP\Group\Backend; /** + * @brief Optional interface for group backends * @since 14.0.0 */ interface IGroupDetailsBackend { /** + * @brief Get additional details for a group, for example the display name. + * + * The array returned can be empty when no additional information is available + * for the group. + * + * @return array{displayName?: string} * @since 14.0.0 */ public function getGroupDetails(string $gid): array; diff --git a/lib/public/GroupInterface.php b/lib/public/GroupInterface.php index f1765afed961e..bd3610b66e6dd 100644 --- a/lib/public/GroupInterface.php +++ b/lib/public/GroupInterface.php @@ -87,7 +87,8 @@ public function inGroup($uid, $gid); public function getUserGroups($uid); /** - * get a list of all groups + * @brief Get a list of all groups + * * @param string $search * @param int $limit * @param int $offset @@ -99,13 +100,40 @@ public function getUserGroups($uid); public function getGroups($search = '', $limit = -1, $offset = 0); /** - * check if a group exists + * @brief Check if a group exists + * * @param string $gid * @return bool * @since 4.5.0 */ public function groupExists($gid); + /** + * @brief Batch method to check if a list of groups exists + * + * The default implementation in ABackend will just call groupExists in + * a loop. But a GroupBackend implementation should provides a more optimized + * override this method to provide a more optimized way to execute this operation. + * + * @param list $gids + * @return list the list of group that exists + * @since 25.0.0 + */ + public function groupsExists(array $gids): array; + + /** + * @brief Batch method to get the group details of a list of groups + * + * The default implementation in ABackend will just call getGroupDetail in + * a loop. But a GroupBackend implementation should provides a more optimized + * override this method to provide a more optimized way to execute this operation. + * + * @throw \RuntimeException if called on a backend that doesn't implements IGroupDetailsBackend + * + * @since 25.0.0 + */ + public function getGroupsDetails(array $gids): array; + /** * get a list of all users in a group * @param string $gid