Passed
Pull Request — master (#2972)
by
unknown
36:56
created

SearchUriBuilder::getSubstitution()   A

Complexity

Conditions 3
Paths 3

Size

Total Lines 10
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 8
CRAP Score 3.072

Importance

Changes 0
Metric Value
eloc 8
dl 0
loc 10
ccs 8
cts 10
cp 0.8
rs 10
c 0
b 0
f 0
cc 3
nc 3
nop 3
crap 3.072
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 8
    public function injectUriBuilder(UriBuilder $uriBuilder)
67
    {
68 8
        $this->uriBuilder = $uriBuilder;
69 8
    }
70
71
    /**
72
     * @param SearchRequest $previousSearchRequest
73
     * @param $facetName
74
     * @param $facetValue
75
     * @return string
76
     */
77 4
    public function getAddFacetValueUri(SearchRequest $previousSearchRequest, $facetName, $facetValue)
78
    {
79
        $persistentAndFacetArguments = $previousSearchRequest
80 4
        ->getCopyForSubRequest()->removeAllGroupItemPages()->addFacetValue($facetName, $facetValue)
81 4
        ->getAsArray();
82
83 4
        $additionalArguments = $this->getAdditionalArgumentsFromRequestConfiguration($previousSearchRequest);
84 4
        $additionalArguments = is_array($additionalArguments) ? $additionalArguments : [];
0 ignored issues
show
introduced by
The condition is_array($additionalArguments) is always true.
Loading history...
85
86 4
        $arguments = $persistentAndFacetArguments + $additionalArguments;
87
88 4
        $this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']);
89
90 4
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
91 4
        return $this->buildLinkWithInMemoryCache($pageUid, $arguments);
92
    }
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
    {
104
        $previousSearchRequest = $previousSearchRequest
105
        ->getCopyForSubRequest()->removeAllGroupItemPages()->removeAllFacetValuesByName($facetName);
106
107
        return $this->getAddFacetValueUri($previousSearchRequest, $facetName, $facetValue);
108
    }
109
110
    /**
111
     * @param SearchRequest $previousSearchRequest
112
     * @param $facetName
113
     * @param $facetValue
114
     * @return string
115
     */
116 1
    public function getRemoveFacetValueUri(SearchRequest $previousSearchRequest, $facetName, $facetValue)
117
    {
118
        $persistentAndFacetArguments = $previousSearchRequest
119 1
        ->getCopyForSubRequest()->removeAllGroupItemPages()->removeFacetValue($facetName, $facetValue)
120 1
        ->getAsArray();
121
122 1
        $additionalArguments = [];
123 1
        if ($previousSearchRequest->getContextTypoScriptConfiguration()->getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl()) {
124
            $additionalArguments = $this->getAdditionalArgumentsFromRequestConfiguration($previousSearchRequest);
125
        }
126 1
        $arguments = $persistentAndFacetArguments + $additionalArguments;
127
128 1
        $this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']);
129
130 1
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
131 1
        return $this->buildLinkWithInMemoryCache($pageUid, $arguments);
132
    }
133
134
    /**
135
     * @param SearchRequest $previousSearchRequest
136
     * @param $facetName
137
     * @return string
138
     */
139 1
    public function getRemoveFacetUri(SearchRequest $previousSearchRequest, $facetName)
140
    {
141
        $persistentAndFacetArguments = $previousSearchRequest
142 1
        ->getCopyForSubRequest()->removeAllGroupItemPages()->removeAllFacetValuesByName($facetName)
143 1
        ->getAsArray();
144
145 1
        $additionalArguments = [];
146 1
        if ($previousSearchRequest->getContextTypoScriptConfiguration()->getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl()) {
147
            $additionalArguments = $this->getAdditionalArgumentsFromRequestConfiguration($previousSearchRequest);
148
        }
149
150 1
        $arguments = $persistentAndFacetArguments + $additionalArguments;
151
152 1
        $this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']);
153
154 1
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
155 1
        return $this->buildLinkWithInMemoryCache($pageUid, $arguments);
156
    }
157
158
    /**
159
     * @param SearchRequest $previousSearchRequest
160
     * @return string
161
     */
162
    public function getRemoveAllFacetsUri(SearchRequest $previousSearchRequest)
163
    {
164
        $persistentAndFacetArguments = $previousSearchRequest
165
        ->getCopyForSubRequest()->removeAllGroupItemPages()->removeAllFacets()
166
        ->getAsArray();
167
168
        $additionalArguments = [];
169
        if ($previousSearchRequest->getContextTypoScriptConfiguration()->getSearchFacetingFacetLinkUrlParametersUseForFacetResetLinkUrl()) {
170
            $additionalArguments = $this->getAdditionalArgumentsFromRequestConfiguration($previousSearchRequest);
171
        }
172
173
        $arguments = $persistentAndFacetArguments + $additionalArguments;
174
175
        $this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']);
176
177
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
178
        return $this->buildLinkWithInMemoryCache($pageUid, $arguments);
179
    }
180
181
    /**
182
     * @param SearchRequest $previousSearchRequest
183
     * @param $page
184
     * @return string
185
     */
186
    public function getResultPageUri(SearchRequest $previousSearchRequest, $page)
187
    {
188
        $persistentAndFacetArguments = $previousSearchRequest
189
        ->getCopyForSubRequest()->setPage($page)
190
        ->getAsArray();
191
192
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
193
        return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments);
194
    }
