summaryrefslogtreecommitdiffstats
path: root/apps/user_ldap/lib/user/deletedusersindex.php
blob: e544d29bad5ada3a6750d967f477d0905602bb19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<?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;
	}
}