initial integration of Search Provider

Signed-off-by: Christian Hartmann <[email protected]>

Author: Chartman123

lib/Db/FormMapper.php

@@ -11,6 +11,8 @@
 use OCP\AppFramework\Db\QBMapper;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;
+use OCP\IUser;
+use OCP\Search\ISearchQuery;
 use OCP\Share\IShare;
 
 /**
@@ -180,6 +182,18 @@ public function findAllByOwnerId(string $ownerId): array {
 		return $this->findEntities($qb);
 	}
 
+	/**
+	 * @param IUser $user the user that performs the search
+	 * @param ISearchQuery $query the query to search the forms
+	 * @throws \OCP\AppFramework\Db\DoesNotExistException if not found
+	 * @return Form[] array of Forms
+	 */
+	public function search(IUser $user, ISearchQuery $query): array {
+		$qb = $this->db->getQueryBuilder();
+		// TODO: implement search for Query Builder
+		return $this->findEntities($qb);
+	}
+
 	/**
 	 * Delete a Form including connected Questions, Submissions and shares.
 	 * @param Form $form The form instance to delete

lib/Search/FormsSearchResultEntry.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Forms\Search;
+
+use OCA\Forms\Db\Form;
+use OCP\Search\SearchResultEntry;
+
+class FormsSearchResultEntry extends SearchResultEntry {
+	public function __construct(Form $form, string $formUrl) {
+		parent::__construct('', $form->getTitle(), $form->getDescription(), $formUrl, 'forms-dark');
+	}
+}

lib/Search/Provider.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Forms\Search;
+
+use OCA\Forms\AppInfo\Application;
+use OCA\Forms\Db\Form;
+use OCA\Forms\Service\FormsService;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\IUser;
+use OCP\Search\IProvider;
+use OCP\Search\ISearchQuery;
+use OCP\Search\SearchResult;
+
+class SearchProvider implements IProvider {
+	/**
+	 * @psalm-suppress PossiblyUnusedMethod
+	 */
+	public function __construct(
+		private IL10N $l10n,
+		private IURLGenerator $urlGenerator,
+		private FormsService $formsService,
+	) {
+	}
+
+	public function getId(): string {
+		return 'forms';
+	}
+
+	public function getName(): string {
+		return $this->l10n->t('Forms');
+	}
+
+	public function search(IUser $user, ISearchQuery $query): SearchResult {
+		$forms = $this->formsService->search($user, $query);
+
+		$results = array_map(function (Form $form) {
+			$formUrl = $this->urlGenerator->linkToRoute('forms.page.views', ['hash' => $form->getHash(), 'view' => 'submit']);
+			return [
+				'object' => $form,
+				'entry' => new FormsSearchResultEntry($form, $formUrl)
+			];
+		}, $forms);
+
+		$resultEntries = array_map(function (array $result) {
+			return $result['entry'];
+		}, $results);
+
+		return SearchResult::complete(
+			$this->l10n->t('Forms'),
+			$resultEntries
+		);
+	}
+
+	public function getOrder(string $route, array $routeParameters): int {
+		if (str_contains($route, Application::APP_ID)) {
+			// Active app, prefer my results
+			return -1;
+		}
+		return 77;
+	}
+}

lib/Service/FormsService.php

@@ -20,6 +20,7 @@
 use OCA\Forms\Events\FormSubmittedEvent;
 use OCP\AppFramework\Db\DoesNotExistException;
 use OCP\AppFramework\Db\IMapperException;
+use OCP\DB\Exception;
 use OCP\EventDispatcher\IEventDispatcher;
 use OCP\Files\IRootFolder;
 use OCP\Files\NotFoundException;
@@ -29,6 +30,7 @@
 use OCP\IUser;
 use OCP\IUserManager;
 use OCP\IUserSession;
+use OCP\Search\ISearchQuery;
 use OCP\Security\ISecureRandom;
 use OCP\Share\IShare;
 
@@ -698,6 +700,23 @@ public function areExtraSettingsValid(array $extraSettings, string $questionType
 		return true;
 	}
 
+	/**
+	 * Get list of forms
+	 *
+	 * @param IUser $user the user that performs the search
+	 * @param ISearchQuery $query the query to search the forms
+	 * @return array list of forms that match the query
+	 */
+	public function search(IUser $user, ISearchQuery $query): array {
+		$formsList = [];
+		try {
+			$formsList = $this->formMapper->search($user, $query);
+		} catch (DoesNotExistException $e) {
+			// silent catch
+		}
+		return $formsList;
+	}
+
 	public function getFilePath(Form $form): ?string {
 		$fileId = $form->getFileId();