195
196
    /**
197
     * @param SearchRequest $previousSearchRequest
198
     * @param GroupItem $groupItem
199
     * @param int $page
200
     * @return string
201
     */
202 1
    public function getResultGroupItemPageUri(SearchRequest $previousSearchRequest, GroupItem $groupItem, int $page)
203
    {
204
        $persistentAndFacetArguments = $previousSearchRequest
205 1
        ->getCopyForSubRequest()->setGroupItemPage($groupItem->getGroup()->getGroupName(), $groupItem->getGroupValue(), $page)
206 1
        ->getAsArray();
207 1
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
208 1
        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
    {
217
        /** @var $request SearchRequest */
218
        $contextConfiguration = $previousSearchRequest->getContextTypoScriptConfiguration();
219
        $contextSystemLanguage = $previousSearchRequest->getContextSystemLanguageUid();
220
        $contextPageUid = $previousSearchRequest->getContextPageUid();
221
222
        $request = GeneralUtility::makeInstance(
223
            SearchRequest::class,
224
            [],
225
            /** @scrutinizer ignore-type */ $contextPageUid,
226
            /** @scrutinizer ignore-type */ $contextSystemLanguage,
227
            /** @scrutinizer ignore-type */ $contextConfiguration
228
            );
229
        $arguments = $request->setRawQueryString($queryString)->getAsArray();
230
231
        $this->sortFilterParametersIfNecessary($previousSearchRequest, $arguments['tx_solr']['filter']);
232
233
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
234
        return $this->buildLinkWithInMemoryCache($pageUid, $arguments);
235
    }
236
237
    /**
238
     * @param SearchRequest $previousSearchRequest
239
     * @param $sortingName
240
     * @param $sortingDirection
241
     * @return string
242
     */
243 1
    public function getSetSortingUri(SearchRequest $previousSearchRequest, $sortingName, $sortingDirection)
244
    {
245
        $persistentAndFacetArguments = $previousSearchRequest
246 1
        ->getCopyForSubRequest()->setSorting($sortingName, $sortingDirection)
247 1
        ->getAsArray();
248
249 1
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
250 1
        return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments);
251
    }
252
253
    /**
254
     * @param SearchRequest $previousSearchRequest
255
     * @return string
256
     */
257
    public function getRemoveSortingUri(SearchRequest $previousSearchRequest)
