|
| 1 | +<?php |
| 2 | + |
| 3 | +declare(strict_types=1); |
| 4 | + |
| 5 | +/** |
| 6 | + * @copyright Copyright (c) 2016, ownCloud, Inc. |
| 7 | + * |
| 8 | + * @author Arthur Schiwon <blizzz@arthur-schiwon.de> |
| 9 | + * @author Christoph Wurst <christoph@winzerhof-wurst.at> |
| 10 | + * @author Côme Chilliet <come.chilliet@nextcloud.com> |
| 11 | + * @author Joas Schilling <coding@schilljs.com> |
| 12 | + * @author Morris Jobke <hey@morrisjobke.de> |
| 13 | + * @author Roeland Jago Douma <roeland@famdouma.nl> |
| 14 | + * |
| 15 | + * @license AGPL-3.0 |
| 16 | + * |
| 17 | + * This code is free software: you can redistribute it and/or modify |
| 18 | + * it under the terms of the GNU Affero General Public License, version 3, |
| 19 | + * as published by the Free Software Foundation. |
| 20 | + * |
| 21 | + * This program is distributed in the hope that it will be useful, |
| 22 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 23 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 24 | + * GNU Affero General Public License for more details. |
| 25 | + * |
| 26 | + * You should have received a copy of the GNU Affero General Public License, version 3, |
| 27 | + * along with this program. If not, see <http://www.gnu.org/licenses/> |
| 28 | + * |
| 29 | + */ |
| 30 | + |
| 31 | +namespace OCA\User_LDAP\Command; |
| 32 | + |
| 33 | +use OCA\User_LDAP\Helper; |
| 34 | +use OCA\User_LDAP\Mapping\GroupMapping; |
| 35 | +use OCA\User_LDAP\Group_Proxy; |
| 36 | +use Symfony\Component\Console\Command\Command; |
| 37 | +use Symfony\Component\Console\Input\InputArgument; |
| 38 | +use Symfony\Component\Console\Input\InputInterface; |
| 39 | +use Symfony\Component\Console\Input\InputOption; |
| 40 | +use Symfony\Component\Console\Output\OutputInterface; |
| 41 | + |
| 42 | +class CheckGroup extends Command { |
| 43 | + public function __construct( |
| 44 | + protected Group_Proxy $backend, |
| 45 | + protected Helper $helper, |
| 46 | + protected GroupMapping $mapping, |
| 47 | + ) { |
| 48 | + parent::__construct(); |
| 49 | + } |
| 50 | + |
| 51 | + protected function configure(): void { |
| 52 | + $this |
| 53 | + ->setName('ldap:check-group') |
| 54 | + ->setDescription('checks whether a group exists on LDAP.') |
| 55 | + ->addArgument( |
| 56 | + 'ocName', |
| 57 | + InputArgument::REQUIRED, |
| 58 | + 'the group name as used in Nextcloud, or the LDAP DN' |
| 59 | + ) |
| 60 | + ->addOption( |
| 61 | + 'force', |
| 62 | + null, |
| 63 | + InputOption::VALUE_NONE, |
| 64 | + 'ignores disabled LDAP configuration' |
| 65 | + ) |
| 66 | + ->addOption( |
| 67 | + 'update', |
| 68 | + null, |
| 69 | + InputOption::VALUE_NONE, |
| 70 | + 'syncs values from LDAP' |
| 71 | + ) |
| 72 | + ; |
| 73 | + } |
| 74 | + |
| 75 | + protected function execute(InputInterface $input, OutputInterface $output): int { |
| 76 | + try { |
| 77 | + $this->assertAllowed($input->getOption('force')); |
| 78 | + $gid = $input->getArgument('ocName'); |
| 79 | + if ($this->backend->getLDAPAccess($gid)->stringResemblesDN($gid)) { |
| 80 | + $groupname = $this->backend->dn2GroupName($gid); |
| 81 | + if ($groupname !== false) { |
| 82 | + $gid = $groupname; |
| 83 | + } |
| 84 | + } |
| 85 | + $wasMapped = $this->groupWasMapped($gid); |
| 86 | + $exists = $this->backend->groupExistsOnLDAP($gid, true); |
| 87 | + if ($exists === true) { |
| 88 | + $output->writeln('The group is still available on LDAP.'); |
| 89 | + if ($input->getOption('update')) { |
| 90 | + $this->updateGroup($gid, $output); |
| 91 | + } |
| 92 | + return 0; |
| 93 | + } elseif ($wasMapped) { |
| 94 | + $output->writeln('The group does not exists on LDAP anymore.'); |
| 95 | + return 0; |
| 96 | + } else { |
| 97 | + throw new \Exception('The given group is not a recognized LDAP group.'); |
| 98 | + } |
| 99 | + } catch (\Exception $e) { |
| 100 | + $output->writeln('<error>' . $e->getMessage(). '</error>'); |
| 101 | + return 1; |
| 102 | + } |
| 103 | + } |
| 104 | + |
| 105 | + /** |
| 106 | + * checks whether a group is actually mapped |
| 107 | + * @param string $ocName the groupname as used in Nextcloud |
| 108 | + */ |
| 109 | + protected function groupWasMapped(string $ocName): bool { |
| 110 | + $dn = $this->mapping->getDNByName($ocName); |
| 111 | + return $dn !== false; |
| 112 | + } |
| 113 | + |
| 114 | + /** |
| 115 | + * checks whether the setup allows reliable checking of LDAP group existence |
| 116 | + * @throws \Exception |
| 117 | + */ |
| 118 | + protected function assertAllowed(bool $force): void { |
| 119 | + if ($this->helper->haveDisabledConfigurations() && !$force) { |
| 120 | + throw new \Exception('Cannot check group existence, because ' |
| 121 | + . 'disabled LDAP configurations are present.'); |
| 122 | + } |
| 123 | + |
| 124 | + // we don't check ldapUserCleanupInterval from config.php because this |
| 125 | + // action is triggered manually, while the setting only controls the |
| 126 | + // background job. |
| 127 | + } |
| 128 | + |
| 129 | + private function updateGroup(string $gid, OutputInterface $output): void { |
| 130 | + try { |
| 131 | + $access = $this->backend->getLDAPAccess($gid); |
| 132 | + $attrs = $access->userManager->getAttributes(); |
| 133 | + $user = $access->userManager->get($gid); |
| 134 | + $avatarAttributes = $access->getConnection()->resolveRule('avatar'); |
| 135 | + $result = $access->search('objectclass=*', $user->getDN(), $attrs, 1, 0); |
| 136 | + foreach ($result[0] as $attribute => $valueSet) { |
| 137 | + $output->writeln(' ' . $attribute . ': '); |
| 138 | + foreach ($valueSet as $value) { |
| 139 | + if (in_array($attribute, $avatarAttributes)) { |
| 140 | + $value = '{ImageData}'; |
| 141 | + } |
| 142 | + $output->writeln(' ' . $value); |
| 143 | + } |
| 144 | + } |
| 145 | + $access->batchApplyUserAttributes($result); |
| 146 | + } catch (\Exception $e) { |
| 147 | + $output->writeln('<error>Error while trying to lookup and update attributes from LDAP</error>'); |
| 148 | + } |
| 149 | + } |
| 150 | +} |
0 commit comments