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
{
67 * Set the WebRequest object
69 * @param WebRequest $r
71 public function setRequest( WebRequest
$r ) {
76 * Get the WebRequest object
80 public function getRequest() {
81 if ( $this->request
=== null ) {
82 global $wgRequest; # fallback to $wg till we can improve this
83 $this->request
= $wgRequest;
85 return $this->request
;
89 * Set the Title object
93 public function setTitle( $t ) {
94 if ( $t !== null && !$t instanceof Title
) {
95 throw new MWException( __METHOD__
. " expects an instance of Title" );
98 // Erase the WikiPage so a new one with the new title gets created.
99 $this->wikipage
= null;
103 * Get the Title object
107 public function getTitle() {
108 if ( $this->title
=== null ) {
109 global $wgTitle; # fallback to $wg till we can improve this
110 $this->title
= $wgTitle;
116 * Check whether a WikiPage object can be get with getWikiPage().
117 * Callers should expect that an exception is thrown from getWikiPage()
118 * if this method returns false.
123 public function canUseWikiPage() {
124 if ( $this->wikipage
!== null ) {
125 # If there's a WikiPage object set, we can for sure get it
128 $title = $this->getTitle();
129 if ( $title === null ) {
130 # No Title, no WikiPage
133 # Only namespaces whose pages are stored in the database can have WikiPage
134 return $title->canExist();
139 * Set the WikiPage object
144 public function setWikiPage( WikiPage
$p ) {
145 $contextTitle = $this->getTitle();
146 $pageTitle = $p->getTitle();
147 if ( !$contextTitle ||
!$pageTitle->equals( $contextTitle ) ) {
148 $this->setTitle( $pageTitle );
150 // Defer this to the end since setTitle sets it to null.
151 $this->wikipage
= $p;
155 * Get the WikiPage object.
156 * May throw an exception if there's no Title object set or the Title object
157 * belongs to a special namespace that doesn't have WikiPage, so use first
158 * canUseWikiPage() to check whether this method can be called safely.
161 * @throws MWException
164 public function getWikiPage() {
165 if ( $this->wikipage
=== null ) {
166 $title = $this->getTitle();
167 if ( $title === null ) {
168 throw new MWException( __METHOD__
. ' called without Title object set' );
170 $this->wikipage
= WikiPage
::factory( $title );
172 return $this->wikipage
;
176 * @param $o OutputPage
178 public function setOutput( OutputPage
$o ) {
183 * Get the OutputPage object
187 public function getOutput() {
188 if ( $this->output
=== null ) {
189 $this->output
= new OutputPage( $this );
191 return $this->output
;
195 * Set the User object
199 public function setUser( User
$u ) {
204 * Get the User object
208 public function getUser() {
209 if ( $this->user
=== null ) {
210 $this->user
= User
::newFromSession( $this->getRequest() );
216 * Accepts a language code and ensures it's sane. Outputs a cleaned up language
217 * code and replaces with $wgLanguageCode if not sane.
218 * @param string $code Language code
221 public static function sanitizeLangCode( $code ) {
222 global $wgLanguageCode;
224 // BCP 47 - letter case MUST NOT carry meaning
225 $code = strtolower( $code );
228 if ( empty( $code ) ||
!Language
::isValidCode( $code ) ||
( $code === 'qqq' ) ) {
229 wfDebug( "Invalid user language code\n" );
230 $code = $wgLanguageCode;
237 * Set the Language object
239 * @deprecated since 1.19 Use setLanguage instead
240 * @param Language|string $l Language instance or language code
242 public function setLang( $l ) {
243 wfDeprecated( __METHOD__
, '1.19' );
244 $this->setLanguage( $l );
248 * Set the Language object
250 * @param Language|string $l Language instance or language code
251 * @throws MWException
254 public function setLanguage( $l ) {
255 if ( $l instanceof Language
) {
257 } elseif ( is_string( $l ) ) {
258 $l = self
::sanitizeLangCode( $l );
259 $obj = Language
::factory( $l );
262 throw new MWException( __METHOD__
. " was passed an invalid type of data." );
267 * @deprecated since 1.19 Use getLanguage instead
270 public function getLang() {
271 wfDeprecated( __METHOD__
, '1.19' );
272 return $this->getLanguage();
276 * Get the Language object.
277 * Initialization of user or request objects can depend on this.
282 public function getLanguage() {
283 if ( isset( $this->recursion
) ) {
284 trigger_error( "Recursion detected in " . __METHOD__
, E_USER_WARNING
);
286 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
288 global $wgLanguageCode;
289 $code = ( $wgLanguageCode ) ?
$wgLanguageCode : 'en';
290 $this->lang
= Language
::factory( $code );
291 } elseif ( $this->lang
=== null ) {
292 $this->recursion
= true;
294 global $wgLanguageCode, $wgContLang;
296 $request = $this->getRequest();
297 $user = $this->getUser();
299 $code = $request->getVal( 'uselang', $user->getOption( 'language' ) );
300 $code = self
::sanitizeLangCode( $code );
302 wfRunHooks( 'UserGetLanguageObject', array( $user, &$code, $this ) );
304 if ( $code === $wgLanguageCode ) {
305 $this->lang
= $wgContLang;
307 $obj = Language
::factory( $code );
311 unset( $this->recursion
);
318 * Set the Skin object
322 public function setSkin( Skin
$s ) {
323 $this->skin
= clone $s;
324 $this->skin
->setContext( $this );
328 * Get the Skin object
332 public function getSkin() {
333 if ( $this->skin
=== null ) {
334 wfProfileIn( __METHOD__
. '-createskin' );
337 wfRunHooks( 'RequestContextCreateSkin', array( $this, &$skin ) );
339 // If the hook worked try to set a skin from it
340 if ( $skin instanceof Skin
) {
342 } elseif ( is_string( $skin ) ) {
343 $this->skin
= Skin
::newFromKey( $skin );
346 // If this is still null (the hook didn't run or didn't work)
347 // then go through the normal processing to load a skin
348 if ( $this->skin
=== null ) {
349 global $wgHiddenPrefs;
350 if ( !in_array( 'skin', $wgHiddenPrefs ) ) {
352 $userSkin = $this->getUser()->getOption( 'skin' );
353 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
355 # if we're not allowing users to override, then use the default
356 global $wgDefaultSkin;
357 $userSkin = $wgDefaultSkin;
360 $this->skin
= Skin
::newFromKey( $userSkin );
363 // After all that set a context on whatever skin got created
364 $this->skin
->setContext( $this );
365 wfProfileOut( __METHOD__
. '-createskin' );
370 /** Helpful methods **/
373 * Get a Message object with context set
374 * Parameters are the same as wfMessage()
378 public function msg() {
379 $args = func_get_args();
380 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
383 /** Static methods **/
386 * Get the RequestContext object associated with the main request
388 * @return RequestContext
390 public static function getMain() {
391 static $instance = null;
392 if ( $instance === null ) {
393 $instance = new self
;
399 * Export the resolved user IP, HTTP headers, user ID, and session ID.
400 * The result will be reasonably sized to allow for serialization.
405 public function exportSession() {
407 'ip' => $this->getRequest()->getIP(),
408 'headers' => $this->getRequest()->getAllHeaders(),
409 'sessionId' => session_id(),
410 'userId' => $this->getUser()->getId()
415 * Import the resolved user IP, HTTP headers, user ID, and session ID.
416 * This sets the current session and sets $wgUser and $wgRequest.
417 * Once the return value falls out of scope, the old context is restored.
418 * This function can only be called within CLI mode scripts.
420 * This will setup the session from the given ID. This is useful when
421 * background scripts inherit context when acting on behalf of a user.
423 * @note suhosin.session.encrypt may interfere with this method.
425 * @param array $params Result of RequestContext::exportSession()
426 * @return ScopedCallback
427 * @throws MWException
430 public static function importScopedSession( array $params ) {
431 if ( PHP_SAPI
!== 'cli' ) {
432 // Don't send random private cookies or turn $wgRequest into FauxRequest
433 throw new MWException( "Sessions can only be imported in cli mode." );
434 } elseif ( !strlen( $params['sessionId'] ) ) {
435 throw new MWException( "No session ID was specified." );
438 if ( $params['userId'] ) { // logged-in user
439 $user = User
::newFromId( $params['userId'] );
441 throw new MWException( "No user with ID '{$params['userId']}'." );
443 } elseif ( !IP
::isValid( $params['ip'] ) ) {
444 throw new MWException( "Could not load user '{$params['ip']}'." );
445 } else { // anon user
446 $user = User
::newFromName( $params['ip'], false );
449 $importSessionFunction = function( User
$user, array $params ) {
450 global $wgRequest, $wgUser;
452 $context = RequestContext
::getMain();
453 // Commit and close any current session
454 session_write_close(); // persist
455 session_id( '' ); // detach
456 $_SESSION = array(); // clear in-memory array
457 // Remove any user IP or agent information
458 $context->setRequest( new FauxRequest() );
459 $wgRequest = $context->getRequest(); // b/c
460 // Now that all private information is detached from the user, it should
461 // be safe to load the new user. If errors occur or an exception is thrown
462 // and caught (leaving the main context in a mixed state), there is no risk
463 // of the User object being attached to the wrong IP, headers, or session.
464 $context->setUser( $user );
465 $wgUser = $context->getUser(); // b/c
466 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
467 wfSetupSession( $params['sessionId'] ); // sets $_SESSION
469 $request = new FauxRequest( array(), false, $_SESSION );
470 $request->setIP( $params['ip'] );
471 foreach ( $params['headers'] as $name => $value ) {
472 $request->setHeader( $name, $value );
474 // Set the current context to use the new WebRequest
475 $context->setRequest( $request );
476 $wgRequest = $context->getRequest(); // b/c
479 // Stash the old session and load in the new one
480 $oUser = self
::getMain()->getUser();
481 $oParams = self
::getMain()->exportSession();
482 $importSessionFunction( $user, $params );
484 // Set callback to save and close the new session and reload the old one
485 return new ScopedCallback( function() use ( $importSessionFunction, $oUser, $oParams ) {
486 $importSessionFunction( $oUser, $oParams );
491 * Create a new extraneous context. The context is filled with information
492 * external to the current session.
493 * - Title is specified by argument
494 * - Request is a FauxRequest, or a FauxRequest can be specified by argument
495 * - User is an anonymous user, for separation IPv4 localhost is used
496 * - Language will be based on the anonymous user and request, may be content
497 * language or a uselang param in the fauxrequest data may change the lang
498 * - Skin will be based on the anonymous user, should be the wiki's default skin
500 * @param Title $title Title to use for the extraneous request
501 * @param WebRequest|array $request A WebRequest or data to use for a FauxRequest
502 * @return RequestContext
504 public static function newExtraneousContext( Title
$title, $request = array() ) {
506 $context->setTitle( $title );
507 if ( $request instanceof WebRequest
) {
508 $context->setRequest( $request );
510 $context->setRequest( new FauxRequest( $request ) );
512 $context->user
= User
::newFromName( '127.0.0.1', false );