1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2020 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OC\Core\Controller;
use InvalidArgumentException;
use OC\Core\ResponseDefinitions;
use OC\Search\SearchComposer;
use OC\Search\SearchQuery;
use OC\Search\UnsupportedFilter;
use OCP\AppFramework\Http;
use OCP\AppFramework\Http\Attribute\ApiRoute;
use OCP\AppFramework\Http\Attribute\NoAdminRequired;
use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
use OCP\AppFramework\Http\DataResponse;
use OCP\AppFramework\OCSController;
use OCP\IRequest;
use OCP\IURLGenerator;
use OCP\IUserSession;
use OCP\Route\IRouter;
use OCP\Search\ISearchQuery;
use Symfony\Component\Routing\Exception\ResourceNotFoundException;
/**
* @psalm-import-type CoreUnifiedSearchProvider from ResponseDefinitions
* @psalm-import-type CoreUnifiedSearchResult from ResponseDefinitions
*/
class UnifiedSearchController extends OCSController {
public function __construct(
IRequest $request,
private IUserSession $userSession,
private SearchComposer $composer,
private IRouter $router,
private IURLGenerator $urlGenerator,
) {
parent::__construct('core', $request);
}
/**
* Get the providers for unified search
*
* @param string $from the url the user is currently at
* @return DataResponse<Http::STATUS_OK, CoreUnifiedSearchProvider[], array{}>
*
* 200: Providers returned
*/
#[NoAdminRequired]
#[NoCSRFRequired]
#[ApiRoute(verb: 'GET', url: '/providers', root: '/search')]
public function getProviders(string $from = ''): DataResponse {
[$route, $parameters] = $this->getRouteInformation($from);
$result = $this->composer->getProviders($route, $parameters);
$response = new DataResponse($result);
$response->setETag(md5(json_encode($result)));
return $response;
}
/**
* Launch a search for a specific search provider.
*
* Additional filters are available for each provider.
* Send a request to /providers endpoint to list providers with their available filters.
*
* @param string $providerId ID of the provider
* @param string $term Term to search
* @param int|null $sortOrder Order of entries
* @param int|null $limit Maximum amount of entries, limited to 25
* @param int|string|null $cursor Offset for searching
* @param string $from The current user URL
*
* @return DataResponse<Http::STATUS_OK, CoreUnifiedSearchResult, array{}>|DataResponse<Http::STATUS_BAD_REQUEST, string, array{}>
*
* 200: Search entries returned
* 400: Searching is not possible
*/
#[NoAdminRequired]
#[NoCSRFRequired]
#[ApiRoute(verb: 'GET', url: '/providers/{providerId}/search', root: '/search')]
public function search(
string $providerId,
// Unused parameter for OpenAPI spec generator
string $term = '',
?int $sortOrder = null,
?int $limit = null,
$cursor = null,
string $from = '',
): DataResponse {
[$route, $routeParameters] = $this->getRouteInformation($from);
$limit ??= SearchQuery::LIMIT_DEFAULT;
$limit = max(1, min($limit, 25));
try {
$filters = $this->composer->buildFilterList($providerId, $this->request->getParams());
} catch (UnsupportedFilter|InvalidArgumentException $e) {
return new DataResponse($e->getMessage(), Http::STATUS_BAD_REQUEST);
}
return new DataResponse(
$this->composer->search(
$this->userSession->getUser(),
$providerId,
new SearchQuery(
$filters,
$sortOrder ?? ISearchQuery::SORT_DATE_DESC,
$limit,
$cursor,
$route,
$routeParameters
)
)->jsonSerialize()
);
}
protected function getRouteInformation(string $url): array {
$routeStr = '';
$parameters = [];
if ($url !== '') {
$urlParts = parse_url($url);
$urlPath = $urlParts['path'];
// Optionally strip webroot from URL. Required for route matching on setups
// with Nextcloud in a webserver subfolder (webroot).
$webroot = $this->urlGenerator->getWebroot();
if ($webroot !== '' && substr($urlPath, 0, strlen($webroot)) === $webroot) {
$urlPath = substr($urlPath, strlen($webroot));
}
try {
$parameters = $this->router->findMatchingRoute($urlPath);
// contacts.PageController.index => contacts.Page.index
$route = $parameters['caller'];
if (substr($route[1], -10) === 'Controller') {
$route[1] = substr($route[1], 0, -10);
}
$routeStr = implode('.', $route);
// cleanup
unset($parameters['_route'], $parameters['action'], $parameters['caller']);
} catch (ResourceNotFoundException $exception) {
}
if (isset($urlParts['query'])) {
parse_str($urlParts['query'], $queryParameters);
$parameters = array_merge($parameters, $queryParameters);
}
}
return [
$routeStr,
$parameters,
];
}
}
|
