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
{
74 private static $instance = null;
77 * Set the Config object
81 public function setConfig( Config
$c ) {
86 * Get the Config object
90 public function getConfig() {
91 if ( $this->config
=== null ) {
92 // @todo In the future, we could move this to WebStart.php so
93 // the Config object is ready for when initialization happens
94 $this->config
= ConfigFactory
::getDefaultInstance()->makeConfig( 'main' );
101 * Set the WebRequest object
103 * @param WebRequest $r
105 public function setRequest( WebRequest
$r ) {
110 * Get the WebRequest object
114 public function getRequest() {
115 if ( $this->request
=== null ) {
116 global $wgRequest; # fallback to $wg till we can improve this
117 $this->request
= $wgRequest;
120 return $this->request
;
124 * Set the Title object
126 * @param Title $title
128 public function setTitle( Title
$title ) {
129 $this->title
= $title;
130 // Erase the WikiPage so a new one with the new title gets created.
131 $this->wikipage
= null;
135 * Get the Title object
139 public function getTitle() {
140 if ( $this->title
=== null ) {
141 global $wgTitle; # fallback to $wg till we can improve this
142 $this->title
= $wgTitle;
143 wfDebugLog( 'GlobalTitleFail', __METHOD__
. ' called by ' . wfGetCaller() . ' with no title set.' );
150 * Check, if a Title object is set
155 public function hasTitle() {
156 return $this->title
!== null;
160 * Check whether a WikiPage object can be get with getWikiPage().
161 * Callers should expect that an exception is thrown from getWikiPage()
162 * if this method returns false.
167 public function canUseWikiPage() {
168 if ( $this->wikipage
) {
169 // If there's a WikiPage object set, we can for sure get it
172 // Only pages with legitimate titles can have WikiPages.
173 // That usually means pages in non-virtual namespaces.
174 $title = $this->getTitle();
175 return $title ?
$title->canExist() : false;
179 * Set the WikiPage object
184 public function setWikiPage( WikiPage
$p ) {
185 $contextTitle = $this->getTitle();
186 $pageTitle = $p->getTitle();
187 if ( !$contextTitle ||
!$pageTitle->equals( $contextTitle ) ) {
188 $this->setTitle( $pageTitle );
190 // Defer this to the end since setTitle sets it to null.
191 $this->wikipage
= $p;
195 * Get the WikiPage object.
196 * May throw an exception if there's no Title object set or the Title object
197 * belongs to a special namespace that doesn't have WikiPage, so use first
198 * canUseWikiPage() to check whether this method can be called safely.
201 * @throws MWException
204 public function getWikiPage() {
205 if ( $this->wikipage
=== null ) {
206 $title = $this->getTitle();
207 if ( $title === null ) {
208 throw new MWException( __METHOD__
. ' called without Title object set' );
210 $this->wikipage
= WikiPage
::factory( $title );
213 return $this->wikipage
;
217 * @param OutputPage $o
219 public function setOutput( OutputPage
$o ) {
224 * Get the OutputPage object
228 public function getOutput() {
229 if ( $this->output
=== null ) {
230 $this->output
= new OutputPage( $this );
233 return $this->output
;
237 * Set the User object
241 public function setUser( User
$u ) {
246 * Get the User object
250 public function getUser() {
251 if ( $this->user
=== null ) {
252 $this->user
= User
::newFromSession( $this->getRequest() );
259 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
260 * code and replaces with $wgLanguageCode if not sane.
261 * @param string $code Language code
264 public static function sanitizeLangCode( $code ) {
265 global $wgLanguageCode;
267 // BCP 47 - letter case MUST NOT carry meaning
268 $code = strtolower( $code );
271 if ( !$code ||
!Language
::isValidCode( $code ) ||
$code === 'qqq' ) {
272 wfDebug( "Invalid user language code\n" );
273 $code = $wgLanguageCode;
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 * Get the Language object.
300 * Initialization of user or request objects can depend on this.
305 public function getLanguage() {
306 if ( isset( $this->recursion
) ) {
307 trigger_error( "Recursion detected in " . __METHOD__
, E_USER_WARNING
);
309 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
311 $code = $this->getConfig()->get( 'LanguageCode' ) ?
: 'en';
312 $this->lang
= Language
::factory( $code );
313 } elseif ( $this->lang
=== null ) {
314 $this->recursion
= true;
319 $request = $this->getRequest();
320 $user = $this->getUser();
322 $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
323 $code = self
::sanitizeLangCode( $code );
325 wfRunHooks( 'UserGetLanguageObject', array( $user, &$code, $this ) );
327 if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
328 $this->lang
= $wgContLang;
330 $obj = Language
::factory( $code );
334 unset( $this->recursion
);
336 catch ( Exception
$ex ) {
337 unset( $this->recursion
);
346 * Set the Skin object
350 public function setSkin( Skin
$s ) {
351 $this->skin
= clone $s;
352 $this->skin
->setContext( $this );
356 * Get the Skin object
360 public function getSkin() {
361 if ( $this->skin
=== null ) {
362 wfProfileIn( __METHOD__
. '-createskin' );
365 wfRunHooks( 'RequestContextCreateSkin', array( $this, &$skin ) );
366 $factory = SkinFactory
::getDefaultInstance();
368 // If the hook worked try to set a skin from it
369 if ( $skin instanceof Skin
) {
371 } elseif ( is_string( $skin ) ) {
372 // Normalize the key, just in case the hook did something weird.
373 $normalized = Skin
::normalizeKey( $skin );
374 $this->skin
= $factory->makeSkin( $normalized );
377 // If this is still null (the hook didn't run or didn't work)
378 // then go through the normal processing to load a skin
379 if ( $this->skin
=== null ) {
380 if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
382 $userSkin = $this->getUser()->getOption( 'skin' );
383 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
385 # if we're not allowing users to override, then use the default
386 $userSkin = $this->getConfig()->get( 'DefaultSkin' );
389 // Normalize the key in case the user is passing gibberish
390 // or has old preferences (bug 69566).
391 $normalized = Skin
::normalizeKey( $userSkin );
393 // Skin::normalizeKey will also validate it, so
394 // this won't throw an exception
395 $this->skin
= $factory->makeSkin( $normalized );
398 // After all that set a context on whatever skin got created
399 $this->skin
->setContext( $this );
400 wfProfileOut( __METHOD__
. '-createskin' );
406 /** Helpful methods **/
409 * Get a Message object with context set
410 * Parameters are the same as wfMessage()
414 public function msg() {
415 $args = func_get_args();
417 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
420 /** Static methods **/
423 * Get the RequestContext object associated with the main request
425 * @return RequestContext
427 public static function getMain() {
428 if ( self
::$instance === null ) {
429 self
::$instance = new self
;
432 return self
::$instance;
436 * Get the RequestContext object associated with the main request
437 * and gives a warning to the log, to find places, where a context maybe is missing.
439 * @param string $func
440 * @return RequestContext
443 public static function getMainAndWarn( $func = __METHOD__
) {
444 wfDebug( $func . ' called without context. ' .
445 "Using RequestContext::getMain() for sanity\n" );
447 return self
::getMain();
451 * Resets singleton returned by getMain(). Should be called only from unit tests.
453 public static function resetMain() {
454 if ( !defined( 'MW_PHPUNIT_TEST' ) ) {
455 throw new MWException( __METHOD__
. '() should be called only from unit tests!' );
457 self
::$instance = null;
461 * Export the resolved user IP, HTTP headers, user ID, and session ID.
462 * The result will be reasonably sized to allow for serialization.
467 public function exportSession() {
469 'ip' => $this->getRequest()->getIP(),
470 'headers' => $this->getRequest()->getAllHeaders(),
471 'sessionId' => session_id(),
472 'userId' => $this->getUser()->getId()
477 * Import an client IP address, HTTP headers, user ID, and session ID
479 * This sets the current session and sets $wgUser and $wgRequest.
480 * Once the return value falls out of scope, the old context is restored.
481 * This method should only be called in contexts (CLI or HTTP job runners)
482 * where there is no session ID or end user receiving the response. This
483 * is partly enforced, and is done so to avoid leaking cookies if certain
484 * error conditions arise.
486 * This will setup the session from the given ID. This is useful when
487 * background scripts inherit context when acting on behalf of a user.
489 * @note suhosin.session.encrypt may interfere with this method.
491 * @param array $params Result of RequestContext::exportSession()
492 * @return ScopedCallback
493 * @throws MWException
496 public static function importScopedSession( array $params ) {
497 if ( session_id() != '' && strlen( $params['sessionId'] ) ) {
498 // Sanity check to avoid sending random cookies for the wrong users.
499 // This method should only called by CLI scripts or by HTTP job runners.
500 throw new MWException( "Sessions can only be imported when none is active." );
501 } elseif ( !IP
::isValid( $params['ip'] ) ) {
502 throw new MWException( "Invalid client IP address '{$params['ip']}'." );
505 if ( $params['userId'] ) { // logged-in user
506 $user = User
::newFromId( $params['userId'] );
508 if ( !$user->getId() ) {
509 throw new MWException( "No user with ID '{$params['userId']}'." );
511 } else { // anon user
512 $user = User
::newFromName( $params['ip'], false );
515 $importSessionFunc = function ( User
$user, array $params ) {
516 global $wgRequest, $wgUser;
518 $context = RequestContext
::getMain();
519 // Commit and close any current session
520 session_write_close(); // persist
521 session_id( '' ); // detach
522 $_SESSION = array(); // clear in-memory array
523 // Remove any user IP or agent information
524 $context->setRequest( new FauxRequest() );
525 $wgRequest = $context->getRequest(); // b/c
526 // Now that all private information is detached from the user, it should
527 // be safe to load the new user. If errors occur or an exception is thrown
528 // and caught (leaving the main context in a mixed state), there is no risk
529 // of the User object being attached to the wrong IP, headers, or session.
530 $context->setUser( $user );
531 $wgUser = $context->getUser(); // b/c
532 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
533 wfSetupSession( $params['sessionId'] ); // sets $_SESSION
535 $request = new FauxRequest( array(), false, $_SESSION );
536 $request->setIP( $params['ip'] );
537 foreach ( $params['headers'] as $name => $value ) {
538 $request->setHeader( $name, $value );
540 // Set the current context to use the new WebRequest
541 $context->setRequest( $request );
542 $wgRequest = $context->getRequest(); // b/c
545 // Stash the old session and load in the new one
546 $oUser = self
::getMain()->getUser();
547 $oParams = self
::getMain()->exportSession();
548 $oRequest = self
::getMain()->getRequest();
549 $importSessionFunc( $user, $params );
551 // Set callback to save and close the new session and reload the old one
552 return new ScopedCallback(
553 function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
555 $importSessionFunc( $oUser, $oParams );
556 // Restore the exact previous Request object (instead of leaving FauxRequest)
557 RequestContext
::getMain()->setRequest( $oRequest );
558 $wgRequest = RequestContext
::getMain()->getRequest(); // b/c
564 * Create a new extraneous context. The context is filled with information
565 * external to the current session.
566 * - Title is specified by argument
567 * - Request is a FauxRequest, or a FauxRequest can be specified by argument
568 * - User is an anonymous user, for separation IPv4 localhost is used
569 * - Language will be based on the anonymous user and request, may be content
570 * language or a uselang param in the fauxrequest data may change the lang
571 * - Skin will be based on the anonymous user, should be the wiki's default skin
573 * @param Title $title Title to use for the extraneous request
574 * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
575 * @return RequestContext
577 public static function newExtraneousContext( Title
$title, $request = array() ) {
579 $context->setTitle( $title );
580 if ( $request instanceof WebRequest
) {
581 $context->setRequest( $request );
583 $context->setRequest( new FauxRequest( $request ) );
585 $context->user
= User
::newFromName( '127.0.0.1', false );