vendor/api-platform/core/src/HttpCache/EventListener/AddHeadersListener.php line 35

  1. <?php
  3. /*
  4.  * This file is part of the API Platform project.
  5.  *
  6.  * (c) Kévin Dunglas <dunglas@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. declare(strict_types=1);
  14. namespace ApiPlatform\HttpCache\EventListener;
  16. use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
  17. use ApiPlatform\Util\OperationRequestInitiatorTrait;
  18. use ApiPlatform\Util\RequestAttributesExtractor;
  19. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  21. /**
  22.  * Configures cache HTTP headers for the current response.
  23.  *
  24.  * @author Kévin Dunglas <dunglas@gmail.com>
  25.  */
  26. final class AddHeadersListener
  27. {
  28.     use OperationRequestInitiatorTrait;
  30.     public function __construct(private readonly bool $etag = false, private readonly ?int $maxAge = null, private readonly ?int $sharedMaxAge = null, private readonly ?array $vary = null, private readonly ?bool $public = null, ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory = null, private readonly ?int $staleWhileRevalidate = null, private readonly ?int $staleIfError = null)
  31.     {
  32.         $this->resourceMetadataCollectionFactory = $resourceMetadataCollectionFactory;
  33.     }
  35.     public function onKernelResponse(ResponseEvent $event): void
  36.     {
  37.         $request = $event->getRequest();
  38.         if (!$request->isMethodCacheable()) {
  39.             return;
  40.         }
  42.         $attributes = RequestAttributesExtractor::extractAttributes($request);
  43.         if (\count($attributes) < 1) {
  44.             return;
  45.         }
  47.         $response = $event->getResponse();
  49.         if (!$response->getContent() || !$response->isSuccessful()) {
  50.             return;
  51.         }
  53.         $operation = $this->initializeOperation($request);
  54.         $resourceCacheHeaders = $attributes['cache_headers'] ?? $operation?->getCacheHeaders() ?? [];
  56.         if ($this->etag && !$response->getEtag()) {
  57.             $response->setEtag(md5((string) $response->getContent()));
  58.         }
  60.         if (null !== ($maxAge = $resourceCacheHeaders['max_age'] ?? $this->maxAge) && !$response->headers->hasCacheControlDirective('max-age')) {
  61.             $response->setMaxAge($maxAge);
  62.         }
  64.         $vary = $resourceCacheHeaders['vary'] ?? $this->vary;
  65.         if (null !== $vary) {
  66.             $response->setVary(array_diff($vary, $response->getVary()), false);
  67.         }
  69.         // if the public-property is defined and not yet set; apply it to the response
  70.         $public = ($resourceCacheHeaders['public'] ?? $this->public);
  71.         if (null !== $public && !$response->headers->hasCacheControlDirective('public')) {
  72.             $public ? $response->setPublic() : $response->setPrivate();
  73.         }
  75.         // Cache-Control "s-maxage" is only relevant is resource is not marked as "private"
  76.         if (false !== $public && null !== ($sharedMaxAge = $resourceCacheHeaders['shared_max_age'] ?? $this->sharedMaxAge) && !$response->headers->hasCacheControlDirective('s-maxage')) {
  77.             $response->setSharedMaxAge($sharedMaxAge);
  78.         }
  80.         if (null !== ($staleWhileRevalidate = $resourceCacheHeaders['stale_while_revalidate'] ?? $this->staleWhileRevalidate) && !$response->headers->hasCacheControlDirective('stale-while-revalidate')) {
  81.             $response->headers->addCacheControlDirective('stale-while-revalidate', (string) $staleWhileRevalidate);
  82.         }
  84.         if (null !== ($staleIfError = $resourceCacheHeaders['stale_if_error'] ?? $this->staleIfError) && !$response->headers->hasCacheControlDirective('stale-if-error')) {
  85.             $response->headers->addCacheControlDirective('stale-if-error', (string) $staleIfError);
  86.         }
  87.     }
  88. }