vendor/pimcore/pimcore/bundles/CoreBundle/EventListener/Frontend/HardlinkCanonicalListener.php line 58

Open in your IDE?
  1. <?php
  3. /**
  4.  * Pimcore
  5.  *
  6.  * This source file is available under two different licenses:
  7.  * - GNU General Public License version 3 (GPLv3)
  8.  * - Pimcore Commercial License (PCL)
  9.  * Full copyright and license information is available in
  10.  * LICENSE.md which is distributed with this source code.
  11.  *
  12.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  14.  */
  16. namespace Pimcore\Bundle\CoreBundle\EventListener\Frontend;
  18. use Pimcore\Bundle\CoreBundle\EventListener\Traits\PimcoreContextAwareTrait;
  19. use Pimcore\Http\Request\Resolver\DocumentResolver;
  20. use Pimcore\Http\Request\Resolver\PimcoreContextResolver;
  21. use Pimcore\Model\Document;
  22. use Pimcore\Model\Document\Hardlink\Wrapper\WrapperInterface;
  23. use Pimcore\Model\Site;
  24. use Pimcore\Model\Staticroute;
  25. use Pimcore\Tool\Frontend;
  26. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  27. use Symfony\Component\HttpFoundation\Request;
  28. use Symfony\Component\HttpFoundation\Response;
  29. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  30. use Symfony\Component\HttpKernel\KernelEvents;
  32. /**
  33.  * Sets canonical headers for hardlink documents
  34.  *
  35.  * @internal
  36.  */
  37. class HardlinkCanonicalListener implements EventSubscriberInterface
  38. {
  39.     use PimcoreContextAwareTrait;
  41.     /**
  42.      * @param DocumentResolver $documentResolver
  43.      */
  44.     public function __construct(protected DocumentResolver $documentResolver)
  45.     {
  46.     }
  48.     /**
  49.      * {@inheritdoc}
  50.      */
  51.     public static function getSubscribedEvents()
  52.     {
  53.         return [
  54.             KernelEvents::RESPONSE => 'onKernelResponse',
  55.         ];
  56.     }
  58.     public function onKernelResponse(ResponseEvent $event)
  59.     {
  60.         $request = $event->getRequest();
  62.         if (!$event->isMainRequest()) {
  63.             return;
  64.         }
  66.         if (!$this->matchesPimcoreContext($request, PimcoreContextResolver::CONTEXT_DEFAULT)) {
  67.             return;
  68.         }
  70.         $document = $this->documentResolver->getDocument($request);
  71.         if (!$document) {
  72.             return;
  73.         }
  75.         if ($document instanceof WrapperInterface && !Staticroute::getCurrentRoute()) {
  76.             $this->handleHardlink($request, $event->getResponse(), $document);
  77.         }
  78.     }
  80.     /**
  81.      * @param Request $request
  82.      * @param Response $response
  83.      * @param Document $document
  84.      */
  85.     protected function handleHardlink(Request $request, Response $response, Document $document)
  86.     {
  87.         $canonical = null;
  89.         // get the canonical (source) document
  90.         $hardlinkCanonicalSourceDocument = Document::getById($document->getId());
  92.         if (Frontend::isDocumentInCurrentSite($hardlinkCanonicalSourceDocument)) {
  93.             $canonical = $request->getSchemeAndHttpHost() . $hardlinkCanonicalSourceDocument->getFullPath();
  94.         } elseif (Site::isSiteRequest()) {
  95.             $sourceSite = Frontend::getSiteForDocument($hardlinkCanonicalSourceDocument);
  96.             if ($sourceSite) {
  97.                 if ($sourceSite->getMainDomain()) {
  98.                     $sourceSiteRelPath = preg_replace('@^' . preg_quote($sourceSite->getRootPath(), '@') . '@', '', $hardlinkCanonicalSourceDocument->getRealFullPath());
  99.                     $canonical = $request->getScheme() . '://' . $sourceSite->getMainDomain() . $sourceSiteRelPath;
  100.                 }
  101.             }
  102.         }
  104.         if ($canonical) {
  105.             $response->headers->set('Link', '<' . $canonical . '>; rel="canonical"', false);
  106.         }
  107.     }
  108. }