MediaWiki  REL1_31
ImmutableSessionProviderWithCookie.php
Go to the documentation of this file.
1 <?php
24 namespace MediaWiki\Session;
25 
27 
41 
43  protected $sessionCookieName = null;
44  protected $sessionCookieOptions = [];
45 
52  public function __construct( $params = [] ) {
53  parent::__construct();
54 
55  if ( isset( $params['sessionCookieName'] ) ) {
56  if ( !is_string( $params['sessionCookieName'] ) ) {
57  throw new \InvalidArgumentException( 'sessionCookieName must be a string' );
58  }
59  $this->sessionCookieName = $params['sessionCookieName'];
60  }
61  if ( isset( $params['sessionCookieOptions'] ) ) {
62  if ( !is_array( $params['sessionCookieOptions'] ) ) {
63  throw new \InvalidArgumentException( 'sessionCookieOptions must be an array' );
64  }
65  $this->sessionCookieOptions = $params['sessionCookieOptions'];
66  }
67  }
68 
80  protected function getSessionIdFromCookie( WebRequest $request ) {
81  if ( $this->sessionCookieName === null ) {
82  throw new \BadMethodCallException(
83  __METHOD__ . ' may not be called when $this->sessionCookieName === null'
84  );
85  }
86 
87  $prefix = isset( $this->sessionCookieOptions['prefix'] )
88  ? $this->sessionCookieOptions['prefix']
89  : $this->config->get( 'CookiePrefix' );
90  $id = $request->getCookie( $this->sessionCookieName, $prefix );
91  return SessionManager::validateSessionId( $id ) ? $id : null;
92  }
93 
94  public function persistsSessionId() {
95  return $this->sessionCookieName !== null;
96  }
97 
98  public function canChangeUser() {
99  return false;
100  }
101 
102  public function persistSession( SessionBackend $session, WebRequest $request ) {
103  if ( $this->sessionCookieName === null ) {
104  return;
105  }
106 
107  $response = $request->response();
108  if ( $response->headersSent() ) {
109  // Can't do anything now
110  $this->logger->debug( __METHOD__ . ': Headers already sent' );
111  return;
112  }
113 
115  if ( $session->shouldForceHTTPS() || $session->getUser()->requiresHTTPS() ) {
116  // Send a cookie unless $wgForceHTTPS is set (T256095)
117  if ( !$this->config->get( 'ForceHTTPS' ) ) {
118  $response->setCookie( 'forceHTTPS', 'true', null,
119  [ 'prefix' => '', 'secure' => false ] + $options );
120  }
121  $options['secure'] = true;
122  }
123 
124  $response->setCookie( $this->sessionCookieName, $session->getId(), null, $options );
125  }
126 
127  public function unpersistSession( WebRequest $request ) {
128  if ( $this->sessionCookieName === null ) {
129  return;
130  }
131 
132  $response = $request->response();
133  if ( $response->headersSent() ) {
134  // Can't do anything now
135  $this->logger->debug( __METHOD__ . ': Headers already sent' );
136  return;
137  }
138 
139  $response->clearCookie( $this->sessionCookieName, $this->sessionCookieOptions );
140  }
141 
142  public function getVaryCookies() {
143  if ( $this->sessionCookieName === null ) {
144  return [];
145  }
146 
147  $prefix = isset( $this->sessionCookieOptions['prefix'] )
148  ? $this->sessionCookieOptions['prefix']
149  : $this->config->get( 'CookiePrefix' );
150  return [ $prefix . $this->sessionCookieName ];
151  }
152 
153  public function whyNoSession() {
154  return wfMessage( 'sessionprovider-nocookies' );
155  }
156 }
MediaWiki\Session\ImmutableSessionProviderWithCookie\$sessionCookieName
string null $sessionCookieName
Definition: ImmutableSessionProviderWithCookie.php:43
MediaWiki\Session\ImmutableSessionProviderWithCookie\getSessionIdFromCookie
getSessionIdFromCookie(WebRequest $request)
Get the session ID from the cookie, if any.
Definition: ImmutableSessionProviderWithCookie.php:80
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
MediaWiki\Session\SessionBackend\getUser
getUser()
Returns the authenticated user for this session.
Definition: SessionBackend.php:369
wfMessage
either a unescaped string or a HtmlArmor object 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 unset offset - wrap String Wrap the message in html(usually something like "&lt
$response
this hook is for auditing only $response
Definition: hooks.txt:783
MediaWiki\Session\SessionBackend\getId
getId()
Returns the session ID.
Definition: SessionBackend.php:205
$params
$params
Definition: styleTest.css.php:40
MediaWiki\Session\ImmutableSessionProviderWithCookie\unpersistSession
unpersistSession(WebRequest $request)
Remove any persisted session from a request/response.
Definition: ImmutableSessionProviderWithCookie.php:127
php
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:37
MediaWiki\Session\ImmutableSessionProviderWithCookie
An ImmutableSessionProviderWithCookie doesn't persist the user, but optionally can use a cookie to su...
Definition: ImmutableSessionProviderWithCookie.php:40
MediaWiki\Session\SessionManager\validateSessionId
static validateSessionId( $id)
Validate a session ID.
Definition: SessionManager.php:371
MediaWiki\Session\ImmutableSessionProviderWithCookie\canChangeUser
canChangeUser()
Indicate whether the user associated with the request can be changed.
Definition: ImmutableSessionProviderWithCookie.php:98
MediaWiki\Session\SessionProvider
A SessionProvider provides SessionInfo and support for Session.
Definition: SessionProvider.php:78
MediaWiki\Session
Definition: BotPasswordSessionProvider.php:24
$options
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 & $options
Definition: hooks.txt:2001
MediaWiki\Session\SessionBackend\shouldForceHTTPS
shouldForceHTTPS()
Whether HTTPS should be forced.
Definition: SessionBackend.php:429
MediaWiki\Session\ImmutableSessionProviderWithCookie\$sessionCookieOptions
$sessionCookieOptions
Definition: ImmutableSessionProviderWithCookie.php:44
WebRequest
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
Definition: WebRequest.php:38
MediaWiki\Session\ImmutableSessionProviderWithCookie\persistSession
persistSession(SessionBackend $session, WebRequest $request)
Persist a session into a request/response.
Definition: ImmutableSessionProviderWithCookie.php:102
MediaWiki\Session\ImmutableSessionProviderWithCookie\persistsSessionId
persistsSessionId()
Indicate whether self::persistSession() can save arbitrary session IDs.
Definition: ImmutableSessionProviderWithCookie.php:94
MediaWiki\Session\ImmutableSessionProviderWithCookie\whyNoSession
whyNoSession()
Return a Message for why sessions might not be being persisted.
Definition: ImmutableSessionProviderWithCookie.php:153
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
MediaWiki\Session\ImmutableSessionProviderWithCookie\getVaryCookies
getVaryCookies()
Return the list of cookies that need varying on.
Definition: ImmutableSessionProviderWithCookie.php:142
MediaWiki\Session\ImmutableSessionProviderWithCookie\__construct
__construct( $params=[])
Definition: ImmutableSessionProviderWithCookie.php:52
MediaWiki\Session\SessionBackend
This is the actual workhorse for Session.
Definition: SessionBackend.php:49