mirror of
https://codeberg.org/icewind/SearchDAV.git
synced 2026-06-04 01:54:07 +02:00
Compare commits
36 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
3865288b69 |
|||
|
|
2b4e9a4811 |
||
|
8339181df3 |
|||
|
|
168c5f9cc4 |
||
| 52c8cfc21b | |||
| acb32ab84d | |||
| d3eb42cd90 | |||
| 721b8825d8 | |||
| b47321646b | |||
| 4d51484de3 | |||
| 3d85afde98 | |||
| 1290acf675 | |||
| c5d79716d0 | |||
|
7bf414d47a |
|||
|
|
9c1e52272c | ||
| c69806d900 | |||
| 286f1527d4 | |||
| 199b246c2a | |||
| 49c010f4d7 | |||
|
946bc1bf69 |
|||
|
|
68d6c966a4 | ||
|
9b78893f83 |
|||
|
|
1ee911ba45 | ||
| 5ba2a3cc31 | |||
| 76953efe15 | |||
| 7174c02348 | |||
|
|
2f87fb84d3 | ||
|
|
c880b7edcd | ||
|
|
faf4ef87fd | ||
|
a469e21c43 |
|||
|
ae858d47f5 |
|||
|
|
f9b08747fc | ||
|
|
bef5795c98 | ||
| 9c24c70774 | |||
| aeb7610589 | |||
| e8cf5e7644 |
42 changed files with 716 additions and 232 deletions
21
.github/workflows/ci.yml
vendored
Normal file
21
.github/workflows/ci.yml
vendored
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
name: CI
|
||||
|
||||
on: [push]
|
||||
|
||||
jobs:
|
||||
build-test:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
php-versions: ['7.4', '8.0', '8.4']
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
- name: Set up php${{ matrix.php-versons }}
|
||||
uses: shivammathur/setup-php@master
|
||||
with:
|
||||
php-version: ${{ matrix.php-versions }}
|
||||
- name: Install dependencies
|
||||
run: composer i
|
||||
- name: PHPUnit
|
||||
run: ./vendor/phpunit/phpunit/phpunit -c tests/phpunit.xml
|
||||
41
.github/workflows/lint.yml
vendored
Normal file
41
.github/workflows/lint.yml
vendored
Normal file
|
|
@ -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
|
||||
36
.github/workflows/static-analysis.yml
vendored
Normal file
36
.github/workflows/static-analysis.yml
vendored
Normal file
|
|
@ -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
|
||||
3
.gitignore
vendored
3
.gitignore
vendored
|
|
@ -1,2 +1,5 @@
|
|||
composer.lock
|
||||
vendor
|
||||
coverage.xml
|
||||
.phpunit.result.cache
|
||||
*.cache
|
||||
|
|
|
|||
15
.php_cs.dist
Normal file
15
.php_cs.dist
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
<?php
|
||||
$finder = PhpCsFixer\Finder::create()
|
||||
->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)
|
||||
;
|
||||
6
.scrutinizer.yml
Normal file
6
.scrutinizer.yml
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
build:
|
||||
nodes:
|
||||
analysis:
|
||||
tests:
|
||||
override:
|
||||
- php-scrutinizer-run
|
||||
|
|
@ -1,9 +1,8 @@
|
|||
language: php
|
||||
php:
|
||||
- '5.6'
|
||||
- '7.0'
|
||||
- '7.1'
|
||||
- '7.2'
|
||||
- '7.3'
|
||||
- '7.4'
|
||||
|
||||
cache:
|
||||
directories:
|
||||
|
|
|
|||
|
|
@ -9,16 +9,31 @@
|
|||
}
|
||||
],
|
||||
"require": {
|
||||
"php": ">=5.6",
|
||||
"sabre/dav": "^3.2.0"
|
||||
"php": ">=7.3 || >=8.0",
|
||||
"sabre/dav": "^4.0.0"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^4.8"
|
||||
"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": {
|
||||
"psr-4": {
|
||||
"SearchDAV\\": "src/",
|
||||
"SearchDAV\\": "src/"
|
||||
}
|
||||
},
|
||||
"autoload-dev": {
|
||||
"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"
|
||||
}
|
||||
}
|
||||
|
|
|
|||
15
psalm.xml
Normal file
15
psalm.xml
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
<?xml version="1.0"?>
|
||||
<psalm
|
||||
errorLevel="3"
|
||||
resolveFromConfigFile="true"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xmlns="https://getpsalm.org/schema/config"
|
||||
xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
|
||||
>
|
||||
<projectFiles>
|
||||
<directory name="src" />
|
||||
<ignoreFiles>
|
||||
<directory name="vendor" />
|
||||
</ignoreFiles>
|
||||
</projectFiles>
|
||||
</psalm>
|
||||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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;
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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');
|
||||
|
|
@ -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,18 +91,13 @@ 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) {
|
||||
$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;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -37,7 +37,7 @@ class PathHelper {
|
|||
$this->server = $server;
|
||||
}
|
||||
|
||||
public function getPathFromUri($uri) {
|
||||
public function getPathFromUri(string $uri): ?string {
|
||||
if (strpos($uri, '://') === false) {
|
||||
return $uri;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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) {
|
||||
|
|
@ -74,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,
|
||||
];
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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,19 +55,14 @@ 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 */
|
||||
$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');
|
||||
|
|
@ -89,7 +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;
|
||||
}
|
||||
|
|
@ -98,9 +97,10 @@ 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) {
|
||||
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');
|
||||
}
|
||||
|
|
@ -110,9 +110,9 @@ 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;
|
||||
return null;
|
||||
}
|
||||
$prop = $allProps[$propName];
|
||||
if (!$prop->selectable) {
|
||||
|
|
@ -122,13 +122,19 @@ 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);
|
||||
}
|
||||
|
||||
private function transformOperator(\SearchDAV\XML\Operator $operator, array $allProps) {
|
||||
$arguments = array_map(function($argument) use ($allProps) {
|
||||
/**
|
||||
* @param \SearchDAV\XML\Operator $operator
|
||||
* @param SearchPropertyDefinition[] $allProps
|
||||
* @return Operator
|
||||
* @throws BadRequest
|
||||
*/
|
||||
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])) {
|
||||
throw new BadRequest('requested search property is not a valid property for this scope');
|
||||
|
|
@ -138,11 +144,13 @@ class SearchHandler {
|
|||
throw new BadRequest('requested search property is not searchable');
|
||||
}
|
||||
return $prop;
|
||||
} else if ($argument instanceof \SearchDAV\XML\Operator) {
|
||||
} else {
|
||||
if ($argument instanceof \SearchDAV\XML\Operator) {
|
||||
return $this->transformOperator($argument, $allProps);
|
||||
} else {
|
||||
return $argument;
|
||||
}
|
||||
}
|
||||
}, $operator->arguments);
|
||||
|
||||
return new Operator($operator->type, $arguments);
|
||||
|
|
@ -158,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<array>
|
||||
*/
|
||||
private function getPropertiesIteratorResults($results, $propertyNames = [], $depth = 0) {
|
||||
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();
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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', '<DAV:basicsearch>');
|
||||
}
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
|
|
@ -108,7 +104,7 @@ class SearchPlugin extends ServerPlugin {
|
|||
|
||||
try {
|
||||
$xml = $this->queryParser->parse(
|
||||
$request->getBody(),
|
||||
$request->getBodyAsString(),
|
||||
$request->getUrl(),
|
||||
$documentType
|
||||
);
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -21,7 +21,6 @@
|
|||
|
||||
namespace SearchDAV\Query;
|
||||
|
||||
|
||||
class Limit {
|
||||
/**
|
||||
* @var integer
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -21,7 +21,6 @@
|
|||
|
||||
namespace SearchDAV\Query;
|
||||
|
||||
|
||||
class Literal {
|
||||
/**
|
||||
* @var string|boolean|\DateTime|integer
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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,9 +59,9 @@ class Operator {
|
|||
* Operator constructor.
|
||||
*
|
||||
* @param string $type
|
||||
* @param array $arguments
|
||||
* @param (Literal|\SearchDAV\Backend\SearchPropertyDefinition|Operator)[] $arguments
|
||||
*/
|
||||
public function __construct($type = '', array $arguments = []) {
|
||||
public function __construct(string $type = '', array $arguments = []) {
|
||||
$this->type = $type;
|
||||
$this->arguments = $arguments;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -21,7 +21,6 @@
|
|||
|
||||
namespace SearchDAV\Query;
|
||||
|
||||
|
||||
use SearchDAV\Backend\SearchPropertyDefinition;
|
||||
|
||||
class Order {
|
||||
|
|
@ -46,7 +45,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;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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.
|
||||
*/
|
||||
|
|
@ -65,11 +64,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;
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2018 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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($href = '', $depth = 1, $path = null) {
|
||||
public function __construct(string $href = '', $depth = 1, ?string $path = null) {
|
||||
$this->href = $href;
|
||||
$this->depth = $depth;
|
||||
$this->path = $path;
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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) {
|
||||
$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()
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -21,7 +21,6 @@
|
|||
|
||||
namespace SearchDAV\XML;
|
||||
|
||||
|
||||
use Sabre\Xml\Writer;
|
||||
use Sabre\Xml\XmlSerializable;
|
||||
|
||||
|
|
@ -38,8 +37,8 @@ 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',
|
||||
'value' => $propDesc
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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) {
|
||||
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;
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -21,15 +21,19 @@
|
|||
|
||||
namespace SearchDAV\XML;
|
||||
|
||||
|
||||
use Sabre\Xml\Reader;
|
||||
use Sabre\Xml\XmlDeserializable;
|
||||
|
||||
class Literal extends \SearchDAV\Query\Literal implements XmlDeserializable {
|
||||
static function xmlDeserialize(Reader $reader) {
|
||||
public static function xmlDeserialize(Reader $reader): Literal {
|
||||
$literal = new self();
|
||||
|
||||
if ($reader->isEmptyElement) {
|
||||
$literal->value = '';
|
||||
} else {
|
||||
$literal->value = $reader->readText();
|
||||
}
|
||||
|
||||
$reader->read();
|
||||
|
||||
return $literal;
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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 {
|
||||
/**
|
||||
|
|
@ -32,7 +33,7 @@ class Operator implements XmlDeserializable {
|
|||
*/
|
||||
public $type;
|
||||
/**
|
||||
* @var (Literal|string|Operation)[]
|
||||
* @var (Literal|string|Operator)[]
|
||||
*
|
||||
* The list of arguments for the operation
|
||||
*
|
||||
|
|
@ -48,32 +49,41 @@ class Operator implements XmlDeserializable {
|
|||
* Operator constructor.
|
||||
*
|
||||
* @param string $type
|
||||
* @param array $arguments
|
||||
* @param (Literal|string|Operator)[] $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) {
|
||||
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;
|
||||
}
|
||||
|
||||
if ($operator->type === QueryOperator::OPERATION_CONTAINS) {
|
||||
$operator->arguments[] = $reader->readString();
|
||||
$reader->next();
|
||||
return $operator;
|
||||
}
|
||||
|
||||
$reader->read();
|
||||
do {
|
||||
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'];
|
||||
}
|
||||
} else {
|
||||
$reader->read();
|
||||
if (!$reader->read()) {
|
||||
break;
|
||||
}
|
||||
}
|
||||
} while ($reader->nodeType !== Reader::END_ELEMENT);
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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 {
|
||||
/**
|
||||
|
|
@ -45,15 +45,15 @@ 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) {
|
||||
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];
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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]
|
||||
];
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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,17 +38,19 @@ 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', [
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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) {
|
||||
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'];
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
<?php
|
||||
<?php declare(strict_types=1);
|
||||
/**
|
||||
* @copyright Copyright (c) 2017 Robin Appelman <robin@icewind.nl>
|
||||
*
|
||||
|
|
@ -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();
|
||||
|
|
|
|||
|
|
@ -21,7 +21,6 @@
|
|||
|
||||
namespace SearchDAV\Test;
|
||||
|
||||
|
||||
use Sabre\DAV\INode;
|
||||
use Sabre\DAV\SimpleFile;
|
||||
use SearchDAV\Backend\ISearchBackend;
|
||||
|
|
@ -31,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 {
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -21,11 +21,12 @@
|
|||
|
||||
namespace SearchDAV\Test;
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Sabre\DAV\Server;
|
||||
use SearchDAV\DAV\PathHelper;
|
||||
|
||||
class PathHelperTest extends \PHPUnit_Framework_TestCase {
|
||||
public function uriProvider(){
|
||||
class PathHelperTest extends TestCase {
|
||||
public function uriProvider() {
|
||||
return [
|
||||
['/', '', ''],
|
||||
['/index.php/', 'foo', 'foo'],
|
||||
|
|
|
|||
|
|
@ -21,7 +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;
|
||||
|
|
@ -32,8 +33,7 @@ use SearchDAV\XML\Order;
|
|||
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();
|
||||
|
|
@ -48,14 +48,14 @@ class QueryParserTest extends \PHPUnit_Framework_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);
|
||||
}
|
||||
|
||||
|
|
@ -73,14 +73,14 @@ class QueryParserTest extends \PHPUnit_Framework_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);
|
||||
}
|
||||
|
||||
|
|
@ -105,12 +105,10 @@ class QueryParserTest extends \PHPUnit_Framework_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);
|
||||
}
|
||||
|
||||
|
|
@ -142,4 +140,44 @@ 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);
|
||||
}
|
||||
|
||||
public function testParseWhereBroken() {
|
||||
$query = file_get_contents(__DIR__ . '/invalidwherebroken.xml');
|
||||
$this->expectException(ParseException::class);
|
||||
(new QueryParser())->parse($query, null, $rootElementName);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@
|
|||
|
||||
namespace SearchDAV\Test;
|
||||
|
||||
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Sabre\DAV\FS\Directory;
|
||||
use Sabre\DAV\INode;
|
||||
use Sabre\DAV\PropFind;
|
||||
|
|
@ -29,25 +29,21 @@ 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;
|
||||
|
||||
protected function setUp() {
|
||||
protected function setUp(): void {
|
||||
parent::setUp();
|
||||
|
||||
$this->searchBackend = $this->getMockBuilder(ISearchBackend::class)
|
||||
|
|
@ -60,7 +56,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 +71,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 +86,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 +103,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 +167,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 +180,22 @@ 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_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);
|
||||
|
|
@ -208,7 +216,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 +247,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 +274,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 +284,23 @@ 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_NON_NEGATIVE_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 +312,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 +339,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,12 +362,19 @@ class SearchPluginTest extends \PHPUnit_Framework_TestCase {
|
|||
->method('getArbiterPath')
|
||||
->willReturn('foo');
|
||||
|
||||
$lengthProp = new SearchPropertyDefinition(
|
||||
'{DAV:}getcontentlength',
|
||||
true,
|
||||
true,
|
||||
true,
|
||||
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_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'));
|
||||
|
|
@ -363,12 +384,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() {
|
||||
|
|
@ -381,7 +410,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'));
|
||||
|
|
@ -409,7 +438,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'));
|
||||
|
|
@ -458,7 +487,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'));
|
||||
|
|
@ -474,7 +503,13 @@ 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_NON_NEGATIVE_INTEGER
|
||||
),
|
||||
]);
|
||||
|
||||
$plugin->searchHandler($request, $response);
|
||||
|
|
@ -482,4 +517,97 @@ 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_NON_NEGATIVE_INTEGER
|
||||
),
|
||||
new SearchPropertyDefinition(
|
||||
'{DAV:}getcontentlength',
|
||||
true,
|
||||
true,
|
||||
true,
|
||||
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||
),
|
||||
]);
|
||||
|
||||
$plugin->searchHandler($request, $response);
|
||||
|
||||
$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');
|
||||
|
||||
$this->searchBackend->expects($this->any())
|
||||
->method('getPropertyDefinitionsForScope')
|
||||
->willReturn([
|
||||
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());
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
<?php
|
||||
|
||||
require '../vendor/autoload.php';
|
||||
require __DIR__ . '/../vendor/autoload.php';
|
||||
|
|
|
|||
41
tests/complexquery.xml
Normal file
41
tests/complexquery.xml
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
<?xml version="1.0"?>
|
||||
<d:searchrequest xmlns:d="DAV:">
|
||||
<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:and>
|
||||
<d:gt>
|
||||
<d:prop>
|
||||
<d:getcontentlength/>
|
||||
</d:prop>
|
||||
<d:literal>10000</d:literal>
|
||||
</d:gt>
|
||||
<d:lt>
|
||||
<d:prop>
|
||||
<d:getcontentlength/>
|
||||
</d:prop>
|
||||
<d:literal>90000</d:literal>
|
||||
</d:lt>
|
||||
<d:contains>Peter Forsberg</d:contains>
|
||||
</d:and>
|
||||
</d:where>
|
||||
<d:orderby>
|
||||
<d:order>
|
||||
<d:prop>
|
||||
<d:getcontentlength/>
|
||||
</d:prop>
|
||||
<d:ascending/>
|
||||
</d:order>
|
||||
</d:orderby>
|
||||
</d:basicsearch>
|
||||
</d:searchrequest>
|
||||
30
tests/infiniteloopemptyliteral.xml
Normal file
30
tests/infiniteloopemptyliteral.xml
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<d:searchrequest xmlns:d="DAV:" xmlns:oc="http://nextcloud.com/ns">
|
||||
<d:basicsearch>
|
||||
<d:select>
|
||||
<d:prop>
|
||||
<d:displayname/>
|
||||
<d:getcontenttype/>
|
||||
<d:resourcetype/>
|
||||
<d:getcontentlength/>
|
||||
<d:getlastmodified/>
|
||||
<d:creationdate/>
|
||||
<d:getetag/>
|
||||
<d:quota-used-bytes/>
|
||||
<d:quota-available-bytes/>
|
||||
<oc:permissions xmlns:oc="http://owncloud.org/ns"/>
|
||||
<oc:id xmlns:oc="http://owncloud.org/ns"/>
|
||||
<oc:size xmlns:oc="http://owncloud.org/ns"/>
|
||||
<oc:favorite xmlns:oc="http://owncloud.org/ns"/>
|
||||
</d:prop>
|
||||
</d:select>
|
||||
<d:from>
|
||||
<d:scope>
|
||||
<d:href>/files/naofumi</d:href>
|
||||
<d:depth>infinity</d:depth>
|
||||
</d:scope>
|
||||
</d:from>
|
||||
<d:where><d:like><d:prop/><d:literal/></d:like></d:where>
|
||||
<d:orderby/>
|
||||
</d:basicsearch>
|
||||
</d:searchrequest>
|
||||
22
tests/invalidwherebroken.xml
Normal file
22
tests/invalidwherebroken.xml
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
<?xml version="1.0"?>
|
||||
<d:searchrequest xmlns:d="DAV:" xmlns:oc="http://ns.nextcloud.com">
|
||||
<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:literal>5</d:literal>
|
||||
</d:gt>
|
||||
</d:where>
|
||||
</d:basicsearch>
|
||||
</d:searchrequest>
|
||||
30
tests/invalidwherenoprop.xml
Normal file
30
tests/invalidwherenoprop.xml
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
<?xml version="1.0"?>
|
||||
<d:searchrequest xmlns:d="DAV:" xmlns:oc="http://ns.nextcloud.com">
|
||||
<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:literal />
|
||||
</d:gt>
|
||||
</d:where>
|
||||
<d:orderby>
|
||||
<d:order>
|
||||
<d:prop>
|
||||
<d:getcontentlength/>
|
||||
</d:prop>
|
||||
<d:ascending/>
|
||||
</d:order>
|
||||
</d:orderby>
|
||||
</d:basicsearch>
|
||||
</d:searchrequest>
|
||||
Loading…
Add table
Add a link
Reference in a new issue