multi-metadata order

Signed-off-by: Maxence Lange <[email protected]>

apps/dav/lib/Connector/Sabre/FilesPlugin.php

@@ -84,6 +84,7 @@ class FilesPlugin extends ServerPlugin {
 	public const SHARE_NOTE = '{http://nextcloud.org/ns}note';
 	public const SUBFOLDER_COUNT_PROPERTYNAME = '{http://nextcloud.org/ns}contained-folder-count';
 	public const SUBFILE_COUNT_PROPERTYNAME = '{http://nextcloud.org/ns}contained-file-count';
+	public const FILE_METADATA_PREFIX = '{http://nextcloud.org/ns}metadata-';
 	public const FILE_METADATA_SIZE = '{http://nextcloud.org/ns}file-metadata-size';
 	public const FILE_METADATA_GPS = '{http://nextcloud.org/ns}file-metadata-gps';
 

apps/dav/lib/Files/FileSearchBackend.php

@@ -42,6 +42,8 @@
 use OCP\Files\Search\ISearchOperator;
 use OCP\Files\Search\ISearchOrder;
 use OCP\Files\Search\ISearchQuery;
+use OCP\FilesMetadata\IFilesMetadataManager;
+use OCP\FilesMetadata\Model\IMetadataValueWrapper;
 use OCP\IUser;
 use OCP\Share\IManager;
 use Sabre\DAV\Exception\NotFound;
@@ -57,37 +59,14 @@
 class FileSearchBackend implements ISearchBackend {
 	public const OPERATOR_LIMIT = 100;
 
-	/** @var CachingTree */
-	private $tree;
-
-	/** @var IUser */
-	private $user;
-
-	/** @var IRootFolder */
-	private $rootFolder;
-
-	/** @var IManager */
-	private $shareManager;
-
-	/** @var View */
-	private $view;
-
-	/**
-	 * FileSearchBackend constructor.
-	 *
-	 * @param CachingTree $tree
-	 * @param IUser $user
-	 * @param IRootFolder $rootFolder
-	 * @param IManager $shareManager
-	 * @param View $view
-	 * @internal param IRootFolder $rootFolder
-	 */
-	public function __construct(CachingTree $tree, IUser $user, IRootFolder $rootFolder, IManager $shareManager, View $view) {
-		$this->tree = $tree;
-		$this->user = $user;
-		$this->rootFolder = $rootFolder;
-		$this->shareManager = $shareManager;
-		$this->view = $view;
+	public function __construct(
+		private CachingTree $tree,
+		private IUser $user,
+		private IRootFolder $rootFolder,
+		private IManager $shareManager,
+		private View $view,
+		private IFilesMetadataManager $filesMetadataManager,
+	) {
 	}
 
 	/**
@@ -115,7 +94,7 @@ public function getPropertyDefinitionsForScope(string $href, ?string $path): arr
 		// all valid scopes support the same schema
 
 		//todo dynamically load all propfind properties that are supported
-		return [
+		$props = [
 			// queryable properties
 			new SearchPropertyDefinition('{DAV:}displayname', true, true, true),
 			new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true),
@@ -137,6 +116,33 @@ public function getPropertyDefinitionsForScope(string $href, ?string $path): arr
 			new SearchPropertyDefinition(FilesPlugin::FILE_METADATA_SIZE, true, false, false, SearchPropertyDefinition::DATATYPE_STRING),
 			new SearchPropertyDefinition(FilesPlugin::FILEID_PROPERTYNAME, true, false, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
 		];
+
+		return array_merge($props, $this->getPropertyDefinitionsForMetadata());
+	}
+
+
+	private function getPropertyDefinitionsForMetadata(): array {
+		$metadataProps = [];
+		$metadata = $this->filesMetadataManager->getAllMetadata();
+		$indexes = $metadata->getIndexes();
+		foreach ($metadata->getKeys() as $key) {
+			$isIndex = in_array($key, $indexes);
+			$type = match ($metadata->getType($key)) {
+				IMetadataValueWrapper::TYPE_INT => SearchPropertyDefinition::DATATYPE_INTEGER,
+				IMetadataValueWrapper::TYPE_FLOAT => SearchPropertyDefinition::DATATYPE_DECIMAL,
+				IMetadataValueWrapper::TYPE_BOOL => SearchPropertyDefinition::DATATYPE_BOOLEAN,
+				default => SearchPropertyDefinition::DATATYPE_STRING
+			};
+			$metadataProps[] = new SearchPropertyDefinition(
+				FilesPlugin::FILE_METADATA_PREFIX . $key,
+				true,
+				$isIndex,
+				$isIndex,
+				$type
+			);
+		}
+
+		return $metadataProps;
 	}
 
 	/**
@@ -300,11 +306,20 @@ private function getHrefForNode(Node $node) {
 
 	/**
 	 * @param Query $query
+	 *
 	 * @return ISearchQuery
 	 */
 	private function transformQuery(Query $query): ISearchQuery {
+		$orders = array_map(function (Order $order): ISearchOrder {
+			$direction = $order->order === Order::ASC ? ISearchOrder::DIRECTION_ASCENDING : ISearchOrder::DIRECTION_DESCENDING;
+			if (str_starts_with($order->property->name, FilesPlugin::FILE_METADATA_PREFIX)) {
+				return new SearchOrder($direction, substr($order->property->name, strlen(FilesPlugin::FILE_METADATA_PREFIX)),  'metadata');
+			} else {
+				return new SearchOrder($direction, $this->mapPropertyNameToColumn($order->property));
+			}
+		}, $query->orderBy);
+
 		$limit = $query->limit;
-		$orders = array_map([$this, 'mapSearchOrder'], $query->orderBy);
 		$offset = $limit->firstResult;
 
 		$limitHome = false;
@@ -352,14 +367,6 @@ private function countSearchOperators(Operator $operator): int {
 		}
 	}
 
-	/**
-	 * @param Order $order
-	 * @return ISearchOrder
-	 */
-	private function mapSearchOrder(Order $order) {
-		return new SearchOrder($order->order === Order::ASC ? ISearchOrder::DIRECTION_ASCENDING : ISearchOrder::DIRECTION_DESCENDING, $this->mapPropertyNameToColumn($order->property));
-	}
-
 	/**
 	 * @param Operator $operator
 	 * @return ISearchOperator
@@ -387,7 +394,17 @@ private function transformSearchOperation(Operator $operator) {
 				if (!($operator->arguments[1] instanceof Literal)) {
 					throw new \InvalidArgumentException('Invalid argument 2 for ' . $trimmedType . ' operation, expected literal');
 				}
-				return new SearchComparison($trimmedType, $this->mapPropertyNameToColumn($operator->arguments[0]), $this->castValue($operator->arguments[0], $operator->arguments[1]->value));
+
+				$property = $operator->arguments[0];
+				$value = $this->castValue($property, $operator->arguments[1]->value);
+				if (str_starts_with($property->name, FilesPlugin::FILE_METADATA_PREFIX)) {
+//				return new SearchComparison($trimmedType, substr($order->property->name, strlen(FilesPlugin::FILE_METADATA_PREFIX)), $value, 'metadata');
+					return new SearchComparison($trimmedType, 'photo-taken', $value, 'metadata');
+				} else {
+					return new SearchComparison($trimmedType, $this->mapPropertyNameToColumn($property), $value);
+				}
+
+				// no break
 			case Operator::OPERATION_IS_COLLECTION:
 				return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE);
 			default:

apps/dav/lib/Server.php

@@ -76,6 +76,7 @@
 use OCP\AppFramework\Http\Response;
 use OCP\Diagnostics\IEventLogger;
 use OCP\EventDispatcher\IEventDispatcher;
+use OCP\FilesMetadata\IFilesMetadataManager;
 use OCP\ICacheFactory;
 use OCP\IRequest;
 use OCP\Profiler\IProfiler;
@@ -316,7 +317,8 @@ public function __construct(IRequest $request, string $baseUri) {
 						$user,
 						\OC::$server->getRootFolder(),
 						\OC::$server->getShareManager(),
-						$view
+						$view,
+						\OCP\Server::get(IFilesMetadataManager::class)
 					));
 					$this->server->addPlugin(
 						new BulkUploadPlugin(

lib/private/Files/Cache/QuerySearchHelper.php

@@ -140,23 +140,14 @@ protected function equipQueryForMetadata(CacheQueryBuilder $query, ISearchQuery
 		$metadataQuery = $this->filesMetadataManager->getMetadataQuery($query, 'file', 'fileid');
 		$metadataQuery->retrieveMetadata();
 
-		$order = $searchQuery->getOrder();
-		if ($order) {
-			foreach ($order as $orderField) {
-				$field = $orderField->getField();
-				if (!str_starts_with($field, 'metakey_')) {
-					continue;
-				}
-				$metadataQuery->joinIndex(substr($field, 8));
-				$query->orderBy($metadataQuery->getMetadataValueIntField(), $orderField->getDirection());
+		foreach ($searchQuery->getOrder() as $order) {
+			if ($order->getExtra() !== 'metadata') {
+				continue; // only metadata search order are managed here.
 			}
-		}
 
-		// TODO: add filter on metadatakey / metadatavalue
-		// is it possible to get information from the webdav request ?
-		// $expr = $query->expr();
-		// $query->andWhere($expr->eq($metadataQuery->getMetadataKeyField(), $query->createNamedParameter('my_key')));
-		// $query->andWhere($expr->eq($metadataQuery->getMetadataValueField(), $query->createNamedParameter('my_value')));
+			$alias = $metadataQuery->joinIndex($order->getField());
+			$query->addOrderBy($metadataQuery->getMetadataValueIntField($alias), $order->getDirection());
+		}
 
 		return $metadataQuery;
 	}

lib/private/Files/Cache/SearchBuilder.php

@@ -76,7 +76,7 @@ public function extractRequestedFields(ISearchOperator $operator): array {
 			return array_reduce($operator->getArguments(), function (array $fields, ISearchOperator $operator) {
 				return array_unique(array_merge($fields, $this->extractRequestedFields($operator)));
 			}, []);
-		} elseif ($operator instanceof ISearchComparison) {
+		} elseif ($operator instanceof ISearchComparison && !$operator->isExtra()) {
 			return [$operator->getField()];
 		}
 		return [];
@@ -124,6 +124,10 @@ public function searchOperatorToDBExpr(IQueryBuilder $builder, ISearchOperator $
 	}
 
 	private function searchComparisonToDBExpr(IQueryBuilder $builder, ISearchComparison $comparison, array $operatorMap) {
+		if ($comparison->isExtra()) {
+			return null;
+		}
+
 		$this->validateComparison($comparison);
 
 		[$field, $value, $type] = $this->getOperatorFieldAndValue($comparison);
@@ -231,6 +235,9 @@ private function getParameterForValue(IQueryBuilder $builder, $value) {
 	 */
 	public function addSearchOrdersToQuery(IQueryBuilder $query, array $orders) {
 		foreach ($orders as $order) {
+			if ($order->isExtra()) {
+				continue; // extra search orders are managed elsewhere
+			}
 			$field = $order->getField();
 			if ($field === 'fileid') {
 				$field = 'file.fileid';

lib/private/Files/Search/QueryOptimizer/PathPrefixOptimizer.php

@@ -48,7 +48,7 @@ public function inspectOperator(ISearchOperator $operator): void {
 	}
 
 	public function processOperator(ISearchOperator &$operator) {
-		if (!$this->useHashEq && $operator instanceof ISearchComparison && $operator->getField() === 'path' && $operator->getType() === ISearchComparison::COMPARE_EQUAL) {
+		if (!$this->useHashEq && $operator instanceof ISearchComparison && !$operator->isExtra() && $operator->getField() === 'path' && $operator->getType() === ISearchComparison::COMPARE_EQUAL) {
 			$operator->setQueryHint(ISearchComparison::HINT_PATH_EQ_HASH, false);
 		}
 
@@ -69,7 +69,7 @@ private function isPathPrefixOperator(ISearchOperator $operator): bool {
 	private function operatorPairIsPathPrefix(ISearchOperator $like, ISearchOperator $equal): bool {
 		return (
 			$like instanceof ISearchComparison && $equal instanceof ISearchComparison &&
-			$like->getField() === 'path' && $equal->getField() === 'path' &&
+			!$like->isExtra() && !$equal->isExtra() && $like->getField() === 'path' && $equal->getField() === 'path' &&
 			$like->getType() === ISearchComparison::COMPARE_LIKE_CASE_SENSITIVE && $equal->getType() === ISearchComparison::COMPARE_EQUAL
 			&& $like->getValue() === SearchComparison::escapeLikeParameter($equal->getValue()) . '/%'
 		);

lib/private/Files/Search/SearchComparison.php

@@ -25,25 +25,15 @@
 use OCP\Files\Search\ISearchComparison;
 
 class SearchComparison implements ISearchComparison {
-	/** @var string */
-	private $type;
-	/** @var string */
-	private $field;
-	/** @var string|integer|\DateTime */
-	private $value;
-	private $hints = [];
+	private array $hints = [];
 
-	/**
-	 * SearchComparison constructor.
-	 *
-	 * @param string $type
-	 * @param string $field
-	 * @param \DateTime|int|string $value
-	 */
-	public function __construct($type, $field, $value) {
-		$this->type = $type;
-		$this->field = $field;
-		$this->value = $value;
+
+	public function __construct(
+		private string $type,
+		private string $field,
+		private \DateTime|int|string $value,
+		private string $extra = ''
+	) {
 	}
 
 	/**
@@ -67,6 +57,14 @@ public function getValue() {
 		return $this->value;
 	}
 
+	public function getExtra(): string {
+		return $this->extra;
+	}
+
+	public function isExtra(): bool {
+		return ($this->extra !== '');
+	}
+
 	public function getQueryHint(string $name, $default) {
 		return $this->hints[$name] ?? $default;
 	}

lib/private/Files/Search/SearchOrder.php

@@ -2,6 +2,7 @@
 /**
  * @copyright Copyright (c) 2017 Robin Appelman <[email protected]>
  *
+ * @author Maxence Lange <[email protected]>
  * @author Robin Appelman <[email protected]>
  *
  * @license GNU AGPL version 3 or any later version
@@ -26,36 +27,36 @@
 use OCP\Files\Search\ISearchOrder;
 
 class SearchOrder implements ISearchOrder {
-	/** @var  string */
-	private $direction;
-	/** @var  string */
-	private $field;
 
-	/**
-	 * SearchOrder constructor.
-	 *
-	 * @param string $direction
-	 * @param string $field
-	 */
-	public function __construct($direction, $field) {
-		$this->direction = $direction;
-		$this->field = $field;
+	public function __construct(
+		private string $direction,
+		private string $field,
+		private string $extra = ''
+	) {
 	}
 
 	/**
 	 * @return string
 	 */
-	public function getDirection() {
+	public function getDirection(): string {
 		return $this->direction;
 	}
 
 	/**
 	 * @return string
 	 */
-	public function getField() {
+	public function getField(): string {
 		return $this->field;
 	}
 
+	public function getExtra(): string {
+		return $this->extra;
+	}
+
+	public function isExtra(): bool {
+		return ($this->extra !== '');
+	}
+
 	public function sortFileInfo(FileInfo $a, FileInfo $b): int {
 		$cmp = $this->sortFileInfoNoDirection($a, $b);
 		return $cmp * ($this->direction === ISearchOrder::DIRECTION_ASCENDING ? 1 : -1);