MediaWiki\Session\SessionBackend Class Reference

This is the actual workhorse for Session. More...

Collaboration diagram for MediaWiki\Session\SessionBackend:

Public Member Functions
	__construct (SessionId $id, SessionInfo $info, CachedBagOStuff $store, LoggerInterface $logger, $lifetime)
	addData (array $newData)
	Add data to the session. More...
	canSetUser ()
	Indicate whether the session user info can be changed. More...
	delaySave ()
	Delay automatic saving while multiple updates are being made. More...
	deregisterSession ($index)
	Deregister a Session. More...
	dirty ()
	Mark data as dirty. More...
	getAllowedUserRights ()
	Fetch the rights allowed the user when this session is active. More...
&	getData ()
	Fetch the session data array. More...
	getId ()
	Returns the session ID. More...
	getLoggedOutTimestamp ()
	Fetch the "logged out" timestamp. More...
	getProvider ()
	Fetch the SessionProvider for this session. More...
	getProviderMetadata ()
	Fetch provider metadata. More...
	getRequest ($index)
	Returns the request associated with a Session. More...
	getSession (WebRequest $request)
	Return a new Session for this backend. More...
	getSessionId ()
	Fetch the SessionId object. More...
	getUser ()
	Returns the authenticated user for this session. More...
	isPersistent ()
	Indicate whether this session is persisted across requests. More...
	persist ()
	Make this session persisted across requests. More...
	renew ()
	Renew the session by resaving everything. More...
	resetId ()
	Changes the session ID. More...
	save ($closing=false)
	Save the session. More...
	setForceHTTPS ($force)
	Set whether HTTPS should be forced. More...
	setLoggedOutTimestamp ($ts=null)
	Set the "logged out" timestamp. More...
	setProviderMetadata ($metadata)
	Set provider metadata. More...
	setRememberUser ($remember)
	Set whether the user should be remembered independently of the session ID. More...
	setUser ($user)
	Set a new user for this session. More...
	shouldForceHTTPS ()
	Whether HTTPS should be forced. More...
	shouldRememberUser ()
	Indicate whether the user should be remembered independently of the session ID. More...
	shutdown ()
	Shut down a session. More...
	suggestLoginUsername ($index)
	Get a suggested username for the login form. More...
	unpersist ()
	Make this session not persisted across requests. More...

Private Member Functions
	autosave ()
	Save the session, unless delayed. More...
	checkPHPSession ()
	For backwards compatibility, open the PHP session when the global session is persisted. More...

Private Attributes
	$checkPHPSessionRecursionGuard = false
	$curIndex = 0
array null	$data = null
	$dataDirty = false
string	$dataHash = null
	Used to detect subarray modifications. More...
	$delaySave = 0
	$expires = 0
	$forceHTTPS = false
	$forcePersist = false
SessionId	$id
int	$lifetime
	$loggedOut = 0
LoggerInterface	$logger
	$metaDirty = false
	$persist = false
SessionProvider	$provider
	provider More...
array null	$providerMetadata = null
	provider-specified metadata More...
	$remember = false
WebRequest[]	$requests = []
	Session requests. More...
	$shutdown = false
CachedBagOStuff	$store
	$usePhpSessionHandling = true
User	$user

Detailed Description

This is the actual workhorse for Session.

Most code does not need to use this class, you want \MediaWiki\Session\Session. The exceptions are SessionProviders and SessionMetadata hook functions, which get an instance of this class rather than Session.

The reasons for this split are:

1. A session can be attached to multiple requests, but we want the Session object to have some features that correspond to just one of those requests.
2. We want reasonable garbage collection behavior, but we also want the SessionManager to hold a reference to every active session so it can be saved when the request ends.

Since

1.27

Definition at line 49 of file SessionBackend.php.

Constructor & Destructor Documentation

MediaWiki\Session\SessionBackend::__construct	(	SessionId	$id,
		SessionInfo	$info,
		CachedBagOStuff	$store,
		LoggerInterface	$logger,
			$lifetime
	)

