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

diff --git a/apps/settings/composer/composer/autoload_classmap.php b/apps/settings/composer/composer/autoload_classmap.php
index 32de1ff6d2a7e5e46126a23d5fc37753b7414a2b..56509947525ed2205efceb01f143542ee65a351a 100644 (file)
--- a/apps/settings/composer/composer/autoload_classmap.php
+++ b/apps/settings/composer/composer/autoload_classmap.php
@@ -41,6 +41,7 @@ return array(
     '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\\Delegation' => $baseDir . '/../lib/Sections/Admin/Delegation.php',
     'OCA\\Settings\\Sections\\Admin\\Groupware' => $baseDir . '/../lib/Sections/Admin/Groupware.php',

diff --git a/apps/settings/composer/composer/autoload_static.php b/apps/settings/composer/composer/autoload_static.php
index 57235766a7c5e10d336d5308c8830d6a1f887674..77605c7cd9df5df4bd94ddce42e7bf0df4bf167c 100644 (file)
--- a/apps/settings/composer/composer/autoload_static.php
+++ b/apps/settings/composer/composer/autoload_static.php
@@ -56,6 +56,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\\Delegation' => __DIR__ . '/..' . '/../lib/Sections/Admin/Delegation.php',
         'OCA\\Settings\\Sections\\Admin\\Groupware' => __DIR__ . '/..' . '/../lib/Sections/Admin/Groupware.php',

diff --git a/apps/settings/lib/AppInfo/Application.php b/apps/settings/lib/AppInfo/Application.php
index 8d99f7f4f8687d867d4e431183840800f1c88074..c69826f7842a5301868c4d43987bf6e8dbb33e48 100644 (file)
--- a/apps/settings/lib/AppInfo/Application.php
+++ b/apps/settings/lib/AppInfo/Application.php
@@ -15,6 +15,7 @@ declare(strict_types=1);
  * @author Robin Appelman <robin@icewind.nl>
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  * @author zulan <git@zulan.net>
+ * @author Stephan Orbaugh <stephan.orbaugh@nextcloud.com>
  *
  * @license AGPL-3.0
  *
@@ -46,6 +47,7 @@ use OCA\Settings\Mailer\NewUserMailHelper;
 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;
@@ -78,6 +80,7 @@ class Application extends App implements IBootstrap {
                $context->registerMiddleware(SubadminMiddleware::class);
                $context->registerSearchProvider(SectionSearch::class);
                $context->registerSearchProvider(AppSearch::class);
+               $context->registerSearchProvider(UserSearch::class);
 
                // Register listeners
                $context->registerEventListener(AppPasswordCreatedEvent::class, AppPasswordCreatedActivityListener::class);

diff --git a/apps/settings/lib/Search/UserSearch.php b/apps/settings/lib/Search/UserSearch.php
new file mode 100644 (file)
index 0000000..181d855
--- /dev/null
+++ b/apps/settings/lib/Search/UserSearch.php
@@ -0,0 +1,137 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2020 Joas Schilling <coding@schilljs.com>
+ *
+ * @author Stephan Orbaugh <stephan.orbaugh@nextcloud.com>
+ *
+ *
+ * @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;
+               $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
+               );
+       }
+}

diff --git a/apps/settings/src/store/users.js b/apps/settings/src/store/users.js
index e89e5e968dacfb8dd3b0127650c406b7b2ebea68..5391cbe1746e6eead4026220ce0a0a3c2289ed6d 100644 (file)
--- a/apps/settings/src/store/users.js
+++ b/apps/settings/src/store/users.js
@@ -8,6 +8,7 @@
  * @author Julius Härtl <jus@bitgrid.net>
  * @author Roeland Jago Douma <roeland@famdouma.nl>
  * @author Vincent Petry <vincent@nextcloud.com>
+ * @author Stephan Orbaugh <stephan.orbaugh@nextcloud.com>
  *
  * @license AGPL-3.0-or-later
  *
@@ -270,6 +271,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 }), {