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

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.     use KernelEventForwardCompatibilityTrait;
  22.     /**
  23.      * @var HubInterface The current hub
  24.      */
  25.     private $hub;
  27.     /**
  28.      * @var TokenStorageInterface|null The token storage
  29.      */
  30.     private $tokenStorage;
  32.     /**
  33.      * Constructor.
  34.      *
  35.      * @param HubInterface               $hub          The current hub
  36.      * @param TokenStorageInterface|null $tokenStorage The token storage
  37.      */
  38.     public function __construct(HubInterface $hub, ?TokenStorageInterface $tokenStorage)
  39.     {
  40.         $this->hub = $hub;
  41.         $this->tokenStorage = $tokenStorage;
  42.     }
  44.     /**
  45.      * This method is called for each request handled by the framework and
  46.      * fills the Sentry scope with information about the current user.
  47.      *
  48.      * @param RequestListenerRequestEvent $event The event
  49.      */
  50.     public function handleKernelRequestEvent(RequestListenerRequestEvent $event): void
  51.     {
  52.         if (!$this->isMainRequest($event)) {
  53.             return;
  54.         }
  56.         $client = $this->hub->getClient();
  58.         if (null === $client || !$client->getOptions()->shouldSendDefaultPii()) {
  59.             return;
  60.         }
  62.         $token = null;
  63.         $userData = new UserDataBag();
  64.         $userData->setIpAddress($event->getRequest()->getClientIp());
  66.         if (null !== $this->tokenStorage) {
  67.             $token = $this->tokenStorage->getToken();
  68.         }
  70.         if (null !== $token && $token->isAuthenticated() && null !== $token->getUser()) {
  71.             $userData->setUsername($this->getUsername($token->getUser()));
  72.         }
  74.         $this->hub->configureScope(static function (Scope $scope) use ($userData): void {
  75.             $scope->setUser($userData);
  76.         });
  77.     }
  79.     /**
  80.      * This method is called for each request handled by the framework and
  81.      * sets the route on the current Sentry scope.
  82.      *
  83.      * @param RequestListenerControllerEvent $event The event
  84.      */
  85.     public function handleKernelControllerEvent(RequestListenerControllerEvent $event): void
  86.     {
  87.         if (!$this->isMainRequest($event)) {
  88.             return;
  89.         }
  91.         $request = $event->getRequest();
  93.         if (!$request->attributes->has('_route')) {
  94.             return;
  95.         }
  97.         $this->hub->configureScope(static function (Scope $scope) use ($request): void {
  98.             $scope->setTag('route', (string) $request->attributes->get('_route'));
  99.         });
  100.     }
  102.     /**
  103.      * @param UserInterface|object|string $user
  104.      */
  105.     private function getUsername($user): ?string
  106.     {
  107.         if ($user instanceof UserInterface) {
  108.             if (method_exists($user, 'getUserIdentifier')) {
  109.                 return $user->getUserIdentifier();
  110.             }
  112.             if (method_exists($user, 'getUsername')) {
  113.                 return $user->getUsername();
  114.             }
  115.         }
  117.         if (\is_string($user)) {
  118.             return $user;
  119.         }
  121.         if (\is_object($user) && method_exists($user, '__toString')) {
  122.             return (string) $user;
  123.         }
  125.         return null;
  126.     }
  127. }