MediaWiki  master
MediaWiki\Session\SessionManager Class Reference

This serves as the entry point to the MediaWiki session handling system. More...

Inheritance diagram for MediaWiki\Session\SessionManager:
Collaboration diagram for MediaWiki\Session\SessionManager:

Public Member Functions

 __construct ($options=[])
 
 getEmptySession (WebRequest $request=null)
 Create a new, empty session. More...
 
 getSessionById ($id, $create=false, WebRequest $request=null)
 Fetch a session by ID. More...
 
 getSessionForRequest (WebRequest $request)
 Fetch the session for a request (or a new empty session if none is attached to it) More...
 
 getVaryCookies ()
 Return the list of cookies that need varying on. More...
 
 getVaryHeaders ()
 Return the HTTP headers that need varying on. More...
 
 invalidateSessionsForUser (User $user)
 Invalidate sessions for a user. More...
 
 setLogger (LoggerInterface $logger)
 

Static Public Member Functions

static getGlobalSession ()
 Get the "global" session. More...
 
static singleton ()
 Get the global SessionManager. More...
 
static validateSessionId ($id)
 Validate a session ID. More...
 

Private Member Functions

 getEmptySessionInternal (WebRequest $request=null, $id=null)
 

Private Attributes

SessionBackend[] $allSessionBackends = []
 
SessionId[] $allSessionIds = []
 
Config $config
 
LoggerInterface $logger
 
string[] $preventUsers = []
 
SessionProvider[] $sessionProviders = null
 
CachedBagOStuff null $store
 
string[] $varyCookies = null
 
array $varyHeaders = null
 

Static Private Attributes

static Session null $globalSession = null
 
static WebRequest null $globalSessionRequest = null
 
static SessionManager null $instance = null
 

Internal methods

static autoCreateUser (User $user)
 Auto-create the given user, if necessary. More...
 
static resetCache ()
 Reset the internal caching for unit testing. More...
 
 preventSessionsForUser ($username)
 Prevent future sessions for the user. More...
 
 isUserSessionPrevented ($username)
 Test if a user is prevented. More...
 
 getProvider ($name)
 Get a session provider by name. More...
 
 shutdown ()
 Save all active sessions on shutdown. More...
 
 getSessionFromInfo (SessionInfo $info, WebRequest $request)
 Create a Session corresponding to the passed SessionInfo. More...
 
 deregisterSessionBackend (SessionBackend $backend)
 Deregister a SessionBackend. More...
 
 changeBackendId (SessionBackend $backend)
 Change a SessionBackend's ID. More...
 
 generateSessionId ()
 Generate a new random session ID. More...
 
 setupPHPSessionHandler (PHPSessionHandler $handler)
 Call setters on a PHPSessionHandler. More...
 
 getSessionInfoForRequest (WebRequest $request)
 Fetch the SessionInfo(s) for a request. More...
 
 loadSessionInfoFromStore (SessionInfo &$info, WebRequest $request)
 Load and verify the session info against the store. More...
 
 getProviders ()
 Get the available SessionProviders. More...
 

Detailed Description

This serves as the entry point to the MediaWiki session handling system.

Most methods here are for internal use by session handling code. Other callers should only use getGlobalSession and the methods of SessionManagerInterface; the rest of the functionality is exposed via MediaWiki\Session\Session methods.

To provide custom session handling, implement a MediaWiki\Session\SessionProvider.

Since
1.27
See also
https://www.mediawiki.org/wiki/Manual:SessionManager_and_AuthManager

Definition at line 49 of file SessionManager.php.

Constructor & Destructor Documentation

MediaWiki\Session\SessionManager::__construct (   $options = [])
Parameters
array$options
  • config: Config to fetch configuration from. Defaults to the default 'main' config.
  • logger: LoggerInterface to use for logging. Defaults to the 'session' channel.
  • store: BagOStuff to store session data in.

Definition at line 147 of file SessionManager.php.

References $options, ObjectCache\getInstance(), MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Session\SessionManager\setLogger(), and store.

Member Function Documentation

static MediaWiki\Session\SessionManager::autoCreateUser ( User  $user)
static

Auto-create the given user, if necessary.

Access:
private Don't call this yourself. Let Setup.php do it for you at the right time.
Deprecated:
since 1.27, use MediaWiki\Auth\AuthManager::autoCreateUser instead
Parameters
User$userUser to auto-create
Returns
bool Success

Definition at line 387 of file SessionManager.php.

References wfDeprecated().

MediaWiki\Session\SessionManager::changeBackendId ( SessionBackend  $backend)

Change a SessionBackend's ID.

Access:
private For use from \MediaWiki\Session\SessionBackend only
Parameters
SessionBackend$backend

