3 * Request-dependant objects containers.
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
22 * @author Alexandre Emsenhuber
23 * @author Daniel Friesen
28 * Group all the pieces relevant to the context of a request into one instance
30 class RequestContext
implements IContextSource
{
72 * Set the Config object
76 public function setConfig( Config
$c ) {
81 * Get the Config object
85 public function getConfig() {
86 if ( $this->config
=== null ) {
87 $this->config
= Config
::factory();
93 * Set the WebRequest object
95 * @param WebRequest $r
97 public function setRequest( WebRequest
$r ) {
102 * Get the WebRequest object
106 public function getRequest() {
107 if ( $this->request
=== null ) {
108 global $wgRequest; # fallback to $wg till we can improve this
109 $this->request
= $wgRequest;
112 return $this->request
;
116 * Set the Title object
119 * @throws MWException
121 public function setTitle( $t ) {
122 if ( $t !== null && !$t instanceof Title
) {
123 throw new MWException( __METHOD__
. " expects an instance of Title" );
126 // Erase the WikiPage so a new one with the new title gets created.
127 $this->wikipage
= null;
131 * Get the Title object
135 public function getTitle() {
136 if ( $this->title
=== null ) {
137 global $wgTitle; # fallback to $wg till we can improve this
138 $this->title
= $wgTitle;
145 * Check whether a WikiPage object can be get with getWikiPage().
146 * Callers should expect that an exception is thrown from getWikiPage()
147 * if this method returns false.
152 public function canUseWikiPage() {
153 if ( $this->wikipage
!== null ) {
154 # If there's a WikiPage object set, we can for sure get it
157 $title = $this->getTitle();
158 if ( $title === null ) {
159 # No Title, no WikiPage
162 # Only namespaces whose pages are stored in the database can have WikiPage
163 return $title->canExist();
168 * Set the WikiPage object
173 public function setWikiPage( WikiPage
$p ) {
174 $contextTitle = $this->getTitle();
175 $pageTitle = $p->getTitle();
176 if ( !$contextTitle ||
!$pageTitle->equals( $contextTitle ) ) {
177 $this->setTitle( $pageTitle );
179 // Defer this to the end since setTitle sets it to null.
180 $this->wikipage
= $p;
184 * Get the WikiPage object.
185 * May throw an exception if there's no Title object set or the Title object
186 * belongs to a special namespace that doesn't have WikiPage, so use first
187 * canUseWikiPage() to check whether this method can be called safely.
190 * @throws MWException
193 public function getWikiPage() {
194 if ( $this->wikipage
=== null ) {
195 $title = $this->getTitle();
196 if ( $title === null ) {
197 throw new MWException( __METHOD__
. ' called without Title object set' );
199 $this->wikipage
= WikiPage
::factory( $title );
202 return $this->wikipage
;
206 * @param $o OutputPage
208 public function setOutput( OutputPage
$o ) {
213 * Get the OutputPage object
217 public function getOutput() {
218 if ( $this->output
=== null ) {
219 $this->output
= new OutputPage( $this );
222 return $this->output
;
226 * Set the User object
230 public function setUser( User
$u ) {
235 * Get the User object
239 public function getUser() {
240 if ( $this->user
=== null ) {
241 $this->user
= User
::newFromSession( $this->getRequest() );
248 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
249 * code and replaces with $wgLanguageCode if not sane.
250 * @param string $code Language code
253 public static function sanitizeLangCode( $code ) {
254 global $wgLanguageCode;
256 // BCP 47 - letter case MUST NOT carry meaning
257 $code = strtolower( $code );
260 if ( empty( $code ) ||
!Language
::isValidCode( $code ) ||
( $code === 'qqq' ) ) {
261 wfDebug( "Invalid user language code\n" );
262 $code = $wgLanguageCode;
269 * Set the Language object
271 * @deprecated since 1.19 Use setLanguage instead
272 * @param Language|string $l Language instance or language code
274 public function setLang( $l ) {
275 wfDeprecated( __METHOD__
, '1.19' );
276 $this->setLanguage( $l );
280 * Set the Language object
282 * @param Language|string $l Language instance or language code
283 * @throws MWException
286 public function setLanguage( $l ) {
287 if ( $l instanceof Language
) {
289 } elseif ( is_string( $l ) ) {
290 $l = self
::sanitizeLangCode( $l );
291 $obj = Language
::factory( $l );
294 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
299 * @deprecated since 1.19 Use getLanguage instead
302 public function getLang() {
303 wfDeprecated( __METHOD__
, '1.19' );
305 return $this->getLanguage();
309 * Get the Language object.
310 * Initialization of user or request objects can depend on this.
315 public function getLanguage() {
316 if ( isset( $this->recursion
) ) {
317 trigger_error( "Recursion detected in " . __METHOD__
, E_USER_WARNING
);
319 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
321 global $wgLanguageCode;
322 $code = ( $wgLanguageCode ) ?
$wgLanguageCode : 'en';
323 $this->lang
= Language
::factory( $code );
324 } elseif ( $this->lang
=== null ) {
325 $this->recursion
= true;
327 global $wgLanguageCode, $wgContLang;
329 $request = $this->getRequest();
330 $user = $this->getUser();
332 $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
333 $code = self
::sanitizeLangCode( $code );
335 wfRunHooks( 'UserGetLanguageObject', array( $user, &$code, $this ) );
337 if ( $code === $wgLanguageCode ) {
338 $this->lang
= $wgContLang;
340 $obj = Language
::factory( $code );
344 unset( $this->recursion
);
351 * Set the Skin object
355 public function setSkin( Skin
$s ) {
356 $this->skin
= clone $s;
357 $this->skin
->setContext( $this );
361 * Get the Skin object
365 public function getSkin() {
366 if ( $this->skin
=== null ) {
367 wfProfileIn( __METHOD__
. '-createskin' );
370 wfRunHooks( 'RequestContextCreateSkin', array( $this, &$skin ) );
372 // If the hook worked try to set a skin from it
373 if ( $skin instanceof Skin
) {
375 } elseif ( is_string( $skin ) ) {
376 $this->skin
= Skin
::newFromKey( $skin );
379 // If this is still null (the hook didn't run or didn't work)
380 // then go through the normal processing to load a skin
381 if ( $this->skin
=== null ) {
382 global $wgHiddenPrefs;
383 if ( !in_array( 'skin', $wgHiddenPrefs ) ) {
385 $userSkin = $this->getUser()->getOption( 'skin' );
386 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
388 # if we're not allowing users to override, then use the default
389 global $wgDefaultSkin;
390 $userSkin = $wgDefaultSkin;
393 $this->skin
= Skin
::newFromKey( $userSkin );
396 // After all that set a context on whatever skin got created
397 $this->skin
->setContext( $this );
398 wfProfileOut( __METHOD__
. '-createskin' );
404 /** Helpful methods **/
407 * Get a Message object with context set
408 * Parameters are the same as wfMessage()
412 public function msg() {
413 $args = func_get_args();
415 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
418 /** Static methods **/
421 * Get the RequestContext object associated with the main request
423 * @return RequestContext
425 public static function getMain() {
426 static $instance = null;
427 if ( $instance === null ) {
428 $instance = new self
;
435 * Export the resolved user IP, HTTP headers, user ID, and session ID.
436 * The result will be reasonably sized to allow for serialization.
441 public function exportSession() {
443 'ip' => $this->getRequest()->getIP(),
444 'headers' => $this->getRequest()->getAllHeaders(),
445 'sessionId' => session_id(),
446 'userId' => $this->getUser()->getId()
451 * Import the resolved user IP, HTTP headers, user ID, and session ID.
452 * This sets the current session and sets $wgUser and $wgRequest.
453 * Once the return value falls out of scope, the old context is restored.
454 * This function can only be called within CLI mode scripts.
456 * This will setup the session from the given ID. This is useful when
457 * background scripts inherit context when acting on behalf of a user.
459 * @note suhosin.session.encrypt may interfere with this method.
461 * @param array $params Result of RequestContext::exportSession()
462 * @return ScopedCallback
463 * @throws MWException
466 public static function importScopedSession( array $params ) {
467 if ( PHP_SAPI
!== 'cli' ) {
468 // Don't send random private cookies or turn $wgRequest into FauxRequest
469 throw new MWException( "Sessions can only be imported in cli mode." );
470 } elseif ( !strlen( $params['sessionId'] ) ) {
471 throw new MWException( "No session ID was specified." );
474 if ( $params['userId'] ) { // logged-in user
475 $user = User
::newFromId( $params['userId'] );
477 throw new MWException( "No user with ID '{$params['userId']}'." );
479 } elseif ( !IP
::isValid( $params['ip'] ) ) {
480 throw new MWException( "Could not load user '{$params['ip']}'." );
481 } else { // anon user
482 $user = User
::newFromName( $params['ip'], false );
485 $importSessionFunction = function ( User
$user, array $params ) {
486 global $wgRequest, $wgUser;
488 $context = RequestContext
::getMain();
489 // Commit and close any current session
490 session_write_close(); // persist
491 session_id( '' ); // detach
492 $_SESSION = array(); // clear in-memory array
493 // Remove any user IP or agent information
494 $context->setRequest( new FauxRequest() );
495 $wgRequest = $context->getRequest(); // b/c
496 // Now that all private information is detached from the user, it should
497 // be safe to load the new user. If errors occur or an exception is thrown
498 // and caught (leaving the main context in a mixed state), there is no risk
499 // of the User object being attached to the wrong IP, headers, or session.
500 $context->setUser( $user );
501 $wgUser = $context->getUser(); // b/c
502 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
503 wfSetupSession( $params['sessionId'] ); // sets $_SESSION
505 $request = new FauxRequest( array(), false, $_SESSION );
506 $request->setIP( $params['ip'] );
507 foreach ( $params['headers'] as $name => $value ) {
508 $request->setHeader( $name, $value );
510 // Set the current context to use the new WebRequest
511 $context->setRequest( $request );
512 $wgRequest = $context->getRequest(); // b/c
515 // Stash the old session and load in the new one
516 $oUser = self
::getMain()->getUser();
517 $oParams = self
::getMain()->exportSession();
518 $importSessionFunction( $user, $params );
520 // Set callback to save and close the new session and reload the old one
521 return new ScopedCallback( function () use ( $importSessionFunction, $oUser, $oParams ) {
522 $importSessionFunction( $oUser, $oParams );
527 * Create a new extraneous context. The context is filled with information
528 * external to the current session.
529 * - Title is specified by argument
530 * - Request is a FauxRequest, or a FauxRequest can be specified by argument
531 * - User is an anonymous user, for separation IPv4 localhost is used
532 * - Language will be based on the anonymous user and request, may be content
533 * language or a uselang param in the fauxrequest data may change the lang
534 * - Skin will be based on the anonymous user, should be the wiki's default skin
536 * @param Title $title Title to use for the extraneous request
537 * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
538 * @return RequestContext
540 public static function newExtraneousContext( Title
$title, $request = array() ) {
542 $context->setTitle( $title );
543 if ( $request instanceof WebRequest
) {
544 $context->setRequest( $request );
546 $context->setRequest( new FauxRequest( $request ) );
548 $context->user
= User
::newFromName( '127.0.0.1', false );