Parameters

SessionId	$id	Session ID object
SessionInfo	$info	Session info to populate from
CachedBagOStuff	$store	Backend data store
LoggerInterface	$logger
int	$lifetime	Session data lifetime in seconds

Definition at line 106 of file SessionBackend.php.

References $blob, MediaWiki\Session\SessionBackend\$id, MediaWiki\Session\SessionBackend\$lifetime, MediaWiki\Session\SessionBackend\$logger, MediaWiki\Session\SessionBackend\$store, data, MediaWiki\Session\SessionInfo\forceHTTPS(), BagOStuff\get(), MediaWiki\Session\SessionId\getId(), MediaWiki\Session\SessionInfo\getId(), RequestContext\getMain(), MediaWiki\Session\SessionInfo\getProvider(), MediaWiki\Session\SessionInfo\getProviderMetadata(), MediaWiki\Session\SessionInfo\getUserInfo(), MediaWiki\Session\SessionBackend\persist(), serialize(), store, user, User, MediaWiki\Session\SessionInfo\wasPersisted(), MediaWiki\Session\SessionInfo\wasRemembered(), and wfMemcKey().

Member Function Documentation

MediaWiki\Session\SessionBackend::addData

(

array

$newData

)

Add data to the session.

Overwrites any existing data under the same keys.

Parameters

array

$newData

Key-value pairs to add to the session

Definition at line 526 of file SessionBackend.php.

References $value, as, MediaWiki\Session\SessionBackend\getData(), and wfGetAllCallers().

Referenced by MediaWiki\Session\CookieSessionProvider\persistSession().

MediaWiki\Session\SessionBackend::autosave ( )

private

Save the session, unless delayed.

See also

SessionBackend::save()

Definition at line 605 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\delaySave(), and MediaWiki\Session\SessionBackend\save().

Referenced by MediaWiki\Session\SessionBackend\persist(), MediaWiki\Session\SessionBackend\renew(), MediaWiki\Session\SessionBackend\resetId(), MediaWiki\Session\SessionBackend\setForceHTTPS(), MediaWiki\Session\SessionBackend\setLoggedOutTimestamp(), MediaWiki\Session\SessionBackend\setProviderMetadata(), MediaWiki\Session\SessionBackend\setRememberUser(), MediaWiki\Session\SessionBackend\setUser(), and MediaWiki\Session\SessionBackend\unpersist().

MediaWiki\Session\SessionBackend::canSetUser

(

)

Indicate whether the session user info can be changed.

Returns

bool

Definition at line 385 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\setUser().

MediaWiki\Session\SessionBackend::checkPHPSession ( )

private

For backwards compatibility, open the PHP session when the global session is persisted.

Definition at line 751 of file SessionBackend.php.

References MediaWiki\Session\SessionManager\getGlobalSession(), MediaWiki\Session\SessionBackend\getId(), and MediaWiki\Session\PHPSessionHandler\isEnabled().

Referenced by MediaWiki\Session\SessionBackend\save().

MediaWiki\Session\SessionBackend::delaySave

(

)

Delay automatic saving while multiple updates are being made.

Calls to save() will not be delayed.

Returns

\Wikimedia\ScopedCallback When this goes out of scope, a save will be triggered

Definition at line 591 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\save().

Referenced by MediaWiki\Session\SessionBackend\autosave(), and MediaWiki\Session\SessionManager\getSessionFromInfo().

MediaWiki\Session\SessionBackend::deregisterSession

(

$index

)

Deregister a Session.

Access:

private For use by \MediaWiki\Session\Session::__destruct() only

Parameters

int

$index

Definition at line 184 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\save(), and MediaWiki\Session\SessionBackend\shutdown().

MediaWiki\Session\SessionBackend::dirty

(

)

Mark data as dirty.

Access:

private For use by \MediaWiki\Session\Session only.

Definition at line 546 of file SessionBackend.php.

References wfGetAllCallers().

Referenced by MediaWiki\Session\SessionBackendTest\testSave().

