vendor/ezsystems/ezplatform-http-cache/src/EventSubscriber/RestKernelViewSubscriber.php line 45

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\Values\Content\Section;
  10. use eZ\Publish\API\Repository\Values\ContentType\ContentType;
  11. use eZ\Publish\Core\REST\Common\Values\Root;
  12. use eZ\Publish\Core\REST\Server\Values\CachedValue;
  13. use eZ\Publish\Core\REST\Server\Values\ContentTypeGroupList;
  14. use eZ\Publish\Core\REST\Server\Values\ContentTypeGroupRefList;
  15. use eZ\Publish\Core\REST\Server\Values\RestContentType;
  16. use eZ\Publish\Core\REST\Server\Values\VersionList;
  17. use EzSystems\MultiFileUpload\API\Repository\Values\PermissionReport;
  18. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  19. use Symfony\Component\HttpKernel\Event\GetResponseForControllerResultEvent;
  20. use Symfony\Component\HttpKernel\KernelEvents;
  21. use FOS\HttpCache\Handler\TagHandler;
  23. /**
  24.  * Set cache tags on a few REST responses used by UI in order to be able to cache them.
  25.  *
  26.  * @deprecated This is a temprary approach to caching certain parts of REST used by UI, it is deprecated in favour of
  27.  *             nativly using tags and CachedValue in kernel's REST server itself once we switch to FOSHttpCache 2.x
  28.  *             where tagger service can be used directly.
  29.  */
  30. class RestKernelViewSubscriber implements EventSubscriberInterface
  31. {
  32.     /** @var \FOS\HttpCache\Handler\TagHandler */
  33.     private $tagHandler;
  35.     public function __construct(TagHandler $tagHandler)
  36.     {
  37.         $this->tagHandler = $tagHandler;
  38.     }
  40.     public static function getSubscribedEvents()
  41.     {
  42.         return [KernelEvents::VIEW => ['tagUIRestResult', 10]];
  43.     }
  45.     public function tagUIRestResult(GetResponseForControllerResultEvent $event)
  46.     {
  47.         $request = $event->getRequest();
  48.         if (!$request->isMethodCacheable() || !$request->attributes->get('is_rest_request')) {
  49.             return;
  50.         }
  52.         // Get tags, and exit if none where found
  53.         $restValue = $event->getControllerResult();
  54.         $tags = $this->getTags($restValue);
  55.         if (empty($tags)) {
  56.             return;
  57.         }
  59.         // Add tags and swap Rest Value for cached value now that REST server can safely cache it
  60.         $this->tagHandler->addTags($tags);
  61.         $event->setControllerResult(new CachedValue($restValue));
  62.     }
  64.     /**
  65.      * @param object $value
  66.      *
  67.      * @return array
  68.      */
  69.     protected function getTags($value)
  70.     {
  71.         $tags = [];
  72.         switch ($value) {
  73.             case $value instanceof VersionList && !empty($value->versions):
  74.                 $tags[] = 'content-' . $value->versions[0]->contentInfo->id;
  75.                 $tags[] = 'content-versions-' . $value->versions[0]->contentInfo->id;
  77.                 break;
  79.             case $value instanceof Section:
  80.                 $tags[] = 'section-' . $value->id;
  81.                 break;
  83.             case $value instanceof ContentTypeGroupRefList:
  84.                 if ($value->contentType->status !== ContentType::STATUS_DEFINED) {
  85.                     return [];
  86.                 }
  87.                 $tags[] = 'type-' . $value->contentType->id;
  88.             case $value instanceof ContentTypeGroupList:
  89.                 foreach ($value->contentTypeGroups as $contentTypeGroup) {
  90.                     $tags[] = 'type-group-' . $contentTypeGroup->id;
  91.                 }
  92.                 break;
  94.             case $value instanceof RestContentType:
  95.                 $value = $value->contentType;
  96.             case $value instanceof ContentType:
  97.                 if ($value->status !== ContentType::STATUS_DEFINED) {
  98.                     return [];
  99.                 }
  100.                 $tags[] = 'type-' . $value->id;
  101.                 break;
  103.             case $value instanceof Root:
  104.                 $tags[] = 'ez-all';
  105.                 break;
  107.                 // @deprecated The following logic is 1.x specific, and should be removed before a 1.0 version
  108.             case $value instanceof PermissionReport:
  109.                 // We requrie v0.1.5 with added location property to be able to add tags
  110.                 if (!isset($value->parentLocation)) {
  111.                     return [];
  112.                 }
  114.                 // In case of for instance location swap where content type might change affecting allowed content types
  115.                 $tags[] = 'content-' . $value->parentLocation->contentId;
  116.                 $tags[] = 'content-type-' . $value->parentLocation->contentInfo->contentTypeId;
  117.                 $tags[] = 'location-' . $value->parentLocation->id;
  119.                 // In case of permissions assigned by subtree, so if path changes affecting this (move subtree operation)
  120.                 foreach ($value->parentLocation->path as $pathItem) {
  121.                     $tags[] = 'path-' . $pathItem;
  122.                 }
  123.                 break;
  124.         }
  126.         return $tags;
  127.     }
  128. }