Merge pull request #61156 from nextcloud/backport/60844/stable33

[stable33] feat(file-search): add property to SearchQuery and check select fields to decide wheter to join extended cache

Author: artonge

apps/dav/lib/Files/FileSearchBackend.php

@@ -342,6 +342,15 @@ private function transformQuery(Query $query, ?SearchBinaryOperator $scopeOperat
 			}
 		}, $query->orderBy);
 
+		$selectFields = [];
+		foreach ($query->select as $searchProperty) {
+			try {
+				$selectFields[] = $this->mapPropertyNameToColumn($searchProperty);
+			} catch (\InvalidArgumentException) {
+				// property does not represent a column on DB
+			}
+		}
+
 		$limit = $query->limit;
 		$maxResults = $limit->maxResults !== 0 ? (int)$limit->maxResults : 100;
 		$offset = $limit->firstResult;
@@ -375,7 +384,8 @@ private function transformQuery(Query $query, ?SearchBinaryOperator $scopeOperat
 			$offset,
 			$orders,
 			$this->user,
-			$limitHome
+			$limitHome,
+			$selectFields
 		);
 	}
 

lib/private/Files/Cache/QuerySearchHelper.php

@@ -150,13 +150,16 @@ public function searchInCaches(ISearchQuery $searchQuery, array $caches): array
 
 		$builder = $this->getQueryBuilder();
 
-		$requestedFields = $this->searchBuilder->extractRequestedFields($searchQuery->getSearchOperation());
-
-		$orderFields = array_map(fn ($order) => $order->getField(), $searchQuery->getOrder());
+		$requestedFields = array_merge(
+			$this->searchBuilder->extractRequestedFields($searchQuery->getSearchOperation()),
+			array_map(fn ($order) => $order->getField(), $searchQuery->getOrder()),
+			$searchQuery->getSelectFields(),
+		);
 
-		$joinExtendedCache = in_array('creation_time', $requestedFields)
+		$joinExtendedCache = in_array('metadata_etag', $requestedFields)
+			|| in_array('creation_time', $requestedFields)
 			|| in_array('upload_time', $requestedFields)
-			|| in_array('last_activity', $orderFields);
+			|| in_array('last_activity', $requestedFields);
 
 		$query = $builder->selectFileCache('file', $joinExtendedCache);
 

lib/private/Files/Search/SearchQuery.php

@@ -23,6 +23,8 @@ class SearchQuery implements ISearchQuery {
 	/** @var ?IUser */
 	private $user;
 	private $limitToHome;
+	/** @var array */
+	private $selectFields;
 
 	/**
 	 * SearchQuery constructor.
@@ -33,6 +35,7 @@ class SearchQuery implements ISearchQuery {
 	 * @param array $order
 	 * @param ?IUser $user
 	 * @param bool $limitToHome
+	 * @param list<string> $selectFields
 	 */
 	public function __construct(
 		ISearchOperator $searchOperation,
@@ -41,13 +44,15 @@ public function __construct(
 		array $order,
 		?IUser $user = null,
 		bool $limitToHome = false,
+		array $selectFields = [],
 	) {
 		$this->searchOperation = $searchOperation;
 		$this->limit = $limit;
 		$this->offset = $offset;
 		$this->order = $order;
 		$this->user = $user;
 		$this->limitToHome = $limitToHome;
+		$this->selectFields = $selectFields;
 	}
 
 	/**
@@ -88,4 +93,9 @@ public function getUser() {
 	public function limitToHome(): bool {
 		return $this->limitToHome;
 	}
+
+	#[\Override]
+	public function getSelectFields(): array {
+		return $this->selectFields;
+	}
 }

lib/public/Files/Search/ISearchQuery.php

@@ -57,4 +57,12 @@ public function getUser();
 	 * @since 18.0.0
 	 */
 	public function limitToHome(): bool;
+
+	/**
+	 * The fields to include in the search results
+	 *
+	 * @return list<string>
+	 * @since 33.0.6
+	 */
+	public function getSelectFields(): array;
 }