MediaWiki\Session\SessionBackend::getAllowedUserRights

(

)

Fetch the rights allowed the user when this session is active.

Returns

null|string[] Allowed user rights, or null to allow all.

Definition at line 377 of file SessionBackend.php.

& MediaWiki\Session\SessionBackend::getData

(

)

Fetch the session data array.

Note the caller is responsible for calling $this->dirty() if anything in the array is changed.

Access:

private For use by \MediaWiki\Session\Session only.

Returns

array

Definition at line 515 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$data.

Referenced by MediaWiki\Session\SessionBackend\addData().

MediaWiki\Session\SessionBackend::getId

(

)

Returns the session ID.

Returns

string

Definition at line 205 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$id.

Referenced by MediaWiki\Session\SessionBackend\checkPHPSession(), MediaWiki\Session\SessionManager\deregisterSessionBackend(), MediaWiki\Session\ImmutableSessionProviderWithCookie\persistSession(), and MediaWiki\Session\CookieSessionProvider\persistSession().

MediaWiki\Session\SessionBackend::getLoggedOutTimestamp

(

)

Fetch the "logged out" timestamp.

Returns

int

Definition at line 454 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$loggedOut.

Referenced by MediaWiki\Session\CookieSessionProvider\persistSession().

MediaWiki\Session\SessionBackend::getProvider

(

)

Fetch the SessionProvider for this session.

Returns

SessionProviderInterface

Definition at line 260 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$provider.

Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\getAllowedUserRights(), and MediaWiki\Session\SessionProvider\getAllowedUserRights().

MediaWiki\Session\SessionBackend::getProviderMetadata

(

)

Fetch provider metadata.

Access:

protected For use by SessionProvider subclasses only

Returns

array|null

Definition at line 481 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$providerMetadata.

Referenced by MediaWiki\Session\Session\BotPasswordSessionProvider\getAllowedUserRights().

MediaWiki\Session\SessionBackend::getRequest

(

$index

)

Returns the request associated with a Session.

Parameters

int

$index

Session index

Returns

WebRequest

Definition at line 358 of file SessionBackend.php.

MediaWiki\Session\SessionBackend::getSession

(

WebRequest

$request

)

Return a new Session for this backend.

Parameters

WebRequest

$request

Returns

Session

Definition at line 172 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$curIndex, and $request.

MediaWiki\Session\SessionBackend::getSessionId

(

)

Fetch the SessionId object.

Access:

private For internal use by WebRequest

Returns

SessionId

Definition at line 214 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$id.

Referenced by MediaWiki\Session\SessionManager\changeBackendId(), MediaWiki\Session\SessionManager\deregisterSessionBackend(), and MediaWiki\Session\SessionBackend\save().

MediaWiki\Session\SessionBackend::getUser

(

)

Returns the authenticated user for this session.

Returns

User

Definition at line 369 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$user.

Referenced by MediaWiki\Session\ImmutableSessionProviderWithCookie\persistSession(), and MediaWiki\Session\CookieSessionProvider\persistSession().

MediaWiki\Session\SessionBackend::isPersistent

(

)

Indicate whether this session is persisted across requests.

For example, if cookies are set.

Returns

bool

Definition at line 271 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$persist.

Referenced by MediaWiki\Session\SessionBackendTest\testSave().

MediaWiki\Session\SessionBackend::persist

(

)

Make this session persisted across requests.

If the session is already persistent, equivalent to calling $this->renew().

Definition at line 281 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave(), and MediaWiki\Session\SessionBackend\renew().

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionBackend\renew(), MediaWiki\Session\SessionBackend\save(), and MediaWiki\Session\SessionBackend\unpersist().

MediaWiki\Session\SessionBackend::renew

(

)

Renew the session by resaving everything.

Resets the TTL in the backend store if the session is near expiring, and re-persists the session to any active WebRequests if persistent.

Definition at line 562 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\SessionBackend\persist(), and wfGetAllCallers().

