3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
20 * @author Alexandre Emsenhuber
21 * @author Daniel Friesen
25 use MediaWiki\Logger\LoggerFactory
;
26 use MediaWiki\MediaWikiServices
;
27 use Wikimedia\ScopedCallback
;
30 * Group all the pieces relevant to the context of a request into one instance
32 class RequestContext
implements IContextSource
, MutableContext
{
81 private static $instance = null;
84 * @param Config $config
86 public function setConfig( Config
$config ) {
87 $this->config
= $config;
93 public function getConfig() {
94 if ( $this->config
=== null ) {
95 // @todo In the future, we could move this to WebStart.php so
96 // the Config object is ready for when initialization happens
97 $this->config
= MediaWikiServices
::getInstance()->getMainConfig();
100 return $this->config
;
104 * @param WebRequest $request
106 public function setRequest( WebRequest
$request ) {
107 $this->request
= $request;
113 public function getRequest() {
114 if ( $this->request
=== null ) {
115 global $wgCommandLineMode;
116 // create the WebRequest object on the fly
117 if ( $wgCommandLineMode ) {
118 $this->request
= new FauxRequest( [] );
120 $this->request
= new WebRequest();
124 return $this->request
;
128 * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)
130 * @return IBufferingStatsdDataFactory
132 public function getStats() {
133 return MediaWikiServices
::getInstance()->getStatsdDataFactory();
139 public function getTiming() {
140 if ( $this->timing
=== null ) {
141 $this->timing
= new Timing( [
142 'logger' => LoggerFactory
::getInstance( 'Timing' )
145 return $this->timing
;
149 * @param Title|null $title
151 public function setTitle( Title
$title = null ) {
152 $this->title
= $title;
153 // Erase the WikiPage so a new one with the new title gets created.
154 $this->wikipage
= null;
160 public function getTitle() {
161 if ( $this->title
=== null ) {
162 global $wgTitle; # fallback to $wg till we can improve this
163 $this->title
= $wgTitle;
166 __METHOD__
. ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
174 * Check, if a Title object is set
179 public function hasTitle() {
180 return $this->title
!== null;
184 * Check whether a WikiPage object can be get with getWikiPage().
185 * Callers should expect that an exception is thrown from getWikiPage()
186 * if this method returns false.
191 public function canUseWikiPage() {
192 if ( $this->wikipage
) {
193 // If there's a WikiPage object set, we can for sure get it
196 // Only pages with legitimate titles can have WikiPages.
197 // That usually means pages in non-virtual namespaces.
198 $title = $this->getTitle();
199 return $title ?
$title->canExist() : false;
204 * @param WikiPage $wikiPage
206 public function setWikiPage( WikiPage
$wikiPage ) {
207 $pageTitle = $wikiPage->getTitle();
208 if ( !$this->hasTitle() ||
!$pageTitle->equals( $this->getTitle() ) ) {
209 $this->setTitle( $pageTitle );
211 // Defer this to the end since setTitle sets it to null.
212 $this->wikipage
= $wikiPage;
216 * Get the WikiPage object.
217 * May throw an exception if there's no Title object set or the Title object
218 * belongs to a special namespace that doesn't have WikiPage, so use first
219 * canUseWikiPage() to check whether this method can be called safely.
222 * @throws MWException
225 public function getWikiPage() {
226 if ( $this->wikipage
=== null ) {
227 $title = $this->getTitle();
228 if ( $title === null ) {
229 throw new MWException( __METHOD__
. ' called without Title object set' );
231 $this->wikipage
= WikiPage
::factory( $title );
234 return $this->wikipage
;
238 * @param OutputPage $output
240 public function setOutput( OutputPage
$output ) {
241 $this->output
= $output;
247 public function getOutput() {
248 if ( $this->output
=== null ) {
249 $this->output
= new OutputPage( $this );
252 return $this->output
;
258 public function setUser( User
$user ) {
265 public function getUser() {
266 if ( $this->user
=== null ) {
267 $this->user
= User
::newFromSession( $this->getRequest() );
274 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
275 * code and replaces with $wgLanguageCode if not sane.
276 * @param string $code Language code
279 public static function sanitizeLangCode( $code ) {
280 global $wgLanguageCode;
282 // BCP 47 - letter case MUST NOT carry meaning
283 $code = strtolower( $code );
286 if ( !$code ||
!Language
::isValidCode( $code ) ||
$code === 'qqq' ) {
287 $code = $wgLanguageCode;
294 * @param Language|string $language Language instance or language code
295 * @throws MWException
298 public function setLanguage( $language ) {
299 if ( $language instanceof Language
) {
300 $this->lang
= $language;
301 } elseif ( is_string( $language ) ) {
302 $language = self
::sanitizeLangCode( $language );
303 $obj = Language
::factory( $language );
306 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
311 * Get the Language object.
312 * Initialization of user or request objects can depend on this.
317 public function getLanguage() {
318 if ( isset( $this->recursion
) ) {
319 trigger_error( "Recursion detected in " . __METHOD__
, E_USER_WARNING
);
321 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
323 $code = $this->getConfig()->get( 'LanguageCode' ) ?
: 'en';
324 $this->lang
= Language
::factory( $code );
325 } elseif ( $this->lang
=== null ) {
326 $this->recursion
= true;
331 $request = $this->getRequest();
332 $user = $this->getUser();
334 $code = $request->getVal( 'uselang', 'user' );
335 if ( $code === 'user' ) {
336 $code = $user->getOption( 'language' );
338 $code = self
::sanitizeLangCode( $code );
340 Hooks
::run( 'UserGetLanguageObject', [ $user, &$code, $this ] );
342 if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
343 $this->lang
= $wgContLang;
345 $obj = Language
::factory( $code );
349 unset( $this->recursion
);
351 catch ( Exception
$ex ) {
352 unset( $this->recursion
);
363 public function setSkin( Skin
$skin ) {
364 $this->skin
= clone $skin;
365 $this->skin
->setContext( $this );
371 public function getSkin() {
372 if ( $this->skin
=== null ) {
374 Hooks
::run( 'RequestContextCreateSkin', [ $this, &$skin ] );
375 $factory = SkinFactory
::getDefaultInstance();
377 // If the hook worked try to set a skin from it
378 if ( $skin instanceof Skin
) {
380 } elseif ( is_string( $skin ) ) {
381 // Normalize the key, just in case the hook did something weird.
382 $normalized = Skin
::normalizeKey( $skin );
383 $this->skin
= $factory->makeSkin( $normalized );
386 // If this is still null (the hook didn't run or didn't work)
387 // then go through the normal processing to load a skin
388 if ( $this->skin
=== null ) {
389 if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
391 $userSkin = $this->getUser()->getOption( 'skin' );
392 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
394 # if we're not allowing users to override, then use the default
395 $userSkin = $this->getConfig()->get( 'DefaultSkin' );
398 // Normalize the key in case the user is passing gibberish
399 // or has old preferences (T71566).
400 $normalized = Skin
::normalizeKey( $userSkin );
402 // Skin::normalizeKey will also validate it, so
403 // this won't throw an exception
404 $this->skin
= $factory->makeSkin( $normalized );
407 // After all that set a context on whatever skin got created
408 $this->skin
->setContext( $this );
415 * Get a Message object with context set
416 * Parameters are the same as wfMessage()
418 * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
419 * or a MessageSpecifier.
420 * @param mixed $args,...
423 public function msg( $key ) {
424 $args = func_get_args();
426 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
430 * Get the RequestContext object associated with the main request
432 * @return RequestContext
434 public static function getMain() {
435 if ( self
::$instance === null ) {
436 self
::$instance = new self
;
439 return self
::$instance;
443 * Get the RequestContext object associated with the main request
444 * and gives a warning to the log, to find places, where a context maybe is missing.
446 * @param string $func
447 * @return RequestContext
450 public static function getMainAndWarn( $func = __METHOD__
) {
451 wfDebug( $func . ' called without context. ' .
452 "Using RequestContext::getMain() for sanity\n" );
454 return self
::getMain();
458 * Resets singleton returned by getMain(). Should be called only from unit tests.
460 public static function resetMain() {
461 if ( !( defined( 'MW_PHPUNIT_TEST' ) ||
defined( 'MW_PARSER_TEST' ) ) ) {
462 throw new MWException( __METHOD__
. '() should be called only from unit tests!' );
464 self
::$instance = null;
468 * Export the resolved user IP, HTTP headers, user ID, and session ID.
469 * The result will be reasonably sized to allow for serialization.
474 public function exportSession() {
475 $session = MediaWiki\Session\SessionManager
::getGlobalSession();
477 'ip' => $this->getRequest()->getIP(),
478 'headers' => $this->getRequest()->getAllHeaders(),
479 'sessionId' => $session->isPersistent() ?
$session->getId() : '',
480 'userId' => $this->getUser()->getId()
485 * Import an client IP address, HTTP headers, user ID, and session ID
487 * This sets the current session, $wgUser, and $wgRequest from $params.
488 * Once the return value falls out of scope, the old context is restored.
489 * This method should only be called in contexts where there is no session
490 * ID or end user receiving the response (CLI or HTTP job runners). This
491 * is partly enforced, and is done so to avoid leaking cookies if certain
492 * error conditions arise.
494 * This is useful when background scripts inherit context when acting on
495 * behalf of a user. In general the 'sessionId' parameter should be set
496 * to an empty string unless session importing is *truly* needed. This
497 * feature is somewhat deprecated.
499 * @note suhosin.session.encrypt may interfere with this method.
501 * @param array $params Result of RequestContext::exportSession()
502 * @return ScopedCallback
503 * @throws MWException
506 public static function importScopedSession( array $params ) {
507 if ( strlen( $params['sessionId'] ) &&
508 MediaWiki\Session\SessionManager
::getGlobalSession()->isPersistent()
510 // Sanity check to avoid sending random cookies for the wrong users.
511 // This method should only called by CLI scripts or by HTTP job runners.
512 throw new MWException( "Sessions can only be imported when none is active." );
513 } elseif ( !IP
::isValid( $params['ip'] ) ) {
514 throw new MWException( "Invalid client IP address '{$params['ip']}'." );
517 if ( $params['userId'] ) { // logged-in user
518 $user = User
::newFromId( $params['userId'] );
520 if ( !$user->getId() ) {
521 throw new MWException( "No user with ID '{$params['userId']}'." );
523 } else { // anon user
524 $user = User
::newFromName( $params['ip'], false );
527 $importSessionFunc = function ( User
$user, array $params ) {
528 global $wgRequest, $wgUser;
530 $context = RequestContext
::getMain();
532 // Commit and close any current session
533 if ( MediaWiki\Session\PHPSessionHandler
::isEnabled() ) {
534 session_write_close(); // persist
535 session_id( '' ); // detach
536 $_SESSION = []; // clear in-memory array
539 // Get new session, if applicable
541 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
542 $manager = MediaWiki\Session\SessionManager
::singleton();
543 $session = $manager->getSessionById( $params['sessionId'], true )
544 ?
: $manager->getEmptySession();
547 // Remove any user IP or agent information, and attach the request
548 // with the new session.
549 $context->setRequest( new FauxRequest( [], false, $session ) );
550 $wgRequest = $context->getRequest(); // b/c
552 // Now that all private information is detached from the user, it should
553 // be safe to load the new user. If errors occur or an exception is thrown
554 // and caught (leaving the main context in a mixed state), there is no risk
555 // of the User object being attached to the wrong IP, headers, or session.
556 $context->setUser( $user );
557 $wgUser = $context->getUser(); // b/c
558 if ( $session && MediaWiki\Session\PHPSessionHandler
::isEnabled() ) {
559 session_id( $session->getId() );
560 Wikimedia\
quietCall( 'session_start' );
562 $request = new FauxRequest( [], false, $session );
563 $request->setIP( $params['ip'] );
564 foreach ( $params['headers'] as $name => $value ) {
565 $request->setHeader( $name, $value );
567 // Set the current context to use the new WebRequest
568 $context->setRequest( $request );
569 $wgRequest = $context->getRequest(); // b/c
572 // Stash the old session and load in the new one
573 $oUser = self
::getMain()->getUser();
574 $oParams = self
::getMain()->exportSession();
575 $oRequest = self
::getMain()->getRequest();
576 $importSessionFunc( $user, $params );
578 // Set callback to save and close the new session and reload the old one
579 return new ScopedCallback(
580 function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
582 $importSessionFunc( $oUser, $oParams );
583 // Restore the exact previous Request object (instead of leaving FauxRequest)
584 RequestContext
::getMain()->setRequest( $oRequest );
585 $wgRequest = RequestContext
::getMain()->getRequest(); // b/c
591 * Create a new extraneous context. The context is filled with information
592 * external to the current session.
593 * - Title is specified by argument
594 * - Request is a FauxRequest, or a FauxRequest can be specified by argument
595 * - User is an anonymous user, for separation IPv4 localhost is used
596 * - Language will be based on the anonymous user and request, may be content
597 * language or a uselang param in the fauxrequest data may change the lang
598 * - Skin will be based on the anonymous user, should be the wiki's default skin
600 * @param Title $title Title to use for the extraneous request
601 * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
602 * @return RequestContext
604 public static function newExtraneousContext( Title
$title, $request = [] ) {
606 $context->setTitle( $title );
607 if ( $request instanceof WebRequest
) {
608 $context->setRequest( $request );
610 $context->setRequest( new FauxRequest( $request ) );
612 $context->user
= User
::newFromName( '127.0.0.1', false );