Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
Next Next commit
Add new user filter to search.
Add regex to prevent filter collision in user-list page

Usage:
1. Type a string in the search bar
2. Add in:users to display only users in the search result
  • Loading branch information
sorbaugh authored and AndyScherzinger committed Oct 12, 2023
commit ab81cd1e1e0685952d2c1818160954cbbaa9fa6b
1 change: 1 addition & 0 deletions apps/settings/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
'OCA\\Settings\\Middleware\\SubadminMiddleware' => $baseDir . '/../lib/Middleware/SubadminMiddleware.php',
'OCA\\Settings\\Search\\AppSearch' => $baseDir . '/../lib/Search/AppSearch.php',
'OCA\\Settings\\Search\\SectionSearch' => $baseDir . '/../lib/Search/SectionSearch.php',
'OCA\\Settings\\Search\\UserSearch' => $baseDir . '/../lib/Search/UserSearch.php',
'OCA\\Settings\\Sections\\Admin\\Additional' => $baseDir . '/../lib/Sections/Admin/Additional.php',
'OCA\\Settings\\Sections\\Admin\\ArtificialIntelligence' => $baseDir . '/../lib/Sections/Admin/ArtificialIntelligence.php',
'OCA\\Settings\\Sections\\Admin\\Delegation' => $baseDir . '/../lib/Sections/Admin/Delegation.php',
Expand Down
1 change: 1 addition & 0 deletions apps/settings/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ class ComposerStaticInitSettings
'OCA\\Settings\\Middleware\\SubadminMiddleware' => __DIR__ . '/..' . '/../lib/Middleware/SubadminMiddleware.php',
'OCA\\Settings\\Search\\AppSearch' => __DIR__ . '/..' . '/../lib/Search/AppSearch.php',
'OCA\\Settings\\Search\\SectionSearch' => __DIR__ . '/..' . '/../lib/Search/SectionSearch.php',
'OCA\\Settings\\Search\\UserSearch' => __DIR__ . '/..' . '/../lib/Search/UserSearch.php',
'OCA\\Settings\\Sections\\Admin\\Additional' => __DIR__ . '/..' . '/../lib/Sections/Admin/Additional.php',
'OCA\\Settings\\Sections\\Admin\\ArtificialIntelligence' => __DIR__ . '/..' . '/../lib/Sections/Admin/ArtificialIntelligence.php',
'OCA\\Settings\\Sections\\Admin\\Delegation' => __DIR__ . '/..' . '/../lib/Sections/Admin/Delegation.php',
Expand Down
3 changes: 3 additions & 0 deletions apps/settings/lib/AppInfo/Application.php
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* @author Robin Appelman <[email protected]>
* @author Roeland Jago Douma <[email protected]>
* @author zulan <[email protected]>
* @author Stephan Orbaugh <[email protected]>
*
* @license AGPL-3.0
*
Expand Down Expand Up @@ -46,6 +47,7 @@
use OCA\Settings\Middleware\SubadminMiddleware;
use OCA\Settings\Search\AppSearch;
use OCA\Settings\Search\SectionSearch;
use OCA\Settings\Search\UserSearch;
use OCA\Settings\UserMigration\AccountMigrator;
use OCA\Settings\WellKnown\ChangePasswordHandler;
use OCA\Settings\WellKnown\SecurityTxtHandler;
Expand Down Expand Up @@ -78,6 +80,7 @@ public function register(IRegistrationContext $context): void {
$context->registerMiddleware(SubadminMiddleware::class);
$context->registerSearchProvider(SectionSearch::class);
$context->registerSearchProvider(AppSearch::class);
$context->registerSearchProvider(UserSearch::class);

// Register listeners
$context->registerEventListener(AppPasswordCreatedEvent::class, AppPasswordCreatedActivityListener::class);
Expand Down
137 changes: 137 additions & 0 deletions apps/settings/lib/Search/UserSearch.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
<?php

declare(strict_types=1);

/**
* @copyright Copyright (c) 2020 Joas Schilling <[email protected]>
*
* @author Stephan Orbaugh <[email protected]>
*
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\Settings\Search;

use OCP\Accounts\IAccountManager;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCS\OCSNotFoundException;
use OCP\IGroupManager;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\IUser;
use OCP\IUserManager;
use OCP\Search\IProvider;
use OCP\Search\ISearchQuery;
use OCP\Search\SearchResult;
use OCP\Search\SearchResultEntry;
use OCP\Settings\IIconSection;
use OCP\Settings\IManager;

class UserSearch implements IProvider {

/** @var IManager */
protected $settingsManager;

/** @var IGroupManager */
protected $groupManager;

/** @var IURLGenerator */
protected $urlGenerator;

/** @var IL10N */
protected $l;

/** @var IUserManager */
protected $userManager;

/** @var IAccountManager */
protected $accountManager;

public function __construct(IManager $settingsManager,
IGroupManager $groupManager,
IURLGenerator $urlGenerator,
IUserManager $userManager,
IAccountManager $accountManager,
IL10N $l) {
$this->settingsManager = $settingsManager;
$this->groupManager = $groupManager;
$this->urlGenerator = $urlGenerator;
$this->userManager = $userManager;
$this->accountManager = $accountManager;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe I am overseeing something, but they are all not being used?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cleaned this one up, thanks for pointing it out 👍

$this->l = $l;
}

/**
* @inheritDoc
*/
public function getId(): string {
return 'users';
}

/**
* @inheritDoc
*/
public function getName(): string {
return $this->l->t('Users');
}

/**
* @inheritDoc
*/
public function getOrder(string $route, array $routeParameters): int {
return 300;
}

/**
* @inheritDoc
*/
public function search(IUser $user, ISearchQuery $query): SearchResult {

$users = $this->userManager->search($query->getTerm(), $query->getLimit(), 0);

if (!$this->groupManager->isAdmin($user->getUID())) {
return SearchResult::complete(
$this->l->t('Users'),
[]
);
}

foreach ($users as $user) {
$targetUserObject = $this->userManager->get($user->getUid());

if ($targetUserObject === null) {
throw new OCSNotFoundException('User does not exist');
}

$userAccount = $this->accountManager->getAccount($targetUserObject);
$avatar = $userAccount->getProperty(IAccountManager::PROPERTY_AVATAR)->getScope();

$result[] = new SearchResultEntry(
'',
$targetUserObject->getDisplayName(),
$user->getUid(),
$this->urlGenerator->linkToRouteAbsolute('settings.Users.usersList'),
'icon-user-dark'
);
}

return SearchResult::complete(
$this->l->t('Users'),
$result
);
}
}
9 changes: 9 additions & 0 deletions apps/settings/src/store/users.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* @author Julius Härtl <[email protected]>
* @author Roeland Jago Douma <[email protected]>
* @author Vincent Petry <[email protected]>
* @author Stephan Orbaugh <[email protected]>
*
* @license AGPL-3.0-or-later
*
Expand Down Expand Up @@ -327,6 +328,14 @@ const actions = {
}
searchRequestCancelSource = CancelToken.source()
search = typeof search === 'string' ? search : ''

