Completed
Pull Request — master (#10087)
by Sebastian
68:04 queued 23:34
created
lib/private/User/Manager.php 1 patch
Indentation   +533 added lines, -533 removed lines patch added patch discarded remove patch
@@ -58,541 +58,541 @@
 block discarded – undo
58 58
  * @package OC\User
59 59
  */
60 60
 class Manager extends PublicEmitter implements IUserManager {
61
-	/**
62
-	 * @var \OCP\UserInterface[] $backends
63
-	 */
64
-	private $backends = array();
65
-
66
-	/**
67
-	 * @var \OC\User\User[] $cachedUsers
68
-	 */
69
-	private $cachedUsers = array();
70
-
71
-	/**
72
-	 * @var \OCP\IConfig $config
73
-	 */
74
-	private $config;
75
-
76
-	/**
77
-	 * @param \OCP\IConfig $config
78
-	 */
79
-	public function __construct(IConfig $config) {
80
-		$this->config = $config;
81
-		$cachedUsers = &$this->cachedUsers;
82
-		$this->listen('\OC\User', 'postDelete', function ($user) use (&$cachedUsers) {
83
-			/** @var \OC\User\User $user */
84
-			unset($cachedUsers[$user->getUID()]);
85
-		});
86
-	}
87
-
88
-	/**
89
-	 * Get the active backends
90
-	 * @return \OCP\UserInterface[]
91
-	 */
92
-	public function getBackends() {
93
-		return $this->backends;
94
-	}
95
-
96
-	/**
97
-	 * register a user backend
98
-	 *
99
-	 * @param \OCP\UserInterface $backend
100
-	 */
101
-	public function registerBackend($backend) {
102
-		$this->backends[] = $backend;
103
-	}
104
-
105
-	/**
106
-	 * remove a user backend
107
-	 *
108
-	 * @param \OCP\UserInterface $backend
109
-	 */
110
-	public function removeBackend($backend) {
111
-		$this->cachedUsers = array();
112
-		if (($i = array_search($backend, $this->backends)) !== false) {
113
-			unset($this->backends[$i]);
114
-		}
115
-	}
116
-
117
-	/**
118
-	 * remove all user backends
119
-	 */
120
-	public function clearBackends() {
121
-		$this->cachedUsers = array();
122
-		$this->backends = array();
123
-	}
124
-
125
-	/**
126
-	 * get a user by user id
127
-	 *
128
-	 * @param string $uid
129
-	 * @return \OC\User\User|null Either the user or null if the specified user does not exist
130
-	 */
131
-	public function get($uid) {
132
-		if (is_null($uid) || $uid === '' || $uid === false) {
133
-			return null;
134
-		}
135
-		if (isset($this->cachedUsers[$uid])) { //check the cache first to prevent having to loop over the backends
136
-			return $this->cachedUsers[$uid];
137
-		}
138
-		foreach ($this->backends as $backend) {
139
-			if ($backend->userExists($uid)) {
140
-				return $this->getUserObject($uid, $backend);
141
-			}
142
-		}
143
-		return null;
144
-	}
145
-
146
-	/**
147
-	 * get or construct the user object
148
-	 *
149
-	 * @param string $uid
150
-	 * @param \OCP\UserInterface $backend
151
-	 * @param bool $cacheUser If false the newly created user object will not be cached
152
-	 * @return \OC\User\User
153
-	 */
154
-	protected function getUserObject($uid, $backend, $cacheUser = true) {
155
-		if (isset($this->cachedUsers[$uid])) {
156
-			return $this->cachedUsers[$uid];
157
-		}
158
-
159
-		$user = new User($uid, $backend, $this, $this->config);
160
-		if ($cacheUser) {
161
-			$this->cachedUsers[$uid] = $user;
162
-		}
163
-		return $user;
164
-	}
165
-
166
-	/**
167
-	 * check if a user exists
168
-	 *
169
-	 * @param string $uid
170
-	 * @return bool
171
-	 */
172
-	public function userExists($uid) {
173
-		$user = $this->get($uid);
174
-		return ($user !== null);
175
-	}
176
-
177
-	/**
178
-	 * Check if the password is valid for the user
179
-	 *
180
-	 * @param string $loginName
181
-	 * @param string $password
182
-	 * @return mixed the User object on success, false otherwise
183
-	 */
184
-	public function checkPassword($loginName, $password) {
185
-		$result = $this->checkPasswordNoLogging($loginName, $password);
186
-
187
-		if ($result === false) {
188
-			\OC::$server->getLogger()->warning('Login failed: \''. $loginName .'\' (Remote IP: \''. \OC::$server->getRequest()->getRemoteAddress(). '\')', ['app' => 'core']);
189
-		}
190
-
191
-		return $result;
192
-	}
193
-
194
-	/**
195
-	 * Check if the password is valid for the user
196
-	 *
197
-	 * @internal
198
-	 * @param string $loginName
199
-	 * @param string $password
200
-	 * @return mixed the User object on success, false otherwise
201
-	 */
202
-	public function checkPasswordNoLogging($loginName, $password) {
203
-		$loginName = str_replace("\0", '', $loginName);
204
-		$password = str_replace("\0", '', $password);
205
-
206
-		foreach ($this->backends as $backend) {
207
-			if ($backend->implementsActions(Backend::CHECK_PASSWORD)) {
208
-				$uid = $backend->checkPassword($loginName, $password);
209
-				if ($uid !== false) {
210
-					return $this->getUserObject($uid, $backend);
211
-				}
212
-			}
213
-		}
214
-
215
-		return false;
216
-	}
217
-
218
-	/**
219
-	 * search by user id
220
-	 *
221
-	 * @param string $pattern
222
-	 * @param int $limit
223
-	 * @param int $offset
224
-	 * @return \OC\User\User[]
225
-	 */
226
-	public function search($pattern, $limit = null, $offset = null) {
227
-		$users = array();
228
-		foreach ($this->backends as $backend) {
229
-			$backendUsers = $backend->getUsers($pattern, $limit, $offset);
230
-			if (is_array($backendUsers)) {
231
-				foreach ($backendUsers as $uid) {
232
-					$users[$uid] = $this->getUserObject($uid, $backend);
233
-				}
234
-			}
235
-		}
236
-
237
-		uasort($users, function ($a, $b) {
238
-			/**
239
-			 * @var \OC\User\User $a
240
-			 * @var \OC\User\User $b
241
-			 */
242
-			return strcasecmp($a->getUID(), $b->getUID());
243
-		});
244
-		return $users;
245
-	}
246
-
247
-	/**
248
-	 * search by displayName
249
-	 *
250
-	 * @param string $pattern
251
-	 * @param int $limit
252
-	 * @param int $offset
253
-	 * @return \OC\User\User[]
254
-	 */
255
-	public function searchDisplayName($pattern, $limit = null, $offset = null) {
256
-		$users = array();
257
-		foreach ($this->backends as $backend) {
258
-			$backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
259
-			if (is_array($backendUsers)) {
260
-				foreach ($backendUsers as $uid => $displayName) {
261
-					$users[] = $this->getUserObject($uid, $backend);
262
-				}
263
-			}
264
-		}
265
-
266
-		usort($users, function ($a, $b) {
267
-			/**
268
-			 * @var \OC\User\User $a
269
-			 * @var \OC\User\User $b
270
-			 */
271
-			return strcasecmp($a->getDisplayName(), $b->getDisplayName());
272
-		});
273
-		return $users;
274
-	}
275
-
276
-	/**
277
-	 * @param string $uid
278
-	 * @param string $password
279
-	 * @throws \InvalidArgumentException
280
-	 * @return bool|IUser the created user or false
281
-	 */
282
-	public function createUser($uid, $password) {
283
-		$localBackends = [];
284
-		foreach ($this->backends as $backend) {
285
-			if ($backend instanceof Database) {
286
-				// First check if there is another user backend
287
-				$localBackends[] = $backend;
288
-				continue;
289
-			}
290
-
291
-			if ($backend->implementsActions(Backend::CREATE_USER)) {
292
-				return $this->createUserFromBackend($uid, $password, $backend);
293
-			}
294
-		}
295
-
296
-		foreach ($localBackends as $backend) {
297
-			if ($backend->implementsActions(Backend::CREATE_USER)) {
298
-				return $this->createUserFromBackend($uid, $password, $backend);
299
-			}
300
-		}
301
-
302
-		return false;
303
-	}
304
-
305
-	/**
306
-	 * @param string $uid
307
-	 * @param string $password
308
-	 * @param UserInterface $backend
309
-	 * @return IUser|null
310
-	 * @throws \InvalidArgumentException
311
-	 */
312
-	public function createUserFromBackend($uid, $password, UserInterface $backend) {
313
-		$l = \OC::$server->getL10N('lib');
314
-
315
-		// Check the name for bad characters
316
-		// Allowed are: "a-z", "A-Z", "0-9" and "_.@-'+"
317
-		if (preg_match('/[^a-zA-Z0-9 _\.@\-\'\+]/', $uid)) {
318
-			throw new \InvalidArgumentException($l->t('Only the following characters are allowed in a username:'
319
-				. ' "a-z", "A-Z", "0-9", and "_.@-\'+"'));
320
-		}
321
-		// No empty username
322
-		if (trim($uid) === '') {
323
-			throw new \InvalidArgumentException($l->t('A valid username must be provided'));
324
-		}
325
-		// No whitespace at the beginning or at the end
326
-		if (trim($uid) !== $uid) {
327
-			throw new \InvalidArgumentException($l->t('Username contains whitespace at the beginning or at the end'));
328
-		}
329
-		// Username only consists of 1 or 2 dots (directory traversal)
330
-		if ($uid === '.' || $uid === '..') {
331
-			throw new \InvalidArgumentException($l->t('Username must not consist of dots only'));
332
-		}
333
-		// No empty password
334
-		if (trim($password) === '') {
335
-			throw new \InvalidArgumentException($l->t('A valid password must be provided'));
336
-		}
337
-
338
-		// Check if user already exists
339
-		if ($this->userExists($uid)) {
340
-			throw new \InvalidArgumentException($l->t('The username is already being used'));
341
-		}
342
-
343
-		$this->emit('\OC\User', 'preCreateUser', [$uid, $password]);
344
-		$state = $backend->createUser($uid, $password);
345
-		if($state === false) {
346
-			throw new \InvalidArgumentException($l->t('Could not create user'));
347
-		}
348
-		$user = $this->getUserObject($uid, $backend);
349
-		if ($user instanceof IUser) {
350
-			$this->emit('\OC\User', 'postCreateUser', [$user, $password]);
351
-		}
352
-		return $user;
353
-	}
354
-
355
-	/**
356
-	 * returns how many users per backend exist (if supported by backend)
357
-	 *
358
-	 * @param boolean $hasLoggedIn when true only users that have a lastLogin
359
-	 *                entry in the preferences table will be affected
360
-	 * @return array|int an array of backend class as key and count number as value
361
-	 *                if $hasLoggedIn is true only an int is returned
362
-	 */
363
-	public function countUsers($hasLoggedIn = false) {
364
-		if ($hasLoggedIn) {
365
-			return $this->countSeenUsers();
366
-		}
367
-		$userCountStatistics = [];
368
-		foreach ($this->backends as $backend) {
369
-			if ($backend->implementsActions(Backend::COUNT_USERS)) {
370
-				$backendUsers = $backend->countUsers();
371
-				if($backendUsers !== false) {
372
-					if($backend instanceof IUserBackend) {
373
-						$name = $backend->getBackendName();
374
-					} else {
375
-						$name = get_class($backend);
376
-					}
377
-					if(isset($userCountStatistics[$name])) {
378
-						$userCountStatistics[$name] += $backendUsers;
379
-					} else {
380
-						$userCountStatistics[$name] = $backendUsers;
381
-					}
382
-				}
383
-			}
384
-		}
385
-		return $userCountStatistics;
386
-	}
387
-
388
-	/**
389
-	 * returns how many users per backend exist in the requested groups (if supported by backend)
390
-	 *
391
-	 * @param IGroup[] $groups an array of gid to search in
392
-	 * @return array|int an array of backend class as key and count number as value
393
-	 *                if $hasLoggedIn is true only an int is returned
394
-	 */
395
-	public function countUsersOfGroups(array $groups) {
396
-		$users = [];
397
-		foreach($groups as $group) {
398
-			$usersIds = array_map(function($user) {
399
-				return $user->getUID();
400
-			}, $group->getUsers());
401
-			$users = array_merge($users, $usersIds);
402
-		}
403
-		return count(array_unique($users));
404
-	}
405
-
406
-	/**
407
-	 * The callback is executed for each user on each backend.
408
-	 * If the callback returns false no further users will be retrieved.
409
-	 *
410
-	 * @param \Closure $callback
411
-	 * @param string $search
412
-	 * @param boolean $onlySeen when true only users that have a lastLogin entry
413
-	 *                in the preferences table will be affected
414
-	 * @since 9.0.0
415
-	 */
416
-	public function callForAllUsers(\Closure $callback, $search = '', $onlySeen = false) {
417
-		if ($onlySeen) {
418
-			$this->callForSeenUsers($callback);
419
-		} else {
420
-			foreach ($this->getBackends() as $backend) {
421
-				$limit = 500;
422
-				$offset = 0;
423
-				do {
424
-					$users = $backend->getUsers($search, $limit, $offset);
425
-					foreach ($users as $uid) {
426
-						if (!$backend->userExists($uid)) {
427
-							continue;
428
-						}
429
-						$user = $this->getUserObject($uid, $backend, false);
430
-						$return = $callback($user);
431
-						if ($return === false) {
432
-							break;
433
-						}
434
-					}
435
-					$offset += $limit;
436
-				} while (count($users) >= $limit);
437
-			}
438
-		}
439
-	}
440
-
441
-	/**
442
-	 * returns how many users are disabled
443
-	 *
444
-	 * @return int
445
-	 * @since 12.0.0
446
-	 */
447
-	public function countDisabledUsers(): int {
448
-		$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
449
-		$queryBuilder->select($queryBuilder->createFunction('COUNT(*)'))
450
-			->from('preferences')
451
-			->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
452
-			->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
453
-			->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR));
61
+    /**
62
+     * @var \OCP\UserInterface[] $backends
63
+     */
64
+    private $backends = array();
65
+
66
+    /**
67
+     * @var \OC\User\User[] $cachedUsers
68
+     */
69
+    private $cachedUsers = array();
70
+
71
+    /**
72
+     * @var \OCP\IConfig $config
73
+     */
74
+    private $config;
75
+
76
+    /**
77
+     * @param \OCP\IConfig $config
78
+     */
79
+    public function __construct(IConfig $config) {
80
+        $this->config = $config;
81
+        $cachedUsers = &$this->cachedUsers;
82
+        $this->listen('\OC\User', 'postDelete', function ($user) use (&$cachedUsers) {
83
+            /** @var \OC\User\User $user */
84
+            unset($cachedUsers[$user->getUID()]);
85
+        });
86
+    }
87
+
88
+    /**
89
+     * Get the active backends
90
+     * @return \OCP\UserInterface[]
91
+     */
92
+    public function getBackends() {
93
+        return $this->backends;
94
+    }
95
+
96
+    /**
97
+     * register a user backend
98
+     *
99
+     * @param \OCP\UserInterface $backend
100
+     */
101
+    public function registerBackend($backend) {
102
+        $this->backends[] = $backend;
103
+    }
104
+
105
+    /**
106
+     * remove a user backend
107
+     *
108
+     * @param \OCP\UserInterface $backend
109
+     */
110
+    public function removeBackend($backend) {
111
+        $this->cachedUsers = array();
112
+        if (($i = array_search($backend, $this->backends)) !== false) {
113
+            unset($this->backends[$i]);
114
+        }
115
+    }
116
+
117
+    /**
118
+     * remove all user backends
119
+     */
120
+    public function clearBackends() {
121
+        $this->cachedUsers = array();
122
+        $this->backends = array();
123
+    }
124
+
125
+    /**
126
+     * get a user by user id
127
+     *
128
+     * @param string $uid
129
+     * @return \OC\User\User|null Either the user or null if the specified user does not exist
130
+     */
131
+    public function get($uid) {
132
+        if (is_null($uid) || $uid === '' || $uid === false) {
133
+            return null;
134
+        }
135
+        if (isset($this->cachedUsers[$uid])) { //check the cache first to prevent having to loop over the backends
136
+            return $this->cachedUsers[$uid];
137
+        }
138
+        foreach ($this->backends as $backend) {
139
+            if ($backend->userExists($uid)) {
140
+                return $this->getUserObject($uid, $backend);
141
+            }
142
+        }
143
+        return null;
144
+    }
145
+
146
+    /**
147
+     * get or construct the user object
148
+     *
149
+     * @param string $uid
150
+     * @param \OCP\UserInterface $backend
151
+     * @param bool $cacheUser If false the newly created user object will not be cached
152
+     * @return \OC\User\User
153
+     */
154
+    protected function getUserObject($uid, $backend, $cacheUser = true) {
155
+        if (isset($this->cachedUsers[$uid])) {
156
+            return $this->cachedUsers[$uid];
157
+        }
158
+
159
+        $user = new User($uid, $backend, $this, $this->config);
160
+        if ($cacheUser) {
161
+            $this->cachedUsers[$uid] = $user;
162
+        }
163
+        return $user;
164
+    }
165
+
166
+    /**
167
+     * check if a user exists
168
+     *
169
+     * @param string $uid
170
+     * @return bool
171
+     */
172
+    public function userExists($uid) {
173
+        $user = $this->get($uid);
174
+        return ($user !== null);
175
+    }
176
+
177
+    /**
178
+     * Check if the password is valid for the user
179
+     *
180
+     * @param string $loginName
181
+     * @param string $password
182
+     * @return mixed the User object on success, false otherwise
183
+     */
184
+    public function checkPassword($loginName, $password) {
185
+        $result = $this->checkPasswordNoLogging($loginName, $password);
186
+
187
+        if ($result === false) {
188
+            \OC::$server->getLogger()->warning('Login failed: \''. $loginName .'\' (Remote IP: \''. \OC::$server->getRequest()->getRemoteAddress(). '\')', ['app' => 'core']);
189
+        }
190
+
191
+        return $result;
192
+    }
193
+
194
+    /**
195
+     * Check if the password is valid for the user
196
+     *
197
+     * @internal
198
+     * @param string $loginName
199
+     * @param string $password
200
+     * @return mixed the User object on success, false otherwise
201
+     */
202
+    public function checkPasswordNoLogging($loginName, $password) {
203
+        $loginName = str_replace("\0", '', $loginName);
204
+        $password = str_replace("\0", '', $password);
205
+
206
+        foreach ($this->backends as $backend) {
207
+            if ($backend->implementsActions(Backend::CHECK_PASSWORD)) {
208
+                $uid = $backend->checkPassword($loginName, $password);
209
+                if ($uid !== false) {
210
+                    return $this->getUserObject($uid, $backend);
211
+                }
212
+            }
213
+        }
214
+
215
+        return false;
216
+    }
217
+
218
+    /**
219
+     * search by user id
220
+     *
221
+     * @param string $pattern
222
+     * @param int $limit
223
+     * @param int $offset
224
+     * @return \OC\User\User[]
225
+     */
226
+    public function search($pattern, $limit = null, $offset = null) {
227
+        $users = array();
228
+        foreach ($this->backends as $backend) {
229
+            $backendUsers = $backend->getUsers($pattern, $limit, $offset);
230
+            if (is_array($backendUsers)) {
231
+                foreach ($backendUsers as $uid) {
232
+                    $users[$uid] = $this->getUserObject($uid, $backend);
233
+                }
234
+            }
235
+        }
236
+
237
+        uasort($users, function ($a, $b) {
238
+            /**
239
+             * @var \OC\User\User $a
240
+             * @var \OC\User\User $b
241
+             */
242
+            return strcasecmp($a->getUID(), $b->getUID());
243
+        });
244
+        return $users;
245
+    }
246
+
247
+    /**
248
+     * search by displayName
249
+     *
250
+     * @param string $pattern
251
+     * @param int $limit
252
+     * @param int $offset
253
+     * @return \OC\User\User[]
254
+     */
255
+    public function searchDisplayName($pattern, $limit = null, $offset = null) {
256
+        $users = array();
257
+        foreach ($this->backends as $backend) {
258
+            $backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
259
+            if (is_array($backendUsers)) {
260
+                foreach ($backendUsers as $uid => $displayName) {
261
+                    $users[] = $this->getUserObject($uid, $backend);
262
+                }
263
+            }
264
+        }
265
+
266
+        usort($users, function ($a, $b) {
267
+            /**
268
+             * @var \OC\User\User $a
269
+             * @var \OC\User\User $b
270
+             */
271
+            return strcasecmp($a->getDisplayName(), $b->getDisplayName());
272
+        });
273
+        return $users;
274
+    }
275
+
276
+    /**
277
+     * @param string $uid
278
+     * @param string $password
279
+     * @throws \InvalidArgumentException
280
+     * @return bool|IUser the created user or false
281
+     */
282
+    public function createUser($uid, $password) {
283
+        $localBackends = [];
284
+        foreach ($this->backends as $backend) {
285
+            if ($backend instanceof Database) {
286
+                // First check if there is another user backend
287
+                $localBackends[] = $backend;
288
+                continue;
289
+            }
290
+
291
+            if ($backend->implementsActions(Backend::CREATE_USER)) {
292
+                return $this->createUserFromBackend($uid, $password, $backend);
293
+            }
294
+        }
295
+
296
+        foreach ($localBackends as $backend) {
297
+            if ($backend->implementsActions(Backend::CREATE_USER)) {
298
+                return $this->createUserFromBackend($uid, $password, $backend);
299
+            }
300
+        }
301
+
302
+        return false;
303
+    }
304
+
305
+    /**
306
+     * @param string $uid
307
+     * @param string $password
308
+     * @param UserInterface $backend
309
+     * @return IUser|null
310
+     * @throws \InvalidArgumentException
311
+     */
312
+    public function createUserFromBackend($uid, $password, UserInterface $backend) {
313
+        $l = \OC::$server->getL10N('lib');
314
+
315
+        // Check the name for bad characters
316
+        // Allowed are: "a-z", "A-Z", "0-9" and "_.@-'+"
317
+        if (preg_match('/[^a-zA-Z0-9 _\.@\-\'\+]/', $uid)) {
318
+            throw new \InvalidArgumentException($l->t('Only the following characters are allowed in a username:'
319
+                . ' "a-z", "A-Z", "0-9", and "_.@-\'+"'));
320
+        }
321
+        // No empty username
322
+        if (trim($uid) === '') {
323
+            throw new \InvalidArgumentException($l->t('A valid username must be provided'));
324
+        }
325
+        // No whitespace at the beginning or at the end
326
+        if (trim($uid) !== $uid) {
327
+            throw new \InvalidArgumentException($l->t('Username contains whitespace at the beginning or at the end'));
328
+        }
329
+        // Username only consists of 1 or 2 dots (directory traversal)
330
+        if ($uid === '.' || $uid === '..') {
331
+            throw new \InvalidArgumentException($l->t('Username must not consist of dots only'));
332
+        }
333
+        // No empty password
334
+        if (trim($password) === '') {
335
+            throw new \InvalidArgumentException($l->t('A valid password must be provided'));
336
+        }
337
+
338
+        // Check if user already exists
339
+        if ($this->userExists($uid)) {
340
+            throw new \InvalidArgumentException($l->t('The username is already being used'));
341
+        }
342
+
343
+        $this->emit('\OC\User', 'preCreateUser', [$uid, $password]);
344
+        $state = $backend->createUser($uid, $password);
345
+        if($state === false) {
346
+            throw new \InvalidArgumentException($l->t('Could not create user'));
347
+        }
348
+        $user = $this->getUserObject($uid, $backend);
349
+        if ($user instanceof IUser) {
350
+            $this->emit('\OC\User', 'postCreateUser', [$user, $password]);
351
+        }
352
+        return $user;
353
+    }
354
+
355
+    /**
356
+     * returns how many users per backend exist (if supported by backend)
357
+     *
358
+     * @param boolean $hasLoggedIn when true only users that have a lastLogin
359
+     *                entry in the preferences table will be affected
360
+     * @return array|int an array of backend class as key and count number as value
361
+     *                if $hasLoggedIn is true only an int is returned
362
+     */
363
+    public function countUsers($hasLoggedIn = false) {
364
+        if ($hasLoggedIn) {
365
+            return $this->countSeenUsers();
366
+        }
367
+        $userCountStatistics = [];
368
+        foreach ($this->backends as $backend) {
369
+            if ($backend->implementsActions(Backend::COUNT_USERS)) {
370
+                $backendUsers = $backend->countUsers();
371
+                if($backendUsers !== false) {
372
+                    if($backend instanceof IUserBackend) {
373
+                        $name = $backend->getBackendName();
374
+                    } else {
375
+                        $name = get_class($backend);
376
+                    }
377
+                    if(isset($userCountStatistics[$name])) {
378
+                        $userCountStatistics[$name] += $backendUsers;
379
+                    } else {
380
+                        $userCountStatistics[$name] = $backendUsers;
381
+                    }
382
+                }
383
+            }
384
+        }
385
+        return $userCountStatistics;
386
+    }
387
+
388
+    /**
389
+     * returns how many users per backend exist in the requested groups (if supported by backend)
390
+     *
391
+     * @param IGroup[] $groups an array of gid to search in
392
+     * @return array|int an array of backend class as key and count number as value
393
+     *                if $hasLoggedIn is true only an int is returned
394
+     */
395
+    public function countUsersOfGroups(array $groups) {
396
+        $users = [];
397
+        foreach($groups as $group) {
398
+            $usersIds = array_map(function($user) {
399
+                return $user->getUID();
400
+            }, $group->getUsers());
401
+            $users = array_merge($users, $usersIds);
402
+        }
403
+        return count(array_unique($users));
404
+    }
405
+
406
+    /**
407
+     * The callback is executed for each user on each backend.
408
+     * If the callback returns false no further users will be retrieved.
409
+     *
410
+     * @param \Closure $callback
411
+     * @param string $search
412
+     * @param boolean $onlySeen when true only users that have a lastLogin entry
413
+     *                in the preferences table will be affected
414
+     * @since 9.0.0
415
+     */
416
+    public function callForAllUsers(\Closure $callback, $search = '', $onlySeen = false) {
417
+        if ($onlySeen) {
418
+            $this->callForSeenUsers($callback);
419
+        } else {
420
+            foreach ($this->getBackends() as $backend) {
421
+                $limit = 500;
422
+                $offset = 0;
423
+                do {
424
+                    $users = $backend->getUsers($search, $limit, $offset);
425
+                    foreach ($users as $uid) {
426
+                        if (!$backend->userExists($uid)) {
427
+                            continue;
428
+                        }
429
+                        $user = $this->getUserObject($uid, $backend, false);
430
+                        $return = $callback($user);
431
+                        if ($return === false) {
432
+                            break;
433
+                        }
434
+                    }
435
+                    $offset += $limit;
436
+                } while (count($users) >= $limit);
437
+            }
438
+        }
439
+    }
440
+
441
+    /**
442
+     * returns how many users are disabled
443
+     *
444
+     * @return int
445
+     * @since 12.0.0
446
+     */
447
+    public function countDisabledUsers(): int {
448
+        $queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
449
+        $queryBuilder->select($queryBuilder->createFunction('COUNT(*)'))
450
+            ->from('preferences')
451
+            ->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
452
+            ->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
453
+            ->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR));
454 454
 
