diff options
Diffstat (limited to 'apps/user_ldap/lib/Jobs/UpdateGroups.php')
| -rw-r--r-- | apps/user_ldap/lib/Jobs/UpdateGroups.php | 239 |
1 files changed, 25 insertions, 214 deletions
diff --git a/apps/user_ldap/lib/Jobs/UpdateGroups.php b/apps/user_ldap/lib/Jobs/UpdateGroups.php index c5eff77dbe3..9e72bcd8432 100644 --- a/apps/user_ldap/lib/Jobs/UpdateGroups.php +++ b/apps/user_ldap/lib/Jobs/UpdateGroups.php @@ -1,227 +1,38 @@ <?php + +declare(strict_types=1); + /** - * @copyright Copyright (c) 2016, ownCloud, Inc. - * - * @author Arthur Schiwon <blizzz@arthur-schiwon.de> - * @author Bart Visscher <bartv@thisnet.nl> - * @author Joas Schilling <coding@schilljs.com> - * @author Jörn Friedrich Dreyer <jfd@butonic.de> - * @author Lukas Reschke <lukas@statuscode.ch> - * @author Morris Jobke <hey@morrisjobke.de> - * @author Robin Appelman <robin@icewind.nl> - * @author Robin McCorkell <robin@mccorkell.me.uk> - * @author Roeland Jago Douma <roeland@famdouma.nl> - * @author Roger Szabo <roger.szabo@web.de> - * @author root <root@localhost.localdomain> - * @author Thomas Müller <thomas.mueller@tmit.eu> - * @author Vinicius Cubas Brand <vinicius@eita.org.br> - * - * @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/> - * + * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors + * SPDX-FileCopyrightText: 2016 ownCloud, Inc. + * SPDX-License-Identifier: AGPL-3.0-only */ - namespace OCA\User_LDAP\Jobs; -use OCA\User_LDAP\Access; -use OCA\User_LDAP\Connection; -use OCA\User_LDAP\FilesystemHelper; -use OCA\User_LDAP\Helper; -use OCA\User_LDAP\LDAP; -use OCA\User_LDAP\LogWrapper; -use OCA\User_LDAP\Mapping\GroupMapping; -use OCA\User_LDAP\Mapping\UserMapping; -use OCA\User_LDAP\User\Manager; - -class UpdateGroups extends \OC\BackgroundJob\TimedJob { - static private $groupsFromDB; - - static private $groupBE; +use OCA\User_LDAP\Service\UpdateGroupsService; +use OCP\AppFramework\Utility\ITimeFactory; +use OCP\BackgroundJob\TimedJob; +use OCP\DB\Exception; +use OCP\IConfig; +use Psr\Log\LoggerInterface; - public function __construct(){ - $this->interval = self::getRefreshInterval(); +class UpdateGroups extends TimedJob { + public function __construct( + private UpdateGroupsService $service, + private LoggerInterface $logger, + IConfig $config, + ITimeFactory $timeFactory, + ) { + parent::__construct($timeFactory); + $this->interval = (int)$config->getAppValue('user_ldap', 'bgjRefreshInterval', '3600'); } /** * @param mixed $argument + * @throws Exception */ - public function run($argument){ - self::updateGroups(); - } - - static public function updateGroups() { - \OCP\Util::writeLog('user_ldap', 'Run background job "updateGroups"', \OCP\Util::DEBUG); - - $knownGroups = array_keys(self::getKnownGroups()); - $actualGroups = self::getGroupBE()->getGroups(); - - if(empty($actualGroups) && empty($knownGroups)) { - \OCP\Util::writeLog('user_ldap', - 'bgJ "updateGroups" – groups do not seem to be configured properly, aborting.', - \OCP\Util::INFO); - return; - } - - self::handleKnownGroups(array_intersect($actualGroups, $knownGroups)); - self::handleCreatedGroups(array_diff($actualGroups, $knownGroups)); - self::handleRemovedGroups(array_diff($knownGroups, $actualGroups)); - - \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Finished.', \OCP\Util::DEBUG); - } - - /** - * @return int - */ - static private function getRefreshInterval() { - //defaults to every hour - return \OC::$server->getConfig()->getAppValue('user_ldap', 'bgjRefreshInterval', 3600); - } - - /** - * @param string[] $groups - */ - static private function handleKnownGroups($groups) { - \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – Dealing with known Groups.', \OCP\Util::DEBUG); - $query = \OCP\DB::prepare(' - UPDATE `*PREFIX*ldap_group_members` - SET `owncloudusers` = ? - WHERE `owncloudname` = ? - '); - foreach($groups as $group) { - //we assume, that self::$groupsFromDB has been retrieved already - $knownUsers = unserialize(self::$groupsFromDB[$group]['owncloudusers']); - $actualUsers = self::getGroupBE()->usersInGroup($group); - $hasChanged = false; - foreach(array_diff($knownUsers, $actualUsers) as $removedUser) { - \OCP\Util::emitHook('OC_User', 'post_removeFromGroup', array('uid' => $removedUser, 'gid' => $group)); - \OCP\Util::writeLog('user_ldap', - 'bgJ "updateGroups" – "'.$removedUser.'" removed from "'.$group.'".', - \OCP\Util::INFO); - $hasChanged = true; - } - foreach(array_diff($actualUsers, $knownUsers) as $addedUser) { - \OCP\Util::emitHook('OC_User', 'post_addToGroup', array('uid' => $addedUser, 'gid' => $group)); - \OCP\Util::writeLog('user_ldap', - 'bgJ "updateGroups" – "'.$addedUser.'" added to "'.$group.'".', - \OCP\Util::INFO); - $hasChanged = true; - } - if($hasChanged) { - $query->execute(array(serialize($actualUsers), $group)); - } - } - \OCP\Util::writeLog('user_ldap', - 'bgJ "updateGroups" – FINISHED dealing with known Groups.', - \OCP\Util::DEBUG); - } - - /** - * @param string[] $createdGroups - */ - static private function handleCreatedGroups($createdGroups) { - \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with created Groups.', \OCP\Util::DEBUG); - $query = \OCP\DB::prepare(' - INSERT - INTO `*PREFIX*ldap_group_members` (`owncloudname`, `owncloudusers`) - VALUES (?, ?) - '); - foreach($createdGroups as $createdGroup) { - \OCP\Util::writeLog('user_ldap', - 'bgJ "updateGroups" – new group "'.$createdGroup.'" found.', - \OCP\Util::INFO); - $users = serialize(self::getGroupBE()->usersInGroup($createdGroup)); - $query->execute(array($createdGroup, $users)); - } - \OCP\Util::writeLog('user_ldap', - 'bgJ "updateGroups" – FINISHED dealing with created Groups.', - \OCP\Util::DEBUG); - } - - /** - * @param string[] $removedGroups - */ - static private function handleRemovedGroups($removedGroups) { - \OCP\Util::writeLog('user_ldap', 'bgJ "updateGroups" – dealing with removed groups.', \OCP\Util::DEBUG); - $query = \OCP\DB::prepare(' - DELETE - FROM `*PREFIX*ldap_group_members` - WHERE `owncloudname` = ? - '); - foreach($removedGroups as $removedGroup) { - \OCP\Util::writeLog('user_ldap', - 'bgJ "updateGroups" – group "'.$removedGroup.'" was removed.', - \OCP\Util::INFO); - $query->execute(array($removedGroup)); - } - \OCP\Util::writeLog('user_ldap', - 'bgJ "updateGroups" – FINISHED dealing with removed groups.', - \OCP\Util::DEBUG); - } - - /** - * @return \OCA\User_LDAP\Group_LDAP|\OCA\User_LDAP\Group_Proxy - */ - static private function getGroupBE() { - if(!is_null(self::$groupBE)) { - return self::$groupBE; - } - $helper = new Helper(\OC::$server->getConfig()); - $configPrefixes = $helper->getServerConfigurationPrefixes(true); - $ldapWrapper = new LDAP(); - if(count($configPrefixes) === 1) { - //avoid the proxy when there is only one LDAP server configured - $dbc = \OC::$server->getDatabaseConnection(); - $userManager = new Manager( - \OC::$server->getConfig(), - new FilesystemHelper(), - new LogWrapper(), - \OC::$server->getAvatarManager(), - new \OCP\Image(), - $dbc, - \OC::$server->getUserManager(), - \OC::$server->getNotificationManager()); - $connector = new Connection($ldapWrapper, $configPrefixes[0]); - $ldapAccess = new Access($connector, $ldapWrapper, $userManager, $helper, \OC::$server->getConfig()); - $groupMapper = new GroupMapping($dbc); - $userMapper = new UserMapping($dbc); - $ldapAccess->setGroupMapper($groupMapper); - $ldapAccess->setUserMapper($userMapper); - self::$groupBE = new \OCA\User_LDAP\Group_LDAP($ldapAccess, \OC::$server->query('LDAPGroupPluginManager')); - } else { - self::$groupBE = new \OCA\User_LDAP\Group_Proxy($configPrefixes, $ldapWrapper, \OC::$server->query('LDAPGroupPluginManager')); - } - - return self::$groupBE; - } - - /** - * @return array - */ - static private function getKnownGroups() { - if(is_array(self::$groupsFromDB)) { - return self::$groupsFromDB; - } - $query = \OCP\DB::prepare(' - SELECT `owncloudname`, `owncloudusers` - FROM `*PREFIX*ldap_group_members` - '); - $result = $query->execute()->fetchAll(); - self::$groupsFromDB = array(); - foreach($result as $dataset) { - self::$groupsFromDB[$dataset['owncloudname']] = $dataset; - } - - return self::$groupsFromDB; + public function run($argument): void { + $this->logger->debug('Run background job "updateGroups"'); + $this->service->updateGroups(); } } |