1
|
|
|
<?php |
2
|
|
|
namespace ApacheSolrForTypo3\Solr\Domain\Search\Uri; |
3
|
|
|
|
4
|
|
|
/* |
5
|
|
|
* This file is part of the TYPO3 CMS project. |
6
|
|
|
* |
7
|
|
|
* It is free software; you can redistribute it and/or modify it under |
8
|
|
|
* the terms of the GNU General Public License, either version 2 |
9
|
|
|
* of the License, or any later version. |
10
|
|
|
* |
11
|
|
|
* For the full copyright and license information, please read the |
12
|
|
|
* LICENSE.txt file that was distributed with this source code. |
13
|
|
|
* |
14
|
|
|
* The TYPO3 project - inspiring people to share! |
15
|
|
|
*/ |
16
|
|
|
|
17
|
|
|
use ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Grouping\GroupItem; |
18
|
|
|
use ApacheSolrForTypo3\Solr\Domain\Search\SearchRequest; |
19
|
|
|
use ApacheSolrForTypo3\Solr\Utility\ParameterSortingUtility; |
20
|
|
|
use TYPO3\CMS\Core\Utility\GeneralUtility; |
21
|
|
|
use TYPO3\CMS\Extbase\Mvc\Web\Routing\UriBuilder; |
22
|
|
|
|
23
|
|
|
/** |
24
|
|
|
* SearchUriBuilder |
25
|
|
|
* |
26
|
|
|
* Responsibility: |
27
|
|
|
* |
28
|
|
|
* The SearchUriBuilder is responsible to build uris, that are used in the |
29
|
|
|
* searchContext. It can use the previous request with it's persistent |
30
|
|
|
* arguments to build the url for a search sub request. |
31
|
|
|
* |
32
|
|
|
* @author Frans Saris <[email protected]> |
33
|
|
|
* @author Timo Hund <[email protected]> |
34
|
|
|
*/ |
35
|
|
|
class SearchUriBuilder |
36
|
|
|
{ |
37
|
|
|
|
38
|
|
|
/** |
39
|
|
|
* @var UriBuilder |
40
|
|
|
*/ |
41
|
|
|
protected $uriBuilder; |
42
|
|
|
|
43
|
|
|
/** |
44
|
|
|
* @var array |
45
|
|
|
*/ |
46
|
|
|
protected static $preCompiledLinks = []; |
47
|
|
|
|
48
|
|
|
/** |
49
|
|
|
* @var integer |
50
|
|
|
*/ |
51
|
|
|
protected static $hitCount; |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* @var integer |
55
|
|
|
*/ |
56
|
|
|
protected static $missCount; |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* @var array |
60
|
|
|
*/ |
61
|
|
|
protected static $additionalArgumentsCache = []; |
62
|
|
|
|
63
|
|
|
/** |
64
|
|
|
* @param UriBuilder $uriBuilder |
65
|
|
|
*/ |
66
|
|
|
public function injectUriBuilder(UriBuilder $uriBuilder) |
67
|
35 |
|
{ |
68
|
|
|
$this->uriBuilder = $uriBuilder; |
69
|
35 |
|
} |
70
|
35 |
|
|
71
|
|
|
/** |
72
|
|
|
* @param SearchRequest $previousSearchRequest |
73
|
|
|
* @param $facetName |
74
|
|
|
* @param $facetValue |
75
|
|
|
* @return string |
76
|
|
|
*/ |
77
|
|
|
public function getAddFacetValueUri(SearchRequest $previousSearchRequest, $facetName, $facetValue) |
78
|
30 |
|
{ |
79
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
80
|
|
|
->getCopyForSubRequest()->removeAllGroupItemPages()->addFacetValue($facetName, $facetValue) |
81
|
30 |
|
->getAsArray(); |
82
|
30 |
|
|
83
|
|
|
$additionalArguments = $this->getAdditionalArgumentsFromRequestConfiguration($previousSearchRequest); |
84
|
30 |
|
$additionalArguments = is_array($additionalArguments) ? $additionalArguments : []; |
|
|
|
|
85
|
30 |
|
|
86
|
|
|
$arguments = $persistentAndFacetArguments + $additionalArguments; |
87
|
30 |
|
|
88
|
|
|
$this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']); |
89
|
30 |
|
|
90
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
91
|
30 |
|
return $this->buildLinkWithInMemoryCache($pageUid, $arguments); |
92
|
30 |
|
} |
93
|
|
|
|
94
|
|
|
/** |
95
|
|
|
* Removes all other facet values for this name and only set's the passed value for the facet. |
96
|
|
|
* |
97
|
|
|
* @param SearchRequest $previousSearchRequest |
98
|
|
|
* @param $facetName |
99
|
|
|
* @param $facetValue |
100
|
|
|
* @return string |
101
|
|
|
*/ |
102
|
|
|
public function getSetFacetValueUri(SearchRequest $previousSearchRequest, $facetName, $facetValue) |
103
|
1 |
|
{ |
104
|
|
|
$previousSearchRequest = $previousSearchRequest |
105
|
|
|
->getCopyForSubRequest()->removeAllGroupItemPages()->removeAllFacetValuesByName($facetName); |
106
|
1 |
|
|
107
|
|
|
return $this->getAddFacetValueUri($previousSearchRequest, $facetName, $facetValue); |
108
|
1 |
|
} |
109
|
|
|
|
110
|
|
|
/** |
111
|
|
|
* @param SearchRequest $previousSearchRequest |
112
|
|
|
* @param $facetName |
113
|
|
|
* @param $facetValue |
114
|
|
|
* @return string |
115
|
|
|
*/ |
116
|
|
|
public function getRemoveFacetValueUri(SearchRequest $previousSearchRequest, $facetName, $facetValue) |
117
|
4 |
|
{ |
118
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
119
|
|
|
->getCopyForSubRequest()->removeAllGroupItemPages()->removeFacetValue($facetName, $facetValue) |
120
|
4 |
|
->getAsArray(); |
121
|
4 |
|
|
122
|
|
|
$additionalArguments = []; |
123
|
4 |
|
if ($previousSearchRequest->getContextTypoScriptConfiguration()->getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl()) { |
124
|
4 |
|
$additionalArguments = $this->getAdditionalArgumentsFromRequestConfiguration($previousSearchRequest); |
125
|
4 |
|
} |
126
|
|
|
$arguments = $persistentAndFacetArguments + $additionalArguments; |
127
|
4 |
|
|
128
|
|
|
$this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']); |
129
|
4 |
|
|
130
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
131
|
4 |
|
return $this->buildLinkWithInMemoryCache($pageUid, $arguments); |
132
|
4 |
|
} |
133
|
|
|
|
134
|
|
|
/** |
135
|
|
|
* @param SearchRequest $previousSearchRequest |
136
|
|
|
* @param $facetName |
137
|
|
|
* @return string |
138
|
|
|
*/ |
139
|
|
|
public function getRemoveFacetUri(SearchRequest $previousSearchRequest, $facetName) |
140
|
|
|
{ |
141
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
142
|
|
|
->getCopyForSubRequest()->removeAllGroupItemPages()->removeAllFacetValuesByName($facetName) |
143
|
|
|
->getAsArray(); |
144
|
|
|
|
145
|
|
|
$additionalArguments = []; |
146
|
|
|
if ($previousSearchRequest->getContextTypoScriptConfiguration()->getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl()) { |
147
|
|
|
$additionalArguments = $this->getAdditionalArgumentsFromRequestConfiguration($previousSearchRequest); |
148
|
|
|
} |
149
|
|
|
|
150
|
|
|
$arguments = $persistentAndFacetArguments + $additionalArguments; |
151
|
|
|
|
152
|
|
|
$this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']); |
153
|
|
|
|
154
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
155
|
|
|
return $this->buildLinkWithInMemoryCache($pageUid, $arguments); |
156
|
|
|
} |
157
|
|
|
|
158
|
|
|
/** |
159
|
|
|
* @param SearchRequest $previousSearchRequest |
160
|
|
|
* @return string |
161
|
|
|
*/ |
162
|
|
|
public function getRemoveAllFacetsUri(SearchRequest $previousSearchRequest) |
163
|
4 |
|
{ |
164
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
165
|
|
|
->getCopyForSubRequest()->removeAllGroupItemPages()->removeAllFacets() |
166
|
4 |
|
->getAsArray(); |
167
|
4 |
|
|
168
|
|
|
$additionalArguments = []; |
169
|
4 |
|
if ($previousSearchRequest->getContextTypoScriptConfiguration()->getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl()) { |
170
|
4 |
|
$additionalArguments = $this->getAdditionalArgumentsFromRequestConfiguration($previousSearchRequest); |
171
|
4 |
|
} |
172
|
|
|
|
173
|
|
|
$arguments = $persistentAndFacetArguments + $additionalArguments; |
174
|
4 |
|
|
175
|
|
|
$this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']); |
176
|
4 |
|
|
177
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
178
|
4 |
|
return $this->buildLinkWithInMemoryCache($pageUid, $arguments); |
179
|
4 |
|
} |
180
|
|
|
|
181
|
|
|
/** |
182
|
|
|
* @param SearchRequest $previousSearchRequest |
183
|
|
|
* @param $page |
184
|
|
|
* @return string |
185
|
|
|
*/ |
186
|
|
|
public function getResultPageUri(SearchRequest $previousSearchRequest, $page) |
187
|
12 |
|
{ |
188
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
189
|
|
|
->getCopyForSubRequest()->setPage($page) |
190
|
12 |
|
->getAsArray(); |
191
|
12 |
|
|
192
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
193
|
12 |
|
return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments); |
194
|
12 |
|
} |
195
|
|
|
|
196
|
|
|
/** |
197
|
|
|
* @param SearchRequest $previousSearchRequest |
198
|
|
|
* @param GroupItem $groupItem |
199
|
|
|
* @param int $page |
200
|
|
|
* @return string |
201
|
|
|
*/ |
202
|
|
|
public function getResultGroupItemPageUri(SearchRequest $previousSearchRequest, GroupItem $groupItem, int $page) |
203
|
|
|
{ |
204
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
205
|
|
|
->getCopyForSubRequest()->setGroupItemPage($groupItem->getGroup()->getGroupName(), $groupItem->getGroupValue(), $page) |
206
|
|
|
->getAsArray(); |
207
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
208
|
|
|
return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments); |
209
|
|
|
} |
210
|
|
|
/** |
211
|
|
|
* @param SearchRequest $previousSearchRequest |
212
|
|
|
* @param $queryString |
213
|
|
|
* @return string |
214
|
|
|
*/ |
215
|
|
|
public function getNewSearchUri(SearchRequest $previousSearchRequest, $queryString) |
216
|
34 |
|
{ |
217
|
|
|
/** @var $request SearchRequest */ |
218
|
|
|
$contextConfiguration = $previousSearchRequest->getContextTypoScriptConfiguration(); |
219
|
34 |
|
$contextSystemLanguage = $previousSearchRequest->getContextSystemLanguageUid(); |
220
|
34 |
|
$contextPageUid = $previousSearchRequest->getContextPageUid(); |
221
|
34 |
|
|
222
|
|
|
$request = GeneralUtility::makeInstance( |
223
|
34 |
|
SearchRequest::class, |
224
|
34 |
|
[], |
225
|
34 |
|
/** @scrutinizer ignore-type */ $contextPageUid, |
226
|
34 |
|
/** @scrutinizer ignore-type */ $contextSystemLanguage, |
227
|
34 |
|
/** @scrutinizer ignore-type */ $contextConfiguration |
228
|
34 |
|
); |
229
|
|
|
$arguments = $request->setRawQueryString($queryString)->getAsArray(); |
230
|
34 |
|
|
231
|
|
|
$this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']); |
232
|
34 |
|
|
233
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
234
|
34 |
|
return $this->buildLinkWithInMemoryCache($pageUid, $arguments); |
235
|
34 |
|
} |
236
|
|
|
|
237
|
|
|
/** |
238
|
|
|
* @param SearchRequest $previousSearchRequest |
239
|
|
|
* @param $sortingName |
240
|
|
|
* @param $sortingDirection |
241
|
|
|
* @return string |
242
|
|
|
*/ |
243
|
|
|
public function getSetSortingUri(SearchRequest $previousSearchRequest, $sortingName, $sortingDirection) |
244
|
32 |
|
{ |
245
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
246
|
|
|
->getCopyForSubRequest()->setSorting($sortingName, $sortingDirection) |
247
|
32 |
|
->getAsArray(); |
248
|
32 |
|
|
249
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
250
|
32 |
|
return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments); |
251
|
32 |
|
} |
252
|
|
|
|
253
|
|
|
/** |
254
|
|
|
* @param SearchRequest $previousSearchRequest |
255
|
|
|
* @return string |
256
|
|
|
*/ |
257
|
|
|
public function getRemoveSortingUri(SearchRequest $previousSearchRequest) |
258
|
32 |
|
{ |
259
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
260
|
|
|
->getCopyForSubRequest()->removeSorting() |
261
|
32 |
|
->getAsArray(); |
262
|
32 |
|
|
263
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
264
|
32 |
|
return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments); |
265
|
32 |
|
} |
266
|
|
|
|
267
|
|
|
/** |
268
|
|
|
* @param SearchRequest $previousSearchRequest |
269
|
|
|
* @return string |
270
|
|
|
*/ |
271
|
|
|
public function getCurrentSearchUri(SearchRequest $previousSearchRequest) |
272
|
28 |
|
{ |
273
|
|
|
$persistentAndFacetArguments = $previousSearchRequest |
274
|
|
|
->getCopyForSubRequest() |
275
|
28 |
|
->getAsArray(); |
276
|
28 |
|
|
277
|
|
|
$pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest); |
278
|
|
|
return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments); |
279
|
28 |
|
} |
280
|
28 |
|
|
281
|
|
|
/** |
282
|
|
|
* @param SearchRequest $request |
283
|
|
|
* @return array |
284
|
|
|
*/ |
285
|
|
|
protected function getAdditionalArgumentsFromRequestConfiguration(SearchRequest $request) |
286
|
|
|
{ |
287
|
31 |
|
if ($request->getContextTypoScriptConfiguration() == null) { |
288
|
|
|
return []; |
289
|
31 |
|
} |
290
|
|
|
|
291
|
|
|
$reQuestId = $request->getId(); |
292
|
|
|
if (isset(self::$additionalArgumentsCache[$reQuestId])) { |
293
|
31 |
|
return self::$additionalArgumentsCache[$reQuestId]; |
294
|
31 |
|
} |
295
|
31 |
|
|
296
|
|
|
self::$additionalArgumentsCache[$reQuestId] = $request->getContextTypoScriptConfiguration() |
297
|
|
|
->getSearchFacetingFacetLinkUrlParametersAsArray(); |
298
|
31 |
|
|
299
|
31 |
|
return self::$additionalArgumentsCache[$reQuestId]; |
300
|
|
|
} |
301
|
31 |
|
|
302
|
|
|
/** |
303
|
|
|
* @param SearchRequest $request |
304
|
|
|
* @return integer|null |
305
|
|
|
*/ |
306
|
|
|
protected function getTargetPageUidFromRequestConfiguration(SearchRequest $request) |
307
|
|
|
{ |
308
|
35 |
|
if ($request->getContextTypoScriptConfiguration() == null) { |
309
|
|
|
return null; |
310
|
35 |
|
} |
311
|
|
|
|
312
|
|
|
return $request->getContextTypoScriptConfiguration()->getSearchTargetPage(); |
313
|
|
|
} |
314
|
35 |
|
|
315
|
|
|
/** |
316
|
|
|
* Build the link with an in memory cache that reduces the amount of required typolink calls. |
317
|
|
|
* |
318
|
|
|
* @param integer $pageUid |
319
|
|
|
* @param array $arguments |
320
|
|
|
* @return string |
321
|
|
|
*/ |
322
|
|
|
protected function buildLinkWithInMemoryCache($pageUid, array $arguments) |
323
|
|
|
{ |
324
|
35 |
|
$hash = md5($pageUid . json_encode($arguments)); |
325
|
|
|
if (isset(self::$preCompiledLinks[$hash])) { |
326
|
35 |
|
self::$hitCount++; |
327
|
35 |
|
$uri = self::$preCompiledLinks[$hash]; |
328
|
35 |
|
} else { |
329
|
35 |
|
self::$missCount++; |
330
|
35 |
|
$uri = $this->uriBuilder |
331
|
33 |
|
->reset() |
332
|
33 |
|
->setTargetPageUid($pageUid) |
333
|
|
|
->setArguments($arguments) |
334
|
35 |
|
->build(); |
335
|
35 |
|
|
336
|
35 |
|
self::$preCompiledLinks[$hash] = (string)$uri; |
337
|
|
|
} |
338
|
|
|
|
339
|
|
|
return $uri; |
340
|
|
|
} |
341
|
|
|
|
342
|
35 |
|
/** |
343
|
35 |
|
* Flushes the internal in memory cache. |
344
|
|
|
* |
345
|
35 |
|
* @return void |
346
|
|
|
*/ |
347
|
|
|
public function flushInMemoryCache() |
348
|
|
|
{ |
349
|
35 |
|
self::$preCompiledLinks = []; |
350
|
35 |
|
} |
351
|
|
|
|
352
|
35 |
|
/** |
353
|
35 |
|
* Sorts filter arguments if enabled. |
354
|
35 |
|
* |
355
|
35 |
|
* |
356
|
|
|
* @param SearchRequest $searchRequest |
357
|
|
|
* @param array|null $filterArguments |
358
|
|
|
*/ |
359
|
|
|
protected function sortFilterParametersIfNecessary(SearchRequest $searchRequest, ?array &$filterArguments) |
360
|
|
|
{ |
361
|
|
|
if (is_array($filterArguments) && !empty($filterArguments) && $searchRequest->isActiveFacetsSorted()) { |
362
|
|
|
ParameterSortingUtility::sortByType( |
363
|
|
|
$filterArguments, |
364
|
|
|
$searchRequest->getActiveFacetsUrlParameterStyle() |
365
|
|
|
); |
366
|
|
|
} |
367
|
|
|
} |
368
|
|
|
} |
369
|
|
|
|