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

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\Authentication\Token\TokenInterface;
  12. use Symfony\Component\Security\Core\User\UserInterface;
  14. /**
  15.  * This listener ensures that a new {@see \Sentry\State\Scope} is created for
  16.  * each request and that it is filled with useful information, e.g. the IP
  17.  * address of the client.
  18.  */
  19. final class RequestListener
  20. {
  21.     use KernelEventForwardCompatibilityTrait;
  23.     /**
  24.      * @var HubInterface The current hub
  25.      */
  26.     private $hub;
  28.     /**
  29.      * @var TokenStorageInterface|null The token storage
  30.      */
  31.     private $tokenStorage;
  33.     /**
  34.      * Constructor.
  35.      *
  36.      * @param HubInterface               $hub          The current hub
  37.      * @param TokenStorageInterface|null $tokenStorage The token storage
  38.      */
  39.     public function __construct(HubInterface $hub, ?TokenStorageInterface $tokenStorage)
  40.     {
  41.         $this->hub = $hub;
  42.         $this->tokenStorage = $tokenStorage;
  43.     }
  45.     /**
  46.      * This method is called for each request handled by the framework and
  47.      * fills the Sentry scope with information about the current user.
  48.      *
  49.      * @param RequestListenerRequestEvent $event The event
  50.      */
  51.     public function handleKernelRequestEvent(RequestListenerRequestEvent $event): void
  52.     {
  53.         if (!$this->isMainRequest($event)) {
  54.             return;
  55.         }
  57.         $client = $this->hub->getClient();
  59.         if (null === $client || !$client->getOptions()->shouldSendDefaultPii()) {
  60.             return;
  61.         }
  63.         $token = null;
  64.         $userData = new UserDataBag();
  65.         $userData->setIpAddress($event->getRequest()->getClientIp());
  67.         if (null !== $this->tokenStorage) {
  68.             $token = $this->tokenStorage->getToken();
  69.         }
  71.         if ($this->isTokenAuthenticated($token)) {
  72.             $userData->setUsername($this->getUsername($token->getUser()));
  73.         }
  75.         $this->hub->configureScope(static function (Scope $scope) use ($userData): void {
  76.             $scope->setUser($userData);
  77.         });
  78.     }
  80.     /**
  81.      * This method is called for each request handled by the framework and
  82.      * sets the route on the current Sentry scope.
  83.      *
  84.      * @param RequestListenerControllerEvent $event The event
  85.      */
  86.     public function handleKernelControllerEvent(RequestListenerControllerEvent $event): void
  87.     {
  88.         if (!$this->isMainRequest($event)) {
  89.             return;
  90.         }
  92.         $request = $event->getRequest();
  94.         if (!$request->attributes->has('_route')) {
  95.             return;
  96.         }
  98.         $this->hub->configureScope(static function (Scope $scope) use ($request): void {
  99.             $scope->setTag('route', (string) $request->attributes->get('_route'));
  100.         });
  101.     }
  103.     /**
  104.      * @param UserInterface|object|string $user
  105.      */
  106.     private function getUsername($user): ?string
  107.     {
  108.         if ($user instanceof UserInterface) {
  109.             if (method_exists($user, 'getUserIdentifier')) {
  110.                 return $user->getUserIdentifier();
  111.             }
  113.             if (method_exists($user, 'getUsername')) {
  114.                 return $user->getUsername();
  115.             }
  116.         }
  118.         if (\is_string($user)) {
  119.             return $user;
  120.         }
  122.         if (\is_object($user) && method_exists($user, '__toString')) {
  123.             return (string) $user;
  124.         }
  126.         return null;
  127.     }
  129.     private function isTokenAuthenticated(?TokenInterface $token): bool
  130.     {
  131.         if (null === $token) {
  132.             return false;
  133.         }
  135.         if (method_exists($token, 'isAuthenticated') && !$token->isAuthenticated(false)) {
  136.             return false;
  137.         }
  139.         return null !== $token->getUser();
  140.     }
  141. }