vendor/contao/core-bundle/src/EventListener/SearchIndexListener.php line 55

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of Contao.
  7.  *
  8.  * (c) Leo Feyer
  9.  *
  10.  * @license LGPL-3.0-or-later
  11.  */
  13. namespace Contao\CoreBundle\EventListener;
  15. use Contao\CoreBundle\Crawl\Escargot\Factory;
  16. use Contao\CoreBundle\Search\Document;
  17. use Contao\CoreBundle\Search\Indexer\IndexerException;
  18. use Contao\CoreBundle\Search\Indexer\IndexerInterface;
  19. use Symfony\Component\HttpFoundation\Request;
  20. use Symfony\Component\HttpKernel\Event\TerminateEvent;
  22. /**
  23.  * @internal
  24.  */
  25. class SearchIndexListener
  26. {
  27.     public const FEATURE_INDEX = 0b01;
  28.     public const FEATURE_DELETE = 0b10;
  30.     /**
  31.      * @var IndexerInterface
  32.      */
  33.     private $indexer;
  35.     /**
  36.      * @var string
  37.      */
  38.     private $fragmentPath;
  40.     /**
  41.      * @var int
  42.      */
  43.     private $enabledFeatures;
  45.     public function __construct(IndexerInterface $indexer, string $fragmentPath = '_fragment', int $enabledFeatures = self::FEATURE_INDEX | self::FEATURE_DELETE)
  46.     {
  47.         $this->indexer = $indexer;
  48.         $this->fragmentPath = $fragmentPath;
  49.         $this->enabledFeatures = $enabledFeatures;
  50.     }
  52.     /**
  53.      * Checks if the request can be indexed and forwards it accordingly.
  54.      */
  55.     public function __invoke(TerminateEvent $event): void
  56.     {
  57.         $request = $event->getRequest();
  59.         // Only handle GET requests (see #1194)
  60.         if (!$request->isMethod(Request::METHOD_GET)) {
  61.             return;
  62.         }
  64.         // Do not index if called by crawler
  65.         if (Factory::USER_AGENT === $request->headers->get('User-Agent')) {
  66.             return;
  67.         }
  69.         // Do not handle fragments
  70.         if (preg_match('~(?:^|/)'.preg_quote($this->fragmentPath, '~').'/~', $request->getPathInfo())) {
  71.             return;
  72.         }
  74.         $response = $event->getResponse();
  76.         // Do not index if the X-Robots-Tag header contains "noindex"
  77.         if (false !== strpos($response->headers->get('X-Robots-Tag', ''), 'noindex')) {
  78.             return;
  79.         }
  81.         $document = Document::createFromRequestResponse($request, $response);
  83.         try {
  84.             $robots = $document->getContentCrawler()->filterXPath('//head/meta[@name="robots"]')->first()->attr('content');
  86.             // Do not index if the meta robots tag contains "noindex"
  87.             if (false !== strpos($robots, 'noindex')) {
  88.                 return;
  89.             }
  90.         } catch (\Exception $e) {
  91.             // No meta robots tag found
  92.         }
  94.         $lds = $document->extractJsonLdScripts();
  96.         // If there are no json ld scripts at all, this should not be handled by our indexer
  97.         if (0 === \count($lds)) {
  98.             return;
  99.         }
  101.         try {
  102.             $success = $event->getResponse()->isSuccessful();
  104.             if ($success && $this->enabledFeatures & self::FEATURE_INDEX) {
  105.                 $this->indexer->index($document);
  106.             }
  108.             if (!$success && $this->enabledFeatures & self::FEATURE_DELETE) {
  109.                 $this->indexer->delete($document);
  110.             }
  111.         } catch (IndexerException $e) {
  112.             // ignore
  113.         }
  114.     }
  115. }