vendor/can/rest/src/Can/RestBundle/EventListener/ContentHeadersListener.php line 52

Open in your IDE?
  1. <?php
  3. namespace Can\RestBundle\EventListener;
  5. use Can\RestBundle\CanRestBundle;
  6. use Can\RestBundle\Http\Method;
  7. use Can\RestBundle\Mapping\MetadataStore;
  8. use Can\RestBundle\Negotiation\NegotiationConfiguration;
  9. use Can\RestBundle\Negotiation\NegotiationHeader;
  10. use Can\RestBundle\URI\ServiceNode;
  12. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  14. /**
  15.  * Adds the response Content-like headers.
  16.  *
  17.  * @group negotiation
  18.  *
  19.  * @package can/rest-bundle
  20.  * @author lechecacharro <lechecacharro@gmail.com>
  21.  */
  22. class ContentHeadersListener
  23. {
  25.     /**
  26.      * @var NegotiationConfiguration
  27.      */
  28.     private $configuration;
  30.     /**
  31.      * @var MetadataStore
  32.      */
  33.     private $store;
  36.     /**
  37.      * ContentHeadersListener constructor.
  38.      *
  39.      * @param NegotiationConfiguration $configuration
  40.      * @param MetadataStore            $store
  41.      */
  42.     public function __construct(NegotiationConfiguration $configuration, MetadataStore $store)
  43.     {
  44.         $this->configuration = $configuration;
  45.         $this->store = $store;
  46.     }
  49.     /**
  50.      * @param ResponseEvent $event
  51.      */
  52.     public function onResponse(ResponseEvent $event): void
  53.     {
  54.         if (! $this->configuration->isEnabled()) {
  55.             return;
  56.         }
  58.         $request = $event->getRequest();
  60.         if (! $request->attributes->get(CanRestBundle::ATTR_SERVICE_ZONE)) {
  61.             return;
  62.         }
  64.         $response = $event->getResponse();
  66.         // Don't add content headers to empty responses
  67.         if ($response->isEmpty() || empty($response->getContent())) {
  68.             return;
  69.         }
  71.         if ($charset = $request->attributes->get(CanRestBundle::ATTR_NEGOTIATION_CHARSET)) {
  72.             $response->setCharset($charset);
  73.         }
  75.         //if ($encoding = $request->attributes->get(CanRestBundle::ATTR_NEGOTIATION_ENCODING)) {
  76.             //$response->headers->set(NegotiationHeader::CONTENT_ENCODING, $encoding);
  77.         //}
  79.         if ($language = $request->attributes->get(CanRestBundle::ATTR_NEGOTIATION_LANGUAGE)) {
  80.             $response->headers->set(NegotiationHeader::CONTENT_LANGUAGE, $language);
  81.         }
  83.         if ($mediaType = $request->attributes->get(CanRestBundle::ATTR_NEGOTIATION_MEDIA_TYPE)) {
  84.             $response->headers->set(NegotiationHeader::CONTENT_TYPE, $mediaType);
  86.             if ($this->configuration->isPreventBrowserSniffing()) {
  87.                 $response->headers->set(NegotiationHeader::X_CONTENT_TYPE_OPTIONS, 'nosniff');
  88.             }
  89.         }
  91.         $serviceNode = $request->attributes->get(CanRestBundle::ATTR_SERVICE_NODE);
  93.         if (! $serviceNode instanceof ServiceNode) {
  94.             return;
  95.         }
  97.         if ($this->configuration->isAdvertiseAcceptedPatches() && $this->currentNodeSupportsPatch($serviceNode)) {
  98.             $patchFormats = $this->configuration->getPatchFormats();
  100.             if ($patchFormats) {
  101.                 $response->headers->set(NegotiationHeader::ACCEPT_PATCH, implode(',', array_merge(...array_values($patchFormats))));
  102.             }
  103.         }
  105.         if ($this->configuration->isAdvertiseAcceptedSearches() && $this->currentNodeSupportsSearch($serviceNode)) {
  106.             $searchFormats = $this->configuration->getSearchFormats();
  108.             if ($searchFormats) {
  109.                 $response->headers->set(NegotiationHeader::ACCEPT_SEARCH, implode(',', array_merge(...array_values($searchFormats))));
  110.             }
  111.         }
  112.     }
  114.     /**
  115.      * @param ServiceNode $node
  116.      *
  117.      * @return bool
  118.      */
  119.     protected function currentNodeSupportsPatch(ServiceNode $node): bool
  120.     {
  121.         if ($node->isCollection()) {
  122.             // We DO NOT support collection patches
  123.             return false;
  124.         }
  126.         if (! $this->store->hasMetadataFor($node)) {
  127.             return false;
  128.         }
  130.         return $this->store->getMetadataFor($node)->supportsMethod(Method::PATCH);
  131.     }
  133.     /**
  134.      * @param ServiceNode $node
  135.      *
  136.      * @return bool
  137.      */
  138.     protected function currentNodeSupportsSearch(ServiceNode $node): bool
  139.     {
  140.         if (! $this->store->hasMetadataFor($node)) {
  141.             return false;
  142.         }
  144.         return $this->store->getMetadataFor($node)->supportsOperation(Method::SEARCH, $node->isCollection());
  145.     }
  147. }