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

Open in your IDE?
  1. <?php
  3. namespace Sentry\SentryBundle\EventListener;
  5. use Sentry\SentrySdk;
  6. use Sentry\State\HubInterface;
  7. use Sentry\State\Scope;
  8. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  9. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  10. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  11. use Symfony\Component\HttpKernel\Event\RequestEvent;
  12. use Symfony\Component\HttpKernel\Kernel;
  13. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  14. use Symfony\Component\Security\Core\User\UserInterface;
  16. if (Kernel::MAJOR_VERSION >= 5) {
  17.     class_alias(RequestEvent::class, RequestListenerRequestEvent::class);
  18.     class_alias(ControllerEvent::class, RequestListenerControllerEvent::class);
  19. } else {
  20.     class_alias(GetResponseEvent::class, RequestListenerRequestEvent::class);
  21.     class_alias(FilterControllerEvent::class, RequestListenerControllerEvent::class);
  22. }
  24. /**
  25.  * Class RequestListener
  26.  * @package Sentry\SentryBundle\EventListener
  27.  */
  28. final class RequestListener
  29. {
  30.     /** @var HubInterface */
  31.     private $hub;
  33.     /** @var TokenStorageInterface|null */
  34.     private $tokenStorage;
  36.     /**
  37.      * RequestListener constructor.
  38.      * @param HubInterface $hub
  39.      * @param TokenStorageInterface|null $tokenStorage
  40.      */
  41.     public function __construct(
  42.         HubInterface $hub,
  43.         ?TokenStorageInterface $tokenStorage
  44.     ) {
  45.         $this->hub = $hub; // not used, needed to trigger instantiation
  46.         $this->tokenStorage = $tokenStorage;
  47.     }
  49.     /**
  50.      * Set the username from the security context by listening on core.request
  51.      *
  52.      * @param RequestListenerRequestEvent $event
  53.      */
  54.     public function onKernelRequest(RequestListenerRequestEvent $event): void
  55.     {
  56.         if (! $event->isMasterRequest()) {
  57.             return;
  58.         }
  60.         $currentClient = SentrySdk::getCurrentHub()->getClient();
  61.         if (null === $currentClient || ! $currentClient->getOptions()->shouldSendDefaultPii()) {
  62.             return;
  63.         }
  65.         $token = null;
  67.         if ($this->tokenStorage instanceof TokenStorageInterface) {
  68.             $token = $this->tokenStorage->getToken();
  69.         }
  71.         $userData = [];
  73.         if (
  74.             null !== $token
  75.             && $token->isAuthenticated()
  76.             && $token->getUser()
  77.         ) {
  78.             $userData = $this->getUserData($token->getUser());
  79.         }
  81.         $userData['ip_address'] = $event->getRequest()->getClientIp();
  83.         SentrySdk::getCurrentHub()
  84.             ->configureScope(function (Scope $scope) use ($userData): void {
  85.                 $scope->setUser($userData, true);
  86.             });
  87.     }
  89.     public function onKernelController(RequestListenerControllerEvent $event): void
  90.     {
  91.         if (! $event->isMasterRequest()) {
  92.             return;
  93.         }
  95.         if (! $event->getRequest()->attributes->has('_route')) {
  96.             return;
  97.         }
  99.         $matchedRoute = (string) $event->getRequest()->attributes->get('_route');
  101.         SentrySdk::getCurrentHub()
  102.             ->configureScope(function (Scope $scope) use ($matchedRoute): void {
  103.                 $scope->setTag('route', $matchedRoute);
  104.             });
  105.     }
  107.     /**
  108.      * @param UserInterface | object | string $user
  109.      * @return array<string, string>
  110.      */
  111.     private function getUserData($user): array
  112.     {
  113.         if ($user instanceof UserInterface) {
  114.             return [
  115.                 'username' => $user->getUsername(),
  116.             ];
  117.         }
  119.         if (is_string($user)) {
  120.             return [
  121.                 'username' => $user,
  122.             ];
  123.         }
  125.         if (is_object($user) && method_exists($user, '__toString')) {
  126.             return [
  127.                 'username' => $user->__toString(),
  128.             ];
  129.         }
  131.         return [];
  132.     }
  133. }