Definition at line 912 of file SessionManager.php.

References MediaWiki\Session\SessionManager\generateSessionId(), MediaWiki\Session\SessionBackend\getSessionId(), and string.

MediaWiki\Session\SessionManager::deregisterSessionBackend ( SessionBackend  $backend)

Deregister a SessionBackend.

Access:
private For use from \MediaWiki\Session\SessionBackend only
Parameters
SessionBackend$backend

Definition at line 894 of file SessionManager.php.

References MediaWiki\Session\SessionBackend\getId(), and MediaWiki\Session\SessionBackend\getSessionId().

MediaWiki\Session\SessionManager::generateSessionId ( )

Generate a new random session ID.

Returns
string

Definition at line 934 of file SessionManager.php.

References $key, MWCryptRand\generateHex(), and store.

Referenced by MediaWiki\Session\SessionManager\changeBackendId().

MediaWiki\Session\SessionManager::getEmptySession ( WebRequest  $request = null)

Create a new, empty session.

The first provider configured that is able to provide an empty session will be used.

Parameters
WebRequest | null$requestCorresponding request. Any existing session associated with this WebRequest object will be overwritten.
Returns
Session

Implements MediaWiki\Session\SessionManagerInterface.

Definition at line 242 of file SessionManager.php.

References $request, and MediaWiki\Session\SessionManager\getEmptySessionInternal().

Referenced by MediaWiki\Session\SessionManager\getSessionForRequest().

MediaWiki\Session\SessionManager::getEmptySessionInternal ( WebRequest  $request = null,
  $id = null 
)
private
MediaWiki\Session\SessionManager::getProvider (   $name)

Get a session provider by name.

Generally, this will only be used by internal implementation of some special session-providing mechanism. General purpose code, if it needs to access a SessionProvider at all, will use Session::getProvider().

Parameters
string$name
Returns
SessionProvider|null

Definition at line 455 of file SessionManager.php.

References $name, and MediaWiki\Session\SessionManager\getProviders().

Referenced by MediaWiki\Session\SessionManager\loadSessionInfoFromStore().

MediaWiki\Session\SessionManager::getSessionById (   $id,
  $create = false,
WebRequest  $request = null 
)

Fetch a session by ID.

Parameters
string$id
bool$createIf no session exists for $id, try to create a new one. May still return null if a session for $id exists but cannot be loaded.
WebRequest | null$requestCorresponding request. Any existing session associated with this WebRequest object will be overwritten.
Returns
Session|null

Implements MediaWiki\Session\SessionManagerInterface.

Definition at line 200 of file SessionManager.php.

References $key, $request, MediaWiki\Session\SessionManager\getEmptySessionInternal(), MediaWiki\Session\SessionManager\getSessionFromInfo(), MediaWiki\Session\SessionManager\loadSessionInfoFromStore(), MediaWiki\Session\SessionInfo\MIN_PRIORITY, and store.

MediaWiki\Session\SessionManager::getSessionForRequest ( WebRequest  $request)

Fetch the session for a request (or a new empty session if none is attached to it)

Note
You probably want to use $request->getSession() instead. It's more efficient and doesn't break FauxRequests or sessions that were changed by $this->getSessionById() or $this->getEmptySession().
Parameters
WebRequest$requestAny existing associated session will be reset to the session corresponding to the data in the request itself.
Returns
Session
Exceptions
if there are multiple sessions tied for top priority in the request. Exception has a property "sessionInfos" holding the SessionInfo objects for the sessions involved.

Implements MediaWiki\Session\SessionManagerInterface.

Definition at line 189 of file SessionManager.php.

References MediaWiki\Session\SessionManager\getEmptySession(), MediaWiki\Session\SessionManager\getSessionFromInfo(), and MediaWiki\Session\SessionManager\getSessionInfoForRequest().

MediaWiki\Session\SessionManager::getSessionFromInfo ( SessionInfo  $info,
WebRequest  $request 
)
MediaWiki\Session\SessionManager::getSessionInfoForRequest ( WebRequest  $request)
private
MediaWiki\Session\SessionManager::getVaryCookies ( )

Return the list of cookies that need varying on.

Returns
string[]

Implements MediaWiki\Session\SessionManagerInterface.

Definition at line 349 of file SessionManager.php.

References MediaWiki\Session\SessionManager\$varyCookies, as, MediaWiki\Session\SessionManager\getProviders(), and MW_NO_SESSION.

MediaWiki\Session\SessionManager::getVaryHeaders ( )

Return the HTTP headers that need varying on.

The return value is such that someone could theoretically do this:

