initial working version

supports grammar discovery, schema discovery and search

src/XML/BasicSearch.php

@@ -0,0 +1,60 @@
+<?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;
+
+class BasicSearch implements XmlDeserializable {
+	/**
+	 * @var string[]
+	 *
+	 * The list of properties to be selected in clark notation
+	 */
+	public $select;
+	/**
+	 * @var Scope[]
+	 *
+	 * The collections to perform the search in
+	 */
+	public $from;
+	/**
+	 * @var Operator[]
+	 */
+	public $where;
+	/**
+	 * @var Order[]
+	 */
+	public $orderBy;
+
+	static function xmlDeserialize(Reader $reader) {
+		$search = new self();
+
+		$elements = \Sabre\Xml\Deserializer\keyValue($reader);
+		$search->select = isset($elements['{DAV:}select']) ? $elements['{DAV:}select'] : null;
+		$search->from = isset($elements['{DAV:}from']) ? $elements['{DAV:}from'] : null;
+		$search->where = isset($elements['{DAV:}where']) ? $elements['{DAV:}where'] : null;
+		$search->orderBy = isset($elements['{DAV:}orderby']) ? $elements['{DAV:}orderby'] : null;
+
+		return $search;
+	}
+}

src/XML/BasicSearchSchema.php

@@ -0,0 +1,50 @@
+<?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\Writer;
+use Sabre\Xml\XmlSerializable;
+
+class BasicSearchSchema implements XmlSerializable {
+	/** @var PropDesc[] */
+	public $properties;
+
+	/**
+	 * BasicSearchSchema constructor.
+	 *
+	 * @param PropDesc[] $properties
+	 */
+	public function __construct(array $properties) {
+		$this->properties = $properties;
+	}
+
+	function xmlSerialize(Writer $writer) {
+		$childs = array_map(function(PropDesc $propDesc) {
+			return [
+				'name' => '{DAV:}propdesc',
+				'value' => $propDesc
+			];
+		}, $this->properties);
+		$writer->writeElement('{DAV:}properties', $childs);
+	}
+}

src/XML/Literal.php

@@ -0,0 +1,40 @@
+<?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;
+
+class Literal implements XmlDeserializable {
+	/** @var string|boolean|\DateTime|integer */
+	public $value;
+
+	static function xmlDeserialize(Reader $reader) {
+		$literal = new self();
+
+		$literal->value = $reader->readText();
+		$reader->read();
+
+		return $literal;
+	}
+}

src/XML/Operator.php

@@ -0,0 +1,86 @@
+<?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;
+
+class Operator implements XmlDeserializable {
+	const OPERATION_AND = '{DAV:}and';
+	const OPERATION_OR = '{DAV:}or';
+	const OPERATION_NOT = '{DAV:}not';
+	const OPERATION_EQUAL = '{DAV:}eq';
+	const OPERATION_LESS_THAN = '{DAV:}lt';
+	const OPERATION_LESS_OR_EQUAL_THAN = '{DAV:}lte';
+	const OPERATION_GREATER_THAN = '{DAV:}gt';
+	const OPERATION_GREATER_OR_EQUAL_THAN = '{DAV:}gte';
+	const OPERATION_IS_COLLECTION = '[DAV:}is-collection';
+	const OPERATION_IS_DEFINED = '[DAV:}is-defined';
+	const OPERATION_IS_LIKE = '[DAV:}like';
+	const OPERATION_CONTAINS = '[DAV:}contains';
+
+	/**
+	 * @var string
+	 *
+	 * The type of operation, one of the Operation::OPERATION_* constants
+	 */
+	public $type;
+	/**
+	 * @var (Literal|string|Operation)[]
+	 *
+	 * The list of arguments for the operation
+	 *
+	 *  - string: property name for comparison
+	 *  - Literal: literal value for comparison
+	 *  - Operation: nested operation for and/or/not operations
+	 */
+	public $arguments;
+
+	static function xmlDeserialize(Reader $reader) {
+		$operator = new self();
+
+		// If there's no children, we don't do anything.
+		if ($reader->isEmptyElement) {
+			$reader->next();
+			return null;
+		}
+		$operator->type = $reader->getClark();
+		$reader->read();
+		do {
+			if ($reader->nodeType === Reader::ELEMENT) {
+				$argument = $reader->parseCurrentElement();
+				if ($argument['name'] === '{DAV:}prop') {
+					$operator->arguments[] = $argument['value'][0];
+				} else {
+					$operator->arguments[] = $argument['value'];
+				}
+			} else {
+				$reader->read();
+			}
+		} while ($reader->nodeType !== Reader::END_ELEMENT);
+
+		$reader->read();
+
+		return $operator;
+	}
+}