258
    {
259
        $persistentAndFacetArguments = $previousSearchRequest
260
        ->getCopyForSubRequest()->removeSorting()
261
        ->getAsArray();
262
263
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
264
        return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments);
265
    }
266
267
    /**
268
     * @param SearchRequest $previousSearchRequest
269
     * @return string
270
     */
271
    public function getCurrentSearchUri(SearchRequest $previousSearchRequest)
272
    {
273
        $persistentAndFacetArguments = $previousSearchRequest
274
        ->getCopyForSubRequest()
275
        ->getAsArray();
276
277
278
        $pageUid = $this->getTargetPageUidFromRequestConfiguration($previousSearchRequest);
279
        return $this->buildLinkWithInMemoryCache($pageUid, $persistentAndFacetArguments);
280
    }
281
282
    /**
283
     * @param SearchRequest $request
284
     * @return array
285
     */
286 4
    protected function getAdditionalArgumentsFromRequestConfiguration(SearchRequest $request)
287
    {
288 4
        if ($request->getContextTypoScriptConfiguration() == null) {
289
            return [];
290
        }
291
292 4
        $reQuestId = $request->getId();
293 4
        if (isset(self::$additionalArgumentsCache[$reQuestId])) {
294 1
            return self::$additionalArgumentsCache[$reQuestId];
295
        }
296
297 4
        self::$additionalArgumentsCache[$reQuestId] = $request->getContextTypoScriptConfiguration()
298 4
        ->getSearchFacetingFacetLinkUrlParametersAsArray();
299
300 4
        return self::$additionalArgumentsCache[$reQuestId];
301
    }
302
303
    /**
304
     * @param SearchRequest $request
305
     * @return integer|null
306
     */
307 8
    protected function getTargetPageUidFromRequestConfiguration(SearchRequest $request)
308
    {
309 8
        if ($request->getContextTypoScriptConfiguration() == null) {
310
            return null;
311
        }
312
313 8
        return $request->getContextTypoScriptConfiguration()->getSearchTargetPage();
314
    }
315
316
    /**
317
     * Build the link with an in memory cache that reduces the amount of required typolink calls.
318
     *
319
     * @param integer $pageUid
320
     * @param array $arguments
321
     * @return string
322
     */
323 8
    protected function buildLinkWithInMemoryCache($pageUid, array $arguments)
324
    {
325 8
        $hash = md5($pageUid . json_encode($arguments));
326 8
        if (isset(self::$preCompiledLinks[$hash])) {
327 1
            self::$hitCount++;
328 1
            $uri = self::$preCompiledLinks[$hash];
329
        } else {
330 8
            self::$missCount++;
331 8
            $uri = $this->uriBuilder
332 8
            ->reset()
333 8
            ->setTargetPageUid($pageUid)
334 8
            ->setArguments($arguments)
335 8
            ->build();
336
337 8
            self::$preCompiledLinks[$hash] = (string)$uri;
338
        }
339
340 8
        return $uri;
341
    }
342
343
    /**
344
     * Flushes the internal in memory cache.
345
     *
346
     * @return void
347
     */
348 8
    public function flushInMemoryCache()
349
    {
350 8
        self::$preCompiledLinks = [];
351 8
    }
352
353
    /**
354
     * Sorts filter arguments if enabled.
355
     *
356
     *
357
     * @param SearchRequest $searchRequest
358
     * @param array|null $filterArguments
359
     */
360 6
    protected function sortFilterParametersIfNecessary(SearchRequest $searchRequest, ?array &$filterArguments)
361
    {
362 6
        if (is_array($filterArguments) && !empty($filterArguments) && $searchRequest->isActiveFacetsSorted()) {
363
            ParameterSortingUtility::sortByType(
364
                $filterArguments,
365
                $searchRequest->getActiveFacetsUrlParameterStyle()
366
                );
367
        }
368 6
    }
369
}
370