nextcloud / server

lib/private/User/Database.php

Indentation +409 added lines, -409 removed lines

@@ -75,415 +75,415 @@
  * Class for user management in a SQL Database (e.g. MySQL, SQLite)
  */
 class Database extends ABackend
-	implements ICreateUserBackend,
-	           ISetPasswordBackend,
-	           ISetDisplayNameBackend,
-	           IGetDisplayNameBackend,
-	           ICheckPasswordBackend,
-	           IGetHomeBackend,
-	           ICountUsersBackend,
-	           IGetRealUIDBackend {
-	/** @var CappedMemoryCache */
-	private $cache;
-
-	/** @var EventDispatcherInterface */
-	private $eventDispatcher;
-
-	/** @var IDBConnection */
-	private $dbConn;
-
-	/** @var string */
-	private $table;
-
-	/**
-	 * \OC\User\Database constructor.
-	 *
-	 * @param EventDispatcherInterface $eventDispatcher
-	 * @param string $table
-	 */
-	public function __construct($eventDispatcher = null, $table = 'users') {
-		$this->cache = new CappedMemoryCache();
-		$this->table = $table;
-		$this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OC::$server->getEventDispatcher();
-	}
-
-	/**
-	 * FIXME: This function should not be required!
-	 */
-	private function fixDI() {
-		if ($this->dbConn === null) {
-			$this->dbConn = \OC::$server->getDatabaseConnection();
-		}
-	}
-
-	/**
-	 * Create a new user
-	 *
-	 * @param string $uid The username of the user to create
-	 * @param string $password The password of the new user
-	 * @return bool
-	 *
-	 * Creates a new user. Basic checking of username is done in OC_User
-	 * itself, not in its subclasses.
-	 */
-	public function createUser(string $uid, string $password): bool {
-		$this->fixDI();
-
-		if (!$this->userExists($uid)) {
-			$event = new GenericEvent($password);
-			$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
-
-			$qb = $this->dbConn->getQueryBuilder();
-			$qb->insert($this->table)
-				->values([
-					'uid' => $qb->createNamedParameter($uid),
-					'password' => $qb->createNamedParameter(\OC::$server->getHasher()->hash($password)),
-					'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
-				]);
-
-			$result = $qb->execute();
-
-			// Clear cache
-			unset($this->cache[$uid]);
-
-			return $result ? true : false;
-		}
-
-		return false;
-	}
-
-	/**
-	 * delete a user
-	 *
-	 * @param string $uid The username of the user to delete
-	 * @return bool
-	 *
-	 * Deletes a user
-	 */
-	public function deleteUser($uid) {
-		$this->fixDI();
-
-		// Delete user-group-relation
-		$query = $this->dbConn->getQueryBuilder();
-		$query->delete($this->table)
-			->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
-		$result = $query->execute();
-
-		if (isset($this->cache[$uid])) {
-			unset($this->cache[$uid]);
-		}
-
-		return $result ? true : false;
-	}
-
-	private function updatePassword(string $uid, string $passwordHash): bool {
-		$query = $this->dbConn->getQueryBuilder();
-		$query->update($this->table)
-			->set('password', $query->createNamedParameter($passwordHash))
-			->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
-		$result = $query->execute();
-
-		return $result ? true : false;
-	}
-
-	/**
-	 * Set password
-	 *
-	 * @param string $uid The username
-	 * @param string $password The new password
-	 * @return bool
-	 *
-	 * Change the password of a user
-	 */
-	public function setPassword(string $uid, string $password): bool {
-		$this->fixDI();
-
-		if ($this->userExists($uid)) {
-			$event = new GenericEvent($password);
-			$this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
-
-			$hasher = \OC::$server->getHasher();
-			$hashedPassword = $hasher->hash($password);
-
-			return $this->updatePassword($uid, $hashedPassword);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Set display name
-	 *
-	 * @param string $uid The username
-	 * @param string $displayName The new display name
-	 * @return bool
-	 *
-	 * Change the display name of a user
-	 */
-	public function setDisplayName(string $uid, string $displayName): bool {
-		$this->fixDI();
-
-		if ($this->userExists($uid)) {
-			$query = $this->dbConn->getQueryBuilder();
-			$query->update($this->table)
-				->set('displayname', $query->createNamedParameter($displayName))
-				->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
-			$query->execute();
-
-			$this->cache[$uid]['displayname'] = $displayName;
-
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * get display name of the user
-	 *
-	 * @param string $uid user ID of the user
-	 * @return string display name
-	 */
-	public function getDisplayName($uid): string {
-		$uid = (string)$uid;
-		$this->loadUser($uid);
-		return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
-	}
-
-	/**
-	 * Get a list of all display names and user ids.
-	 *
-	 * @param string $search
-	 * @param string|null $limit
-	 * @param string|null $offset
-	 * @return array an array of all displayNames (value) and the corresponding uids (key)
-	 */
-	public function getDisplayNames($search = '', $limit = null, $offset = null) {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-
-		$query->select('uid', 'displayname')
-			->from($this->table, 'u')
-			->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
-				$query->expr()->eq('userid', 'uid'),
-				$query->expr()->eq('appid', $query->expr()->literal('settings')),
-				$query->expr()->eq('configkey', $query->expr()->literal('email')))
-			)
-			// sqlite doesn't like re-using a single named parameter here
-			->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
-			->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
-			->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
-			->orderBy($query->func()->lower('displayname'), 'ASC')
-			->orderBy('uid_lower', 'ASC')
-			->setMaxResults($limit)
-			->setFirstResult($offset);
-
-		$result = $query->execute();
-		$displayNames = [];
-		while ($row = $result->fetch()) {
-			$displayNames[(string)$row['uid']] = (string)$row['displayname'];
-		}
-
-		return $displayNames;
-	}
-
-	/**
-	 * Check if the password is correct
-	 *
-	 * @param string $uid The username
-	 * @param string $password The password
-	 * @return string
-	 *
-	 * Check if the password is correct without logging in the user
-	 * returns the user id or false
-	 */
-	public function checkPassword(string $uid, string $password) {
-		$this->fixDI();
-
-		$qb = $this->dbConn->getQueryBuilder();
-		$qb->select('uid', 'password')
-			->from($this->table)
-			->where(
-				$qb->expr()->eq(
-					'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
-				)
-			);
-		$result = $qb->execute();
-		$row = $result->fetch();
-		$result->closeCursor();
-
-		if ($row) {
-			$storedHash = $row['password'];
-			$newHash = '';
-			if (\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) {
-				if (!empty($newHash)) {
-					$this->updatePassword($uid, $newHash);
-				}
-				return (string)$row['uid'];
-			}
-
-		}
-
-		return false;
-	}
-
-	/**
-	 * Load an user in the cache
-	 *
-	 * @param string $uid the username
-	 * @return boolean true if user was found, false otherwise
-	 */
-	private function loadUser($uid) {
-		$this->fixDI();
-
-		$uid = (string)$uid;
-		if (!isset($this->cache[$uid])) {
-			//guests $uid could be NULL or ''
-			if ($uid === '') {
-				$this->cache[$uid] = false;
-				return true;
-			}
-
-			$qb = $this->dbConn->getQueryBuilder();
-			$qb->select('uid', 'displayname')
-				->from($this->table)
-				->where(
-					$qb->expr()->eq(
-						'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
-					)
-				);
-			$result = $qb->execute();
-			$row = $result->fetch();
-			$result->closeCursor();
-
-			$this->cache[$uid] = false;
-
-			// "uid" is primary key, so there can only be a single result
-			if ($row !== false) {
-				$this->cache[$uid]['uid'] = (string)$row['uid'];
-				$this->cache[$uid]['displayname'] = (string)$row['displayname'];
-			} else {
-				return false;
-			}
-		}
-
-		return true;
-	}
-
-	/**
-	 * Get a list of all users
-	 *
-	 * @param string $search
-	 * @param null|int $limit
-	 * @param null|int $offset
-	 * @return string[] an array of all uids
-	 */
-	public function getUsers($search = '', $limit = null, $offset = null) {
-		$users = $this->getDisplayNames($search, $limit, $offset);
-		$userIds = array_map(function ($uid) {
-			return (string)$uid;
-		}, array_keys($users));
-		sort($userIds, SORT_STRING | SORT_FLAG_CASE);
-		return $userIds;
-	}
-
-	/**
-	 * check if a user exists
-	 *
-	 * @param string $uid the username
-	 * @return boolean
-	 */
-	public function userExists($uid) {
-		$this->loadUser($uid);
-		return $this->cache[$uid] !== false;
-	}
-
-	/**
-	 * get the user's home directory
-	 *
-	 * @param string $uid the username
-	 * @return string|false
-	 */
-	public function getHome(string $uid) {
-		if ($this->userExists($uid)) {
-			return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
-		}
-
-		return false;
-	}
-
-	/**
-	 * @return bool
-	 */
-	public function hasUserListings() {
-		return true;
-	}
-
-	/**
-	 * counts the users in the database
-	 *
-	 * @return int|bool
-	 */
-	public function countUsers() {
-		$this->fixDI();
-
-		$query = $this->dbConn->getQueryBuilder();
-		$query->select($query->func()->count('uid'))
-			->from($this->table);
-		$result = $query->execute();
-
-		return $result->fetchColumn();
-	}
-
-	/**
-	 * returns the username for the given login name in the correct casing
-	 *
-	 * @param string $loginName
-	 * @return string|false
-	 */
-	public function loginName2UserName($loginName) {
-		if ($this->userExists($loginName)) {
-			return $this->cache[$loginName]['uid'];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Backend name to be shown in user management
-	 *
-	 * @return string the name of the backend to be shown
-	 */
-	public function getBackendName() {
-		return 'Database';
-	}
-
-	public static function preLoginNameUsedAsUserName($param) {
-		if (!isset($param['uid'])) {
-			throw new \Exception('key uid is expected to be set in $param');
-		}
-
-		$backends = \OC::$server->getUserManager()->getBackends();
-		foreach ($backends as $backend) {
-			if ($backend instanceof Database) {
-				/** @var \OC\User\Database $backend */
-				$uid = $backend->loginName2UserName($param['uid']);
-				if ($uid !== false) {
-					$param['uid'] = $uid;
-					return;
-				}
-			}
-		}
-	}
-
-	public function getRealUID(string $uid): string {
-		if (!$this->userExists($uid)) {
-			throw new \RuntimeException($uid . ' does not exist');
-		}
-
-		return $this->cache[$uid]['uid'];
-	}
+    implements ICreateUserBackend,
+                ISetPasswordBackend,
+                ISetDisplayNameBackend,
+                IGetDisplayNameBackend,
+                ICheckPasswordBackend,
+                IGetHomeBackend,
+                ICountUsersBackend,
+                IGetRealUIDBackend {
+    /** @var CappedMemoryCache */
+    private $cache;
+
+    /** @var EventDispatcherInterface */
+    private $eventDispatcher;
+
+    /** @var IDBConnection */
+    private $dbConn;
+
+    /** @var string */
+    private $table;
+
+    /**
+     * \OC\User\Database constructor.
+     *
+     * @param EventDispatcherInterface $eventDispatcher
+     * @param string $table
+     */
+    public function __construct($eventDispatcher = null, $table = 'users') {
+        $this->cache = new CappedMemoryCache();
+        $this->table = $table;
+        $this->eventDispatcher = $eventDispatcher ? $eventDispatcher : \OC::$server->getEventDispatcher();
+    }
+
+    /**
+     * FIXME: This function should not be required!
+     */
+    private function fixDI() {
+        if ($this->dbConn === null) {
+            $this->dbConn = \OC::$server->getDatabaseConnection();
+        }
+    }
+
+    /**
+     * Create a new user
+     *
+     * @param string $uid The username of the user to create
+     * @param string $password The password of the new user
+     * @return bool
+     *
+     * Creates a new user. Basic checking of username is done in OC_User
+     * itself, not in its subclasses.
+     */
+    public function createUser(string $uid, string $password): bool {
+        $this->fixDI();
+
+        if (!$this->userExists($uid)) {
+            $event = new GenericEvent($password);
+            $this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
+
+            $qb = $this->dbConn->getQueryBuilder();
+            $qb->insert($this->table)
+                ->values([
+                    'uid' => $qb->createNamedParameter($uid),
+                    'password' => $qb->createNamedParameter(\OC::$server->getHasher()->hash($password)),
+                    'uid_lower' => $qb->createNamedParameter(mb_strtolower($uid)),
+                ]);
+
+            $result = $qb->execute();
+
+            // Clear cache
+            unset($this->cache[$uid]);
+
+            return $result ? true : false;
+        }
+
+        return false;
+    }
+
+    /**
+     * delete a user
+     *
+     * @param string $uid The username of the user to delete
+     * @return bool
+     *
+     * Deletes a user
+     */
+    public function deleteUser($uid) {
+        $this->fixDI();
+
+        // Delete user-group-relation
+        $query = $this->dbConn->getQueryBuilder();
+        $query->delete($this->table)
+            ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
+        $result = $query->execute();
+
+        if (isset($this->cache[$uid])) {
+            unset($this->cache[$uid]);
+        }
+
+        return $result ? true : false;
+    }
+
+    private function updatePassword(string $uid, string $passwordHash): bool {
+        $query = $this->dbConn->getQueryBuilder();
+        $query->update($this->table)
+            ->set('password', $query->createNamedParameter($passwordHash))
+            ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
+        $result = $query->execute();
+
+        return $result ? true : false;
+    }
+
+    /**
+     * Set password
+     *
+     * @param string $uid The username
+     * @param string $password The new password
+     * @return bool
+     *
+     * Change the password of a user
+     */
+    public function setPassword(string $uid, string $password): bool {
+        $this->fixDI();
+
+        if ($this->userExists($uid)) {
+            $event = new GenericEvent($password);
+            $this->eventDispatcher->dispatch('OCP\PasswordPolicy::validate', $event);
+
+            $hasher = \OC::$server->getHasher();
+            $hashedPassword = $hasher->hash($password);
+
+            return $this->updatePassword($uid, $hashedPassword);
+        }
+
+        return false;
+    }
+
+    /**
+     * Set display name
+     *
+     * @param string $uid The username
+     * @param string $displayName The new display name
+     * @return bool
+     *
+     * Change the display name of a user
+     */
+    public function setDisplayName(string $uid, string $displayName): bool {
+        $this->fixDI();
+
+        if ($this->userExists($uid)) {
+            $query = $this->dbConn->getQueryBuilder();
+            $query->update($this->table)
+                ->set('displayname', $query->createNamedParameter($displayName))
+                ->where($query->expr()->eq('uid_lower', $query->createNamedParameter(mb_strtolower($uid))));
+            $query->execute();
+
+            $this->cache[$uid]['displayname'] = $displayName;
+
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * get display name of the user
+     *
+     * @param string $uid user ID of the user
+     * @return string display name
+     */
+    public function getDisplayName($uid): string {
+        $uid = (string)$uid;
+        $this->loadUser($uid);
+        return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
+    }
+
+    /**
+     * Get a list of all display names and user ids.
+     *
+     * @param string $search
+     * @param string|null $limit
+     * @param string|null $offset
+     * @return array an array of all displayNames (value) and the corresponding uids (key)
+     */
+    public function getDisplayNames($search = '', $limit = null, $offset = null) {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+
+        $query->select('uid', 'displayname')
+            ->from($this->table, 'u')
+            ->leftJoin('u', 'preferences', 'p', $query->expr()->andX(
+                $query->expr()->eq('userid', 'uid'),
+                $query->expr()->eq('appid', $query->expr()->literal('settings')),
+                $query->expr()->eq('configkey', $query->expr()->literal('email')))
+            )
+            // sqlite doesn't like re-using a single named parameter here
+            ->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
+            ->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
+            ->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
+            ->orderBy($query->func()->lower('displayname'), 'ASC')
+            ->orderBy('uid_lower', 'ASC')
+            ->setMaxResults($limit)
+            ->setFirstResult($offset);
+
+        $result = $query->execute();
+        $displayNames = [];
+        while ($row = $result->fetch()) {
+            $displayNames[(string)$row['uid']] = (string)$row['displayname'];
+        }
+
+        return $displayNames;
+    }
+
+    /**
+     * Check if the password is correct
+     *
+     * @param string $uid The username
+     * @param string $password The password
+     * @return string
+     *
+     * Check if the password is correct without logging in the user
+     * returns the user id or false
+     */
+    public function checkPassword(string $uid, string $password) {
+        $this->fixDI();
+
+        $qb = $this->dbConn->getQueryBuilder();
+        $qb->select('uid', 'password')
+            ->from($this->table)
+            ->where(
+                $qb->expr()->eq(
+                    'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
+                )
+            );
+        $result = $qb->execute();
+        $row = $result->fetch();
+        $result->closeCursor();
+
+        if ($row) {
+            $storedHash = $row['password'];
+            $newHash = '';
+            if (\OC::$server->getHasher()->verify($password, $storedHash, $newHash)) {
+                if (!empty($newHash)) {
+                    $this->updatePassword($uid, $newHash);
+                }
+                return (string)$row['uid'];
+            }
+
+        }
+
+        return false;
+    }
+
+    /**
+     * Load an user in the cache
+     *
+     * @param string $uid the username
+     * @return boolean true if user was found, false otherwise
+     */
+    private function loadUser($uid) {
+        $this->fixDI();
+
+        $uid = (string)$uid;
+        if (!isset($this->cache[$uid])) {
+            //guests $uid could be NULL or ''
+            if ($uid === '') {
+                $this->cache[$uid] = false;
+                return true;
+            }
+
+            $qb = $this->dbConn->getQueryBuilder();
+            $qb->select('uid', 'displayname')
+                ->from($this->table)
+                ->where(
+                    $qb->expr()->eq(
+                        'uid_lower', $qb->createNamedParameter(mb_strtolower($uid))
+                    )
+                );
+            $result = $qb->execute();
+            $row = $result->fetch();
+            $result->closeCursor();
+
+            $this->cache[$uid] = false;
+
+            // "uid" is primary key, so there can only be a single result
+            if ($row !== false) {
+                $this->cache[$uid]['uid'] = (string)$row['uid'];
+                $this->cache[$uid]['displayname'] = (string)$row['displayname'];
+            } else {
+                return false;
+            }
+        }
+
+        return true;
+    }
+
+    /**
+     * Get a list of all users
+     *
+     * @param string $search
+     * @param null|int $limit
+     * @param null|int $offset
+     * @return string[] an array of all uids
+     */
+    public function getUsers($search = '', $limit = null, $offset = null) {
+        $users = $this->getDisplayNames($search, $limit, $offset);
+        $userIds = array_map(function ($uid) {
+            return (string)$uid;
+        }, array_keys($users));
+        sort($userIds, SORT_STRING | SORT_FLAG_CASE);
+        return $userIds;
+    }
+
+    /**
+     * check if a user exists
+     *
+     * @param string $uid the username
+     * @return boolean
+     */
+    public function userExists($uid) {
+        $this->loadUser($uid);
+        return $this->cache[$uid] !== false;
+    }
+
+    /**
+     * get the user's home directory
+     *
+     * @param string $uid the username
+     * @return string|false
+     */
+    public function getHome(string $uid) {
+        if ($this->userExists($uid)) {
+            return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
+        }
+
+        return false;
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasUserListings() {
+        return true;
+    }
+
+    /**
+     * counts the users in the database
+     *
+     * @return int|bool
+     */
+    public function countUsers() {
+        $this->fixDI();
+
+        $query = $this->dbConn->getQueryBuilder();
+        $query->select($query->func()->count('uid'))
+            ->from($this->table);
+        $result = $query->execute();
+
+        return $result->fetchColumn();
+    }
+
+    /**
+     * returns the username for the given login name in the correct casing
+     *
+     * @param string $loginName
+     * @return string|false
+     */
+    public function loginName2UserName($loginName) {
+        if ($this->userExists($loginName)) {
+            return $this->cache[$loginName]['uid'];
+        }
+
+        return false;
+    }
+
+    /**
+     * Backend name to be shown in user management
+     *
+     * @return string the name of the backend to be shown
+     */
+    public function getBackendName() {
+        return 'Database';
+    }
+
+    public static function preLoginNameUsedAsUserName($param) {
+        if (!isset($param['uid'])) {
+            throw new \Exception('key uid is expected to be set in $param');
+        }
+
+        $backends = \OC::$server->getUserManager()->getBackends();
+        foreach ($backends as $backend) {
+            if ($backend instanceof Database) {
+                /** @var \OC\User\Database $backend */
+                $uid = $backend->loginName2UserName($param['uid']);
+                if ($uid !== false) {
+                    $param['uid'] = $uid;
+                    return;
+                }
+            }
+        }
+    }
+
+    public function getRealUID(string $uid): string {
+        if (!$this->userExists($uid)) {
+            throw new \RuntimeException($uid . ' does not exist');
+        }
+
+        return $this->cache[$uid]['uid'];
+    }
 
 
 }

Spacing +13 added lines, -13 removed lines

@@ -245,7 +245,7 @@ 
 	 * @return string display name
 	 */
 	public function getDisplayName($uid): string {
-		$uid = (string)$uid;
+		$uid = (string) $uid;
 		$this->loadUser($uid);
 		return empty($this->cache[$uid]['displayname']) ? $uid : $this->cache[$uid]['displayname'];
 	}
@@ -271,9 +271,9 @@ 
 				$query->expr()->eq('configkey', $query->expr()->literal('email')))
 			)
 			// sqlite doesn't like re-using a single named parameter here
-			->where($query->expr()->iLike('uid', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
-			->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
-			->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%' . $this->dbConn->escapeLikeParameter($search) . '%')))
+			->where($query->expr()->iLike('uid', $query->createPositionalParameter('%'.$this->dbConn->escapeLikeParameter($search).'%')))
+			->orWhere($query->expr()->iLike('displayname', $query->createPositionalParameter('%'.$this->dbConn->escapeLikeParameter($search).'%')))
+			->orWhere($query->expr()->iLike('configvalue', $query->createPositionalParameter('%'.$this->dbConn->escapeLikeParameter($search).'%')))
 			->orderBy($query->func()->lower('displayname'), 'ASC')
 			->orderBy('uid_lower', 'ASC')
 			->setMaxResults($limit)
@@ -282,7 +282,7 @@ 
 		$result = $query->execute();
 		$displayNames = [];
 		while ($row = $result->fetch()) {
-			$displayNames[(string)$row['uid']] = (string)$row['displayname'];
+			$displayNames[(string) $row['uid']] = (string) $row['displayname'];
 		}
 
 		return $displayNames;
@@ -320,7 +320,7 @@ 
 				if (!empty($newHash)) {
 					$this->updatePassword($uid, $newHash);
 				}
-				return (string)$row['uid'];
+				return (string) $row['uid'];
 			}
 
 		}
@@ -337,7 +337,7 @@ 
 	private function loadUser($uid) {
 		$this->fixDI();
 
-		$uid = (string)$uid;
+		$uid = (string) $uid;
 		if (!isset($this->cache[$uid])) {
 			//guests $uid could be NULL or ''
 			if ($uid === '') {
@@ -361,8 +361,8 @@ 
 
 			// "uid" is primary key, so there can only be a single result
 			if ($row !== false) {
-				$this->cache[$uid]['uid'] = (string)$row['uid'];
-				$this->cache[$uid]['displayname'] = (string)$row['displayname'];
+				$this->cache[$uid]['uid'] = (string) $row['uid'];
+				$this->cache[$uid]['displayname'] = (string) $row['displayname'];
 			} else {
 				return false;
 			}
@@ -381,8 +381,8 @@ 
 	 */
 	public function getUsers($search = '', $limit = null, $offset = null) {
 		$users = $this->getDisplayNames($search, $limit, $offset);
-		$userIds = array_map(function ($uid) {
-			return (string)$uid;
+		$userIds = array_map(function($uid) {
+			return (string) $uid;
 		}, array_keys($users));
 		sort($userIds, SORT_STRING | SORT_FLAG_CASE);
 		return $userIds;
@@ -407,7 +407,7 @@ 
 	 */
 	public function getHome(string $uid) {
 		if ($this->userExists($uid)) {
-			return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT . '/data') . '/' . $uid;
+			return \OC::$server->getConfig()->getSystemValue('datadirectory', \OC::$SERVERROOT.'/data').'/'.$uid;
 		}
 
 		return false;
@@ -479,7 +479,7 @@ 
 
 	public function getRealUID(string $uid): string {
 		if (!$this->userExists($uid)) {
-			throw new \RuntimeException($uid . ' does not exist');
+			throw new \RuntimeException($uid.' does not exist');
 		}
 
 		return $this->cache[$uid]['uid'];

lib/private/User/Manager.php

Indentation +553 added lines, -553 removed lines

@@ -60,561 +60,561 @@
  * @package OC\User
  */
 class Manager extends PublicEmitter implements IUserManager {
-	/**
-	 * @var \OCP\UserInterface[] $backends
-	 */
-	private $backends = array();
-
-	/**
-	 * @var \OC\User\User[] $cachedUsers
-	 */
-	private $cachedUsers = array();
-
-	/** @var IConfig */
-	private $config;
-	/** @var EventDispatcherInterface */
-	private $dispatcher;
-
-	public function __construct(IConfig $config, EventDispatcherInterface $dispatcher) {
-		$this->config = $config;
-		$this->dispatcher = $dispatcher;
-		$cachedUsers = &$this->cachedUsers;
-		$this->listen('\OC\User', 'postDelete', function ($user) use (&$cachedUsers) {
-			/** @var \OC\User\User $user */
-			unset($cachedUsers[$user->getUID()]);
-		});
-	}
-
-	/**
-	 * Get the active backends
-	 * @return \OCP\UserInterface[]
-	 */
-	public function getBackends() {
-		return $this->backends;
-	}
-
-	/**
-	 * register a user backend
-	 *
-	 * @param \OCP\UserInterface $backend
-	 */
-	public function registerBackend($backend) {
-		$this->backends[] = $backend;
-	}
-
-	/**
-	 * remove a user backend
-	 *
-	 * @param \OCP\UserInterface $backend
-	 */
-	public function removeBackend($backend) {
-		$this->cachedUsers = array();
-		if (($i = array_search($backend, $this->backends)) !== false) {
-			unset($this->backends[$i]);
-		}
-	}
-
-	/**
-	 * remove all user backends
-	 */
-	public function clearBackends() {
-		$this->cachedUsers = array();
-		$this->backends = array();
-	}
-
-	/**
-	 * get a user by user id
-	 *
-	 * @param string $uid
-	 * @return \OC\User\User|null Either the user or null if the specified user does not exist
-	 */
-	public function get($uid) {
-		if (is_null($uid) || $uid === '' || $uid === false) {
-			return null;
-		}
-		if (isset($this->cachedUsers[$uid])) { //check the cache first to prevent having to loop over the backends
-			return $this->cachedUsers[$uid];
-		}
-		foreach ($this->backends as $backend) {
-			if ($backend->userExists($uid)) {
-				return $this->getUserObject($uid, $backend);
-			}
-		}
-		return null;
-	}
-
-	/**
-	 * get or construct the user object
-	 *
-	 * @param string $uid
-	 * @param \OCP\UserInterface $backend
-	 * @param bool $cacheUser If false the newly created user object will not be cached
-	 * @return \OC\User\User
-	 */
-	protected function getUserObject($uid, $backend, $cacheUser = true) {
-		if ($backend instanceof IGetRealUIDBackend) {
-			$uid = $backend->getRealUID($uid);
-		}
-
-		if (isset($this->cachedUsers[$uid])) {
-			return $this->cachedUsers[$uid];
-		}
-
-		$user = new User($uid, $backend, $this->dispatcher, $this, $this->config);
-		if ($cacheUser) {
-			$this->cachedUsers[$uid] = $user;
-		}
-		return $user;
-	}
-
-	/**
-	 * check if a user exists
-	 *
-	 * @param string $uid
-	 * @return bool
-	 */
-	public function userExists($uid) {
-		$user = $this->get($uid);
-		return ($user !== null);
-	}
-
-	/**
-	 * Check if the password is valid for the user
-	 *
-	 * @param string $loginName
-	 * @param string $password
-	 * @return mixed the User object on success, false otherwise
-	 */
-	public function checkPassword($loginName, $password) {
-		$result = $this->checkPasswordNoLogging($loginName, $password);
-
-		if ($result === false) {
-			\OC::$server->getLogger()->warning('Login failed: \''. $loginName .'\' (Remote IP: \''. \OC::$server->getRequest()->getRemoteAddress(). '\')', ['app' => 'core']);
-		}
-
-		return $result;
-	}
-
-	/**
-	 * Check if the password is valid for the user
-	 *
-	 * @internal
-	 * @param string $loginName
-	 * @param string $password
-	 * @return IUser|false the User object on success, false otherwise
-	 */
-	public function checkPasswordNoLogging($loginName, $password) {
-		$loginName = str_replace("\0", '', $loginName);
-		$password = str_replace("\0", '', $password);
-
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(Backend::CHECK_PASSWORD)) {
-				$uid = $backend->checkPassword($loginName, $password);
-				if ($uid !== false) {
-					return $this->getUserObject($uid, $backend);
-				}
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * search by user id
-	 *
-	 * @param string $pattern
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OC\User\User[]
-	 */
-	public function search($pattern, $limit = null, $offset = null) {
-		$users = array();
-		foreach ($this->backends as $backend) {
-			$backendUsers = $backend->getUsers($pattern, $limit, $offset);
-			if (is_array($backendUsers)) {
-				foreach ($backendUsers as $uid) {
-					$users[$uid] = $this->getUserObject($uid, $backend);
-				}
-			}
-		}
-
-		uasort($users, function ($a, $b) {
-			/**
-			 * @var \OC\User\User $a
-			 * @var \OC\User\User $b
-			 */
-			return strcasecmp($a->getUID(), $b->getUID());
-		});
-		return $users;
-	}
-
-	/**
-	 * search by displayName
-	 *
-	 * @param string $pattern
-	 * @param int $limit
-	 * @param int $offset
-	 * @return \OC\User\User[]
-	 */
-	public function searchDisplayName($pattern, $limit = null, $offset = null) {
-		$users = array();
-		foreach ($this->backends as $backend) {
-			$backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
-			if (is_array($backendUsers)) {
-				foreach ($backendUsers as $uid => $displayName) {
-					$users[] = $this->getUserObject($uid, $backend);
-				}
-			}
-		}
-
-		usort($users, function ($a, $b) {
-			/**
-			 * @var \OC\User\User $a
-			 * @var \OC\User\User $b
-			 */
-			return strcasecmp($a->getDisplayName(), $b->getDisplayName());
-		});
-		return $users;
-	}
-
-	/**
-	 * @param string $uid
-	 * @param string $password
-	 * @throws \InvalidArgumentException
-	 * @return bool|IUser the created user or false
-	 */
-	public function createUser($uid, $password) {
-		if (!$this->verifyUid($uid)) {
-			return false;
-		}
-
-		$localBackends = [];
-		foreach ($this->backends as $backend) {
-			if ($backend instanceof Database) {
-				// First check if there is another user backend
-				$localBackends[] = $backend;
-				continue;
-			}
-
-			if ($backend->implementsActions(Backend::CREATE_USER)) {
-				return $this->createUserFromBackend($uid, $password, $backend);
-			}
-		}
-
-		foreach ($localBackends as $backend) {
-			if ($backend->implementsActions(Backend::CREATE_USER)) {
-				return $this->createUserFromBackend($uid, $password, $backend);
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param string $uid
-	 * @param string $password
-	 * @param UserInterface $backend
-	 * @return IUser|null
-	 * @throws \InvalidArgumentException
-	 */
-	public function createUserFromBackend($uid, $password, UserInterface $backend) {
-		$l = \OC::$server->getL10N('lib');
-
-		// Check the name for bad characters
-		// Allowed are: "a-z", "A-Z", "0-9" and "_.@-'"
-		if (preg_match('/[^a-zA-Z0-9 _\.@\-\']/', $uid)) {
-			throw new \InvalidArgumentException($l->t('Only the following characters are allowed in a username:'
-				. ' "a-z", "A-Z", "0-9", and "_.@-\'"'));
-		}
-		// No empty username
-		if (trim($uid) === '') {
-			throw new \InvalidArgumentException($l->t('A valid username must be provided'));
-		}
-		// No whitespace at the beginning or at the end
-		if (trim($uid) !== $uid) {
-			throw new \InvalidArgumentException($l->t('Username contains whitespace at the beginning or at the end'));
-		}
-		// Username only consists of 1 or 2 dots (directory traversal)
-		if ($uid === '.' || $uid === '..') {
-			throw new \InvalidArgumentException($l->t('Username must not consist of dots only'));
-		}
-		// No empty password
-		if (trim($password) === '') {
-			throw new \InvalidArgumentException($l->t('A valid password must be provided'));
-		}
-
-		// Check if user already exists
-		if ($this->userExists($uid)) {
-			throw new \InvalidArgumentException($l->t('The username is already being used'));
-		}
-
-		$this->emit('\OC\User', 'preCreateUser', [$uid, $password]);
-		$state = $backend->createUser($uid, $password);
-		if($state === false) {
-			throw new \InvalidArgumentException($l->t('Could not create user'));
-		}
-		$user = $this->getUserObject($uid, $backend);
-		if ($user instanceof IUser) {
-			$this->emit('\OC\User', 'postCreateUser', [$user, $password]);
-		}
-		return $user;
-	}
-
-	/**
-	 * returns how many users per backend exist (if supported by backend)
-	 *
-	 * @param boolean $hasLoggedIn when true only users that have a lastLogin
-	 *                entry in the preferences table will be affected
-	 * @return array|int an array of backend class as key and count number as value
-	 *                if $hasLoggedIn is true only an int is returned
-	 */
-	public function countUsers($hasLoggedIn = false) {
-		if ($hasLoggedIn) {
-			return $this->countSeenUsers();
-		}
-		$userCountStatistics = [];
-		foreach ($this->backends as $backend) {
-			if ($backend->implementsActions(Backend::COUNT_USERS)) {
-				$backendUsers = $backend->countUsers();
-				if($backendUsers !== false) {
-					if($backend instanceof IUserBackend) {
-						$name = $backend->getBackendName();
-					} else {
-						$name = get_class($backend);
-					}
-					if(isset($userCountStatistics[$name])) {
-						$userCountStatistics[$name] += $backendUsers;
-					} else {
-						$userCountStatistics[$name] = $backendUsers;
-					}
-				}
-			}
-		}
-		return $userCountStatistics;
-	}
-
-	/**
-	 * returns how many users per backend exist in the requested groups (if supported by backend)
-	 *
-	 * @param IGroup[] $groups an array of gid to search in
-	 * @return array|int an array of backend class as key and count number as value
-	 *                if $hasLoggedIn is true only an int is returned
-	 */
-	public function countUsersOfGroups(array $groups) {
-		$users = [];
-		foreach($groups as $group) {
-			$usersIds = array_map(function($user) {
-				return $user->getUID();
-			}, $group->getUsers());
-			$users = array_merge($users, $usersIds);
-		}
-		return count(array_unique($users));
-	}
-
-	/**
-	 * The callback is executed for each user on each backend.
-	 * If the callback returns false no further users will be retrieved.
-	 *
-	 * @param \Closure $callback
-	 * @param string $search
-	 * @param boolean $onlySeen when true only users that have a lastLogin entry
-	 *                in the preferences table will be affected
-	 * @since 9.0.0
-	 */
-	public function callForAllUsers(\Closure $callback, $search = '', $onlySeen = false) {
-		if ($onlySeen) {
-			$this->callForSeenUsers($callback);
-		} else {
-			foreach ($this->getBackends() as $backend) {
-				$limit = 500;
-				$offset = 0;
-				do {
-					$users = $backend->getUsers($search, $limit, $offset);
-					foreach ($users as $uid) {
-						if (!$backend->userExists($uid)) {
-							continue;
-						}
-						$user = $this->getUserObject($uid, $backend, false);
-						$return = $callback($user);
-						if ($return === false) {
-							break;
-						}
-					}
-					$offset += $limit;
-				} while (count($users) >= $limit);
-			}
-		}
-	}
-
-	/**
-	 * returns how many users are disabled
-	 *
-	 * @return int
-	 * @since 12.0.0
-	 */
-	public function countDisabledUsers(): int {
-		$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
-		$queryBuilder->select($queryBuilder->func()->count('*'))
-			->from('preferences')
-			->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
-			->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
-			->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR));
+    /**
+     * @var \OCP\UserInterface[] $backends
+     */
+    private $backends = array();
+
+    /**
+     * @var \OC\User\User[] $cachedUsers
+     */
+    private $cachedUsers = array();
+
+    /** @var IConfig */
+    private $config;
+    /** @var EventDispatcherInterface */
+    private $dispatcher;
+
+    public function __construct(IConfig $config, EventDispatcherInterface $dispatcher) {
+        $this->config = $config;
+        $this->dispatcher = $dispatcher;
+        $cachedUsers = &$this->cachedUsers;
+        $this->listen('\OC\User', 'postDelete', function ($user) use (&$cachedUsers) {
+            /** @var \OC\User\User $user */
+            unset($cachedUsers[$user->getUID()]);
+        });
+    }
+
+    /**
+     * Get the active backends
+     * @return \OCP\UserInterface[]
+     */
+    public function getBackends() {
+        return $this->backends;
+    }
+
+    /**
+     * register a user backend
+     *
+     * @param \OCP\UserInterface $backend
+     */
+    public function registerBackend($backend) {
+        $this->backends[] = $backend;
+    }
+
+    /**
+     * remove a user backend
+     *
+     * @param \OCP\UserInterface $backend
+     */
+    public function removeBackend($backend) {
+        $this->cachedUsers = array();
+        if (($i = array_search($backend, $this->backends)) !== false) {
+            unset($this->backends[$i]);
+        }
+    }
+
+    /**
+     * remove all user backends
+     */
+    public function clearBackends() {
+        $this->cachedUsers = array();
+        $this->backends = array();
+    }
+
+    /**
+     * get a user by user id
+     *
+     * @param string $uid
+     * @return \OC\User\User|null Either the user or null if the specified user does not exist
+     */
+    public function get($uid) {
+        if (is_null($uid) || $uid === '' || $uid === false) {
+            return null;
+        }
+        if (isset($this->cachedUsers[$uid])) { //check the cache first to prevent having to loop over the backends
+            return $this->cachedUsers[$uid];
+        }
+        foreach ($this->backends as $backend) {
+            if ($backend->userExists($uid)) {
+                return $this->getUserObject($uid, $backend);
+            }
+        }
+        return null;
+    }
+
+    /**
+     * get or construct the user object
+     *
+     * @param string $uid
+     * @param \OCP\UserInterface $backend
+     * @param bool $cacheUser If false the newly created user object will not be cached
+     * @return \OC\User\User
+     */
+    protected function getUserObject($uid, $backend, $cacheUser = true) {
+        if ($backend instanceof IGetRealUIDBackend) {
+            $uid = $backend->getRealUID($uid);
+        }
+
+        if (isset($this->cachedUsers[$uid])) {
+            return $this->cachedUsers[$uid];
+        }
+
+        $user = new User($uid, $backend, $this->dispatcher, $this, $this->config);
+        if ($cacheUser) {
+            $this->cachedUsers[$uid] = $user;
+        }
+        return $user;
+    }
+
+    /**
+     * check if a user exists
+     *
+     * @param string $uid
+     * @return bool
+     */
+    public function userExists($uid) {
+        $user = $this->get($uid);
+        return ($user !== null);
+    }
+
+    /**
+     * Check if the password is valid for the user
+     *
+     * @param string $loginName
+     * @param string $password
+     * @return mixed the User object on success, false otherwise
+     */
+    public function checkPassword($loginName, $password) {
+        $result = $this->checkPasswordNoLogging($loginName, $password);
+
+        if ($result === false) {
+            \OC::$server->getLogger()->warning('Login failed: \''. $loginName .'\' (Remote IP: \''. \OC::$server->getRequest()->getRemoteAddress(). '\')', ['app' => 'core']);
+        }
+
+        return $result;
+    }
+
+    /**
+     * Check if the password is valid for the user
+     *
+     * @internal
+     * @param string $loginName
+     * @param string $password
+     * @return IUser|false the User object on success, false otherwise
+     */
+    public function checkPasswordNoLogging($loginName, $password) {
+        $loginName = str_replace("\0", '', $loginName);
+        $password = str_replace("\0", '', $password);
+
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(Backend::CHECK_PASSWORD)) {
+                $uid = $backend->checkPassword($loginName, $password);
+                if ($uid !== false) {
+                    return $this->getUserObject($uid, $backend);
+                }
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * search by user id
+     *
+     * @param string $pattern
+     * @param int $limit
+     * @param int $offset
+     * @return \OC\User\User[]
+     */
+    public function search($pattern, $limit = null, $offset = null) {
+        $users = array();
+        foreach ($this->backends as $backend) {
+            $backendUsers = $backend->getUsers($pattern, $limit, $offset);
+            if (is_array($backendUsers)) {
+                foreach ($backendUsers as $uid) {
+                    $users[$uid] = $this->getUserObject($uid, $backend);
+                }
+            }
+        }
+
+        uasort($users, function ($a, $b) {
+            /**
+             * @var \OC\User\User $a
+             * @var \OC\User\User $b
+             */
+            return strcasecmp($a->getUID(), $b->getUID());
+        });
+        return $users;
+    }
+
+    /**
+     * search by displayName
+     *
+     * @param string $pattern
+     * @param int $limit
+     * @param int $offset
+     * @return \OC\User\User[]
+     */
+    public function searchDisplayName($pattern, $limit = null, $offset = null) {
+        $users = array();
+        foreach ($this->backends as $backend) {
+            $backendUsers = $backend->getDisplayNames($pattern, $limit, $offset);
+            if (is_array($backendUsers)) {
+                foreach ($backendUsers as $uid => $displayName) {
+                    $users[] = $this->getUserObject($uid, $backend);
+                }
+            }
+        }
+
+        usort($users, function ($a, $b) {
+            /**
+             * @var \OC\User\User $a
+             * @var \OC\User\User $b
+             */
+            return strcasecmp($a->getDisplayName(), $b->getDisplayName());
+        });
+        return $users;
+    }
+
+    /**
+     * @param string $uid
+     * @param string $password
+     * @throws \InvalidArgumentException
+     * @return bool|IUser the created user or false
+     */
+    public function createUser($uid, $password) {
+        if (!$this->verifyUid($uid)) {
+            return false;
+        }
+
+        $localBackends = [];
+        foreach ($this->backends as $backend) {
+            if ($backend instanceof Database) {
+                // First check if there is another user backend
+                $localBackends[] = $backend;
+                continue;
+            }
+
+            if ($backend->implementsActions(Backend::CREATE_USER)) {
+                return $this->createUserFromBackend($uid, $password, $backend);
+            }
+        }
+
+        foreach ($localBackends as $backend) {
+            if ($backend->implementsActions(Backend::CREATE_USER)) {
+                return $this->createUserFromBackend($uid, $password, $backend);
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $uid
+     * @param string $password
+     * @param UserInterface $backend
+     * @return IUser|null
+     * @throws \InvalidArgumentException
+     */
+    public function createUserFromBackend($uid, $password, UserInterface $backend) {
+        $l = \OC::$server->getL10N('lib');
+
+        // Check the name for bad characters
+        // Allowed are: "a-z", "A-Z", "0-9" and "_.@-'"
+        if (preg_match('/[^a-zA-Z0-9 _\.@\-\']/', $uid)) {
+            throw new \InvalidArgumentException($l->t('Only the following characters are allowed in a username:'
+                . ' "a-z", "A-Z", "0-9", and "_.@-\'"'));
+        }
+        // No empty username
+        if (trim($uid) === '') {
+            throw new \InvalidArgumentException($l->t('A valid username must be provided'));
+        }
+        // No whitespace at the beginning or at the end
+        if (trim($uid) !== $uid) {
+            throw new \InvalidArgumentException($l->t('Username contains whitespace at the beginning or at the end'));
+        }
+        // Username only consists of 1 or 2 dots (directory traversal)
+        if ($uid === '.' || $uid === '..') {
+            throw new \InvalidArgumentException($l->t('Username must not consist of dots only'));
+        }
+        // No empty password
+        if (trim($password) === '') {
+            throw new \InvalidArgumentException($l->t('A valid password must be provided'));
+        }
+
+        // Check if user already exists
+        if ($this->userExists($uid)) {
+            throw new \InvalidArgumentException($l->t('The username is already being used'));
+        }
+
+        $this->emit('\OC\User', 'preCreateUser', [$uid, $password]);
+        $state = $backend->createUser($uid, $password);
+        if($state === false) {
+            throw new \InvalidArgumentException($l->t('Could not create user'));
+        }
+        $user = $this->getUserObject($uid, $backend);
+        if ($user instanceof IUser) {
+            $this->emit('\OC\User', 'postCreateUser', [$user, $password]);
+        }
+        return $user;
+    }
+
+    /**
+     * returns how many users per backend exist (if supported by backend)
+     *
+     * @param boolean $hasLoggedIn when true only users that have a lastLogin
+     *                entry in the preferences table will be affected
+     * @return array|int an array of backend class as key and count number as value
+     *                if $hasLoggedIn is true only an int is returned
+     */
+    public function countUsers($hasLoggedIn = false) {
+        if ($hasLoggedIn) {
+            return $this->countSeenUsers();
+        }
+        $userCountStatistics = [];
+        foreach ($this->backends as $backend) {
+            if ($backend->implementsActions(Backend::COUNT_USERS)) {
+                $backendUsers = $backend->countUsers();
+                if($backendUsers !== false) {
+                    if($backend instanceof IUserBackend) {
+                        $name = $backend->getBackendName();
+                    } else {
+                        $name = get_class($backend);
+                    }
+                    if(isset($userCountStatistics[$name])) {
+                        $userCountStatistics[$name] += $backendUsers;
+                    } else {
+                        $userCountStatistics[$name] = $backendUsers;
+                    }
+                }
+            }
+        }
+        return $userCountStatistics;
+    }
+
+    /**
+     * returns how many users per backend exist in the requested groups (if supported by backend)
+     *
+     * @param IGroup[] $groups an array of gid to search in
+     * @return array|int an array of backend class as key and count number as value
+     *                if $hasLoggedIn is true only an int is returned
+     */
+    public function countUsersOfGroups(array $groups) {
+        $users = [];
+        foreach($groups as $group) {
+            $usersIds = array_map(function($user) {
+                return $user->getUID();
+            }, $group->getUsers());
+            $users = array_merge($users, $usersIds);
+        }
+        return count(array_unique($users));
+    }
+
+    /**
+     * The callback is executed for each user on each backend.
+     * If the callback returns false no further users will be retrieved.
+     *
+     * @param \Closure $callback
+     * @param string $search
+     * @param boolean $onlySeen when true only users that have a lastLogin entry
+     *                in the preferences table will be affected
+     * @since 9.0.0
+     */
+    public function callForAllUsers(\Closure $callback, $search = '', $onlySeen = false) {
+        if ($onlySeen) {
+            $this->callForSeenUsers($callback);
+        } else {
+            foreach ($this->getBackends() as $backend) {
+                $limit = 500;
+                $offset = 0;
+                do {
+                    $users = $backend->getUsers($search, $limit, $offset);
+                    foreach ($users as $uid) {
+                        if (!$backend->userExists($uid)) {
+                            continue;
+                        }
+                        $user = $this->getUserObject($uid, $backend, false);
+                        $return = $callback($user);
+                        if ($return === false) {
+                            break;
+                        }
+                    }
+                    $offset += $limit;
+                } while (count($users) >= $limit);
+            }
+        }
+    }
+
+    /**
+     * returns how many users are disabled
+     *
+     * @return int
+     * @since 12.0.0
+     */
+    public function countDisabledUsers(): int {
+        $queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+        $queryBuilder->select($queryBuilder->func()->count('*'))
+            ->from('preferences')
+            ->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
+            ->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
+            ->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR));
 
 		
-		$result = $queryBuilder->execute();
-		$count = $result->fetchColumn();
-		$result->closeCursor();
+        $result = $queryBuilder->execute();
+        $count = $result->fetchColumn();
+        $result->closeCursor();
 		
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	/**
-	 * returns how many users are disabled in the requested groups
-	 *
-	 * @param array $groups groupids to search
-	 * @return int
-	 * @since 14.0.0
-	 */
-	public function countDisabledUsersOfGroups(array $groups): int {
-		$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
-		$queryBuilder->select($queryBuilder->createFunction('COUNT(DISTINCT ' . $queryBuilder->getColumnName('uid') . ')'))
-			->from('preferences', 'p')
-			->innerJoin('p', 'group_user', 'g', $queryBuilder->expr()->eq('p.userid', 'g.uid'))
-			->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
-			->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
-			->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
-			->andWhere($queryBuilder->expr()->in('gid', $queryBuilder->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY)));
-
-		$result = $queryBuilder->execute();
-		$count = $result->fetchColumn();
-		$result->closeCursor();
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    /**
+     * returns how many users are disabled in the requested groups
+     *
+     * @param array $groups groupids to search
+     * @return int
+     * @since 14.0.0
+     */
+    public function countDisabledUsersOfGroups(array $groups): int {
+        $queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+        $queryBuilder->select($queryBuilder->createFunction('COUNT(DISTINCT ' . $queryBuilder->getColumnName('uid') . ')'))
+            ->from('preferences', 'p')
+            ->innerJoin('p', 'group_user', 'g', $queryBuilder->expr()->eq('p.userid', 'g.uid'))
+            ->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('core')))
+            ->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('enabled')))
+            ->andWhere($queryBuilder->expr()->eq('configvalue', $queryBuilder->createNamedParameter('false'), IQueryBuilder::PARAM_STR))
+            ->andWhere($queryBuilder->expr()->in('gid', $queryBuilder->createNamedParameter($groups, IQueryBuilder::PARAM_STR_ARRAY)));
+
+        $result = $queryBuilder->execute();
+        $count = $result->fetchColumn();
+        $result->closeCursor();
 		
-		if ($count !== false) {
-			$count = (int)$count;
-		} else {
-			$count = 0;
-		}
-
-		return $count;
-	}
-
-	/**
-	 * returns how many users have logged in once
-	 *
-	 * @return int
-	 * @since 11.0.0
-	 */
-	public function countSeenUsers() {
-		$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
-		$queryBuilder->select($queryBuilder->func()->count('*'))
-			->from('preferences')
-			->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('login')))
-			->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('lastLogin')))
-			->andWhere($queryBuilder->expr()->isNotNull('configvalue'));
-
-		$query = $queryBuilder->execute();
-
-		$result = (int)$query->fetchColumn();
-		$query->closeCursor();
-
-		return $result;
-	}
-
-	/**
-	 * @param \Closure $callback
-	 * @since 11.0.0
-	 */
-	public function callForSeenUsers(\Closure $callback) {
-		$limit = 1000;
-		$offset = 0;
-		do {
-			$userIds = $this->getSeenUserIds($limit, $offset);
-			$offset += $limit;
-			foreach ($userIds as $userId) {
-				foreach ($this->backends as $backend) {
-					if ($backend->userExists($userId)) {
-						$user = $this->getUserObject($userId, $backend, false);
-						$return = $callback($user);
-						if ($return === false) {
-							return;
-						}
-						break;
-					}
-				}
-			}
-		} while (count($userIds) >= $limit);
-	}
-
-	/**
-	 * Getting all userIds that have a listLogin value requires checking the
-	 * value in php because on oracle you cannot use a clob in a where clause,
-	 * preventing us from doing a not null or length(value) > 0 check.
-	 *
-	 * @param int $limit
-	 * @param int $offset
-	 * @return string[] with user ids
-	 */
-	private function getSeenUserIds($limit = null, $offset = null) {
-		$queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
-		$queryBuilder->select(['userid'])
-			->from('preferences')
-			->where($queryBuilder->expr()->eq(
-				'appid', $queryBuilder->createNamedParameter('login'))
-			)
-			->andWhere($queryBuilder->expr()->eq(
-				'configkey', $queryBuilder->createNamedParameter('lastLogin'))
-			)
-			->andWhere($queryBuilder->expr()->isNotNull('configvalue')
-			);
-
-		if ($limit !== null) {
-			$queryBuilder->setMaxResults($limit);
-		}
-		if ($offset !== null) {
-			$queryBuilder->setFirstResult($offset);
-		}
-		$query = $queryBuilder->execute();
-		$result = [];
-
-		while ($row = $query->fetch()) {
-			$result[] = $row['userid'];
-		}
-
-		$query->closeCursor();
-
-		return $result;
-	}
-
-	/**
-	 * @param string $email
-	 * @return IUser[]
-	 * @since 9.1.0
-	 */
-	public function getByEmail($email) {
-		$userIds = $this->config->getUsersForUserValueCaseInsensitive('settings', 'email', $email);
-
-		$users = array_map(function($uid) {
-			return $this->get($uid);
-		}, $userIds);
-
-		return array_values(array_filter($users, function($u) {
-			return ($u instanceof IUser);
-		}));
-	}
-
-	private function verifyUid(string $uid): bool {
-		$appdata = 'appdata_' . $this->config->getSystemValueString('instanceid');
-
-		if ($uid === '.htaccess' || $uid === 'files_external' || $uid === '.ocdata' || $uid === 'owncloud.log' || $uid === 'nextcloud.log' || $uid === $appdata) {
-			return false;
-		}
-
-		return true;
-	}
+        if ($count !== false) {
+            $count = (int)$count;
+        } else {
+            $count = 0;
+        }
+
+        return $count;
+    }
+
+    /**
+     * returns how many users have logged in once
+     *
+     * @return int
+     * @since 11.0.0
+     */
+    public function countSeenUsers() {
+        $queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+        $queryBuilder->select($queryBuilder->func()->count('*'))
+            ->from('preferences')
+            ->where($queryBuilder->expr()->eq('appid', $queryBuilder->createNamedParameter('login')))
+            ->andWhere($queryBuilder->expr()->eq('configkey', $queryBuilder->createNamedParameter('lastLogin')))
+            ->andWhere($queryBuilder->expr()->isNotNull('configvalue'));
+
+        $query = $queryBuilder->execute();
+
+        $result = (int)$query->fetchColumn();
+        $query->closeCursor();
+
+        return $result;
+    }
+
+    /**
+     * @param \Closure $callback
+     * @since 11.0.0
+     */
+    public function callForSeenUsers(\Closure $callback) {
+        $limit = 1000;
+        $offset = 0;
+        do {
+            $userIds = $this->getSeenUserIds($limit, $offset);
+            $offset += $limit;
+            foreach ($userIds as $userId) {
+                foreach ($this->backends as $backend) {
+                    if ($backend->userExists($userId)) {
+                        $user = $this->getUserObject($userId, $backend, false);
+                        $return = $callback($user);
+                        if ($return === false) {
+                            return;
+                        }
+                        break;
+                    }
+                }
+            }
+        } while (count($userIds) >= $limit);
+    }
+
+    /**
+     * Getting all userIds that have a listLogin value requires checking the
+     * value in php because on oracle you cannot use a clob in a where clause,
+     * preventing us from doing a not null or length(value) > 0 check.
+     *
+     * @param int $limit
+     * @param int $offset
+     * @return string[] with user ids
+     */
+    private function getSeenUserIds($limit = null, $offset = null) {
+        $queryBuilder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+        $queryBuilder->select(['userid'])
+            ->from('preferences')
+            ->where($queryBuilder->expr()->eq(
+                'appid', $queryBuilder->createNamedParameter('login'))
+            )
+            ->andWhere($queryBuilder->expr()->eq(
+                'configkey', $queryBuilder->createNamedParameter('lastLogin'))
+            )
+            ->andWhere($queryBuilder->expr()->isNotNull('configvalue')
+            );
+
+        if ($limit !== null) {
+            $queryBuilder->setMaxResults($limit);
+        }
+        if ($offset !== null) {
+            $queryBuilder->setFirstResult($offset);
+        }
+        $query = $queryBuilder->execute();
+        $result = [];
+
+        while ($row = $query->fetch()) {
+            $result[] = $row['userid'];
+        }
+
+        $query->closeCursor();
+
+        return $result;
+    }
+
+    /**
+     * @param string $email
+     * @return IUser[]
+     * @since 9.1.0
+     */
+    public function getByEmail($email) {
+        $userIds = $this->config->getUsersForUserValueCaseInsensitive('settings', 'email', $email);
+
+        $users = array_map(function($uid) {
+            return $this->get($uid);
+        }, $userIds);
+
+        return array_values(array_filter($users, function($u) {
+            return ($u instanceof IUser);
+        }));
+    }
+
+    private function verifyUid(string $uid): bool {
+        $appdata = 'appdata_' . $this->config->getSystemValueString('instanceid');
+
+        if ($uid === '.htaccess' || $uid === 'files_external' || $uid === '.ocdata' || $uid === 'owncloud.log' || $uid === 'nextcloud.log' || $uid === $appdata) {
+            return false;
+        }
+
+        return true;
+    }
 }

lib/public/User/Backend/IGetRealUIDBackend.php

Indentation +12 added lines, -12 removed lines

@@ -29,16 +29,16 @@
  */
 interface IGetRealUIDBackend {
 
-	/**
-	 * Some backends accept different UIDs than what is the internal UID to be used.
-	 * For example the database backend accepts differnt cased UIDs in all the functions
-	 * but the internal UID that is to be used should be correctly cased.
-	 *
-	 * This little function makes sure that the used UID will be correct hen using the user object
-	 *
-	 * @since 17.0.0
-	 * @param string $uid
-	 * @return string
-	 */
-	public function getRealUID(string $uid): string;
+    /**
+     * Some backends accept different UIDs than what is the internal UID to be used.
+     * For example the database backend accepts differnt cased UIDs in all the functions
+     * but the internal UID that is to be used should be correctly cased.
+     *
+     * This little function makes sure that the used UID will be correct hen using the user object
+     *
+     * @since 17.0.0
+     * @param string $uid
+     * @return string
+     */
+    public function getRealUID(string $uid): string;
 }