src/XML/Order.php

@@ -0,0 +1,45 @@
+<?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;
+
+class Order implements XmlDeserializable {
+	const ASC = 'ascending';
+	const DESC = 'descending';
+
+	public $properties;
+	public $order;
+
+	static function xmlDeserialize(Reader $reader) {
+		$order = new self();
+
+		$childs = \Sabre\Xml\Deserializer\keyValue($reader);
+
+		$order->order = isset($childs['{DAV:}descending']) ? self::DESC : self::ASC;
+		$order->properties = $childs['{DAV:}prop'];
+
+		return $order;
+	}
+}

src/XML/PropDesc.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\Writer;
+use Sabre\Xml\XmlSerializable;
+
+class PropDesc implements XmlSerializable {
+	/**
+	 * @var string[]
+	 */
+	public $properties = [];
+	public $dataType;
+	public $searchable;
+	public $selectable;
+	public $sortable;
+
+	function xmlSerialize(Writer $writer) {
+		$data = [
+			'{DAV:}dataType' => [$this->dataType => null]
+		];
+		if ($this->searchable) {
+			$data['{DAV:}searchable'] = null;
+		}
+		if ($this->sortable) {
+			$data['{DAV:}sortable'] = null;
+		}
+		if ($this->selectable) {
+			$data['{DAV:}selectable'] = null;
+		}
+		$writer->write(array_map(function ($propName) {
+			return [
+				'name' => '{DAV:}prop',
+				'value' => $propName
+			];
+		}, $this->properties));
+		$writer->write($data);
+	}
+}

src/XML/QueryDiscoverResponse.php

@@ -0,0 +1,56 @@
+<?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\DAV\Xml\Element\Response;
+use Sabre\Xml\Writer;
+
+class QueryDiscoverResponse extends Response {
+	protected $schema;
+
+	/**
+	 * QueryDiscoverResponse constructor.
+	 *
+	 * @param string $href
+	 * @param BasicSearchSchema|null $schema
+	 * @param null|int|string $httpStatus
+	 */
+	function __construct($href, BasicSearchSchema $schema, $httpStatus = null) {
+		parent::__construct($href, [], $httpStatus);
+		$this->schema = $schema;
+
+	}
+
+	function xmlSerialize(Writer $writer) {
+		if ($status = $this->getHTTPStatus()) {
+			$writer->writeElement('{DAV:}status', 'HTTP/1.1 ' . $status . ' ' . \Sabre\HTTP\Response::$statusCodes[$status]);
+		}
+		$writer->writeElement('{DAV:}href', $writer->contextUri . \Sabre\HTTP\encodePath($this->getHref()));
+
+		if ($this->schema) {
+			$writer->writeElement('{DAV:}query-schema', [
+				'{DAV:basicsearchschema}' => $this->schema
+			]);
+		}
+	}
+}

src/XML/Scope.php

@@ -0,0 +1,41 @@
+<?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;
+
+class Scope implements XmlDeserializable {
+	public $href;
+	public $depth;
+
+	static function xmlDeserialize(Reader $reader) {
+		$scope = new self();
+
+		$values = \Sabre\Xml\Deserializer\keyValue($reader);
+		$scope->href = $values['{DAV:}href'];
+		$scope->depth = $values['{DAV:}depth'];
+
+		return $scope;
+	}
+}

src/XML/SupportedQueryGrammar.php

@@ -0,0 +1,41 @@
+<?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\Writer;
+use Sabre\Xml\XmlSerializable;
+
+class SupportedQueryGrammar implements XmlSerializable {
+	const GRAMMAR_BASICSEARCH = '{DAV:}basicsearch';
+
+	public $grammar = self::GRAMMAR_BASICSEARCH;
+
+	function xmlSerialize(Writer $writer) {
+		$writer->startElement('{DAV:}supported-query-grammar');
+		$writer->startElement('{DAV:}grammar');
+		$writer->startElement($this->grammar);
+		$writer->endElement();
+		$writer->endElement();
+		$writer->endElement();
+	}
+}