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

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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 <[email protected]>
  24.  */
  25. final class UsageTrackingTokenStorage implements TokenStorageInterface, ServiceSubscriberInterface
  26. {
  27.     private TokenStorageInterface $storage;
  28.     private ContainerInterface $container;
  29.     private bool $enableUsageTracking = false;
  31.     public function __construct(TokenStorageInterface $storage, ContainerInterface $container)
  32.     {
  33.         $this->storage = $storage;
  34.         $this->container = $container;
  35.     }
  37.     public function getToken(): ?TokenInterface
  38.     {
  39.         if ($this->shouldTrackUsage()) {
  40.             // increments the internal session usage index
  41.             $this->getSession()->getMetadataBag();
  42.         }
  44.         return $this->storage->getToken();
  45.     }
  47.     public function setToken(TokenInterface $token = null): void
  48.     {
  49.         $this->storage->setToken($token);
  51.         if ($token && $this->shouldTrackUsage()) {
  52.             // increments the internal session usage index
  53.             $this->getSession()->getMetadataBag();
  54.         }
  55.     }
  57.     public function enableUsageTracking(): void
  58.     {
  59.         $this->enableUsageTracking = true;
  60.     }
  62.     public function disableUsageTracking(): void
  63.     {
  64.         $this->enableUsageTracking = false;
  65.     }
  67.     public static function getSubscribedServices(): array
  68.     {
  69.         return [
  70.             'request_stack' => RequestStack::class,
  71.         ];
  72.     }
  74.     private function getSession(): SessionInterface
  75.     {
  76.         return $this->container->get('request_stack')->getSession();
  77.     }
  79.     private function shouldTrackUsage(): bool
  80.     {
  81.         return $this->enableUsageTracking && $this->container->get('request_stack')->getMainRequest();
  82.     }
  83. }