host/julienmonnerie
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update to Kirby 4.7.0

Browse source
This commit is contained in:
Paul Nicoué 2025-04-21 18:57:21 +02:00
parent 02a9ab387c
commit ba25a9a198
509 changed files with 26604 additions and 14872 deletions
Download patch file Download diff file Expand all files Collapse all files

109
kirby/src/Session/Sessions.php
View file

@ -21,11 +21,11 @@ use Throwable;
*/
class Sessions
{
protected $store;
protected $mode;
protected $cookieName;
protected SessionStore $store;
protected string $mode;
protected string $cookieName;
protected $cache = [];
protected array $cache = [];
/**
* Creates a new Sessions instance
@ -36,39 +36,30 @@ class Sessions
* - `cookieName`: Name to use for the session cookie; defaults to `kirby_session`
* - `gcInterval`: How often should the garbage collector be run?; integer or `false` for never; defaults to `100`
*/
public function __construct($store, array $options = [])
public function __construct(SessionStore|string $store, array $options = [])
{
if (is_string($store)) {
$this->store = new FileSessionStore($store);
} elseif ($store instanceof SessionStore) {
$this->store = $store;
} else {
throw new InvalidArgumentException([
'data' => ['method' => 'Sessions::__construct', 'argument' => 'store'],
'translate' => false
]);
}
$this->store = match (is_string($store)) {
true => new FileSessionStore($store),
default => $store
};
$this->mode = $options['mode'] ?? 'cookie';
$this->cookieName = $options['cookieName'] ?? 'kirby_session';
$gcInterval = $options['gcInterval'] ?? 100;
// validate options
if (!in_array($this->mode, ['cookie', 'header', 'manual'])) {
if (in_array($this->mode, ['cookie', 'header', 'manual']) === false) {
throw new InvalidArgumentException([
'data' => ['method' => 'Sessions::__construct', 'argument' => '$options[\'mode\']'],
'translate' => false
]);
}
if (!is_string($this->cookieName)) {
throw new InvalidArgumentException([
'data' => ['method' => 'Sessions::__construct', 'argument' => '$options[\'cookieName\']'],
'data' => [
'method' => 'Sessions::__construct',
'argument' => '$options[\'mode\']'
],
'translate' => false
]);
}
// trigger automatic garbage collection with the given probability
if (is_int($gcInterval) && $gcInterval > 0) {
if (is_int($gcInterval) === true && $gcInterval > 0) {
// convert the interval into a probability between 0 and 1
$gcProbability = 1 / $gcInterval;
@ -81,7 +72,10 @@ class Sessions
}
} elseif ($gcInterval !== false) {
throw new InvalidArgumentException([
'data' => ['method' => 'Sessions::__construct', 'argument' => '$options[\'gcInterval\']'],
'data' => [
'method' => 'Sessions::__construct',
'argument' => '$options[\'gcInterval\']'
],
'translate' => false
]);
}
@ -96,9 +90,8 @@ class Sessions
* - `expiryTime`: Time the session expires (date string or timestamp); defaults to `+ 2 hours`
* - `timeout`: Activity timeout in seconds (integer or false for none); defaults to `1800` (half an hour)
* - `renewable`: Should it be possible to extend the expiry date?; defaults to `true`
* @return \Kirby\Session\Session
*/
public function create(array $options = [])
public function create(array $options = []): Session
{
// fall back to default mode
$options['mode'] ??= $this->mode;
@ -110,12 +103,15 @@ class Sessions
* Returns the specified Session object
*
* @param string $token Session token, either including or without the key
* @param string $mode Optional transmission mode override
* @return \Kirby\Session\Session
* @param string|null $mode Optional transmission mode override
*/
public function get(string $token, string $mode = null)
public function get(string $token, string|null $mode = null): Session
{
return $this->cache[$token] ??= new Session($this, $token, ['mode' => $mode ?? $this->mode]);
return $this->cache[$token] ??= new Session(
$this,
$token,
['mode' => $mode ?? $this->mode]
);
}
/**
@ -128,7 +124,7 @@ class Sessions
* @throws \Kirby\Exception\Exception
* @throws \Kirby\Exception\LogicException
*/
public function current()
public function current(): Session|null
{
$token = match ($this->mode) {
'cookie' => $this->tokenFromCookie(),
@ -164,7 +160,7 @@ class Sessions
*
* @return \Kirby\Session\Session|null Either the current session or null in case there isn't one
*/
public function currentDetected()
public function currentDetected(): Session|null
{
$tokenFromHeader = $this->tokenFromHeader();
$tokenFromCookie = $this->tokenFromCookie();
@ -173,13 +169,13 @@ class Sessions
$token = $tokenFromHeader ?? $tokenFromCookie;
// no token was found, no session
if (!is_string($token)) {
if (is_string($token) === false) {
return null;
}
// token was found, try to get the session
try {
$mode = (is_string($tokenFromHeader)) ? 'header' : 'cookie';
$mode = is_string($tokenFromHeader) ? 'header' : 'cookie';
return $this->get($token, $mode);
} catch (Throwable) {
return null;
@ -188,20 +184,16 @@ class Sessions
/**
* Getter for the session store instance
* Used internally
*
* @return \Kirby\Session\SessionStore
* @internal
*/
public function store()
public function store(): SessionStore
{
return $this->store;
}
/**
* Getter for the cookie name
* Used internally
*
* @return string
* @internal
*/
public function cookieName(): string
{
@ -213,10 +205,8 @@ class Sessions
*
* If the `gcInterval` is configured, this is done automatically
* on init of the Sessions object.
*
* @return void
*/
public function collectGarbage()
public function collectGarbage(): void
{
$this->store()->collectGarbage();
}
@ -228,17 +218,15 @@ class Sessions
* @internal
* @param \Kirby\Session\Session $session Session instance to push to the cache
*/
public function updateCache(Session $session)
public function updateCache(Session $session): void
{
$this->cache[$session->token()] = $session;
}
/**
* Returns the auth token from the cookie
*
* @return string|null
*/
protected function tokenFromCookie()
protected function tokenFromCookie(): string|null
{
$value = Cookie::get($this->cookieName());
@ -251,26 +239,23 @@ class Sessions
/**
* Returns the auth token from the Authorization header
*
* @return string|null
*/
protected function tokenFromHeader()
protected function tokenFromHeader(): string|null
{
$request = new Request();
$headers = $request->headers();
// check if the header exists at all
if (isset($headers['Authorization']) === false) {
return null;
if ($header = $headers['Authorization'] ?? null) {
// check if the header uses the "Session" scheme
if (Str::startsWith($header, 'Session ', true) !== true) {
return null;
}
// return the part after the scheme
return substr($header, 8);
}
// check if the header uses the "Session" scheme
$header = $headers['Authorization'];
if (Str::startsWith($header, 'Session ', true) !== true) {
return null;
}
// return the part after the scheme
return substr($header, 8);
return null;
}
}