Referenced by MediaWiki\Session\SessionBackend\persist().

MediaWiki\Session\SessionBackend::resetId

(

)

Changes the session ID.

Returns

string New ID (might be the same as the old)

Definition at line 222 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\PHPSessionHandler\isEnabled(), store, string, and wfMemcKey().

MediaWiki\Session\SessionBackend::save

(

$closing = false

)

Save the session.

Update both the backend data and the associated WebRequest(s) to reflect the state of the the SessionBackend. This might include persisting or unpersisting the session.

Parameters

bool

$closing

Whether the session is being closed

Definition at line 620 of file SessionBackend.php.

References $flags, MediaWiki\Session\SessionBackend\$forceHTTPS, MediaWiki\Session\SessionBackend\$id, MediaWiki\Session\SessionBackend\$lifetime, MediaWiki\Session\SessionBackend\$loggedOut, MediaWiki\Session\SessionBackend\$persist, MediaWiki\Session\SessionBackend\$remember, $request, MediaWiki\Session\SessionBackend\$user, DeferredUpdates\addCallableUpdate(), as, MediaWiki\Session\SessionBackend\checkPHPSession(), data, MediaWiki\Session\SessionBackend\getSessionId(), User\isValidUserName(), MediaWiki\Session\SessionBackend\persist(), Hooks\run(), User\saveSettings(), serialize(), store, string, use, user, wfMemcKey(), wfReadOnly(), BagOStuff\WRITE_CACHE_ONLY, and BagOStuff\WRITE_SYNC.

Referenced by MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\SessionBackend\delaySave(), MediaWiki\Session\SessionBackend\deregisterSession(), MediaWiki\Session\SessionBackend\shutdown(), and MediaWiki\Session\SessionBackendTest\testSave().

MediaWiki\Session\SessionBackend::setForceHTTPS

(

$force

)

Set whether HTTPS should be forced.

Parameters

bool

$force

Definition at line 437 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave().

MediaWiki\Session\SessionBackend::setLoggedOutTimestamp

(

$ts = null

)

Set the "logged out" timestamp.

Parameters

int

$ts

Definition at line 462 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave().

MediaWiki\Session\SessionBackend::setProviderMetadata

(

$metadata

)

Set provider metadata.

Access:

protected For use by SessionProvider subclasses only

Parameters

array | null

$metadata

Definition at line 490 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave().

MediaWiki\Session\SessionBackend::setRememberUser

(

$remember

)

Set whether the user should be remembered independently of the session ID.

Parameters

bool

$remember

Definition at line 340 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$remember, and MediaWiki\Session\SessionBackend\autosave().

MediaWiki\Session\SessionBackend::setUser

(

$user

)

Set a new user for this session.

Note

This should only be called when the user has been authenticated via a login process

Parameters

User

$user

User to set on the session. This may become a "UserValue" in the future, or User may be refactored into such.

Definition at line 396 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$user, MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\SessionBackend\canSetUser(), and user.

MediaWiki\Session\SessionBackend::shouldForceHTTPS

(

)

Whether HTTPS should be forced.

Returns

bool

Definition at line 429 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$forceHTTPS.

Referenced by MediaWiki\Session\ImmutableSessionProviderWithCookie\persistSession(), and MediaWiki\Session\CookieSessionProvider\persistSession().

MediaWiki\Session\SessionBackend::shouldRememberUser

(

)

Indicate whether the user should be remembered independently of the session ID.

Returns

bool

Definition at line 331 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\$remember.

Referenced by MediaWiki\Session\CookieSessionProvider\persistSession().

MediaWiki\Session\SessionBackend::shutdown

(

)

Shut down a session.

Access:

private For use by \MediaWiki\Session\SessionManager::shutdown() only

Definition at line 196 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\save().

Referenced by MediaWiki\Session\SessionBackend\deregisterSession().

MediaWiki\Session\SessionBackend::suggestLoginUsername

(

$index

)

Get a suggested username for the login form.

Parameters

int

$index

Session index

Returns

string|null