foreach ( $provider->getVaryHeaders() as $header => $options ) {
$outputPage->addVaryHeader( $header, $options );
}
Returns
array

Implements MediaWiki\Session\SessionManagerInterface.

Definition at line 326 of file SessionManager.php.

References $header, $options, MediaWiki\Session\SessionManager\$varyHeaders, as, MediaWiki\Session\SessionManager\getProviders(), and MW_NO_SESSION.

MediaWiki\Session\SessionManager::invalidateSessionsForUser ( User  $user)

Invalidate sessions for a user.

After calling this, existing sessions should be invalid. For mutable session providers, this generally means the user has to log in again; for immutable providers, it generally means the loss of session data.

Parameters
User$user

Implements MediaWiki\Session\SessionManagerInterface.

Definition at line 312 of file SessionManager.php.

References as, MediaWiki\Auth\AuthManager\callLegacyAuthPlugin(), MediaWiki\Session\SessionManager\getProviders(), User\saveSettings(), and User\setToken().

MediaWiki\Session\SessionManager::isUserSessionPrevented (   $username)

Test if a user is prevented.

Access:
private For use from SessionBackend only
Parameters
string$username
Returns
bool

Definition at line 420 of file SessionManager.php.

References $username.

MediaWiki\Session\SessionManager::preventSessionsForUser (   $username)

Prevent future sessions for the user.

The intention is that the named account will never again be usable for normal login (i.e. there is no way to undo the prevention of access).

Access:
private For use from \User::newSystemUser only
Parameters
string$username

Definition at line 405 of file SessionManager.php.

References $username, as, and MediaWiki\Session\SessionManager\getProviders().

static MediaWiki\Session\SessionManager::resetCache ( )
static

Reset the internal caching for unit testing.

Access:
protected Unit tests only

Definition at line 955 of file SessionManager.php.

Referenced by MediaWikiTestCase\doLightweightServiceReset(), and MediaWikiTestCase\tearDown().

MediaWiki\Session\SessionManager::setLogger ( LoggerInterface  $logger)
MediaWiki\Session\SessionManager::setupPHPSessionHandler ( PHPSessionHandler  $handler)

Call setters on a PHPSessionHandler.

Access:
private Use PhpSessionHandler::install()
Parameters
PHPSessionHandler$handler

Definition at line 947 of file SessionManager.php.

References MediaWiki\Session\PHPSessionHandler\setManager(), and store.

Referenced by MediaWiki\Session\PHPSessionHandler\__construct(), and MediaWiki\Session\PHPSessionHandler\install().

MediaWiki\Session\SessionManager::shutdown ( )

Save all active sessions on shutdown.

Access:
private For internal use with register_shutdown_function()

Definition at line 464 of file SessionManager.php.

References as.

static MediaWiki\Session\SessionManager::validateSessionId (   $id)
static

Member Data Documentation

SessionBackend [] MediaWiki\Session\SessionManager::$allSessionBackends = []
private

Definition at line 78 of file SessionManager.php.

SessionId [] MediaWiki\Session\SessionManager::$allSessionIds = []
private

Definition at line 81 of file SessionManager.php.

Config MediaWiki\Session\SessionManager::$config
private

Definition at line 63 of file SessionManager.php.

Session null MediaWiki\Session\SessionManager::$globalSession = null
staticprivate

Definition at line 54 of file SessionManager.php.

WebRequest null MediaWiki\Session\SessionManager::$globalSessionRequest = null
staticprivate

Definition at line 57 of file SessionManager.php.

SessionManager null MediaWiki\Session\SessionManager::$instance = null
staticprivate

Definition at line 51 of file SessionManager.php.

LoggerInterface MediaWiki\Session\SessionManager::$logger
private

Definition at line 60 of file SessionManager.php.

Referenced by MediaWiki\Session\SessionManager\setLogger().

string [] MediaWiki\Session\SessionManager::$preventUsers = []
private

Definition at line 84 of file SessionManager.php.

SessionProvider [] MediaWiki\Session\SessionManager::$sessionProviders = null
private

Definition at line 69 of file SessionManager.php.

Referenced by MediaWiki\Session\SessionManager\getProviders().

CachedBagOStuff null MediaWiki\Session\SessionManager::$store
private

Definition at line 66 of file SessionManager.php.

string [] MediaWiki\Session\SessionManager::$varyCookies = null
private

Definition at line 72 of file SessionManager.php.

Referenced by MediaWiki\Session\SessionManager\getVaryCookies().

array MediaWiki\Session\SessionManager::$varyHeaders = null
private

Definition at line 75 of file SessionManager.php.

Referenced by MediaWiki\Session\SessionManager\getVaryHeaders().


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