From e8cf5e7644640238b07124a361fad3f5d1ec5db3 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Wed, 20 Feb 2019 15:43:12 +0100 Subject: [PATCH 01/29] strict typing and php 7.1 --- composer.json | 2 +- src/Backend/ISearchBackend.php | 2 +- src/Backend/SearchPropertyDefinition.php | 2 +- src/Backend/SearchResult.php | 2 +- src/DAV/DiscoverHandler.php | 2 +- src/DAV/PathHelper.php | 2 +- src/DAV/QueryParser.php | 2 +- src/DAV/SearchHandler.php | 9 ++++++++- src/DAV/SearchPlugin.php | 2 +- src/Query/Limit.php | 2 +- src/Query/Literal.php | 2 +- src/Query/Operator.php | 4 ++-- src/Query/Order.php | 4 ++-- src/Query/Query.php | 2 +- src/Query/Scope.php | 4 ++-- src/XML/BasicSearch.php | 4 ++-- src/XML/BasicSearchSchema.php | 2 +- src/XML/Limit.php | 4 ++-- src/XML/Literal.php | 4 ++-- src/XML/Operator.php | 6 +++--- src/XML/Order.php | 6 +++--- src/XML/PropDesc.php | 2 +- src/XML/QueryDiscoverResponse.php | 2 +- src/XML/Scope.php | 4 ++-- src/XML/SupportedQueryGrammar.php | 2 +- 25 files changed, 43 insertions(+), 36 deletions(-) diff --git a/composer.json b/composer.json index 242db29..52b8e58 100644 --- a/composer.json +++ b/composer.json @@ -9,7 +9,7 @@ } ], "require": { - "php": ">=5.6", + "php": ">=7.1", "sabre/dav": "^3.2.0" }, "require-dev": { diff --git a/src/Backend/ISearchBackend.php b/src/Backend/ISearchBackend.php index 665666c..21d577b 100644 --- a/src/Backend/ISearchBackend.php +++ b/src/Backend/ISearchBackend.php @@ -1,4 +1,4 @@ - * diff --git a/src/Backend/SearchPropertyDefinition.php b/src/Backend/SearchPropertyDefinition.php index d7de46a..daa22bd 100644 --- a/src/Backend/SearchPropertyDefinition.php +++ b/src/Backend/SearchPropertyDefinition.php @@ -1,4 +1,4 @@ - * diff --git a/src/Backend/SearchResult.php b/src/Backend/SearchResult.php index 32f99a7..43ee333 100644 --- a/src/Backend/SearchResult.php +++ b/src/Backend/SearchResult.php @@ -1,4 +1,4 @@ - * diff --git a/src/DAV/DiscoverHandler.php b/src/DAV/DiscoverHandler.php index 675fd6a..62fb5f8 100644 --- a/src/DAV/DiscoverHandler.php +++ b/src/DAV/DiscoverHandler.php @@ -1,4 +1,4 @@ - * diff --git a/src/DAV/PathHelper.php b/src/DAV/PathHelper.php index de7ea6a..b572493 100644 --- a/src/DAV/PathHelper.php +++ b/src/DAV/PathHelper.php @@ -1,4 +1,4 @@ - * diff --git a/src/DAV/QueryParser.php b/src/DAV/QueryParser.php index 592b620..44c594b 100644 --- a/src/DAV/QueryParser.php +++ b/src/DAV/QueryParser.php @@ -1,4 +1,4 @@ - * diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index ab400ce..b6e3d2a 100644 --- a/src/DAV/SearchHandler.php +++ b/src/DAV/SearchHandler.php @@ -1,4 +1,4 @@ - * @@ -98,6 +98,7 @@ class SearchHandler { * @param BasicSearch $xml * @param SearchPropertyDefinition[] $allProps * @return Query + * @throws BadRequest */ private function getQueryForXML(BasicSearch $xml, array $allProps) { $orderBy = array_map(function(\SearchDAV\XML\Order $order) use ($allProps) { @@ -127,6 +128,12 @@ class SearchHandler { return new Query($select, $xml->from, $where, $orderBy, $xml->limit); } + /** + * @param \SearchDAV\XML\Operator $operator + * @param array $allProps + * @return Operator + * @throws BadRequest + */ private function transformOperator(\SearchDAV\XML\Operator $operator, array $allProps) { $arguments = array_map(function($argument) use ($allProps) { if (is_string($argument)) { diff --git a/src/DAV/SearchPlugin.php b/src/DAV/SearchPlugin.php index 98c3ae9..113010b 100644 --- a/src/DAV/SearchPlugin.php +++ b/src/DAV/SearchPlugin.php @@ -1,4 +1,4 @@ - * diff --git a/src/Query/Limit.php b/src/Query/Limit.php index 0619e02..e6b4867 100644 --- a/src/Query/Limit.php +++ b/src/Query/Limit.php @@ -1,4 +1,4 @@ - * diff --git a/src/Query/Literal.php b/src/Query/Literal.php index 58b2fdd..862a412 100644 --- a/src/Query/Literal.php +++ b/src/Query/Literal.php @@ -1,4 +1,4 @@ - * diff --git a/src/Query/Operator.php b/src/Query/Operator.php index 868557b..198d1fb 100644 --- a/src/Query/Operator.php +++ b/src/Query/Operator.php @@ -1,4 +1,4 @@ - * @@ -60,7 +60,7 @@ class Operator { * @param string $type * @param array $arguments */ - public function __construct($type = '', array $arguments = []) { + public function __construct(string $type = '', array $arguments = []) { $this->type = $type; $this->arguments = $arguments; } diff --git a/src/Query/Order.php b/src/Query/Order.php index 5266658..c6afcee 100644 --- a/src/Query/Order.php +++ b/src/Query/Order.php @@ -1,4 +1,4 @@ - * @@ -46,7 +46,7 @@ class Order { * @param SearchPropertyDefinition $property * @param string $order */ - public function __construct(SearchPropertyDefinition $property, $order) { + public function __construct(SearchPropertyDefinition $property, string $order) { $this->property = $property; $this->order = $order; } diff --git a/src/Query/Query.php b/src/Query/Query.php index 85fc1ed..efd367c 100644 --- a/src/Query/Query.php +++ b/src/Query/Query.php @@ -1,4 +1,4 @@ - * diff --git a/src/Query/Scope.php b/src/Query/Scope.php index ebc778d..9c342c8 100644 --- a/src/Query/Scope.php +++ b/src/Query/Scope.php @@ -1,4 +1,4 @@ - * @@ -52,7 +52,7 @@ class Scope { * @param int|string $depth * @param string|null $path */ - public function __construct($href = '', $depth = 1, $path = null) { + public function __construct(string $href = '', $depth = 1, string $path = null) { $this->href = $href; $this->depth = $depth; $this->path = $path; diff --git a/src/XML/BasicSearch.php b/src/XML/BasicSearch.php index 8af30f4..269edb0 100644 --- a/src/XML/BasicSearch.php +++ b/src/XML/BasicSearch.php @@ -1,4 +1,4 @@ - * @@ -70,7 +70,7 @@ class BasicSearch implements XmlDeserializable { * @return BasicSearch * @throws ParseException */ - static function xmlDeserialize(Reader $reader) { + static function xmlDeserialize(Reader $reader): BasicSearch { $search = new self(); $elements = \Sabre\Xml\Deserializer\keyValue($reader); diff --git a/src/XML/BasicSearchSchema.php b/src/XML/BasicSearchSchema.php index 0e4c30d..edda372 100644 --- a/src/XML/BasicSearchSchema.php +++ b/src/XML/BasicSearchSchema.php @@ -1,4 +1,4 @@ - * diff --git a/src/XML/Limit.php b/src/XML/Limit.php index 0179d40..26d7866 100644 --- a/src/XML/Limit.php +++ b/src/XML/Limit.php @@ -1,4 +1,4 @@ - * @@ -29,7 +29,7 @@ use SearchDAV\DAV\SearchPlugin; * The limit and offset of a search query */ class Limit extends \SearchDAV\Query\Limit implements XmlDeserializable { - static function xmlDeserialize(Reader $reader) { + static function xmlDeserialize(Reader $reader): Limit { $limit = new self(); $elements = \Sabre\Xml\Deserializer\keyValue($reader); diff --git a/src/XML/Literal.php b/src/XML/Literal.php index 03d167f..f368940 100644 --- a/src/XML/Literal.php +++ b/src/XML/Literal.php @@ -1,4 +1,4 @@ - * @@ -26,7 +26,7 @@ use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; class Literal extends \SearchDAV\Query\Literal implements XmlDeserializable { - static function xmlDeserialize(Reader $reader) { + static function xmlDeserialize(Reader $reader): Literal { $literal = new self(); $literal->value = $reader->readText(); diff --git a/src/XML/Operator.php b/src/XML/Operator.php index 6439ff6..b3de50e 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -1,4 +1,4 @@ - * @@ -50,12 +50,12 @@ class Operator implements XmlDeserializable { * @param string $type * @param array $arguments */ - public function __construct($type = '', array $arguments = []) { + public function __construct(string $type = '', array $arguments = []) { $this->type = $type; $this->arguments = $arguments; } - static function xmlDeserialize(Reader $reader) { + static function xmlDeserialize(Reader $reader): Operator { $operator = new self(); $operator->type = $reader->getClark(); diff --git a/src/XML/Order.php b/src/XML/Order.php index 6573473..7aae162 100644 --- a/src/XML/Order.php +++ b/src/XML/Order.php @@ -1,4 +1,4 @@ - * @@ -45,12 +45,12 @@ class Order implements XmlDeserializable { * @param string $property * @param string $order */ - public function __construct($property = '', $order = \SearchDAV\Query\Order::ASC) { + public function __construct(string $property = '', string $order = \SearchDAV\Query\Order::ASC) { $this->property = $property; $this->order = $order; } - static function xmlDeserialize(Reader $reader) { + static function xmlDeserialize(Reader $reader): Order { $order = new self(); $childs = \Sabre\Xml\Deserializer\keyValue($reader); diff --git a/src/XML/PropDesc.php b/src/XML/PropDesc.php index 85e0c63..ab503b3 100644 --- a/src/XML/PropDesc.php +++ b/src/XML/PropDesc.php @@ -1,4 +1,4 @@ - * diff --git a/src/XML/QueryDiscoverResponse.php b/src/XML/QueryDiscoverResponse.php index b564b3b..802fdcd 100644 --- a/src/XML/QueryDiscoverResponse.php +++ b/src/XML/QueryDiscoverResponse.php @@ -1,4 +1,4 @@ - * diff --git a/src/XML/Scope.php b/src/XML/Scope.php index 905e140..78d4ba4 100644 --- a/src/XML/Scope.php +++ b/src/XML/Scope.php @@ -1,4 +1,4 @@ - * @@ -25,7 +25,7 @@ use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; class Scope extends \SearchDAV\Query\Scope implements XmlDeserializable { - static function xmlDeserialize(Reader $reader) { + static function xmlDeserialize(Reader $reader): Scope { $scope = new self(); $values = \Sabre\Xml\Deserializer\keyValue($reader); diff --git a/src/XML/SupportedQueryGrammar.php b/src/XML/SupportedQueryGrammar.php index 9b17a9b..ddb4e33 100644 --- a/src/XML/SupportedQueryGrammar.php +++ b/src/XML/SupportedQueryGrammar.php @@ -1,4 +1,4 @@ - * From aeb761058969f82a7495ffb68c1bf4c7ba20e979 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Wed, 20 Feb 2019 18:02:24 +0100 Subject: [PATCH 02/29] "where" is optional --- src/DAV/SearchHandler.php | 7 +------ src/Query/Query.php | 4 ++-- tests/SearchPluginTest.php | 15 ++++++++++++--- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index b6e3d2a..15cad4d 100644 --- a/src/DAV/SearchHandler.php +++ b/src/DAV/SearchHandler.php @@ -62,11 +62,6 @@ class SearchHandler { } /** @var BasicSearch $query */ $query = $xml['{DAV:}basicsearch']; - if (!$query->where) { - $response->setStatus(400); - $response->setBody('Parse error: Missing {DAV:}where from {DAV:}basicsearch'); - return false; - } if (!$query->select) { $response->setStatus(400); $response->setBody('Parse error: Missing {DAV:}select from {DAV:}basicsearch'); @@ -123,7 +118,7 @@ class SearchHandler { }, $xml->select); $select = array_filter($select); - $where = $this->transformOperator($xml->where, $allProps); + $where = $xml->where ? $this->transformOperator($xml->where, $allProps) : null; return new Query($select, $xml->from, $where, $orderBy, $xml->limit); } diff --git a/src/Query/Query.php b/src/Query/Query.php index efd367c..613c369 100644 --- a/src/Query/Query.php +++ b/src/Query/Query.php @@ -65,11 +65,11 @@ class Query { * Query constructor. * @param SearchPropertyDefinition[] $select * @param Scope[] $from - * @param Operator $where + * @param Operator|null $where * @param Order[] $orderBy * @param Limit $limit */ - public function __construct(array $select, array $from, Operator $where, array $orderBy, Limit $limit) { + public function __construct(array $select, array $from, ?Operator $where, array $orderBy, Limit $limit) { $this->select = $select; $this->from = $from; $this->where = $where; diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php index 351fafe..f6df61c 100644 --- a/tests/SearchPluginTest.php +++ b/tests/SearchPluginTest.php @@ -348,6 +348,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { ->method('getArbiterPath') ->willReturn('foo'); + $lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER); $plugin = new SearchPlugin($this->searchBackend); $server = new Server(); $plugin->initialize($server); @@ -363,12 +364,20 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { ->method('isValidScope') ->willReturn(true); - $this->searchBackend->expects($this->never()) - ->method('search'); + $this->searchBackend->expects($this->any()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([$lengthProp]); + + $this->searchBackend->expects($this->once()) + ->method('search') + ->willReturnCallback(function(Query $query) { + $this->assertNull($query->where); + return []; + }); $plugin->searchHandler($request, $response); - $this->assertEquals(400, $response->getStatus()); + $this->assertEquals(207, $response->getStatus()); } public function testSearchQueryNoSelect() { From 9c24c70774d5c9f05618166d0a860d6dd52e3591 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Wed, 20 Feb 2019 18:02:49 +0100 Subject: [PATCH 03/29] update php versions for travis --- .travis.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index 5d7c956..2236f26 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,9 +1,8 @@ language: php php: - - '5.6' - - '7.0' - '7.1' - '7.2' + - '7.3' cache: directories: From bef5795c984f277d2b814f3715a93151e276d415 Mon Sep 17 00:00:00 2001 From: Daniel Kesselberg Date: Sun, 3 Nov 2019 11:34:31 +0100 Subject: [PATCH 04/29] Fix parsing of {DAV:}contains element --- src/XML/Operator.php | 8 ++++++++ tests/QueryParserTest.php | 34 ++++++++++++++++++++++++++++++++ tests/complexquery.xml | 41 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 83 insertions(+) create mode 100644 tests/complexquery.xml diff --git a/src/XML/Operator.php b/src/XML/Operator.php index b3de50e..d4089de 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -23,6 +23,7 @@ namespace SearchDAV\XML; use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use SearchDAV\Query\Operator as QueryOperator; class Operator implements XmlDeserializable { /** @@ -63,6 +64,13 @@ class Operator implements XmlDeserializable { $reader->next(); return $operator; } + + if ($operator->type === QueryOperator::OPERATION_CONTAINS) { + $operator->arguments[] = $reader->readString(); + $reader->next(); + return $operator; + } + $reader->read(); do { if ($reader->nodeType === Reader::ELEMENT) { diff --git a/tests/QueryParserTest.php b/tests/QueryParserTest.php index 2ff8543..57ffb00 100644 --- a/tests/QueryParserTest.php +++ b/tests/QueryParserTest.php @@ -142,4 +142,38 @@ class QueryParserTest extends \PHPUnit_Framework_TestCase { $limit->maxResults = 10; $this->assertEquals($limit, $search->limit); } + + public function testParseComplexQuery() { + $query = file_get_contents(__DIR__ . '/complexquery.xml'); + $parser = new QueryParser(); + $xml = $parser->parse($query, null, $rootElementName); + + $this->assertEquals('{DAV:}searchrequest', $rootElementName); + $this->assertArrayHasKey('{DAV:}basicsearch', $xml); + + /** @var BasicSearch $search */ + $search = $xml['{DAV:}basicsearch']; + $this->assertInstanceOf(BasicSearch::class, $search); + + $this->assertEquals(['{DAV:}getcontentlength'], $search->select); + $this->assertEquals([ + new Scope('/container1/', 'infinity') + ], $search->from); + $this->assertEquals(new Operator(\SearchDAV\Query\Operator::OPERATION_AND, [ + new Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ + '{DAV:}getcontentlength', + new Literal(10000) + ]), + new Operator(\SearchDAV\Query\Operator::OPERATION_LESS_THAN, [ + '{DAV:}getcontentlength', + new Literal(90000) + ]), + new Operator(\SearchDAV\Query\Operator::OPERATION_CONTAINS, [ + 'Peter Forsberg' + ]), + ]), $search->where); + $this->assertEquals([ + new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::ASC) + ], $search->orderBy); + } } diff --git a/tests/complexquery.xml b/tests/complexquery.xml new file mode 100644 index 0000000..a29c85b --- /dev/null +++ b/tests/complexquery.xml @@ -0,0 +1,41 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + + + + 10000 + + + + + + 90000 + + Peter Forsberg + + + + + + + + + + + + From f9b08747fc3e9e926e462dac31dbba15ecbd47e3 Mon Sep 17 00:00:00 2001 From: Daniel Kesselberg Date: Sun, 3 Nov 2019 15:36:34 +0100 Subject: [PATCH 05/29] Fix Undefined offset: 0 --- src/XML/Operator.php | 2 +- tests/SearchPluginTest.php | 35 +++++++++++++++++++++++++++++++++++ tests/invalidwherenoprop.xml | 30 ++++++++++++++++++++++++++++++ 3 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 tests/invalidwherenoprop.xml diff --git a/src/XML/Operator.php b/src/XML/Operator.php index b3de50e..14ee8e8 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -68,7 +68,7 @@ class Operator implements XmlDeserializable { if ($reader->nodeType === Reader::ELEMENT) { $argument = $reader->parseCurrentElement(); if ($argument['name'] === '{DAV:}prop') { - $operator->arguments[] = $argument['value'][0]; + $operator->arguments[] = $argument['value'][0] ?? ''; } else { $operator->arguments[] = $argument['value']; } diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php index f6df61c..6fabea2 100644 --- a/tests/SearchPluginTest.php +++ b/tests/SearchPluginTest.php @@ -491,4 +491,39 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $this->assertEquals(400, $response->getStatus()); } + public function testSearchQueryInvalidWhereNoProp() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml' + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/invalidwherenoprop.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->never()) + ->method('search'); + + $this->searchBackend->expects($this->any()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([ + new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + ]); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + } diff --git a/tests/invalidwherenoprop.xml b/tests/invalidwherenoprop.xml new file mode 100644 index 0000000..8613100 --- /dev/null +++ b/tests/invalidwherenoprop.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + + + + + + + + + + + + + \ No newline at end of file From faf4ef87fd150e7c6d4c5a341211f6d22e2d5d1e Mon Sep 17 00:00:00 2001 From: Naofumi Date: Fri, 1 Nov 2019 07:59:07 +0900 Subject: [PATCH 06/29] Fix a possible infinite loop. --- src/XML/Operator.php | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/XML/Operator.php b/src/XML/Operator.php index 21d0236..61f410a 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -81,7 +81,9 @@ class Operator implements XmlDeserializable { $operator->arguments[] = $argument['value']; } } else { - $reader->read(); + if (!$reader->read()) { + break; + } } } while ($reader->nodeType !== Reader::END_ELEMENT); From c880b7edcdd406a474d2cbeebcb8a77cc5cfacf5 Mon Sep 17 00:00:00 2001 From: Naofumi Date: Wed, 6 Nov 2019 12:14:53 +0900 Subject: [PATCH 07/29] Don't call readText() in an empty element, otherwise all the subsequent elements are exhausted. --- src/XML/Literal.php | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/src/XML/Literal.php b/src/XML/Literal.php index f368940..92c76ca 100644 --- a/src/XML/Literal.php +++ b/src/XML/Literal.php @@ -29,7 +29,12 @@ class Literal extends \SearchDAV\Query\Literal implements XmlDeserializable { static function xmlDeserialize(Reader $reader): Literal { $literal = new self(); - $literal->value = $reader->readText(); + if ($reader->isEmptyElement) { + $literal->value = ''; + } else { + $literal->value = $reader->readText(); + } + $reader->read(); return $literal; From 2f87fb84d3d4d23d344407585f626d97f1cd991c Mon Sep 17 00:00:00 2001 From: Naofumi Date: Wed, 6 Nov 2019 12:14:18 +0900 Subject: [PATCH 08/29] add testSearchQueryInfiniteLoopEmptyLiteral(). --- tests/SearchPluginTest.php | 28 ++++++++++++++++++++++++++++ tests/infiniteloopemptyliteral.xml | 30 ++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 tests/infiniteloopemptyliteral.xml diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php index 6fabea2..d7d0d00 100644 --- a/tests/SearchPluginTest.php +++ b/tests/SearchPluginTest.php @@ -526,4 +526,32 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $this->assertEquals(400, $response->getStatus()); } + public function testSearchQueryInfiniteLoopEmptyLiteral() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); + + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); + + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml' + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/infiniteloopemptyliteral.xml', 'r')); + $response = new Response(); + + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); + + $this->searchBackend->expects($this->never()) + ->method('search'); + + $plugin->searchHandler($request, $response); + + $this->assertEquals(400, $response->getStatus()); + } + } diff --git a/tests/infiniteloopemptyliteral.xml b/tests/infiniteloopemptyliteral.xml new file mode 100644 index 0000000..7fa428a --- /dev/null +++ b/tests/infiniteloopemptyliteral.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + /files/naofumi + infinity + + + + + + \ No newline at end of file From 7174c023485c23037c6af786fce5a382fc72a75d Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Wed, 6 Nov 2019 14:15:26 +0100 Subject: [PATCH 09/29] fix test --- src/DAV/SearchHandler.php | 17 +++--- tests/SearchPluginTest.php | 118 +++++++++++++++++++++---------------- 2 files changed, 77 insertions(+), 58 deletions(-) diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index 15cad4d..8f6483e 100644 --- a/src/DAV/SearchHandler.php +++ b/src/DAV/SearchHandler.php @@ -84,7 +84,8 @@ class SearchHandler { $response->setBody($e->getMessage()); return false; } - $data = $this->server->generateMultiStatus(iterator_to_array($this->getPropertiesIteratorResults($results, $query->select)), false); + $data = $this->server->generateMultiStatus(iterator_to_array($this->getPropertiesIteratorResults($results, + $query->select)), false); $response->setBody($data); return false; } @@ -96,7 +97,7 @@ class SearchHandler { * @throws BadRequest */ private function getQueryForXML(BasicSearch $xml, array $allProps) { - $orderBy = array_map(function(\SearchDAV\XML\Order $order) use ($allProps) { + $orderBy = array_map(function (\SearchDAV\XML\Order $order) use ($allProps) { if (!isset($allProps[$order->property])) { throw new BadRequest('requested order by property is not a valid property for this scope'); } @@ -106,7 +107,7 @@ class SearchHandler { } return new Order($prop, $order->order); }, $xml->orderBy); - $select = array_map(function($propName) use ($allProps) { + $select = array_map(function ($propName) use ($allProps) { if (!isset($allProps[$propName])) { return; } @@ -130,7 +131,7 @@ class SearchHandler { * @throws BadRequest */ private function transformOperator(\SearchDAV\XML\Operator $operator, array $allProps) { - $arguments = array_map(function($argument) use ($allProps) { + $arguments = array_map(function ($argument) use ($allProps) { if (is_string($argument)) { if (!isset($allProps[$argument])) { throw new BadRequest('requested search property is not a valid property for this scope'); @@ -140,10 +141,12 @@ class SearchHandler { throw new BadRequest('requested search property is not searchable'); } return $prop; - } else if ($argument instanceof \SearchDAV\XML\Operator) { - return $this->transformOperator($argument, $allProps); } else { - return $argument; + if ($argument instanceof \SearchDAV\XML\Operator) { + return $this->transformOperator($argument, $allProps); + } else { + return $argument; + } } }, $operator->arguments); diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php index d7d0d00..89dc08d 100644 --- a/tests/SearchPluginTest.php +++ b/tests/SearchPluginTest.php @@ -60,7 +60,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { ->willReturn('foo'); $request = new Request('SEARCH', 'foo', [ - 'Content-Type' => 'text/plain' + 'Content-Type' => 'text/plain', ], fopen(__DIR__ . '/nofrom.xml', 'r')); $response = new Response(); @@ -75,7 +75,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { ->willReturn('foo'); $request = new Request('SEARCH', 'bar', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ], fopen(__DIR__ . '/nofrom.xml', 'r')); $response = new Response(); @@ -90,7 +90,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { ->willReturn('foo'); $request = new Request('SEARCH', 'foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ], fopen(__DIR__ . '/invalidtype.xml', 'r')); $response = new Response(); @@ -107,7 +107,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { ->willReturn('foo'); $request = new Request('SEARCH', 'foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ], fopen(__DIR__ . '/nofrom.xml', 'r')); $response = new Response(); @@ -171,7 +171,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/discover.xml', 'r')); @@ -184,10 +184,12 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $this->searchBackend->expects($this->once()) ->method('getPropertyDefinitionsForScope') ->willReturn([ - new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), new SearchPropertyDefinition('{DAV:}displayname', true, true, true), - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), ]); $plugin->searchHandler($request, $response); @@ -208,7 +210,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/discover.xml', 'r')); @@ -239,7 +241,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/invaliddiscover.xml', 'r')); @@ -266,7 +268,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/basicquery.xml', 'r')); @@ -276,17 +278,18 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { ->method('isValidScope') ->willReturn(true); - $lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER); + $lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER); $orderBy = [ - new \SearchDAV\Query\Order($lengthProp, \SearchDAV\Query\Order::ASC) + new \SearchDAV\Query\Order($lengthProp, \SearchDAV\Query\Order::ASC), ]; $select = [$lengthProp]; $from = [ - new Scope('/container1/', 'infinity', '/container1/') + new Scope('/container1/', 'infinity', '/container1/'), ]; $where = new \SearchDAV\Query\Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ $lengthProp, - new Literal(10000) + new Literal(10000), ]); $limit = new Limit(); $query = new Query($select, $from, $where, $orderBy, $limit); @@ -298,13 +301,13 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { new SearchResult( new Directory('/foo'), '/foo' - ) + ), ]); $this->searchBackend->expects($this->any()) ->method('getPropertyDefinitionsForScope') ->willReturn([ - $lengthProp + $lengthProp, ]); $plugin->searchHandler($request, $response); @@ -325,7 +328,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/nofrom.xml', 'r')); @@ -348,13 +351,14 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { ->method('getArbiterPath') ->willReturn('foo'); - $lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER); + $lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER); $plugin = new SearchPlugin($this->searchBackend); $server = new Server(); $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/nowhere.xml', 'r')); @@ -370,10 +374,10 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $this->searchBackend->expects($this->once()) ->method('search') - ->willReturnCallback(function(Query $query) { - $this->assertNull($query->where); - return []; - }); + ->willReturnCallback(function (Query $query) { + $this->assertNull($query->where); + return []; + }); $plugin->searchHandler($request, $response); @@ -390,7 +394,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/noselect.xml', 'r')); @@ -418,7 +422,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/invalid.xml', 'r')); @@ -467,7 +471,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/invalidwhere.xml', 'r')); @@ -483,7 +487,8 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $this->searchBackend->expects($this->once()) ->method('getPropertyDefinitionsForScope') ->willReturn([ - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), ]); $plugin->searchHandler($request, $response); @@ -491,40 +496,42 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $this->assertEquals(400, $response->getStatus()); } - public function testSearchQueryInvalidWhereNoProp() { - $this->searchBackend->expects($this->any()) - ->method('getArbiterPath') - ->willReturn('foo'); + public function testSearchQueryInvalidWhereNoProp() { + $this->searchBackend->expects($this->any()) + ->method('getArbiterPath') + ->willReturn('foo'); - $plugin = new SearchPlugin($this->searchBackend); - $server = new Server(); - $plugin->initialize($server); + $plugin = new SearchPlugin($this->searchBackend); + $server = new Server(); + $plugin->initialize($server); - $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' - ]); - $request->setBaseUrl('/index.php'); - $request->setBody(fopen(__DIR__ . '/invalidwherenoprop.xml', 'r')); - $response = new Response(); + $request = new Request('SEARCH', '/index.php/foo', [ + 'Content-Type' => 'text/xml', + ]); + $request->setBaseUrl('/index.php'); + $request->setBody(fopen(__DIR__ . '/invalidwherenoprop.xml', 'r')); + $response = new Response(); - $this->searchBackend->expects($this->any()) - ->method('isValidScope') - ->willReturn(true); + $this->searchBackend->expects($this->any()) + ->method('isValidScope') + ->willReturn(true); - $this->searchBackend->expects($this->never()) - ->method('search'); + $this->searchBackend->expects($this->never()) + ->method('search'); $this->searchBackend->expects($this->any()) ->method('getPropertyDefinitionsForScope') ->willReturn([ - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), - new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), ]); - $plugin->searchHandler($request, $response); + $plugin->searchHandler($request, $response); - $this->assertEquals(400, $response->getStatus()); - } + $this->assertEquals(400, $response->getStatus()); + } public function testSearchQueryInfiniteLoopEmptyLiteral() { $this->searchBackend->expects($this->any()) @@ -536,7 +543,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $plugin->initialize($server); $request = new Request('SEARCH', '/index.php/foo', [ - 'Content-Type' => 'text/xml' + 'Content-Type' => 'text/xml', ]); $request->setBaseUrl('/index.php'); $request->setBody(fopen(__DIR__ . '/infiniteloopemptyliteral.xml', 'r')); @@ -549,6 +556,15 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase { $this->searchBackend->expects($this->never()) ->method('search'); + $this->searchBackend->expects($this->any()) + ->method('getPropertyDefinitionsForScope') + ->willReturn([ + new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + ]); + $plugin->searchHandler($request, $response); $this->assertEquals(400, $response->getStatus()); From 76953efe15a198ecfd42f9be6b2a0915903fc53d Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Wed, 6 Nov 2019 14:28:07 +0100 Subject: [PATCH 10/29] update to phpunit 7 --- composer.json | 2 +- tests/PathHelperTest.php | 3 ++- tests/QueryParserTest.php | 3 ++- tests/SearchPluginTest.php | 7 ++----- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/composer.json b/composer.json index 52b8e58..6e7fe46 100644 --- a/composer.json +++ b/composer.json @@ -13,7 +13,7 @@ "sabre/dav": "^3.2.0" }, "require-dev": { - "phpunit/phpunit": "^4.8" + "phpunit/phpunit": "^7" }, "autoload": { "psr-4": { diff --git a/tests/PathHelperTest.php b/tests/PathHelperTest.php index 259ab2f..d0b27a1 100644 --- a/tests/PathHelperTest.php +++ b/tests/PathHelperTest.php @@ -21,10 +21,11 @@ namespace SearchDAV\Test; +use PHPUnit\Framework\TestCase; use Sabre\DAV\Server; use SearchDAV\DAV\PathHelper; -class PathHelperTest extends \PHPUnit_Framework_TestCase { +class PathHelperTest extends TestCase { public function uriProvider(){ return [ ['/', '', ''], diff --git a/tests/QueryParserTest.php b/tests/QueryParserTest.php index 57ffb00..974363b 100644 --- a/tests/QueryParserTest.php +++ b/tests/QueryParserTest.php @@ -22,6 +22,7 @@ namespace SearchDAV\Test; +use PHPUnit\Framework\TestCase; use Sabre\Xml\Service; use SearchDAV\DAV\QueryParser; use SearchDAV\XML\BasicSearch; @@ -33,7 +34,7 @@ use SearchDAV\XML\Scope; use SearchDAV\XML\SupportedQueryGrammar; -class QueryParserTest extends \PHPUnit_Framework_TestCase { +class QueryParserTest extends TestCase { public function testParseBasicQuery() { $query = file_get_contents(__DIR__ . '/basicquery.xml'); $parser = new QueryParser(); diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php index 89dc08d..b22dff6 100644 --- a/tests/SearchPluginTest.php +++ b/tests/SearchPluginTest.php @@ -22,6 +22,7 @@ namespace SearchDAV\Test; +use PHPUnit\Framework\TestCase; use Sabre\DAV\FS\Directory; use Sabre\DAV\INode; use Sabre\DAV\PropFind; @@ -29,21 +30,17 @@ use Sabre\DAV\Server; use Sabre\DAV\Xml\Service; use Sabre\HTTP\Request; use Sabre\HTTP\Response; -use Sabre\VObject\Parser\XML; use SearchDAV\Backend\ISearchBackend; use SearchDAV\Backend\SearchPropertyDefinition; use SearchDAV\Backend\SearchResult; use SearchDAV\DAV\SearchPlugin; use SearchDAV\Query\Query; -use SearchDAV\XML\BasicSearch; use SearchDAV\XML\Limit; use SearchDAV\XML\Literal; -use SearchDAV\XML\Operator; -use SearchDAV\XML\Order; use SearchDAV\XML\Scope; use SearchDAV\XML\SupportedQueryGrammar; -class SearchPluginTest extends \PHPUnit_Framework_TestCase { +class SearchPluginTest extends TestCase { /** @var ISearchBackend|\PHPUnit_Framework_MockObject_MockObject */ private $searchBackend; From 5ba2a3cc31d6726f245b5e3bc31d21e7dd55c600 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Wed, 6 Nov 2019 14:33:04 +0100 Subject: [PATCH 11/29] add some type hinting --- src/DAV/DiscoverHandler.php | 4 ++-- src/DAV/PathHelper.php | 2 +- src/DAV/SearchHandler.php | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/src/DAV/DiscoverHandler.php b/src/DAV/DiscoverHandler.php index 62fb5f8..e5a48a1 100644 --- a/src/DAV/DiscoverHandler.php +++ b/src/DAV/DiscoverHandler.php @@ -80,7 +80,7 @@ class DiscoverHandler { return false; } - private function hashDefinition(SearchPropertyDefinition $definition) { + private function hashDefinition(SearchPropertyDefinition $definition): string { return $definition->dataType . (($definition->searchable) ? '1' : '0') . (($definition->sortable) ? '1' : '0') @@ -91,7 +91,7 @@ class DiscoverHandler { * @param SearchPropertyDefinition[] $propertyDefinitions * @return BasicSearchSchema */ - private function getBasicSearchForProperties(array $propertyDefinitions) { + private function getBasicSearchForProperties(array $propertyDefinitions): BasicSearchSchema { /** @var PropDesc[] $groups */ $groups = []; foreach ($propertyDefinitions as $propertyDefinition) { diff --git a/src/DAV/PathHelper.php b/src/DAV/PathHelper.php index b572493..2c0faef 100644 --- a/src/DAV/PathHelper.php +++ b/src/DAV/PathHelper.php @@ -37,7 +37,7 @@ class PathHelper { $this->server = $server; } - public function getPathFromUri($uri) { + public function getPathFromUri($uri): ?string { if (strpos($uri, '://') === false) { return $uri; } diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index 8f6483e..85fe43b 100644 --- a/src/DAV/SearchHandler.php +++ b/src/DAV/SearchHandler.php @@ -96,7 +96,7 @@ class SearchHandler { * @return Query * @throws BadRequest */ - private function getQueryForXML(BasicSearch $xml, array $allProps) { + private function getQueryForXML(BasicSearch $xml, array $allProps): Query { $orderBy = array_map(function (\SearchDAV\XML\Order $order) use ($allProps) { if (!isset($allProps[$order->property])) { throw new BadRequest('requested order by property is not a valid property for this scope'); @@ -109,7 +109,7 @@ class SearchHandler { }, $xml->orderBy); $select = array_map(function ($propName) use ($allProps) { if (!isset($allProps[$propName])) { - return; + return null; } $prop = $allProps[$propName]; if (!$prop->selectable) { @@ -130,7 +130,7 @@ class SearchHandler { * @return Operator * @throws BadRequest */ - private function transformOperator(\SearchDAV\XML\Operator $operator, array $allProps) { + private function transformOperator(\SearchDAV\XML\Operator $operator, array $allProps): Operator { $arguments = array_map(function ($argument) use ($allProps) { if (is_string($argument)) { if (!isset($allProps[$argument])) { @@ -167,7 +167,7 @@ class SearchHandler { * @param int $depth * @return \Iterator */ - private function getPropertiesIteratorResults($results, $propertyNames = [], $depth = 0) { + private function getPropertiesIteratorResults($results, $propertyNames = [], $depth = 0): \Iterator { $propFindType = $propertyNames ? PropFind::NORMAL : PropFind::ALLPROPS; foreach ($results as $result) { From 1ee911ba45d0f0e607ed7fc5aa7f4eab25e04328 Mon Sep 17 00:00:00 2001 From: Daniel Kesselberg Date: Wed, 6 Nov 2019 17:01:22 +0100 Subject: [PATCH 12/29] Add test case for !$reader->read then break --- src/XML/Operator.php | 6 +++--- tests/QueryParserTest.php | 13 +++++++++++++ tests/invalidwherebroken.xml | 22 ++++++++++++++++++++++ 3 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 tests/invalidwherebroken.xml diff --git a/src/XML/Operator.php b/src/XML/Operator.php index 61f410a..36721c3 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -81,9 +81,9 @@ class Operator implements XmlDeserializable { $operator->arguments[] = $argument['value']; } } else { - if (!$reader->read()) { - break; - } + if (!$reader->read()) { + break; + } } } while ($reader->nodeType !== Reader::END_ELEMENT); diff --git a/tests/QueryParserTest.php b/tests/QueryParserTest.php index 974363b..df6d1eb 100644 --- a/tests/QueryParserTest.php +++ b/tests/QueryParserTest.php @@ -177,4 +177,17 @@ class QueryParserTest extends TestCase { new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::ASC) ], $search->orderBy); } + + /** + * @expectedException \Sabre\Xml\LibXMLException + * @expectedExceptionMessage Opening and ending tag mismatch: prop line 17 and gt + * on line 19, column 20 + * + * @throws \Sabre\Xml\ParseException + */ + public function testParseWhereBroken() + { + $query = file_get_contents(__DIR__ . '/invalidwherebroken.xml'); + (new QueryParser())->parse($query, null, $rootElementName); + } } diff --git a/tests/invalidwherebroken.xml b/tests/invalidwherebroken.xml new file mode 100644 index 0000000..04025dd --- /dev/null +++ b/tests/invalidwherebroken.xml @@ -0,0 +1,22 @@ + + + + + + + + + + + /container1/ + infinity + + + + + + 5 + + + + From 68d6c966a4fd34869e9863963e8cc5362bbdc0ec Mon Sep 17 00:00:00 2001 From: Daniel Kesselberg Date: Sat, 9 Nov 2019 10:51:25 +0100 Subject: [PATCH 13/29] Load tests only on dev --- composer.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/composer.json b/composer.json index 6e7fe46..1c71d39 100644 --- a/composer.json +++ b/composer.json @@ -17,7 +17,11 @@ }, "autoload": { "psr-4": { - "SearchDAV\\": "src/", + "SearchDAV\\": "src/" + } + }, + "autoload-dev": { + "psr-4": { "SearchDAV\\Test\\": "tests/" } } From 49c010f4d7c32724d564b0558361e3e2677f0909 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 6 Feb 2020 14:26:43 +0100 Subject: [PATCH 14/29] update sabredav and phpunit --- .gitignore | 2 ++ .travis.yml | 2 +- composer.json | 4 ++-- tests/DummyBackend.php | 1 - tests/QueryParserTest.php | 39 +++++++++++++++----------------------- tests/SearchPluginTest.php | 3 +-- tests/bootstrap.php | 2 +- 7 files changed, 22 insertions(+), 31 deletions(-) diff --git a/.gitignore b/.gitignore index 987e2a2..1c769fc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ composer.lock vendor +coverage.xml +.phpunit.result.cache diff --git a/.travis.yml b/.travis.yml index 2236f26..58f03a2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,8 +1,8 @@ language: php php: - - '7.1' - '7.2' - '7.3' + - '7.4' cache: directories: diff --git a/composer.json b/composer.json index 1c71d39..8988c35 100644 --- a/composer.json +++ b/composer.json @@ -10,10 +10,10 @@ ], "require": { "php": ">=7.1", - "sabre/dav": "^3.2.0" + "sabre/dav": "^4.0.0" }, "require-dev": { - "phpunit/phpunit": "^7" + "phpunit/phpunit": "^8" }, "autoload": { "psr-4": { diff --git a/tests/DummyBackend.php b/tests/DummyBackend.php index f5da86c..a54c79d 100644 --- a/tests/DummyBackend.php +++ b/tests/DummyBackend.php @@ -21,7 +21,6 @@ namespace SearchDAV\Test; - use Sabre\DAV\INode; use Sabre\DAV\SimpleFile; use SearchDAV\Backend\ISearchBackend; diff --git a/tests/QueryParserTest.php b/tests/QueryParserTest.php index df6d1eb..6203541 100644 --- a/tests/QueryParserTest.php +++ b/tests/QueryParserTest.php @@ -21,8 +21,8 @@ namespace SearchDAV\Test; - use PHPUnit\Framework\TestCase; +use Sabre\Xml\ParseException; use Sabre\Xml\Service; use SearchDAV\DAV\QueryParser; use SearchDAV\XML\BasicSearch; @@ -49,14 +49,14 @@ class QueryParserTest extends TestCase { $this->assertEquals(['{DAV:}getcontentlength'], $search->select); $this->assertEquals([ - new Scope('/container1/', 'infinity') + new Scope('/container1/', 'infinity'), ], $search->from); $this->assertEquals(new Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ '{DAV:}getcontentlength', - new Literal(10000) + new Literal(10000), ]), $search->where); $this->assertEquals([ - new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::ASC) + new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::ASC), ], $search->orderBy); } @@ -74,14 +74,14 @@ class QueryParserTest extends TestCase { $this->assertEquals(['{DAV:}getcontentlength'], $search->select); $this->assertEquals([ - new Scope('/container1/', 'infinity') + new Scope('/container1/', 'infinity'), ], $search->from); $this->assertEquals(new Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ '{DAV:}getcontentlength', - new Literal(10000) + new Literal(10000), ]), $search->where); $this->assertEquals([ - new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::DESC) + new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::DESC), ], $search->orderBy); } @@ -106,12 +106,10 @@ class QueryParserTest extends TestCase { $this->assertEquals([], $search->orderBy); } - /** - * @expectedException \Sabre\XML\ParseException - */ public function testParseNoFrom() { $query = file_get_contents(__DIR__ . '/nofrom.xml'); $parser = new QueryParser(); + $this->expectException(ParseException::class); $parser->parse($query, null, $rootElementName); } @@ -158,36 +156,29 @@ class QueryParserTest extends TestCase { $this->assertEquals(['{DAV:}getcontentlength'], $search->select); $this->assertEquals([ - new Scope('/container1/', 'infinity') + new Scope('/container1/', 'infinity'), ], $search->from); $this->assertEquals(new Operator(\SearchDAV\Query\Operator::OPERATION_AND, [ new Operator(\SearchDAV\Query\Operator::OPERATION_GREATER_THAN, [ '{DAV:}getcontentlength', - new Literal(10000) + new Literal(10000), ]), new Operator(\SearchDAV\Query\Operator::OPERATION_LESS_THAN, [ '{DAV:}getcontentlength', - new Literal(90000) + new Literal(90000), ]), new Operator(\SearchDAV\Query\Operator::OPERATION_CONTAINS, [ - 'Peter Forsberg' + 'Peter Forsberg', ]), ]), $search->where); $this->assertEquals([ - new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::ASC) + new Order('{DAV:}getcontentlength', \SearchDAV\Query\Order::ASC), ], $search->orderBy); } - /** - * @expectedException \Sabre\Xml\LibXMLException - * @expectedExceptionMessage Opening and ending tag mismatch: prop line 17 and gt - * on line 19, column 20 - * - * @throws \Sabre\Xml\ParseException - */ - public function testParseWhereBroken() - { + public function testParseWhereBroken() { $query = file_get_contents(__DIR__ . '/invalidwherebroken.xml'); + $this->expectException(ParseException::class); (new QueryParser())->parse($query, null, $rootElementName); } } diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php index b22dff6..53d4d19 100644 --- a/tests/SearchPluginTest.php +++ b/tests/SearchPluginTest.php @@ -21,7 +21,6 @@ namespace SearchDAV\Test; - use PHPUnit\Framework\TestCase; use Sabre\DAV\FS\Directory; use Sabre\DAV\INode; @@ -44,7 +43,7 @@ class SearchPluginTest extends TestCase { /** @var ISearchBackend|\PHPUnit_Framework_MockObject_MockObject */ private $searchBackend; - protected function setUp() { + protected function setUp(): void { parent::setUp(); $this->searchBackend = $this->getMockBuilder(ISearchBackend::class) diff --git a/tests/bootstrap.php b/tests/bootstrap.php index 52135e2..d21c14d 100644 --- a/tests/bootstrap.php +++ b/tests/bootstrap.php @@ -1,3 +1,3 @@ Date: Thu, 6 Feb 2020 14:41:14 +0100 Subject: [PATCH 15/29] add github actions ci --- .github/workflows/ci.yml | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 .github/workflows/ci.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..768c918 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,14 @@ +name: CI + +on: [push] + +jobs: + build-test: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v1 + - uses: php-actions/composer@v1 + - uses: php-actions/phpunit@v1.0.0 + with: + config: tests/phpunit.xml From 286f1527d472e8bb432ff28870e4b046027141cd Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 6 Feb 2020 14:56:15 +0100 Subject: [PATCH 16/29] scrutinizer config --- .scrutinizer.yml | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .scrutinizer.yml diff --git a/.scrutinizer.yml b/.scrutinizer.yml new file mode 100644 index 0000000..884d059 --- /dev/null +++ b/.scrutinizer.yml @@ -0,0 +1,6 @@ +build: + nodes: + analysis: + tests: + override: + - php-scrutinizer-run From c69806d900c2c9a5954bfabc80178d6eb0d63df4 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Thu, 6 Feb 2020 14:56:26 +0100 Subject: [PATCH 17/29] fix scrutinizer type warning --- src/DAV/SearchPlugin.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/DAV/SearchPlugin.php b/src/DAV/SearchPlugin.php index 113010b..17d44cc 100644 --- a/src/DAV/SearchPlugin.php +++ b/src/DAV/SearchPlugin.php @@ -108,7 +108,7 @@ class SearchPlugin extends ServerPlugin { try { $xml = $this->queryParser->parse( - $request->getBody(), + $request->getBodyAsString(), $request->getUrl(), $documentType ); From 9c1e52272c750f0ee543b43e62e1794cd3bfb212 Mon Sep 17 00:00:00 2001 From: Carl Schwan Date: Fri, 8 Apr 2022 15:57:51 +0200 Subject: [PATCH 18/29] Allow preloading of properties in one go Make it possible to not be affected by a N+1 issue when doing a search Signed-off-by: Carl Schwan --- src/Backend/ISearchBackend.php | 7 +++++++ src/DAV/SearchHandler.php | 5 +++++ 2 files changed, 12 insertions(+) diff --git a/src/Backend/ISearchBackend.php b/src/Backend/ISearchBackend.php index 21d577b..a4b510e 100644 --- a/src/Backend/ISearchBackend.php +++ b/src/Backend/ISearchBackend.php @@ -21,6 +21,7 @@ namespace SearchDAV\Backend; +use Sabre\DAV\INode; use SearchDAV\Query\Query; interface ISearchBackend { @@ -81,4 +82,10 @@ interface ISearchBackend { * @return SearchResult[] */ public function search(Query $query); + + /** + * @param INode[] $nodes + * @param string[] $requestProperties + */ + public function preloadPropertyFor(array $nodes, array $requestProperties): void; } diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index 85fe43b..a643062 100644 --- a/src/DAV/SearchHandler.php +++ b/src/DAV/SearchHandler.php @@ -22,6 +22,7 @@ namespace SearchDAV\DAV; use Sabre\DAV\Exception\BadRequest; +use Sabre\DAV\INode; use Sabre\DAV\PropFind; use Sabre\DAV\Server; use Sabre\HTTP\ResponseInterface; @@ -170,6 +171,10 @@ class SearchHandler { private function getPropertiesIteratorResults($results, $propertyNames = [], $depth = 0): \Iterator { $propFindType = $propertyNames ? PropFind::NORMAL : PropFind::ALLPROPS; + $this->searchBackend->preloadPropertyFor(array_map(function (SearchResult $result): INode { + return $result->node; + }, $results), $propertyNames); + foreach ($results as $result) { $node = $result->node; $propFind = new PropFind($result->href, (array)$propertyNames, $depth, $propFindType); From c5d79716d0d7a9c60f767ef2648db164a2cb04cb Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Fri, 8 Apr 2022 17:04:51 +0200 Subject: [PATCH 19/29] bumb ci versions --- .github/workflows/ci.yml | 15 +++++++++++---- tests/DummyBackend.php | 4 ++++ 2 files changed, 15 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 768c918..6ad7713 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,10 +5,17 @@ on: [push] jobs: build-test: runs-on: ubuntu-latest + strategy: + matrix: + php-versions: ['7.4', '8.0'] steps: - - uses: actions/checkout@v1 - - uses: php-actions/composer@v1 - - uses: php-actions/phpunit@v1.0.0 + - uses: actions/checkout@v2 + - name: Set up php${{ matrix.php-versons }} + uses: shivammathur/setup-php@master with: - config: tests/phpunit.xml + php-version: ${{ matrix.php-versions }} + - name: Install dependencies + run: composer i + - name: PHPUnit + run: ./vendor/phpunit/phpunit/phpunit -c tests/phpunit.xml diff --git a/tests/DummyBackend.php b/tests/DummyBackend.php index a54c79d..6ca63c1 100644 --- a/tests/DummyBackend.php +++ b/tests/DummyBackend.php @@ -52,4 +52,8 @@ class DummyBackend implements ISearchBackend { new SearchResult(new SimpleFile('foo.txt', 'foobar', 'text/plain'), '/bar/foo.txt') ]; } + + public function preloadPropertyFor(array $nodes, array $requestProperties): void { + + } } From 1290acf6754ebfe21b0dffc9707e156b8c54a3e7 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Fri, 8 Apr 2022 17:17:26 +0200 Subject: [PATCH 20/29] lint/psalm --- .github/workflows/lint.yml | 41 +++++++++++++++++++++++++++ .github/workflows/static-analysis.yml | 20 +++++++++++++ .gitignore | 1 + .php_cs.dist | 15 ++++++++++ composer.json | 12 +++++++- psalm.xml | 15 ++++++++++ 6 files changed, 103 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/lint.yml create mode 100644 .github/workflows/static-analysis.yml create mode 100644 .php_cs.dist create mode 100644 psalm.xml diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..75f0f34 --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,41 @@ +name: Php Lint +on: [push, pull_request] + +jobs: + php-linters: + runs-on: ubuntu-20.04 + strategy: + matrix: + php-versions: ['7.4', '8.0'] + name: php${{ matrix.php-versions }} lint + steps: + - name: Checkout + uses: actions/checkout@master + - name: Set up php${{ matrix.php-versons }} + uses: shivammathur/setup-php@master + with: + php-version: ${{ matrix.php-versions }} + coverage: none + extensions: inotify + - name: Install dependencies + run: composer i + - name: Lint + run: composer run lint + + php-cs-fixer: + name: php-cs check + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@master + - name: Set up php${{ matrix.php-versions }} + uses: shivammathur/setup-php@master + with: + php-version: 7.4 + tools: composer:v1 + coverage: none + extensions: inotify + - name: Install dependencies + run: composer i + - name: Run coding standards check + run: composer run cs:check diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml new file mode 100644 index 0000000..58c8155 --- /dev/null +++ b/.github/workflows/static-analysis.yml @@ -0,0 +1,20 @@ +name: Php Static analysis +on: [push, pull_request] + +jobs: + static-psalm-analysis: + runs-on: ubuntu-20.04 + steps: + - name: Checkout + uses: actions/checkout@master + - name: Set up php + uses: shivammathur/setup-php@master + with: + php-version: 7.4 + tools: composer:v1 + coverage: none + extensions: redis + - name: Install dependencies + run: composer i + - name: Run coding standards check + run: composer run psalm diff --git a/.gitignore b/.gitignore index 1c769fc..3ca03c7 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ composer.lock vendor coverage.xml .phpunit.result.cache +*.cache diff --git a/.php_cs.dist b/.php_cs.dist new file mode 100644 index 0000000..a2fdf19 --- /dev/null +++ b/.php_cs.dist @@ -0,0 +1,15 @@ +exclude('vendor') + ->in(__DIR__) +; +return PhpCsFixer\Config::create() + ->setRules([ + '@PSR2' => true, + 'array_syntax' => ['syntax' => 'short'], + 'braces' => ['position_after_functions_and_oop_constructs' => 'same'], + 'binary_operator_spaces' => ['align_double_arrow' => true, 'align_equals' => false], + ]) + ->setIndent("\t") + ->setFinder($finder) + ; diff --git a/composer.json b/composer.json index 8988c35..1c76777 100644 --- a/composer.json +++ b/composer.json @@ -9,10 +9,14 @@ } ], "require": { - "php": ">=7.1", + "php": ">=7.3 || >=8.0", "sabre/dav": "^4.0.0" }, "require-dev": { + "php-parallel-lint/php-parallel-lint": "^1.0", + "friendsofphp/php-cs-fixer": "^2", + "phpstan/phpstan": "^0.12", + "psalm/phar": "^4.3", "phpunit/phpunit": "^8" }, "autoload": { @@ -24,5 +28,11 @@ "psr-4": { "SearchDAV\\Test\\": "tests/" } + }, + "scripts": { + "lint": "parallel-lint --exclude src --exclude vendor --exclude target --exclude build .", + "cs:check": "php-cs-fixer fix --dry-run --diff", + "cs:fix": "php-cs-fixer fix", + "psalm": "psalm.phar" } } diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 0000000..30258a7 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,15 @@ + + + + + + + + + From 3d85afde98c4d3df4b62af19fa1d8c4a2558110a Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Fri, 8 Apr 2022 17:25:10 +0200 Subject: [PATCH 21/29] psalm fixes --- src/DAV/SearchPlugin.php | 10 +++++----- src/Query/Operator.php | 5 +++-- src/Query/Query.php | 2 +- src/XML/BasicSearch.php | 10 +++++----- src/XML/Operator.php | 4 ++-- src/XML/QueryDiscoverResponse.php | 3 +++ 6 files changed, 19 insertions(+), 15 deletions(-) diff --git a/src/DAV/SearchPlugin.php b/src/DAV/SearchPlugin.php index 17d44cc..7690bb5 100644 --- a/src/DAV/SearchPlugin.php +++ b/src/DAV/SearchPlugin.php @@ -76,11 +76,11 @@ class SearchPlugin extends ServerPlugin { /** * SEARCH is allowed for users files * - * @param string $uri + * @param string $path * @return array */ - public function getHTTPMethods($uri) { - $path = $this->pathHelper->getPathFromUri($uri); + public function getHTTPMethods($path) { + $path = $this->pathHelper->getPathFromUri($path); if ($this->searchBackend->getArbiterPath() === $path) { return ['SEARCH']; } else { @@ -95,9 +95,9 @@ class SearchPlugin extends ServerPlugin { } public function searchHandler(RequestInterface $request, ResponseInterface $response) { - $contentType = $request->getHeader('Content-Type'); + $contentType = $request->getHeader('Content-Type') ?? ''; - // Currently we only support xml search queries + // Currently, we only support xml search queries if ((strpos($contentType, 'text/xml') === false) && (strpos($contentType, 'application/xml') === false)) { return true; } diff --git a/src/Query/Operator.php b/src/Query/Operator.php index 198d1fb..4390bdd 100644 --- a/src/Query/Operator.php +++ b/src/Query/Operator.php @@ -41,14 +41,15 @@ class Operator { * The type of operation, one of the Operator::OPERATION_* constants */ public $type; + /** - * @var (Literal|SearchPropDefinition|Operation)[] + * @var (Literal|\SearchDAV\Backend\SearchPropertyDefinition|Operator)[] * * The list of arguments for the operation * * - SearchPropDefinition: property for comparison * - Literal: literal value for comparison - * - Operation: nested operation for and/or/not operations + * - Operator: nested operation for and/or/not operations * * Which type and what number of argument an Operator takes depends on the operator type. */ diff --git a/src/Query/Query.php b/src/Query/Query.php index 613c369..c64e8cf 100644 --- a/src/Query/Query.php +++ b/src/Query/Query.php @@ -38,7 +38,7 @@ class Query { */ public $from; /** - * @var Operator + * @var ?Operator * * The search operator, either a comparison ('gt', 'eq', ...) or a boolean operator ('and', 'or', 'not') */ diff --git a/src/XML/BasicSearch.php b/src/XML/BasicSearch.php index 269edb0..7bc3b11 100644 --- a/src/XML/BasicSearch.php +++ b/src/XML/BasicSearch.php @@ -42,7 +42,7 @@ class BasicSearch implements XmlDeserializable { */ public $from; /** - * @var Operator + * @var ?Operator * * The search operator, either a comparison ('gt', 'eq', ...) or a boolean operator ('and', 'or', 'not') */ @@ -79,11 +79,11 @@ class BasicSearch implements XmlDeserializable { throw new ParseException('Missing {DAV:}from when parsing {DAV:}basicsearch'); } - $search->select = isset($elements['{DAV:}select']) ? $elements['{DAV:}select'] : []; + $search->select = $elements['{DAV:}select'] ?? []; $search->from = $elements['{DAV:}from']; - $search->where = isset($elements['{DAV:}where']) ? $elements['{DAV:}where'] : null; - $search->orderBy = isset($elements['{DAV:}orderby']) ? $elements['{DAV:}orderby'] : []; - $search->limit = isset($elements['{DAV:}limit']) ? $elements['{DAV:}limit'] : new Limit(); + $search->where = $elements['{DAV:}where'] ?? null; + $search->orderBy = $elements['{DAV:}orderby'] ?? []; + $search->limit = $elements['{DAV:}limit'] ?? new Limit(); return $search; } diff --git a/src/XML/Operator.php b/src/XML/Operator.php index 36721c3..1d6a176 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -33,7 +33,7 @@ class Operator implements XmlDeserializable { */ public $type; /** - * @var (Literal|string|Operation)[] + * @var (Literal|string|Operator)[] * * The list of arguments for the operation * @@ -59,7 +59,7 @@ class Operator implements XmlDeserializable { static function xmlDeserialize(Reader $reader): Operator { $operator = new self(); - $operator->type = $reader->getClark(); + $operator->type = $reader->getClark() ?? ''; if ($reader->isEmptyElement) { $reader->next(); return $operator; diff --git a/src/XML/QueryDiscoverResponse.php b/src/XML/QueryDiscoverResponse.php index 802fdcd..1f63a61 100644 --- a/src/XML/QueryDiscoverResponse.php +++ b/src/XML/QueryDiscoverResponse.php @@ -39,6 +39,9 @@ class QueryDiscoverResponse extends Response { * @param null|int|string $httpStatus */ function __construct($href, BasicSearchSchema $schema = null, $httpStatus = null) { + if ($httpStatus !== null) { + $httpStatus = (string)$httpStatus; + } parent::__construct($href, [], $httpStatus); $this->schema = $schema; From 4d51484de3fc1f9aa3ca7aef9b5cb57154d00137 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Fri, 8 Apr 2022 17:28:32 +0200 Subject: [PATCH 22/29] fmt --- src/Backend/SearchResult.php | 1 - src/DAV/QueryParser.php | 40 +++++++-------- src/DAV/SearchHandler.php | 6 ++- src/Query/Limit.php | 1 - src/Query/Literal.php | 1 - src/Query/Order.php | 1 - src/Query/Query.php | 1 - src/Query/Scope.php | 1 - src/XML/BasicSearch.php | 2 +- src/XML/BasicSearchSchema.php | 7 ++- src/XML/Limit.php | 2 +- src/XML/Literal.php | 3 +- src/XML/Operator.php | 2 +- src/XML/Order.php | 3 +- src/XML/PropDesc.php | 5 +- src/XML/QueryDiscoverResponse.php | 8 ++- src/XML/Scope.php | 2 +- src/XML/SupportedQueryGrammar.php | 3 +- tests/DummyBackend.php | 1 - tests/PathHelperTest.php | 2 +- tests/QueryParserTest.php | 1 - tests/SearchPluginTest.php | 82 ++++++++++++++++++++++++------- 22 files changed, 103 insertions(+), 72 deletions(-) diff --git a/src/Backend/SearchResult.php b/src/Backend/SearchResult.php index 43ee333..97c5eae 100644 --- a/src/Backend/SearchResult.php +++ b/src/Backend/SearchResult.php @@ -21,7 +21,6 @@ namespace SearchDAV\Backend; - use Sabre\DAV\INode; class SearchResult { diff --git a/src/DAV/QueryParser.php b/src/DAV/QueryParser.php index 44c594b..55e5f2d 100644 --- a/src/DAV/QueryParser.php +++ b/src/DAV/QueryParser.php @@ -33,19 +33,19 @@ use SearchDAV\XML\Scope; class QueryParser extends Service { public $namespaceMap = [ - 'DAV:' => 'd', - 'http://sabredav.org/ns' => 's', + 'DAV:' => 'd', + 'http://sabredav.org/ns' => 's', 'http://www.w3.org/2001/XMLSchema' => 'xs', - SearchPlugin::SEARCHDAV_NS => 'sd' + SearchPlugin::SEARCHDAV_NS => 'sd' ]; public function __construct() { $this->elementMap = [ - '{DAV:}literal' => Literal::class, - '{DAV:}searchrequest' => Element\KeyValue::class, + '{DAV:}literal' => Literal::class, + '{DAV:}searchrequest' => Element\KeyValue::class, '{DAV:}query-schema-discovery' => Element\KeyValue::class, - '{DAV:}basicsearch' => BasicSearch::class, - '{DAV:}select' => function (Reader $reader) { + '{DAV:}basicsearch' => BasicSearch::class, + '{DAV:}select' => function (Reader $reader) { return \Sabre\Xml\Deserializer\keyValue($reader, '{DAV:}scope')['{DAV:}prop']; }, '{DAV:}from' => function (Reader $reader) { @@ -61,20 +61,20 @@ class QueryParser extends Service { }, $reader->parseGetElements()); return (isset($operators[0])) ? $operators[0] : null; }, - '{DAV:}prop' => Element\Elements::class, - '{DAV:}order' => Order::class, - '{DAV:}eq' => Operator::class, - '{DAV:}gt' => Operator::class, - '{DAV:}gte' => Operator::class, - '{DAV:}lt' => Operator::class, - '{DAV:}lte' => Operator::class, - '{DAV:}and' => Operator::class, - '{DAV:}or' => Operator::class, - '{DAV:}like' => Operator::class, - '{DAV:}contains' => Operator::class, - '{DAV:}not' => Operator::class, + '{DAV:}prop' => Element\Elements::class, + '{DAV:}order' => Order::class, + '{DAV:}eq' => Operator::class, + '{DAV:}gt' => Operator::class, + '{DAV:}gte' => Operator::class, + '{DAV:}lt' => Operator::class, + '{DAV:}lte' => Operator::class, + '{DAV:}and' => Operator::class, + '{DAV:}or' => Operator::class, + '{DAV:}like' => Operator::class, + '{DAV:}contains' => Operator::class, + '{DAV:}not' => Operator::class, '{DAV:}is-collection' => Operator::class, - '{DAV:}limit' => Limit::class, + '{DAV:}limit' => Limit::class, ]; } } diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index a643062..3d20cbf 100644 --- a/src/DAV/SearchHandler.php +++ b/src/DAV/SearchHandler.php @@ -85,8 +85,10 @@ class SearchHandler { $response->setBody($e->getMessage()); return false; } - $data = $this->server->generateMultiStatus(iterator_to_array($this->getPropertiesIteratorResults($results, - $query->select)), false); + $data = $this->server->generateMultiStatus(iterator_to_array($this->getPropertiesIteratorResults( + $results, + $query->select + )), false); $response->setBody($data); return false; } diff --git a/src/Query/Limit.php b/src/Query/Limit.php index e6b4867..f59550f 100644 --- a/src/Query/Limit.php +++ b/src/Query/Limit.php @@ -21,7 +21,6 @@ namespace SearchDAV\Query; - class Limit { /** * @var integer diff --git a/src/Query/Literal.php b/src/Query/Literal.php index 862a412..99ce07a 100644 --- a/src/Query/Literal.php +++ b/src/Query/Literal.php @@ -21,7 +21,6 @@ namespace SearchDAV\Query; - class Literal { /** * @var string|boolean|\DateTime|integer diff --git a/src/Query/Order.php b/src/Query/Order.php index c6afcee..20f69f6 100644 --- a/src/Query/Order.php +++ b/src/Query/Order.php @@ -21,7 +21,6 @@ namespace SearchDAV\Query; - use SearchDAV\Backend\SearchPropertyDefinition; class Order { diff --git a/src/Query/Query.php b/src/Query/Query.php index c64e8cf..107b0d3 100644 --- a/src/Query/Query.php +++ b/src/Query/Query.php @@ -21,7 +21,6 @@ namespace SearchDAV\Query; - use SearchDAV\Backend\SearchPropertyDefinition; class Query { diff --git a/src/Query/Scope.php b/src/Query/Scope.php index 9c342c8..faded1c 100644 --- a/src/Query/Scope.php +++ b/src/Query/Scope.php @@ -21,7 +21,6 @@ namespace SearchDAV\Query; - class Scope { /** * @var string diff --git a/src/XML/BasicSearch.php b/src/XML/BasicSearch.php index 7bc3b11..0227927 100644 --- a/src/XML/BasicSearch.php +++ b/src/XML/BasicSearch.php @@ -70,7 +70,7 @@ class BasicSearch implements XmlDeserializable { * @return BasicSearch * @throws ParseException */ - static function xmlDeserialize(Reader $reader): BasicSearch { + public static function xmlDeserialize(Reader $reader): BasicSearch { $search = new self(); $elements = \Sabre\Xml\Deserializer\keyValue($reader); diff --git a/src/XML/BasicSearchSchema.php b/src/XML/BasicSearchSchema.php index edda372..d2616c4 100644 --- a/src/XML/BasicSearchSchema.php +++ b/src/XML/BasicSearchSchema.php @@ -21,7 +21,6 @@ namespace SearchDAV\XML; - use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; @@ -38,10 +37,10 @@ class BasicSearchSchema implements XmlSerializable { $this->properties = $properties; } - function xmlSerialize(Writer $writer) { - $childs = array_map(function(PropDesc $propDesc) { + public function xmlSerialize(Writer $writer) { + $childs = array_map(function (PropDesc $propDesc) { return [ - 'name' => '{DAV:}propdesc', + 'name' => '{DAV:}propdesc', 'value' => $propDesc ]; }, $this->properties); diff --git a/src/XML/Limit.php b/src/XML/Limit.php index 26d7866..71e356c 100644 --- a/src/XML/Limit.php +++ b/src/XML/Limit.php @@ -29,7 +29,7 @@ use SearchDAV\DAV\SearchPlugin; * The limit and offset of a search query */ class Limit extends \SearchDAV\Query\Limit implements XmlDeserializable { - static function xmlDeserialize(Reader $reader): Limit { + public static function xmlDeserialize(Reader $reader): Limit { $limit = new self(); $elements = \Sabre\Xml\Deserializer\keyValue($reader); diff --git a/src/XML/Literal.php b/src/XML/Literal.php index 92c76ca..dc1f69d 100644 --- a/src/XML/Literal.php +++ b/src/XML/Literal.php @@ -21,12 +21,11 @@ namespace SearchDAV\XML; - use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; class Literal extends \SearchDAV\Query\Literal implements XmlDeserializable { - static function xmlDeserialize(Reader $reader): Literal { + public static function xmlDeserialize(Reader $reader): Literal { $literal = new self(); if ($reader->isEmptyElement) { diff --git a/src/XML/Operator.php b/src/XML/Operator.php index 1d6a176..f7a714c 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -56,7 +56,7 @@ class Operator implements XmlDeserializable { $this->arguments = $arguments; } - static function xmlDeserialize(Reader $reader): Operator { + public static function xmlDeserialize(Reader $reader): Operator { $operator = new self(); $operator->type = $reader->getClark() ?? ''; diff --git a/src/XML/Order.php b/src/XML/Order.php index 7aae162..e675f78 100644 --- a/src/XML/Order.php +++ b/src/XML/Order.php @@ -21,7 +21,6 @@ namespace SearchDAV\XML; - use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; @@ -50,7 +49,7 @@ class Order implements XmlDeserializable { $this->order = $order; } - static function xmlDeserialize(Reader $reader): Order { + public static function xmlDeserialize(Reader $reader): Order { $order = new self(); $childs = \Sabre\Xml\Deserializer\keyValue($reader); diff --git a/src/XML/PropDesc.php b/src/XML/PropDesc.php index ab503b3..0cfc848 100644 --- a/src/XML/PropDesc.php +++ b/src/XML/PropDesc.php @@ -21,7 +21,6 @@ namespace SearchDAV\XML; - use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; @@ -47,7 +46,7 @@ class PropDesc implements XmlSerializable { */ public $sortable; - function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer) { $data = [ '{DAV:}dataType' => [$this->dataType => null] ]; @@ -62,7 +61,7 @@ class PropDesc implements XmlSerializable { } $writer->write(array_map(function ($propName) { return [ - 'name' => '{DAV:}prop', + 'name' => '{DAV:}prop', 'value' => $propName ]; }, $this->properties)); diff --git a/src/XML/QueryDiscoverResponse.php b/src/XML/QueryDiscoverResponse.php index 1f63a61..d9af76c 100644 --- a/src/XML/QueryDiscoverResponse.php +++ b/src/XML/QueryDiscoverResponse.php @@ -21,7 +21,6 @@ namespace SearchDAV\XML; - use Sabre\DAV\Xml\Element\Response; use Sabre\Xml\Writer; @@ -38,16 +37,15 @@ class QueryDiscoverResponse extends Response { * @param BasicSearchSchema|null $schema * @param null|int|string $httpStatus */ - function __construct($href, BasicSearchSchema $schema = null, $httpStatus = null) { + public function __construct($href, BasicSearchSchema $schema = null, $httpStatus = null) { if ($httpStatus !== null) { $httpStatus = (string)$httpStatus; } parent::__construct($href, [], $httpStatus); $this->schema = $schema; - } - function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer) { if ($status = $this->getHTTPStatus()) { $writer->writeElement('{DAV:}status', 'HTTP/1.1 ' . $status . ' ' . \Sabre\HTTP\Response::$statusCodes[$status]); } @@ -55,7 +53,7 @@ class QueryDiscoverResponse extends Response { if ($this->schema) { $writer->writeElement('{DAV:}query-schema', [ - '{DAV:}basicsearchschema' => $this->schema + '{DAV:}basicsearchschema' => $this->schema ]); } } diff --git a/src/XML/Scope.php b/src/XML/Scope.php index 78d4ba4..6fb7c0f 100644 --- a/src/XML/Scope.php +++ b/src/XML/Scope.php @@ -25,7 +25,7 @@ use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; class Scope extends \SearchDAV\Query\Scope implements XmlDeserializable { - static function xmlDeserialize(Reader $reader): Scope { + public static function xmlDeserialize(Reader $reader): Scope { $scope = new self(); $values = \Sabre\Xml\Deserializer\keyValue($reader); diff --git a/src/XML/SupportedQueryGrammar.php b/src/XML/SupportedQueryGrammar.php index ddb4e33..12e84e5 100644 --- a/src/XML/SupportedQueryGrammar.php +++ b/src/XML/SupportedQueryGrammar.php @@ -21,7 +21,6 @@ namespace SearchDAV\XML; - use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; @@ -30,7 +29,7 @@ class SupportedQueryGrammar implements XmlSerializable { public $grammar = self::GRAMMAR_BASICSEARCH; - function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer) { $writer->startElement('{DAV:}supported-query-grammar'); $writer->startElement('{DAV:}grammar'); $writer->startElement($this->grammar); diff --git a/tests/DummyBackend.php b/tests/DummyBackend.php index 6ca63c1..4f0b9ef 100644 --- a/tests/DummyBackend.php +++ b/tests/DummyBackend.php @@ -54,6 +54,5 @@ class DummyBackend implements ISearchBackend { } public function preloadPropertyFor(array $nodes, array $requestProperties): void { - } } diff --git a/tests/PathHelperTest.php b/tests/PathHelperTest.php index d0b27a1..1a83a6a 100644 --- a/tests/PathHelperTest.php +++ b/tests/PathHelperTest.php @@ -26,7 +26,7 @@ use Sabre\DAV\Server; use SearchDAV\DAV\PathHelper; class PathHelperTest extends TestCase { - public function uriProvider(){ + public function uriProvider() { return [ ['/', '', ''], ['/index.php/', 'foo', 'foo'], diff --git a/tests/QueryParserTest.php b/tests/QueryParserTest.php index 6203541..84e6b8c 100644 --- a/tests/QueryParserTest.php +++ b/tests/QueryParserTest.php @@ -33,7 +33,6 @@ use SearchDAV\XML\Order; use SearchDAV\XML\Scope; use SearchDAV\XML\SupportedQueryGrammar; - class QueryParserTest extends TestCase { public function testParseBasicQuery() { $query = file_get_contents(__DIR__ . '/basicquery.xml'); diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php index 53d4d19..d97e91e 100644 --- a/tests/SearchPluginTest.php +++ b/tests/SearchPluginTest.php @@ -180,12 +180,22 @@ class SearchPluginTest extends TestCase { $this->searchBackend->expects($this->once()) ->method('getPropertyDefinitionsForScope') ->willReturn([ - new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ), new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), new SearchPropertyDefinition('{DAV:}displayname', true, true, true), - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition( + '{http://ns.nextcloud.com:}fileid', + false, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ), ]); $plugin->searchHandler($request, $response); @@ -274,8 +284,13 @@ class SearchPluginTest extends TestCase { ->method('isValidScope') ->willReturn(true); - $lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER); + $lengthProp = new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ); $orderBy = [ new \SearchDAV\Query\Order($lengthProp, \SearchDAV\Query\Order::ASC), ]; @@ -347,8 +362,13 @@ class SearchPluginTest extends TestCase { ->method('getArbiterPath') ->willReturn('foo'); - $lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER); + $lengthProp = new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ); $plugin = new SearchPlugin($this->searchBackend); $server = new Server(); $plugin->initialize($server); @@ -483,8 +503,13 @@ class SearchPluginTest extends TestCase { $this->searchBackend->expects($this->once()) ->method('getPropertyDefinitionsForScope') ->willReturn([ - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition( + '{http://ns.nextcloud.com:}fileid', + false, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ), ]); $plugin->searchHandler($request, $response); @@ -518,10 +543,20 @@ class SearchPluginTest extends TestCase { $this->searchBackend->expects($this->any()) ->method('getPropertyDefinitionsForScope') ->willReturn([ - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), - new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition( + '{http://ns.nextcloud.com:}fileid', + false, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ), + new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ), ]); $plugin->searchHandler($request, $response); @@ -555,15 +590,24 @@ class SearchPluginTest extends TestCase { $this->searchBackend->expects($this->any()) ->method('getPropertyDefinitionsForScope') ->willReturn([ - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), - new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition( + '{http://ns.nextcloud.com:}fileid', + false, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ), + new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + ), ]); $plugin->searchHandler($request, $response); $this->assertEquals(400, $response->getStatus()); } - } From b47321646b161a8392dbe790f9101f95cf5f5afb Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Fri, 8 Apr 2022 17:29:52 +0200 Subject: [PATCH 23/29] add phpstan in ci --- .github/workflows/static-analysis.yml | 18 +++++++++++++++++- composer.json | 3 ++- 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml index 58c8155..b286401 100644 --- a/.github/workflows/static-analysis.yml +++ b/.github/workflows/static-analysis.yml @@ -2,7 +2,7 @@ name: Php Static analysis on: [push, pull_request] jobs: - static-psalm-analysis: + psalm: runs-on: ubuntu-20.04 steps: - name: Checkout @@ -18,3 +18,19 @@ jobs: run: composer i - name: Run coding standards check run: composer run psalm + phpstan: + runs-on: ubuntu-20.04 + steps: + - name: Checkout + uses: actions/checkout@master + - name: Set up php + uses: shivammathur/setup-php@master + with: + php-version: 7.4 + tools: composer:v1 + coverage: none + extensions: redis + - name: Install dependencies + run: composer i + - name: Run coding standards check + run: composer run psalm diff --git a/composer.json b/composer.json index 1c76777..25e7143 100644 --- a/composer.json +++ b/composer.json @@ -33,6 +33,7 @@ "lint": "parallel-lint --exclude src --exclude vendor --exclude target --exclude build .", "cs:check": "php-cs-fixer fix --dry-run --diff", "cs:fix": "php-cs-fixer fix", - "psalm": "psalm.phar" + "psalm": "psalm.phar", + "phpstan": "phpstan analyse --level 5 src" } } From 721b8825d83034c421067046450481347ae142e6 Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Fri, 8 Apr 2022 17:33:30 +0200 Subject: [PATCH 24/29] comment --- src/Backend/ISearchBackend.php | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/Backend/ISearchBackend.php b/src/Backend/ISearchBackend.php index a4b510e..11ffdb7 100644 --- a/src/Backend/ISearchBackend.php +++ b/src/Backend/ISearchBackend.php @@ -84,6 +84,9 @@ interface ISearchBackend { public function search(Query $query); /** + * Called by the search plugin once the nodes to be returned have been found. + * This can be used to more efficiently load the requested properties for the results. + * * @param INode[] $nodes * @param string[] $requestProperties */ From d3eb42cd90ed7be9c8f9b2cb1ca017449080600a Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Fri, 8 Apr 2022 17:36:08 +0200 Subject: [PATCH 25/29] more types --- src/Backend/ISearchBackend.php | 8 ++++---- src/Backend/SearchPropertyDefinition.php | 2 +- src/Backend/SearchResult.php | 2 +- src/DAV/DiscoverHandler.php | 2 +- src/DAV/PathHelper.php | 2 +- src/DAV/SearchHandler.php | 12 ++++++------ src/DAV/SearchPlugin.php | 12 ++++++------ src/Query/Operator.php | 2 +- src/XML/BasicSearchSchema.php | 2 +- src/XML/Operator.php | 2 +- src/XML/PropDesc.php | 2 +- src/XML/QueryDiscoverResponse.php | 2 +- src/XML/SupportedQueryGrammar.php | 8 +++----- tests/DummyBackend.php | 8 ++++---- 14 files changed, 32 insertions(+), 34 deletions(-) diff --git a/src/Backend/ISearchBackend.php b/src/Backend/ISearchBackend.php index 11ffdb7..6a1defc 100644 --- a/src/Backend/ISearchBackend.php +++ b/src/Backend/ISearchBackend.php @@ -38,7 +38,7 @@ interface ISearchBackend { * * @return string */ - public function getArbiterPath(); + public function getArbiterPath(): string; /** * Whether or not the search backend supports search requests on this scope @@ -55,7 +55,7 @@ interface ISearchBackend { * @param string|null $path the path of the search scope relative to the dav server, or null if the scope is outside the dav server * @return bool */ - public function isValidScope($href, $depth, $path); + public function isValidScope(string $href, $depth, ?string $path): bool; /** * List the available properties that can be used in search @@ -69,7 +69,7 @@ interface ISearchBackend { * @param string|null $path the path of the search scope relative to the dav server, or null if the scope is outside the dav server * @return SearchPropertyDefinition[] */ - public function getPropertyDefinitionsForScope($href, $path); + public function getPropertyDefinitionsForScope(string $href, ?string $path): array; /** * Preform the search request @@ -81,7 +81,7 @@ interface ISearchBackend { * @param Query $query * @return SearchResult[] */ - public function search(Query $query); + public function search(Query $query): array; /** * Called by the search plugin once the nodes to be returned have been found. diff --git a/src/Backend/SearchPropertyDefinition.php b/src/Backend/SearchPropertyDefinition.php index daa22bd..f4a7f3e 100644 --- a/src/Backend/SearchPropertyDefinition.php +++ b/src/Backend/SearchPropertyDefinition.php @@ -54,7 +54,7 @@ class SearchPropertyDefinition { * @param string $dataType the datatype of the property, one of the SearchProperty::DATATYPE_ constants or any XSD datatype in clark notation * @param bool $caseSensitive whether or not comparisons on the property are case sensitive, only applies to string propertries */ - public function __construct($name, $searchable, $selectable, $sortable, $dataType = self::DATATYPE_STRING, $caseSensitive = true) { + public function __construct(string $name, bool $selectable, bool $searchable, bool $sortable, string $dataType = self::DATATYPE_STRING, bool $caseSensitive = true) { $this->searchable = $searchable; $this->selectable = $selectable; $this->sortable = $sortable; diff --git a/src/Backend/SearchResult.php b/src/Backend/SearchResult.php index 97c5eae..af48506 100644 --- a/src/Backend/SearchResult.php +++ b/src/Backend/SearchResult.php @@ -35,7 +35,7 @@ class SearchResult { * @param INode $node * @param string $href */ - public function __construct(INode $node, $href) { + public function __construct(INode $node, string $href) { $this->node = $node; $this->href = $href; } diff --git a/src/DAV/DiscoverHandler.php b/src/DAV/DiscoverHandler.php index e5a48a1..84cc571 100644 --- a/src/DAV/DiscoverHandler.php +++ b/src/DAV/DiscoverHandler.php @@ -54,7 +54,7 @@ class DiscoverHandler { $this->queryParser = $queryParser; } - public function handelDiscoverRequest($xml, RequestInterface $request, ResponseInterface $response) { + public function handelDiscoverRequest($xml, RequestInterface $request, ResponseInterface $response): bool { if (!isset($xml['{DAV:}basicsearch'])) { $response->setStatus(400); $response->setBody('Unexpected xml content for query-schema-discovery, expected basicsearch'); diff --git a/src/DAV/PathHelper.php b/src/DAV/PathHelper.php index 2c0faef..04098c7 100644 --- a/src/DAV/PathHelper.php +++ b/src/DAV/PathHelper.php @@ -37,7 +37,7 @@ class PathHelper { $this->server = $server; } - public function getPathFromUri($uri): ?string { + public function getPathFromUri(string $uri): ?string { if (strpos($uri, '://') === false) { return $uri; } diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index 3d20cbf..27e4da2 100644 --- a/src/DAV/SearchHandler.php +++ b/src/DAV/SearchHandler.php @@ -55,7 +55,7 @@ class SearchHandler { $this->server = $server; } - public function handleSearchRequest($xml, ResponseInterface $response) { + public function handleSearchRequest($xml, ResponseInterface $response): bool { if (!isset($xml['{DAV:}basicsearch'])) { $response->setStatus(400); $response->setBody('Unexpected xml content for searchrequest, expected basicsearch'); @@ -129,7 +129,7 @@ class SearchHandler { /** * @param \SearchDAV\XML\Operator $operator - * @param array $allProps + * @param SearchPropertyDefinition[] $allProps * @return Operator * @throws BadRequest */ @@ -166,11 +166,11 @@ class SearchHandler { * If a depth of 1 is requested child elements will also be returned. * * @param SearchResult[] $results - * @param array $propertyNames + * @param string[] $propertyNames * @param int $depth - * @return \Iterator + * @return \Iterator */ - private function getPropertiesIteratorResults($results, $propertyNames = [], $depth = 0): \Iterator { + private function getPropertiesIteratorResults(array $results, array $propertyNames = [], int $depth = 0): \Iterator { $propFindType = $propertyNames ? PropFind::NORMAL : PropFind::ALLPROPS; $this->searchBackend->preloadPropertyFor(array_map(function (SearchResult $result): INode { @@ -179,7 +179,7 @@ class SearchHandler { foreach ($results as $result) { $node = $result->node; - $propFind = new PropFind($result->href, (array)$propertyNames, $depth, $propFindType); + $propFind = new PropFind($result->href, $propertyNames, $depth, $propFindType); $r = $this->server->getPropertiesByNode($propFind, $node); if ($r) { $result = $propFind->getResultForMultiStatus(); diff --git a/src/DAV/SearchPlugin.php b/src/DAV/SearchPlugin.php index 7690bb5..2a5b823 100644 --- a/src/DAV/SearchPlugin.php +++ b/src/DAV/SearchPlugin.php @@ -57,7 +57,7 @@ class SearchPlugin extends ServerPlugin { $this->queryParser = new QueryParser(); } - public function initialize(Server $server) { + public function initialize(Server $server): void { $this->server = $server; $this->pathHelper = new PathHelper($server); $this->search = new SearchHandler($this->searchBackend, $this->pathHelper, $server); @@ -67,7 +67,7 @@ class SearchPlugin extends ServerPlugin { $server->on('propFind', [$this, 'propFindHandler']); } - public function propFindHandler(PropFind $propFind, INode $node) { + public function propFindHandler(PropFind $propFind, INode $node): void { if ($propFind->getPath() === $this->searchBackend->getArbiterPath()) { $propFind->handle('{DAV:}supported-query-grammar-set', new SupportedQueryGrammar()); } @@ -77,9 +77,9 @@ class SearchPlugin extends ServerPlugin { * SEARCH is allowed for users files * * @param string $path - * @return array + * @return string[] */ - public function getHTTPMethods($path) { + public function getHTTPMethods($path): array { $path = $this->pathHelper->getPathFromUri($path); if ($this->searchBackend->getArbiterPath() === $path) { return ['SEARCH']; @@ -88,13 +88,13 @@ class SearchPlugin extends ServerPlugin { } } - public function optionHandler(RequestInterface $request, ResponseInterface $response) { + public function optionHandler(RequestInterface $request, ResponseInterface $response): void { if ($request->getPath() === $this->searchBackend->getArbiterPath()) { $response->addHeader('DASL', ''); } } - public function searchHandler(RequestInterface $request, ResponseInterface $response) { + public function searchHandler(RequestInterface $request, ResponseInterface $response): bool { $contentType = $request->getHeader('Content-Type') ?? ''; // Currently, we only support xml search queries diff --git a/src/Query/Operator.php b/src/Query/Operator.php index 4390bdd..182f264 100644 --- a/src/Query/Operator.php +++ b/src/Query/Operator.php @@ -59,7 +59,7 @@ class Operator { * Operator constructor. * * @param string $type - * @param array $arguments + * @param (Literal|\SearchDAV\Backend\SearchPropertyDefinition|Operator)[] $arguments */ public function __construct(string $type = '', array $arguments = []) { $this->type = $type; diff --git a/src/XML/BasicSearchSchema.php b/src/XML/BasicSearchSchema.php index d2616c4..c68aabe 100644 --- a/src/XML/BasicSearchSchema.php +++ b/src/XML/BasicSearchSchema.php @@ -37,7 +37,7 @@ class BasicSearchSchema implements XmlSerializable { $this->properties = $properties; } - public function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer): void { $childs = array_map(function (PropDesc $propDesc) { return [ 'name' => '{DAV:}propdesc', diff --git a/src/XML/Operator.php b/src/XML/Operator.php index f7a714c..fb44ba8 100644 --- a/src/XML/Operator.php +++ b/src/XML/Operator.php @@ -49,7 +49,7 @@ class Operator implements XmlDeserializable { * Operator constructor. * * @param string $type - * @param array $arguments + * @param (Literal|string|Operator)[] $arguments */ public function __construct(string $type = '', array $arguments = []) { $this->type = $type; diff --git a/src/XML/PropDesc.php b/src/XML/PropDesc.php index 0cfc848..b9549cd 100644 --- a/src/XML/PropDesc.php +++ b/src/XML/PropDesc.php @@ -46,7 +46,7 @@ class PropDesc implements XmlSerializable { */ public $sortable; - public function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer): void { $data = [ '{DAV:}dataType' => [$this->dataType => null] ]; diff --git a/src/XML/QueryDiscoverResponse.php b/src/XML/QueryDiscoverResponse.php index d9af76c..c1eea4d 100644 --- a/src/XML/QueryDiscoverResponse.php +++ b/src/XML/QueryDiscoverResponse.php @@ -45,7 +45,7 @@ class QueryDiscoverResponse extends Response { $this->schema = $schema; } - public function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer): void { if ($status = $this->getHTTPStatus()) { $writer->writeElement('{DAV:}status', 'HTTP/1.1 ' . $status . ' ' . \Sabre\HTTP\Response::$statusCodes[$status]); } diff --git a/src/XML/SupportedQueryGrammar.php b/src/XML/SupportedQueryGrammar.php index 12e84e5..a24e7b1 100644 --- a/src/XML/SupportedQueryGrammar.php +++ b/src/XML/SupportedQueryGrammar.php @@ -25,14 +25,12 @@ use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; class SupportedQueryGrammar implements XmlSerializable { - const GRAMMAR_BASICSEARCH = '{DAV:}basicsearch'; + const GRAMMAR_BASIC_SEARCH = '{DAV:}basicsearch'; - public $grammar = self::GRAMMAR_BASICSEARCH; - - public function xmlSerialize(Writer $writer) { + public function xmlSerialize(Writer $writer): void { $writer->startElement('{DAV:}supported-query-grammar'); $writer->startElement('{DAV:}grammar'); - $writer->startElement($this->grammar); + $writer->startElement(self::GRAMMAR_BASIC_SEARCH); $writer->endElement(); $writer->endElement(); $writer->endElement(); diff --git a/tests/DummyBackend.php b/tests/DummyBackend.php index 4f0b9ef..a404416 100644 --- a/tests/DummyBackend.php +++ b/tests/DummyBackend.php @@ -30,15 +30,15 @@ use SearchDAV\XML\BasicSearch; use SearchDAV\Backend\SearchPropertyDefinition; class DummyBackend implements ISearchBackend { - public function getArbiterPath() { + public function getArbiterPath(): string { return ''; } - public function isValidScope($href, $depth, $path) { + public function isValidScope(string $href, $depth, ?string $path): bool { return true; } - public function getPropertyDefinitionsForScope($href, $path) { + public function getPropertyDefinitionsForScope($href, $path): array { return [ new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), @@ -47,7 +47,7 @@ class DummyBackend implements ISearchBackend { ]; } - public function search(Query $query) { + public function search(Query $query): array { return [ new SearchResult(new SimpleFile('foo.txt', 'foobar', 'text/plain'), '/bar/foo.txt') ]; From acb32ab84d0ecee6f6137126b98fdda5da5e3b5d Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Mon, 11 Apr 2022 14:52:12 +0200 Subject: [PATCH 26/29] minor fixes --- src/Backend/ISearchBackend.php | 4 ++-- src/Backend/SearchPropertyDefinition.php | 10 ++++----- src/DAV/DiscoverHandler.php | 7 +----- src/DAV/QueryParser.php | 8 ++++--- src/DAV/SearchHandler.php | 2 +- src/DAV/SearchPlugin.php | 4 ---- src/Query/Query.php | 2 +- src/XML/BasicSearch.php | 28 +++++++++++++++--------- src/XML/Limit.php | 3 ++- src/XML/Order.php | 3 ++- src/XML/PropDesc.php | 8 +++++++ src/XML/QueryDiscoverResponse.php | 3 ++- src/XML/Scope.php | 3 ++- tests/DummyBackend.php | 4 ++-- tests/SearchPluginTest.php | 18 +++++++-------- 15 files changed, 60 insertions(+), 47 deletions(-) diff --git a/src/Backend/ISearchBackend.php b/src/Backend/ISearchBackend.php index 6a1defc..277f284 100644 --- a/src/Backend/ISearchBackend.php +++ b/src/Backend/ISearchBackend.php @@ -28,7 +28,7 @@ interface ISearchBackend { /** * Get the path of the search arbiter of this backend * - * The search arbiter is the URI that the client will send it's SEARCH requests to + * The search arbiter is the URI that the client will send its SEARCH requests to * Note that this is not required to be the same as the search scopes which determine what to search in * * The returned value should be a path relative the root of the dav server. @@ -41,7 +41,7 @@ interface ISearchBackend { public function getArbiterPath(): string; /** - * Whether or not the search backend supports search requests on this scope + * Whether the search backend supports search requests on this scope * * The scope defines the resource that it being searched, such as a folder or address book. * diff --git a/src/Backend/SearchPropertyDefinition.php b/src/Backend/SearchPropertyDefinition.php index f4a7f3e..c8a8879 100644 --- a/src/Backend/SearchPropertyDefinition.php +++ b/src/Backend/SearchPropertyDefinition.php @@ -25,7 +25,7 @@ class SearchPropertyDefinition { const XS = '{http://www.w3.org/2001/XMLSchema}'; const DATATYPE_STRING = self::XS . 'string'; const DATATYPE_INTEGER = self::XS . 'integer'; - const DATATYPE_NONNEGATIVE_INTEGER = self::XS . 'nonNegativeInteger'; + const DATATYPE_NON_NEGATIVE_INTEGER = self::XS . 'nonNegativeInteger'; const DATATYPE_DECIMAL = self::XS . 'decimal'; const DATATYPE_DATETIME = self::XS . 'dateTime'; const DATATYPE_BOOLEAN = self::XS . 'boolean'; @@ -48,11 +48,11 @@ class SearchPropertyDefinition { * SearchProperty constructor. * * @param string $name the name and namespace of the property in clark notation - * @param bool $searchable whether or not this property can be used as part of a search query - * @param bool $selectable whether or not this property can be returned as part of a search result - * @param bool $sortable whether or not this property can be used to sort the search result + * @param bool $searchable whether this property can be used as part of a search query + * @param bool $selectable whether this property can be returned as part of a search result + * @param bool $sortable whether this property can be used to sort the search result * @param string $dataType the datatype of the property, one of the SearchProperty::DATATYPE_ constants or any XSD datatype in clark notation - * @param bool $caseSensitive whether or not comparisons on the property are case sensitive, only applies to string propertries + * @param bool $caseSensitive whether comparisons on the property are case-sensitive, only applies to string properties */ public function __construct(string $name, bool $selectable, bool $searchable, bool $sortable, string $dataType = self::DATATYPE_STRING, bool $caseSensitive = true) { $this->searchable = $searchable; diff --git a/src/DAV/DiscoverHandler.php b/src/DAV/DiscoverHandler.php index 84cc571..811cfc7 100644 --- a/src/DAV/DiscoverHandler.php +++ b/src/DAV/DiscoverHandler.php @@ -97,12 +97,7 @@ class DiscoverHandler { foreach ($propertyDefinitions as $propertyDefinition) { $key = $this->hashDefinition($propertyDefinition); if (!isset($groups[$key])) { - $desc = new PropDesc(); - $desc->dataType = $propertyDefinition->dataType; - $desc->sortable = $propertyDefinition->sortable; - $desc->selectable = $propertyDefinition->selectable; - $desc->searchable = $propertyDefinition->searchable; - $groups[$key] = $desc; + $groups[$key] = new PropDesc($propertyDefinition); } $groups[$key]->properties[] = $propertyDefinition->name; } diff --git a/src/DAV/QueryParser.php b/src/DAV/QueryParser.php index 55e5f2d..440b644 100644 --- a/src/DAV/QueryParser.php +++ b/src/DAV/QueryParser.php @@ -30,6 +30,8 @@ use SearchDAV\XML\Literal; use SearchDAV\XML\Operator; use SearchDAV\XML\Order; use SearchDAV\XML\Scope; +use function Sabre\Xml\Deserializer\keyValue; +use function Sabre\Xml\Deserializer\repeatingElements; class QueryParser extends Service { public $namespaceMap = [ @@ -46,13 +48,13 @@ class QueryParser extends Service { '{DAV:}query-schema-discovery' => Element\KeyValue::class, '{DAV:}basicsearch' => BasicSearch::class, '{DAV:}select' => function (Reader $reader) { - return \Sabre\Xml\Deserializer\keyValue($reader, '{DAV:}scope')['{DAV:}prop']; + return keyValue($reader, '{DAV:}scope')['{DAV:}prop']; }, '{DAV:}from' => function (Reader $reader) { - return \Sabre\Xml\Deserializer\repeatingElements($reader, '{DAV:}scope'); + return repeatingElements($reader, '{DAV:}scope'); }, '{DAV:}orderby' => function (Reader $reader) { - return \Sabre\Xml\Deserializer\repeatingElements($reader, '{DAV:}order'); + return repeatingElements($reader, '{DAV:}order'); }, '{DAV:}scope' => Scope::class, '{DAV:}where' => function (Reader $reader) { diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index 27e4da2..a1fa5a7 100644 --- a/src/DAV/SearchHandler.php +++ b/src/DAV/SearchHandler.php @@ -58,7 +58,7 @@ class SearchHandler { public function handleSearchRequest($xml, ResponseInterface $response): bool { if (!isset($xml['{DAV:}basicsearch'])) { $response->setStatus(400); - $response->setBody('Unexpected xml content for searchrequest, expected basicsearch'); + $response->setBody('Unexpected xml content for search request, expected basicsearch'); return false; } /** @var BasicSearch $query */ diff --git a/src/DAV/SearchPlugin.php b/src/DAV/SearchPlugin.php index 2a5b823..7c03b5a 100644 --- a/src/DAV/SearchPlugin.php +++ b/src/DAV/SearchPlugin.php @@ -34,9 +34,6 @@ use SearchDAV\XML\SupportedQueryGrammar; class SearchPlugin extends ServerPlugin { const SEARCHDAV_NS = 'https://github.com/icewind1991/SearchDAV/ns'; - /** @var Server */ - private $server; - /** @var ISearchBackend */ private $searchBackend; @@ -58,7 +55,6 @@ class SearchPlugin extends ServerPlugin { } public function initialize(Server $server): void { - $this->server = $server; $this->pathHelper = new PathHelper($server); $this->search = new SearchHandler($this->searchBackend, $this->pathHelper, $server); $this->discover = new DiscoverHandler($this->searchBackend, $this->pathHelper, $this->queryParser); diff --git a/src/Query/Query.php b/src/Query/Query.php index 107b0d3..82f237c 100644 --- a/src/Query/Query.php +++ b/src/Query/Query.php @@ -48,7 +48,7 @@ class Query { * The list of order operations that should be used to order the results. * * Each order operations consists of a property to sort on and a sort direction. - * If more then one order operations are specified, the comparisons for ordering should + * If more than one order operations are specified, the comparisons for ordering should * be applied in the order that the order operations are defined in with the earlier comparisons being * more significant. */ diff --git a/src/XML/BasicSearch.php b/src/XML/BasicSearch.php index 0227927..c5451ca 100644 --- a/src/XML/BasicSearch.php +++ b/src/XML/BasicSearch.php @@ -24,6 +24,7 @@ namespace SearchDAV\XML; use Sabre\Xml\ParseException; use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use function Sabre\Xml\Deserializer\keyValue; /** * The object representation of a search query made by the client @@ -65,26 +66,33 @@ class BasicSearch implements XmlDeserializable { */ public $limit; + public function __construct(array $select, array $from, ?Operator $where, array $orderBy, Limit $limit) { + $this->select = $select; + $this->from = $from; + $this->where = $where; + $this->orderBy = $orderBy; + $this->limit = $limit; + } + + /** * @param Reader $reader * @return BasicSearch * @throws ParseException */ public static function xmlDeserialize(Reader $reader): BasicSearch { - $search = new self(); - - $elements = \Sabre\Xml\Deserializer\keyValue($reader); + $elements = keyValue($reader); if (!isset($elements['{DAV:}from'])) { throw new ParseException('Missing {DAV:}from when parsing {DAV:}basicsearch'); } - $search->select = $elements['{DAV:}select'] ?? []; - $search->from = $elements['{DAV:}from']; - $search->where = $elements['{DAV:}where'] ?? null; - $search->orderBy = $elements['{DAV:}orderby'] ?? []; - $search->limit = $elements['{DAV:}limit'] ?? new Limit(); - - return $search; + return new BasicSearch( + $elements['{DAV:}select'] ?? [], + $elements['{DAV:}from'], + $elements['{DAV:}where'] ?? null, + $elements['{DAV:}orderby'] ?? [], + $elements['{DAV:}limit'] ?? new Limit() + ); } } diff --git a/src/XML/Limit.php b/src/XML/Limit.php index 71e356c..b00809f 100644 --- a/src/XML/Limit.php +++ b/src/XML/Limit.php @@ -24,6 +24,7 @@ namespace SearchDAV\XML; use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; use SearchDAV\DAV\SearchPlugin; +use function Sabre\Xml\Deserializer\keyValue; /** * The limit and offset of a search query @@ -32,7 +33,7 @@ class Limit extends \SearchDAV\Query\Limit implements XmlDeserializable { public static function xmlDeserialize(Reader $reader): Limit { $limit = new self(); - $elements = \Sabre\Xml\Deserializer\keyValue($reader); + $elements = keyValue($reader); $namespace = SearchPlugin::SEARCHDAV_NS; $limit->maxResults = isset($elements['{DAV:}nresults']) ? $elements['{DAV:}nresults'] : 0; diff --git a/src/XML/Order.php b/src/XML/Order.php index e675f78..74eab7e 100644 --- a/src/XML/Order.php +++ b/src/XML/Order.php @@ -23,6 +23,7 @@ namespace SearchDAV\XML; use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use function Sabre\Xml\Deserializer\keyValue; class Order implements XmlDeserializable { /** @@ -52,7 +53,7 @@ class Order implements XmlDeserializable { public static function xmlDeserialize(Reader $reader): Order { $order = new self(); - $childs = \Sabre\Xml\Deserializer\keyValue($reader); + $childs = keyValue($reader); $order->order = array_key_exists('{DAV:}descending', $childs) ? \SearchDAV\Query\Order::DESC : \SearchDAV\Query\Order::ASC; $order->property = $childs['{DAV:}prop'][0]; diff --git a/src/XML/PropDesc.php b/src/XML/PropDesc.php index b9549cd..43ada6a 100644 --- a/src/XML/PropDesc.php +++ b/src/XML/PropDesc.php @@ -23,6 +23,7 @@ namespace SearchDAV\XML; use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; +use SearchDAV\Backend\SearchPropertyDefinition; class PropDesc implements XmlSerializable { /** @@ -46,6 +47,13 @@ class PropDesc implements XmlSerializable { */ public $sortable; + public function __construct(SearchPropertyDefinition $propertyDefinition) { + $this->dataType = $propertyDefinition->dataType; + $this->sortable = $propertyDefinition->sortable; + $this->selectable = $propertyDefinition->selectable; + $this->searchable = $propertyDefinition->searchable; + } + public function xmlSerialize(Writer $writer): void { $data = [ '{DAV:}dataType' => [$this->dataType => null] diff --git a/src/XML/QueryDiscoverResponse.php b/src/XML/QueryDiscoverResponse.php index c1eea4d..c50dea9 100644 --- a/src/XML/QueryDiscoverResponse.php +++ b/src/XML/QueryDiscoverResponse.php @@ -23,6 +23,7 @@ namespace SearchDAV\XML; use Sabre\DAV\Xml\Element\Response; use Sabre\Xml\Writer; +use function Sabre\HTTP\encodePath; class QueryDiscoverResponse extends Response { /** @@ -49,7 +50,7 @@ class QueryDiscoverResponse extends Response { if ($status = $this->getHTTPStatus()) { $writer->writeElement('{DAV:}status', 'HTTP/1.1 ' . $status . ' ' . \Sabre\HTTP\Response::$statusCodes[$status]); } - $writer->writeElement('{DAV:}href', \Sabre\HTTP\encodePath($this->getHref())); + $writer->writeElement('{DAV:}href', encodePath($this->getHref())); if ($this->schema) { $writer->writeElement('{DAV:}query-schema', [ diff --git a/src/XML/Scope.php b/src/XML/Scope.php index 6fb7c0f..90a2384 100644 --- a/src/XML/Scope.php +++ b/src/XML/Scope.php @@ -23,12 +23,13 @@ namespace SearchDAV\XML; use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use function Sabre\Xml\Deserializer\keyValue; class Scope extends \SearchDAV\Query\Scope implements XmlDeserializable { public static function xmlDeserialize(Reader $reader): Scope { $scope = new self(); - $values = \Sabre\Xml\Deserializer\keyValue($reader); + $values = keyValue($reader); $scope->href = $values['{DAV:}href']; $scope->depth = $values['{DAV:}depth']; diff --git a/tests/DummyBackend.php b/tests/DummyBackend.php index a404416..822a392 100644 --- a/tests/DummyBackend.php +++ b/tests/DummyBackend.php @@ -40,10 +40,10 @@ class DummyBackend implements ISearchBackend { public function getPropertyDefinitionsForScope($href, $path): array { return [ - new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true, SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER), new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), new SearchPropertyDefinition('{DAV:}displayname', true, true, true), - new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER), + new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true, SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER), ]; } diff --git a/tests/SearchPluginTest.php b/tests/SearchPluginTest.php index d97e91e..7ce28d6 100644 --- a/tests/SearchPluginTest.php +++ b/tests/SearchPluginTest.php @@ -185,7 +185,7 @@ class SearchPluginTest extends TestCase { true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ), new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true), new SearchPropertyDefinition('{DAV:}displayname', true, true, true), @@ -194,7 +194,7 @@ class SearchPluginTest extends TestCase { false, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ), ]); @@ -289,7 +289,7 @@ class SearchPluginTest extends TestCase { true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ); $orderBy = [ new \SearchDAV\Query\Order($lengthProp, \SearchDAV\Query\Order::ASC), @@ -367,7 +367,7 @@ class SearchPluginTest extends TestCase { true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ); $plugin = new SearchPlugin($this->searchBackend); $server = new Server(); @@ -508,7 +508,7 @@ class SearchPluginTest extends TestCase { false, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ), ]); @@ -548,14 +548,14 @@ class SearchPluginTest extends TestCase { false, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ), new SearchPropertyDefinition( '{DAV:}getcontentlength', true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ), ]); @@ -595,14 +595,14 @@ class SearchPluginTest extends TestCase { false, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ), new SearchPropertyDefinition( '{DAV:}getcontentlength', true, true, true, - SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER ), ]); From 52c8cfc21bd69271f224671c4924d260b0a8d4fb Mon Sep 17 00:00:00 2001 From: Robin Appelman Date: Mon, 11 Apr 2022 15:02:49 +0200 Subject: [PATCH 27/29] add alias for `DATATYPE_NONNEGATIVE_INTEGER` --- src/Backend/SearchPropertyDefinition.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/Backend/SearchPropertyDefinition.php b/src/Backend/SearchPropertyDefinition.php index c8a8879..4dca05b 100644 --- a/src/Backend/SearchPropertyDefinition.php +++ b/src/Backend/SearchPropertyDefinition.php @@ -25,6 +25,7 @@ class SearchPropertyDefinition { const XS = '{http://www.w3.org/2001/XMLSchema}'; const DATATYPE_STRING = self::XS . 'string'; const DATATYPE_INTEGER = self::XS . 'integer'; + const DATATYPE_NONNEGATIVE_INTEGER = self::XS . 'nonNegativeInteger'; const DATATYPE_NON_NEGATIVE_INTEGER = self::XS . 'nonNegativeInteger'; const DATATYPE_DECIMAL = self::XS . 'decimal'; const DATATYPE_DATETIME = self::XS . 'dateTime'; From 168c5f9cc4bc9106ca7f2384e7f2f9a0e8723ad5 Mon Sep 17 00:00:00 2001 From: Louis Date: Tue, 14 Nov 2023 17:40:44 +0100 Subject: [PATCH 28/29] Add handling for is-defined operator --- src/DAV/QueryParser.php | 1 + 1 file changed, 1 insertion(+) diff --git a/src/DAV/QueryParser.php b/src/DAV/QueryParser.php index 440b644..915184e 100644 --- a/src/DAV/QueryParser.php +++ b/src/DAV/QueryParser.php @@ -76,6 +76,7 @@ class QueryParser extends Service { '{DAV:}contains' => Operator::class, '{DAV:}not' => Operator::class, '{DAV:}is-collection' => Operator::class, + '{DAV:}is-defined' => Operator::class, '{DAV:}limit' => Limit::class, ]; } From 2b4e9a481165b84837872460bce6e145bf64dc16 Mon Sep 17 00:00:00 2001 From: Joas Schilling Date: Fri, 8 Nov 2024 12:13:26 +0100 Subject: [PATCH 29/29] feat: Add PHP 8.4 support Signed-off-by: Joas Schilling --- .github/workflows/ci.yml | 2 +- .github/workflows/lint.yml | 2 +- src/Query/Scope.php | 2 +- src/XML/QueryDiscoverResponse.php | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6ad7713..7ad8d77 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -7,7 +7,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - php-versions: ['7.4', '8.0'] + php-versions: ['7.4', '8.0', '8.4'] steps: - uses: actions/checkout@v2 diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 75f0f34..2cd12eb 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -6,7 +6,7 @@ jobs: runs-on: ubuntu-20.04 strategy: matrix: - php-versions: ['7.4', '8.0'] + php-versions: ['7.4', '8.0', '8.4'] name: php${{ matrix.php-versions }} lint steps: - name: Checkout diff --git a/src/Query/Scope.php b/src/Query/Scope.php index faded1c..76b41ae 100644 --- a/src/Query/Scope.php +++ b/src/Query/Scope.php @@ -51,7 +51,7 @@ class Scope { * @param int|string $depth * @param string|null $path */ - public function __construct(string $href = '', $depth = 1, string $path = null) { + public function __construct(string $href = '', $depth = 1, ?string $path = null) { $this->href = $href; $this->depth = $depth; $this->path = $path; diff --git a/src/XML/QueryDiscoverResponse.php b/src/XML/QueryDiscoverResponse.php index c50dea9..0d8b6a2 100644 --- a/src/XML/QueryDiscoverResponse.php +++ b/src/XML/QueryDiscoverResponse.php @@ -38,7 +38,7 @@ class QueryDiscoverResponse extends Response { * @param BasicSearchSchema|null $schema * @param null|int|string $httpStatus */ - public function __construct($href, BasicSearchSchema $schema = null, $httpStatus = null) { + public function __construct($href, ?BasicSearchSchema $schema = null, $httpStatus = null) { if ($httpStatus !== null) { $httpStatus = (string)$httpStatus; }