add limit and offset

README.md

@@ -4,7 +4,7 @@
 [![codecov](https://codecov.io/gh/icewind1991/SearchDAV/branch/master/graph/badge.svg)](https://codecov.io/gh/icewind1991/SearchDAV)
 [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/icewind1991/SearchDAV/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/icewind1991/SearchDAV/?branch=master)
 
-A sabre/dav plugin to implement rfc5323 SEARCH
+A sabre/dav plugin to implement [rfc5323](https://tools.ietf.org/search/rfc5323) SEARCH
 
 ## Usage
 

src/DAV/QueryParser.php

@@ -25,6 +25,7 @@ use Sabre\Xml\Element;
 use Sabre\Xml\Reader;
 use Sabre\Xml\Service;
 use SearchDAV\XML\BasicSearch;
+use SearchDAV\XML\Limit;
 use SearchDAV\XML\Literal;
 use SearchDAV\XML\Operator;
 use SearchDAV\XML\Order;
@@ -34,7 +35,8 @@ class QueryParser extends Service {
 	public $namespaceMap = [
 		'DAV:' => 'd',
 		'http://sabredav.org/ns' => 's',
-		'http://www.w3.org/2001/XMLSchema' => 'xs'
+		'http://www.w3.org/2001/XMLSchema' => 'xs',
+		SearchPlugin::SEARCHDAV_NS => 'sd'
 	];
 
 	public function __construct() {
@@ -72,6 +74,7 @@ class QueryParser extends Service {
 			'{DAV:}contains' => Operator::class,
 			'{DAV:}not' => Operator::class,
 			'{DAV:}is-collection' => Operator::class,
+			'{DAV:}limit' => Limit::class,
 		];
 	}
 }

src/DAV/SearchPlugin.php

@@ -45,6 +45,8 @@ use SearchDAV\XML\Scope;
 use SearchDAV\XML\SupportedQueryGrammar;
 
 class SearchPlugin extends ServerPlugin {
+	const SEARCHDAV_NS = 'https://github.com/icewind1991/SearchDAV/ns';
+
 	/** @var Server */
 	private $server;
 

src/XML/BasicSearch.php

@@ -58,6 +58,12 @@ class BasicSearch implements XmlDeserializable {
 	 * more significant.
 	 */
 	public $orderBy;
+	/**
+	 * @var Limit
+	 *
+	 * The limit and offset for the search query
+	 */
+	public $limit;
 
 	static function xmlDeserialize(Reader $reader) {
 		$search = new self();
@@ -72,6 +78,7 @@ class BasicSearch implements XmlDeserializable {
 		$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();
 
 		return $search;
 	}

src/XML/Limit.php

@@ -0,0 +1,59 @@
+<?php
+/**
+ * @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace SearchDAV\XML;
+
+use Sabre\Xml\Reader;
+use Sabre\Xml\XmlDeserializable;
+use SearchDAV\DAV\SearchPlugin;
+
+/**
+ * The limit and offset of a search query
+ */
+class Limit implements XmlDeserializable {
+	/**
+	 * @var integer
+	 *
+	 * The maximum number of results to be returned
+	 *
+	 * If set to 0 then no limit should be imposed
+	 */
+	public $maxResults = 0;
+	/**
+	 * @var integer
+	 *
+	 * The index of the first result to be returned (offset)
+	 */
+	public $firstResult = 0;
+
+	static function xmlDeserialize(Reader $reader) {
+		$limit = new self();
+
+		$elements = \Sabre\Xml\Deserializer\keyValue($reader);
+		$namespace = SearchPlugin::SEARCHDAV_NS;
+
+		$limit->maxResults = isset($elements['{DAV:}nresults']) ? $elements['{DAV:}nresults'] : 0;
+		$firstResult = '{' . $namespace . '}firstresult';
+		$limit->firstResult = isset($elements[$firstResult]) ? $elements[$firstResult] : 0;
+
+		return $limit;
+	}
+}

tests/QueryParserTest.php

@@ -25,6 +25,7 @@ namespace SearchDAV\Test;
 use Sabre\Xml\Service;
 use SearchDAV\DAV\QueryParser;
 use SearchDAV\XML\BasicSearch;
+use SearchDAV\XML\Limit;
 use SearchDAV\XML\Literal;
 use SearchDAV\XML\Operator;
 use SearchDAV\XML\Order;
@@ -97,4 +98,23 @@ class QueryParserTest extends \PHPUnit_Framework_TestCase {
 		$xml = new Service();
 		$this->assertEquals($xml->parse(fopen(__DIR__ . '/supportedgrammar.xml', 'r')), $xml->parse($serialized));
 	}
+
+	public function testParseLimit() {
+		$query = file_get_contents(__DIR__ . '/limit.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);
+		$limit = new Limit();
+		$limit->firstResult = 20;
+		$limit->maxResults = 10;
+		$this->assertEquals($limit, $search->limit);
+	}
 }

tests/SearchPluginTest.php

@@ -35,6 +35,7 @@ use SearchDAV\Backend\SearchPropertyDefinition;
 use SearchDAV\Backend\SearchResult;
 use SearchDAV\DAV\SearchPlugin;
 use SearchDAV\XML\BasicSearch;
+use SearchDAV\XML\Limit;
 use SearchDAV\XML\Literal;
 use SearchDAV\XML\Operator;
 use SearchDAV\XML\Order;
@@ -286,6 +287,7 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase {
 			'{DAV:}getcontentlength',
 			new Literal(10000)
 		]);
+		$query->limit = new Limit();
 
 		$this->searchBackend->expects($this->once())
 			->method('search')

tests/limit.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+<d:searchrequest xmlns:d="DAV:"
+				 xmlns:sd="https://github.com/icewind1991/SearchDAV/ns">
+	<d:basicsearch>
+		<d:select>
+			<d:prop>
+				<d:getcontentlength/>
+			</d:prop>
+		</d:select>
+		<d:from>
+			<d:scope>
+				<d:href>/container1/</d:href>
+				<d:depth>infinity</d:depth>
+			</d:scope>
+		</d:from>
+		<d:where>
+			<d:gt>
+				<d:prop>
+					<d:getcontentlength/>
+				</d:prop>
+				<d:literal>10000</d:literal>
+			</d:gt>
+		</d:where>
+		<d:orderby>
+			<d:order>
+				<d:prop>
+					<d:getcontentlength/>
+				</d:prop>
+				<d:ascending/>
+			</d:order>
+		</d:orderby>
+		<d:limit>
+			<d:nresults>10</d:nresults>
+			<sd:firstresult>20</sd:firstresult>
+		</d:limit>
+	</d:basicsearch>
+</d:searchrequest>