Completed
Push — master ( ae71a5...213d43 )
by Morris
25:08 queued 10:22
created
lib/private/User/Database.php 2 patches
Indentation   +401 added lines, -401 removed lines patch added patch discarded remove patch
@@ -76,405 +76,405 @@
 block discarded – undo
76 76
  * Class for user management in a SQL Database (e.g. MySQL, SQLite)
77 77
  */
78 78
 class Database extends ABackend
79
-	implements ICreateUserBackend,
80
-	           ISetPasswordBackend,
81
-	           ISetDisplayNameBackend,
82
-	           IGetDisplayNameBackend,
83
-	           ICheckPasswordBackend,
84
-	           IGetHomeBackend,
85
-	           ICountUsersBackend {
86
-	/** @var CappedMemoryCache */
87
-	private $cache;
88
-
89
-	/** @var EventDispatcher */
90
-	private $eventDispatcher;
91
-
92
-	/** @var IDBConnection */
93
-	private $dbConn;
94
-
95
-	/** @var string */
96
-	private $table;
97
-
98
-	/**
99
-	 * \OC\User\Database constructor.
100
-	 *
101
-	 * @param EventDispatcher $eventDispatcher
102
-	 * @param string $table
103
-	 */
104
-	public function __construct($eventDispatcher = null, $table = 'users') {
105
-		$this->cache = new CappedMemoryCache();
106
-		$this->table = $table;
107
-		$this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OC::$server->getEventDispatcher();
108
-	}
109
-
110
-	/**
111
-	 * FIXME: This function should not be required!
112
-	 */
113
-	private function fixDI() {
114
-		if ($this->dbConn === null) {
115
-			$this->dbConn = \OC::$server->getDatabaseConnection();
116
-		}
117
-	}
118
-
119
-	/**
120
-	 * Create a new user
121
-	 *
122
-	 * @param string $uid The username of the user to create
123
-	 * @param string $password The password of the new user
124
-	 * @return bool
125
-	 *
126
-	 * Creates a new user. Basic checking of username is done in OC_User
127
-	 * itself, not in its subclasses.
128
-	 */
129
-	public function createUser(string $uid, string $password): bool {
130
-		$this->fixDI();
131
-
132
-		if (!$this->userExists($uid)) {
133
-			$event = new GenericEvent($password);
134
-			$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
135
-
136
-			$qb = $this->dbConn->getQueryBuilder();
137
-			$qb->insert($this->table)
138
-				->values([
139
-					'uid' => $qb->createNamedParameter($uid),
140
-					'password' => $qb->createNamedParameter(\OC::$server->getHasher()->hash($password)),
141
-					'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
142
-				]);
143
-
144
-			$result = $qb->execute();
145
-
146
-			// Clear cache
147
-			unset($this->cache[$uid]);
148
-
149
-			return $result ? true : false;
150
-		}
151
-
152
-		return false;
153
-	}
154
-
155
-	/**
156
-	 * delete a user
157
-	 *
158
-	 * @param string $uid The username of the user to delete
159
-	 * @return bool
160
-	 *
161
-	 * Deletes a user
162
-	 */
163
-	public function deleteUser($uid) {
164
-		$this->fixDI();
165
-
166
-		// Delete user-group-relation
167
-		$query = $this->dbConn->getQueryBuilder();
168
-		$query->delete($this->table)
169
-			->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
170
-		$result = $query->execute();
171
-
172
-		if (isset($this->cache[$uid])) {
173
-			unset($this->cache[$uid]);
174
-		}
175
-
176
-		return $result ? true : false;
177
-	}
178
-
179
-	private function updatePassword(string $uid, string $passwordHash): bool {
180
-		$query = $this->dbConn->getQueryBuilder();
181
-		$query->update($this->table)
182
-			->set('password', $query->createNamedParameter($passwordHash))
183
-			->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
184
-		$result = $query->execute();
185
-
186
-		return $result ? true : false;
187
-	}
188
-
189
-	/**
190
-	 * Set password
191
-	 *
192
-	 * @param string $uid The username
193
-	 * @param string $password The new password
194
-	 * @return bool
195
-	 *
196
-	 * Change the password of a user
197
-	 */
198
-	public function setPassword(string $uid, string $password): bool {
199
-		$this->fixDI();
200
-
201
-		if ($this->userExists($uid)) {
202
-			$event = new GenericEvent($password);
203
-			$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
204
-
205
-			$hasher = \OC::$server->getHasher();
206
-			$hashedPassword = $hasher->hash($password);
207
-
208
-			return $this->updatePassword($uid, $hashedPassword);
209
-		}
210
-
211
-		return false;
212
-	}
213
-
214
-	/**
215
-	 * Set display name
216
-	 *
217
-	 * @param string $uid The username
218
-	 * @param string $displayName The new display name
219
-	 * @return bool
220
-	 *
221
-	 * Change the display name of a user
222
-	 */
223
-	public function setDisplayName(string $uid, string $displayName): bool {
224
-		$this->fixDI();
225
-
226
-		if ($this->userExists($uid)) {
227
-			$query = $this->dbConn->getQueryBuilder();
228
-			$query->update($this->table)
229
-				->set('displayname', $query->createNamedParameter($displayName))
230
-				->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
231
-			$query->execute();
232
-
233
-			$this->cache[$uid]['displayname'] = $displayName;
234
-
235
-			return true;
236
-		}
237
-
238
-		return false;
239
-	}
240
-
241
-	/**
242
-	 * get display name of the user
243
-	 *
244
-	 * @param string $uid user ID of the user
245
-	 * @return string display name
246
-	 */
247
-	public function getDisplayName($uid): string {
248
-		$uid = (string)$uid;
249
-		$this->loadUser($uid);
250
-		return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
251
-	}
252
-
253
-	/**
254
-	 * Get a list of all display names and user ids.
255
-	 *
256
-	 * @param string $search
257
-	 * @param string|null $limit
258
-	 * @param string|null $offset
259
-	 * @return array an array of all displayNames (value) and the corresponding uids (key)
260
-	 */
261
-	public function getDisplayNames($search = '', $limit = null, $offset = null) {
262
-		$this->fixDI();
263
-
264
-		$query = $this->dbConn->getQueryBuilder();
265
-
266
-		$query->select('uid', 'displayname')
267
-			->from($this->table, 'u')
268
-			->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
269
-				$query->expr()->eq('userid', 'uid'),
270
-				$query->expr()->eq('appid', $query->expr()->literal('settings')),
271
-				$query->expr()->eq('configkey', $query->expr()->literal('email')))
272
-			)
273
-			// sqlite doesn't like re-using a single named parameter here
274
-			->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
275
-			->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
276
-			->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
277
-			->orderBy($query->func()->lower('displayname'), 'ASC')
278
-			->orderBy('uid_lower', 'ASC')
279
-			->setMaxResults($limit)
280
-			->setFirstResult($offset);
281
-
282
-		$result = $query->execute();
283
-		$displayNames = [];
284
-		while ($row = $result->fetch()) {
285
-			$displayNames[(string)$row['uid']] = (string)$row['displayname'];
286
-		}
287
-
288
-		return $displayNames;
289
-	}
290
-
291
-	/**
292
-	 * Check if the password is correct
293
-	 *
294
-	 * @param string $uid The username
295
-	 * @param string $password The password
296
-	 * @return string
297
-	 *
298
-	 * Check if the password is correct without logging in the user
299
-	 * returns the user id or false
300
-	 */
301
-	public function checkPassword(string $uid, string $password) {
302
-		$this->fixDI();
303
-
304
-		$qb = $this->dbConn->getQueryBuilder();
305
-		$qb->select('uid', 'password')
306
-			->from($this->table)
307
-			->where(
308
-				$qb->expr()->eq(
309
-					'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
310
-				)
311
-			);
312
-		$result = $qb->execute();
313
-		$row = $result->fetch();
314
-		$result->closeCursor();
315
-
316
-		if ($row) {
317
-			$storedHash = $row['password'];
318
-			$newHash = '';
319
-			if (\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) {
320
-				if (!empty($newHash)) {
321
-					$this->updatePassword($uid, $newHash);
322
-				}
323
-				return (string)$row['uid'];
324
-			}
325
-
326
-		}
327
-
328
-		return false;
329
-	}
330
-
331
-	/**
332
-	 * Load an user in the cache
333
-	 *
334
-	 * @param string $uid the username
335
-	 * @return boolean true if user was found, false otherwise
336
-	 */
337
-	private function loadUser($uid) {
338
-		$this->fixDI();
339
-
340
-		$uid = (string)$uid;
341
-		if (!isset($this->cache[$uid])) {
342
-			//guests $uid could be NULL or ''
343
-			if ($uid === '') {
344
-				$this->cache[$uid] = false;
345
-				return true;
346
-			}
347
-
348
-			$qb = $this->dbConn->getQueryBuilder();
349
-			$qb->select('uid', 'displayname')
350
-				->from($this->table)
351
-				->where(
352
-					$qb->expr()->eq(
353
-						'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
354
-					)
355
-				);
356
-			$result = $qb->execute();
357
-			$row = $result->fetch();
358
-			$result->closeCursor();
359
-
360
-			$this->cache[$uid] = false;
361
-
362
-			// "uid" is primary key, so there can only be a single result
363
-			if ($row !== false) {
364
-				$this->cache[$uid]['uid'] = (string)$row['uid'];
365
-				$this->cache[$uid]['displayname'] = (string)$row['displayname'];
366
-			} else {
367
-				return false;
368
-			}
369
-		}
370
-
371
-		return true;
372
-	}
373
-
374
-	/**
375
-	 * Get a list of all users
376
-	 *
377
-	 * @param string $search
378
-	 * @param null|int $limit
379
-	 * @param null|int $offset
380
-	 * @return string[] an array of all uids
381
-	 */
382
-	public function getUsers($search = '', $limit = null, $offset = null) {
383
-		$users = $this->getDisplayNames($search, $limit, $offset);
384
-		$userIds = array_map(function ($uid) {
385
-			return (string)$uid;
386
-		}, array_keys($users));
387
-		sort($userIds, SORT_STRING | SORT_FLAG_CASE);
388
-		return $userIds;
389
-	}
390
-
391
-	/**
392
-	 * check if a user exists
393
-	 *
394
-	 * @param string $uid the username
395
-	 * @return boolean
396
-	 */
397
-	public function userExists($uid) {
398
-		$this->loadUser($uid);
399
-		return $this->cache[$uid] !== false;
400
-	}
401
-
402
-	/**
403
-	 * get the user's home directory
404
-	 *
405
-	 * @param string $uid the username
406
-	 * @return string|false
407
-	 */
408
-	public function getHome(string $uid) {
409
-		if ($this->userExists($uid)) {
410
-			return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
411
-		}
412
-
413
-		return false;
414
-	}
415
-
416
-	/**
417
-	 * @return bool
418
-	 */
419
-	public function hasUserListings() {
420
-		return true;
421
-	}
422
-
423
-	/**
424
-	 * counts the users in the database
425
-	 *
426
-	 * @return int|bool
427
-	 */
428
-	public function countUsers() {
429
-		$this->fixDI();
430
-
431
-		$query = $this->dbConn->getQueryBuilder();
432
-		$query->select($query->func()->count('uid'))
433
-			->from($this->table);
434
-		$result = $query->execute();
435
-
436
-		return $result->fetchColumn();
437
-	}
438
-
439
-	/**
440
-	 * returns the username for the given login name in the correct casing
441
-	 *
442
-	 * @param string $loginName
443
-	 * @return string|false
444
-	 */
445
-	public function loginName2UserName($loginName) {
446
-		if ($this->userExists($loginName)) {
447
-			return $this->cache[$loginName]['uid'];
448
-		}
449
-
450
-		return false;
451
-	}
452
-
453
-	/**
454
-	 * Backend name to be shown in user management
455
-	 *
456
-	 * @return string the name of the backend to be shown
457
-	 */
458
-	public function getBackendName() {
459
-		return 'Database';
460
-	}
461
-
462
-	public static function preLoginNameUsedAsUserName($param) {
463
-		if (!isset($param['uid'])) {
464
-			throw new \Exception('key uid is expected to be set in $param');
465
-		}
466
-
467
-		$backends = \OC::$server->getUserManager()->getBackends();
468
-		foreach ($backends as $backend) {
469
-			if ($backend instanceof Database) {
470
-				/** @var \OC\User\Database $backend */
471
-				$uid = $backend->loginName2UserName($param['uid']);
472
-				if ($uid !== false) {
473
-					$param['uid'] = $uid;
474
-					return;
475
-				}
476
-			}
477
-		}
478
-
479
-	}
79
+    implements ICreateUserBackend,
80
+                ISetPasswordBackend,
81
+                ISetDisplayNameBackend,
82
+                IGetDisplayNameBackend,
83
+                ICheckPasswordBackend,
84
+                IGetHomeBackend,
85
+                ICountUsersBackend {
86
+    /** @var CappedMemoryCache */
87
+    private $cache;
88
+
89
+    /** @var EventDispatcher */
90
+    private $eventDispatcher;
91
+
92
+    /** @var IDBConnection */
93
+    private $dbConn;
94
+
95
+    /** @var string */
96
+    private $table;
97
+
98
+    /**
99
+     * \OC\User\Database constructor.
100
+     *
101
+     * @param EventDispatcher $eventDispatcher
102
+     * @param string $table
103
+     */
104
+    public function __construct($eventDispatcher = null, $table = 'users') {
105
+        $this->cache = new CappedMemoryCache();
106
+        $this->table = $table;
107
+        $this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OC::$server->getEventDispatcher();
108
+    }
109
+
110
+    /**
111
+     * FIXME: This function should not be required!
112
+     */
113
+    private function fixDI() {
114
+        if ($this->dbConn === null) {
115
+            $this->dbConn = \OC::$server->getDatabaseConnection();
116
+        }
117
+    }
118
+
119
+    /**
120
+     * Create a new user
121
+     *
122
+     * @param string $uid The username of the user to create
123
+     * @param string $password The password of the new user
124
+     * @return bool
125
+     *
126
+     * Creates a new user. Basic checking of username is done in OC_User
127
+     * itself, not in its subclasses.
128
+     */
129
+    public function createUser(string $uid, string $password): bool {
130
+        $this->fixDI();
131
+
132
+        if (!$this->userExists($uid)) {
133
+            $event = new GenericEvent($password);
134
+            $this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
135
+
136
+            $qb = $this->dbConn->getQueryBuilder();
137
+            $qb->insert($this->table)
138
+                ->values([
139
+                    'uid' => $qb->createNamedParameter($uid),
140
+                    'password' => $qb->createNamedParameter(\OC::$server->getHasher()->hash($password)),
141
+                    'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
142
+                ]);
143
+
144
+            $result = $qb->execute();
145
+
146
+            // Clear cache
147
+            unset($this->cache[$uid]);
148
+
149
+            return $result ? true : false;
150
+        }
151
+
152
+        return false;
153
+    }
154
+
155
+    /**
156
+     * delete a user
157
+     *
158
+     * @param string $uid The username of the user to delete
159
+     * @return bool
160
+     *
161
+     * Deletes a user
162
+     */
163
+    public function deleteUser($uid) {
164
+        $this->fixDI();
165
+
166
+        // Delete user-group-relation
167
+        $query = $this->dbConn->getQueryBuilder();
168
+        $query->delete($this->table)
169
+            ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
170
+        $result = $query->execute();
171
+
172
+        if (isset($this->cache[$uid])) {
173
+            unset($this->cache[$uid]);
174
+        }
175
+
176
+        return $result ? true : false;
177
+    }
178
+
179
+    private function updatePassword(string $uid, string $passwordHash): bool {
180
+        $query = $this->dbConn->getQueryBuilder();
181
+        $query->update($this->table)
182
+            ->set('password', $query->createNamedParameter($passwordHash))
183
+            ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
184
+        $result = $query->execute();
185
+
186
+        return $result ? true : false;
187
+    }
188
+
189
+    /**
190
+     * Set password
191
+     *
192
+     * @param string $uid The username
193
+     * @param string $password The new password
194
+     * @return bool
195
+     *
196
+     * Change the password of a user
197
+     */
198
+    public function setPassword(string $uid, string $password): bool {
199
+        $this->fixDI();
200
+
201
+        if ($this->userExists($uid)) {
202
+            $event = new GenericEvent($password);
203
+            $this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
204
+
205
+            $hasher = \OC::$server->getHasher();
206
+            $hashedPassword = $hasher->hash($password);
207
+
208
+            return $this->updatePassword($uid, $hashedPassword);
209
+        }
210
+
211
+        return false;
212
+    }
213
+
214
+    /**
215
+     * Set display name
216
+     *
217
+     * @param string $uid The username
218
+     * @param string $displayName The new display name
219
+     * @return bool
220
+     *
221
+     * Change the display name of a user
222
+     */
223
+    public function setDisplayName(string $uid, string $displayName): bool {
224
+        $this->fixDI();
225
+
226
+        if ($this->userExists($uid)) {
227
+            $query = $this->dbConn->getQueryBuilder();
228
+            $query->update($this->table)
229
+                ->set('displayname', $query->createNamedParameter($displayName))
230
+                ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
231
+            $query->execute();
232
+
233
+            $this->cache[$uid]['displayname'] = $displayName;
234
+
235
+            return true;
236
+        }
237
+
238
+        return false;
239
+    }
240
+
241
+    /**
242
+     * get display name of the user
243
+     *
244
+     * @param string $uid user ID of the user
245
+     * @return string display name
246
+     */
247
+    public function getDisplayName($uid): string {
248
+        $uid = (string)$uid;
249
+        $this->loadUser($uid);
250
+        return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
251
+    }
252
+
253
+    /**
254
+     * Get a list of all display names and user ids.
255
+     *
256
+     * @param string $search
257
+     * @param string|null $limit
258
+     * @param string|null $offset
259
+     * @return array an array of all displayNames (value) and the corresponding uids (key)
260
+     */
261
+    public function getDisplayNames($search = '', $limit = null, $offset = null) {
262
+        $this->fixDI();
263
+
264
+        $query = $this->dbConn->getQueryBuilder();
265
+
266
+        $query->select('uid', 'displayname')
267
+            ->from($this->table, 'u')
268
+            ->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
269
+                $query->expr()->eq('userid', 'uid'),
270
+                $query->expr()->eq('appid', $query->expr()->literal('settings')),
271
+                $query->expr()->eq('configkey', $query->expr()->literal('email')))
272
+            )
273
+            // sqlite doesn't like re-using a single named parameter here
274
+            ->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
275
+            ->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
276
+            ->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
277
+            ->orderBy($query->func()->lower('displayname'), 'ASC')
278
+            ->orderBy('uid_lower', 'ASC')
279
+            ->setMaxResults($limit)
280
+            ->setFirstResult($offset);
281
+
282
+        $result = $query->execute();
283
+        $displayNames = [];
284
+        while ($row = $result->fetch()) {
285
+            $displayNames[(string)$row['uid']] = (string)$row['displayname'];
286
+        }
287
+
288
+        return $displayNames;
289
+    }
290
+
291
+    /**
292
+     * Check if the password is correct
293
+     *
294
+     * @param string $uid The username
295
+     * @param string $password The password
296
+     * @return string
297
+     *
298
+     * Check if the password is correct without logging in the user
299
+     * returns the user id or false
300
+     */
301
+    public function checkPassword(string $uid, string $password) {
302
+        $this->fixDI();
303
+
304
+        $qb = $this->dbConn->getQueryBuilder();
305
+        $qb->select('uid', 'password')
306
+            ->from($this->table)
307
+            ->where(
308
+                $qb->expr()->eq(
309
+                    'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
310
+                )
311
+            );
312
+        $result = $qb->execute();
313
+        $row = $result->fetch();
314
+        $result->closeCursor();
315
+
316
+        if ($row) {
317
+            $storedHash = $row['password'];
318
+            $newHash = '';
319
+            if (\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) {
320
+                if (!empty($newHash)) {
321
+                    $this->updatePassword($uid, $newHash);
322
+                }
323
+                return (string)$row['uid'];
324
+            }
325
+
326
+        }
327
+
328
+        return false;
329
+    }
330
+
331
+    /**
332
+     * Load an user in the cache
333
+     *
334
+     * @param string $uid the username
335
+     * @return boolean true if user was found, false otherwise
336
+     */
337
+    private function loadUser($uid) {
338
+        $this->fixDI();
339
+
340
+        $uid = (string)$uid;
341
+        if (!isset($this->cache[$uid])) {
342
+            //guests $uid could be NULL or ''
343
+            if ($uid === '') {
344
+                $this->cache[$uid] = false;
345
+                return true;
346
+            }
347
+
348
+            $qb = $this->dbConn->getQueryBuilder();
349
+            $qb->select('uid', 'displayname')
350
+                ->from($this->table)
351
+                ->where(
352
+                    $qb->expr()->eq(
353
+                        'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
354
+                    )
355
+                );
356
+            $result = $qb->execute();
357
+            $row = $result->fetch();
358
+            $result->closeCursor();
359
+
360
+            $this->cache[$uid] = false;
361
+
362
+            // "uid" is primary key, so there can only be a single result
363
+            if ($row !== false) {
364
+                $this->cache[$uid]['uid'] = (string)$row['uid'];
365
+                $this->cache[$uid]['displayname'] = (string)$row['displayname'];
366
+            } else {
367
+                return false;
368
+            }
369
+        }
370
+
371
+        return true;
372
+    }
373
+
374
+    /**
375
+     * Get a list of all users
376
+     *
377
+     * @param string $search
378
+     * @param null|int $limit
379
+     * @param null|int $offset
380
+     * @return string[] an array of all uids
381
+     */
382
+    public function getUsers($search = '', $limit = null, $offset = null) {
383
+        $users = $this->getDisplayNames($search, $limit, $offset);
384
+        $userIds = array_map(function ($uid) {
385
+            return (string)$uid;
386
+        }, array_keys($users));
387
+        sort($userIds, SORT_STRING | SORT_FLAG_CASE);
388
+        return $userIds;
389
+    }
390
+
391
+    /**
392
+     * check if a user exists
393
+     *
394
+     * @param string $uid the username
395
+     * @return boolean
396
+     */
397
+    public function userExists($uid) {
398
+        $this->loadUser($uid);
399
+        return $this->cache[$uid] !== false;
400
+    }
401
+
402
+    /**
403
+     * get the user's home directory
404
+     *
405
+     * @param string $uid the username
406
+     * @return string|false
407
+     */
408
+    public function getHome(string $uid) {
409
+        if ($this->userExists($uid)) {
410
+            return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
411
+        }
412
+
413
+        return false;
414
+    }
415
+
416
+    /**
417
+     * @return bool
418
+     */
419
+    public function hasUserListings() {
420
+        return true;
421
+    }
422
+
423
+    /**
424
+     * counts the users in the database
425
+     *
426
+     * @return int|bool
427
+     */
428
+    public function countUsers() {
429
+        $this->fixDI();
430
+
431
+        $query = $this->dbConn->getQueryBuilder();
432
+        $query->select($query->func()->count('uid'))
433
+            ->from($this->table);
434
+        $result = $query->execute();
435
+
436
+        return $result->fetchColumn();
437
+    }
438
+
439
+    /**
440
+     * returns the username for the given login name in the correct casing
441
+     *
442
+     * @param string $loginName
443
+     * @return string|false
444
+     */
445
+    public function loginName2UserName($loginName) {
446
+        if ($this->userExists($loginName)) {
447
+            return $this->cache[$loginName]['uid'];
448
+        }
449
+
450
+        return false;
451
+    }
452
+
453
+    /**
454
+     * Backend name to be shown in user management
455
+     *
456
+     * @return string the name of the backend to be shown
457
+     */
458
+    public function getBackendName() {
459
+        return 'Database';
460
+    }
461
+
462
+    public static function preLoginNameUsedAsUserName($param) {
463
+        if (!isset($param['uid'])) {
464
+            throw new \Exception('key uid is expected to be set in $param');
465
+        }
466
+
467
+        $backends = \OC::$server->getUserManager()->getBackends();
468
+        foreach ($backends as $backend) {
469
+            if ($backend instanceof Database) {
470
+                /** @var \OC\User\Database $backend */
471
+                $uid = $backend->loginName2UserName($param['uid']);
472
+                if ($uid !== false) {
473
+                    $param['uid'] = $uid;
474
+                    return;
475
+                }
476
+            }
477
+        }
478
+
479
+    }
480 480
 }
