vendor/sentry/sentry-symfony/src/EventListener/RequestListener.php line 48

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\SentryBundle\EventListener;
  7. use Sentry\State\HubInterface;
  8. use Sentry\State\Scope;
  9. use Sentry\UserDataBag;
  10. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  11. use Symfony\Component\Security\Core\User\UserInterface;
  13. /**
  14.  * This listener ensures that a new {@see \Sentry\State\Scope} is created for
  15.  * each request and that it is filled with useful information, e.g. the IP
  16.  * address of the client.
  17.  */
  18. final class RequestListener
  19. {
  20.     /**
  21.      * @var HubInterface The current hub
  22.      */
  23.     private $hub;
  25.     /**
  26.      * @var TokenStorageInterface|null The token storage
  27.      */
  28.     private $tokenStorage;
  30.     /**
  31.      * Constructor.
  32.      *
  33.      * @param HubInterface               $hub          The current hub
  34.      * @param TokenStorageInterface|null $tokenStorage The token storage
  35.      */
  36.     public function __construct(HubInterface $hub, ?TokenStorageInterface $tokenStorage)
  37.     {
  38.         $this->hub = $hub;
  39.         $this->tokenStorage = $tokenStorage;
  40.     }
  42.     /**
  43.      * This method is called for each request handled by the framework and
  44.      * fills the Sentry scope with information about the current user.
  45.      *
  46.      * @param RequestListenerRequestEvent $event The event
  47.      */
  48.     public function handleKernelRequestEvent(RequestListenerRequestEvent $event): void
  49.     {
  50.         if (!$event->isMasterRequest()) {
  51.             return;
  52.         }
  54.         $client = $this->hub->getClient();
  56.         if (null === $client || !$client->getOptions()->shouldSendDefaultPii()) {
  57.             return;
  58.         }
  60.         $token = null;
  61.         $userData = UserDataBag::createFromUserIpAddress($event->getRequest()->getClientIp());
  63.         if (null !== $this->tokenStorage) {
  64.             $token = $this->tokenStorage->getToken();
  65.         }
  67.         if (null !== $token && $token->isAuthenticated() && null !== $token->getUser()) {
  68.             $userData->setUsername($this->getUsername($token->getUser()));
  69.         }
  71.         $this->hub->configureScope(static function (Scope $scope) use ($userData): void {
  72.             $scope->setUser($userData);
  73.         });
  74.     }
  76.     /**
  77.      * This method is called for each request handled by the framework and
  78.      * sets the route on the current Sentry scope.
  79.      *
  80.      * @param RequestListenerControllerEvent $event The event
  81.      */
  82.     public function handleKernelControllerEvent(RequestListenerControllerEvent $event): void
  83.     {
  84.         if (!$event->isMasterRequest()) {
  85.             return;
  86.         }
  88.         $request = $event->getRequest();
  90.         if (!$request->attributes->has('_route')) {
  91.             return;
  92.         }
  94.         $this->hub->configureScope(static function (Scope $scope) use ($request): void {
  95.             $scope->setTag('route', (string) $request->attributes->get('_route'));
  96.         });
  97.     }
  99.     /**
  100.      * @param UserInterface|object|string $user
  101.      */
  102.     private function getUsername($user): ?string
  103.     {
  104.         if ($user instanceof UserInterface) {
  105.             return $user->getUsername();
  106.         }
  108.         if (\is_string($user)) {
  109.             return $user;
  110.         }
  112.         if (\is_object($user) && method_exists($user, '__toString')) {
  113.             return (string) $user;
  114.         }
  116.         return null;
  117.     }
  118. }