-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
Refactor user_ldap group membership cache and add check-group command #39446
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
come-nc
merged 17 commits into
master
from
enh/user_ldap-refactor-group-membership-cache
Aug 10, 2023
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
d8142b6
Refactor user_ldap group membership to use flat DB
come-nc d9b3680
Update autoloader mapping for user_ldap
come-nc 34fa413
Add group events to UpdateGroups
come-nc 2c19aac
Move UpdateGroups methods to a service
come-nc f9ed48e
Add check-group command
come-nc ec13f22
Add missing primary key for ldap_group_membership
come-nc 1b102ca
Fix errors in UpdateGroupsService.php
come-nc ce5a4e5
Always empty cache before updating a group
come-nc 7a14aa7
Add output to check-group --update command
come-nc 42448c0
Fix getKnownGroups return value
come-nc 1026b21
Fix check-group command for new groups
come-nc c33c40f
[user_ldap] Small perf improvements suggestion from review
come-nc ad1e487
Dispatch UserRemovedEvents for removed groups
come-nc 7732de7
Removed GroupCreatedEvent/GroupDeletedEvent from UpdateGroupsService
come-nc 5425f7d
Use BIGINT for new table id field
come-nc b8a0954
Fix check-group --update for deleted groups
come-nc a080811
Add unique index for user_ldap group memberships
come-nc File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,181 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2016, ownCloud, Inc. | ||
| * | ||
| * @author Arthur Schiwon <[email protected]> | ||
| * @author Christoph Wurst <[email protected]> | ||
| * @author Côme Chilliet <[email protected]> | ||
| * @author Joas Schilling <[email protected]> | ||
| * @author Morris Jobke <[email protected]> | ||
| * @author Roeland Jago Douma <[email protected]> | ||
| * | ||
| * @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 OCA\User_LDAP\Command; | ||
|
|
||
| use OCA\User_LDAP\Group_Proxy; | ||
| use OCA\User_LDAP\Helper; | ||
| use OCA\User_LDAP\Mapping\GroupMapping; | ||
| use OCA\User_LDAP\Service\UpdateGroupsService; | ||
| use OCP\EventDispatcher\IEventDispatcher; | ||
| use OCP\Group\Events\GroupCreatedEvent; | ||
| use OCP\Group\Events\UserAddedEvent; | ||
| use OCP\Group\Events\UserRemovedEvent; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| class CheckGroup extends Command { | ||
| public function __construct( | ||
| private UpdateGroupsService $service, | ||
| protected Group_Proxy $backend, | ||
| protected Helper $helper, | ||
| protected GroupMapping $mapping, | ||
| protected IEventDispatcher $dispatcher, | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| protected function configure(): void { | ||
| $this | ||
| ->setName('ldap:check-group') | ||
| ->setDescription('checks whether a group exists on LDAP.') | ||
| ->addArgument( | ||
| 'ocName', | ||
| InputArgument::REQUIRED, | ||
| 'the group name as used in Nextcloud, or the LDAP DN' | ||
| ) | ||
| ->addOption( | ||
| 'force', | ||
| null, | ||
| InputOption::VALUE_NONE, | ||
| 'ignores disabled LDAP configuration' | ||
| ) | ||
| ->addOption( | ||
| 'update', | ||
| null, | ||
| InputOption::VALUE_NONE, | ||
| 'syncs values from LDAP' | ||
| ) | ||
| ; | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int { | ||
| $this->dispatcher->addListener(GroupCreatedEvent::class, fn ($event) => $this->onGroupCreatedEvent($event, $output)); | ||
Check noticeCode scanning / Psalm ArgumentTypeCoercion
Argument 1 of OCA\User_LDAP\Command\CheckGroup::onGroupCreatedEvent expects OCP\Group\Events\GroupCreatedEvent, but parent type OCP\EventDispatcher\Event provided
|
||
| $this->dispatcher->addListener(UserAddedEvent::class, fn ($event) => $this->onUserAddedEvent($event, $output)); | ||
Check noticeCode scanning / Psalm ArgumentTypeCoercion
Argument 1 of OCA\User_LDAP\Command\CheckGroup::onUserAddedEvent expects OCP\Group\Events\UserAddedEvent, but parent type OCP\EventDispatcher\Event provided
|
||
| $this->dispatcher->addListener(UserRemovedEvent::class, fn ($event) => $this->onUserRemovedEvent($event, $output)); | ||
Check noticeCode scanning / Psalm ArgumentTypeCoercion
Argument 1 of OCA\User_LDAP\Command\CheckGroup::onUserRemovedEvent expects OCP\Group\Events\UserRemovedEvent, but parent type OCP\EventDispatcher\Event provided
|
||
| try { | ||
| $this->assertAllowed($input->getOption('force')); | ||
| $gid = $input->getArgument('ocName'); | ||
| $wasMapped = $this->groupWasMapped($gid); | ||
| if ($this->backend->getLDAPAccess($gid)->stringResemblesDN($gid)) { | ||
| $groupname = $this->backend->dn2GroupName($gid); | ||
| if ($groupname !== false) { | ||
| $gid = $groupname; | ||
| } | ||
| } | ||
| /* Search to trigger mapping for new groups */ | ||
| $this->backend->getGroups($gid); | ||
| $exists = $this->backend->groupExistsOnLDAP($gid, true); | ||
| if ($exists === true) { | ||
| $output->writeln('The group is still available on LDAP.'); | ||
| if ($input->getOption('update')) { | ||
| $this->backend->getLDAPAccess($gid)->connection->clearCache(); | ||
| if ($wasMapped) { | ||
| $this->service->handleKnownGroups([$gid]); | ||
| } else { | ||
| $this->service->handleCreatedGroups([$gid]); | ||
| } | ||
| } | ||
| return 0; | ||
| } elseif ($wasMapped) { | ||
come-nc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| $output->writeln('The group does not exist on LDAP anymore.'); | ||
| if ($input->getOption('update')) { | ||
| $this->backend->getLDAPAccess($gid)->connection->clearCache(); | ||
| $this->service->handleRemovedGroups([$gid]); | ||
| } | ||
| return 0; | ||
| } else { | ||
| throw new \Exception('The given group is not a recognized LDAP group.'); | ||
| } | ||
| } catch (\Exception $e) { | ||
| $output->writeln('<error>' . $e->getMessage(). '</error>'); | ||
| return 1; | ||
| } | ||
| } | ||
|
|
||
| public function onGroupCreatedEvent(GroupCreatedEvent $event, OutputInterface $output): void { | ||
| $output->writeln('<info>The group '.$event->getGroup()->getGID().' was added to Nextcloud with '.$event->getGroup()->count().' users</info>'); | ||
| } | ||
|
|
||
| public function onUserAddedEvent(UserAddedEvent $event, OutputInterface $output): void { | ||
| $user = $event->getUser(); | ||
| $group = $event->getGroup(); | ||
| $output->writeln('<info>The user '.$user->getUID().' was added to group '.$group->getGID().'</info>'); | ||
| } | ||
|
|
||
| public function onUserRemovedEvent(UserRemovedEvent $event, OutputInterface $output): void { | ||
| $user = $event->getUser(); | ||
| $group = $event->getGroup(); | ||
| $output->writeln('<info>The user '.$user->getUID().' was removed from group '.$group->getGID().'</info>'); | ||
| } | ||
|
|
||
| /** | ||
| * checks whether a group is actually mapped | ||
| * @param string $gid the groupname as passed to the command | ||
| */ | ||
| protected function groupWasMapped(string $gid): bool { | ||
| $dn = $this->mapping->getDNByName($gid); | ||
| if ($dn !== false) { | ||
| return true; | ||
| } | ||
| $name = $this->mapping->getNameByDN($gid); | ||
| return $name !== false; | ||
| } | ||
|
|
||
| /** | ||
| * checks whether the setup allows reliable checking of LDAP group existence | ||
| * @throws \Exception | ||
| */ | ||
| protected function assertAllowed(bool $force): void { | ||
| if ($this->helper->haveDisabledConfigurations() && !$force) { | ||
| throw new \Exception('Cannot check group existence, because ' | ||
| . 'disabled LDAP configurations are present.'); | ||
| } | ||
|
|
||
| // we don't check ldapUserCleanupInterval from config.php because this | ||
| // action is triggered manually, while the setting only controls the | ||
| // background job. | ||
| } | ||
|
|
||
| private function updateGroup(string $gid, OutputInterface $output, bool $wasMapped): void { | ||
| try { | ||
| if ($wasMapped) { | ||
| $this->service->handleKnownGroups([$gid]); | ||
| } else { | ||
| $this->service->handleCreatedGroups([$gid]); | ||
| } | ||
| } catch (\Exception $e) { | ||
| $output->writeln('<error>Error while trying to lookup and update attributes from LDAP</error>'); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2023 Côme Chilliet <[email protected]> | ||
| * | ||
| * @author Côme Chilliet <[email protected]> | ||
| * | ||
| * @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 OCA\User_LDAP\Db; | ||
|
|
||
| use OCP\AppFramework\Db\Entity; | ||
|
|
||
| /** | ||
| * @method void setUserid(string $userid) | ||
| * @method string getUserid() | ||
| * @method void setGroupid(string $groupid) | ||
| * @method string getGroupid() | ||
| */ | ||
| class GroupMembership extends Entity { | ||
Check noticeCode scanning / Psalm PropertyNotSetInConstructor
Property OCA\User_LDAP\Db\GroupMembership::$id is not defined in constructor of OCA\User_LDAP\Db\GroupMembership or in any methods called in the constructor
|
||
| /** @var string */ | ||
| protected $groupid; | ||
Check noticeCode scanning / Psalm PropertyNotSetInConstructor
Property OCA\User_LDAP\Db\GroupMembership::$groupid is not defined in constructor of OCA\User_LDAP\Db\GroupMembership or in any methods called in the constructor
|
||
|
|
||
| /** @var string */ | ||
| protected $userid; | ||
Check noticeCode scanning / Psalm PropertyNotSetInConstructor
Property OCA\User_LDAP\Db\GroupMembership::$userid is not defined in constructor of OCA\User_LDAP\Db\GroupMembership or in any methods called in the constructor
|
||
|
|
||
| public function __construct() { | ||
| $this->addType('groupid', 'string'); | ||
| $this->addType('userid', 'string'); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.