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 Wikimedia\AtEase\AtEase
;
26 use MediaWiki\Logger\LoggerFactory
;
27 use MediaWiki\MediaWikiServices
;
28 use Wikimedia\ScopedCallback
;
31 * Group all the pieces relevant to the context of a request into one instance
33 class RequestContext
implements IContextSource
, MutableContext
{
82 private static $instance = null;
85 * @param Config $config
87 public function setConfig( Config
$config ) {
88 $this->config
= $config;
94 public function getConfig() {
95 if ( $this->config
=== null ) {
96 // @todo In the future, we could move this to WebStart.php so
97 // the Config object is ready for when initialization happens
98 $this->config
= MediaWikiServices
::getInstance()->getMainConfig();
101 return $this->config
;
105 * @param WebRequest $request
107 public function setRequest( WebRequest
$request ) {
108 $this->request
= $request;
114 public function getRequest() {
115 if ( $this->request
=== null ) {
116 global $wgCommandLineMode;
117 // create the WebRequest object on the fly
118 if ( $wgCommandLineMode ) {
119 $this->request
= new FauxRequest( [] );
121 $this->request
= new WebRequest();
125 return $this->request
;
129 * @deprecated since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)
131 * @return IBufferingStatsdDataFactory
133 public function getStats() {
134 return MediaWikiServices
::getInstance()->getStatsdDataFactory();
140 public function getTiming() {
141 if ( $this->timing
=== null ) {
142 $this->timing
= new Timing( [
143 'logger' => LoggerFactory
::getInstance( 'Timing' )
146 return $this->timing
;
150 * @param Title|null $title
152 public function setTitle( Title
$title = null ) {
153 $this->title
= $title;
154 // Erase the WikiPage so a new one with the new title gets created.
155 $this->wikipage
= null;
161 public function getTitle() {
162 if ( $this->title
=== null ) {
163 global $wgTitle; # fallback to $wg till we can improve this
164 $this->title
= $wgTitle;
167 __METHOD__
. ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
175 * Check, if a Title object is set
180 public function hasTitle() {
181 return $this->title
!== null;
185 * Check whether a WikiPage object can be get with getWikiPage().
186 * Callers should expect that an exception is thrown from getWikiPage()
187 * if this method returns false.
192 public function canUseWikiPage() {
193 if ( $this->wikipage
) {
194 // If there's a WikiPage object set, we can for sure get it
197 // Only pages with legitimate titles can have WikiPages.
198 // That usually means pages in non-virtual namespaces.
199 $title = $this->getTitle();
200 return $title ?
$title->canExist() : false;
205 * @param WikiPage $wikiPage
207 public function setWikiPage( WikiPage
$wikiPage ) {
208 $pageTitle = $wikiPage->getTitle();
209 if ( !$this->hasTitle() ||
!$pageTitle->equals( $this->getTitle() ) ) {
210 $this->setTitle( $pageTitle );
212 // Defer this to the end since setTitle sets it to null.
213 $this->wikipage
= $wikiPage;
217 * Get the WikiPage object.
218 * May throw an exception if there's no Title object set or the Title object
219 * belongs to a special namespace that doesn't have WikiPage, so use first
220 * canUseWikiPage() to check whether this method can be called safely.
223 * @throws MWException
226 public function getWikiPage() {
227 if ( $this->wikipage
=== null ) {
228 $title = $this->getTitle();
229 if ( $title === null ) {
230 throw new MWException( __METHOD__
. ' called without Title object set' );
232 $this->wikipage
= WikiPage
::factory( $title );
235 return $this->wikipage
;
239 * @param OutputPage $output
241 public function setOutput( OutputPage
$output ) {
242 $this->output
= $output;
248 public function getOutput() {
249 if ( $this->output
=== null ) {
250 $this->output
= new OutputPage( $this );
253 return $this->output
;
259 public function setUser( User
$user ) {
261 // Invalidate cached user interface language
268 public function getUser() {
269 if ( $this->user
=== null ) {
270 $this->user
= User
::newFromSession( $this->getRequest() );
277 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
278 * code and replaces with $wgLanguageCode if not sane.
279 * @param string $code Language code
282 public static function sanitizeLangCode( $code ) {
283 global $wgLanguageCode;
285 // BCP 47 - letter case MUST NOT carry meaning
286 $code = strtolower( $code );
289 if ( !$code ||
!Language
::isValidCode( $code ) ||
$code === 'qqq' ) {
290 $code = $wgLanguageCode;
297 * @param Language|string $language Language instance or language code
298 * @throws MWException
301 public function setLanguage( $language ) {
302 if ( $language instanceof Language
) {
303 $this->lang
= $language;
304 } elseif ( is_string( $language ) ) {
305 $language = self
::sanitizeLangCode( $language );
306 $obj = Language
::factory( $language );
309 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
314 * Get the Language object.
315 * Initialization of user or request objects can depend on this.
320 public function getLanguage() {
321 if ( isset( $this->recursion
) ) {
322 trigger_error( "Recursion detected in " . __METHOD__
, E_USER_WARNING
);
324 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
326 $code = $this->getConfig()->get( 'LanguageCode' ) ?
: 'en';
327 $this->lang
= Language
::factory( $code );
328 } elseif ( $this->lang
=== null ) {
329 $this->recursion
= true;
332 $request = $this->getRequest();
333 $user = $this->getUser();
335 $code = $request->getVal( 'uselang', 'user' );
336 if ( $code === 'user' ) {
337 $code = $user->getOption( 'language' );
339 $code = self
::sanitizeLangCode( $code );
341 Hooks
::run( 'UserGetLanguageObject', [ $user, &$code, $this ] );
343 if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
344 $this->lang
= MediaWikiServices
::getInstance()->getContentLanguage();
346 $obj = Language
::factory( $code );
350 unset( $this->recursion
);
360 public function setSkin( Skin
$skin ) {
361 $this->skin
= clone $skin;
362 $this->skin
->setContext( $this );
368 public function getSkin() {
369 if ( $this->skin
=== null ) {
371 Hooks
::run( 'RequestContextCreateSkin', [ $this, &$skin ] );
372 $factory = MediaWikiServices
::getInstance()->getSkinFactory();
374 if ( $skin instanceof Skin
) {
375 // The hook provided a skin object
377 } elseif ( is_string( $skin ) ) {
378 // The hook provided a skin name
379 // Normalize the key, just in case the hook did something weird.
380 $normalized = Skin
::normalizeKey( $skin );
381 $this->skin
= $factory->makeSkin( $normalized );
383 // No hook override, go through normal processing
384 if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
385 $userSkin = $this->getUser()->getOption( 'skin' );
386 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
388 $userSkin = $this->getConfig()->get( 'DefaultSkin' );
391 // Normalize the key in case the user is passing gibberish query params
392 // or has old user preferences (T71566).
393 // Skin::normalizeKey will also validate it, so makeSkin() won't throw.
394 $normalized = Skin
::normalizeKey( $userSkin );
395 $this->skin
= $factory->makeSkin( $normalized );
398 // After all that set a context on whatever skin got created
399 $this->skin
->setContext( $this );
406 * Get a Message object with context set
407 * Parameters are the same as wfMessage()
409 * @param string|string[]|MessageSpecifier $key Message key, or array of keys,
410 * or a MessageSpecifier.
411 * @param mixed $args,...
414 public function msg( $key ) {
415 $args = func_get_args();
417 return wfMessage( ...$args )->setContext( $this );
421 * Get the RequestContext object associated with the main request
423 * @return RequestContext
425 public static function getMain() {
426 if ( self
::$instance === null ) {
427 self
::$instance = new self
;
430 return self
::$instance;
434 * Get the RequestContext object associated with the main request
435 * and gives a warning to the log, to find places, where a context maybe is missing.
437 * @param string $func
438 * @return RequestContext
441 public static function getMainAndWarn( $func = __METHOD__
) {
442 wfDebug( $func . ' called without context. ' .
443 "Using RequestContext::getMain() for sanity\n" );
445 return self
::getMain();
449 * Resets singleton returned by getMain(). Should be called only from unit tests.
451 public static function resetMain() {
452 if ( !( defined( 'MW_PHPUNIT_TEST' ) ||
defined( 'MW_PARSER_TEST' ) ) ) {
453 throw new MWException( __METHOD__
. '() should be called only from unit tests!' );
455 self
::$instance = null;
459 * Export the resolved user IP, HTTP headers, user ID, and session ID.
460 * The result will be reasonably sized to allow for serialization.
465 public function exportSession() {
466 $session = MediaWiki\Session\SessionManager
::getGlobalSession();
468 'ip' => $this->getRequest()->getIP(),
469 'headers' => $this->getRequest()->getAllHeaders(),
470 'sessionId' => $session->isPersistent() ?
$session->getId() : '',
471 'userId' => $this->getUser()->getId()
476 * Import an client IP address, HTTP headers, user ID, and session ID
478 * This sets the current session, $wgUser, and $wgRequest from $params.
479 * Once the return value falls out of scope, the old context is restored.
480 * This method should only be called in contexts where there is no session
481 * ID or end user receiving the response (CLI or HTTP job runners). This
482 * is partly enforced, and is done so to avoid leaking cookies if certain
483 * error conditions arise.
485 * This is useful when background scripts inherit context when acting on
486 * behalf of a user. In general the 'sessionId' parameter should be set
487 * to an empty string unless session importing is *truly* needed. This
488 * feature is somewhat deprecated.
490 * @note suhosin.session.encrypt may interfere with this method.
492 * @param array $params Result of RequestContext::exportSession()
493 * @return ScopedCallback
494 * @throws MWException
497 public static function importScopedSession( array $params ) {
498 if ( strlen( $params['sessionId'] ) &&
499 MediaWiki\Session\SessionManager
::getGlobalSession()->isPersistent()
501 // Sanity check to avoid sending random cookies for the wrong users.
502 // This method should only called by CLI scripts or by HTTP job runners.
503 throw new MWException( "Sessions can only be imported when none is active." );
504 } elseif ( !IP
::isValid( $params['ip'] ) ) {
505 throw new MWException( "Invalid client IP address '{$params['ip']}'." );
508 if ( $params['userId'] ) { // logged-in user
509 $user = User
::newFromId( $params['userId'] );
511 if ( !$user->getId() ) {
512 throw new MWException( "No user with ID '{$params['userId']}'." );
514 } else { // anon user
515 $user = User
::newFromName( $params['ip'], false );
518 $importSessionFunc = function ( User
$user, array $params ) {
519 global $wgRequest, $wgUser;
521 $context = RequestContext
::getMain();
523 // Commit and close any current session
524 if ( MediaWiki\Session\PHPSessionHandler
::isEnabled() ) {
525 session_write_close(); // persist
526 session_id( '' ); // detach
527 $_SESSION = []; // clear in-memory array
530 // Get new session, if applicable
532 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
533 $manager = MediaWiki\Session\SessionManager
::singleton();
534 $session = $manager->getSessionById( $params['sessionId'], true )
535 ?
: $manager->getEmptySession();
538 // Remove any user IP or agent information, and attach the request
539 // with the new session.
540 $context->setRequest( new FauxRequest( [], false, $session ) );
541 $wgRequest = $context->getRequest(); // b/c
543 // Now that all private information is detached from the user, it should
544 // be safe to load the new user. If errors occur or an exception is thrown
545 // and caught (leaving the main context in a mixed state), there is no risk
546 // of the User object being attached to the wrong IP, headers, or session.
547 $context->setUser( $user );
548 $wgUser = $context->getUser(); // b/c
549 if ( $session && MediaWiki\Session\PHPSessionHandler
::isEnabled() ) {
550 session_id( $session->getId() );
551 AtEase
::quietCall( 'session_start' );
553 $request = new FauxRequest( [], false, $session );
554 $request->setIP( $params['ip'] );
555 foreach ( $params['headers'] as $name => $value ) {
556 $request->setHeader( $name, $value );
558 // Set the current context to use the new WebRequest
559 $context->setRequest( $request );
560 $wgRequest = $context->getRequest(); // b/c
563 // Stash the old session and load in the new one
564 $oUser = self
::getMain()->getUser();
565 $oParams = self
::getMain()->exportSession();
566 $oRequest = self
::getMain()->getRequest();
567 $importSessionFunc( $user, $params );
569 // Set callback to save and close the new session and reload the old one
570 return new ScopedCallback(
571 function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
573 $importSessionFunc( $oUser, $oParams );
574 // Restore the exact previous Request object (instead of leaving FauxRequest)
575 RequestContext
::getMain()->setRequest( $oRequest );
576 $wgRequest = RequestContext
::getMain()->getRequest(); // b/c
582 * Create a new extraneous context. The context is filled with information
583 * external to the current session.
584 * - Title is specified by argument
585 * - Request is a FauxRequest, or a FauxRequest can be specified by argument
586 * - User is an anonymous user, for separation IPv4 localhost is used
587 * - Language will be based on the anonymous user and request, may be content
588 * language or a uselang param in the fauxrequest data may change the lang
589 * - Skin will be based on the anonymous user, should be the wiki's default skin
591 * @param Title $title Title to use for the extraneous request
592 * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
593 * @return RequestContext
595 public static function newExtraneousContext( Title
$title, $request = [] ) {
597 $context->setTitle( $title );
598 if ( $request instanceof WebRequest
) {
599 $context->setRequest( $request );
601 $context->setRequest( new FauxRequest( $request ) );
603 $context->user
= User
::newFromName( '127.0.0.1', false );