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

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\HttpKernel\Event\ControllerEvent;
  11. use Symfony\Component\HttpKernel\Event\RequestEvent;
  12. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  13. use Symfony\Component\Security\Core\Authentication\Token\SwitchUserToken;
  14. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  15. use Symfony\Component\Security\Core\User\UserInterface;
  17. /**
  18.  * This listener ensures that a new {@see \Sentry\State\Scope} is created for
  19.  * each request and that it is filled with useful information, e.g. the IP
  20.  * address of the client.
  21.  */
  22. final class RequestListener
  23. {
  24.     use KernelEventForwardCompatibilityTrait;
  26.     /**
  27.      * @var HubInterface The current hub
  28.      */
  29.     private $hub;
  31.     /**
  32.      * @var TokenStorageInterface|null The token storage
  33.      */
  34.     private $tokenStorage;
  36.     /**
  37.      * Constructor.
  38.      *
  39.      * @param HubInterface               $hub          The current hub
  40.      * @param TokenStorageInterface|null $tokenStorage The token storage
  41.      */
  42.     public function __construct(HubInterface $hub, ?TokenStorageInterface $tokenStorage)
  43.     {
  44.         $this->hub = $hub;
  45.         $this->tokenStorage = $tokenStorage;
  46.     }
  48.     /**
  49.      * This method is called for each request handled by the framework and
  50.      * fills the Sentry scope with information about the current user.
  51.      *
  52.      * @param RequestEvent $event The event
  53.      */
  54.     public function handleKernelRequestEvent(RequestEvent $event): void
  55.     {
  56.         if (!$this->isMainRequest($event)) {
  57.             return;
  58.         }
  60.         $client = $this->hub->getClient();
  62.         if (null === $client || !$client->getOptions()->shouldSendDefaultPii()) {
  63.             return;
  64.         }
  66.         $userData = new UserDataBag();
  67.         $userData->setIpAddress($event->getRequest()->getClientIp());
  69.         if (null !== $this->tokenStorage) {
  70.             $this->setUserData($userData, $this->tokenStorage->getToken());
  71.         }
  73.         $this->hub->configureScope(static function (Scope $scope) use ($userData): void {
  74.             $scope->setUser($userData);
  75.         });
  76.     }
  78.     /**
  79.      * This method is called for each request handled by the framework and
  80.      * sets the route on the current Sentry scope.
  81.      *
  82.      * @param ControllerEvent $event The event
  83.      */
  84.     public function handleKernelControllerEvent(ControllerEvent $event): void
  85.     {
  86.         if (!$this->isMainRequest($event)) {
  87.             return;
  88.         }
  90.         $route = $event->getRequest()->attributes->get('_route');
  92.         if (!\is_string($route)) {
  93.             return;
  94.         }
  96.         $this->hub->configureScope(static function (Scope $scope) use ($route): void {
  97.             $scope->setTag('route', $route);
  98.         });
  99.     }
  101.     /**
  102.      * @param UserInterface|object|string|null $user
  103.      */
  104.     private function getUsername($user): ?string
  105.     {
  106.         if ($user instanceof UserInterface) {
  107.             if (method_exists($user, 'getUserIdentifier')) {
  108.                 return $user->getUserIdentifier();
  109.             }
  111.             if (method_exists($user, 'getUsername')) {
  112.                 return $user->getUsername();
  113.             }
  114.         }
  116.         if (\is_string($user)) {
  117.             return $user;
  118.         }
  120.         if (\is_object($user) && method_exists($user, '__toString')) {
  121.             return (string) $user;
  122.         }
  124.         return null;
  125.     }
  127.     private function getImpersonatorUser(TokenInterface $token): ?string
  128.     {
  129.         if (!$token instanceof SwitchUserToken) {
  130.             return null;
  131.         }
  133.         return $this->getUsername($token->getOriginalToken()->getUser());
  134.     }
  136.     private function setUserData(UserDataBag $userData, ?TokenInterface $token): void
  137.     {
  138.         if (null === $token || !$this->isTokenAuthenticated($token)) {
  139.             return;
  140.         }
  142.         $userData->setUsername($this->getUsername($token->getUser()));
  144.         $impersonatorUser = $this->getImpersonatorUser($token);
  146.         if (null !== $impersonatorUser) {
  147.             $userData->setMetadata('impersonator_username', $impersonatorUser);
  148.         }
  149.     }
  151.     private function isTokenAuthenticated(TokenInterface $token): bool
  152.     {
  153.         if (method_exists($token, 'isAuthenticated') && !$token->isAuthenticated(false)) {
  154.             return false;
  155.         }
  157.         return null !== $token->getUser();
  158.     }
  159. }