select2-8.x-1.11/modules/select2_facets/src/Controller/FacetApiAutocompleteController.php
modules/select2_facets/src/Controller/FacetApiAutocompleteController.php
<?php
namespace Drupal\select2_facets\Controller;
use Drupal\Component\Utility\Crypt;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Path\CurrentPathStack;
use Drupal\Core\PathProcessor\InboundPathProcessorInterface;
use Drupal\Core\Routing\AccessAwareRouterInterface;
use Drupal\Core\Site\Settings;
use Drupal\facets\FacetManager\DefaultFacetManager;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
/**
* Defines a route controller for facets autocomplete form elements.
*/
class FacetApiAutocompleteController extends ControllerBase {
/**
* The facet manager service.
*
* @var \Drupal\facets\FacetManager\DefaultFacetManager
*/
protected DefaultFacetManager $facetManager;
/**
* The request stack.
*
* @var \Symfony\Component\HttpFoundation\RequestStack
*/
protected RequestStack $requestStack;
/**
* The current path stack.
*
* @var \Drupal\Core\Path\CurrentPathStack
*/
protected CurrentPathStack $currentPathStack;
/**
* The current router.
*
* @var \Drupal\Core\Routing\AccessAwareRouterInterface
*/
protected AccessAwareRouterInterface $router;
/**
* The processor manager.
*
* @var \Drupal\Core\PathProcessor\InboundPathProcessorInterface
*/
protected InboundPathProcessorInterface $pathProcessor;
/**
* Array of request.
*
* @var array
*/
protected array $storedRequests = [];
/**
* {@inheritdoc}
*
* @phpstan-ignore-next-line
*/
public static function create(ContainerInterface $container) {
$controller = parent::create($container);
$controller->setFacetManager($container->get('facets.manager'));
$controller->setRequestStack($container->get('request_stack'));
$controller->setCurrentPathStack($container->get('path.current'));
$controller->setRouter($container->get('router'));
$controller->setPathProcessor($container->get('path_processor_manager'));
return $controller;
}
/**
* Set the facet manager service.
*
* @param \Drupal\facets\FacetManager\DefaultFacetManager $facetManager
* The facet manager.
*/
protected function setFacetManager(DefaultFacetManager $facetManager): void {
$this->facetManager = $facetManager;
}
/**
* Set the request stack.
*
* @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
* The request stack object.
*/
protected function setRequestStack(RequestStack $requestStack): void {
$this->requestStack = $requestStack;
}
/**
* Set the current path stack.
*
* @param \Drupal\Core\Path\CurrentPathStack $currentPathStack
* Current path stack object.
*/
protected function setCurrentPathStack(CurrentPathStack $currentPathStack): void {
$this->currentPathStack = $currentPathStack;
}
/**
* Set the router.
*
* @param \Drupal\Core\Routing\AccessAwareRouterInterface $router
* The router object.
*/
protected function setRouter(AccessAwareRouterInterface $router): void {
$this->router = $router;
}
/**
* Set the path processor service.
*
* @param \Drupal\Core\PathProcessor\InboundPathProcessorInterface $pathProcessor
* The path processor service object.
*/
protected function setPathProcessor(InboundPathProcessorInterface $pathProcessor): void {
$this->pathProcessor = $pathProcessor;
}
/**
* Autocomplete the label of an entity.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The request object that contains the typed tags.
* @param string $facetsource_id
* The ID of the facet source.
* @param string $facet_id
* The ID of the facet.
* @param string $selection_settings_key
* The hashed key of the key/value entry that holds the selection handler
* settings.
*
* @return \Symfony\Component\HttpFoundation\JsonResponse
* The matched entity labels as a JSON response.
*
* @throws \Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
* Thrown if the selection settings key is not found in the key/value store
* or if it does not match the stored data.
* @throws \Drupal\facets\Exception\InvalidProcessorException
*/
public function handleAutocomplete(Request $request, string $facetsource_id, string $facet_id, string $selection_settings_key): JsonResponse {
$matches = [
'results' => [],
];
// Get the typed string from the URL, if it exists.
if ($input = $request->query->get('q')) {
$typed_string = mb_strtolower($input);
// Selection settings are passed in as a hashed key of a serialized array
// stored in the key/value store.
$selection_settings = $this->keyValue('entity_autocomplete')->get($selection_settings_key, FALSE);
if ($selection_settings !== FALSE) {
$selection_settings_hash = Crypt::hmacBase64(serialize($selection_settings) . $facetsource_id . $facet_id, Settings::getHashSalt());
if (!hash_equals($selection_settings_hash, $selection_settings_key)) {
// Disallow access when the selection settings hash does not match the
// passed-in key.
throw new AccessDeniedHttpException('Invalid selection settings key.');
}
}
else {
// Disallow access when the selection settings key is not found in the
// key/value store.
throw new AccessDeniedHttpException();
}
$new_request = $this->createRequestFromPath($selection_settings['path']);
$request->attributes->add($this->router->matchRequest($new_request));
$this->overwriteRequestStack($new_request);
$facets = $this->facetManager->getFacetsByFacetSourceId($facetsource_id);
foreach ($facets as $facet) {
if ($facet->id() != $facet_id) {
continue;
}
$this->facetManager->build($facet);
foreach ($facet->getResults() as $result) {
$display_value = mb_strtolower($result->getDisplayValue());
if ($selection_settings['match_operator'] == 'CONTAINS' && strpos($display_value, $typed_string) === FALSE || ($selection_settings['match_operator'] == 'STARTS_WITH' && strpos($display_value, $typed_string) !== 0)) {
continue;
}
$matches['results'][] = [
'id' => $result->getUrl()->toString(),
'text' => ($selection_settings['show_numbers'] ? sprintf('%s (%d)', $result->getDisplayValue(), $result->getCount()) : $result->getDisplayValue()),
];
}
}
$this->restoreRequestStack();
}
return new JsonResponse($matches);
}
/**
* Creates a new request object from a path.
*
* @param string $path
* A path with facet arguments.
*
* @return \Symfony\Component\HttpFoundation\Request
* A new request object.
*/
protected function createRequestFromPath(string $path): Request {
$new_request = Request::create($path);
$processed = $this->pathProcessor->processInbound($path, $new_request);
$this->currentPathStack->setPath($processed);
return $new_request;
}
/**
* Resets the request stack and adds one request.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* The one and only request.
*/
protected function overwriteRequestStack(Request $request): void {
while ($this->requestStack->getCurrentRequest()) {
$this->storedRequests[] = $this->requestStack->pop();
}
$this->requestStack->push($request);
}
/**
* Restore all saved requests on the stack.
*/
protected function restoreRequestStack(): void {
$this->requestStack->pop();
foreach ($this->storedRequests as $request) {
$this->requestStack->push($request);
}
}
}
