AbstractSessionHandler.php 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\HttpFoundation\Session\Storage\Handler;
  11. use Symfony\Component\HttpFoundation\Session\SessionUtils;
  12. /**
  13. * This abstract session handler provides a generic implementation
  14. * of the PHP 7.0 SessionUpdateTimestampHandlerInterface,
  15. * enabling strict and lazy session handling.
  16. *
  17. * @author Nicolas Grekas <p@tchwork.com>
  18. */
  19. abstract class AbstractSessionHandler implements \SessionHandlerInterface, \SessionUpdateTimestampHandlerInterface
  20. {
  21. private $sessionName;
  22. private $prefetchId;
  23. private $prefetchData;
  24. private $newSessionId;
  25. private $igbinaryEmptyData;
  26. /**
  27. * @return bool
  28. */
  29. public function open($savePath, $sessionName)
  30. {
  31. $this->sessionName = $sessionName;
  32. if (!headers_sent() && !ini_get('session.cache_limiter') && '0' !== ini_get('session.cache_limiter')) {
  33. header(sprintf('Cache-Control: max-age=%d, private, must-revalidate', 60 * (int) ini_get('session.cache_expire')));
  34. }
  35. return true;
  36. }
  37. /**
  38. * @param string $sessionId
  39. *
  40. * @return string
  41. */
  42. abstract protected function doRead($sessionId);
  43. /**
  44. * @param string $sessionId
  45. * @param string $data
  46. *
  47. * @return bool
  48. */
  49. abstract protected function doWrite($sessionId, $data);
  50. /**
  51. * @param string $sessionId
  52. *
  53. * @return bool
  54. */
  55. abstract protected function doDestroy($sessionId);
  56. /**
  57. * @return bool
  58. */
  59. public function validateId($sessionId)
  60. {
  61. $this->prefetchData = $this->read($sessionId);
  62. $this->prefetchId = $sessionId;
  63. return '' !== $this->prefetchData;
  64. }
  65. /**
  66. * @return string
  67. */
  68. public function read($sessionId)
  69. {
  70. if (null !== $this->prefetchId) {
  71. $prefetchId = $this->prefetchId;
  72. $prefetchData = $this->prefetchData;
  73. $this->prefetchId = $this->prefetchData = null;
  74. if ($prefetchId === $sessionId || '' === $prefetchData) {
  75. $this->newSessionId = '' === $prefetchData ? $sessionId : null;
  76. return $prefetchData;
  77. }
  78. }
  79. $data = $this->doRead($sessionId);
  80. $this->newSessionId = '' === $data ? $sessionId : null;
  81. if (\PHP_VERSION_ID < 70000) {
  82. $this->prefetchData = $data;
  83. }
  84. return $data;
  85. }
  86. /**
  87. * @return bool
  88. */
  89. public function write($sessionId, $data)
  90. {
  91. if (\PHP_VERSION_ID < 70000 && $this->prefetchData) {
  92. $readData = $this->prefetchData;
  93. $this->prefetchData = null;
  94. if ($readData === $data) {
  95. return $this->updateTimestamp($sessionId, $data);
  96. }
  97. }
  98. if (null === $this->igbinaryEmptyData) {
  99. // see https://github.com/igbinary/igbinary/issues/146
  100. $this->igbinaryEmptyData = \function_exists('igbinary_serialize') ? igbinary_serialize([]) : '';
  101. }
  102. if ('' === $data || $this->igbinaryEmptyData === $data) {
  103. return $this->destroy($sessionId);
  104. }
  105. $this->newSessionId = null;
  106. return $this->doWrite($sessionId, $data);
  107. }
  108. /**
  109. * @return bool
  110. */
  111. public function destroy($sessionId)
  112. {
  113. if (\PHP_VERSION_ID < 70000) {
  114. $this->prefetchData = null;
  115. }
  116. if (!headers_sent() && filter_var(ini_get('session.use_cookies'), FILTER_VALIDATE_BOOLEAN)) {
  117. if (!$this->sessionName) {
  118. throw new \LogicException(sprintf('Session name cannot be empty, did you forget to call "parent::open()" in "%s"?.', static::class));
  119. }
  120. $cookie = SessionUtils::popSessionCookie($this->sessionName, $sessionId);
  121. /*
  122. * We send an invalidation Set-Cookie header (zero lifetime)
  123. * when either the session was started or a cookie with
  124. * the session name was sent by the client (in which case
  125. * we know it's invalid as a valid session cookie would've
  126. * started the session).
  127. */
  128. if (null === $cookie || isset($_COOKIE[$this->sessionName])) {
  129. if (\PHP_VERSION_ID < 70300) {
  130. setcookie($this->sessionName, '', 0, ini_get('session.cookie_path'), ini_get('session.cookie_domain'), filter_var(ini_get('session.cookie_secure'), FILTER_VALIDATE_BOOLEAN), filter_var(ini_get('session.cookie_httponly'), FILTER_VALIDATE_BOOLEAN));
  131. } else {
  132. $params = session_get_cookie_params();
  133. unset($params['lifetime']);
  134. setcookie($this->sessionName, '', $params);
  135. }
  136. }
  137. }
  138. return $this->newSessionId === $sessionId || $this->doDestroy($sessionId);
  139. }
  140. }