MediaWiki  1.27.2
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  $response->setCookie( 'forceHTTPS', 'true', null,
117  [ 'prefix' => '', 'secure' => false ] + $options );
118  $options['secure'] = true;
119  }
120 
121  $response->setCookie( $this->sessionCookieName, $session->getId(), null, $options );
122  }
123 
124  public function unpersistSession( WebRequest $request ) {
125  if ( $this->sessionCookieName === null ) {
126  return;
127  }
128 
129  $response = $request->response();
130  if ( $response->headersSent() ) {
131  // Can't do anything now
132  $this->logger->debug( __METHOD__ . ': Headers already sent' );
133  return;
134  }
135 
136  $response->clearCookie( $this->sessionCookieName, $this->sessionCookieOptions );
137  }
138 
139  public function getVaryCookies() {
140  if ( $this->sessionCookieName === null ) {
141  return [];
142  }
143 
144  $prefix = isset( $this->sessionCookieOptions['prefix'] )
145  ? $this->sessionCookieOptions['prefix']
146  : $this->config->get( 'CookiePrefix' );
147  return [ $prefix . $this->sessionCookieName ];
148  }
149 
150  public function whyNoSession() {
151  return wfMessage( 'sessionprovider-nocookies' );
152  }
153 }
getUser()
Returns the authenticated user for this session.
This is the actual workhorse for Session.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
response()
Return a handle to WebResponse style object, for setting cookies, headers and other stuff...
Definition: WebRequest.php:937
this hook is for auditing only $response
Definition: hooks.txt:762
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1004
A SessionProvider provides SessionInfo and support for Session.
An ImmutableSessionProviderWithCookie doesn't persist the user, but optionally can use a cookie to su...
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
$params
getId()
Returns the session ID.
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
error also a ContextSource you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2418
static validateSessionId($id)
Validate a session ID.
getCookie($key, $prefix=null, $default=null)
Get a cookie from the $_COOKIE jar.
Definition: WebRequest.php:749
getSessionIdFromCookie(WebRequest $request)
Get the session ID from the cookie, if any.
shouldForceHTTPS()
Whether HTTPS should be forced.
whyNoSession()
Return a Message for why sessions might not be being persisted.