3 * MediaWiki\Session entry point
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 namespace MediaWiki\Session
;
26 use MediaWiki\MediaWikiServices
;
28 use Psr\Log\LoggerInterface
;
35 use Wikimedia\ObjectFactory
;
38 * This serves as the entry point to the MediaWiki session handling system.
40 * Most methods here are for internal use by session handling code. Other callers
41 * should only use getGlobalSession and the methods of SessionManagerInterface;
42 * the rest of the functionality is exposed via MediaWiki\Session\Session methods.
44 * To provide custom session handling, implement a MediaWiki\Session\SessionProvider.
48 * @see https://www.mediawiki.org/wiki/Manual:SessionManager_and_AuthManager
50 final class SessionManager
implements SessionManagerInterface
{
51 /** @var SessionManager|null */
52 private static $instance = null;
54 /** @var Session|null */
55 private static $globalSession = null;
57 /** @var WebRequest|null */
58 private static $globalSessionRequest = null;
60 /** @var LoggerInterface */
66 /** @var CachedBagOStuff|null */
69 /** @var SessionProvider[] */
70 private $sessionProviders = null;
73 private $varyCookies = null;
76 private $varyHeaders = null;
78 /** @var SessionBackend[] */
79 private $allSessionBackends = [];
81 /** @var SessionId[] */
82 private $allSessionIds = [];
85 private $preventUsers = [];
88 * Get the global SessionManager
91 public static function singleton() {
92 if ( self
::$instance === null ) {
93 self
::$instance = new self();
95 return self
::$instance;
99 * Get the "global" session
101 * If PHP's session_id() has been set, returns that session. Otherwise
102 * returns the session for RequestContext::getMain()->getRequest().
106 public static function getGlobalSession() {
107 if ( !PHPSessionHandler
::isEnabled() ) {
113 $request = \RequestContext
::getMain()->getRequest();
115 !self
::$globalSession // No global session is set up yet
116 || self
::$globalSessionRequest !== $request // The global WebRequest changed
117 ||
$id !== '' && self
::$globalSession->getId() !== $id // Someone messed with session_id()
119 self
::$globalSessionRequest = $request;
121 // session_id() wasn't used, so fetch the Session from the WebRequest.
122 // We use $request->getSession() instead of $singleton->getSessionForRequest()
123 // because doing the latter would require a public
124 // "$request->getSessionId()" method that would confuse end
125 // users by returning SessionId|null where they'd expect it to
126 // be short for $request->getSession()->getId(), and would
127 // wind up being a duplicate of the code in
128 // $request->getSession() anyway.
129 self
::$globalSession = $request->getSession();
131 // Someone used session_id(), so we need to follow suit.
132 // Note this overwrites whatever session might already be
133 // associated with $request with the one for $id.
134 self
::$globalSession = self
::singleton()->getSessionById( $id, true, $request )
135 ?
: $request->getSession();
138 return self
::$globalSession;
142 * @param array $options
143 * - config: Config to fetch configuration from. Defaults to the default 'main' config.
144 * - logger: LoggerInterface to use for logging. Defaults to the 'session' channel.
145 * - store: BagOStuff to store session data in.
147 public function __construct( $options = [] ) {
148 if ( isset( $options['config'] ) ) {
149 $this->config
= $options['config'];
150 if ( !$this->config
instanceof Config
) {
151 throw new \
InvalidArgumentException(
152 '$options[\'config\'] must be an instance of Config'
156 $this->config
= MediaWikiServices
::getInstance()->getMainConfig();
159 if ( isset( $options['logger'] ) ) {
160 if ( !$options['logger'] instanceof LoggerInterface
) {
161 throw new \
InvalidArgumentException(
162 '$options[\'logger\'] must be an instance of LoggerInterface'
165 $this->setLogger( $options['logger'] );
167 $this->setLogger( \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' ) );
170 if ( isset( $options['store'] ) ) {
171 if ( !$options['store'] instanceof BagOStuff
) {
172 throw new \
InvalidArgumentException(
173 '$options[\'store\'] must be an instance of BagOStuff'
176 $store = $options['store'];
178 $store = \ObjectCache
::getInstance( $this->config
->get( 'SessionCacheType' ) );
180 $this->store
= $store instanceof CachedBagOStuff ?
$store : new CachedBagOStuff( $store );
182 register_shutdown_function( [ $this, 'shutdown' ] );
185 public function setLogger( LoggerInterface
$logger ) {
186 $this->logger
= $logger;
189 public function getSessionForRequest( WebRequest
$request ) {
190 $info = $this->getSessionInfoForRequest( $request );
193 $session = $this->getEmptySession( $request );
195 $session = $this->getSessionFromInfo( $info, $request );
200 public function getSessionById( $id, $create = false, WebRequest
$request = null ) {
201 if ( !self
::validateSessionId( $id ) ) {
202 throw new \
InvalidArgumentException( 'Invalid session ID' );
205 $request = new FauxRequest
;
209 $info = new SessionInfo( SessionInfo
::MIN_PRIORITY
, [ 'id' => $id, 'idIsSafe' => true ] );
211 // If we already have the backend loaded, use it directly
212 if ( isset( $this->allSessionBackends
[$id] ) ) {
213 return $this->getSessionFromInfo( $info, $request );
216 // Test if the session is in storage, and if so try to load it.
217 $key = $this->store
->makeKey( 'MWSession', $id );
218 if ( is_array( $this->store
->get( $key ) ) ) {
219 $create = false; // If loading fails, don't bother creating because it probably will fail too.
220 if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
221 $session = $this->getSessionFromInfo( $info, $request );
225 if ( $create && $session === null ) {
228 $session = $this->getEmptySessionInternal( $request, $id );
229 } catch ( \Exception
$ex ) {
230 $this->logger
->error( 'Failed to create empty session: {exception}',
232 'method' => __METHOD__
,
242 public function getEmptySession( WebRequest
$request = null ) {
243 return $this->getEmptySessionInternal( $request );
247 * @see SessionManagerInterface::getEmptySession
248 * @param WebRequest|null $request
249 * @param string|null $id ID to force on the new session
252 private function getEmptySessionInternal( WebRequest
$request = null, $id = null ) {
253 if ( $id !== null ) {
254 if ( !self
::validateSessionId( $id ) ) {
255 throw new \
InvalidArgumentException( 'Invalid session ID' );
258 $key = $this->store
->makeKey( 'MWSession', $id );
259 if ( is_array( $this->store
->get( $key ) ) ) {
260 throw new \
InvalidArgumentException( 'Session ID already exists' );
264 $request = new FauxRequest
;
268 foreach ( $this->getProviders() as $provider ) {
269 $info = $provider->newSessionInfo( $id );
273 if ( $info->getProvider() !== $provider ) {
274 throw new \
UnexpectedValueException(
275 "$provider returned an empty session info for a different provider: $info"
278 if ( $id !== null && $info->getId() !== $id ) {
279 throw new \
UnexpectedValueException(
280 "$provider returned empty session info with a wrong id: " .
281 $info->getId() . ' != ' . $id
284 if ( !$info->isIdSafe() ) {
285 throw new \
UnexpectedValueException(
286 "$provider returned empty session info with id flagged unsafe"
289 // @phan-suppress-next-line PhanTypeInvalidDimOffset
290 $compare = $infos ? SessionInfo
::compare( $infos[0], $info ) : -1;
291 if ( $compare > 0 ) {
294 if ( $compare === 0 ) {
301 // Make sure there's exactly one
302 if ( count( $infos ) > 1 ) {
303 throw new \
UnexpectedValueException(
304 'Multiple empty sessions tied for top priority: ' . implode( ', ', $infos )
306 } elseif ( count( $infos ) < 1 ) {
307 throw new \
UnexpectedValueException( 'No provider could provide an empty session!' );
310 return $this->getSessionFromInfo( $infos[0], $request );
313 public function invalidateSessionsForUser( User
$user ) {
315 $user->saveSettings();
317 foreach ( $this->getProviders() as $provider ) {
318 $provider->invalidateSessionsForUser( $user );
322 public function getVaryHeaders() {
323 // @codeCoverageIgnoreStart
324 // @phan-suppress-next-line PhanUndeclaredConstant
325 if ( defined( 'MW_NO_SESSION' ) && MW_NO_SESSION
!== 'warn' ) {
328 // @codeCoverageIgnoreEnd
329 if ( $this->varyHeaders
=== null ) {
331 foreach ( $this->getProviders() as $provider ) {
332 foreach ( $provider->getVaryHeaders() as $header => $options ) {
333 # Note that the $options value returned has been deprecated
335 $headers[$header] = null;
338 $this->varyHeaders
= $headers;
340 return $this->varyHeaders
;
343 public function getVaryCookies() {
344 // @codeCoverageIgnoreStart
345 // @phan-suppress-next-line PhanUndeclaredConstant
346 if ( defined( 'MW_NO_SESSION' ) && MW_NO_SESSION
!== 'warn' ) {
349 // @codeCoverageIgnoreEnd
350 if ( $this->varyCookies
=== null ) {
352 foreach ( $this->getProviders() as $provider ) {
353 $cookies = array_merge( $cookies, $provider->getVaryCookies() );
355 $this->varyCookies
= array_values( array_unique( $cookies ) );
357 return $this->varyCookies
;
361 * Validate a session ID
365 public static function validateSessionId( $id ) {
366 return is_string( $id ) && preg_match( '/^[a-zA-Z0-9_-]{32,}$/', $id );
370 * @name Internal methods
375 * Prevent future sessions for the user
377 * The intention is that the named account will never again be usable for
378 * normal login (i.e. there is no way to undo the prevention of access).
380 * @private For use from \User::newSystemUser only
381 * @param string $username
383 public function preventSessionsForUser( $username ) {
384 $this->preventUsers
[$username] = true;
386 // Instruct the session providers to kill any other sessions too.
387 foreach ( $this->getProviders() as $provider ) {
388 $provider->preventSessionsForUser( $username );
393 * Test if a user is prevented
394 * @private For use from SessionBackend only
395 * @param string $username
398 public function isUserSessionPrevented( $username ) {
399 return !empty( $this->preventUsers
[$username] );
403 * Get the available SessionProviders
404 * @return SessionProvider[]
406 protected function getProviders() {
407 if ( $this->sessionProviders
=== null ) {
408 $this->sessionProviders
= [];
409 foreach ( $this->config
->get( 'SessionProviders' ) as $spec ) {
410 $provider = ObjectFactory
::getObjectFromSpec( $spec );
411 $provider->setLogger( $this->logger
);
412 $provider->setConfig( $this->config
);
413 $provider->setManager( $this );
414 if ( isset( $this->sessionProviders
[(string)$provider] ) ) {
415 // @phan-suppress-next-line PhanTypeSuspiciousStringExpression
416 throw new \
UnexpectedValueException( "Duplicate provider name \"$provider\"" );
418 $this->sessionProviders
[(string)$provider] = $provider;
421 return $this->sessionProviders
;
425 * Get a session provider by name
427 * Generally, this will only be used by internal implementation of some
428 * special session-providing mechanism. General purpose code, if it needs
429 * to access a SessionProvider at all, will use Session::getProvider().
431 * @param string $name
432 * @return SessionProvider|null
434 public function getProvider( $name ) {
435 $providers = $this->getProviders();
436 return $providers[$name] ??
null;
440 * Save all active sessions on shutdown
441 * @private For internal use with register_shutdown_function()
443 public function shutdown() {
444 if ( $this->allSessionBackends
) {
445 $this->logger
->debug( 'Saving all sessions on shutdown' );
446 if ( session_id() !== '' ) {
447 // @codeCoverageIgnoreStart
448 session_write_close();
450 // @codeCoverageIgnoreEnd
451 foreach ( $this->allSessionBackends
as $backend ) {
452 $backend->shutdown();
458 * Fetch the SessionInfo(s) for a request
459 * @param WebRequest $request
460 * @return SessionInfo|null
462 private function getSessionInfoForRequest( WebRequest
$request ) {
463 // Call all providers to fetch "the" session
465 foreach ( $this->getProviders() as $provider ) {
466 $info = $provider->provideSessionInfo( $request );
470 if ( $info->getProvider() !== $provider ) {
471 throw new \
UnexpectedValueException(
472 "$provider returned session info for a different provider: $info"
478 // Sort the SessionInfos. Then find the first one that can be
479 // successfully loaded, and then all the ones after it with the same
481 usort( $infos, 'MediaWiki\\Session\\SessionInfo::compare' );
484 $info = array_pop( $infos );
485 if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
488 $info = array_pop( $infos );
489 if ( SessionInfo
::compare( $retInfos[0], $info ) ) {
490 // We hit a lower priority, stop checking.
493 if ( $this->loadSessionInfoFromStore( $info, $request ) ) {
494 // This is going to error out below, but we want to
495 // provide a complete list.
498 // Session load failed, so unpersist it from this request
499 $info->getProvider()->unpersistSession( $request );
503 // Session load failed, so unpersist it from this request
504 $info->getProvider()->unpersistSession( $request );
508 if ( count( $retInfos ) > 1 ) {
509 $ex = new \
OverflowException(
510 'Multiple sessions for this request tied for top priority: ' . implode( ', ', $retInfos )
512 $ex->sessionInfos
= $retInfos;
516 return $retInfos ?
$retInfos[0] : null;
520 * Load and verify the session info against the store
522 * @param SessionInfo &$info Will likely be replaced with an updated SessionInfo instance
523 * @param WebRequest $request
524 * @return bool Whether the session info matches the stored data (if any)
526 private function loadSessionInfoFromStore( SessionInfo
&$info, WebRequest
$request ) {
527 $key = $this->store
->makeKey( 'MWSession', $info->getId() );
528 $blob = $this->store
->get( $key );
530 // If we got data from the store and the SessionInfo says to force use,
531 // "fail" means to delete the data from the store and retry. Otherwise,
532 // "fail" is just return false.
533 if ( $info->forceUse() && $blob !== false ) {
534 $failHandler = function () use ( $key, &$info, $request ) {
535 $this->store
->delete( $key );
536 return $this->loadSessionInfoFromStore( $info, $request );
539 $failHandler = function () {
546 if ( $blob !== false ) {
547 // Sanity check: blob must be an array, if it's saved at all
548 if ( !is_array( $blob ) ) {
549 $this->logger
->warning( 'Session "{session}": Bad data', [
552 $this->store
->delete( $key );
553 return $failHandler();
556 // Sanity check: blob has data and metadata arrays
557 if ( !isset( $blob['data'] ) ||
!is_array( $blob['data'] ) ||
558 !isset( $blob['metadata'] ) ||
!is_array( $blob['metadata'] )
560 $this->logger
->warning( 'Session "{session}": Bad data structure', [
563 $this->store
->delete( $key );
564 return $failHandler();
567 $data = $blob['data'];
568 $metadata = $blob['metadata'];
570 // Sanity check: metadata must be an array and must contain certain
571 // keys, if it's saved at all
572 if ( !array_key_exists( 'userId', $metadata ) ||
573 !array_key_exists( 'userName', $metadata ) ||
574 !array_key_exists( 'userToken', $metadata ) ||
575 !array_key_exists( 'provider', $metadata )
577 $this->logger
->warning( 'Session "{session}": Bad metadata', [
580 $this->store
->delete( $key );
581 return $failHandler();
584 // First, load the provider from metadata, or validate it against the metadata.
585 $provider = $info->getProvider();
586 if ( $provider === null ) {
587 $newParams['provider'] = $provider = $this->getProvider( $metadata['provider'] );
589 $this->logger
->warning(
590 'Session "{session}": Unknown provider ' . $metadata['provider'],
595 $this->store
->delete( $key );
596 return $failHandler();
598 } elseif ( $metadata['provider'] !== (string)$provider ) {
599 $this->logger
->warning( 'Session "{session}": Wrong provider ' .
600 $metadata['provider'] . ' !== ' . $provider,
604 return $failHandler();
607 // Load provider metadata from metadata, or validate it against the metadata
608 $providerMetadata = $info->getProviderMetadata();
609 if ( isset( $metadata['providerMetadata'] ) ) {
610 if ( $providerMetadata === null ) {
611 $newParams['metadata'] = $metadata['providerMetadata'];
614 $newProviderMetadata = $provider->mergeMetadata(
615 $metadata['providerMetadata'], $providerMetadata
617 if ( $newProviderMetadata !== $providerMetadata ) {
618 $newParams['metadata'] = $newProviderMetadata;
620 } catch ( MetadataMergeException
$ex ) {
621 $this->logger
->warning(
622 'Session "{session}": Metadata merge failed: {exception}',
626 ] +
$ex->getContext()
628 return $failHandler();
633 // Next, load the user from metadata, or validate it against the metadata.
634 $userInfo = $info->getUserInfo();
636 // For loading, id is preferred to name.
638 if ( $metadata['userId'] ) {
639 $userInfo = UserInfo
::newFromId( $metadata['userId'] );
640 } elseif ( $metadata['userName'] !== null ) { // Shouldn't happen, but just in case
641 $userInfo = UserInfo
::newFromName( $metadata['userName'] );
643 $userInfo = UserInfo
::newAnonymous();
645 } catch ( \InvalidArgumentException
$ex ) {
646 $this->logger
->error( 'Session "{session}": {exception}', [
650 return $failHandler();
652 $newParams['userInfo'] = $userInfo;
654 // User validation passes if user ID matches, or if there
655 // is no saved ID and the names match.
656 if ( $metadata['userId'] ) {
657 if ( $metadata['userId'] !== $userInfo->getId() ) {
658 $this->logger
->warning(
659 'Session "{session}": User ID mismatch, {uid_a} !== {uid_b}',
662 'uid_a' => $metadata['userId'],
663 'uid_b' => $userInfo->getId(),
665 return $failHandler();
668 // If the user was renamed, probably best to fail here.
669 if ( $metadata['userName'] !== null &&
670 $userInfo->getName() !== $metadata['userName']
672 $this->logger
->warning(
673 'Session "{session}": User ID matched but name didn\'t (rename?), {uname_a} !== {uname_b}',
676 'uname_a' => $metadata['userName'],
677 'uname_b' => $userInfo->getName(),
679 return $failHandler();
682 } elseif ( $metadata['userName'] !== null ) { // Shouldn't happen, but just in case
683 if ( $metadata['userName'] !== $userInfo->getName() ) {
684 $this->logger
->warning(
685 'Session "{session}": User name mismatch, {uname_a} !== {uname_b}',
688 'uname_a' => $metadata['userName'],
689 'uname_b' => $userInfo->getName(),
691 return $failHandler();
693 } elseif ( !$userInfo->isAnon() ) {
694 // Metadata specifies an anonymous user, but the passed-in
695 // user isn't anonymous.
696 $this->logger
->warning(
697 'Session "{session}": Metadata has an anonymous user, but a non-anon user was provided',
701 return $failHandler();
705 // And if we have a token in the metadata, it must match the loaded/provided user.
706 if ( $metadata['userToken'] !== null &&
707 $userInfo->getToken() !== $metadata['userToken']
709 $this->logger
->warning( 'Session "{session}": User token mismatch', [
712 return $failHandler();
714 if ( !$userInfo->isVerified() ) {
715 $newParams['userInfo'] = $userInfo->verified();
718 if ( !empty( $metadata['remember'] ) && !$info->wasRemembered() ) {
719 $newParams['remembered'] = true;
721 if ( !empty( $metadata['forceHTTPS'] ) && !$info->forceHTTPS() ) {
722 $newParams['forceHTTPS'] = true;
724 if ( !empty( $metadata['persisted'] ) && !$info->wasPersisted() ) {
725 $newParams['persisted'] = true;
728 if ( !$info->isIdSafe() ) {
729 $newParams['idIsSafe'] = true;
732 // No metadata, so we can't load the provider if one wasn't given.
733 if ( $info->getProvider() === null ) {
734 $this->logger
->warning(
735 'Session "{session}": Null provider and no metadata',
739 return $failHandler();
742 // If no user was provided and no metadata, it must be anon.
743 if ( !$info->getUserInfo() ) {
744 if ( $info->getProvider()->canChangeUser() ) {
745 $newParams['userInfo'] = UserInfo
::newAnonymous();
748 'Session "{session}": No user provided and provider cannot set user',
752 return $failHandler();
754 } elseif ( !$info->getUserInfo()->isVerified() ) {
755 // probably just a session timeout
757 'Session "{session}": Unverified user provided and no metadata to auth it',
761 return $failHandler();
767 if ( !$info->getProvider()->persistsSessionId() && !$info->isIdSafe() ) {
768 // The ID doesn't come from the user, so it should be safe
769 // (and if not, nothing we can do about it anyway)
770 $newParams['idIsSafe'] = true;
774 // Construct the replacement SessionInfo, if necessary
776 $newParams['copyFrom'] = $info;
777 $info = new SessionInfo( $info->getPriority(), $newParams );
780 // Allow the provider to check the loaded SessionInfo
781 $providerMetadata = $info->getProviderMetadata();
782 if ( !$info->getProvider()->refreshSessionInfo( $info, $request, $providerMetadata ) ) {
783 return $failHandler();
785 if ( $providerMetadata !== $info->getProviderMetadata() ) {
786 $info = new SessionInfo( $info->getPriority(), [
787 'metadata' => $providerMetadata,
792 // Give hooks a chance to abort. Combined with the SessionMetadata
793 // hook, this can allow for tying a session to an IP address or the
795 $reason = 'Hook aborted';
798 [ &$reason, $info, $request, $metadata, $data ]
800 $this->logger
->warning( 'Session "{session}": ' . $reason, [
803 return $failHandler();
810 * Create a Session corresponding to the passed SessionInfo
811 * @private For use by a SessionProvider that needs to specially create its
812 * own Session. Most session providers won't need this.
813 * @param SessionInfo $info
814 * @param WebRequest $request
817 public function getSessionFromInfo( SessionInfo
$info, WebRequest
$request ) {
818 // @codeCoverageIgnoreStart
819 if ( defined( 'MW_NO_SESSION' ) ) {
820 // @phan-suppress-next-line PhanUndeclaredConstant
821 if ( MW_NO_SESSION
=== 'warn' ) {
822 // Undocumented safety case for converting existing entry points
823 $this->logger
->error( 'Sessions are supposed to be disabled for this entry point', [
824 'exception' => new \
BadMethodCallException( 'Sessions are disabled for this entry point' ),
827 throw new \
BadMethodCallException( 'Sessions are disabled for this entry point' );
830 // @codeCoverageIgnoreEnd
832 $id = $info->getId();
834 if ( !isset( $this->allSessionBackends
[$id] ) ) {
835 if ( !isset( $this->allSessionIds
[$id] ) ) {
836 $this->allSessionIds
[$id] = new SessionId( $id );
838 $backend = new SessionBackend(
839 $this->allSessionIds
[$id],
843 $this->config
->get( 'ObjectCacheSessionExpiry' )
845 $this->allSessionBackends
[$id] = $backend;
846 $delay = $backend->delaySave();
848 $backend = $this->allSessionBackends
[$id];
849 $delay = $backend->delaySave();
850 if ( $info->wasPersisted() ) {
853 if ( $info->wasRemembered() ) {
854 $backend->setRememberUser( true );
858 $request->setSessionId( $backend->getSessionId() );
859 $session = $backend->getSession( $request );
861 if ( !$info->isIdSafe() ) {
865 \Wikimedia\ScopedCallback
::consume( $delay );
870 * Deregister a SessionBackend
871 * @private For use from \MediaWiki\Session\SessionBackend only
872 * @param SessionBackend $backend
874 public function deregisterSessionBackend( SessionBackend
$backend ) {
875 $id = $backend->getId();
876 if ( !isset( $this->allSessionBackends
[$id] ) ||
!isset( $this->allSessionIds
[$id] ) ||
877 $this->allSessionBackends
[$id] !== $backend ||
878 $this->allSessionIds
[$id] !== $backend->getSessionId()
880 throw new \
InvalidArgumentException( 'Backend was not registered with this SessionManager' );
883 unset( $this->allSessionBackends
[$id] );
884 // Explicitly do not unset $this->allSessionIds[$id]
888 * Change a SessionBackend's ID
889 * @private For use from \MediaWiki\Session\SessionBackend only
890 * @param SessionBackend $backend
892 public function changeBackendId( SessionBackend
$backend ) {
893 $sessionId = $backend->getSessionId();
894 $oldId = (string)$sessionId;
895 if ( !isset( $this->allSessionBackends
[$oldId] ) ||
!isset( $this->allSessionIds
[$oldId] ) ||
896 $this->allSessionBackends
[$oldId] !== $backend ||
897 $this->allSessionIds
[$oldId] !== $sessionId
899 throw new \
InvalidArgumentException( 'Backend was not registered with this SessionManager' );
902 $newId = $this->generateSessionId();
904 unset( $this->allSessionBackends
[$oldId], $this->allSessionIds
[$oldId] );
905 $sessionId->setId( $newId );
906 $this->allSessionBackends
[$newId] = $backend;
907 $this->allSessionIds
[$newId] = $sessionId;
911 * Generate a new random session ID
914 public function generateSessionId() {
916 $id = \Wikimedia\base_convert
( \MWCryptRand
::generateHex( 40 ), 16, 32, 32 );
917 $key = $this->store
->makeKey( 'MWSession', $id );
918 } while ( isset( $this->allSessionIds
[$id] ) ||
is_array( $this->store
->get( $key ) ) );
923 * Call setters on a PHPSessionHandler
924 * @private Use PhpSessionHandler::install()
925 * @param PHPSessionHandler $handler
927 public function setupPHPSessionHandler( PHPSessionHandler
$handler ) {
928 $handler->setManager( $this, $this->store
, $this->logger
);
932 * Reset the internal caching for unit testing
933 * @protected Unit tests only
935 public static function resetCache() {
936 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
937 // @codeCoverageIgnoreStart
938 throw new MWException( __METHOD__
. ' may only be called from unit tests!' );
939 // @codeCoverageIgnoreEnd
942 self
::$globalSession = null;
943 self
::$globalSessionRequest = null;