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 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. // reading the token can enable usage tracking, e.g. when a lazy firewall loads it from the session
  40. $token = $this->storage->getToken();
  42. if ($this->shouldTrackUsage()) {
  43. // increments the internal session usage index
  44. $this->getSession()->getMetadataBag();
  45. }
  47. return $token;
  48. }
  50. public function setToken(?TokenInterface $token = null): void
  51. {
  52. $this->storage->setToken($token);
  54. if ($token && $this->shouldTrackUsage()) {
  55. // increments the internal session usage index
  56. $this->getSession()->getMetadataBag();
  57. }
  58. }
  60. public function enableUsageTracking(): void
  61. {
  62. $this->enableUsageTracking = true;
  63. }
  65. public function disableUsageTracking(): void
  66. {
  67. $this->enableUsageTracking = false;
  68. }
  70. public static function getSubscribedServices(): array
  71. {
  72. return [
  73. 'request_stack' => RequestStack::class,
  74. ];
  75. }
  77. private function getSession(): SessionInterface
  78. {
  79. return $this->container->get('request_stack')->getSession();
  80. }
  82. private function shouldTrackUsage(): bool
  83. {
  84. return $this->enableUsageTracking && $this->container->get('request_stack')->getMainRequest();
  85. }
  86. }