/**
* Adding filters in the search bar such as in:files, in:users, etc.
* collides with this particular search, so we need to remove them
* here and leave only the original search query
*/
search = search.replace(/in:[^\s]+/g, '').trim()

group = typeof group === 'string' ? group : ''
if (group !== '') {
return api.get(generateOcsUrl('cloud/groups/{group}/users/details?offset={offset}&limit={limit}&search={search}', { group: encodeURIComponent(group), offset, limit, search }), {
Expand Down
3 changes: 3 additions & 0 deletions dist/2196-2196.js

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions dist/523-523.js.LICENSE.txt → dist/2196-2196.js.LICENSE.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@
*
*/

/*! For license information please see NcDatetimePicker.js.LICENSE.txt */

/*! For license information please see NcInputField.js.LICENSE.txt */

/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

/**
Expand Down
1 change: 1 addition & 0 deletions dist/2196-2196.js.map

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions dist/2246-2246.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dist/2246-2246.js.map

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions dist/2323-2323.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dist/2323-2323.js.LICENSE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/*! For license information please see NcRichContenteditable.js.LICENSE.txt */
1 change: 1 addition & 0 deletions dist/2323-2323.js.map

Large diffs are not rendered by default.

2 changes: 0 additions & 2 deletions dist/3245-3245.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/3245-3245.js.map

This file was deleted.

2 changes: 2 additions & 0 deletions dist/3609-3609.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dist/3609-3609.js.map

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/50-50.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/50-50.js.map

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions dist/523-523.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/523-523.js.map

This file was deleted.

2 changes: 0 additions & 2 deletions dist/6318-6318.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/6318-6318.js.map

This file was deleted.

2 changes: 0 additions & 2 deletions dist/6678-6678.js

This file was deleted.

1 change: 0 additions & 1 deletion dist/6678-6678.js.map

This file was deleted.

2 changes: 2 additions & 0 deletions dist/6870-6870.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions dist/6870-6870.js.map

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/7816-7816.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/7816-7816.js.map

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/comments-comments-app.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/comments-comments-app.js.map

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/comments-init.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/comments-init.js.map

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dist/core-common.js

Large diffs are not rendered by default.

Loading