vendor/symfony/security-core/Authentication/Token/Storage/UsageTrackingTokenStorage.php line 44

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Core\Authentication\Token\Storage;
  14. use Psr\Container\ContainerInterface;
  15. use Symfony\Component\HttpFoundation\RequestStack;
  16. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  17. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  18. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  20. /**
  21.  * A token storage that increments the session usage index when the token is accessed.
  22.  *
  23.  * @author Nicolas Grekas <p@tchwork.com>
  24.  */
  25. final class UsageTrackingTokenStorage implements TokenStorageInterface, ServiceSubscriberInterface
  26. {
  27.     private $storage;
  28.     private $container;
  29.     private $enableUsageTracking = false;
  31.     public function __construct(TokenStorageInterface $storage, ContainerInterface $container)
  32.     {
  33.         $this->storage = $storage;
  34.         $this->container = $container;
  35.     }
  37.     /**
  38.      * {@inheritdoc}
  39.      */
  40.     public function getToken(): ?TokenInterface
  41.     {
  42.         if ($this->shouldTrackUsage()) {
  43.             // increments the internal session usage index
  44.             $this->getSession()->getMetadataBag();
  45.         }
  47.         return $this->storage->getToken();
  48.     }
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function setToken(?TokenInterface $token = null): void
  54.     {
  55.         $this->storage->setToken($token);
  57.         if ($token && $this->shouldTrackUsage()) {
  58.             // increments the internal session usage index
  59.             $this->getSession()->getMetadataBag();
  60.         }
  61.     }
  63.     public function enableUsageTracking(): void
  64.     {
  65.         $this->enableUsageTracking = true;
  66.     }
  68.     public function disableUsageTracking(): void
  69.     {
  70.         $this->enableUsageTracking = false;
  71.     }
  73.     public static function getSubscribedServices(): array
  74.     {
  75.         return [
  76.             'request_stack' => RequestStack::class,
  77.         ];
  78.     }
  80.     private function getSession(): SessionInterface
  81.     {
  82.         // BC for symfony/security-bundle < 5.3
  83.         if ($this->container->has('session')) {
  84.             trigger_deprecation('symfony/security-core', '5.3', 'Injecting the "session" in "%s" is deprecated, inject the "request_stack" instead.', __CLASS__);
  86.             return $this->container->get('session');
  87.         }
  89.         return $this->container->get('request_stack')->getSession();
  90.     }
  92.     private function shouldTrackUsage(): bool
  93.     {
  94.         if (!$this->enableUsageTracking) {
  95.             return false;
  96.         }
  98.         // BC for symfony/security-bundle < 5.3
  99.         if ($this->container->has('session')) {
  100.             return true;
  101.         }
  103.         if (!$this->container->get('request_stack')->getMainRequest()) {
  104.             return false;
  105.         }
  107.         return true;
  108.     }
  109. }