nextcloud / server

lib/private/Files/Cache/Wrapper/CacheJail.php

Indentation +304 added lines, -304 removed lines

@@ -37,308 +37,308 @@
  * Jail to a subdirectory of the wrapped cache
  */
 class CacheJail extends CacheWrapper {
-	/**
-	 * @var string
-	 */
-	protected $root;
-
-	/**
-	 * @param \OCP\Files\Cache\ICache $cache
-	 * @param string $root
-	 */
-	public function __construct($cache, $root) {
-		parent::__construct($cache);
-		$this->root = $root;
-	}
-
-	protected function getRoot() {
-		return $this->root;
-	}
-
-	protected function getSourcePath($path) {
-		if ($path === '') {
-			return $this->getRoot();
-		} else {
-			return $this->getRoot() . '/' . ltrim($path, '/');
-		}
-	}
-
-	/**
-	 * @param string $path
-	 * @return null|string the jailed path or null if the path is outside the jail
-	 */
-	protected function getJailedPath($path) {
-		if ($this->getRoot() === '') {
-			return $path;
-		}
-		$rootLength = strlen($this->getRoot()) + 1;
-		if ($path === $this->getRoot()) {
-			return '';
-		} else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
-			return substr($path, $rootLength);
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * @param ICacheEntry|array $entry
-	 * @return array
-	 */
-	protected function formatCacheEntry($entry) {
-		if (isset($entry['path'])) {
-			$entry['path'] = $this->getJailedPath($entry['path']);
-		}
-		return $entry;
-	}
-
-	protected function filterCacheEntry($entry) {
-		$rootLength = strlen($this->getRoot()) + 1;
-		return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
-	}
-
-	/**
-	 * get the stored metadata of a file or folder
-	 *
-	 * @param string /int $file
-	 * @return ICacheEntry|false
-	 */
-	public function get($file) {
-		if (is_string($file) or $file == '') {
-			$file = $this->getSourcePath($file);
-		}
-		return parent::get($file);
-	}
-
-	/**
-	 * insert meta data for a new file or folder
-	 *
-	 * @param string $file
-	 * @param array $data
-	 *
-	 * @return int file id
-	 * @throws \RuntimeException
-	 */
-	public function insert($file, array $data) {
-		return $this->getCache()->insert($this->getSourcePath($file), $data);
-	}
-
-	/**
-	 * update the metadata in the cache
-	 *
-	 * @param int $id
-	 * @param array $data
-	 */
-	public function update($id, array $data) {
-		$this->getCache()->update($id, $data);
-	}
-
-	/**
-	 * get the file id for a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getId($file) {
-		return $this->getCache()->getId($this->getSourcePath($file));
-	}
-
-	/**
-	 * get the id of the parent folder of a file
-	 *
-	 * @param string $file
-	 * @return int
-	 */
-	public function getParentId($file) {
-		return $this->getCache()->getParentId($this->getSourcePath($file));
-	}
-
-	/**
-	 * check if a file is available in the cache
-	 *
-	 * @param string $file
-	 * @return bool
-	 */
-	public function inCache($file) {
-		return $this->getCache()->inCache($this->getSourcePath($file));
-	}
-
-	/**
-	 * remove a file or folder from the cache
-	 *
-	 * @param string $file
-	 */
-	public function remove($file) {
-		$this->getCache()->remove($this->getSourcePath($file));
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * @param string $source
-	 * @param string $target
-	 */
-	public function move($source, $target) {
-		$this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
-	}
-
-	/**
-	 * Get the storage id and path needed for a move
-	 *
-	 * @param string $path
-	 * @return array [$storageId, $internalPath]
-	 */
-	protected function getMoveInfo($path) {
-		return [$this->getNumericStorageId(), $this->getSourcePath($path)];
-	}
-
-	/**
-	 * remove all entries for files that are stored on the storage from the cache
-	 */
-	public function clear() {
-		$this->getCache()->remove($this->getRoot());
-	}
-
-	/**
-	 * @param string $file
-	 *
-	 * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
-	 */
-	public function getStatus($file) {
-		return $this->getCache()->getStatus($this->getSourcePath($file));
-	}
-
-	private function formatSearchResults($results) {
-		$results = array_filter($results, array($this, 'filterCacheEntry'));
-		$results = array_values($results);
-		return array_map(array($this, 'formatCacheEntry'), $results);
-	}
-
-	/**
-	 * search for files matching $pattern
-	 *
-	 * @param string $pattern
-	 * @return array an array of file data
-	 */
-	public function search($pattern) {
-		$results = $this->getCache()->search($pattern);
-		return $this->formatSearchResults($results);
-	}
-
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string $mimetype
-	 * @return array
-	 */
-	public function searchByMime($mimetype) {
-		$results = $this->getCache()->searchByMime($mimetype);
-		return $this->formatSearchResults($results);
-	}
-
-	public function searchQuery(ISearchQuery $query) {
-		$simpleQuery = new SearchQuery($query->getSearchOperation(), 0, 0, $query->getOrder(), $query->getUser());
-		$results = $this->getCache()->searchQuery($simpleQuery);
-		$results = $this->formatSearchResults($results);
-
-		$limit = $query->getLimit() === 0 ? NULL : $query->getLimit();
-		$results = array_slice($results, $query->getOffset(), $limit);
-
-		return $results;
-	}
-
-	/**
-	 * search for files by mimetype
-	 *
-	 * @param string|int $tag name or tag id
-	 * @param string $userId owner of the tags
-	 * @return array
-	 */
-	public function searchByTag($tag, $userId) {
-		$results = $this->getCache()->searchByTag($tag, $userId);
-		return $this->formatSearchResults($results);
-	}
-
-	/**
-	 * update the folder size and the size of all parent folders
-	 *
-	 * @param string|boolean $path
-	 * @param array $data (optional) meta data of the folder
-	 */
-	public function correctFolderSize($path, $data = null) {
-		if ($this->getCache() instanceof Cache) {
-			$this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
-		}
-	}
-
-	/**
-	 * get the size of a folder and set it in the cache
-	 *
-	 * @param string $path
-	 * @param array $entry (optional) meta data of the folder
-	 * @return int
-	 */
-	public function calculateFolderSize($path, $entry = null) {
-		if ($this->getCache() instanceof Cache) {
-			return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
-		} else {
-			return 0;
-		}
-
-	}
-
-	/**
-	 * get all file ids on the files on the storage
-	 *
-	 * @return int[]
-	 */
-	public function getAll() {
-		// not supported
-		return array();
-	}
-
-	/**
-	 * find a folder in the cache which has not been fully scanned
-	 *
-	 * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
-	 * use the one with the highest id gives the best result with the background scanner, since that is most
-	 * likely the folder where we stopped scanning previously
-	 *
-	 * @return string|bool the path of the folder or false when no folder matched
-	 */
-	public function getIncomplete() {
-		// not supported
-		return false;
-	}
-
-	/**
-	 * get the path of a file on this storage by it's id
-	 *
-	 * @param int $id
-	 * @return string|null
-	 */
-	public function getPathById($id) {
-		$path = $this->getCache()->getPathById($id);
-		if ($path === null) {
-			return null;
-		}
-
-		return $this->getJailedPath($path);
-	}
-
-	/**
-	 * Move a file or folder in the cache
-	 *
-	 * Note that this should make sure the entries are removed from the source cache
-	 *
-	 * @param \OCP\Files\Cache\ICache $sourceCache
-	 * @param string $sourcePath
-	 * @param string $targetPath
-	 */
-	public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
-		if ($sourceCache === $this) {
-			return $this->move($sourcePath, $targetPath);
-		}
-		return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
-	}
+    /**
+     * @var string
+     */
+    protected $root;
+
+    /**
+     * @param \OCP\Files\Cache\ICache $cache
+     * @param string $root
+     */
+    public function __construct($cache, $root) {
+        parent::__construct($cache);
+        $this->root = $root;
+    }
+
+    protected function getRoot() {
+        return $this->root;
+    }
+
+    protected function getSourcePath($path) {
+        if ($path === '') {
+            return $this->getRoot();
+        } else {
+            return $this->getRoot() . '/' . ltrim($path, '/');
+        }
+    }
+
+    /**
+     * @param string $path
+     * @return null|string the jailed path or null if the path is outside the jail
+     */
+    protected function getJailedPath($path) {
+        if ($this->getRoot() === '') {
+            return $path;
+        }
+        $rootLength = strlen($this->getRoot()) + 1;
+        if ($path === $this->getRoot()) {
+            return '';
+        } else if (substr($path, 0, $rootLength) === $this->getRoot() . '/') {
+            return substr($path, $rootLength);
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * @param ICacheEntry|array $entry
+     * @return array
+     */
+    protected function formatCacheEntry($entry) {
+        if (isset($entry['path'])) {
+            $entry['path'] = $this->getJailedPath($entry['path']);
+        }
+        return $entry;
+    }
+
+    protected function filterCacheEntry($entry) {
+        $rootLength = strlen($this->getRoot()) + 1;
+        return ($entry['path'] === $this->getRoot()) or (substr($entry['path'], 0, $rootLength) === $this->getRoot() . '/');
+    }
+
+    /**
+     * get the stored metadata of a file or folder
+     *
+     * @param string /int $file
+     * @return ICacheEntry|false
+     */
+    public function get($file) {
+        if (is_string($file) or $file == '') {
+            $file = $this->getSourcePath($file);
+        }
+        return parent::get($file);
+    }
+
+    /**
+     * insert meta data for a new file or folder
+     *
+     * @param string $file
+     * @param array $data
+     *
+     * @return int file id
+     * @throws \RuntimeException
+     */
+    public function insert($file, array $data) {
+        return $this->getCache()->insert($this->getSourcePath($file), $data);
+    }
+
+    /**
+     * update the metadata in the cache
+     *
+     * @param int $id
+     * @param array $data
+     */
+    public function update($id, array $data) {
+        $this->getCache()->update($id, $data);
+    }
+
+    /**
+     * get the file id for a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getId($file) {
+        return $this->getCache()->getId($this->getSourcePath($file));
+    }
+
+    /**
+     * get the id of the parent folder of a file
+     *
+     * @param string $file
+     * @return int
+     */
+    public function getParentId($file) {
+        return $this->getCache()->getParentId($this->getSourcePath($file));
+    }
+
+    /**
+     * check if a file is available in the cache
+     *
+     * @param string $file
+     * @return bool
+     */
+    public function inCache($file) {
+        return $this->getCache()->inCache($this->getSourcePath($file));
+    }
+
+    /**
+     * remove a file or folder from the cache
+     *
+     * @param string $file
+     */
+    public function remove($file) {
+        $this->getCache()->remove($this->getSourcePath($file));
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * @param string $source
+     * @param string $target
+     */
+    public function move($source, $target) {
+        $this->getCache()->move($this->getSourcePath($source), $this->getSourcePath($target));
+    }
+
+    /**
+     * Get the storage id and path needed for a move
+     *
+     * @param string $path
+     * @return array [$storageId, $internalPath]
+     */
+    protected function getMoveInfo($path) {
+        return [$this->getNumericStorageId(), $this->getSourcePath($path)];
+    }
+
+    /**
+     * remove all entries for files that are stored on the storage from the cache
+     */
+    public function clear() {
+        $this->getCache()->remove($this->getRoot());
+    }
+
+    /**
+     * @param string $file
+     *
+     * @return int Cache::NOT_FOUND, Cache::PARTIAL, Cache::SHALLOW or Cache::COMPLETE
+     */
+    public function getStatus($file) {
+        return $this->getCache()->getStatus($this->getSourcePath($file));
+    }
+
+    private function formatSearchResults($results) {
+        $results = array_filter($results, array($this, 'filterCacheEntry'));
+        $results = array_values($results);
+        return array_map(array($this, 'formatCacheEntry'), $results);
+    }
+
+    /**
+     * search for files matching $pattern
+     *
+     * @param string $pattern
+     * @return array an array of file data
+     */
+    public function search($pattern) {
+        $results = $this->getCache()->search($pattern);
+        return $this->formatSearchResults($results);
+    }
+
+    /**
+     * search for files by mimetype
+     *
+     * @param string $mimetype
+     * @return array
+     */
+    public function searchByMime($mimetype) {
+        $results = $this->getCache()->searchByMime($mimetype);
+        return $this->formatSearchResults($results);
+    }
+
+    public function searchQuery(ISearchQuery $query) {
+        $simpleQuery = new SearchQuery($query->getSearchOperation(), 0, 0, $query->getOrder(), $query->getUser());
+        $results = $this->getCache()->searchQuery($simpleQuery);
+        $results = $this->formatSearchResults($results);
+
+        $limit = $query->getLimit() === 0 ? NULL : $query->getLimit();
+        $results = array_slice($results, $query->getOffset(), $limit);
+
+        return $results;
+    }
+
+    /**
+     * search for files by mimetype
+     *
+     * @param string|int $tag name or tag id
+     * @param string $userId owner of the tags
+     * @return array
+     */
+    public function searchByTag($tag, $userId) {
+        $results = $this->getCache()->searchByTag($tag, $userId);
+        return $this->formatSearchResults($results);
+    }
+
+    /**
+     * update the folder size and the size of all parent folders
+     *
+     * @param string|boolean $path
+     * @param array $data (optional) meta data of the folder
+     */
+    public function correctFolderSize($path, $data = null) {
+        if ($this->getCache() instanceof Cache) {
+            $this->getCache()->correctFolderSize($this->getSourcePath($path), $data);
+        }
+    }
+
+    /**
+     * get the size of a folder and set it in the cache
+     *
+     * @param string $path
+     * @param array $entry (optional) meta data of the folder
+     * @return int
+     */
+    public function calculateFolderSize($path, $entry = null) {
+        if ($this->getCache() instanceof Cache) {
+            return $this->getCache()->calculateFolderSize($this->getSourcePath($path), $entry);
+        } else {
+            return 0;
+        }
+
+    }
+
+    /**
+     * get all file ids on the files on the storage
+     *
+     * @return int[]
+     */
+    public function getAll() {
+        // not supported
+        return array();
+    }
+
+    /**
+     * find a folder in the cache which has not been fully scanned
+     *
+     * If multiply incomplete folders are in the cache, the one with the highest id will be returned,
+     * use the one with the highest id gives the best result with the background scanner, since that is most
+     * likely the folder where we stopped scanning previously
+     *
+     * @return string|bool the path of the folder or false when no folder matched
+     */
+    public function getIncomplete() {
+        // not supported
+        return false;
+    }
+
+    /**
+     * get the path of a file on this storage by it's id
+     *
+     * @param int $id
+     * @return string|null
+     */
+    public function getPathById($id) {
+        $path = $this->getCache()->getPathById($id);
+        if ($path === null) {
+            return null;
+        }
+
+        return $this->getJailedPath($path);
+    }
+
+    /**
+     * Move a file or folder in the cache
+     *
+     * Note that this should make sure the entries are removed from the source cache
+     *
+     * @param \OCP\Files\Cache\ICache $sourceCache
+     * @param string $sourcePath
+     * @param string $targetPath
+     */
+    public function moveFromCache(\OCP\Files\Cache\ICache $sourceCache, $sourcePath, $targetPath) {
+        if ($sourceCache === $this) {
+            return $this->move($sourcePath, $targetPath);
+        }
+        return $this->getCache()->moveFromCache($sourceCache, $sourcePath, $this->getSourcePath($targetPath));
+    }
 }

apps/dav/lib/Files/FileSearchBackend.php

Indentation +309 added lines, -309 removed lines

@@ -51,313 +51,313 @@
 use SearchDAV\Query\Order;
 
 class FileSearchBackend implements ISearchBackend {
-	/** @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;
-	}
-
-	/**
-	 * Search endpoint will be remote.php/dav
-	 *
-	 * @return string
-	 */
-	public function getArbiterPath() {
-		return '';
-	}
-
-	public function isValidScope($href, $depth, $path) {
-		// only allow scopes inside the dav server
-		if (is_null($path)) {
-			return false;
-		}
-
-		try {
-			$node = $this->tree->getNodeForPath($path);
-			return $node instanceof Directory;
-		} catch (NotFound $e) {
-			return false;
-		}
-	}
-
-	public function getPropertyDefinitionsForScope($href, $path) {
-		// all valid scopes support the same schema
-
-		//todo dynamically load all propfind properties that are supported
-		return [
-			// queryable properties
-			new SearchPropertyDefinition('{DAV:}displayname', true, false, true),
-			new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true),
-			new SearchPropertyDefinition('{DAV:}getlastmodified', true, true, true, SearchPropertyDefinition::DATATYPE_DATETIME),
-			new SearchPropertyDefinition(FilesPlugin::SIZE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
-			new SearchPropertyDefinition(TagsPlugin::FAVORITE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_BOOLEAN),
-			new SearchPropertyDefinition(FilesPlugin::INTERNAL_FILEID_PROPERTYNAME, true, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
-
-			// select only properties
-			new SearchPropertyDefinition('{DAV:}resourcetype', false, true, false),
-			new SearchPropertyDefinition('{DAV:}getcontentlength', false, true, false),
-			new SearchPropertyDefinition(FilesPlugin::CHECKSUMS_PROPERTYNAME, false, true, false),
-			new SearchPropertyDefinition(FilesPlugin::PERMISSIONS_PROPERTYNAME, false, true, false),
-			new SearchPropertyDefinition(FilesPlugin::GETETAG_PROPERTYNAME, false, true, false),
-			new SearchPropertyDefinition(FilesPlugin::OWNER_ID_PROPERTYNAME, false, true, false),
-			new SearchPropertyDefinition(FilesPlugin::OWNER_DISPLAY_NAME_PROPERTYNAME, false, true, false),
-			new SearchPropertyDefinition(FilesPlugin::DATA_FINGERPRINT_PROPERTYNAME, false, true, false),
-			new SearchPropertyDefinition(FilesPlugin::HAS_PREVIEW_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_BOOLEAN),
-			new SearchPropertyDefinition(FilesPlugin::FILEID_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
-		];
-	}
-
-	/**
-	 * @param Query $search
-	 * @return SearchResult[]
-	 */
-	public function search(Query $search) {
-		if (count($search->from) !== 1) {
-			throw new \InvalidArgumentException('Searching more than one folder is not supported');
-		}
-		$query = $this->transformQuery($search);
-		$scope = $search->from[0];
-		if ($scope->path === null) {
-			throw new \InvalidArgumentException('Using uri\'s as scope is not supported, please use a path relative to the search arbiter instead');
-		}
-		$node = $this->tree->getNodeForPath($scope->path);
-		if (!$node instanceof Directory) {
-			throw new \InvalidArgumentException('Search is only supported on directories');
-		}
-
-		$fileInfo = $node->getFileInfo();
-		$folder = $this->rootFolder->get($fileInfo->getPath());
-		/** @var Folder $folder $results */
-		$results = $folder->search($query);
-
-		/** @var SearchResult[] $nodes */
-		$nodes = array_map(function (Node $node) {
-			if ($node instanceof Folder) {
-				$davNode = new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager);
-			} else {
-				$davNode = new \OCA\DAV\Connector\Sabre\File($this->view, $node, $this->shareManager);
-			}
-			$path = $this->getHrefForNode($node);
-			$this->tree->cacheNode($davNode, $path);
-			return new SearchResult($davNode, $path);
-		}, $results);
-
-		// Sort again, since the result from multiple storages is appended and not sorted
-		usort($nodes, function (SearchResult $a, SearchResult $b) use ($search) {
-			return $this->sort($a, $b, $search->orderBy);
-		});
-
-		// If a limit is provided use only return that number of files
-		if ($search->limit->maxResults !== 0) {
-			$nodes = \array_slice($nodes, 0, $search->limit->maxResults);
-		}
-
-		return $nodes;
-	}
-
-	private function sort(SearchResult $a, SearchResult $b, array $orders) {
-		/** @var Order $order */
-		foreach ($orders as $order) {
-			$v1 = $this->getSearchResultProperty($a, $order->property);
-			$v2 = $this->getSearchResultProperty($b, $order->property);
-
-
-			if ($v1 === null && $v2 === null) {
-				continue;
-			}
-			if ($v1 === null) {
-				return $order->order === Order::ASC ? 1 : -1;
-			}
-			if ($v2 === null) {
-				return $order->order === Order::ASC ? -1 : 1;
-			}
-
-			$s = $this->compareProperties($v1, $v2, $order);
-			if ($s === 0) {
-				continue;
-			}
-
-			if ($order->order === Order::DESC) {
-				$s = -$s;
-			}
-			return $s;
-		}
-
-		return 0;
-	}
-
-	private function compareProperties($a, $b, Order $order) {
-		switch ($order->property->dataType) {
-			case SearchPropertyDefinition::DATATYPE_STRING:
-				return strcmp($a, $b);
-			case SearchPropertyDefinition::DATATYPE_BOOLEAN:
-				if ($a === $b) {
-					return 0;
-				}
-				if ($a === false) {
-					return -1;
-				}
-				return 1;
-			default:
-				if ($a === $b) {
-					return 0;
-				}
-				if ($a < $b) {
-					return -1;
-				}
-				return 1;
-		}
-	}
-
-	private function getSearchResultProperty(SearchResult $result, SearchPropertyDefinition $property) {
-		/** @var \OCA\DAV\Connector\Sabre\Node $node */
-		$node = $result->node;
-
-		switch ($property->name) {
-			case '{DAV:}displayname':
-				return $node->getName();
-			case '{DAV:}getlastmodified':
-				return $node->getLastModified();
-			case FilesPlugin::SIZE_PROPERTYNAME:
-				return $node->getSize();
-			case FilesPlugin::INTERNAL_FILEID_PROPERTYNAME:
-				return $node->getInternalFileId();
-			default:
-				return null;
-		}
-	}
-
-	/**
-	 * @param Node $node
-	 * @return string
-	 */
-	private function getHrefForNode(Node $node) {
-		$base = '/files/' . $this->user->getUID();
-		return $base . $this->view->getRelativePath($node->getPath());
-	}
-
-	/**
-	 * @param Query $query
-	 * @return ISearchQuery
-	 */
-	private function transformQuery(Query $query) {
-		// TODO offset
-		$limit = $query->limit;
-		$orders = array_map([$this, 'mapSearchOrder'], $query->orderBy);
-		return new SearchQuery($this->transformSearchOperation($query->where), (int)$limit->maxResults, 0, $orders, $this->user);
-	}
-
-	/**
-	 * @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
-	 */
-	private function transformSearchOperation(Operator $operator) {
-		list(, $trimmedType) = explode('}', $operator->type);
-		switch ($operator->type) {
-			case Operator::OPERATION_AND:
-			case Operator::OPERATION_OR:
-			case Operator::OPERATION_NOT:
-				$arguments = array_map([$this, 'transformSearchOperation'], $operator->arguments);
-				return new SearchBinaryOperator($trimmedType, $arguments);
-			case Operator::OPERATION_EQUAL:
-			case Operator::OPERATION_GREATER_OR_EQUAL_THAN:
-			case Operator::OPERATION_GREATER_THAN:
-			case Operator::OPERATION_LESS_OR_EQUAL_THAN:
-			case Operator::OPERATION_LESS_THAN:
-			case Operator::OPERATION_IS_LIKE:
-				if (count($operator->arguments) !== 2) {
-					throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation');
-				}
-				if (!($operator->arguments[0] instanceof SearchPropertyDefinition)) {
-					throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property');
-				}
-				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));
-			case Operator::OPERATION_IS_COLLECTION:
-				return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE);
-			default:
-				throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType . ' (' . $operator->type . ')');
-		}
-	}
-
-	/**
-	 * @param SearchPropertyDefinition $property
-	 * @return string
-	 */
-	private function mapPropertyNameToColumn(SearchPropertyDefinition $property) {
-		switch ($property->name) {
-			case '{DAV:}displayname':
-				return 'name';
-			case '{DAV:}getcontenttype':
-				return 'mimetype';
-			case '{DAV:}getlastmodified':
-				return 'mtime';
-			case FilesPlugin::SIZE_PROPERTYNAME:
-				return 'size';
-			case TagsPlugin::FAVORITE_PROPERTYNAME:
-				return 'favorite';
-			case TagsPlugin::TAGS_PROPERTYNAME:
-				return 'tagname';
-			case FilesPlugin::INTERNAL_FILEID_PROPERTYNAME:
-				return 'fileid';
-			default:
-				throw new \InvalidArgumentException('Unsupported property for search or order: ' . $property->name);
-		}
-	}
-
-	private function castValue(SearchPropertyDefinition $property, $value) {
-		switch ($property->dataType) {
-			case SearchPropertyDefinition::DATATYPE_BOOLEAN:
-				return $value === 'yes';
-			case SearchPropertyDefinition::DATATYPE_DECIMAL:
-			case SearchPropertyDefinition::DATATYPE_INTEGER:
-			case SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER:
-				return 0 + $value;
-			case SearchPropertyDefinition::DATATYPE_DATETIME:
-				if (is_numeric($value)) {
-					return 0 + $value;
-				}
-				$date = \DateTime::createFromFormat(\DateTime::ATOM, $value);
-				return ($date instanceof \DateTime) ? $date->getTimestamp() : 0;
-			default:
-				return $value;
-		}
-	}
+    /** @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;
+    }
+
+    /**
+     * Search endpoint will be remote.php/dav
+     *
+     * @return string
+     */
+    public function getArbiterPath() {
+        return '';
+    }
+
+    public function isValidScope($href, $depth, $path) {
+        // only allow scopes inside the dav server
+        if (is_null($path)) {
+            return false;
+        }
+
+        try {
+            $node = $this->tree->getNodeForPath($path);
+            return $node instanceof Directory;
+        } catch (NotFound $e) {
+            return false;
+        }
+    }
+
+    public function getPropertyDefinitionsForScope($href, $path) {
+        // all valid scopes support the same schema
+
+        //todo dynamically load all propfind properties that are supported
+        return [
+            // queryable properties
+            new SearchPropertyDefinition('{DAV:}displayname', true, false, true),
+            new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true),
+            new SearchPropertyDefinition('{DAV:}getlastmodified', true, true, true, SearchPropertyDefinition::DATATYPE_DATETIME),
+            new SearchPropertyDefinition(FilesPlugin::SIZE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
+            new SearchPropertyDefinition(TagsPlugin::FAVORITE_PROPERTYNAME, true, true, true, SearchPropertyDefinition::DATATYPE_BOOLEAN),
+            new SearchPropertyDefinition(FilesPlugin::INTERNAL_FILEID_PROPERTYNAME, true, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
+
+            // select only properties
+            new SearchPropertyDefinition('{DAV:}resourcetype', false, true, false),
+            new SearchPropertyDefinition('{DAV:}getcontentlength', false, true, false),
+            new SearchPropertyDefinition(FilesPlugin::CHECKSUMS_PROPERTYNAME, false, true, false),
+            new SearchPropertyDefinition(FilesPlugin::PERMISSIONS_PROPERTYNAME, false, true, false),
+            new SearchPropertyDefinition(FilesPlugin::GETETAG_PROPERTYNAME, false, true, false),
+            new SearchPropertyDefinition(FilesPlugin::OWNER_ID_PROPERTYNAME, false, true, false),
+            new SearchPropertyDefinition(FilesPlugin::OWNER_DISPLAY_NAME_PROPERTYNAME, false, true, false),
+            new SearchPropertyDefinition(FilesPlugin::DATA_FINGERPRINT_PROPERTYNAME, false, true, false),
+            new SearchPropertyDefinition(FilesPlugin::HAS_PREVIEW_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_BOOLEAN),
+            new SearchPropertyDefinition(FilesPlugin::FILEID_PROPERTYNAME, false, true, false, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
+        ];
+    }
+
+    /**
+     * @param Query $search
+     * @return SearchResult[]
+     */
+    public function search(Query $search) {
+        if (count($search->from) !== 1) {
+            throw new \InvalidArgumentException('Searching more than one folder is not supported');
+        }
+        $query = $this->transformQuery($search);
+        $scope = $search->from[0];
+        if ($scope->path === null) {
+            throw new \InvalidArgumentException('Using uri\'s as scope is not supported, please use a path relative to the search arbiter instead');
+        }
+        $node = $this->tree->getNodeForPath($scope->path);
+        if (!$node instanceof Directory) {
+            throw new \InvalidArgumentException('Search is only supported on directories');
+        }
+
+        $fileInfo = $node->getFileInfo();
+        $folder = $this->rootFolder->get($fileInfo->getPath());
+        /** @var Folder $folder $results */
+        $results = $folder->search($query);
+
+        /** @var SearchResult[] $nodes */
+        $nodes = array_map(function (Node $node) {
+            if ($node instanceof Folder) {
+                $davNode = new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager);
+            } else {
+                $davNode = new \OCA\DAV\Connector\Sabre\File($this->view, $node, $this->shareManager);
+            }
+            $path = $this->getHrefForNode($node);
+            $this->tree->cacheNode($davNode, $path);
+            return new SearchResult($davNode, $path);
+        }, $results);
+
+        // Sort again, since the result from multiple storages is appended and not sorted
+        usort($nodes, function (SearchResult $a, SearchResult $b) use ($search) {
+            return $this->sort($a, $b, $search->orderBy);
+        });
+
+        // If a limit is provided use only return that number of files
+        if ($search->limit->maxResults !== 0) {
+            $nodes = \array_slice($nodes, 0, $search->limit->maxResults);
+        }
+
+        return $nodes;
+    }
+
+    private function sort(SearchResult $a, SearchResult $b, array $orders) {
+        /** @var Order $order */
+        foreach ($orders as $order) {
+            $v1 = $this->getSearchResultProperty($a, $order->property);
+            $v2 = $this->getSearchResultProperty($b, $order->property);
+
+
+            if ($v1 === null && $v2 === null) {
+                continue;
+            }
+            if ($v1 === null) {
+                return $order->order === Order::ASC ? 1 : -1;
+            }
+            if ($v2 === null) {
+                return $order->order === Order::ASC ? -1 : 1;
+            }
+
+            $s = $this->compareProperties($v1, $v2, $order);
+            if ($s === 0) {
+                continue;
+            }
+
+            if ($order->order === Order::DESC) {
+                $s = -$s;
+            }
+            return $s;
+        }
+
+        return 0;
+    }
+
+    private function compareProperties($a, $b, Order $order) {
+        switch ($order->property->dataType) {
+            case SearchPropertyDefinition::DATATYPE_STRING:
+                return strcmp($a, $b);
+            case SearchPropertyDefinition::DATATYPE_BOOLEAN:
+                if ($a === $b) {
+                    return 0;
+                }
+                if ($a === false) {
+                    return -1;
+                }
+                return 1;
+            default:
+                if ($a === $b) {
+                    return 0;
+                }
+                if ($a < $b) {
+                    return -1;
+                }
+                return 1;
+        }
+    }
+
+    private function getSearchResultProperty(SearchResult $result, SearchPropertyDefinition $property) {
+        /** @var \OCA\DAV\Connector\Sabre\Node $node */
+        $node = $result->node;
+
+        switch ($property->name) {
+            case '{DAV:}displayname':
+                return $node->getName();
+            case '{DAV:}getlastmodified':
+                return $node->getLastModified();
+            case FilesPlugin::SIZE_PROPERTYNAME:
+                return $node->getSize();
+            case FilesPlugin::INTERNAL_FILEID_PROPERTYNAME:
+                return $node->getInternalFileId();
+            default:
+                return null;
+        }
+    }
+
+    /**
+     * @param Node $node
+     * @return string
+     */
+    private function getHrefForNode(Node $node) {
+        $base = '/files/' . $this->user->getUID();
+        return $base . $this->view->getRelativePath($node->getPath());
+    }
+
+    /**
+     * @param Query $query
+     * @return ISearchQuery
+     */
+    private function transformQuery(Query $query) {
+        // TODO offset
+        $limit = $query->limit;
+        $orders = array_map([$this, 'mapSearchOrder'], $query->orderBy);
+        return new SearchQuery($this->transformSearchOperation($query->where), (int)$limit->maxResults, 0, $orders, $this->user);
+    }
+
+    /**
+     * @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
+     */
+    private function transformSearchOperation(Operator $operator) {
+        list(, $trimmedType) = explode('}', $operator->type);
+        switch ($operator->type) {
+            case Operator::OPERATION_AND:
+            case Operator::OPERATION_OR:
+            case Operator::OPERATION_NOT:
+                $arguments = array_map([$this, 'transformSearchOperation'], $operator->arguments);
+                return new SearchBinaryOperator($trimmedType, $arguments);
+            case Operator::OPERATION_EQUAL:
+            case Operator::OPERATION_GREATER_OR_EQUAL_THAN:
+            case Operator::OPERATION_GREATER_THAN:
+            case Operator::OPERATION_LESS_OR_EQUAL_THAN:
+            case Operator::OPERATION_LESS_THAN:
+            case Operator::OPERATION_IS_LIKE:
+                if (count($operator->arguments) !== 2) {
+                    throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation');
+                }
+                if (!($operator->arguments[0] instanceof SearchPropertyDefinition)) {
+                    throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property');
+                }
+                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));
+            case Operator::OPERATION_IS_COLLECTION:
+                return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE);
+            default:
+                throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType . ' (' . $operator->type . ')');
+        }
+    }
+
+    /**
+     * @param SearchPropertyDefinition $property
+     * @return string
+     */
+    private function mapPropertyNameToColumn(SearchPropertyDefinition $property) {
+        switch ($property->name) {
+            case '{DAV:}displayname':
+                return 'name';
+            case '{DAV:}getcontenttype':
+                return 'mimetype';
+            case '{DAV:}getlastmodified':
+                return 'mtime';
+            case FilesPlugin::SIZE_PROPERTYNAME:
+                return 'size';
+            case TagsPlugin::FAVORITE_PROPERTYNAME:
+                return 'favorite';
+            case TagsPlugin::TAGS_PROPERTYNAME:
+                return 'tagname';
+            case FilesPlugin::INTERNAL_FILEID_PROPERTYNAME:
+                return 'fileid';
+            default:
+                throw new \InvalidArgumentException('Unsupported property for search or order: ' . $property->name);
+        }
+    }
+
+    private function castValue(SearchPropertyDefinition $property, $value) {
+        switch ($property->dataType) {
+            case SearchPropertyDefinition::DATATYPE_BOOLEAN:
+                return $value === 'yes';
+            case SearchPropertyDefinition::DATATYPE_DECIMAL:
+            case SearchPropertyDefinition::DATATYPE_INTEGER:
+            case SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER:
+                return 0 + $value;
+            case SearchPropertyDefinition::DATATYPE_DATETIME:
+                if (is_numeric($value)) {
+                    return 0 + $value;
+                }
+                $date = \DateTime::createFromFormat(\DateTime::ATOM, $value);
+                return ($date instanceof \DateTime) ? $date->getTimestamp() : 0;
+            default:
+                return $value;
+        }
+    }
 }

