Skip to content

Patch: search disabled users by display name or email #999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
janepie wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Patch: search disabled users by display name or email #999

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 80 additions & 16 deletions lib/GroupBackend.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

namespace OCA\User_SAML;

use OC\User\LazyUser;
use OCP\DB\Exception;
use OCP\Group\Backend\ABackend;
use OCP\Group\Backend\IAddToGroupBackend;
Expand All @@ -16,19 +17,24 @@
use OCP\Group\Backend\IGetDisplayNameBackend;
use OCP\Group\Backend\INamedBackend;
use OCP\Group\Backend\IRemoveFromGroupBackend;
use OCP\Group\Backend\ISearchableGroupBackend;
use OCP\Group\Backend\ISetDisplayNameBackend;
use OCP\IDBConnection;
use OCP\IUserManager;
use OCP\Server;
use PDO;
use Psr\Log\LoggerInterface;

class GroupBackend extends ABackend implements IAddToGroupBackend, ICountUsersBackend, ICreateGroupBackend, IDeleteGroupBackend, IGetDisplayNameBackend, IRemoveFromGroupBackend, ISetDisplayNameBackend, INamedBackend {
class GroupBackend extends ABackend implements IAddToGroupBackend, ICountUsersBackend, ICreateGroupBackend, IDeleteGroupBackend, IGetDisplayNameBackend, IRemoveFromGroupBackend, ISetDisplayNameBackend, INamedBackend, ISearchableGroupBackend {

/** @var array */
private $groupCache = [];

public const TABLE_GROUPS = 'user_saml_groups';
public const TABLE_MEMBERS = 'user_saml_group_members';

private ?IUserManager $userManager = null;

public function __construct(
protected IDBConnection $dbc,
protected LoggerInterface $logger,
Expand Down Expand Up @@ -152,16 +158,45 @@
* @return array<int,string> User ids
*/
public function usersInGroup($gid, $search = '', $limit = -1, $offset = 0): array {
return array_values(array_map(
static fn ($user) => $user->getUID(),
$this->searchInGroup($gid, $search, $limit, $offset)
));
}

/**
* @return array<string,\OCP\IUser>

Check failure on line 168 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-master

InvalidReturnType 

lib/GroupBackend.php:168:13: InvalidReturnType: The declared return type 'array<string, OCP\IUser>' for OCA\User_SAML\GroupBackend::searchInGroup is incorrect, got 'array<array-key, OC\User\LazyUser>' (see https://psalm.dev/011)

Check failure on line 168 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable32

InvalidReturnType 

lib/GroupBackend.php:168:13: InvalidReturnType: The declared return type 'array<string, OCP\IUser>' for OCA\User_SAML\GroupBackend::searchInGroup is incorrect, got 'array<array-key, OC\User\LazyUser>' (see https://psalm.dev/011)

Check failure on line 168 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable30

InvalidReturnType 

lib/GroupBackend.php:168:13: InvalidReturnType: The declared return type 'array<string, OCP\IUser>' for OCA\User_SAML\GroupBackend::searchInGroup is incorrect, got 'array<array-key, OC\User\LazyUser>' (see https://psalm.dev/011)

Check failure on line 168 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable31

InvalidReturnType 

lib/GroupBackend.php:168:13: InvalidReturnType: The declared return type 'array<string, OCP\IUser>' for OCA\User_SAML\GroupBackend::searchInGroup is incorrect, got 'array<array-key, OC\User\LazyUser>' (see https://psalm.dev/011)
*/
public function searchInGroup(string $gid, string $search = '', int $limit = -1, int $offset = 0): array {
$query = $this->dbc->getQueryBuilder();
$query->select('uid')
->from(self::TABLE_MEMBERS)
->where($query->expr()->eq('gid', $query->createNamedParameter($gid)))
->orderBy('uid', 'ASC');
$query->select('m.uid', 'dn.value AS displayname')
->from(self::TABLE_MEMBERS, 'm')
->leftJoin('m', 'accounts_data', 'dn',
$query->expr()->andX(
$query->expr()->eq('dn.uid', 'm.uid'),
$query->expr()->eq('dn.name', $query->createNamedParameter('displayname'))
)
)
->leftJoin('m', 'accounts_data', 'em',
$query->expr()->andX(
$query->expr()->eq('em.uid', 'm.uid'),
$query->expr()->eq('em.name', $query->createNamedParameter('email'))
)
)
->where($query->expr()->eq('m.gid', $query->createNamedParameter($gid)))
->orderBy('m.uid', 'ASC');

if ($search !== '') {
$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
'%' . $this->dbc->escapeLikeParameter($search) . '%'
)));
$searchParam1 = $query->createNamedParameter('%' . $this->dbc->escapeLikeParameter($search) . '%');
$searchParam2 = $query->createNamedParameter('%' . $this->dbc->escapeLikeParameter($search) . '%');
$searchParam3 = $query->createNamedParameter('%' . $this->dbc->escapeLikeParameter($search) . '%');
$query->andWhere(
$query->expr()->orX(
$query->expr()->ilike('m.uid', $searchParam1),
$query->expr()->ilike('dn.value', $searchParam2),
$query->expr()->ilike('em.value', $searchParam3)
)
);
}

if ($limit !== -1) {
Expand All @@ -172,14 +207,14 @@
}

$result = $query->executeQuery();

$users = [];
$userManager = $this->getUserManager();
while ($row = $result->fetch()) {
$users[] = $row['uid'];
$users[$row['uid']] = new LazyUser($row['uid'], $userManager, $row['displayname'] ?? null);

Check failure on line 213 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-master

UndefinedClass 

lib/GroupBackend.php:213:30: UndefinedClass: Class, interface or enum named OC\User\LazyUser does not exist (see https://psalm.dev/019)

Check failure on line 213 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable32

UndefinedClass 

lib/GroupBackend.php:213:30: UndefinedClass: Class, interface or enum named OC\User\LazyUser does not exist (see https://psalm.dev/019)

Check failure on line 213 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable30

UndefinedClass 

lib/GroupBackend.php:213:30: UndefinedClass: Class, interface or enum named OC\User\LazyUser does not exist (see https://psalm.dev/019)

Check failure on line 213 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable31

UndefinedClass 

lib/GroupBackend.php:213:30: UndefinedClass: Class, interface or enum named OC\User\LazyUser does not exist (see https://psalm.dev/019)
}
$result->closeCursor();

return $users;

Check failure on line 217 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-master

InvalidReturnStatement 

lib/GroupBackend.php:217:10: InvalidReturnStatement: The inferred type 'array<array-key, OC\User\LazyUser>' does not match the declared return type 'array<string, OCP\IUser>' for OCA\User_SAML\GroupBackend::searchInGroup (see https://psalm.dev/128)

Check failure on line 217 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable32

InvalidReturnStatement 

lib/GroupBackend.php:217:10: InvalidReturnStatement: The inferred type 'array<array-key, OC\User\LazyUser>' does not match the declared return type 'array<string, OCP\IUser>' for OCA\User_SAML\GroupBackend::searchInGroup (see https://psalm.dev/128)

Check failure on line 217 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable30

InvalidReturnStatement 

lib/GroupBackend.php:217:10: InvalidReturnStatement: The inferred type 'array<array-key, OC\User\LazyUser>' does not match the declared return type 'array<string, OCP\IUser>' for OCA\User_SAML\GroupBackend::searchInGroup (see https://psalm.dev/128)

Check failure on line 217 in lib/GroupBackend.php

View workflow job for this annotation

GitHub Actions / static-psalm-analysis dev-stable31

InvalidReturnStatement 

lib/GroupBackend.php:217:10: InvalidReturnStatement: The inferred type 'array<array-key, OC\User\LazyUser>' does not match the declared return type 'array<string, OCP\IUser>' for OCA\User_SAML\GroupBackend::searchInGroup (see https://psalm.dev/128)
}

public function createGroup(string $gid, ?string $samlGid = null): bool {
Expand Down Expand Up @@ -238,14 +273,36 @@

public function countUsersInGroup(string $gid, string $search = ''): int {
$query = $this->dbc->getQueryBuilder();
$query->select($query->func()->count('*', 'num_users'))
->from(self::TABLE_MEMBERS)
->where($query->expr()->eq('gid', $query->createNamedParameter($gid)));
$query->select(
$query->createFunction('COUNT(DISTINCT ' . $query->getColumnName('uid', 'm') . ')')
)
->from(self::TABLE_MEMBERS, 'm')
->where($query->expr()->eq('m.gid', $query->createNamedParameter($gid)));

if ($search !== '') {
$query->andWhere($query->expr()->like('uid', $query->createNamedParameter(
'%' . $this->dbc->escapeLikeParameter($search) . '%'
)));
$query->leftJoin('m', 'accounts_data', 'dn',
$query->expr()->andX(
$query->expr()->eq('dn.uid', 'm.uid'),
$query->expr()->eq('dn.name', $query->createNamedParameter('displayname'))
)
);
$query->leftJoin('m', 'accounts_data', 'em',
$query->expr()->andX(
$query->expr()->eq('em.uid', 'm.uid'),
$query->expr()->eq('em.name', $query->createNamedParameter('email'))
)
);

$searchParam1 = $query->createNamedParameter('%' . $this->dbc->escapeLikeParameter($search) . '%');
$searchParam2 = $query->createNamedParameter('%' . $this->dbc->escapeLikeParameter($search) . '%');
$searchParam3 = $query->createNamedParameter('%' . $this->dbc->escapeLikeParameter($search) . '%');
$query->andWhere(
$query->expr()->orX(
$query->expr()->ilike('m.uid', $searchParam1),
$query->expr()->ilike('dn.value', $searchParam2),
$query->expr()->ilike('em.value', $searchParam3)
)
);
}

$result = $query->executeQuery();
Expand Down Expand Up @@ -321,4 +378,11 @@

return $isUpdated;
}

private function getUserManager(): IUserManager {
if ($this->userManager === null) {
$this->userManager = Server::get(IUserManager::class);
}
return $this->userManager;
}
}
Loading