vendor/ezsystems/ezplatform-http-cache/src/EventSubscriber/XLocationIdResponseSubscriber.php line 54

Open in your IDE?
  1. <?php
  3. /**
  4.  * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  5.  * @license For full copyright and license information view LICENSE file distributed with this source code.
  6.  */
  7. namespace EzSystems\PlatformHttpCacheBundle\EventSubscriber;
  9. use eZ\Publish\API\Repository\Exceptions\NotFoundException;
  10. use eZ\Publish\API\Repository\Repository;
  11. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  12. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  13. use Symfony\Component\HttpKernel\KernelEvents;
  14. use FOS\HttpCache\Handler\TagHandler;
  16. /**
  17.  * Rewrites the X-Location-Id HTTP header.
  18.  *
  19.  * This is a BC layer for custom controllers (including REST server) still
  20.  * using X-Location-Id header which is now deprecated. For
  21.  * full value of tagging, see docs/using_tags.md for how to take advantage of the
  22.  * system.
  23.  */
  24. class XLocationIdResponseSubscriber implements EventSubscriberInterface
  25. {
  26.     const LOCATION_ID_HEADER = 'X-Location-Id';
  28.     /** @var \FOS\HttpCache\Handler\TagHandler */
  29.     private $tagHandler;
  31.     /** @var \eZ\Publish\API\Repository\Repository */
  32.     private $repository;
  34.     public function __construct(TagHandler $tagHandler, Repository $repository)
  35.     {
  36.         $this->tagHandler = $tagHandler;
  37.         $this->repository = $repository;
  38.     }
  40.     public static function getSubscribedEvents()
  41.     {
  42.         return [KernelEvents::RESPONSE => ['rewriteCacheHeader', 10]];
  43.     }
  45.     public function rewriteCacheHeader(FilterResponseEvent $event)
  46.     {
  47.         $response = $event->getResponse();
  48.         if (!$response->headers->has(static::LOCATION_ID_HEADER)) {
  49.             return;
  50.         }
  52.         @trigger_error(
  53.             'X-Location-Id is no longer preferred way to tag content responses, see ezplatform-http-cache/docs/using_tags.md',
  54.             E_USER_DEPRECATED
  55.         );
  57.         // Map the tags, even if not officially supported, handle comma separated values as was possible with Varnish
  58.         $tags = [];
  59.         foreach (explode(',', $response->headers->get(static::LOCATION_ID_HEADER)) as $id) {
  60.             $id = trim($id);
  61.             try {
  62.                 /** @var $location \eZ\Publish\API\Repository\Values\Content\Location */
  63.                 $location = $this->repository->sudo(function (Repository $repository) use ($id) {
  64.                     return $repository->getLocationService()->loadLocation($id);
  65.                 });
  67.                 $tags[] = 'location-' . $location->id;
  68.                 $tags[] = 'parent-' . $location->parentLocationId;
  70.                 foreach ($location->path as $pathItem) {
  71.                     $tags[] = 'path-' . $pathItem;
  72.                 }
  74.                 $contentInfo = $location->getContentInfo();
  75.                 $tags[] = 'content-' . $contentInfo->id;
  76.                 $tags[] = 'content-type-' . $contentInfo->contentTypeId;
  78.                 if ($contentInfo->mainLocationId !== $location->id) {
  79.                     $tags[] = 'location-' . $contentInfo->mainLocationId;
  80.                 }
  81.             } catch (NotFoundException $e) {
  82.                 $tags[] = "location-$id";
  83.                 $tags[] = "path-$id";
  84.             }
  85.         }
  87.         $this->tagHandler->addTags($tags);
  88.         $response->headers->remove(static::LOCATION_ID_HEADER);
  89.     }
  90. }