455 455
 		
456
-		$result = $queryBuilder->execute();
457
-		$count = $result->fetchColumn();
458
-		$result->closeCursor();
456
+        $result = $queryBuilder->execute();
457
+        $count = $result->fetchColumn();
458
+        $result->closeCursor();
459 459
 		
460
-		if ($count !== false) {
461
-			$count = (int)$count;
462
-		} else {
463
-			$count = 0;
464
-		}
465
-
466
-		return $count;
467
-	}
468
-
469
-	/**
470
-	 * returns how many users are disabled in the requested groups
471
-	 *
472
-	 * @param array $groups groupids to search
473
-	 * @return int
474
-	 * @since 14.0.0
475
-	 */
476
-	public function countDisabledUsersOfGroups(array $groups): int {
477
-		$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
478
-		$queryBuilder->select($queryBuilder->createFunction('COUNT(Distinct uid)'))
479
-			->from('preferences', 'p')
480
-			->innerJoin('p', 'group_user', 'g', 'p.userid = g.uid')
481
-			->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
482
-			->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
483
-			->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
484
-			->andWhere($queryBuilder->expr()->in('gid', $queryBuilder->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY)));
485
-
486
-		$result = $queryBuilder->execute();
487
-		$count = $result->fetchColumn();
488
-		$result->closeCursor();
460
+        if ($count !== false) {
461
+            $count = (int)$count;
462
+        } else {
463
+            $count = 0;
464
+        }
465
+
466
+        return $count;
467
+    }
468
+
469
+    /**
470
+     * returns how many users are disabled in the requested groups
471
+     *
472
+     * @param array $groups groupids to search
473
+     * @return int
474
+     * @since 14.0.0
475
+     */
476
+    public function countDisabledUsersOfGroups(array $groups): int {
477
+        $queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
478
+        $queryBuilder->select($queryBuilder->createFunction('COUNT(Distinct uid)'))
479
+            ->from('preferences', 'p')
480
+            ->innerJoin('p', 'group_user', 'g', 'p.userid = g.uid')
481
+            ->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
482
+            ->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
483
+            ->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
484
+            ->andWhere($queryBuilder->expr()->in('gid', $queryBuilder->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY)));
485
+
486
+        $result = $queryBuilder->execute();
487
+        $count = $result->fetchColumn();
488
+        $result->closeCursor();
489 489
 		