Spacing +10 added lines, -10 removed lines

@@ -158,7 +158,7 @@ 
 		$results = $folder->search($query);
 
 		/** @var SearchResult[] $nodes */
-		$nodes = array_map(function (Node $node) {
+		$nodes = array_map(function(Node $node) {
 			if ($node instanceof Folder) {
 				$davNode = new \OCA\DAV\Connector\Sabre\Directory($this->view, $node, $this->tree, $this->shareManager);
 			} else {
@@ -170,7 +170,7 @@ 
 		}, $results);
 
 		// Sort again, since the result from multiple storages is appended and not sorted
-		usort($nodes, function (SearchResult $a, SearchResult $b) use ($search) {
+		usort($nodes, function(SearchResult $a, SearchResult $b) use ($search) {
 			return $this->sort($a, $b, $search->orderBy);
 		});
 
@@ -259,8 +259,8 @@ 
 	 * @return string
 	 */
 	private function getHrefForNode(Node $node) {
-		$base = '/files/' . $this->user->getUID();
-		return $base . $this->view->getRelativePath($node->getPath());
+		$base = '/files/'.$this->user->getUID();
+		return $base.$this->view->getRelativePath($node->getPath());
 	}
 
 	/**
@@ -271,7 +271,7 @@ 
 		// TODO offset
 		$limit = $query->limit;
 		$orders = array_map([$this, 'mapSearchOrder'], $query->orderBy);
-		return new SearchQuery($this->transformSearchOperation($query->where), (int)$limit->maxResults, 0, $orders, $this->user);
+		return new SearchQuery($this->transformSearchOperation($query->where), (int) $limit->maxResults, 0, $orders, $this->user);
 	}
 
 	/**
@@ -301,19 +301,19 @@ 
 			case Operator::OPERATION_LESS_THAN:
 			case Operator::OPERATION_IS_LIKE:
 				if (count($operator->arguments) !== 2) {
-					throw new \InvalidArgumentException('Invalid number of arguments for ' . $trimmedType . ' operation');
+					throw new \InvalidArgumentException('Invalid number of arguments for '.$trimmedType.' operation');
 				}
 				if (!($operator->arguments[0] instanceof SearchPropertyDefinition)) {
-					throw new \InvalidArgumentException('Invalid argument 1 for ' . $trimmedType . ' operation, expected property');
+					throw new \InvalidArgumentException('Invalid argument 1 for '.$trimmedType.' operation, expected property');
 				}
 				if (!($operator->arguments[1] instanceof Literal)) {
-					throw new \InvalidArgumentException('Invalid argument 2 for ' . $trimmedType . ' operation, expected 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));
 			case Operator::OPERATION_IS_COLLECTION:
 				return new SearchComparison('eq', 'mimetype', ICacheEntry::DIRECTORY_MIMETYPE);
 			default:
-				throw new \InvalidArgumentException('Unsupported operation ' . $trimmedType . ' (' . $operator->type . ')');
+				throw new \InvalidArgumentException('Unsupported operation '.$trimmedType.' ('.$operator->type.')');
 		}
 	}
 
@@ -338,7 +338,7 @@ 
 			case FilesPlugin::INTERNAL_FILEID_PROPERTYNAME:
 				return 'fileid';
 			default:
-				throw new \InvalidArgumentException('Unsupported property for search or order: ' . $property->name);
+				throw new \InvalidArgumentException('Unsupported property for search or order: '.$property->name);
 		}
 	}