Please login to merge, or discard this patch.
Spacing   +12 added lines, -12 removed lines patch added patch discarded remove patch
@@ -245,7 +245,7 @@  discard block
 block discarded – undo
245 245
 	 * @return string display name
246 246
 	 */
247 247
 	public function getDisplayName($uid): string {
248
-		$uid = (string)$uid;
248
+		$uid = (string) $uid;
249 249
 		$this->loadUser($uid);
250 250
 		return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
251 251
 	}
@@ -271,9 +271,9 @@  discard block
 block discarded – undo
271 271
 				$query->expr()->eq('configkey', $query->expr()->literal('email')))
272 272
 			)
273 273
 			// sqlite doesn't like re-using a single named parameter here
274
-			->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
275
-			->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
276
-			->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
274
+			->where($query->expr()->iLike('uid', $query->createPositionalParameter('%'.$this->dbConn->escapeLikeParameter($search).'%')))
275
+			->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%'.$this->dbConn->escapeLikeParameter($search).'%')))
276
+			->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%'.$this->dbConn->escapeLikeParameter($search).'%')))
277 277
 			->orderBy($query->func()->lower('displayname'), 'ASC')
278 278
 			->orderBy('uid_lower', 'ASC')
279 279
 			->setMaxResults($limit)
@@ -282,7 +282,7 @@  discard block
 block discarded – undo
