2014-08-21 19:59:13 +04:00
|
|
|
<?php
|
|
|
|
/**
|
2016-07-21 17:49:16 +03:00
|
|
|
* @copyright Copyright (c) 2016, ownCloud, Inc.
|
|
|
|
*
|
2016-05-26 20:56:05 +03:00
|
|
|
* @author Arthur Schiwon <blizzz@arthur-schiwon.de>
|
2016-07-21 17:49:16 +03:00
|
|
|
* @author Joas Schilling <coding@schilljs.com>
|
2015-03-26 13:44:34 +03:00
|
|
|
* @author Morris Jobke <hey@morrisjobke.de>
|
|
|
|
*
|
|
|
|
* @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/>
|
|
|
|
*
|
2014-08-21 19:59:13 +04:00
|
|
|
*/
|
2015-02-26 13:37:37 +03:00
|
|
|
|
2014-08-21 19:59:13 +04:00
|
|
|
namespace OCA\User_LDAP\Jobs;
|
|
|
|
|
2016-09-09 17:52:10 +03:00
|
|
|
use OC\BackgroundJob\TimedJob;
|
|
|
|
use OCA\User_LDAP\Helper;
|
|
|
|
use OCA\User_LDAP\LDAP;
|
|
|
|
use OCA\User_LDAP\Mapping\UserMapping;
|
|
|
|
use OCA\User_LDAP\User_LDAP;
|
|
|
|
use OCA\User_LDAP\User_Proxy;
|
|
|
|
use OCA\User_LDAP\User\DeletedUsersIndex;
|
2014-08-21 19:59:13 +04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Class CleanUp
|
|
|
|
*
|
|
|
|
* a Background job to clean up deleted users
|
|
|
|
*
|
2016-05-13 09:44:09 +03:00
|
|
|
* @package OCA\User_LDAP\Jobs;
|
2014-08-21 19:59:13 +04:00
|
|
|
*/
|
2015-01-08 19:45:07 +03:00
|
|
|
class CleanUp extends TimedJob {
|
2015-01-06 19:50:06 +03:00
|
|
|
/** @var int $limit amount of users that should be checked per run */
|
2014-08-21 19:59:13 +04:00
|
|
|
protected $limit = 50;
|
|
|
|
|
2015-01-06 19:50:06 +03:00
|
|
|
/** @var int $defaultIntervalMin default interval in minutes */
|
|
|
|
protected $defaultIntervalMin = 51;
|
|
|
|
|
2015-01-08 19:45:07 +03:00
|
|
|
/** @var User_LDAP|User_Proxy $userBackend */
|
2014-08-21 19:59:13 +04:00
|
|
|
protected $userBackend;
|
|
|
|
|
2015-01-06 19:50:06 +03:00
|
|
|
/** @var \OCP\IConfig $ocConfig */
|
2014-08-21 19:59:13 +04:00
|
|
|
protected $ocConfig;
|
|
|
|
|
2015-01-06 19:50:06 +03:00
|
|
|
/** @var \OCP\IDBConnection $db */
|
2014-08-21 19:59:13 +04:00
|
|
|
protected $db;
|
|
|
|
|
2015-01-06 19:50:06 +03:00
|
|
|
/** @var Helper $ldapHelper */
|
2014-08-21 19:59:13 +04:00
|
|
|
protected $ldapHelper;
|
|
|
|
|
2014-12-20 19:08:26 +03:00
|
|
|
/** @var \OCA\User_LDAP\Mapping\UserMapping */
|
|
|
|
protected $mapping;
|
|
|
|
|
2016-05-12 12:25:50 +03:00
|
|
|
/** @var \OCA\User_LDAP\User\DeletedUsersIndex */
|
2014-12-20 19:08:26 +03:00
|
|
|
protected $dui;
|
|
|
|
|
2014-08-21 19:59:13 +04:00
|
|
|
public function __construct() {
|
|
|
|
$minutes = \OC::$server->getConfig()->getSystemValue(
|
|
|
|
'ldapUserCleanupInterval', strval($this->defaultIntervalMin));
|
|
|
|
$this->setInterval(intval($minutes) * 60);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* assigns the instances passed to run() to the class properties
|
|
|
|
* @param array $arguments
|
|
|
|
*/
|
|
|
|
public function setArguments($arguments) {
|
|
|
|
//Dependency Injection is not possible, because the constructor will
|
|
|
|
//only get values that are serialized to JSON. I.e. whatever we would
|
|
|
|
//pass in app.php we do add here, except something else is passed e.g.
|
|
|
|
//in tests.
|
|
|
|
|
|
|
|
if(isset($arguments['helper'])) {
|
|
|
|
$this->ldapHelper = $arguments['helper'];
|
|
|
|
} else {
|
2016-10-10 11:18:18 +03:00
|
|
|
$this->ldapHelper = new Helper(\OC::$server->getConfig());
|
2014-08-21 19:59:13 +04:00
|
|
|
}
|
|
|
|
|
2015-01-08 19:45:07 +03:00
|
|
|
if(isset($arguments['ocConfig'])) {
|
|
|
|
$this->ocConfig = $arguments['ocConfig'];
|
|
|
|
} else {
|
|
|
|
$this->ocConfig = \OC::$server->getConfig();
|
|
|
|
}
|
|
|
|
|
2014-08-21 19:59:13 +04:00
|
|
|
if(isset($arguments['userBackend'])) {
|
|
|
|
$this->userBackend = $arguments['userBackend'];
|
|
|
|
} else {
|
|
|
|
$this->userBackend = new User_Proxy(
|
|
|
|
$this->ldapHelper->getServerConfigurationPrefixes(true),
|
2015-01-07 01:28:49 +03:00
|
|
|
new LDAP(),
|
2017-03-31 10:16:22 +03:00
|
|
|
$this->ocConfig,
|
2017-09-15 17:01:54 +03:00
|
|
|
\OC::$server->getNotificationManager(),
|
2017-11-02 15:40:38 +03:00
|
|
|
\OC::$server->getUserSession(),
|
|
|
|
\OC::$server->query('LDAPUserPluginManager')
|
2014-08-21 19:59:13 +04:00
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
if(isset($arguments['db'])) {
|
|
|
|
$this->db = $arguments['db'];
|
|
|
|
} else {
|
|
|
|
$this->db = \OC::$server->getDatabaseConnection();
|
|
|
|
}
|
2014-12-20 19:08:26 +03:00
|
|
|
|
|
|
|
if(isset($arguments['mapping'])) {
|
|
|
|
$this->mapping = $arguments['mapping'];
|
|
|
|
} else {
|
|
|
|
$this->mapping = new UserMapping($this->db);
|
|
|
|
}
|
|
|
|
|
|
|
|
if(isset($arguments['deletedUsersIndex'])) {
|
|
|
|
$this->dui = $arguments['deletedUsersIndex'];
|
|
|
|
} else {
|
|
|
|
$this->dui = new DeletedUsersIndex(
|
|
|
|
$this->ocConfig, $this->db, $this->mapping);
|
|
|
|
}
|
2014-08-21 19:59:13 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* makes the background job do its work
|
|
|
|
* @param array $argument
|
|
|
|
*/
|
|
|
|
public function run($argument) {
|
|
|
|
$this->setArguments($argument);
|
|
|
|
|
|
|
|
if(!$this->isCleanUpAllowed()) {
|
|
|
|
return;
|
|
|
|
}
|
2015-01-08 19:45:07 +03:00
|
|
|
$users = $this->mapping->getList($this->getOffset(), $this->limit);
|
2014-08-21 19:59:13 +04:00
|
|
|
if(!is_array($users)) {
|
|
|
|
//something wrong? Let's start from the beginning next time and
|
|
|
|
//abort
|
|
|
|
$this->setOffset(true);
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
$resetOffset = $this->isOffsetResetNecessary(count($users));
|
|
|
|
$this->checkUsers($users);
|
|
|
|
$this->setOffset($resetOffset);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* checks whether next run should start at 0 again
|
|
|
|
* @param int $resultCount
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function isOffsetResetNecessary($resultCount) {
|
|
|
|
return ($resultCount < $this->limit) ? true : false;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* checks whether cleaning up LDAP users is allowed
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
public function isCleanUpAllowed() {
|
|
|
|
try {
|
|
|
|
if($this->ldapHelper->haveDisabledConfigurations()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
} catch (\Exception $e) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
$enabled = $this->isCleanUpEnabled();
|
|
|
|
|
|
|
|
return $enabled;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* checks whether clean up is enabled by configuration
|
|
|
|
* @return bool
|
|
|
|
*/
|
|
|
|
private function isCleanUpEnabled() {
|
|
|
|
return (bool)$this->ocConfig->getSystemValue(
|
|
|
|
'ldapUserCleanupInterval', strval($this->defaultIntervalMin));
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* checks users whether they are still existing
|
|
|
|
* @param array $users result from getMappedUsers()
|
|
|
|
*/
|
2015-01-06 19:50:06 +03:00
|
|
|
private function checkUsers(array $users) {
|
2014-08-21 19:59:13 +04:00
|
|
|
foreach($users as $user) {
|
|
|
|
$this->checkUser($user);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* checks whether a user is still existing in LDAP
|
|
|
|
* @param string[] $user
|
|
|
|
*/
|
2015-01-06 19:50:06 +03:00
|
|
|
private function checkUser(array $user) {
|
2014-08-21 19:59:13 +04:00
|
|
|
if($this->userBackend->userExistsOnLDAP($user['name'])) {
|
|
|
|
//still available, all good
|
2014-12-20 19:08:26 +03:00
|
|
|
|
2014-08-21 19:59:13 +04:00
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
2014-12-20 19:08:26 +03:00
|
|
|
$this->dui->markUser($user['name']);
|
2014-08-21 19:59:13 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* gets the offset to fetch users from the mappings table
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
private function getOffset() {
|
2015-01-07 15:28:56 +03:00
|
|
|
return intval($this->ocConfig->getAppValue('user_ldap', 'cleanUpJobOffset', 0));
|
2014-08-21 19:59:13 +04:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* sets the new offset for the next run
|
|
|
|
* @param bool $reset whether the offset should be set to 0
|
|
|
|
*/
|
|
|
|
public function setOffset($reset = false) {
|
|
|
|
$newOffset = $reset ? 0 :
|
|
|
|
$this->getOffset() + $this->limit;
|
|
|
|
$this->ocConfig->setAppValue('user_ldap', 'cleanUpJobOffset', $newOffset);
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* returns the chunk size (limit in DB speak)
|
|
|
|
* @return int
|
|
|
|
*/
|
|
|
|
public function getChunkSize() {
|
|
|
|
return $this->limit;
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|