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

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.     if (! class_exists(RequestListenerRequestEvent::class, false)) {
  18.         class_alias(RequestEvent::class, RequestListenerRequestEvent::class);
  19.     }
  20.     if (! class_exists(RequestListenerControllerEvent::class, false)) {
  21.         class_alias(ControllerEvent::class, RequestListenerControllerEvent::class);
  22.     }
  23. } else {
  24.     if (! class_exists(RequestListenerRequestEvent::class, false)) {
  25.         class_alias(GetResponseEvent::class, RequestListenerRequestEvent::class);
  26.     }
  27.     if (! class_exists(RequestListenerControllerEvent::class, false)) {
  28.         class_alias(FilterControllerEvent::class, RequestListenerControllerEvent::class);
  29.     }
  30. }
  32. /**
  33.  * Class RequestListener
  34.  * @package Sentry\SentryBundle\EventListener
  35.  */
  36. final class RequestListener
  37. {
  38.     /** @var HubInterface */
  39.     private $hub;
  41.     /** @var TokenStorageInterface|null */
  42.     private $tokenStorage;
  44.     /**
  45.      * RequestListener constructor.
  46.      * @param HubInterface $hub
  47.      * @param TokenStorageInterface|null $tokenStorage
  48.      */
  49.     public function __construct(
  50.         HubInterface $hub,
  51.         ?TokenStorageInterface $tokenStorage
  52.     ) {
  53.         $this->hub = $hub; // not used, needed to trigger instantiation
  54.         $this->tokenStorage = $tokenStorage;
  55.     }
  57.     /**
  58.      * Set the username from the security context by listening on core.request
  59.      *
  60.      * @param RequestListenerRequestEvent $event
  61.      */
  62.     public function onKernelRequest(RequestListenerRequestEvent $event): void
  63.     {
  64.         if (! $event->isMasterRequest()) {
  65.             return;
  66.         }
  68.         $currentClient = SentrySdk::getCurrentHub()->getClient();
  69.         if (null === $currentClient || ! $currentClient->getOptions()->shouldSendDefaultPii()) {
  70.             return;
  71.         }
  73.         $token = null;
  75.         if ($this->tokenStorage instanceof TokenStorageInterface) {
  76.             $token = $this->tokenStorage->getToken();
  77.         }
  79.         $userData = [];
  81.         if (
  82.             null !== $token
  83.             && $token->isAuthenticated()
  84.             && $token->getUser()
  85.         ) {
  86.             $userData = $this->getUserData($token->getUser());
  87.         }
  89.         $userData['ip_address'] = $event->getRequest()->getClientIp();
  91.         SentrySdk::getCurrentHub()
  92.             ->configureScope(function (Scope $scope) use ($userData): void {
  93.                 $scope->setUser($userData, true);
  94.             });
  95.     }
  97.     public function onKernelController(RequestListenerControllerEvent $event): void
  98.     {
  99.         if (! $event->isMasterRequest()) {
  100.             return;
  101.         }
  103.         if (! $event->getRequest()->attributes->has('_route')) {
  104.             return;
  105.         }
  107.         $matchedRoute = (string) $event->getRequest()->attributes->get('_route');
  109.         SentrySdk::getCurrentHub()
  110.             ->configureScope(function (Scope $scope) use ($matchedRoute): void {
  111.                 $scope->setTag('route', $matchedRoute);
  112.             });
  113.     }
  115.     /**
  116.      * @param UserInterface | object | string $user
  117.      * @return array<string, string>
  118.      */
  119.     private function getUserData($user): array
  120.     {
  121.         if ($user instanceof UserInterface) {
  122.             return [
  123.                 'username' => $user->getUsername(),
  124.             ];
  125.         }
  127.         if (is_string($user)) {
  128.             return [
  129.                 'username' => $user,
  130.             ];
  131.         }
  133.         if (is_object($user) && method_exists($user, '__toString')) {
  134.             return [
  135.                 'username' => $user->__toString(),
  136.             ];
  137.         }
  139.         return [];
  140.     }
  141. }