Merge pull request #45370 from nextcloud/feat/add-back-search-in-disa…

…bled-users feat: Add back searching in disabled user list
nextcloud · May 23, 2024 · 2fa099a · 2fa099a
2 parents e38fcf8 + 9a523e9
commit 2fa099a
Show file tree

Hide file tree

Showing 14 changed files with 62 additions and 20 deletions.
diff --git a/apps/provisioning_api/lib/Controller/UsersController.php b/apps/provisioning_api/lib/Controller/UsersController.php
@@ -225,13 +225,14 @@ public function getUsersDetails(string $search = '', ?int $limit = null, int $of
 	 *
 	 * Get the list of disabled users and their details
 	 *
+	 * @param string $search Text to search for
 	 * @param ?int $limit Limit the amount of users returned
 	 * @param int $offset Offset
 	 * @return DataResponse<Http::STATUS_OK, array{users: array<string, Provisioning_APIUserDetails|array{id: string}>}, array{}>
 	 *
 	 * 200: Disabled users details returned
 	 */
-	public function getDisabledUsersDetails(?int $limit = null, int $offset = 0): DataResponse {
+	public function getDisabledUsersDetails(string $search = '', ?int $limit = null, int $offset = 0): DataResponse {
 		$currentUser = $this->userSession->getUser();
 		if ($currentUser === null) {
 			return new DataResponse(['users' => []]);
@@ -249,7 +250,7 @@ public function getDisabledUsersDetails(?int $limit = null, int $offset = 0): Da
 		$uid = $currentUser->getUID();
 		$subAdminManager = $this->groupManager->getSubAdmin();
 		if ($this->groupManager->isAdmin($uid)) {
-			$users = $this->userManager->getDisabledUsers($limit, $offset);
+			$users = $this->userManager->getDisabledUsers($limit, $offset, $search);
 			$users = array_map(fn (IUser $user): string => $user->getUID(), $users);
 		} elseif ($subAdminManager->isSubAdmin($currentUser)) {
 			$subAdminOfGroups = $subAdminManager->getSubAdminsGroups($currentUser);
@@ -263,7 +264,7 @@ public function getDisabledUsersDetails(?int $limit = null, int $offset = 0): Da
 					array_map(
 						fn (IUser $user): string => $user->getUID(),
 						array_filter(
-							$group->searchUsers('', ($tempLimit === null ? null : $tempLimit - count($users))),
+							$group->searchUsers($search, ($tempLimit === null ? null : $tempLimit - count($users))),
 							fn (IUser $user): bool => !$user->isEnabled()
 						)
 					)

diff --git a/apps/provisioning_api/openapi-full.json b/apps/provisioning_api/openapi-full.json
@@ -2279,6 +2279,15 @@
                     }
                 ],
                 "parameters": [
+                    {
+                        "name": "search",
+                        "in": "query",
+                        "description": "Text to search for",
+                        "schema": {
+                            "type": "string",
+                            "default": ""
+                        }
+                    },
                     {
                         "name": "limit",
                         "in": "query",

diff --git a/apps/provisioning_api/openapi.json b/apps/provisioning_api/openapi.json
@@ -1353,6 +1353,15 @@
                     }
                 ],
                 "parameters": [
+                    {
+                        "name": "search",
+                        "in": "query",
+                        "description": "Text to search for",
+                        "schema": {
+                            "type": "string",
+                            "default": ""
+                        }
+                    },
                     {
                         "name": "limit",
                         "in": "query",

diff --git a/apps/settings/src/components/UserList.vue b/apps/settings/src/components/UserList.vue
@@ -313,6 +313,7 @@ export default {
 					await this.$store.dispatch('getDisabledUsers', {
 						offset: this.disabledUsersOffset,
 						limit: this.disabledUsersLimit,
+						search: this.searchQuery,
 					})
 				} else {
 					await this.$store.dispatch('getUsers', {

diff --git a/apps/settings/src/store/users.js b/apps/settings/src/store/users.js
@@ -416,8 +416,8 @@ const actions = {
 	 * @param {number} options.limit List number to return from offset
 	 * @return {Promise<number>}
 	 */
-	async getDisabledUsers(context, { offset, limit }) {
-		const url = generateOcsUrl('cloud/users/disabled?offset={offset}&limit={limit}', { offset, limit })
+	async getDisabledUsers(context, { offset, limit, search }) {
+		const url = generateOcsUrl('cloud/users/disabled?offset={offset}&limit={limit}&search={search}', { offset, limit, search })
 		try {
 			const response = await api.get(url)
 			const usersCount = Object.keys(response.data.ocs.data.users).length

diff --git a/apps/user_ldap/lib/User_LDAP.php b/apps/user_ldap/lib/User_LDAP.php
@@ -682,7 +682,7 @@ public function setUserEnabled(string $uid, bool $enabled, callable $queryDataba
 		return $enabled;
 	}
 
-	public function getDisabledUserList(?int $limit = null, int $offset = 0): array {
+	public function getDisabledUserList(?int $limit = null, int $offset = 0, string $search = ''): array {
 		throw new \Exception('This is implemented directly in User_Proxy');
 	}
 }
diff --git a/apps/user_ldap/lib/User_Proxy.php b/apps/user_ldap/lib/User_Proxy.php
@@ -463,11 +463,22 @@ public function setUserEnabled(string $uid, bool $enabled, callable $queryDataba
 		return $this->handleRequest($uid, 'setUserEnabled', [$uid, $enabled, $queryDatabaseValue, $setDatabaseValue]);
 	}
 
-	public function getDisabledUserList(?int $limit = null, int $offset = 0): array {
+	public function getDisabledUserList(?int $limit = null, int $offset = 0, string $search = ''): array {
+		$disabledUsers = $this->deletedUsersIndex->getUsers();
+		if ($search !== '') {
+			$disabledUsers = array_filter(
+				$disabledUsers,
+				fn (OfflineUser $user): bool =>
+					mb_stripos($user->getOCName(), $search) !== false ||
+					mb_stripos($user->getUID(), $search) !== false ||
+					mb_stripos($user->getDisplayName(), $search) !== false ||
+					mb_stripos($user->getEmail(), $search) !== false,
+			);
+		}
 		return array_map(
 			fn (OfflineUser $user) => $user->getOCName(),
 			array_slice(
-				$this->deletedUsersIndex->getUsers(),
+				$disabledUsers,
 				$offset,
 				$limit
 			)

diff --git a/dist/settings-users-3239.js b/dist/settings-users-3239.js
diff --git a/dist/settings-users-3239.js.map b/dist/settings-users-3239.js.map
diff --git a/dist/settings-vue-settings-apps-users-management.js b/dist/settings-vue-settings-apps-users-management.js
diff --git a/dist/settings-vue-settings-apps-users-management.js.map b/dist/settings-vue-settings-apps-users-management.js.map
diff --git a/lib/private/User/Manager.php b/lib/private/User/Manager.php
@@ -333,7 +333,7 @@ public function searchDisplayName($pattern, $limit = null, $offset = null) {
 	/**
 	 * @return IUser[]
 	 */
-	public function getDisabledUsers(?int $limit = null, int $offset = 0): array {
+	public function getDisabledUsers(?int $limit = null, int $offset = 0, string $search = ''): array {
 		$users = $this->config->getUsersForUserValue('core', 'enabled', 'false');
 		$users = array_combine(
 			$users,
@@ -342,14 +342,23 @@ public function getDisabledUsers(?int $limit = null, int $offset = 0): array {
 				$users
 			)
 		);
+		if ($search !== '') {
+			$users = array_filter(
+				$users,
+				fn (IUser $user): bool =>
+					mb_stripos($user->getUID(), $search) !== false ||
+					mb_stripos($user->getDisplayName(), $search) !== false ||
+					mb_stripos($user->getEMailAddress() ?? '', $search) !== false,
+			);
+		}
 
 		$tempLimit = ($limit === null ? null : $limit + $offset);
 		foreach ($this->backends as $backend) {
 			if (($tempLimit !== null) && (count($users) >= $tempLimit)) {
 				break;
 			}
 			if ($backend instanceof IProvideEnabledStateBackend) {
-				$backendUsers = $backend->getDisabledUserList(($tempLimit === null ? null : $tempLimit - count($users)));
+				$backendUsers = $backend->getDisabledUserList(($tempLimit === null ? null : $tempLimit - count($users)), 0, $search);
 				foreach ($backendUsers as $uid) {
 					$users[$uid] = new LazyUser($uid, $this, null, $backend);
 				}

diff --git a/lib/public/IUserManager.php b/lib/public/IUserManager.php
@@ -142,8 +142,9 @@ public function searchDisplayName($pattern, $limit = null, $offset = null);
 	/**
 	 * @return IUser[]
 	 * @since 28.0.0
+	 * @since 30.0.0 $search parameter added
 	 */
-	public function getDisabledUsers(?int $limit = null, int $offset = 0): array;
+	public function getDisabledUsers(?int $limit = null, int $offset = 0, string $search = ''): array;
 
 	/**
 	 * Search known users (from phonebook sync) by displayName

diff --git a/lib/public/User/Backend/IProvideEnabledStateBackend.php b/lib/public/User/Backend/IProvideEnabledStateBackend.php
@@ -49,8 +49,9 @@ public function setUserEnabled(string $uid, bool $enabled, callable $queryDataba
 	 * Get the list of disabled users, to merge with the ones disabled in database
 	 *
 	 * @since 28.0.0
+	 * @since 30.0.0 $search parameter added
 	 *
 	 * @return string[]
 	 */
-	public function getDisabledUserList(?int $limit = null, int $offset = 0): array;
+	public function getDisabledUserList(?int $limit = null, int $offset = 0, string $search = ''): array;
 }