aboutsummaryrefslogtreecommitdiffstats
path: root/apps/user_ldap/lib/Jobs/Sync.php
diff options
context:
space:
mode:
Diffstat (limited to 'apps/user_ldap/lib/Jobs/Sync.php')
-rw-r--r--apps/user_ldap/lib/Jobs/Sync.php228
1 files changed, 59 insertions, 169 deletions
diff --git a/apps/user_ldap/lib/Jobs/Sync.php b/apps/user_ldap/lib/Jobs/Sync.php
index 3d0dd88dfd2..26888ae96ae 100644
--- a/apps/user_ldap/lib/Jobs/Sync.php
+++ b/apps/user_ldap/lib/Jobs/Sync.php
@@ -1,30 +1,12 @@
<?php
+
/**
- * @copyright Copyright (c) 2017 Arthur Schiwon <blizzz@arthur-schiwon.de>
- *
- * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
- * @author Christoph Wurst <christoph@winzerhof-wurst.at>
- * @author Joas Schilling <coding@schilljs.com>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
*/
+
namespace OCA\User_LDAP\Jobs;
-use OC\BackgroundJob\TimedJob;
use OC\ServerNotAvailableException;
use OCA\User_LDAP\AccessFactory;
use OCA\User_LDAP\Configuration;
@@ -32,7 +14,9 @@ use OCA\User_LDAP\ConnectionFactory;
use OCA\User_LDAP\Helper;
use OCA\User_LDAP\LDAP;
use OCA\User_LDAP\Mapping\UserMapping;
-use OCA\User_LDAP\User\Manager;
+use OCP\AppFramework\Utility\ITimeFactory;
+use OCP\BackgroundJob\TimedJob;
+use OCP\EventDispatcher\IEventDispatcher;
use OCP\IAvatarManager;
use OCP\IConfig;
use OCP\IDBConnection;
@@ -43,46 +27,38 @@ use Psr\Log\LoggerInterface;
class Sync extends TimedJob {
public const MAX_INTERVAL = 12 * 60 * 60; // 12h
public const MIN_INTERVAL = 30 * 60; // 30min
- /** @var Helper */
- protected $ldapHelper;
- /** @var LDAP */
- protected $ldap;
- /** @var Manager */
- protected $userManager;
- /** @var UserMapping */
- protected $mapper;
- /** @var IConfig */
- protected $config;
- /** @var IAvatarManager */
- protected $avatarManager;
- /** @var IDBConnection */
- protected $dbc;
- /** @var IUserManager */
- protected $ncUserManager;
- /** @var LoggerInterface */
- protected $logger;
- /** @var IManager */
- protected $notificationManager;
- /** @var ConnectionFactory */
- protected $connectionFactory;
- /** @var AccessFactory */
- protected $accessFactory;
- public function __construct(Manager $userManager) {
- $this->userManager = $userManager;
+ protected LDAP $ldap;
+
+ public function __construct(
+ ITimeFactory $timeFactory,
+ private IEventDispatcher $dispatcher,
+ private IConfig $config,
+ private IDBConnection $dbc,
+ private IAvatarManager $avatarManager,
+ private IUserManager $ncUserManager,
+ private LoggerInterface $logger,
+ private IManager $notificationManager,
+ private UserMapping $mapper,
+ private Helper $ldapHelper,
+ private ConnectionFactory $connectionFactory,
+ private AccessFactory $accessFactory,
+ ) {
+ parent::__construct($timeFactory);
$this->setInterval(
- \OC::$server->getConfig()->getAppValue(
+ (int)$this->config->getAppValue(
'user_ldap',
'background_sync_interval',
- self::MIN_INTERVAL
+ (string)self::MIN_INTERVAL
)
);
+ $this->ldap = new LDAP($this->config->getSystemValueString('ldap_log_file'));
}
/**
- * updates the interval
+ * Updates the interval
*
- * the idea is to adjust the interval depending on the amount of known users
+ * The idea is to adjust the interval depending on the amount of known users
* and the attempt to update each user one day. At most it would run every
* 30 minutes, and at least every 12 hours.
*/
@@ -95,17 +71,16 @@ class Sync extends TimedJob {
$interval = floor(24 * 60 * 60 / $runsPerDay);
$interval = min(max($interval, self::MIN_INTERVAL), self::MAX_INTERVAL);
- $this->config->setAppValue('user_ldap', 'background_sync_interval', $interval);
+ $this->config->setAppValue('user_ldap', 'background_sync_interval', (string)$interval);
}
/**
* returns the smallest configured paging size
- * @return int
*/
- protected function getMinPagingSize() {
+ protected function getMinPagingSize(): int {
$configKeys = $this->config->getAppKeys('user_ldap');
$configKeys = array_filter($configKeys, function ($key) {
- return strpos($key, 'ldap_paging_size') !== false;
+ return str_contains($key, 'ldap_paging_size');
});
$minPagingSize = null;
foreach ($configKeys as $configKey) {
@@ -119,10 +94,8 @@ class Sync extends TimedJob {
* @param array $argument
*/
public function run($argument) {
- $this->setArgument($argument);
-
$isBackgroundJobModeAjax = $this->config
- ->getAppValue('core', 'backgroundjobs_mode', 'ajax') === 'ajax';
+ ->getAppValue('core', 'backgroundjobs_mode', 'ajax') === 'ajax';
if ($isBackgroundJobModeAjax) {
return;
}
@@ -155,10 +128,10 @@ class Sync extends TimedJob {
}
/**
- * @param array $cycleData
+ * @param array{offset: int, prefix: string} $cycleData
* @return bool whether more results are expected from the same configuration
*/
- public function runCycle($cycleData) {
+ public function runCycle(array $cycleData): bool {
$connection = $this->connectionFactory->get($cycleData['prefix']);
$access = $this->accessFactory->get($connection);
$access->setUserMapper($this->mapper);
@@ -171,7 +144,7 @@ class Sync extends TimedJob {
$results = $access->fetchListOfUsers(
$filter,
$access->userManager->getAttributes(),
- $connection->ldapPagingSize,
+ (int)$connection->ldapPagingSize,
$cycleData['offset'],
true
);
@@ -183,24 +156,22 @@ class Sync extends TimedJob {
}
/**
- * returns the info about the current cycle that should be run, if any,
+ * Returns the info about the current cycle that should be run, if any,
* otherwise null
- *
- * @return array|null
*/
- public function getCycle() {
+ public function getCycle(): ?array {
$prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
if (count($prefixes) === 0) {
return null;
}
$cycleData = [
- 'prefix' => $this->config->getAppValue('user_ldap', 'background_sync_prefix', null),
- 'offset' => (int)$this->config->getAppValue('user_ldap', 'background_sync_offset', 0),
+ 'prefix' => $this->config->getAppValue('user_ldap', 'background_sync_prefix', 'none'),
+ 'offset' => (int)$this->config->getAppValue('user_ldap', 'background_sync_offset', '0'),
];
if (
- $cycleData['prefix'] !== null
+ $cycleData['prefix'] !== 'none'
&& in_array($cycleData['prefix'], $prefixes)
) {
return $cycleData;
@@ -212,21 +183,21 @@ class Sync extends TimedJob {
/**
* Save the provided cycle information in the DB
*
- * @param array $cycleData
+ * @param array{prefix: ?string, offset: int} $cycleData
*/
- public function setCycle(array $cycleData) {
+ public function setCycle(array $cycleData): void {
$this->config->setAppValue('user_ldap', 'background_sync_prefix', $cycleData['prefix']);
- $this->config->setAppValue('user_ldap', 'background_sync_offset', $cycleData['offset']);
+ $this->config->setAppValue('user_ldap', 'background_sync_offset', (string)$cycleData['offset']);
}
/**
* returns data about the next cycle that should run, if any, otherwise
* null. It also always goes for the next LDAP configuration!
*
- * @param array|null $cycleData the old cycle
- * @return array|null
+ * @param ?array{prefix: string, offset: int} $cycleData the old cycle
+ * @return ?array{prefix: string, offset: int}
*/
- public function determineNextCycle(array $cycleData = null) {
+ public function determineNextCycle(?array $cycleData = null): ?array {
$prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
if (count($prefixes) === 0) {
return null;
@@ -246,14 +217,13 @@ class Sync extends TimedJob {
}
/**
- * Checks whether the provided cycle should be run. Currently only the
+ * Checks whether the provided cycle should be run. Currently, only the
* last configuration change goes into account (at least one hour).
*
- * @param $cycleData
- * @return bool
+ * @param array{prefix: string} $cycleData
*/
- public function qualifiesToRun($cycleData) {
- $lastChange = $this->config->getAppValue('user_ldap', $cycleData['prefix'] . '_lastChange', 0);
+ public function qualifiesToRun(array $cycleData): bool {
+ $lastChange = (int)$this->config->getAppValue('user_ldap', $cycleData['prefix'] . '_lastChange', '0');
if ((time() - $lastChange) > 60 * 30) {
return true;
}
@@ -261,23 +231,20 @@ class Sync extends TimedJob {
}
/**
- * increases the offset of the current cycle for the next run
+ * Increases the offset of the current cycle for the next run
*
- * @param $cycleData
+ * @param array{prefix: string, offset: int} $cycleData
*/
- protected function increaseOffset($cycleData) {
+ protected function increaseOffset(array $cycleData): void {
$ldapConfig = new Configuration($cycleData['prefix']);
$cycleData['offset'] += (int)$ldapConfig->ldapPagingSize;
$this->setCycle($cycleData);
}
/**
- * determines the next configuration prefix based on the last one (if any)
- *
- * @param string|null $lastPrefix
- * @return string|null
+ * Determines the next configuration prefix based on the last one (if any)
*/
- protected function getNextPrefix($lastPrefix) {
+ protected function getNextPrefix(?string $lastPrefix): ?string {
$prefixes = $this->ldapHelper->getServerConfigurationPrefixes(true);
$noOfPrefixes = count($prefixes);
if ($noOfPrefixes === 0) {
@@ -297,86 +264,9 @@ class Sync extends TimedJob {
}
/**
- * "fixes" DI
- *
- * @param array $argument
+ * Only used in tests
*/
- public function setArgument($argument) {
- if (isset($argument['config'])) {
- $this->config = $argument['config'];
- } else {
- $this->config = \OC::$server->getConfig();
- }
-
- if (isset($argument['helper'])) {
- $this->ldapHelper = $argument['helper'];
- } else {
- $this->ldapHelper = new Helper($this->config, \OC::$server->getDatabaseConnection());
- }
-
- if (isset($argument['ldapWrapper'])) {
- $this->ldap = $argument['ldapWrapper'];
- } else {
- $this->ldap = new LDAP($this->config->getSystemValueString('ldap_log_file'));
- }
-
- if (isset($argument['avatarManager'])) {
- $this->avatarManager = $argument['avatarManager'];
- } else {
- $this->avatarManager = \OC::$server->getAvatarManager();
- }
-
- if (isset($argument['dbc'])) {
- $this->dbc = $argument['dbc'];
- } else {
- $this->dbc = \OC::$server->getDatabaseConnection();
- }
-
- if (isset($argument['ncUserManager'])) {
- $this->ncUserManager = $argument['ncUserManager'];
- } else {
- $this->ncUserManager = \OC::$server->getUserManager();
- }
-
- if (isset($argument['logger'])) {
- $this->logger = $argument['logger'];
- } else {
- $this->logger = \OC::$server->get(LoggerInterface::class);
- }
-
- if (isset($argument['notificationManager'])) {
- $this->notificationManager = $argument['notificationManager'];
- } else {
- $this->notificationManager = \OC::$server->getNotificationManager();
- }
-
- if (isset($argument['userManager'])) {
- $this->userManager = $argument['userManager'];
- }
-
- if (isset($argument['mapper'])) {
- $this->mapper = $argument['mapper'];
- } else {
- $this->mapper = new UserMapping($this->dbc);
- }
-
- if (isset($argument['connectionFactory'])) {
- $this->connectionFactory = $argument['connectionFactory'];
- } else {
- $this->connectionFactory = new ConnectionFactory($this->ldap);
- }
-
- if (isset($argument['accessFactory'])) {
- $this->accessFactory = $argument['accessFactory'];
- } else {
- $this->accessFactory = new AccessFactory(
- $this->ldap,
- $this->userManager,
- $this->ldapHelper,
- $this->config,
- $this->ncUserManager,
- $this->logger
- );
- }
+ public function overwritePropertiesForTest(LDAP $ldapWrapper): void {
+ $this->ldap = $ldapWrapper;
}
}
generated by cgit v1.2.3 (git 2.39.1) at 2025-08-15 01:22:36 +0000