490
-		if ($count !== false) {
491
-			$count = (int)$count;
492
-		} else {
493
-			$count = 0;
494
-		}
495
-
496
-		return $count;
497
-	}
498
-
499
-	/**
500
-	 * returns how many users have logged in once
501
-	 *
502
-	 * @return int
503
-	 * @since 11.0.0
504
-	 */
505
-	public function countSeenUsers() {
506
-		$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
507
-		$queryBuilder->select($queryBuilder->createFunction('COUNT(*)'))
508
-			->from('preferences')
509
-			->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('login')))
510
-			->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('lastLogin')))
511
-			->andWhere($queryBuilder->expr()->isNotNull('configvalue'));
512
-
513
-		$query = $queryBuilder->execute();
514
-
515
-		$result = (int)$query->fetchColumn();
516
-		$query->closeCursor();
517
-
518
-		return $result;
519
-	}
520
-
521
-	/**
522
-	 * @param \Closure $callback
523
-	 * @since 11.0.0
524
-	 */
525
-	public function callForSeenUsers(\Closure $callback) {
526
-		$limit = 1000;
527
-		$offset = 0;
528
-		do {
529
-			$userIds = $this->getSeenUserIds($limit, $offset);
530
-			$offset += $limit;
531
-			foreach ($userIds as $userId) {
532
-				foreach ($this->backends as $backend) {
533
-					if ($backend->userExists($userId)) {
534
-						$user = $this->getUserObject($userId, $backend, false);
535
-						$return = $callback($user);
536
-						if ($return === false) {
537
-							return;
538
-						}
539
-						break;
540
-					}
541
-				}
542
-			}
543
-		} while (count($userIds) >= $limit);
544
-	}
545
-
546
-	/**
547
-	 * Getting all userIds that have a listLogin value requires checking the
548
-	 * value in php because on oracle you cannot use a clob in a where clause,
549
-	 * preventing us from doing a not null or length(value) > 0 check.
550
-	 *
551
-	 * @param int $limit
552
-	 * @param int $offset
553
-	 * @return string[] with user ids
554
-	 */
555
-	private function getSeenUserIds($limit = null, $offset = null) {
556
-		$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
557
-		$queryBuilder->select(['userid'])
558
-			->from('preferences')
559
-			->where($queryBuilder->expr()->eq(
560
-				'appid', $queryBuilder->createNamedParameter('login'))
561
-			)
562
-			->andWhere($queryBuilder->expr()->eq(
563
-				'configkey', $queryBuilder->createNamedParameter('lastLogin'))
564
-			)
565
-			->andWhere($queryBuilder->expr()->isNotNull('configvalue')
566
-			);
567
-
568
-		if ($limit !== null) {
569
-			$queryBuilder->setMaxResults($limit);
570
-		}
571
-		if ($offset !== null) {
572
-			$queryBuilder->setFirstResult($offset);
573
-		}
574
-		$query = $queryBuilder->execute();
575
-		$result = [];
576
-
577
-		while ($row = $query->fetch()) {
578
-			$result[] = $row['userid'];
579
-		}
580
-
581
-		$query->closeCursor();
582
-
583
-		return $result;
584
-	}
585
-
586
-	/**
587
-	 * @param string $email
588
-	 * @return IUser[]
589
-	 * @since 9.1.0
590
-	 */
591
-	public function getByEmail($email) {
592
-		$userIds = $this->config->getUsersForUserValue('settings', 'email', $email);
593
-
594
-		return array_map(function($uid) {
595
-			return $this->get($uid);
596
-		}, $userIds);
597
-	}
490
+        if ($count !== false) {
491
+            $count = (int)$count;
492
+        } else {
493
+            $count = 0;
494
+        }
495
+
496
+        return $count;
497
+    }
498
+
499
+    /**
500
+     * returns how many users have logged in once
501
+     *
502
+     * @return int
503
+     * @since 11.0.0
504
+     */
505
+    public function countSeenUsers() {
506
+        $queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
507
+        $queryBuilder->select($queryBuilder->createFunction('COUNT(*)'))
508
+            ->from('preferences')
509
+            ->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('login')))
510
+            ->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('lastLogin')))
511
+            ->andWhere($queryBuilder->expr()->isNotNull('configvalue'));
512
+
513
+        $query = $queryBuilder->execute();
514
+
515
+        $result = (int)$query->fetchColumn();
516
+        $query->closeCursor();
517
+
518
+        return $result;
519
+    }
520
+
521
+    /**
522
+     * @param \Closure $callback
523
+     * @since 11.0.0
524
+     */
525
+    public function callForSeenUsers(\Closure $callback) {
526
+        $limit = 1000;
527
+        $offset = 0;
528
+        do {
529
+            $userIds = $this->getSeenUserIds($limit, $offset);
530
+            $offset += $limit;
531
+            foreach ($userIds as $userId) {
532
+                foreach ($this->backends as $backend) {
533
+                    if ($backend->userExists($userId)) {
534
+                        $user = $this->getUserObject($userId, $backend, false);
535
+                        $return = $callback($user);
536
+                        if ($return === false) {
537
+                            return;
538
+                        }
539
+                        break;
540
+                    }
541
+                }
542
+            }
543
+        } while (count($userIds) >= $limit);
544
+    }
545
+
546
+    /**
547
+     * Getting all userIds that have a listLogin value requires checking the
548
+     * value in php because on oracle you cannot use a clob in a where clause,
549
+     * preventing us from doing a not null or length(value) > 0 check.
550
+     *
551
+     * @param int $limit
552
+     * @param int $offset
553
+     * @return string[] with user ids
554
+     */
555
+    private function getSeenUserIds($limit = null, $offset = null) {
556
+        $queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
557
+        $queryBuilder->select(['userid'])
558
+            ->from('preferences')
559
+            ->where($queryBuilder->expr()->eq(
560
+                'appid', $queryBuilder->createNamedParameter('login'))
561
+            )
562
+            ->andWhere($queryBuilder->expr()->eq(
563
+                'configkey', $queryBuilder->createNamedParameter('lastLogin'))
564
+            )
565
+            ->andWhere($queryBuilder->expr()->isNotNull('configvalue')
566
+            );
567
+
568
+        if ($limit !== null) {
569
+            $queryBuilder->setMaxResults($limit);
570
+        }
571
+        if ($offset !== null) {
572
+            $queryBuilder->setFirstResult($offset);
573
+        }
574
+        $query = $queryBuilder->execute();
575
+        $result = [];
576
+
577
+        while ($row = $query->fetch()) {
578
+            $result[] = $row['userid'];
579
+        }
580
+
581
+        $query->closeCursor();
582
+
583
+        return $result;
584
+    }
585
+
586
+    /**
587
+     * @param string $email
588
+     * @return IUser[]
589
+     * @since 9.1.0
590
+     */
591
+    public function getByEmail($email) {
592
+        $userIds = $this->config->getUsersForUserValue('settings', 'email', $email);
593
+
594
+        return array_map(function($uid) {
595
+            return $this->get($uid);
596
+        }, $userIds);
597
+    }
598 598
 }
Please login to merge, or discard this patch.