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
;
28 * Group all the pieces relevant to the context of a request into one instance
30 class RequestContext
implements IContextSource
, MutableContext
{
67 * @var \Liuggio\StatsdClient\Factory\StatsdDataFactory
84 private static $instance = null;
87 * Set the Config object
91 public function setConfig( Config
$c ) {
96 * Get the Config object
100 public function getConfig() {
101 if ( $this->config
=== null ) {
102 // @todo In the future, we could move this to WebStart.php so
103 // the Config object is ready for when initialization happens
104 $this->config
= ConfigFactory
::getDefaultInstance()->makeConfig( 'main' );
107 return $this->config
;
111 * Set the WebRequest object
113 * @param WebRequest $r
115 public function setRequest( WebRequest
$r ) {
120 * Get the WebRequest object
124 public function getRequest() {
125 if ( $this->request
=== null ) {
126 global $wgRequest; # fallback to $wg till we can improve this
127 $this->request
= $wgRequest;
130 return $this->request
;
134 * Get the Stats object
136 * @return BufferingStatsdDataFactory
138 public function getStats() {
139 if ( $this->stats
=== null ) {
140 $config = $this->getConfig();
141 $prefix = $config->get( 'StatsdMetricPrefix' )
142 ?
rtrim( $config->get( 'StatsdMetricPrefix' ), '.' )
144 $this->stats
= new BufferingStatsdDataFactory( $prefix );
150 * Get the timing object
154 public function getTiming() {
155 if ( $this->timing
=== null ) {
156 $this->timing
= new Timing( array(
157 'logger' => LoggerFactory
::getInstance( 'Timing' )
160 return $this->timing
;
164 * Set the Title object
166 * @param Title $title
168 public function setTitle( Title
$title ) {
169 $this->title
= $title;
170 // Erase the WikiPage so a new one with the new title gets created.
171 $this->wikipage
= null;
175 * Get the Title object
179 public function getTitle() {
180 if ( $this->title
=== null ) {
181 global $wgTitle; # fallback to $wg till we can improve this
182 $this->title
= $wgTitle;
185 __METHOD__
. ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
193 * Check, if a Title object is set
198 public function hasTitle() {
199 return $this->title
!== null;
203 * Check whether a WikiPage object can be get with getWikiPage().
204 * Callers should expect that an exception is thrown from getWikiPage()
205 * if this method returns false.
210 public function canUseWikiPage() {
211 if ( $this->wikipage
) {
212 // If there's a WikiPage object set, we can for sure get it
215 // Only pages with legitimate titles can have WikiPages.
216 // That usually means pages in non-virtual namespaces.
217 $title = $this->getTitle();
218 return $title ?
$title->canExist() : false;
222 * Set the WikiPage object
227 public function setWikiPage( WikiPage
$p ) {
228 $pageTitle = $p->getTitle();
229 if ( !$this->hasTitle() ||
!$pageTitle->equals( $this->getTitle() ) ) {
230 $this->setTitle( $pageTitle );
232 // Defer this to the end since setTitle sets it to null.
233 $this->wikipage
= $p;
237 * Get the WikiPage object.
238 * May throw an exception if there's no Title object set or the Title object
239 * belongs to a special namespace that doesn't have WikiPage, so use first
240 * canUseWikiPage() to check whether this method can be called safely.
243 * @throws MWException
246 public function getWikiPage() {
247 if ( $this->wikipage
=== null ) {
248 $title = $this->getTitle();
249 if ( $title === null ) {
250 throw new MWException( __METHOD__
. ' called without Title object set' );
252 $this->wikipage
= WikiPage
::factory( $title );
255 return $this->wikipage
;
259 * @param OutputPage $o
261 public function setOutput( OutputPage
$o ) {
266 * Get the OutputPage object
270 public function getOutput() {
271 if ( $this->output
=== null ) {
272 $this->output
= new OutputPage( $this );
275 return $this->output
;
279 * Set the User object
283 public function setUser( User
$u ) {
288 * Get the User object
292 public function getUser() {
293 if ( $this->user
=== null ) {
294 $this->user
= User
::newFromSession( $this->getRequest() );
301 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
302 * code and replaces with $wgLanguageCode if not sane.
303 * @param string $code Language code
306 public static function sanitizeLangCode( $code ) {
307 global $wgLanguageCode;
309 // BCP 47 - letter case MUST NOT carry meaning
310 $code = strtolower( $code );
313 if ( !$code ||
!Language
::isValidCode( $code ) ||
$code === 'qqq' ) {
314 wfDebug( "Invalid user language code\n" );
315 $code = $wgLanguageCode;
322 * Set the Language object
324 * @param Language|string $l Language instance or language code
325 * @throws MWException
328 public function setLanguage( $l ) {
329 if ( $l instanceof Language
) {
331 } elseif ( is_string( $l ) ) {
332 $l = self
::sanitizeLangCode( $l );
333 $obj = Language
::factory( $l );
336 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
341 * Get the Language object.
342 * Initialization of user or request objects can depend on this.
347 public function getLanguage() {
348 if ( isset( $this->recursion
) ) {
349 trigger_error( "Recursion detected in " . __METHOD__
, E_USER_WARNING
);
351 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
353 $code = $this->getConfig()->get( 'LanguageCode' ) ?
: 'en';
354 $this->lang
= Language
::factory( $code );
355 } elseif ( $this->lang
=== null ) {
356 $this->recursion
= true;
361 $request = $this->getRequest();
362 $user = $this->getUser();
364 $code = $request->getVal( 'uselang', 'user' );
365 if ( $code === 'user' ) {
366 $code = $user->getOption( 'language' );
368 $code = self
::sanitizeLangCode( $code );
370 Hooks
::run( 'UserGetLanguageObject', array( $user, &$code, $this ) );
372 if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
373 $this->lang
= $wgContLang;
375 $obj = Language
::factory( $code );
379 unset( $this->recursion
);
381 catch ( Exception
$ex ) {
382 unset( $this->recursion
);
391 * Set the Skin object
395 public function setSkin( Skin
$s ) {
396 $this->skin
= clone $s;
397 $this->skin
->setContext( $this );
401 * Get the Skin object
405 public function getSkin() {
406 if ( $this->skin
=== null ) {
408 Hooks
::run( 'RequestContextCreateSkin', array( $this, &$skin ) );
409 $factory = SkinFactory
::getDefaultInstance();
411 // If the hook worked try to set a skin from it
412 if ( $skin instanceof Skin
) {
414 } elseif ( is_string( $skin ) ) {
415 // Normalize the key, just in case the hook did something weird.
416 $normalized = Skin
::normalizeKey( $skin );
417 $this->skin
= $factory->makeSkin( $normalized );
420 // If this is still null (the hook didn't run or didn't work)
421 // then go through the normal processing to load a skin
422 if ( $this->skin
=== null ) {
423 if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
425 $userSkin = $this->getUser()->getOption( 'skin' );
426 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
428 # if we're not allowing users to override, then use the default
429 $userSkin = $this->getConfig()->get( 'DefaultSkin' );
432 // Normalize the key in case the user is passing gibberish
433 // or has old preferences (bug 69566).
434 $normalized = Skin
::normalizeKey( $userSkin );
436 // Skin::normalizeKey will also validate it, so
437 // this won't throw an exception
438 $this->skin
= $factory->makeSkin( $normalized );
441 // After all that set a context on whatever skin got created
442 $this->skin
->setContext( $this );
448 /** Helpful methods **/
451 * Get a Message object with context set
452 * Parameters are the same as wfMessage()
457 public function msg() {
458 $args = func_get_args();
460 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
463 /** Static methods **/
466 * Get the RequestContext object associated with the main request
468 * @return RequestContext
470 public static function getMain() {
471 if ( self
::$instance === null ) {
472 self
::$instance = new self
;
475 return self
::$instance;
479 * Get the RequestContext object associated with the main request
480 * and gives a warning to the log, to find places, where a context maybe is missing.
482 * @param string $func
483 * @return RequestContext
486 public static function getMainAndWarn( $func = __METHOD__
) {
487 wfDebug( $func . ' called without context. ' .
488 "Using RequestContext::getMain() for sanity\n" );
490 return self
::getMain();
494 * Resets singleton returned by getMain(). Should be called only from unit tests.
496 public static function resetMain() {
497 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
498 throw new MWException( __METHOD__
. '() should be called only from unit tests!' );
500 self
::$instance = null;
504 * Export the resolved user IP, HTTP headers, user ID, and session ID.
505 * The result will be reasonably sized to allow for serialization.
510 public function exportSession() {
512 'ip' => $this->getRequest()->getIP(),
513 'headers' => $this->getRequest()->getAllHeaders(),
514 'sessionId' => session_id(),
515 'userId' => $this->getUser()->getId()
520 * Import an client IP address, HTTP headers, user ID, and session ID
522 * This sets the current session, $wgUser, and $wgRequest from $params.
523 * Once the return value falls out of scope, the old context is restored.
524 * This method should only be called in contexts where there is no session
525 * ID or end user receiving the response (CLI or HTTP job runners). This
526 * is partly enforced, and is done so to avoid leaking cookies if certain
527 * error conditions arise.
529 * This is useful when background scripts inherit context when acting on
530 * behalf of a user. In general the 'sessionId' parameter should be set
531 * to an empty string unless session importing is *truly* needed. This
532 * feature is somewhat deprecated.
534 * @note suhosin.session.encrypt may interfere with this method.
536 * @param array $params Result of RequestContext::exportSession()
537 * @return ScopedCallback
538 * @throws MWException
541 public static function importScopedSession( array $params ) {
542 if ( session_id() != '' && strlen( $params['sessionId'] ) ) {
543 // Sanity check to avoid sending random cookies for the wrong users.
544 // This method should only called by CLI scripts or by HTTP job runners.
545 throw new MWException( "Sessions can only be imported when none is active." );
546 } elseif ( !IP
::isValid( $params['ip'] ) ) {
547 throw new MWException( "Invalid client IP address '{$params['ip']}'." );
550 if ( $params['userId'] ) { // logged-in user
551 $user = User
::newFromId( $params['userId'] );
553 if ( !$user->getId() ) {
554 throw new MWException( "No user with ID '{$params['userId']}'." );
556 } else { // anon user
557 $user = User
::newFromName( $params['ip'], false );
560 $importSessionFunc = function ( User
$user, array $params ) {
561 global $wgRequest, $wgUser;
563 $context = RequestContext
::getMain();
564 // Commit and close any current session
565 session_write_close(); // persist
566 session_id( '' ); // detach
567 $_SESSION = array(); // clear in-memory array
568 // Remove any user IP or agent information
569 $context->setRequest( new FauxRequest() );
570 $wgRequest = $context->getRequest(); // b/c
571 // Now that all private information is detached from the user, it should
572 // be safe to load the new user. If errors occur or an exception is thrown
573 // and caught (leaving the main context in a mixed state), there is no risk
574 // of the User object being attached to the wrong IP, headers, or session.
575 $context->setUser( $user );
576 $wgUser = $context->getUser(); // b/c
577 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
578 wfSetupSession( $params['sessionId'] ); // sets $_SESSION
580 $request = new FauxRequest( array(), false, $_SESSION );
581 $request->setIP( $params['ip'] );
582 foreach ( $params['headers'] as $name => $value ) {
583 $request->setHeader( $name, $value );
585 // Set the current context to use the new WebRequest
586 $context->setRequest( $request );
587 $wgRequest = $context->getRequest(); // b/c
590 // Stash the old session and load in the new one
591 $oUser = self
::getMain()->getUser();
592 $oParams = self
::getMain()->exportSession();
593 $oRequest = self
::getMain()->getRequest();
594 $importSessionFunc( $user, $params );
596 // Set callback to save and close the new session and reload the old one
597 return new ScopedCallback(
598 function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
600 $importSessionFunc( $oUser, $oParams );
601 // Restore the exact previous Request object (instead of leaving FauxRequest)
602 RequestContext
::getMain()->setRequest( $oRequest );
603 $wgRequest = RequestContext
::getMain()->getRequest(); // b/c
609 * Create a new extraneous context. The context is filled with information
610 * external to the current session.
611 * - Title is specified by argument
612 * - Request is a FauxRequest, or a FauxRequest can be specified by argument
613 * - User is an anonymous user, for separation IPv4 localhost is used
614 * - Language will be based on the anonymous user and request, may be content
615 * language or a uselang param in the fauxrequest data may change the lang
616 * - Skin will be based on the anonymous user, should be the wiki's default skin
618 * @param Title $title Title to use for the extraneous request
619 * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
620 * @return RequestContext
622 public static function newExtraneousContext( Title
$title, $request = array() ) {
624 $context->setTitle( $title );
625 if ( $request instanceof WebRequest
) {
626 $context->setRequest( $request );
628 $context->setRequest( new FauxRequest( $request ) );
630 $context->user
= User
::newFromName( '127.0.0.1', false );