Definition at line 418 of file SessionBackend.php.

MediaWiki\Session\SessionBackend::unpersist

(

)

Make this session not persisted across requests.

Definition at line 300 of file SessionBackend.php.

References MediaWiki\Session\SessionBackend\autosave(), MediaWiki\Session\PHPSessionHandler\isEnabled(), MediaWiki\Session\SessionBackend\persist(), store, and wfMemcKey().

Member Data Documentation

MediaWiki\Session\SessionBackend::$checkPHPSessionRecursionGuard = false

private

Definition at line 95 of file SessionBackend.php.

MediaWiki\Session\SessionBackend::$curIndex = 0

private

Definition at line 79 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\getSession().

array null MediaWiki\Session\SessionBackend::$data = null

private

Definition at line 58 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\getData().

MediaWiki\Session\SessionBackend::$dataDirty = false

private

Definition at line 62 of file SessionBackend.php.

string MediaWiki\Session\SessionBackend::$dataHash = null

private

Used to detect subarray modifications.

Definition at line 65 of file SessionBackend.php.

MediaWiki\Session\SessionBackend::$delaySave = 0

private

Definition at line 92 of file SessionBackend.php.

MediaWiki\Session\SessionBackend::$expires = 0

private

Definition at line 90 of file SessionBackend.php.

MediaWiki\Session\SessionBackend::$forceHTTPS = false

private

Definition at line 55 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\save(), and MediaWiki\Session\SessionBackend\shouldForceHTTPS().

MediaWiki\Session\SessionBackend::$forcePersist = false

private

Definition at line 60 of file SessionBackend.php.

SessionId MediaWiki\Session\SessionBackend::$id

private

Definition at line 51 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\__construct(), MediaWiki\Session\SessionBackend\getId(), MediaWiki\Session\SessionBackend\getSessionId(), and MediaWiki\Session\SessionBackend\save().

int MediaWiki\Session\SessionBackend::$lifetime

private

Definition at line 74 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\__construct(), and MediaWiki\Session\SessionBackend\save().

MediaWiki\Session\SessionBackend::$loggedOut = 0

private

Definition at line 91 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\getLoggedOutTimestamp(), and MediaWiki\Session\SessionBackend\save().

LoggerInterface MediaWiki\Session\SessionBackend::$logger

private

Definition at line 71 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\__construct().

MediaWiki\Session\SessionBackend::$metaDirty = false

private

Definition at line 61 of file SessionBackend.php.

MediaWiki\Session\SessionBackend::$persist = false

private

Definition at line 53 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\isPersistent(), and MediaWiki\Session\SessionBackend\save().

SessionProvider MediaWiki\Session\SessionBackend::$provider

private

provider

Definition at line 85 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\getProvider().

array null MediaWiki\Session\SessionBackend::$providerMetadata = null

private

provider-specified metadata

Definition at line 88 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\getProviderMetadata().

MediaWiki\Session\SessionBackend::$remember = false

private

Definition at line 54 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\save(), MediaWiki\Session\SessionBackend\setRememberUser(), and MediaWiki\Session\SessionBackend\shouldRememberUser().

WebRequest [] MediaWiki\Session\SessionBackend::$requests = []

private

Session requests.

Definition at line 82 of file SessionBackend.php.

MediaWiki\Session\SessionBackend::$shutdown = false

private

Definition at line 97 of file SessionBackend.php.

CachedBagOStuff MediaWiki\Session\SessionBackend::$store

private

Definition at line 68 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\__construct().

MediaWiki\Session\SessionBackend::$usePhpSessionHandling = true

private

Definition at line 94 of file SessionBackend.php.

User MediaWiki\Session\SessionBackend::$user

private

Definition at line 77 of file SessionBackend.php.

Referenced by MediaWiki\Session\SessionBackend\getUser(), MediaWiki\Session\SessionBackend\save(), and MediaWiki\Session\SessionBackend\setUser().

---

The documentation for this class was generated from the following file:

• includes/session/SessionBackend.php