vendor/can/rest/src/Can/RestBundle/EventListener/TrackingListener.php line 53

Open in your IDE?
  1. <?php
  3. namespace Can\RestBundle\EventListener;
  5. use Can\RestBundle\CanRestBundle;
  6. use Can\RestBundle\Http\Header\DoNotTrack;
  7. use Can\RestBundle\Tracking\TrackingConfiguration;
  8. use Can\RestBundle\Tracking\TrackingHeader;
  9. use Can\RestBundle\Tracking\TrackingResolverInterface;
  10. use Can\RestBundle\Tracking\TrackingUtil;
  12. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  13. use Symfony\Component\HttpKernel\Exception\BadRequestHttpException;
  15. use InvalidArgumentException;
  17. /**
  18.  * Manages tracking headers (DNT and its Do-Not-Track variants).
  19.  *
  20.  * @group tracking
  21.  *
  22.  * @package can/rest-bundle
  23.  * @author lechecacharro <lechecacharro@gmail.com>
  24.  */
  25. class TrackingListener
  26. {
  28.     /**
  29.      * @var TrackingConfiguration
  30.      */
  31.     private $configuration;
  33.     /**
  34.      * @var TrackingResolverInterface
  35.      */
  36.     private $resolver;
  38.     /**
  39.      * TrackingListener constructor.
  40.      *
  41.      * @param TrackingConfiguration     $configuration
  42.      * @param TrackingResolverInterface $resolver
  43.      */
  44.     public function __construct(TrackingConfiguration $configuration, TrackingResolverInterface $resolver)
  45.     {
  46.         $this->configuration = $configuration;
  47.         $this->resolver = $resolver;
  48.     }
  50.     /**
  51.      * @param ResponseEvent $event
  52.      */
  53.     public function onResponse(ResponseEvent $event): void
  54.     {
  55.         if (! $this->configuration->isEnabled()) {
  56.             return;
  57.         }
  59.         $request = $event->getRequest();
  61.         if (! $request->attributes->get(CanRestBundle::ATTR_SERVICE_ZONE)) {
  62.             return;
  63.         }
  65.         if (null === $doNotTrack = TrackingUtil::extractDoNotTrackHeader($request)) {
  66.             return;
  67.         }
  69.         try {
  70.             $trackingPreference = DoNotTrack::parseHeader($doNotTrack);
  71.         } catch (InvalidArgumentException $e) {
  72.             throw new BadRequestHttpException($e->getMessage(), $e);
  73.         }
  75.         $trackingStatus = $this->resolver->resolve($request);
  77.         $request->attributes->set(CanRestBundle::ATTR_DO_NOT_TRACK, (string) $doNotTrack);
  78.         $request->attributes->set(CanRestBundle::ATTR_TRACKING_PREFERENCE, $trackingPreference);
  79.         $request->attributes->set(CanRestBundle::ATTR_TRACKING_STATUS, $trackingStatus);
  81.         $response = $event->getResponse();
  82.         $response->headers->set(TrackingHeader::TRACKING_STATUS, $trackingStatus->getValue());
  83.     }
  85. }