nextcloud-server/apps/user_ldap/lib/user/deletedusersindex.php

126 lines
3.1 KiB
PHP

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<?php
/**
* ownCloud LDAP Helper
*
* @author Arthur Schiwon
* @copyright 2014 Arthur Schiwon <blizzz@owncloud.com>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 library. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\user_ldap\lib\user;
use OCA\user_ldap\lib\user\OfflineUser;
use OCA\User_LDAP\Mapping\UserMapping;
/**
* Class DeletedUsersIndex
* @package OCA\User_LDAP
*/
class DeletedUsersIndex {
/**
* @var \OC\Preferences $preferences
*/
protected $preferences;
/**
* @var \OCP\IDBConnection $db
*/
protected $db;
/**
* @var \OCA\User_LDAP\Mapping\UserMapping $mapping
*/
protected $mapping;
/**
* @var int $limit
*/
protected $limit = 10;
/**
* @var array $deletedUsers
*/
protected $deletedUsers = false;
public function __construct(\OC\Preferences $preferences, \OCP\IDBConnection $db, UserMapping $mapping) {
$this->preferences = $preferences;
$this->db = $db;
$this->mapping = $mapping;
}
/**
* returns key to be used against $this->deletedUsers
* @param int $limit
* @param int $offset
* @return string
*/
private function getDeletedUsersCacheKey($limit, $offset) {
return strval($limit) . '.' . strval($offset);
}
/**
* reads LDAP users marked as deleted from the database
* @param int $offset
* @return OCA\user_ldap\lib\user\OfflineUser[]
*/
private function fetchDeletedUsers($offset) {
$deletedUsers = $this->preferences->getUsersForValue(
'user_ldap', 'isDeleted', '1', $this->limit, $offset);
$key = $this->getDeletedUsersCacheKey($this->limit, $offset);
$userObjects = array();
foreach($deletedUsers as $user) {
$userObjects[] = new OfflineUser($user, $this->preferences, $this->db, $this->mapping);
}
$this->deletedUsers[$key] = $userObjects;
if(count($userObjects) > 0) {
$this->hasUsers();
}
return $this->deletedUsers[$key];
}
/**
* returns all LDAP users that are marked as deleted
* @param int|null $offset
* @return OCA\user_ldap\lib\user\OfflineUser[]
*/
public function getUsers($offset = null) {
$key = $this->getDeletedUsersCacheKey($this->limit, $offset);
if(is_array($this->deletedUsers) && isset($this->deletedUsers[$key])) {
return $this->deletedUsers[$key];
}
return $this->fetchDeletedUsers($offset);
}
/**
* whether at least one user was detected as deleted
* @return bool
*/
public function hasUsers() {
if($this->deletedUsers === false) {
$this->fetchDeletedUsers(0);
}
foreach($this->deletedUsers as $batch) {
if(count($batch) > 0) {
return true;
}
}
return false;
}
}