282 282
 		$result = $query->execute();
283 283
 		$displayNames = [];
284 284
 		while ($row = $result->fetch()) {
285
-			$displayNames[(string)$row['uid']] = (string)$row['displayname'];
285
+			$displayNames[(string) $row['uid']] = (string) $row['displayname'];
286 286
 		}
287 287
 
288 288
 		return $displayNames;
@@ -320,7 +320,7 @@  discard block
 block discarded – undo
320 320
 				if (!empty($newHash)) {
321 321
 					$this->updatePassword($uid, $newHash);
322 322
 				}
323
-				return (string)$row['uid'];
323
+				return (string) $row['uid'];
324 324
 			}
325 325
 
326 326
 		}
@@ -337,7 +337,7 @@  discard block
 block discarded – undo
337 337
 	private function loadUser($uid) {
338 338
 		$this->fixDI();
339 339
 
340
-		$uid = (string)$uid;
340
+		$uid = (string) $uid;
341 341
 		if (!isset($this->cache[$uid])) {
342 342
 			//guests $uid could be NULL or ''
343 343
 			if ($uid === '') {
@@ -361,8 +361,8 @@  discard block
 block discarded – undo
361 361
 
362 362
 			// "uid" is primary key, so there can only be a single result
363 363
 			if ($row !== false) {
364
-				$this->cache[$uid]['uid'] = (string)$row['uid'];
365
-				$this->cache[$uid]['displayname'] = (string)$row['displayname'];
364
+				$this->cache[$uid]['uid'] = (string) $row['uid'];
365
+				$this->cache[$uid]['displayname'] = (string) $row['displayname'];
366 366
 			} else {
367 367
 				return false;
368 368
 			}
@@ -381,8 +381,8 @@  discard block
 block discarded – undo
381 381
 	 */
382 382
 	public function getUsers($search = '', $limit = null, $offset = null) {
383 383
 		$users = $this->getDisplayNames($search, $limit, $offset);
384
-		$userIds = array_map(function ($uid) {
385
-			return (string)$uid;
384
+		$userIds = array_map(function($uid) {
385
+			return (string) $uid;
386 386
 		}, array_keys($users));
387 387
 		sort($userIds, SORT_STRING | SORT_FLAG_CASE);
388 388
 		return $userIds;
@@ -407,7 +407,7 @@  discard block
 block discarded – undo
407 407
 	 */
408 408
 	public function getHome(string $uid) {
409 409
 		if ($this->userExists($uid)) {
410
-			return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
410
+			return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').'/'.$uid;
411 411
 		}
412 412
 
413 413
 		return false;
Please login to merge, or discard this patch.