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

Open in your IDE?
  1. <?php
  3. namespace Sentry\SentryBundle\EventListener;
  5. use Sentry\State\Hub;
  6. use Sentry\State\HubInterface;
  7. use Sentry\State\Scope;
  8. use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
  9. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  10. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  11. use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
  12. use Symfony\Component\Security\Core\Authorization\Voter\AuthenticatedVoter;
  13. use Symfony\Component\Security\Core\User\UserInterface;
  15. /**
  16.  * Class RequestListener
  17.  * @package Sentry\SentryBundle\EventListener
  18.  */
  19. final class RequestListener
  20. {
  21.     /** @var HubInterface */
  22.     private $hub;
  24.     /** @var TokenStorageInterface|null */
  25.     private $tokenStorage;
  27.     /** @var AuthorizationCheckerInterface|null */
  28.     private $authorizationChecker;
  30.     /**
  31.      * RequestListener constructor.
  32.      * @param HubInterface $hub
  33.      * @param TokenStorageInterface|null $tokenStorage
  34.      * @param AuthorizationCheckerInterface|null $authorizationChecker
  35.      */
  36.     public function __construct(
  37.         HubInterface $hub,
  38.         ?TokenStorageInterface $tokenStorage,
  39.         ?AuthorizationCheckerInterface $authorizationChecker
  40.     ) {
  41.         $this->hub = $hub; // not used, needed to trigger instantiation
  42.         $this->tokenStorage = $tokenStorage;
  43.         $this->authorizationChecker = $authorizationChecker;
  44.     }
  46.     /**
  47.      * Set the username from the security context by listening on core.request
  48.      *
  49.      * @param GetResponseEvent $event
  50.      */
  51.     public function onKernelRequest(GetResponseEvent $event): void
  52.     {
  53.         if (! $event->isMasterRequest()) {
  54.             return;
  55.         }
  57.         $currentClient = Hub::getCurrent()->getClient();
  58.         if (null === $currentClient || ! $currentClient->getOptions()->shouldSendDefaultPii()) {
  59.             return;
  60.         }
  62.         $token = null;
  64.         if ($this->tokenStorage instanceof TokenStorageInterface) {
  65.             $token = $this->tokenStorage->getToken();
  66.         }
  68.         if (
  69.             null !== $token
  70.             && null !== $this->authorizationChecker
  71.             && $token->isAuthenticated()
  72.             && $this->authorizationChecker->isGranted(AuthenticatedVoter::IS_AUTHENTICATED_REMEMBERED)
  73.         ) {
  74.             $userData = $this->getUserData($token->getUser());
  75.         }
  77.         $userData['ip_address'] = $event->getRequest()->getClientIp();
  79.         Hub::getCurrent()
  80.             ->configureScope(function (Scope $scope) use ($userData): void {
  81.                 $scope->setUser($userData);
  82.             });
  83.     }
  85.     public function onKernelController(FilterControllerEvent $event): void
  86.     {
  87.         if (! $event->isMasterRequest()) {
  88.             return;
  89.         }
  91.         $matchedRoute = $event->getRequest()->attributes->get('_route');
  93.         Hub::getCurrent()
  94.             ->configureScope(function (Scope $scope) use ($matchedRoute): void {
  95.                 $scope->setTag('route', $matchedRoute);
  96.             });
  97.     }
  99.     /**
  100.      * @param UserInterface | object | string $user
  101.      */
  102.     private function getUserData($user): array
  103.     {
  104.         if ($user instanceof UserInterface) {
  105.             return [
  106.                 'username' => $user->getUsername(),
  107.             ];
  108.         }
  110.         if (is_string($user)) {
  111.             return [
  112.                 'username' => $user,
  113.             ];
  114.         }
  116.         if (is_object($user) && method_exists($user, '__toString')) {
  117.             return [
  118.                 'username' => $user->__toString(),
  119.             ];
  120.         }
  122.         return [];
  123.     }
  124. }