vendor/can/rest/src/Can/RestBundle/EventListener/RateLimitHeadersListener.php line 41

Open in your IDE?
  1. <?php
  3. namespace Can\RestBundle\EventListener;
  5. use Can\RestBundle\CanRestBundle;
  6. use Can\RestBundle\RateLimit\RateLimitConfiguration;
  7. use Can\RestBundle\RateLimit\RateLimitHeader;
  8. use Can\RestBundle\RateLimit\RateLimitInfo;
  10. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  12. /**
  13.  * Adds the rate limit headers to the response.
  14.  *
  15.  * @group ratelimit
  16.  *
  17.  * @package can/rest-bundle
  18.  * @author lechecacharro <lechecacharro@gmail.com>
  19.  */
  20. class RateLimitHeadersListener
  21. {
  23.     /**
  24.      * @var RateLimitConfiguration
  25.      */
  26.     private $configuration;
  28.     /**
  29.      * RateLimitHeadersListener constructor.
  30.      *
  31.      * @param RateLimitConfiguration $configuration
  32.      */
  33.     public function __construct(RateLimitConfiguration $configuration)
  34.     {
  35.         $this->configuration = $configuration;
  36.     }
  38.     /**
  39.      * @param ResponseEvent $event
  40.      */
  41.     public function onResponse(ResponseEvent $event): void
  42.     {
  43.         if (! $this->configuration->isEnabled()) {
  44.             return;
  45.         }
  47.         $request = $event->getRequest();
  49.         if (! $request->attributes->get(CanRestBundle::ATTR_SERVICE_ZONE)) {
  50.             return;
  51.         }
  53.         /** @var RateLimitInfo $rateLimitInfo */
  54.         $rateLimitInfo = $event->getRequest()->attributes->get(CanRestBundle::ATTR_RATE_LIMIT_INFO, null);
  56.         if (null === $rateLimitInfo) {
  57.             return;
  58.         }
  60.         $response = $event->getResponse();
  62.         $response->headers->set($this->configuration->getLimitHeader(),     $rateLimitInfo->getLimit());
  63.         $response->headers->set($this->configuration->getRemainingHeader(), $rateLimitInfo->getRemaining());
  64.         $response->headers->set($this->configuration->getResetHeader(),     $rateLimitInfo->getWindowResetTime());
  65.         $response->headers->set($this->configuration->getWindowHeader(),    $rateLimitInfo->getWindowLength());
  67.         if ($this->configuration->isDebug()) {
  68.             $response->headers->set(RateLimitHeader::KEY,
  69.                 $request->attributes->get(CanRestBundle::ATTR_RATE_LIMIT_KEY)
  70.             );
  72.             if (null !== CanRestBundle::ATTR_RATE_LIMIT_CONSTRAINT) {
  73.                 $response->headers->set(RateLimitHeader::CONSTRAINT,
  74.                     $request->attributes->get(CanRestBundle::ATTR_RATE_LIMIT_CONSTRAINT)
  75.                 );
  76.             }
  78.             if (null !== CanRestBundle::ATTR_RATE_LIMIT_PLAN) {
  79.                 $response->headers->set(RateLimitHeader::PLAN,
  80.                     $request->attributes->get(CanRestBundle::ATTR_RATE_LIMIT_PLAN)
  81.                 );
  82.             }
  83.         }
  85.         if ($rateLimitInfo->isRateLimitExceeded()) {
  86.             $response->headers->set('Connection', 'close');
  87.         }
  88.     }
  90. }