vendor/se7enxweb/legacy-bridge/mvc/Session/LegacySessionStorage.php line 136

Open in your IDE?
  1. <?php
  3. /**
  4. * @copyright Copyright (C) eZ Systems AS. All rights reserved.
  5. * @license For full copyright and license information view LICENSE file distributed with this source code.
  6. */
  7. namespace eZ\Publish\Core\MVC\Legacy\Session;
  9. use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
  10. use Symfony\Component\HttpFoundation\Session\Storage\MetadataBag;
  11. use Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage;
  12. use Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface;
  13. use ezpEvent;
  14. use eZSession;
  15. use eZDB;
  16. use Closure;
  18. /**
  19. * Session storage proxy for legacy.
  20. * Ensures that appropriate legacy session events are triggered whenever needed.
  21. *
  22. * Note that it extends NativeSessionStorage. This is only a workaround to strictly respect its full interface, as it
  23. * has methods that are not part of an interface.
  24. * See https://jira.ez.no/browse/EZP-24017
  25. */
  26. class LegacySessionStorage extends NativeSessionStorage
  27. {
  28. /**
  29. * @var SessionStorageInterface|NativeSessionStorage
  30. */
  31. private $innerSessionStorage;
  33. /**
  34. * @var callable
  35. */
  36. private $legacyKernelClosure;
  38. public function __construct(Closure $legacyKernelClosure, SessionStorageInterface $innerSessionStorage)
  39. {
  40. $this->innerSessionStorage = $innerSessionStorage;
  41. $this->legacyKernelClosure = $legacyKernelClosure;
  42. }
  44. public function start()
  45. {
  46. return $this->innerSessionStorage->start();
  47. }
  49. public function isStarted()
  50. {
  51. return $this->innerSessionStorage->isStarted();
  52. }
  54. public function getId()
  55. {
  56. return $this->innerSessionStorage->getId();
  57. }
  59. public function setId($id)
  60. {
  61. $this->innerSessionStorage->setId($id);
  62. }
  64. public function getName()
  65. {
  66. return $this->innerSessionStorage->getName();
  67. }
  69. public function setName($name)
  70. {
  71. $this->innerSessionStorage->setName($name);
  72. }
  74. /**
  75. * Ensures appropriate legacy events are sent when migrating the session.
  76. *
  77. * {@inheritdoc}
  78. */
  79. public function regenerate($destroy = false, $lifetime = null)
  80. {
  81. $oldSessionId = $this->getId();
  82. $success = $this->innerSessionStorage->regenerate($destroy, $lifetime);
  83. $newSessionId = $this->getId();
  85. // Callbacks cannot be called once the session is destroyed.
  86. if ($success && !$destroy) {
  87. $kernelClosure = $this->legacyKernelClosure;
  88. $kernelClosure()->runCallback(
  89. static function () use ($oldSessionId, $newSessionId) {
  90. ezpEvent::getInstance()->notify('session/regenerate', [$oldSessionId, $newSessionId]);
  91. $db = eZDB::instance();
  92. $escOldKey = $db->escapeString($oldSessionId);
  93. $escNewKey = $db->escapeString($newSessionId);
  94. $escUserID = $db->escapeString(eZSession::userID());
  95. eZSession::triggerCallback('regenerate_pre', [$db, $escNewKey, $escOldKey, $escUserID]);
  96. eZSession::triggerCallback('regenerate_post', [$db, $escNewKey, $escOldKey, $escUserID]);
  97. },
  98. false,
  99. false
  100. );
  101. }
  103. return $success;
  104. }
  106. public function save()
  107. {
  108. $this->innerSessionStorage->save();
  109. }
  111. /**
  112. * Clear all session data in memory.
  113. */
  114. public function clear()
  115. {
  116. $this->innerSessionStorage->clear();
  117. }
  119. public function getBag($name)
  120. {
  121. return $this->innerSessionStorage->getBag($name);
  122. }
  124. public function registerBag(SessionBagInterface $bag)
  125. {
  126. $this->innerSessionStorage->registerBag($bag);
  127. }
  129. public function getMetadataBag()
  130. {
  131. return $this->innerSessionStorage->getMetadataBag();
  132. }
  134. // Below reimplementation of public methods from NativeSessionStorage.
  136. public function setMetadataBag(MetadataBag $metaBag = null)
  137. {
  138. if ($this->innerSessionStorage instanceof NativeSessionStorage) {
  139. $this->innerSessionStorage->setMetadataBag($metaBag);
  140. }
  141. }
  143. public function getSaveHandler()
  144. {
  145. if ($this->innerSessionStorage instanceof NativeSessionStorage) {
  146. return $this->innerSessionStorage->getSaveHandler();
  147. }
  148. }
  150. public function setSaveHandler($saveHandler = null)
  151. {
  152. if ($this->innerSessionStorage instanceof NativeSessionStorage) {
  153. $this->innerSessionStorage->setSaveHandler($saveHandler);
  154. }
  155. }
  157. public function setOptions(array $options)
  158. {
  159. if ($this->innerSessionStorage instanceof NativeSessionStorage) {
  160. $this->innerSessionStorage->setOptions($options);
  161. }
  162. }
  163. }