MediaWiki  1.27.1
SessionProvider.php
Go to the documentation of this file.
1 <?php
24 namespace MediaWiki\Session;
25 
28 use Config;
30 use User;
32 
77 abstract class SessionProvider implements SessionProviderInterface, LoggerAwareInterface {
78 
80  protected $logger;
81 
83  protected $config;
84 
86  protected $manager;
87 
91  protected $priority;
92 
99  public function __construct() {
100  $this->priority = SessionInfo::MIN_PRIORITY + 10;
101  }
102 
103  public function setLogger( LoggerInterface $logger ) {
104  $this->logger = $logger;
105  }
106 
111  public function setConfig( Config $config ) {
112  $this->config = $config;
113  }
114 
119  public function setManager( SessionManager $manager ) {
120  $this->manager = $manager;
121  }
122 
127  public function getManager() {
128  return $this->manager;
129  }
130 
153  abstract public function provideSessionInfo( WebRequest $request );
154 
168  public function newSessionInfo( $id = null ) {
169  if ( $this->canChangeUser() && $this->persistsSessionId() ) {
170  return new SessionInfo( $this->priority, [
171  'id' => $id,
172  'provider' => $this,
173  'persisted' => false,
174  'idIsSafe' => true,
175  ] );
176  }
177  return null;
178  }
179 
192  public function mergeMetadata( array $savedMetadata, array $providedMetadata ) {
193  foreach ( $providedMetadata as $k => $v ) {
194  if ( array_key_exists( $k, $savedMetadata ) && $savedMetadata[$k] !== $v ) {
195  $e = new MetadataMergeException( "Key \"$k\" changed" );
196  $e->setContext( [
197  'old_value' => $savedMetadata[$k],
198  'new_value' => $v,
199  ] );
200  throw $e;
201  }
202  }
203  return $providedMetadata;
204  }
205 
219  public function refreshSessionInfo( SessionInfo $info, WebRequest $request, &$metadata ) {
220  return true;
221  }
222 
249  abstract public function persistsSessionId();
250 
276  abstract public function canChangeUser();
277 
284  public function getRememberUserDuration() {
285  return null;
286  }
287 
298  public function sessionIdWasReset( SessionBackend $session, $oldId ) {
299  }
300 
328  abstract public function persistSession( SessionBackend $session, WebRequest $request );
329 
341  abstract public function unpersistSession( WebRequest $request );
342 
364  public function preventSessionsForUser( $username ) {
365  if ( !$this->canChangeUser() ) {
366  throw new \BadMethodCallException(
367  __METHOD__ . ' must be implmented when canChangeUser() is false'
368  );
369  }
370  }
371 
382  public function invalidateSessionsForUser( User $user ) {
383  }
384 
398  public function getVaryHeaders() {
399  return [];
400  }
401 
407  public function getVaryCookies() {
408  return [];
409  }
410 
418  return null;
419  }
420 
426  public function getAllowedUserRights( SessionBackend $backend ) {
427  if ( $backend->getProvider() !== $this ) {
428  // Not that this should ever happen...
429  throw new \InvalidArgumentException( 'Backend\'s provider isn\'t $this' );
430  }
431 
432  return null;
433  }
434 
442  public function __toString() {
443  return get_class( $this );
444  }
445 
461  protected function describeMessage() {
462  return wfMessage(
463  'sessionprovider-' . str_replace( '\\', '-', strtolower( get_class( $this ) ) )
464  );
465  }
466 
467  public function describe( Language $lang ) {
468  $msg = $this->describeMessage();
469  $msg->inLanguage( $lang );
470  if ( $msg->isDisabled() ) {
471  $msg = wfMessage( 'sessionprovider-generic', (string)$this )->inLanguage( $lang );
472  }
473  return $msg->plain();
474  }
475 
476  public function whyNoSession() {
477  return null;
478  }
479 
493  final protected function hashToSessionId( $data, $key = null ) {
494  if ( !is_string( $data ) ) {
495  throw new \InvalidArgumentException(
496  '$data must be a string, ' . gettype( $data ) . ' was passed'
497  );
498  }
499  if ( $key !== null && !is_string( $key ) ) {
500  throw new \InvalidArgumentException(
501  '$key must be a string or null, ' . gettype( $key ) . ' was passed'
502  );
503  }
504 
505  $hash = \MWCryptHash::hmac( "$this\n$data", $key ?: $this->config->get( 'SecretKey' ), false );
506  if ( strlen( $hash ) < 32 ) {
507  // Should never happen, even md5 is 128 bits
508  // @codeCoverageIgnoreStart
509  throw new \UnexpectedValueException( 'Hash fuction returned less than 128 bits' );
510  // @codeCoverageIgnoreEnd
511  }
512  if ( strlen( $hash ) >= 40 ) {
513  $hash = wfBaseConvert( $hash, 16, 32, 32 );
514  }
515  return substr( $hash, -32 );
516  }
517 
518 }
const MIN_PRIORITY
Minimum allowed priority.
Definition: SessionInfo.php:36
describe(Language $lang)
Return an identifier for this session type.
persistSession(SessionBackend $session, WebRequest $request)
Persist a session into a request/response.
This is the actual workhorse for Session.
the array() calling protocol came about after MediaWiki 1.4rc1.
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
Definition: hooks.txt:2321
getProvider()
Fetch the SessionProvider for this session.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:1932
unpersistSession(WebRequest $request)
Remove any persisted session from a request/response.
if(!isset($args[0])) $lang
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:189
Subclass of UnexpectedValueException that can be annotated with additional data for debug logging...
canChangeUser()
Indicate whether the user associated with the request can be changed.
setManager(SessionManager $manager)
Set the session manager.
getVaryCookies()
Return the list of cookies that need varying on.
persistsSessionId()
Indicate whether self::persistSession() can save arbitrary session IDs.
suggestLoginUsername(WebRequest $request)
Get a suggested username for the login form.
getManager()
Get the session manager.
setLogger(LoggerInterface $logger)
A SessionProvider provides SessionInfo and support for Session.
This exists to make IDEs happy, so they don't see the internal-but-required-to-be-public methods on S...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
setConfig(Config $config)
Set configuration.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
whyNoSession()
Return a Message for why sessions might not be being persisted.
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
provideSessionInfo(WebRequest $request)
Provide session info for a request.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
this hook is for auditing only or null if authentication failed before getting that far $username
Definition: hooks.txt:762
wfBaseConvert($input, $sourceBase, $destBase, $pad=1, $lowercase=true, $engine= 'auto')
Convert an arbitrarily-long digit string from one numeric base to another, optionally zero-padding to...
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2418
static hmac($data, $key, $raw=true)
Generate an acceptably unstable one-way-hmac of some text making use of the best hash algorithm that ...
getRememberUserDuration()
Returns the duration (in seconds) for which users will be remembered when Session::setRememberUser() ...
mergeMetadata(array $savedMetadata, array $providedMetadata)
Merge saved session provider metadata.
sessionIdWasReset(SessionBackend $session, $oldId)
Notification that the session ID was reset.
describeMessage()
Return a Message identifying this session type.
getVaryHeaders()
Return the HTTP headers that need varying on.
hashToSessionId($data, $key=null)
Hash data as a session ID.
getAllowedUserRights(SessionBackend $backend)
Fetch the rights allowed the user when the specified session is active.
This serves as the entry point to the MediaWiki session handling system.
preventSessionsForUser($username)
Prevent future sessions for the user.
newSessionInfo($id=null)
Provide session info for a new, empty session.
invalidateSessionsForUser(User $user)
Invalidate existing sessions for a user.
refreshSessionInfo(SessionInfo $info, WebRequest $request, &$metadata)
Validate a loaded SessionInfo and refresh provider metadata.
Value object returned by SessionProvider.
Definition: SessionInfo.php:34