1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
|
<?php
/**
* This file is part of the Nette Framework (https://nette.org)
* Copyright (c) 2004 David Grudl (https://davidgrudl.com)
*/
namespace Nette\Http;
use Nette;
use Nette\Security\IIdentity;
/**
* Session storage for user object.
*/
class UserStorage implements Nette\Security\IUserStorage
{
use Nette\SmartObject;
/** @var string */
private $namespace = '';
/** @var Session */
private $sessionHandler;
/** @var SessionSection */
private $sessionSection;
public function __construct(Session $sessionHandler)
{
$this->sessionHandler = $sessionHandler;
}
/**
* Sets the authenticated status of this user.
* @param bool
* @return self
*/
public function setAuthenticated($state)
{
$section = $this->getSessionSection(TRUE);
$section->authenticated = (bool) $state;
// Session Fixation defence
$this->sessionHandler->regenerateId();
if ($state) {
$section->reason = NULL;
$section->authTime = time(); // informative value
} else {
$section->reason = self::MANUAL;
$section->authTime = NULL;
}
return $this;
}
/**
* Is this user authenticated?
* @return bool
*/
public function isAuthenticated()
{
$session = $this->getSessionSection(FALSE);
return $session && $session->authenticated;
}
/**
* Sets the user identity.
* @return self
*/
public function setIdentity(IIdentity $identity = NULL)
{
$this->getSessionSection(TRUE)->identity = $identity;
return $this;
}
/**
* Returns current user identity, if any.
* @return Nette\Security\IIdentity|NULL
*/
public function getIdentity()
{
$session = $this->getSessionSection(FALSE);
return $session ? $session->identity : NULL;
}
/**
* Changes namespace; allows more users to share a session.
* @param string
* @return self
*/
public function setNamespace($namespace)
{
if ($this->namespace !== $namespace) {
$this->namespace = (string) $namespace;
$this->sessionSection = NULL;
}
return $this;
}
/**
* Returns current namespace.
* @return string
*/
public function getNamespace()
{
return $this->namespace;
}
/**
* Enables log out after inactivity.
* @param string|int|\DateTimeInterface Number of seconds or timestamp
* @param int Log out when the browser is closed | Clear the identity from persistent storage?
* @return self
*/
public function setExpiration($time, $flags = 0)
{
$section = $this->getSessionSection(TRUE);
if ($time) {
$time = Nette\Utils\DateTime::from($time)->format('U');
$section->expireTime = $time;
$section->expireDelta = $time - time();
} else {
unset($section->expireTime, $section->expireDelta);
}
$section->expireIdentity = (bool) ($flags & self::CLEAR_IDENTITY);
$section->expireBrowser = (bool) ($flags & self::BROWSER_CLOSED);
$section->browserCheck = TRUE;
$section->setExpiration(0, 'browserCheck');
$section->setExpiration($time, 'foo'); // time check
return $this;
}
/**
* Why was user logged out?
* @return int|NULL
*/
public function getLogoutReason()
{
$session = $this->getSessionSection(FALSE);
return $session ? $session->reason : NULL;
}
/**
* Returns and initializes $this->sessionSection.
* @return SessionSection
*/
protected function getSessionSection($need)
{
if ($this->sessionSection !== NULL) {
return $this->sessionSection;
}
if (!$need && !$this->sessionHandler->exists()) {
return NULL;
}
$this->sessionSection = $section = $this->sessionHandler->getSection('Nette.Http.UserStorage/' . $this->namespace);
if (!$section->identity instanceof IIdentity || !is_bool($section->authenticated)) {
$section->remove();
}
if ($section->authenticated && $section->expireBrowser && !$section->browserCheck) { // check if browser was closed?
$section->reason = self::BROWSER_CLOSED;
$section->authenticated = FALSE;
if ($section->expireIdentity) {
unset($section->identity);
}
}
if ($section->authenticated && $section->expireDelta > 0) { // check time expiration
if ($section->expireTime < time()) {
$section->reason = self::INACTIVITY;
$section->authenticated = FALSE;
if ($section->expireIdentity) {
unset($section->identity);
}
}
$section->expireTime = time() + $section->expireDelta; // sliding expiration
}
if (!$section->authenticated) {
unset($section->expireTime, $section->expireDelta, $section->expireIdentity,
$section->expireBrowser, $section->browserCheck, $section->authTime);
}
return $this->sessionSection;
}
}
|