[stable31] feat: unified search

lib/AppInfo/Application.php

@@ -27,6 +27,7 @@
 use OCA\Libresign\Middleware\GlobalInjectionMiddleware;
 use OCA\Libresign\Middleware\InjectionMiddleware;
 use OCA\Libresign\Notification\Notifier;
+use OCA\Libresign\Search\FileSearchProvider;
 use OCP\AppFramework\App;
 use OCP\AppFramework\Bootstrap\IBootContext;
 use OCP\AppFramework\Bootstrap\IBootstrap;
@@ -55,6 +56,8 @@ public function register(IRegistrationContext $context): void {
 
 		$context->registerNotifierService(Notifier::class);
 
+		$context->registerSearchProvider(FileSearchProvider::class);
+
 		$context->registerEventListener(LoadSidebar::class, TemplateLoader::class);
 		$context->registerEventListener(BeforeNodeDeletedEvent::class, BeforeNodeDeletedListener::class);
 		$context->registerEventListener(CacheEntryRemovedEvent::class, BeforeNodeDeletedListener::class);

lib/Db/SignRequestMapper.php

@@ -459,6 +459,38 @@ public function getFilesAssociatedFilesWithMe(
 		];
 	}
 
+	public function getFilesToSearchProvider(IUser $user, string $fileName, int $limit, int $offset): array {
+		$filter = [
+			'page' => ($offset / $limit) + 1,
+			'length' => $limit,
+			'fileName' => $fileName,
+		];
+
+		$sort = [
+			'sortBy' => 'created_at',
+			'sortDirection' => 'desc',
+		];
+
+		$qb = $this->getFilesAssociatedFilesWithMeQueryBuilder($user->getUID(), $filter, false, $sort);
+
+		$result = $qb->executeQuery();
+		$files = [];
+
+		while ($row = $result->fetch()) {
+			try {
+				$file = File::fromRow($row);
+
+				$files[] = $file;
+			} catch (\Exception $e) {
+				continue;
+			}
+		}
+
+		$result->closeCursor();
+
+		return $files;
+	}
+
 	/**
 	 * @param array<SignRequest> $signRequests
 	 * @return FileElement[][]
@@ -532,7 +564,12 @@ public function getMyLibresignFile(string $userId, ?array $filter = []): File {
 		return $file->fromRow($row);
 	}
 
-	private function getFilesAssociatedFilesWithMeQueryBuilder(string $userId, array $filter = [], bool $count = false): IQueryBuilder {
+	private function getFilesAssociatedFilesWithMeQueryBuilder(
+		string $userId,
+		array $filter = [],
+		bool $count = false,
+		array $sort = [],
+	): IQueryBuilder {
 		$qb = $this->db->getQueryBuilder();
 		$qb->from('libresign_file', 'f')
 			->leftJoin('f', 'libresign_sign_request', 'sr', 'sr.file_id = f.id')
@@ -643,26 +680,21 @@ private function getFilesAssociatedFilesWithMeQueryBuilder(string $userId, array
 					$qb->expr()->lte('f.created_at', $qb->createNamedParameter($end, IQueryBuilder::PARAM_STR))
 				);
 			}
+			if (!empty($filter['fileName'])) {
+				$qb->andWhere(
+					$qb->expr()->like('f.name', $qb->createNamedParameter('%' . $this->db->escapeLikeParameter($filter['fileName']) . '%'))
+				);
+			}
 			if (!empty($filter['parentFileId'])) {
 				$qb->andWhere(
 					$qb->expr()->eq('f.parent_file_id', $qb->createNamedParameter($filter['parentFileId'], IQueryBuilder::PARAM_INT))
 				);
 			} else {
 				$qb->andWhere($qb->expr()->isNull('f.parent_file_id'));
 			}
-		} else {
-			$qb->andWhere($qb->expr()->isNull('f.parent_file_id'));
 		}
-		return $qb;
-	}
 
-	private function getFilesAssociatedFilesWithMeStmt(
-		string $userId,
-		?array $filter = [],
-		?array $sort = [],
-	): Pagination {
-		$qb = $this->getFilesAssociatedFilesWithMeQueryBuilder($userId, $filter);
-		if (!empty($sort['sortBy'])) {
+		if (!empty($sort['sortBy']) && !empty($sort['sortDirection'])) {
 			switch ($sort['sortBy']) {
 				case 'name':
 				case 'status':
@@ -679,6 +711,16 @@ private function getFilesAssociatedFilesWithMeStmt(
 			}
 		}
 
+		return $qb;
+	}
+
+	private function getFilesAssociatedFilesWithMeStmt(
+		string $userId,
+		?array $filter = [],
+		?array $sort = [],
+	): Pagination {
+		$qb = $this->getFilesAssociatedFilesWithMeQueryBuilder($userId, $filter, false, $sort);
+
 		$countQb = $this->getFilesAssociatedFilesWithMeQueryBuilder(
 			userId: $userId,
 			filter: $filter,

lib/Search/FileSearchProvider.php

@@ -0,0 +1,140 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 LibreCode coop and contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Libresign\Search;
+
+use OCA\Libresign\AppInfo\Application;
+use OCA\Libresign\Db\File;
+use OCA\Libresign\Db\SignRequestMapper;
+use OCP\App\IAppManager;
+use OCP\Files\IMimeTypeDetector;
+use OCP\Files\IRootFolder;
+use OCP\IL10N;
+use OCP\IURLGenerator;
+use OCP\IUser;
+use OCP\Search\IProvider;
+use OCP\Search\ISearchQuery;
+use OCP\Search\SearchResult;
+use OCP\Search\SearchResultEntry;
+
+class FileSearchProvider implements IProvider {
+	public function __construct(
+		private IL10N $l10n,
+		private IURLGenerator $urlGenerator,
+		private IRootFolder $rootFolder,
+		private IAppManager $appManager,
+		private IMimeTypeDetector $mimeTypeDetector,
+		private SignRequestMapper $fileMapper,
+	) {
+	}
+
+	#[\Override]
+	public function getId(): string {
+		return 'libresign_files';
+	}
+
+	#[\Override]
+	public function getName(): string {
+		return $this->l10n->t('LibreSign documents');
+	}
+
+	#[\Override]
+	public function getOrder(string $route, array $routeParameters): int {
+		if (strpos($route, Application::APP_ID . '.') === 0) {
+			return 0;
+		}
+		return 10;
+	}
+
+	#[\Override]
+	public function search(IUser $user, ISearchQuery $query): SearchResult {
+		if (!$this->appManager->isEnabledForUser(Application::APP_ID, $user)) {
+			return SearchResult::complete($this->l10n->t('LibreSign documents'), []);
+		}
+
+		$term = $query->getTerm();
+		$limit = $query->getLimit();
+		$offset = $query->getCursor();
+
+		try {
+			$files = $this->fileMapper->getFilesToSearchProvider($user, $term, $limit, (int)$offset);
+		} catch (\Exception $e) {
+			return SearchResult::complete($this->l10n->t('LibreSign documents'), []);
+		}
+
+		$results = array_map(function (File $file) use ($user) {
+			return $this->formatResult($file, $user);
+		}, $files);
+
+		return SearchResult::paginated(
+			$this->l10n->t('LibreSign documents'),
+			$results,
+			$offset + $limit
+		);
+	}
+
+	private function formatResult(File $file): SearchResultEntry {
+		$userFolder = $this->rootFolder->getUserFolder($file->getUserId());
+		$thumbnailUrl = '';
+		$subline = '';
+		$icon = '';
+		$path = '';
+
+		try {
+			$nodes = $userFolder->getById($file->getNodeId());
+			if (!empty($nodes)) {
+				$node = array_shift($nodes);
+
+				$icon = $this->mimeTypeDetector->mimeTypeIcon($node->getMimetype());
+
+				$thumbnailUrl = $this->urlGenerator->linkToRouteAbsolute(
+					'core.Preview.getPreviewByFileId',
+					[
+						'x' => 32,
+						'y' => 32,
+						'fileId' => $node->getId()
+					]
+				);
+
+				$path = $userFolder->getRelativePath($node->getPath());
+				$subline = $this->formatSubline($path);
+			}
+		} catch (\Exception $e) {
+		}
+
+		$link = $this->urlGenerator->linkToRoute(
+			'files.View.showFile',
+			['fileid' => $file->getNodeId()]
+		);
+
+		$searchResultEntry = new SearchResultEntry(
+			$thumbnailUrl,
+			$file->getName(),
+			$subline,
+			$this->urlGenerator->getAbsoluteURL($link),
+			$icon,
+		);
+
+		$searchResultEntry->addAttribute('fileId', (string)$file->getNodeId());
+		$searchResultEntry->addAttribute('path', $path);
+
+		return $searchResultEntry;
+	}
+
+	private function formatSubline(string $path): string {
+		if (strrpos($path, '/') > 0) {
+			$path = ltrim(dirname($path), '/');
+			// TRANSLATORS This string indicates the location of a file in a given path.
+			return $this->l10n->t('in %s', [$path]);
+		} else {
+			return '';
+		}
+	}
+
+}