mirror of
https://codeberg.org/icewind/SearchDAV.git
synced 2026-06-04 01:54:07 +02:00
Compare commits
15 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
3865288b69 |
|||
|
|
2b4e9a4811 |
||
|
8339181df3 |
|||
|
|
168c5f9cc4 |
||
| 52c8cfc21b | |||
| acb32ab84d | |||
| d3eb42cd90 | |||
| 721b8825d8 | |||
| b47321646b | |||
| 4d51484de3 | |||
| 3d85afde98 | |||
| 1290acf675 | |||
| c5d79716d0 | |||
|
7bf414d47a |
|||
|
|
9c1e52272c |
35 changed files with 347 additions and 154 deletions
15
.github/workflows/ci.yml
vendored
15
.github/workflows/ci.yml
vendored
|
|
@ -5,10 +5,17 @@ on: [push]
|
||||||
jobs:
|
jobs:
|
||||||
build-test:
|
build-test:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
php-versions: ['7.4', '8.0', '8.4']
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v1
|
- uses: actions/checkout@v2
|
||||||
- uses: php-actions/composer@v1
|
- name: Set up php${{ matrix.php-versons }}
|
||||||
- uses: php-actions/phpunit@v1.0.0
|
uses: shivammathur/setup-php@master
|
||||||
with:
|
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
|
||||||
|
|
|
||||||
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
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
|
|
@ -2,3 +2,4 @@ composer.lock
|
||||||
vendor
|
vendor
|
||||||
coverage.xml
|
coverage.xml
|
||||||
.phpunit.result.cache
|
.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)
|
||||||
|
;
|
||||||
|
|
@ -9,10 +9,14 @@
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"require": {
|
"require": {
|
||||||
"php": ">=7.1",
|
"php": ">=7.3 || >=8.0",
|
||||||
"sabre/dav": "^4.0.0"
|
"sabre/dav": "^4.0.0"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"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"
|
"phpunit/phpunit": "^8"
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
|
|
@ -24,5 +28,12 @@
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"SearchDAV\\Test\\": "tests/"
|
"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>
|
||||||
|
|
@ -21,13 +21,14 @@
|
||||||
|
|
||||||
namespace SearchDAV\Backend;
|
namespace SearchDAV\Backend;
|
||||||
|
|
||||||
|
use Sabre\DAV\INode;
|
||||||
use SearchDAV\Query\Query;
|
use SearchDAV\Query\Query;
|
||||||
|
|
||||||
interface ISearchBackend {
|
interface ISearchBackend {
|
||||||
/**
|
/**
|
||||||
* Get the path of the search arbiter of this backend
|
* 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
|
* 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.
|
* The returned value should be a path relative the root of the dav server.
|
||||||
|
|
@ -37,10 +38,10 @@ interface ISearchBackend {
|
||||||
*
|
*
|
||||||
* @return string
|
* @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.
|
* 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
|
* @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
|
* @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
|
* 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
|
* @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[]
|
* @return SearchPropertyDefinition[]
|
||||||
*/
|
*/
|
||||||
public function getPropertyDefinitionsForScope($href, $path);
|
public function getPropertyDefinitionsForScope(string $href, ?string $path): array;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Preform the search request
|
* Preform the search request
|
||||||
|
|
@ -80,5 +81,14 @@ interface ISearchBackend {
|
||||||
* @param Query $query
|
* @param Query $query
|
||||||
* @return SearchResult[]
|
* @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;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -26,6 +26,7 @@ class SearchPropertyDefinition {
|
||||||
const DATATYPE_STRING = self::XS . 'string';
|
const DATATYPE_STRING = self::XS . 'string';
|
||||||
const DATATYPE_INTEGER = self::XS . 'integer';
|
const DATATYPE_INTEGER = self::XS . 'integer';
|
||||||
const DATATYPE_NONNEGATIVE_INTEGER = self::XS . 'nonNegativeInteger';
|
const DATATYPE_NONNEGATIVE_INTEGER = self::XS . 'nonNegativeInteger';
|
||||||
|
const DATATYPE_NON_NEGATIVE_INTEGER = self::XS . 'nonNegativeInteger';
|
||||||
const DATATYPE_DECIMAL = self::XS . 'decimal';
|
const DATATYPE_DECIMAL = self::XS . 'decimal';
|
||||||
const DATATYPE_DATETIME = self::XS . 'dateTime';
|
const DATATYPE_DATETIME = self::XS . 'dateTime';
|
||||||
const DATATYPE_BOOLEAN = self::XS . 'boolean';
|
const DATATYPE_BOOLEAN = self::XS . 'boolean';
|
||||||
|
|
@ -48,13 +49,13 @@ class SearchPropertyDefinition {
|
||||||
* SearchProperty constructor.
|
* SearchProperty constructor.
|
||||||
*
|
*
|
||||||
* @param string $name the name and namespace of the property in clark notation
|
* @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 $searchable whether 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 $selectable whether 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 $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 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->searchable = $searchable;
|
||||||
$this->selectable = $selectable;
|
$this->selectable = $selectable;
|
||||||
$this->sortable = $sortable;
|
$this->sortable = $sortable;
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,6 @@
|
||||||
|
|
||||||
namespace SearchDAV\Backend;
|
namespace SearchDAV\Backend;
|
||||||
|
|
||||||
|
|
||||||
use Sabre\DAV\INode;
|
use Sabre\DAV\INode;
|
||||||
|
|
||||||
class SearchResult {
|
class SearchResult {
|
||||||
|
|
@ -36,7 +35,7 @@ class SearchResult {
|
||||||
* @param INode $node
|
* @param INode $node
|
||||||
* @param string $href
|
* @param string $href
|
||||||
*/
|
*/
|
||||||
public function __construct(INode $node, $href) {
|
public function __construct(INode $node, string $href) {
|
||||||
$this->node = $node;
|
$this->node = $node;
|
||||||
$this->href = $href;
|
$this->href = $href;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,7 @@ class DiscoverHandler {
|
||||||
$this->queryParser = $queryParser;
|
$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'])) {
|
if (!isset($xml['{DAV:}basicsearch'])) {
|
||||||
$response->setStatus(400);
|
$response->setStatus(400);
|
||||||
$response->setBody('Unexpected xml content for query-schema-discovery, expected basicsearch');
|
$response->setBody('Unexpected xml content for query-schema-discovery, expected basicsearch');
|
||||||
|
|
@ -97,12 +97,7 @@ class DiscoverHandler {
|
||||||
foreach ($propertyDefinitions as $propertyDefinition) {
|
foreach ($propertyDefinitions as $propertyDefinition) {
|
||||||
$key = $this->hashDefinition($propertyDefinition);
|
$key = $this->hashDefinition($propertyDefinition);
|
||||||
if (!isset($groups[$key])) {
|
if (!isset($groups[$key])) {
|
||||||
$desc = new PropDesc();
|
$groups[$key] = new PropDesc($propertyDefinition);
|
||||||
$desc->dataType = $propertyDefinition->dataType;
|
|
||||||
$desc->sortable = $propertyDefinition->sortable;
|
|
||||||
$desc->selectable = $propertyDefinition->selectable;
|
|
||||||
$desc->searchable = $propertyDefinition->searchable;
|
|
||||||
$groups[$key] = $desc;
|
|
||||||
}
|
}
|
||||||
$groups[$key]->properties[] = $propertyDefinition->name;
|
$groups[$key]->properties[] = $propertyDefinition->name;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -37,7 +37,7 @@ class PathHelper {
|
||||||
$this->server = $server;
|
$this->server = $server;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getPathFromUri($uri): ?string {
|
public function getPathFromUri(string $uri): ?string {
|
||||||
if (strpos($uri, '://') === false) {
|
if (strpos($uri, '://') === false) {
|
||||||
return $uri;
|
return $uri;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -30,6 +30,8 @@ use SearchDAV\XML\Literal;
|
||||||
use SearchDAV\XML\Operator;
|
use SearchDAV\XML\Operator;
|
||||||
use SearchDAV\XML\Order;
|
use SearchDAV\XML\Order;
|
||||||
use SearchDAV\XML\Scope;
|
use SearchDAV\XML\Scope;
|
||||||
|
use function Sabre\Xml\Deserializer\keyValue;
|
||||||
|
use function Sabre\Xml\Deserializer\repeatingElements;
|
||||||
|
|
||||||
class QueryParser extends Service {
|
class QueryParser extends Service {
|
||||||
public $namespaceMap = [
|
public $namespaceMap = [
|
||||||
|
|
@ -46,13 +48,13 @@ class QueryParser extends Service {
|
||||||
'{DAV:}query-schema-discovery' => Element\KeyValue::class,
|
'{DAV:}query-schema-discovery' => Element\KeyValue::class,
|
||||||
'{DAV:}basicsearch' => BasicSearch::class,
|
'{DAV:}basicsearch' => BasicSearch::class,
|
||||||
'{DAV:}select' => function (Reader $reader) {
|
'{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) {
|
'{DAV:}from' => function (Reader $reader) {
|
||||||
return \Sabre\Xml\Deserializer\repeatingElements($reader, '{DAV:}scope');
|
return repeatingElements($reader, '{DAV:}scope');
|
||||||
},
|
},
|
||||||
'{DAV:}orderby' => function (Reader $reader) {
|
'{DAV:}orderby' => function (Reader $reader) {
|
||||||
return \Sabre\Xml\Deserializer\repeatingElements($reader, '{DAV:}order');
|
return repeatingElements($reader, '{DAV:}order');
|
||||||
},
|
},
|
||||||
'{DAV:}scope' => Scope::class,
|
'{DAV:}scope' => Scope::class,
|
||||||
'{DAV:}where' => function (Reader $reader) {
|
'{DAV:}where' => function (Reader $reader) {
|
||||||
|
|
@ -74,6 +76,7 @@ class QueryParser extends Service {
|
||||||
'{DAV:}contains' => Operator::class,
|
'{DAV:}contains' => Operator::class,
|
||||||
'{DAV:}not' => Operator::class,
|
'{DAV:}not' => Operator::class,
|
||||||
'{DAV:}is-collection' => Operator::class,
|
'{DAV:}is-collection' => Operator::class,
|
||||||
|
'{DAV:}is-defined' => Operator::class,
|
||||||
'{DAV:}limit' => Limit::class,
|
'{DAV:}limit' => Limit::class,
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -22,6 +22,7 @@
|
||||||
namespace SearchDAV\DAV;
|
namespace SearchDAV\DAV;
|
||||||
|
|
||||||
use Sabre\DAV\Exception\BadRequest;
|
use Sabre\DAV\Exception\BadRequest;
|
||||||
|
use Sabre\DAV\INode;
|
||||||
use Sabre\DAV\PropFind;
|
use Sabre\DAV\PropFind;
|
||||||
use Sabre\DAV\Server;
|
use Sabre\DAV\Server;
|
||||||
use Sabre\HTTP\ResponseInterface;
|
use Sabre\HTTP\ResponseInterface;
|
||||||
|
|
@ -54,7 +55,7 @@ class SearchHandler {
|
||||||
$this->server = $server;
|
$this->server = $server;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function handleSearchRequest($xml, ResponseInterface $response) {
|
public function handleSearchRequest($xml, ResponseInterface $response): bool {
|
||||||
if (!isset($xml['{DAV:}basicsearch'])) {
|
if (!isset($xml['{DAV:}basicsearch'])) {
|
||||||
$response->setStatus(400);
|
$response->setStatus(400);
|
||||||
$response->setBody('Unexpected xml content for search request, expected basicsearch');
|
$response->setBody('Unexpected xml content for search request, expected basicsearch');
|
||||||
|
|
@ -84,8 +85,10 @@ class SearchHandler {
|
||||||
$response->setBody($e->getMessage());
|
$response->setBody($e->getMessage());
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
$data = $this->server->generateMultiStatus(iterator_to_array($this->getPropertiesIteratorResults($results,
|
$data = $this->server->generateMultiStatus(iterator_to_array($this->getPropertiesIteratorResults(
|
||||||
$query->select)), false);
|
$results,
|
||||||
|
$query->select
|
||||||
|
)), false);
|
||||||
$response->setBody($data);
|
$response->setBody($data);
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
@ -126,7 +129,7 @@ class SearchHandler {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param \SearchDAV\XML\Operator $operator
|
* @param \SearchDAV\XML\Operator $operator
|
||||||
* @param array $allProps
|
* @param SearchPropertyDefinition[] $allProps
|
||||||
* @return Operator
|
* @return Operator
|
||||||
* @throws BadRequest
|
* @throws BadRequest
|
||||||
*/
|
*/
|
||||||
|
|
@ -163,16 +166,20 @@ class SearchHandler {
|
||||||
* If a depth of 1 is requested child elements will also be returned.
|
* If a depth of 1 is requested child elements will also be returned.
|
||||||
*
|
*
|
||||||
* @param SearchResult[] $results
|
* @param SearchResult[] $results
|
||||||
* @param array $propertyNames
|
* @param string[] $propertyNames
|
||||||
* @param int $depth
|
* @param int $depth
|
||||||
* @return \Iterator
|
* @return \Iterator<array>
|
||||||
*/
|
*/
|
||||||
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;
|
$propFindType = $propertyNames ? PropFind::NORMAL : PropFind::ALLPROPS;
|
||||||
|
|
||||||
|
$this->searchBackend->preloadPropertyFor(array_map(function (SearchResult $result): INode {
|
||||||
|
return $result->node;
|
||||||
|
}, $results), $propertyNames);
|
||||||
|
|
||||||
foreach ($results as $result) {
|
foreach ($results as $result) {
|
||||||
$node = $result->node;
|
$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);
|
$r = $this->server->getPropertiesByNode($propFind, $node);
|
||||||
if ($r) {
|
if ($r) {
|
||||||
$result = $propFind->getResultForMultiStatus();
|
$result = $propFind->getResultForMultiStatus();
|
||||||
|
|
|
||||||
|
|
@ -34,9 +34,6 @@ use SearchDAV\XML\SupportedQueryGrammar;
|
||||||
class SearchPlugin extends ServerPlugin {
|
class SearchPlugin extends ServerPlugin {
|
||||||
const SEARCHDAV_NS = 'https://github.com/icewind1991/SearchDAV/ns';
|
const SEARCHDAV_NS = 'https://github.com/icewind1991/SearchDAV/ns';
|
||||||
|
|
||||||
/** @var Server */
|
|
||||||
private $server;
|
|
||||||
|
|
||||||
/** @var ISearchBackend */
|
/** @var ISearchBackend */
|
||||||
private $searchBackend;
|
private $searchBackend;
|
||||||
|
|
||||||
|
|
@ -57,8 +54,7 @@ class SearchPlugin extends ServerPlugin {
|
||||||
$this->queryParser = new QueryParser();
|
$this->queryParser = new QueryParser();
|
||||||
}
|
}
|
||||||
|
|
||||||
public function initialize(Server $server) {
|
public function initialize(Server $server): void {
|
||||||
$this->server = $server;
|
|
||||||
$this->pathHelper = new PathHelper($server);
|
$this->pathHelper = new PathHelper($server);
|
||||||
$this->search = new SearchHandler($this->searchBackend, $this->pathHelper, $server);
|
$this->search = new SearchHandler($this->searchBackend, $this->pathHelper, $server);
|
||||||
$this->discover = new DiscoverHandler($this->searchBackend, $this->pathHelper, $this->queryParser);
|
$this->discover = new DiscoverHandler($this->searchBackend, $this->pathHelper, $this->queryParser);
|
||||||
|
|
@ -67,7 +63,7 @@ class SearchPlugin extends ServerPlugin {
|
||||||
$server->on('propFind', [$this, 'propFindHandler']);
|
$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()) {
|
if ($propFind->getPath() === $this->searchBackend->getArbiterPath()) {
|
||||||
$propFind->handle('{DAV:}supported-query-grammar-set', new SupportedQueryGrammar());
|
$propFind->handle('{DAV:}supported-query-grammar-set', new SupportedQueryGrammar());
|
||||||
}
|
}
|
||||||
|
|
@ -76,11 +72,11 @@ class SearchPlugin extends ServerPlugin {
|
||||||
/**
|
/**
|
||||||
* SEARCH is allowed for users files
|
* SEARCH is allowed for users files
|
||||||
*
|
*
|
||||||
* @param string $uri
|
* @param string $path
|
||||||
* @return array
|
* @return string[]
|
||||||
*/
|
*/
|
||||||
public function getHTTPMethods($uri) {
|
public function getHTTPMethods($path): array {
|
||||||
$path = $this->pathHelper->getPathFromUri($uri);
|
$path = $this->pathHelper->getPathFromUri($path);
|
||||||
if ($this->searchBackend->getArbiterPath() === $path) {
|
if ($this->searchBackend->getArbiterPath() === $path) {
|
||||||
return ['SEARCH'];
|
return ['SEARCH'];
|
||||||
} else {
|
} 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()) {
|
if ($request->getPath() === $this->searchBackend->getArbiterPath()) {
|
||||||
$response->addHeader('DASL', '<DAV:basicsearch>');
|
$response->addHeader('DASL', '<DAV:basicsearch>');
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public function searchHandler(RequestInterface $request, ResponseInterface $response) {
|
public function searchHandler(RequestInterface $request, ResponseInterface $response): bool {
|
||||||
$contentType = $request->getHeader('Content-Type');
|
$contentType = $request->getHeader('Content-Type') ?? '';
|
||||||
|
|
||||||
// Currently we only support xml search queries
|
// Currently, we only support xml search queries
|
||||||
if ((strpos($contentType, 'text/xml') === false) && (strpos($contentType, 'application/xml') === false)) {
|
if ((strpos($contentType, 'text/xml') === false) && (strpos($contentType, 'application/xml') === false)) {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,6 @@
|
||||||
|
|
||||||
namespace SearchDAV\Query;
|
namespace SearchDAV\Query;
|
||||||
|
|
||||||
|
|
||||||
class Limit {
|
class Limit {
|
||||||
/**
|
/**
|
||||||
* @var integer
|
* @var integer
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,6 @@
|
||||||
|
|
||||||
namespace SearchDAV\Query;
|
namespace SearchDAV\Query;
|
||||||
|
|
||||||
|
|
||||||
class Literal {
|
class Literal {
|
||||||
/**
|
/**
|
||||||
* @var string|boolean|\DateTime|integer
|
* @var string|boolean|\DateTime|integer
|
||||||
|
|
|
||||||
|
|
@ -41,14 +41,15 @@ class Operator {
|
||||||
* The type of operation, one of the Operator::OPERATION_* constants
|
* The type of operation, one of the Operator::OPERATION_* constants
|
||||||
*/
|
*/
|
||||||
public $type;
|
public $type;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var (Literal|SearchPropDefinition|Operation)[]
|
* @var (Literal|\SearchDAV\Backend\SearchPropertyDefinition|Operator)[]
|
||||||
*
|
*
|
||||||
* The list of arguments for the operation
|
* The list of arguments for the operation
|
||||||
*
|
*
|
||||||
* - SearchPropDefinition: property for comparison
|
* - SearchPropDefinition: property for comparison
|
||||||
* - Literal: literal value 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.
|
* Which type and what number of argument an Operator takes depends on the operator type.
|
||||||
*/
|
*/
|
||||||
|
|
@ -58,7 +59,7 @@ class Operator {
|
||||||
* Operator constructor.
|
* Operator constructor.
|
||||||
*
|
*
|
||||||
* @param string $type
|
* @param string $type
|
||||||
* @param array $arguments
|
* @param (Literal|\SearchDAV\Backend\SearchPropertyDefinition|Operator)[] $arguments
|
||||||
*/
|
*/
|
||||||
public function __construct(string $type = '', array $arguments = []) {
|
public function __construct(string $type = '', array $arguments = []) {
|
||||||
$this->type = $type;
|
$this->type = $type;
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,6 @@
|
||||||
|
|
||||||
namespace SearchDAV\Query;
|
namespace SearchDAV\Query;
|
||||||
|
|
||||||
|
|
||||||
use SearchDAV\Backend\SearchPropertyDefinition;
|
use SearchDAV\Backend\SearchPropertyDefinition;
|
||||||
|
|
||||||
class Order {
|
class Order {
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,6 @@
|
||||||
|
|
||||||
namespace SearchDAV\Query;
|
namespace SearchDAV\Query;
|
||||||
|
|
||||||
|
|
||||||
use SearchDAV\Backend\SearchPropertyDefinition;
|
use SearchDAV\Backend\SearchPropertyDefinition;
|
||||||
|
|
||||||
class Query {
|
class Query {
|
||||||
|
|
@ -38,7 +37,7 @@ class Query {
|
||||||
*/
|
*/
|
||||||
public $from;
|
public $from;
|
||||||
/**
|
/**
|
||||||
* @var Operator
|
* @var ?Operator
|
||||||
*
|
*
|
||||||
* The search operator, either a comparison ('gt', 'eq', ...) or a boolean operator ('and', 'or', 'not')
|
* 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.
|
* 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.
|
* 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
|
* be applied in the order that the order operations are defined in with the earlier comparisons being
|
||||||
* more significant.
|
* more significant.
|
||||||
*/
|
*/
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,6 @@
|
||||||
|
|
||||||
namespace SearchDAV\Query;
|
namespace SearchDAV\Query;
|
||||||
|
|
||||||
|
|
||||||
class Scope {
|
class Scope {
|
||||||
/**
|
/**
|
||||||
* @var string
|
* @var string
|
||||||
|
|
@ -52,7 +51,7 @@ class Scope {
|
||||||
* @param int|string $depth
|
* @param int|string $depth
|
||||||
* @param string|null $path
|
* @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->href = $href;
|
||||||
$this->depth = $depth;
|
$this->depth = $depth;
|
||||||
$this->path = $path;
|
$this->path = $path;
|
||||||
|
|
|
||||||
|
|
@ -24,6 +24,7 @@ namespace SearchDAV\XML;
|
||||||
use Sabre\Xml\ParseException;
|
use Sabre\Xml\ParseException;
|
||||||
use Sabre\Xml\Reader;
|
use Sabre\Xml\Reader;
|
||||||
use Sabre\Xml\XmlDeserializable;
|
use Sabre\Xml\XmlDeserializable;
|
||||||
|
use function Sabre\Xml\Deserializer\keyValue;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The object representation of a search query made by the client
|
* The object representation of a search query made by the client
|
||||||
|
|
@ -42,7 +43,7 @@ class BasicSearch implements XmlDeserializable {
|
||||||
*/
|
*/
|
||||||
public $from;
|
public $from;
|
||||||
/**
|
/**
|
||||||
* @var Operator
|
* @var ?Operator
|
||||||
*
|
*
|
||||||
* The search operator, either a comparison ('gt', 'eq', ...) or a boolean operator ('and', 'or', 'not')
|
* 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 $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
|
* @param Reader $reader
|
||||||
* @return BasicSearch
|
* @return BasicSearch
|
||||||
* @throws ParseException
|
* @throws ParseException
|
||||||
*/
|
*/
|
||||||
static function xmlDeserialize(Reader $reader): BasicSearch {
|
public static function xmlDeserialize(Reader $reader): BasicSearch {
|
||||||
$search = new self();
|
$elements = keyValue($reader);
|
||||||
|
|
||||||
$elements = \Sabre\Xml\Deserializer\keyValue($reader);
|
|
||||||
|
|
||||||
if (!isset($elements['{DAV:}from'])) {
|
if (!isset($elements['{DAV:}from'])) {
|
||||||
throw new ParseException('Missing {DAV:}from when parsing {DAV:}basicsearch');
|
throw new ParseException('Missing {DAV:}from when parsing {DAV:}basicsearch');
|
||||||
}
|
}
|
||||||
|
|
||||||
$search->select = isset($elements['{DAV:}select']) ? $elements['{DAV:}select'] : [];
|
return new BasicSearch(
|
||||||
$search->from = $elements['{DAV:}from'];
|
$elements['{DAV:}select'] ?? [],
|
||||||
$search->where = isset($elements['{DAV:}where']) ? $elements['{DAV:}where'] : null;
|
$elements['{DAV:}from'],
|
||||||
$search->orderBy = isset($elements['{DAV:}orderby']) ? $elements['{DAV:}orderby'] : [];
|
$elements['{DAV:}where'] ?? null,
|
||||||
$search->limit = isset($elements['{DAV:}limit']) ? $elements['{DAV:}limit'] : new Limit();
|
$elements['{DAV:}orderby'] ?? [],
|
||||||
|
$elements['{DAV:}limit'] ?? new Limit()
|
||||||
return $search;
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -21,7 +21,6 @@
|
||||||
|
|
||||||
namespace SearchDAV\XML;
|
namespace SearchDAV\XML;
|
||||||
|
|
||||||
|
|
||||||
use Sabre\Xml\Writer;
|
use Sabre\Xml\Writer;
|
||||||
use Sabre\Xml\XmlSerializable;
|
use Sabre\Xml\XmlSerializable;
|
||||||
|
|
||||||
|
|
@ -38,7 +37,7 @@ class BasicSearchSchema implements XmlSerializable {
|
||||||
$this->properties = $properties;
|
$this->properties = $properties;
|
||||||
}
|
}
|
||||||
|
|
||||||
function xmlSerialize(Writer $writer) {
|
public function xmlSerialize(Writer $writer): void {
|
||||||
$childs = array_map(function (PropDesc $propDesc) {
|
$childs = array_map(function (PropDesc $propDesc) {
|
||||||
return [
|
return [
|
||||||
'name' => '{DAV:}propdesc',
|
'name' => '{DAV:}propdesc',
|
||||||
|
|
|
||||||
|
|
@ -24,15 +24,16 @@ namespace SearchDAV\XML;
|
||||||
use Sabre\Xml\Reader;
|
use Sabre\Xml\Reader;
|
||||||
use Sabre\Xml\XmlDeserializable;
|
use Sabre\Xml\XmlDeserializable;
|
||||||
use SearchDAV\DAV\SearchPlugin;
|
use SearchDAV\DAV\SearchPlugin;
|
||||||
|
use function Sabre\Xml\Deserializer\keyValue;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The limit and offset of a search query
|
* The limit and offset of a search query
|
||||||
*/
|
*/
|
||||||
class Limit extends \SearchDAV\Query\Limit implements XmlDeserializable {
|
class Limit extends \SearchDAV\Query\Limit implements XmlDeserializable {
|
||||||
static function xmlDeserialize(Reader $reader): Limit {
|
public static function xmlDeserialize(Reader $reader): Limit {
|
||||||
$limit = new self();
|
$limit = new self();
|
||||||
|
|
||||||
$elements = \Sabre\Xml\Deserializer\keyValue($reader);
|
$elements = keyValue($reader);
|
||||||
$namespace = SearchPlugin::SEARCHDAV_NS;
|
$namespace = SearchPlugin::SEARCHDAV_NS;
|
||||||
|
|
||||||
$limit->maxResults = isset($elements['{DAV:}nresults']) ? $elements['{DAV:}nresults'] : 0;
|
$limit->maxResults = isset($elements['{DAV:}nresults']) ? $elements['{DAV:}nresults'] : 0;
|
||||||
|
|
|
||||||
|
|
@ -21,12 +21,11 @@
|
||||||
|
|
||||||
namespace SearchDAV\XML;
|
namespace SearchDAV\XML;
|
||||||
|
|
||||||
|
|
||||||
use Sabre\Xml\Reader;
|
use Sabre\Xml\Reader;
|
||||||
use Sabre\Xml\XmlDeserializable;
|
use Sabre\Xml\XmlDeserializable;
|
||||||
|
|
||||||
class Literal extends \SearchDAV\Query\Literal implements 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();
|
$literal = new self();
|
||||||
|
|
||||||
if ($reader->isEmptyElement) {
|
if ($reader->isEmptyElement) {
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,7 @@ class Operator implements XmlDeserializable {
|
||||||
*/
|
*/
|
||||||
public $type;
|
public $type;
|
||||||
/**
|
/**
|
||||||
* @var (Literal|string|Operation)[]
|
* @var (Literal|string|Operator)[]
|
||||||
*
|
*
|
||||||
* The list of arguments for the operation
|
* The list of arguments for the operation
|
||||||
*
|
*
|
||||||
|
|
@ -49,17 +49,17 @@ class Operator implements XmlDeserializable {
|
||||||
* Operator constructor.
|
* Operator constructor.
|
||||||
*
|
*
|
||||||
* @param string $type
|
* @param string $type
|
||||||
* @param array $arguments
|
* @param (Literal|string|Operator)[] $arguments
|
||||||
*/
|
*/
|
||||||
public function __construct(string $type = '', array $arguments = []) {
|
public function __construct(string $type = '', array $arguments = []) {
|
||||||
$this->type = $type;
|
$this->type = $type;
|
||||||
$this->arguments = $arguments;
|
$this->arguments = $arguments;
|
||||||
}
|
}
|
||||||
|
|
||||||
static function xmlDeserialize(Reader $reader): Operator {
|
public static function xmlDeserialize(Reader $reader): Operator {
|
||||||
$operator = new self();
|
$operator = new self();
|
||||||
|
|
||||||
$operator->type = $reader->getClark();
|
$operator->type = $reader->getClark() ?? '';
|
||||||
if ($reader->isEmptyElement) {
|
if ($reader->isEmptyElement) {
|
||||||
$reader->next();
|
$reader->next();
|
||||||
return $operator;
|
return $operator;
|
||||||
|
|
|
||||||
|
|
@ -21,9 +21,9 @@
|
||||||
|
|
||||||
namespace SearchDAV\XML;
|
namespace SearchDAV\XML;
|
||||||
|
|
||||||
|
|
||||||
use Sabre\Xml\Reader;
|
use Sabre\Xml\Reader;
|
||||||
use Sabre\Xml\XmlDeserializable;
|
use Sabre\Xml\XmlDeserializable;
|
||||||
|
use function Sabre\Xml\Deserializer\keyValue;
|
||||||
|
|
||||||
class Order implements XmlDeserializable {
|
class Order implements XmlDeserializable {
|
||||||
/**
|
/**
|
||||||
|
|
@ -50,10 +50,10 @@ class Order implements XmlDeserializable {
|
||||||
$this->order = $order;
|
$this->order = $order;
|
||||||
}
|
}
|
||||||
|
|
||||||
static function xmlDeserialize(Reader $reader): Order {
|
public static function xmlDeserialize(Reader $reader): Order {
|
||||||
$order = new self();
|
$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->order = array_key_exists('{DAV:}descending', $childs) ? \SearchDAV\Query\Order::DESC : \SearchDAV\Query\Order::ASC;
|
||||||
$order->property = $childs['{DAV:}prop'][0];
|
$order->property = $childs['{DAV:}prop'][0];
|
||||||
|
|
|
||||||
|
|
@ -21,9 +21,9 @@
|
||||||
|
|
||||||
namespace SearchDAV\XML;
|
namespace SearchDAV\XML;
|
||||||
|
|
||||||
|
|
||||||
use Sabre\Xml\Writer;
|
use Sabre\Xml\Writer;
|
||||||
use Sabre\Xml\XmlSerializable;
|
use Sabre\Xml\XmlSerializable;
|
||||||
|
use SearchDAV\Backend\SearchPropertyDefinition;
|
||||||
|
|
||||||
class PropDesc implements XmlSerializable {
|
class PropDesc implements XmlSerializable {
|
||||||
/**
|
/**
|
||||||
|
|
@ -47,7 +47,14 @@ class PropDesc implements XmlSerializable {
|
||||||
*/
|
*/
|
||||||
public $sortable;
|
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 = [
|
$data = [
|
||||||
'{DAV:}dataType' => [$this->dataType => null]
|
'{DAV:}dataType' => [$this->dataType => null]
|
||||||
];
|
];
|
||||||
|
|
|
||||||
|
|
@ -21,9 +21,9 @@
|
||||||
|
|
||||||
namespace SearchDAV\XML;
|
namespace SearchDAV\XML;
|
||||||
|
|
||||||
|
|
||||||
use Sabre\DAV\Xml\Element\Response;
|
use Sabre\DAV\Xml\Element\Response;
|
||||||
use Sabre\Xml\Writer;
|
use Sabre\Xml\Writer;
|
||||||
|
use function Sabre\HTTP\encodePath;
|
||||||
|
|
||||||
class QueryDiscoverResponse extends Response {
|
class QueryDiscoverResponse extends Response {
|
||||||
/**
|
/**
|
||||||
|
|
@ -38,17 +38,19 @@ class QueryDiscoverResponse extends Response {
|
||||||
* @param BasicSearchSchema|null $schema
|
* @param BasicSearchSchema|null $schema
|
||||||
* @param null|int|string $httpStatus
|
* @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);
|
parent::__construct($href, [], $httpStatus);
|
||||||
$this->schema = $schema;
|
$this->schema = $schema;
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function xmlSerialize(Writer $writer) {
|
public function xmlSerialize(Writer $writer): void {
|
||||||
if ($status = $this->getHTTPStatus()) {
|
if ($status = $this->getHTTPStatus()) {
|
||||||
$writer->writeElement('{DAV:}status', 'HTTP/1.1 ' . $status . ' ' . \Sabre\HTTP\Response::$statusCodes[$status]);
|
$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) {
|
if ($this->schema) {
|
||||||
$writer->writeElement('{DAV:}query-schema', [
|
$writer->writeElement('{DAV:}query-schema', [
|
||||||
|
|
|
||||||
|
|
@ -23,12 +23,13 @@ namespace SearchDAV\XML;
|
||||||
|
|
||||||
use Sabre\Xml\Reader;
|
use Sabre\Xml\Reader;
|
||||||
use Sabre\Xml\XmlDeserializable;
|
use Sabre\Xml\XmlDeserializable;
|
||||||
|
use function Sabre\Xml\Deserializer\keyValue;
|
||||||
|
|
||||||
class Scope extends \SearchDAV\Query\Scope implements XmlDeserializable {
|
class Scope extends \SearchDAV\Query\Scope implements XmlDeserializable {
|
||||||
static function xmlDeserialize(Reader $reader): Scope {
|
public static function xmlDeserialize(Reader $reader): Scope {
|
||||||
$scope = new self();
|
$scope = new self();
|
||||||
|
|
||||||
$values = \Sabre\Xml\Deserializer\keyValue($reader);
|
$values = keyValue($reader);
|
||||||
$scope->href = $values['{DAV:}href'];
|
$scope->href = $values['{DAV:}href'];
|
||||||
$scope->depth = $values['{DAV:}depth'];
|
$scope->depth = $values['{DAV:}depth'];
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -21,19 +21,16 @@
|
||||||
|
|
||||||
namespace SearchDAV\XML;
|
namespace SearchDAV\XML;
|
||||||
|
|
||||||
|
|
||||||
use Sabre\Xml\Writer;
|
use Sabre\Xml\Writer;
|
||||||
use Sabre\Xml\XmlSerializable;
|
use Sabre\Xml\XmlSerializable;
|
||||||
|
|
||||||
class SupportedQueryGrammar implements XmlSerializable {
|
class SupportedQueryGrammar implements XmlSerializable {
|
||||||
const GRAMMAR_BASICSEARCH = '{DAV:}basicsearch';
|
const GRAMMAR_BASIC_SEARCH = '{DAV:}basicsearch';
|
||||||
|
|
||||||
public $grammar = self::GRAMMAR_BASICSEARCH;
|
public function xmlSerialize(Writer $writer): void {
|
||||||
|
|
||||||
function xmlSerialize(Writer $writer) {
|
|
||||||
$writer->startElement('{DAV:}supported-query-grammar');
|
$writer->startElement('{DAV:}supported-query-grammar');
|
||||||
$writer->startElement('{DAV:}grammar');
|
$writer->startElement('{DAV:}grammar');
|
||||||
$writer->startElement($this->grammar);
|
$writer->startElement(self::GRAMMAR_BASIC_SEARCH);
|
||||||
$writer->endElement();
|
$writer->endElement();
|
||||||
$writer->endElement();
|
$writer->endElement();
|
||||||
$writer->endElement();
|
$writer->endElement();
|
||||||
|
|
|
||||||
|
|
@ -30,26 +30,29 @@ use SearchDAV\XML\BasicSearch;
|
||||||
use SearchDAV\Backend\SearchPropertyDefinition;
|
use SearchDAV\Backend\SearchPropertyDefinition;
|
||||||
|
|
||||||
class DummyBackend implements ISearchBackend {
|
class DummyBackend implements ISearchBackend {
|
||||||
public function getArbiterPath() {
|
public function getArbiterPath(): string {
|
||||||
return '';
|
return '';
|
||||||
}
|
}
|
||||||
|
|
||||||
public function isValidScope($href, $depth, $path) {
|
public function isValidScope(string $href, $depth, ?string $path): bool {
|
||||||
return true;
|
return true;
|
||||||
}
|
}
|
||||||
|
|
||||||
public function getPropertyDefinitionsForScope($href, $path) {
|
public function getPropertyDefinitionsForScope($href, $path): array {
|
||||||
return [
|
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:}getcontenttype', true, true, true),
|
||||||
new SearchPropertyDefinition('{DAV:}displayname', 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 [
|
return [
|
||||||
new SearchResult(new SimpleFile('foo.txt', 'foobar', 'text/plain'), '/bar/foo.txt')
|
new SearchResult(new SimpleFile('foo.txt', 'foobar', 'text/plain'), '/bar/foo.txt')
|
||||||
];
|
];
|
||||||
}
|
}
|
||||||
|
|
||||||
|
public function preloadPropertyFor(array $nodes, array $requestProperties): void {
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,6 @@ use SearchDAV\XML\Order;
|
||||||
use SearchDAV\XML\Scope;
|
use SearchDAV\XML\Scope;
|
||||||
use SearchDAV\XML\SupportedQueryGrammar;
|
use SearchDAV\XML\SupportedQueryGrammar;
|
||||||
|
|
||||||
|
|
||||||
class QueryParserTest extends TestCase {
|
class QueryParserTest extends TestCase {
|
||||||
public function testParseBasicQuery() {
|
public function testParseBasicQuery() {
|
||||||
$query = file_get_contents(__DIR__ . '/basicquery.xml');
|
$query = file_get_contents(__DIR__ . '/basicquery.xml');
|
||||||
|
|
|
||||||
|
|
@ -180,12 +180,22 @@ class SearchPluginTest extends TestCase {
|
||||||
$this->searchBackend->expects($this->once())
|
$this->searchBackend->expects($this->once())
|
||||||
->method('getPropertyDefinitionsForScope')
|
->method('getPropertyDefinitionsForScope')
|
||||||
->willReturn([
|
->willReturn([
|
||||||
new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true,
|
new SearchPropertyDefinition(
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
|
'{DAV:}getcontentlength',
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
),
|
||||||
new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true),
|
new SearchPropertyDefinition('{DAV:}getcontenttype', true, true, true),
|
||||||
new SearchPropertyDefinition('{DAV:}displayname', true, true, true),
|
new SearchPropertyDefinition('{DAV:}displayname', true, true, true),
|
||||||
new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true,
|
new SearchPropertyDefinition(
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
|
'{http://ns.nextcloud.com:}fileid',
|
||||||
|
false,
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
$plugin->searchHandler($request, $response);
|
$plugin->searchHandler($request, $response);
|
||||||
|
|
@ -274,8 +284,13 @@ class SearchPluginTest extends TestCase {
|
||||||
->method('isValidScope')
|
->method('isValidScope')
|
||||||
->willReturn(true);
|
->willReturn(true);
|
||||||
|
|
||||||
$lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true,
|
$lengthProp = new SearchPropertyDefinition(
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER);
|
'{DAV:}getcontentlength',
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
);
|
||||||
$orderBy = [
|
$orderBy = [
|
||||||
new \SearchDAV\Query\Order($lengthProp, \SearchDAV\Query\Order::ASC),
|
new \SearchDAV\Query\Order($lengthProp, \SearchDAV\Query\Order::ASC),
|
||||||
];
|
];
|
||||||
|
|
@ -347,8 +362,13 @@ class SearchPluginTest extends TestCase {
|
||||||
->method('getArbiterPath')
|
->method('getArbiterPath')
|
||||||
->willReturn('foo');
|
->willReturn('foo');
|
||||||
|
|
||||||
$lengthProp = new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true,
|
$lengthProp = new SearchPropertyDefinition(
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER);
|
'{DAV:}getcontentlength',
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
);
|
||||||
$plugin = new SearchPlugin($this->searchBackend);
|
$plugin = new SearchPlugin($this->searchBackend);
|
||||||
$server = new Server();
|
$server = new Server();
|
||||||
$plugin->initialize($server);
|
$plugin->initialize($server);
|
||||||
|
|
@ -483,8 +503,13 @@ class SearchPluginTest extends TestCase {
|
||||||
$this->searchBackend->expects($this->once())
|
$this->searchBackend->expects($this->once())
|
||||||
->method('getPropertyDefinitionsForScope')
|
->method('getPropertyDefinitionsForScope')
|
||||||
->willReturn([
|
->willReturn([
|
||||||
new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true,
|
new SearchPropertyDefinition(
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
|
'{http://ns.nextcloud.com:}fileid',
|
||||||
|
false,
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
$plugin->searchHandler($request, $response);
|
$plugin->searchHandler($request, $response);
|
||||||
|
|
@ -518,10 +543,20 @@ class SearchPluginTest extends TestCase {
|
||||||
$this->searchBackend->expects($this->any())
|
$this->searchBackend->expects($this->any())
|
||||||
->method('getPropertyDefinitionsForScope')
|
->method('getPropertyDefinitionsForScope')
|
||||||
->willReturn([
|
->willReturn([
|
||||||
new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true,
|
new SearchPropertyDefinition(
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
|
'{http://ns.nextcloud.com:}fileid',
|
||||||
new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true,
|
false,
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
),
|
||||||
|
new SearchPropertyDefinition(
|
||||||
|
'{DAV:}getcontentlength',
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
$plugin->searchHandler($request, $response);
|
$plugin->searchHandler($request, $response);
|
||||||
|
|
@ -555,15 +590,24 @@ class SearchPluginTest extends TestCase {
|
||||||
$this->searchBackend->expects($this->any())
|
$this->searchBackend->expects($this->any())
|
||||||
->method('getPropertyDefinitionsForScope')
|
->method('getPropertyDefinitionsForScope')
|
||||||
->willReturn([
|
->willReturn([
|
||||||
new SearchPropertyDefinition('{http://ns.nextcloud.com:}fileid', false, true, true,
|
new SearchPropertyDefinition(
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
|
'{http://ns.nextcloud.com:}fileid',
|
||||||
new SearchPropertyDefinition('{DAV:}getcontentlength', true, true, true,
|
false,
|
||||||
SearchPropertyDefinition::DATATYPE_NONNEGATIVE_INTEGER),
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
),
|
||||||
|
new SearchPropertyDefinition(
|
||||||
|
'{DAV:}getcontentlength',
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
true,
|
||||||
|
SearchPropertyDefinition::DATATYPE_NON_NEGATIVE_INTEGER
|
||||||
|
),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
$plugin->searchHandler($request, $response);
|
$plugin->searchHandler($request, $response);
|
||||||
|
|
||||||
$this->assertEquals(400, $response->getStatus());
|
$this->assertEquals(400, $response->getStatus());
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue