diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 768c918..7ad8d77 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', '8.4'] 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/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000..2cd12eb --- /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', '8.4'] + 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..b286401 --- /dev/null +++ b/.github/workflows/static-analysis.yml @@ -0,0 +1,36 @@ +name: Php Static analysis +on: [push, pull_request] + +jobs: + psalm: + 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 + 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/.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..25e7143 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,12 @@ "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", + "phpstan": "phpstan analyse --level 5 src" } } diff --git a/psalm.xml b/psalm.xml new file mode 100644 index 0000000..30258a7 --- /dev/null +++ b/psalm.xml @@ -0,0 +1,15 @@ + + + + + + + + + diff --git a/src/Backend/ISearchBackend.php b/src/Backend/ISearchBackend.php index 21d577b..277f284 100644 --- a/src/Backend/ISearchBackend.php +++ b/src/Backend/ISearchBackend.php @@ -21,13 +21,14 @@ namespace SearchDAV\Backend; +use Sabre\DAV\INode; use SearchDAV\Query\Query; 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. @@ -37,10 +38,10 @@ interface ISearchBackend { * * @return string */ - public function getArbiterPath(); + 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. * @@ -54,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 @@ -68,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 @@ -80,5 +81,14 @@ 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. + * This can be used to more efficiently load the requested properties for the results. + * + * @param INode[] $nodes + * @param string[] $requestProperties + */ + public function preloadPropertyFor(array $nodes, array $requestProperties): void; } diff --git a/src/Backend/SearchPropertyDefinition.php b/src/Backend/SearchPropertyDefinition.php index daa22bd..4dca05b 100644 --- a/src/Backend/SearchPropertyDefinition.php +++ b/src/Backend/SearchPropertyDefinition.php @@ -26,6 +26,7 @@ class SearchPropertyDefinition { 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,13 +49,13 @@ 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($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 43ee333..af48506 100644 --- a/src/Backend/SearchResult.php +++ b/src/Backend/SearchResult.php @@ -21,7 +21,6 @@ namespace SearchDAV\Backend; - use Sabre\DAV\INode; class SearchResult { @@ -36,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..811cfc7 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'); @@ -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/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/QueryParser.php b/src/DAV/QueryParser.php index 44c594b..915184e 100644 --- a/src/DAV/QueryParser.php +++ b/src/DAV/QueryParser.php @@ -30,29 +30,31 @@ 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 = [ - '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) { - return \Sabre\Xml\Deserializer\keyValue($reader, '{DAV:}scope')['{DAV:}prop']; + '{DAV:}basicsearch' => BasicSearch::class, + '{DAV:}select' => function (Reader $reader) { + 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) { @@ -61,20 +63,21 @@ 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:}is-defined' => Operator::class, + '{DAV:}limit' => Limit::class, ]; } } diff --git a/src/DAV/SearchHandler.php b/src/DAV/SearchHandler.php index 85fe43b..a1fa5a7 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; @@ -54,10 +55,10 @@ 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'); + $response->setBody('Unexpected xml content for search request, expected basicsearch'); return false; } /** @var BasicSearch $query */ @@ -84,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; } @@ -126,7 +129,7 @@ class SearchHandler { /** * @param \SearchDAV\XML\Operator $operator - * @param array $allProps + * @param SearchPropertyDefinition[] $allProps * @return Operator * @throws BadRequest */ @@ -163,16 +166,20 @@ 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 { + return $result->node; + }, $results), $propertyNames); + 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 17d44cc..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; @@ -57,8 +54,7 @@ class SearchPlugin extends ServerPlugin { $this->queryParser = new QueryParser(); } - public function initialize(Server $server) { - $this->server = $server; + public function initialize(Server $server): void { $this->pathHelper = new PathHelper($server); $this->search = new SearchHandler($this->searchBackend, $this->pathHelper, $server); $this->discover = new DiscoverHandler($this->searchBackend, $this->pathHelper, $this->queryParser); @@ -67,7 +63,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()); } @@ -76,11 +72,11 @@ class SearchPlugin extends ServerPlugin { /** * SEARCH is allowed for users files * - * @param string $uri - * @return array + * @param string $path + * @return string[] */ - public function getHTTPMethods($uri) { - $path = $this->pathHelper->getPathFromUri($uri); + public function getHTTPMethods($path): array { + $path = $this->pathHelper->getPathFromUri($path); if ($this->searchBackend->getArbiterPath() === $path) { return ['SEARCH']; } else { @@ -88,16 +84,16 @@ 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) { - $contentType = $request->getHeader('Content-Type'); + public function searchHandler(RequestInterface $request, ResponseInterface $response): bool { + $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/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/Operator.php b/src/Query/Operator.php index 198d1fb..182f264 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. */ @@ -58,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/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 613c369..82f237c 100644 --- a/src/Query/Query.php +++ b/src/Query/Query.php @@ -21,7 +21,6 @@ namespace SearchDAV\Query; - use SearchDAV\Backend\SearchPropertyDefinition; class Query { @@ -38,7 +37,7 @@ class Query { */ public $from; /** - * @var Operator + * @var ?Operator * * The search operator, either a comparison ('gt', 'eq', ...) or a boolean operator ('and', 'or', 'not') */ @@ -49,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/Query/Scope.php b/src/Query/Scope.php index 9c342c8..76b41ae 100644 --- a/src/Query/Scope.php +++ b/src/Query/Scope.php @@ -21,7 +21,6 @@ namespace SearchDAV\Query; - class Scope { /** * @var string @@ -52,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/BasicSearch.php b/src/XML/BasicSearch.php index 269edb0..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 @@ -42,7 +43,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') */ @@ -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 */ - static function xmlDeserialize(Reader $reader): BasicSearch { - $search = new self(); - - $elements = \Sabre\Xml\Deserializer\keyValue($reader); + public static function xmlDeserialize(Reader $reader): BasicSearch { + $elements = keyValue($reader); if (!isset($elements['{DAV:}from'])) { throw new ParseException('Missing {DAV:}from when parsing {DAV:}basicsearch'); } - $search->select = isset($elements['{DAV:}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(); - - 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/BasicSearchSchema.php b/src/XML/BasicSearchSchema.php index edda372..c68aabe 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): void { + $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..b00809f 100644 --- a/src/XML/Limit.php +++ b/src/XML/Limit.php @@ -24,15 +24,16 @@ 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 */ 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); + $elements = keyValue($reader); $namespace = SearchPlugin::SEARCHDAV_NS; $limit->maxResults = isset($elements['{DAV:}nresults']) ? $elements['{DAV:}nresults'] : 0; 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 36721c3..fb44ba8 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 * @@ -49,17 +49,17 @@ 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; $this->arguments = $arguments; } - static function xmlDeserialize(Reader $reader): Operator { + public 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/Order.php b/src/XML/Order.php index 7aae162..74eab7e 100644 --- a/src/XML/Order.php +++ b/src/XML/Order.php @@ -21,9 +21,9 @@ namespace SearchDAV\XML; - use Sabre\Xml\Reader; use Sabre\Xml\XmlDeserializable; +use function Sabre\Xml\Deserializer\keyValue; class Order implements XmlDeserializable { /** @@ -50,10 +50,10 @@ 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); + $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 ab503b3..43ada6a 100644 --- a/src/XML/PropDesc.php +++ b/src/XML/PropDesc.php @@ -21,9 +21,9 @@ namespace SearchDAV\XML; - use Sabre\Xml\Writer; use Sabre\Xml\XmlSerializable; +use SearchDAV\Backend\SearchPropertyDefinition; class PropDesc implements XmlSerializable { /** @@ -47,7 +47,14 @@ class PropDesc implements XmlSerializable { */ public $sortable; - function xmlSerialize(Writer $writer) { + 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] ]; @@ -62,7 +69,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 802fdcd..0d8b6a2 100644 --- a/src/XML/QueryDiscoverResponse.php +++ b/src/XML/QueryDiscoverResponse.php @@ -21,9 +21,9 @@ namespace SearchDAV\XML; - use Sabre\DAV\Xml\Element\Response; use Sabre\Xml\Writer; +use function Sabre\HTTP\encodePath; class QueryDiscoverResponse extends Response { /** @@ -38,21 +38,23 @@ 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): void { 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', [ - '{DAV:}basicsearchschema' => $this->schema + '{DAV:}basicsearchschema' => $this->schema ]); } } diff --git a/src/XML/Scope.php b/src/XML/Scope.php index 78d4ba4..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 { - static function xmlDeserialize(Reader $reader): Scope { + 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/src/XML/SupportedQueryGrammar.php b/src/XML/SupportedQueryGrammar.php index ddb4e33..a24e7b1 100644 --- a/src/XML/SupportedQueryGrammar.php +++ b/src/XML/SupportedQueryGrammar.php @@ -21,19 +21,16 @@ namespace SearchDAV\XML; - 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; - - 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 a54c79d..822a392 100644 --- a/tests/DummyBackend.php +++ b/tests/DummyBackend.php @@ -30,26 +30,29 @@ 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:}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), ]; } - public function search(Query $query) { + public function search(Query $query): array { return [ new SearchResult(new SimpleFile('foo.txt', 'foobar', 'text/plain'), '/bar/foo.txt') ]; } + + 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..7ce28d6 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_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 + ), ]); $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_NON_NEGATIVE_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_NON_NEGATIVE_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_NON_NEGATIVE_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_NON_NEGATIVE_INTEGER + ), + new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_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_NON_NEGATIVE_INTEGER + ), + new SearchPropertyDefinition( + '{DAV:}getcontentlength', + true, + true, + true, + SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER + ), ]); $plugin->searchHandler($request, $response); $this->assertEquals(400, $response->getStatus()); } - }