vendor/ibexa/http-cache/src/lib/EventSubscriber/XLocationIdResponseSubscriber.php line 46

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