-
-
Notifications
You must be signed in to change notification settings - Fork 243
/
RoutingService.php
1128 lines (1006 loc) · 33.4 KB
/
RoutingService.php
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
declare(strict_types=1);
/*
* This file is part of the TYPO3 CMS project.
*
* It is free software; you can redistribute it and/or modify it under
* the terms of the GNU General Public License, either version 2
* of the License, or any later version.
*
* For the full copyright and license information, please read the
* LICENSE.txt file that was distributed with this source code.
*
* The TYPO3 project - inspiring people to share!
*/
namespace ApacheSolrForTypo3\Solr\Routing;
use ApacheSolrForTypo3\Solr\Routing\Enhancer\SolrRouteEnhancerInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\UriInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use TYPO3\CMS\Core\Context\Context;
use TYPO3\CMS\Core\Exception\SiteNotFoundException;
use TYPO3\CMS\Core\Http\Uri;
use TYPO3\CMS\Core\Routing\PageSlugCandidateProvider;
use TYPO3\CMS\Core\Routing\SiteMatcher;
use TYPO3\CMS\Core\Site\Entity\NullSite;
use TYPO3\CMS\Core\Site\Entity\Site;
use TYPO3\CMS\Core\Site\Entity\SiteInterface;
use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
use TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\CMS\Core\Utility\GeneralUtility;
/**
* This service class bundles method required to process and manipulate routes.
*
* @author Lars Tode <lars.tode@dkd.de>
*/
class RoutingService implements LoggerAwareInterface
{
use LoggerAwareTrait;
/**
* Default plugin namespace
*/
const PLUGIN_NAMESPACE = 'tx_solr';
/**
* Settings from routing configuration
*
* @var array
*/
protected $settings = [];
/**
* List of filter that are placed as path arguments
*
* @var array
*/
protected $pathArguments = [];
/**
* Plugin/extension namespace
*
* @var string
*/
protected $pluginNamespace = 'tx_solr';
/**
* List of TYPO3 core parameters, that we should ignore
*
* @see \TYPO3\CMS\Frontend\Page\CacheHashCalculator::isCoreParameter
* @var string[]
*/
protected $coreParameters = ['no_cache', 'cHash', 'id', 'MP', 'type'];
/**
* @var UrlFacetService
*/
protected $urlFacetPathService;
/**
* @var UrlFacetService
*/
protected $urlFacetQueryService;
/**
* RoutingService constructor.
*
* @param array $settings
* @param string $pluginNamespace
*/
public function __construct(array $settings = [], string $pluginNamespace = self::PLUGIN_NAMESPACE)
{
$this->settings = $settings;
$this->pluginNamespace = $pluginNamespace;
if (empty($this->pluginNamespace)) {
$this->pluginNamespace = self::PLUGIN_NAMESPACE;
}
$this->initUrlFacetService();
}
/**
* Creates a clone of the current service and replace the settings inside
*
* @param array $settings
* @return RoutingService
*/
public function withSettings(array $settings): RoutingService
{
$service = clone $this;
$service->settings = $settings;
$service->initUrlFacetService();
return $service;
}
/**
* Creates a clone of the current service and replace the settings inside
*
* @param array $pathArguments
* @return RoutingService
*/
public function withPathArguments(array $pathArguments): RoutingService
{
$service = clone $this;
$service->pathArguments = $pathArguments;
$service->initUrlFacetService();
return $service;
}
/**
* Load configuration from routing configuration
*
* @param array $routingConfiguration
* @return $this
*/
public function fromRoutingConfiguration(array $routingConfiguration): RoutingService
{
if (empty($routingConfiguration) ||
empty($routingConfiguration['type']) ||
!$this->isRouteEnhancerForSolr((string)$routingConfiguration['type'])) {
return $this;
}
if (isset($routingConfiguration['solr'])) {
$this->settings = $routingConfiguration['solr'];
$this->initUrlFacetService();
}
if (isset($routingConfiguration['_arguments'])) {
$this->pathArguments = $routingConfiguration['_arguments'];
}
return $this;
}
/**
* Reset the routing service
*
* @return $this
*/
public function reset(): RoutingService
{
$this->settings = [];
$this->pathArguments = [];
$this->pluginNamespace = self::PLUGIN_NAMESPACE;
return $this;
}
/**
* Initialize url facet services for different types
*
* @return $this
*/
protected function initUrlFacetService(): RoutingService
{
$this->urlFacetPathService = new UrlFacetService('path', $this->settings);
$this->urlFacetQueryService = new UrlFacetService('query', $this->settings);
return $this;
}
/**
* @return UrlFacetService
*/
public function getUrlFacetPathService(): UrlFacetService
{
return $this->urlFacetPathService;
}
/**
* @return UrlFacetService
*/
public function getUrlFacetQueryService(): UrlFacetService
{
return $this->urlFacetQueryService;
}
/**
* Test if the given parameter is a Core parameter
*
* @see \TYPO3\CMS\Frontend\Page\CacheHashCalculator::isCoreParameter
* @param string $parameterName
* @return bool
*/
public function isCoreParameter(string $parameterName): bool
{
return in_array($parameterName, $this->coreParameters);
}
/**
* This returns the plugin namespace
* @see https://docs.typo3.org/p/apache-solr-for-typo3/solr/main/en-us/Configuration/Reference/TxSolrView.html#pluginnamespace
*
* @return string
*/
public function getPluginNamespace(): string
{
return $this->pluginNamespace;
}
/**
* Determine if an enhancer is in use for Solr
*
* @param string $enhancerName
* @return bool
*/
public function isRouteEnhancerForSolr(string $enhancerName): bool
{
if (empty($enhancerName)) {
return false;
}
if (!isset($GLOBALS['TYPO3_CONF_VARS']['SYS']['routing']['enhancers'][$enhancerName])) {
return false;
}
$className = $GLOBALS['TYPO3_CONF_VARS']['SYS']['routing']['enhancers'][$enhancerName];
if (!class_exists($className)) {
return false;
}
$interfaces = class_implements($className);
return in_array(SolrRouteEnhancerInterface::class, $interfaces);
}
/**
* Masks Solr filter inside of the query parameters
*
* @param string $uriPath
* @return string
*/
public function finalizePathQuery(string $uriPath): string
{
$pathSegments = explode('/', $uriPath);
$query = array_pop($pathSegments);
$queryValues = explode($this->urlFacetPathService->getMultiValueSeparator(), $query);
$queryValues = array_map([$this->urlFacetPathService, 'decodeSingleValue'], $queryValues);
/*
* In some constellations the path query contains the facet type in front.
* This leads to the result, that the query values could contain the same facet value multiple times.
*
* In order to avoid this behaviour, the query values need to be checked and clean up.
* 1. Remove possible prefix information
* 2. Apply character replacements
* 3. Filter duplicate values
*/
$queryValuesCount = count($queryValues);
for ($i = 0; $i < $queryValuesCount; $i++) {
$queryValues[$i] = urldecode($queryValues[$i]);
if ($this->containsFacetAndValueSeparator((string)$queryValues[$i])) {
[$facetName, $facetValue] = explode(
$this->detectFacetAndValueSeparator((string)$queryValues[$i]),
(string)$queryValues[$i],
2
);
if ($this->isPathArgument((string)$facetName)) {
$queryValues[$i] = $facetValue;
}
}
$queryValues[$i] = $this->urlFacetPathService->applyCharacterMap($queryValues[$i]);
}
$queryValues = array_unique($queryValues);
$queryValues = array_map([$this->urlFacetPathService, 'encodeSingleValue'], $queryValues);
sort($queryValues);
$pathSegments[] = implode(
$this->urlFacetPathService->getMultiValueSeparator(),
$queryValues
);
return implode('/', $pathSegments);
}
/**
* This method checks if the query parameter should be masked.
*
* @return bool
*/
public function shouldMaskQueryParameter(): bool
{
if (!isset($this->settings['query']['mask']) ||
!(bool)$this->settings['query']['mask']) {
return false;
}
$targetFields = $this->getQueryParameterMap();
return !empty($targetFields);
}
/**
* Masks Solr filter inside of the query parameters
*
* @param array $queryParams
* @return array
*/
public function maskQueryParameters(array $queryParams): array
{
if (!$this->shouldMaskQueryParameter()) {
return $queryParams;
}
if (!isset($queryParams[$this->getPluginNamespace()])) {
$this->logger
->/** @scrutinizer ignore-call */
error('Mask error: Query parameters has no entry for namespace ' . $this->getPluginNamespace());
return $queryParams;
}
if (!isset($queryParams[$this->getPluginNamespace()]['filter'])) {
$this->logger
->/** @scrutinizer ignore-call */
info('Mask info: Query parameters has no filter in namespace ' . $this->getPluginNamespace());
return $queryParams;
}
$queryParameterMap = $this->getQueryParameterMap();
$newQueryParams = $queryParams;
$newFilterArray = [];
foreach ($newQueryParams[$this->getPluginNamespace()]['filter'] as $queryParamName => $queryParamValue) {
$defaultSeparator = $this->detectFacetAndValueSeparator((string)$queryParamValue);
[$facetName, $facetValue] = explode($defaultSeparator, $queryParamValue, 2);
$keep = false;
if (isset($queryParameterMap[$facetName]) &&
isset($newQueryParams[$queryParameterMap[$facetName]])) {
$this->logger->/** @scrutinizer ignore-call */error(
'Mask error: Facet "' . $facetName . '" as "' . $queryParameterMap[$facetName] .
'" already in query!'
);
$keep = true;
}
if (!isset($queryParameterMap[$facetName]) || $keep) {
$newFilterArray[] = $queryParamValue;
continue;
}
$newQueryParams[$queryParameterMap[$facetName]] = $facetValue;
}
$newQueryParams[$this->getPluginNamespace()]['filter'] = $newFilterArray;
return $this->cleanUpQueryParameters($newQueryParams);
}
/**
* Unmask incoming parameters if needed
*
* @param array $queryParams
* @return array
*/
public function unmaskQueryParameters(array $queryParams): array
{
if (!$this->shouldMaskQueryParameter()) {
return $queryParams;
}
/*
* The array $queryParameterMap contains the mapping of
* facet name to new url name. In order to unmask we need to switch key and values.
*/
$queryParameterMap = $this->getQueryParameterMap();
$queryParameterMapSwitched = [];
foreach ($queryParameterMap as $value => $key) {
$queryParameterMapSwitched[$key] = $value;
}
$newQueryParams = [];
foreach ($queryParams as $queryParamName => $queryParamValue) {
// A merge is needed!
if (!isset($queryParameterMapSwitched[$queryParamName])) {
if (isset($newQueryParams[$queryParamName])) {
$newQueryParams[$queryParamName] = array_merge_recursive(
$newQueryParams[$queryParamName],
$queryParamValue
);
} else {
$newQueryParams[$queryParamName] = $queryParamValue;
}
continue;
}
if (!isset($newQueryParams[$this->getPluginNamespace()])) {
$newQueryParams[$this->getPluginNamespace()] = [];
}
if (!isset($newQueryParams[$this->getPluginNamespace()]['filter'])) {
$newQueryParams[$this->getPluginNamespace()]['filter'] = [];
}
$newQueryParams[$this->getPluginNamespace()]['filter'][] =
$queryParameterMapSwitched[$queryParamName] . ':' . $queryParamValue;
}
return $this->cleanUpQueryParameters($newQueryParams);
}
/**
* This method check if the query parameters should be touched or not.
*
* There are following requirements:
* - Masking is activated and the mal is valid or
* - Concat is activated
*
* @return bool
*/
public function shouldConcatQueryParameters(): bool
{
/*
* The concat will activate automatically if parameters should be masked.
* This solution is less complex since not every mapping parameter needs to be tested
*/
if ($this->shouldMaskQueryParameter()) {
return true;
}
return isset($this->settings['query']['concat']) && (bool)$this->settings['query']['concat'];
}
/**
* Returns the query parameter map
*
* Note TYPO3 core query arguments removed from the configured map!
*
* @return array
*/
public function getQueryParameterMap(): array
{
if (!isset($this->settings['query']['map']) ||
!is_array($this->settings['query']['map']) ||
empty($this->settings['query']['map'])) {
return [];
}
// TODO: Test if there is more than one value!
$self = $this;
return array_filter(
$this->settings['query']['map'],
function($value) use ($self) {
return !$self->isCoreParameter($value);
}
);
}
/**
* Group all filter values together and concat e
* Note: this will just handle filter values
*
* IN:
* tx_solr => [
* filter => [
* color:red
* product:candy
* color:blue
* taste:sour
* ]
* ]
*
* OUT:
* tx_solr => [
* filter => [
* color:blue,red
* product:candy
* taste:sour
* ]
* ]
* @param array $queryParams
* @return array
*/
public function concatQueryParameter(array $queryParams = []): array
{
if (!$this->shouldConcatQueryParameters()) {
return $queryParams;
}
if (!isset($queryParams[$this->getPluginNamespace()])) {
$this->logger
->error('Mask error: Query parameters has no entry for namespace ' . $this->getPluginNamespace());
return $queryParams;
}
if (!isset($queryParams[$this->getPluginNamespace()]['filter'])) {
$this->logger
->info('Mask info: Query parameters has no filter in namespace ' . $this->getPluginNamespace());
return $queryParams;
}
$queryParams[$this->getPluginNamespace()]['filter'] =
$this->concatFilterValues($queryParams[$this->getPluginNamespace()]['filter']);
return $this->cleanUpQueryParameters($queryParams);
}
/**
* This method expect a filter array that should be concat instead of the whole query
*
* @param array $filterArray
* @return array
*/
public function concatFilterValues(array $filterArray): array
{
if (empty($filterArray) || !$this->shouldConcatQueryParameters()) {
return $filterArray;
}
$queryParameterMap = $this->getQueryParameterMap();
$newFilterArray = [];
$defaultSeparator = $this->detectFacetAndValueSeparator((string)$filterArray[0]);
// Collect parameter names and rename parameter if required
foreach ($filterArray as $set) {
$separator = $this->detectFacetAndValueSeparator((string)$set);
[$facetName, $facetValue] = explode($separator, $set, 2);
if (isset($queryParameterMap[$facetName])) {
$facetName = $queryParameterMap[$facetName];
}
if (!isset($newFilterArray[$facetName])) {
$newFilterArray[$facetName] = [$facetValue];
} else {
$newFilterArray[$facetName][] = $facetValue;
}
}
foreach ($newFilterArray as $facetName => $facetValues) {
$newFilterArray[$facetName] = $facetName . $defaultSeparator . $this->queryParameterFacetsToString($facetValues);
}
return array_values($newFilterArray);
}
/**
* Inflate given query parameters if configured
* Note: this will just combine filter values
*
* IN:
* tx_solr => [
* filter => [
* color:blue,red
* product:candy
* taste:sour
* ]
* ]
*
* OUT:
* tx_solr => [
* filter => [
* color:red
* product:candy
* color:blue
* taste:sour
* ]
* ]
*
* @param array $queryParams
* @return array
*/
public function inflateQueryParameter(array $queryParams = []): array
{
if (!$this->shouldConcatQueryParameters()) {
return $queryParams;
}
if (!isset($queryParams[$this->getPluginNamespace()])) {
$queryParams[$this->getPluginNamespace()] = [];
}
if (!isset($queryParams[$this->getPluginNamespace()]['filter'])) {
$queryParams[$this->getPluginNamespace()]['filter'] = [];
}
$newQueryParams = [];
foreach ($queryParams[$this->getPluginNamespace()]['filter'] as $set) {
$separator = $this->detectFacetAndValueSeparator((string)$set);
[$facetName, $facetValuesString] = explode($separator, $set, 2);
$facetValues = explode($this->urlFacetQueryService->getMultiValueSeparator(), $facetValuesString);
/**
* A facet value could contain the multi value separator. This value is masked in order to
* avoid problems during separation of the values (line above).
*
* After splitting the values, the character inside the value need to be restored
*
* @see RoutingService::queryParameterFacetsToString
*/
$facetValues = array_map([$this->urlFacetQueryService, 'decodeSingleValue'], $facetValues);
foreach ($facetValues as $facetValue) {
$newQueryParams[] = $facetName . $separator . $facetValue;
}
}
$queryParams[$this->getPluginNamespace()]['filter'] = array_values($newQueryParams);
return $this->cleanUpQueryParameters($queryParams);
}
/**
* Cleanup the query parameters, to avoid empty solr arguments
*
* @param array $queryParams
* @return array
*/
public function cleanUpQueryParameters(array $queryParams): array
{
if (empty($queryParams[$this->getPluginNamespace()]['filter'])) {
unset($queryParams[$this->getPluginNamespace()]['filter']);
}
if (empty($queryParams[$this->getPluginNamespace()])) {
unset($queryParams[$this->getPluginNamespace()]);
}
return $queryParams;
}
/**
* Builds a string out of multiple facet values
*
* A facet value could contain the multi value separator. This value have to masked in order to
* avoid problems during separation of the values later.
*
* This mask have to apply before contact the values
*
* @param array $facets
* @return string
*/
public function queryParameterFacetsToString(array $facets): string
{
$facets = array_map([$this->urlFacetQueryService, 'encodeSingleValue'], $facets);
sort($facets);
return implode($this->urlFacetQueryService->getMultiValueSeparator(), $facets);
}
/**
* Returns the string which separates the facet from the value
*
* @param string $facetWithValue
* @return string
*/
public function detectFacetAndValueSeparator(string $facetWithValue): string
{
$separator = ':';
if (mb_strpos($facetWithValue, '%3A') !== false) {
$separator = '%3A';
}
return $separator;
}
/**
* Check if given facet value combination contains a separator
*
* @param string $facetWithValue
* @return bool
*/
public function containsFacetAndValueSeparator(string $facetWithValue): bool
{
if (mb_strpos($facetWithValue, ':') === false && mb_strpos($facetWithValue, '%3A') === false) {
return false;
}
return true;
}
/**
* Cleanup facet values (strip type if needed)
*
* @param array $facetValues
* @return array
*/
public function cleanupFacetValues(array $facetValues): array
{
$facetValuesCount = count($facetValues);
for ($i = 0; $i < $facetValuesCount; $i++) {
if (!$this->containsFacetAndValueSeparator((string)$facetValues[$i])) {
continue;
}
$separator = $this->detectFacetAndValueSeparator((string)$facetValues[$i]);
[$type, $value] = explode($separator, $facetValues[$i]);
if ($this->isMappingArgument($type) || $this->isPathArgument($type)) {
$facetValues[$i] = $value;
}
}
return $facetValues;
}
/**
* Builds a string out of multiple facet values
*
* @param array $facets
* @return string
*/
public function pathFacetsToString(array $facets): string
{
$facets = $this->cleanupFacetValues($facets);
sort($facets);
$facets = array_map([$this->urlFacetPathService, 'applyCharacterMap'], $facets);
$facets = array_map([$this->urlFacetPathService, 'encodeSingleValue'], $facets);
return implode($this->urlFacetPathService->getMultiValueSeparator(), $facets);
}
/**
* Builds a string out of multiple facet values
*
* @param array $facets
* @return string
*/
public function facetsToString(array $facets): string
{
$facets = $this->cleanupFacetValues($facets);
sort($facets);
return implode($this->getDefaultMultiValueSeparator(), $facets);
}
/**
* Builds a string out of multiple facet values
*
* This method is used in two different situation
* 1. Middleware: Here the values should not be decoded
* 2. Within the event listener CachedPathVariableModifier
*
* @param string $facets
* @param bool $decode
* @return array
*/
public function pathFacetStringToArray(string $facets, bool $decode = true): array
{
$facetString = $this->urlFacetPathService->applyCharacterMap($facets);
$facets = explode($this->urlFacetPathService->getMultiValueSeparator(), $facetString);
if (!$decode) {
return $facets;
}
return array_map([$this->urlFacetPathService, 'decodeSingleValue'], $facets);
}
/**
* Returns the multi value separator
* @return string
*/
public function getDefaultMultiValueSeparator(): string
{
return $this->settings['multiValueSeparator'] ?? ',';
}
/**
* Find a enhancer configuration by a given page id
*
* @param int $pageUid
* @return array
*/
public function fetchEnhancerByPageUid(int $pageUid): array
{
$site = $this->findSiteByUid($pageUid);
if ($site instanceof NullSite) {
return [];
}
return $this->fetchEnhancerInSiteConfigurationByPageUid(
$site,
$pageUid
);
}
/**
* Returns the route enhancer configuration by given site and page uid
*
* @param Site $site
* @param int $pageUid
* @return array
*/
public function fetchEnhancerInSiteConfigurationByPageUid(Site $site, int $pageUid): array
{
$configuration = $site->getConfiguration();
if (empty($configuration['routeEnhancers']) || !is_array($configuration['routeEnhancers'])) {
return [];
}
$result = [];
foreach ($configuration['routeEnhancers'] as $routing => $settings) {
// Not the page we are looking for
if (isset($settings['limitToPages']) &&
is_array($settings['limitToPages']) &&
!in_array($pageUid, $settings['limitToPages'])) {
continue;
}
if (empty($settings) || !isset($settings['type']) ||
!$this->isRouteEnhancerForSolr((string)$settings['type'])
) {
continue;
}
$result[] = $settings;
}
return $result;
}
/**
* Add heading slash to given slug
*
* @param string $slug
* @return string
*/
public function cleanupHeadingSlash(string $slug): string
{
if (mb_substr($slug, 0, 1) !== '/') {
return '/' . $slug;
} else if (mb_substr($slug, 0, 2) === '//') {
return mb_substr($slug, 1, mb_strlen($slug) - 1);
}
return $slug;
}
/**
* Add heading slash to given slug
*
* @param string $slug
* @return string
*/
public function addHeadingSlash(string $slug): string
{
if (mb_substr($slug, 0, 1) === '/') {
return $slug;
}
return '/' . $slug;
}
/**
* Remove heading slash from given slug
*
* @param string $slug
* @return string
*/
public function removeHeadingSlash(string $slug): string
{
if (mb_substr($slug, 0, 1) !== '/') {
return $slug;
}
return mb_substr($slug, 1, mb_strlen($slug) - 1);
}
/**
* Retrieve the site by given UID
*
* @param int $pageUid
* @return SiteInterface
*/
public function findSiteByUid(int $pageUid): SiteInterface
{
try {
$site = $this->getSiteFinder()
->getSiteByPageId($pageUid);
return $site;
} catch (SiteNotFoundException $exception) {
return new NullSite();
}
}
/**
* @param Site $site
* @return PageSlugCandidateProvider
*/
public function getSlugCandidateProvider(Site $site): PageSlugCandidateProvider
{
$context = GeneralUtility::makeInstance(Context::class);
return GeneralUtility::makeInstance(
PageSlugCandidateProvider::class,
$context,
$site,
null
);
}
/**
* Convert the base string into a URI object
*
* @param string $base
* @return UriInterface|null
*/
public function convertStringIntoUri(string $base): ?UriInterface
{
try {
/* @var Uri $uri */
$uri = GeneralUtility::makeInstance(
Uri::class,
$base
);
return $uri;
} catch (\InvalidArgumentException $argumentException) {
return null;
}
}
/**
* In order to search for a path, a possible language prefix need to remove
*
* @param SiteLanguage $language
* @param string $path
* @return string
*/
public function stripLanguagePrefixFromPath(SiteLanguage $language, string $path): string
{
if ($language->getBase()->getPath() === '/') {
return $path;
}
$pathLength = mb_strlen($language->getBase()->getPath());
$path = mb_substr($path, $pathLength, mb_strlen($path) - $pathLength);
if (mb_substr($path, 0, 1) !== '/') {
$path = '/' . $path;
}
return $path;
}
/**
* Enrich the current query Params with data from path information
*
* @param ServerRequestInterface $request
* @param array $arguments
* @param array $parameters
* @return ServerRequestInterface
*/
public function addPathArgumentsToQuery(
ServerRequestInterface $request,
array $arguments,
array $parameters
): ServerRequestInterface {
$queryParams = $request->getQueryParams();
foreach ($arguments as $fieldName => $queryPath) {
// Skip if there is no parameter
if (!isset($parameters[$fieldName])) {
continue;
}
$pathElements = explode('/', $queryPath);
if (!empty($this->pluginNamespace)) {
array_unshift($pathElements, $this->pluginNamespace);
}
$queryParams = $this->processUriPathArgument(
$queryParams,
$fieldName,
$parameters,
$pathElements
);
}
return $request->withQueryParams($queryParams);
}
/**
* Check if given argument is a mapping argument
*
* @param string $facetName
* @return bool
*/
public function isMappingArgument(string $facetName): bool
{
$map = $this->getQueryParameterMap();
if (isset($map[$facetName]) && $this->shouldMaskQueryParameter()) {
return true;
}
return false;
}
/**
* Check if given facet type is an path argument
*
* @param string $facetName
* @return bool
*/
public function isPathArgument(string $facetName): bool
{
return isset($this->pathArguments[$facetName]);