Merge pull request #3360 from nextcloud/dav-search

Implement webdav SEARCH

2 files changed, 263 insertions, 15 deletions

diff --git a/tests/lib/Files/Cache/CacheTest.php b/tests/lib/Files/Cache/CacheTest.php
index 4c4f43d63d5..1bcf8832c63 100644
--- a/tests/lib/Files/Cache/CacheTest.php
+++ b/tests/lib/Files/Cache/CacheTest.php
@@ -11,6 +11,9 @@ namespace Test\Files\Cache;
 
 use Doctrine\DBAL\Platforms\MySqlPlatform;
 use OC\Files\Cache\Cache;
+use OC\Files\Search\SearchComparison;
+use OC\Files\Search\SearchQuery;
+use OCP\Files\Search\ISearchComparison;
 
 class LongId extends \OC\Files\Storage\Temporary {
 	public function getId() {
@@ -111,15 +114,15 @@ class CacheTest extends \Test\TestCase {
 	 * @dataProvider folderDataProvider
 	 */
 	public function testFolder($folder) {
-		if(strpos($folder, 'F09F9890')) {
+		if (strpos($folder, 'F09F9890')) {
 			// 4 byte UTF doesn't work on mysql
 			$params = \OC::$server->getDatabaseConnection()->getParams();
-			if(\OC::$server->getDatabaseConnection()->getDatabasePlatform() instanceof MySqlPlatform && $params['charset'] !== 'utf8mb4') {
+			if (\OC::$server->getDatabaseConnection()->getDatabasePlatform() instanceof MySqlPlatform && $params['charset'] !== 'utf8mb4') {
 				$this->markTestSkipped('MySQL doesn\'t support 4 byte UTF-8');
 			}
 		}
-		$file2 = $folder.'/bar';
-		$file3 = $folder.'/foo';
+		$file2 = $folder . '/bar';
+		$file3 = $folder . '/foo';
 		$data1 = array('size' => 100, 'mtime' => 50, 'mimetype' => 'httpd/unix-directory');
 		$fileData = array();
 		$fileData['bar'] = array('size' => 1000, 'mtime' => 20, 'mimetype' => 'foo/file');
@@ -138,7 +141,7 @@ class CacheTest extends \Test\TestCase {
 			}
 		}
 
-		$file4 = $folder.'/unkownSize';
+		$file4 = $folder . '/unkownSize';
 		$fileData['unkownSize'] = array('size' => -1, 'mtime' => 25, 'mimetype' => 'foo/file');
 		$this->cache->put($file4, $fileData['unkownSize']);
 
@@ -155,8 +158,8 @@ class CacheTest extends \Test\TestCase {
 		$this->assertEquals(0, $this->cache->calculateFolderSize($folder));
 
 		$this->cache->remove($folder);
-		$this->assertFalse($this->cache->inCache($folder.'/foo'));
-		$this->assertFalse($this->cache->inCache($folder.'/bar'));
+		$this->assertFalse($this->cache->inCache($folder . '/foo'));
+		$this->assertFalse($this->cache->inCache($folder . '/bar'));
 	}
 
 	public function testRemoveRecursive() {
@@ -165,7 +168,7 @@ class CacheTest extends \Test\TestCase {
 		$folders = ['folder', 'folder/subfolder', 'folder/sub2', 'folder/sub2/sub3'];
 		$files = ['folder/foo.txt', 'folder/bar.txt', 'folder/subfolder/asd.txt', 'folder/sub2/qwerty.txt', 'folder/sub2/sub3/foo.txt'];
 
-		foreach($folders as $folder){
+		foreach ($folders as $folder) {
 			$this->cache->put($folder, $folderData);
 		}
 		foreach ($files as $file) {
@@ -360,7 +363,9 @@ class CacheTest extends \Test\TestCase {
 
 		$this->assertEquals(2, count($results));
 
-		usort($results, function($value1, $value2) { return $value1['name'] >= $value2['name']; });
+		usort($results, function ($value1, $value2) {
+			return $value1['name'] >= $value2['name'];
+		});
 
 		$this->assertEquals('folder', $results[0]['name']);
 		$this->assertEquals('foo', $results[1]['name']);
@@ -368,11 +373,15 @@ class CacheTest extends \Test\TestCase {
 		// use tag id
 		$tags = $tagManager->getTagsForUser($userId);
 		$this->assertNotEmpty($tags);
-		$tags = array_filter($tags, function($tag) { return $tag->getName() === 'tag2'; });
+		$tags = array_filter($tags, function ($tag) {
+			return $tag->getName() === 'tag2';
+		});
 		$results = $this->cache->searchByTag(current($tags)->getId(), $userId);
 		$this->assertEquals(3, count($results));
 
-		usort($results, function($value1, $value2) { return $value1['name'] >= $value2['name']; });
+		usort($results, function ($value1, $value2) {
+			return $value1['name'] >= $value2['name'];
+		});
 
 		$this->assertEquals('folder', $results[0]['name']);
 		$this->assertEquals('foo2', $results[1]['name']);
@@ -383,7 +392,42 @@ class CacheTest extends \Test\TestCase {
 
 		$this->logout();
 		$user = \OC::$server->getUserManager()->get($userId);
-		if ($user !== null) { $user->delete(); }
+		if ($user !== null) {
+			$user->delete();
+		}
+	}
+
+	function testSearchByQuery() {
+		$file1 = 'folder';
+		$file2 = 'folder/foobar';
+		$file3 = 'folder/foo';
+		$data1 = array('size' => 100, 'mtime' => 50, 'mimetype' => 'foo/folder');
+		$fileData = array();
+		$fileData['foobar'] = array('size' => 1000, 'mtime' => 20, 'mimetype' => 'foo/file');
+		$fileData['foo'] = array('size' => 20, 'mtime' => 25, 'mimetype' => 'foo/file');
+
+		$this->cache->put($file1, $data1);
+		$this->cache->put($file2, $fileData['foobar']);
+		$this->cache->put($file3, $fileData['foo']);
+
+		$this->assertCount(1, $this->cache->searchQuery(new SearchQuery(
+			new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'name', 'foo')
+			, 10, 0, [])));
+		$this->assertCount(2, $this->cache->searchQuery(new SearchQuery(
+			new SearchComparison(ISearchComparison::COMPARE_LIKE, 'name', 'foo%')
+			, 10, 0, [])));
+		$this->assertCount(2, $this->cache->searchQuery(new SearchQuery(
+			new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mimetype', 'foo/file')
+			, 10, 0, [])));
+		$this->assertCount(3, $this->cache->searchQuery(new SearchQuery(
+			new SearchComparison(ISearchComparison::COMPARE_LIKE, 'mimetype', 'foo/%')
+			, 10, 0, [])));
+		$this->assertCount(1, $this->cache->searchQuery(new SearchQuery(
+			new SearchComparison(ISearchComparison::COMPARE_GREATER_THAN, 'size', 100)
+			, 10, 0, [])));
+		$this->assertCount(2, $this->cache->searchQuery(new SearchQuery(
+			new SearchComparison(ISearchComparison::COMPARE_GREATER_THAN_EQUAL, 'size', 100)
+			, 10, 0, [])));
 	}
 
 	function testMove() {
@@ -626,9 +670,9 @@ class CacheTest extends \Test\TestCase {
 
 	public function escapingProvider() {
 		return [
-				['foo'],
-				['o%'],
-				['oth_r'],
+			['foo'],
+			['o%'],
+			['oth_r'],
 		];
 	}
 
diff --git a/tests/lib/Files/Cache/QuerySearchHelperTest.php b/tests/lib/Files/Cache/QuerySearchHelperTest.php
new file mode 100644
index 00000000000..f458ef039e1
--- /dev/null
+++ b/tests/lib/Files/Cache/QuerySearchHelperTest.php
@@ -0,0 +1,204 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Test\Files\Cache;
+
+use OC\DB\QueryBuilder\Literal;
+use OC\Files\Cache\QuerySearchHelper;
+use OC\Files\Search\SearchBinaryOperator;
+use OC\Files\Search\SearchComparison;
+use OCP\DB\QueryBuilder\IQueryBuilder;
+use OCP\Files\IMimeTypeLoader;
+use OCP\Files\Search\ISearchBinaryOperator;
+use OCP\Files\Search\ISearchComparison;
+use OCP\Files\Search\ISearchOperator;
+use Test\TestCase;
+
+/**
+ * @group DB
+ */
+class QuerySearchHelperTest extends TestCase {
+	/** @var  IQueryBuilder */
+	private $builder;
+
+	/** @var  IMimeTypeLoader|\PHPUnit_Framework_MockObject_MockObject */
+	private $mimetypeLoader;
+
+	/** @var  QuerySearchHelper */
+	private $querySearchHelper;
+
+	/** @var  integer */
+	private $numericStorageId;
+
+	public function setUp() {
+		parent::setUp();
+		$this->builder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+		$this->mimetypeLoader = $this->createMock(IMimeTypeLoader::class);
+
+		$this->mimetypeLoader->expects($this->any())
+			->method('getId')
+			->willReturnMap([
+				['text', 1],
+				['text/plain', 2],
+				['text/xml', 3],
+				['image/jpg', 4],
+				['image/png', 5],
+				['image', 6],
+			]);
+
+		$this->mimetypeLoader->expects($this->any())
+			->method('getMimetypeById')
+			->willReturnMap([
+				[1, 'text'],
+				[2, 'text/plain'],
+				[3, 'text/xml'],
+				[4, 'image/jpg'],
+				[5, 'image/png'],
+				[6, 'image']
+			]);
+
+		$this->querySearchHelper = new QuerySearchHelper($this->mimetypeLoader);
+		$this->numericStorageId = 10000;
+
+		$this->builder->select(['fileid'])
+			->from('filecache')
+			->where($this->builder->expr()->eq('storage', new Literal($this->numericStorageId)));
+	}
+
+	public function tearDown() {
+		parent::tearDown();
+
+		$builder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+
+		$builder->delete('filecache')
+			->where($builder->expr()->eq('storage', $builder->createNamedParameter($this->numericStorageId, IQueryBuilder::PARAM_INT)));
+
+		$builder->execute();
+	}
+
+	private function addCacheEntry(array $data) {
+		$data['storage'] = $this->numericStorageId;
+		$data['etag'] = 'unimportant';
+		$data['storage_mtime'] = $data['mtime'];
+		if (!isset($data['path'])) {
+			$data['path'] = 'random/' . $this->getUniqueID();
+		}
+		$data['path_hash'] = md5($data['path']);
+		if (!isset($data['mtime'])) {
+			$data['mtime'] = 100;
+		}
+		if (!isset($data['size'])) {
+			$data['size'] = 100;
+		}
+		$data['name'] = basename($data['path']);
+		$data['parent'] = -1;
+		if (isset($data['mimetype'])) {
+			list($mimepart,) = explode('/', $data['mimetype']);
+			$data['mimepart'] = $this->mimetypeLoader->getId($mimepart);
+			$data['mimetype'] = $this->mimetypeLoader->getId($data['mimetype']);
+		} else {
+			$data['mimepart'] = 1;
+			$data['mimetype'] = 1;
+		}
+
+		$builder = \OC::$server->getDatabaseConnection()->getQueryBuilder();
+
+		$values = [];
+		foreach ($data as $key => $value) {
+			$values[$key] = $builder->createNamedParameter($value);
+		}
+
+		$builder->insert('filecache')
+			->values($values)
+			->execute();
+	}
+
+	private function search(ISearchOperator $operator) {
+		$dbOperator = $this->querySearchHelper->searchOperatorToDBExpr($this->builder, $operator);
+		$this->builder->andWhere($dbOperator);
+		return $this->builder->execute()->fetchAll(\PDO::FETCH_COLUMN);
+	}
+
+	public function comparisonProvider() {
+		return [
+			[new SearchComparison(ISearchComparison::COMPARE_GREATER_THAN, 'mtime', 125), [1002]],
+			[new SearchComparison(ISearchComparison::COMPARE_LESS_THAN, 'mtime', 125), [1001]],
+			[new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'size', 125), []],
+			[new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'size', 50), [1001, 1002]],
+			[new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'name', 'foobar'), [1001]],
+			[new SearchComparison(ISearchComparison::COMPARE_LIKE, 'name', 'foo%'), [1001, 1002]],
+			[new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mimetype', 'image/jpg'), [1001]],
+			[new SearchComparison(ISearchComparison::COMPARE_LIKE, 'mimetype', 'image/%'), [1001, 1002]],
+			[new SearchBinaryOperator(ISearchBinaryOperator::OPERATOR_AND, [
+				new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'size', 50),
+				new SearchComparison(ISearchComparison::COMPARE_LESS_THAN, 'mtime', 125), [1001]
+			]), [1001]],
+			[new SearchBinaryOperator(ISearchBinaryOperator::OPERATOR_OR, [
+				new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mtime', 100),
+				new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mtime', 150),
+			]), [1001, 1002]],
+			[new SearchBinaryOperator(ISearchBinaryOperator::OPERATOR_NOT, [
+				new SearchComparison(ISearchComparison::COMPARE_EQUAL, 'mtime', 150),
+			]), [1001]],
+			[new SearchBinaryOperator(ISearchBinaryOperator::OPERATOR_NOT, [
+				new SearchComparison(ISearchComparison::COMPARE_GREATER_THAN, 'mtime', 125),
+			]), [1001]],
+			[new SearchBinaryOperator(ISearchBinaryOperator::OPERATOR_NOT, [
+				new SearchComparison(ISearchComparison::COMPARE_LESS_THAN, 'mtime', 125),
+			]), [1002]],
+			[new SearchBinaryOperator(ISearchBinaryOperator::OPERATOR_NOT, [
+				new SearchComparison(ISearchComparison::COMPARE_LIKE, 'name', '%bar'),
+			]), [1002]],
+
+		];
+	}
+
+	/**
+	 * @dataProvider comparisonProvider
+	 *
+	 * @param ISearchOperator $operator
+	 * @param array $fileIds
+	 */
+	public function testComparison(ISearchOperator $operator, array $fileIds) {
+		$this->addCacheEntry([
+			'path' => 'foobar',
+			'fileid' => 1001,
+			'mtime' => 100,
+			'size' => 50,
+			'mimetype' => 'image/jpg'
+		]);
+
+		$this->addCacheEntry([
+			'path' => 'fooasd',
+			'fileid' => 1002,
+			'mtime' => 150,
+			'size' => 50,
+			'mimetype' => 'image/png'
+		]);
+
+		$results = $this->search($operator);
+
+		sort($fileIds);
+		sort($results);
+
+		$this->assertEquals($fileIds, $results);
+	}
+}