MediaWiki REL1_30
RequestContext.php
Go to the documentation of this file.
1<?php
25use Liuggio\StatsdClient\Factory\StatsdDataFactory;
28use Wikimedia\ScopedCallback;
29
37 private $request;
38
42 private $title;
43
47 private $wikipage;
48
52 private $output;
53
57 private $user;
58
62 private $lang;
63
67 private $skin;
68
72 private $timing;
73
77 private $config;
78
82 private static $instance = null;
83
89 public function setConfig( Config $c ) {
90 $this->config = $c;
91 }
92
98 public function getConfig() {
99 if ( $this->config === null ) {
100 // @todo In the future, we could move this to WebStart.php so
101 // the Config object is ready for when initialization happens
102 $this->config = MediaWikiServices::getInstance()->getMainConfig();
103 }
104
105 return $this->config;
106 }
107
113 public function setRequest( WebRequest $r ) {
114 $this->request = $r;
115 }
116
122 public function getRequest() {
123 if ( $this->request === null ) {
125 // create the WebRequest object on the fly
126 if ( $wgCommandLineMode ) {
127 $this->request = new FauxRequest( [] );
128 } else {
129 $this->request = new WebRequest();
130 }
131 }
132
133 return $this->request;
134 }
135
143 public function getStats() {
144 return MediaWikiServices::getInstance()->getStatsdDataFactory();
145 }
146
152 public function getTiming() {
153 if ( $this->timing === null ) {
154 $this->timing = new Timing( [
155 'logger' => LoggerFactory::getInstance( 'Timing' )
156 ] );
157 }
158 return $this->timing;
159 }
160
166 public function setTitle( Title $title = null ) {
167 $this->title = $title;
168 // Erase the WikiPage so a new one with the new title gets created.
169 $this->wikipage = null;
170 }
171
177 public function getTitle() {
178 if ( $this->title === null ) {
179 global $wgTitle; # fallback to $wg till we can improve this
180 $this->title = $wgTitle;
182 'GlobalTitleFail',
183 __METHOD__ . ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
184 );
185 }
186
187 return $this->title;
188 }
189
196 public function hasTitle() {
197 return $this->title !== null;
198 }
199
208 public function canUseWikiPage() {
209 if ( $this->wikipage ) {
210 // If there's a WikiPage object set, we can for sure get it
211 return true;
212 }
213 // Only pages with legitimate titles can have WikiPages.
214 // That usually means pages in non-virtual namespaces.
215 $title = $this->getTitle();
216 return $title ? $title->canExist() : false;
217 }
218
225 public function setWikiPage( WikiPage $p ) {
226 $pageTitle = $p->getTitle();
227 if ( !$this->hasTitle() || !$pageTitle->equals( $this->getTitle() ) ) {
228 $this->setTitle( $pageTitle );
229 }
230 // Defer this to the end since setTitle sets it to null.
231 $this->wikipage = $p;
232 }
233
244 public function getWikiPage() {
245 if ( $this->wikipage === null ) {
246 $title = $this->getTitle();
247 if ( $title === null ) {
248 throw new MWException( __METHOD__ . ' called without Title object set' );
249 }
250 $this->wikipage = WikiPage::factory( $title );
251 }
252
253 return $this->wikipage;
254 }
255
259 public function setOutput( OutputPage $o ) {
260 $this->output = $o;
261 }
262
268 public function getOutput() {
269 if ( $this->output === null ) {
270 $this->output = new OutputPage( $this );
271 }
272
273 return $this->output;
274 }
275
281 public function setUser( User $u ) {
282 $this->user = $u;
283 }
284
290 public function getUser() {
291 if ( $this->user === null ) {
292 $this->user = User::newFromSession( $this->getRequest() );
293 }
294
295 return $this->user;
296 }
297
304 public static function sanitizeLangCode( $code ) {
306
307 // BCP 47 - letter case MUST NOT carry meaning
308 $code = strtolower( $code );
309
310 # Validate $code
311 if ( !$code || !Language::isValidCode( $code ) || $code === 'qqq' ) {
312 wfDebug( "Invalid user language code\n" );
314 }
315
316 return $code;
317 }
318
326 public function setLanguage( $l ) {
327 if ( $l instanceof Language ) {
328 $this->lang = $l;
329 } elseif ( is_string( $l ) ) {
330 $l = self::sanitizeLangCode( $l );
331 $obj = Language::factory( $l );
332 $this->lang = $obj;
333 } else {
334 throw new MWException( __METHOD__ . " was passed an invalid type of data." );
335 }
336 }
337
345 public function getLanguage() {
346 if ( isset( $this->recursion ) ) {
347 trigger_error( "Recursion detected in " . __METHOD__, E_USER_WARNING );
348 $e = new Exception;
349 wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
350
351 $code = $this->getConfig()->get( 'LanguageCode' ) ?: 'en';
352 $this->lang = Language::factory( $code );
353 } elseif ( $this->lang === null ) {
354 $this->recursion = true;
355
357
358 try {
359 $request = $this->getRequest();
360 $user = $this->getUser();
361
362 $code = $request->getVal( 'uselang', 'user' );
363 if ( $code === 'user' ) {
364 $code = $user->getOption( 'language' );
365 }
367
368 Hooks::run( 'UserGetLanguageObject', [ $user, &$code, $this ] );
369
370 if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
371 $this->lang = $wgContLang;
372 } else {
373 $obj = Language::factory( $code );
374 $this->lang = $obj;
375 }
376
377 unset( $this->recursion );
378 }
379 catch ( Exception $ex ) {
380 unset( $this->recursion );
381 throw $ex;
382 }
383 }
384
385 return $this->lang;
386 }
387
393 public function setSkin( Skin $s ) {
394 $this->skin = clone $s;
395 $this->skin->setContext( $this );
396 }
397
403 public function getSkin() {
404 if ( $this->skin === null ) {
405 $skin = null;
406 Hooks::run( 'RequestContextCreateSkin', [ $this, &$skin ] );
407 $factory = SkinFactory::getDefaultInstance();
408
409 // If the hook worked try to set a skin from it
410 if ( $skin instanceof Skin ) {
411 $this->skin = $skin;
412 } elseif ( is_string( $skin ) ) {
413 // Normalize the key, just in case the hook did something weird.
414 $normalized = Skin::normalizeKey( $skin );
415 $this->skin = $factory->makeSkin( $normalized );
416 }
417
418 // If this is still null (the hook didn't run or didn't work)
419 // then go through the normal processing to load a skin
420 if ( $this->skin === null ) {
421 if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
422 # get the user skin
423 $userSkin = $this->getUser()->getOption( 'skin' );
424 $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
425 } else {
426 # if we're not allowing users to override, then use the default
427 $userSkin = $this->getConfig()->get( 'DefaultSkin' );
428 }
429
430 // Normalize the key in case the user is passing gibberish
431 // or has old preferences (T71566).
432 $normalized = Skin::normalizeKey( $userSkin );
433
434 // Skin::normalizeKey will also validate it, so
435 // this won't throw an exception
436 $this->skin = $factory->makeSkin( $normalized );
437 }
438
439 // After all that set a context on whatever skin got created
440 $this->skin->setContext( $this );
441 }
442
443 return $this->skin;
444 }
445
457 public function msg( $key ) {
458 $args = func_get_args();
459
460 return call_user_func_array( 'wfMessage', $args )->setContext( $this );
461 }
462
470 public static function getMain() {
471 if ( self::$instance === null ) {
472 self::$instance = new self;
473 }
474
475 return self::$instance;
476 }
477
486 public static function getMainAndWarn( $func = __METHOD__ ) {
487 wfDebug( $func . ' called without context. ' .
488 "Using RequestContext::getMain() for sanity\n" );
489
490 return self::getMain();
491 }
492
496 public static function resetMain() {
497 if ( !( defined( 'MW_PHPUNIT_TEST' ) || defined( 'MW_PARSER_TEST' ) ) ) {
498 throw new MWException( __METHOD__ . '() should be called only from unit tests!' );
499 }
500 self::$instance = null;
501 }
502
510 public function exportSession() {
511 $session = MediaWiki\Session\SessionManager::getGlobalSession();
512 return [
513 'ip' => $this->getRequest()->getIP(),
514 'headers' => $this->getRequest()->getAllHeaders(),
515 'sessionId' => $session->isPersistent() ? $session->getId() : '',
516 'userId' => $this->getUser()->getId()
517 ];
518 }
519
542 public static function importScopedSession( array $params ) {
543 if ( strlen( $params['sessionId'] ) &&
544 MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent()
545 ) {
546 // Sanity check to avoid sending random cookies for the wrong users.
547 // This method should only called by CLI scripts or by HTTP job runners.
548 throw new MWException( "Sessions can only be imported when none is active." );
549 } elseif ( !IP::isValid( $params['ip'] ) ) {
550 throw new MWException( "Invalid client IP address '{$params['ip']}'." );
551 }
552
553 if ( $params['userId'] ) { // logged-in user
554 $user = User::newFromId( $params['userId'] );
555 $user->load();
556 if ( !$user->getId() ) {
557 throw new MWException( "No user with ID '{$params['userId']}'." );
558 }
559 } else { // anon user
560 $user = User::newFromName( $params['ip'], false );
561 }
562
563 $importSessionFunc = function ( User $user, array $params ) {
565
567
568 // Commit and close any current session
569 if ( MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
570 session_write_close(); // persist
571 session_id( '' ); // detach
572 $_SESSION = []; // clear in-memory array
573 }
574
575 // Get new session, if applicable
576 $session = null;
577 if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
578 $manager = MediaWiki\Session\SessionManager::singleton();
579 $session = $manager->getSessionById( $params['sessionId'], true )
580 ?: $manager->getEmptySession();
581 }
582
583 // Remove any user IP or agent information, and attach the request
584 // with the new session.
585 $context->setRequest( new FauxRequest( [], false, $session ) );
586 $wgRequest = $context->getRequest(); // b/c
587
588 // Now that all private information is detached from the user, it should
589 // be safe to load the new user. If errors occur or an exception is thrown
590 // and caught (leaving the main context in a mixed state), there is no risk
591 // of the User object being attached to the wrong IP, headers, or session.
592 $context->setUser( $user );
593 $wgUser = $context->getUser(); // b/c
594 if ( $session && MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
595 session_id( $session->getId() );
596 MediaWiki\quietCall( 'session_start' );
597 }
598 $request = new FauxRequest( [], false, $session );
599 $request->setIP( $params['ip'] );
600 foreach ( $params['headers'] as $name => $value ) {
601 $request->setHeader( $name, $value );
602 }
603 // Set the current context to use the new WebRequest
604 $context->setRequest( $request );
605 $wgRequest = $context->getRequest(); // b/c
606 };
607
608 // Stash the old session and load in the new one
609 $oUser = self::getMain()->getUser();
610 $oParams = self::getMain()->exportSession();
611 $oRequest = self::getMain()->getRequest();
612 $importSessionFunc( $user, $params );
613
614 // Set callback to save and close the new session and reload the old one
615 return new ScopedCallback(
616 function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
618 $importSessionFunc( $oUser, $oParams );
619 // Restore the exact previous Request object (instead of leaving FauxRequest)
620 RequestContext::getMain()->setRequest( $oRequest );
621 $wgRequest = RequestContext::getMain()->getRequest(); // b/c
622 }
623 );
624 }
625
640 public static function newExtraneousContext( Title $title, $request = [] ) {
641 $context = new self;
642 $context->setTitle( $title );
643 if ( $request instanceof WebRequest ) {
644 $context->setRequest( $request );
645 } else {
646 $context->setRequest( new FauxRequest( $request ) );
647 }
648 $context->user = User::newFromName( '127.0.0.1', false );
649
650 return $context;
651 }
652}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
to move a page</td >< td > &*You are moving the page across *A non empty talk page already exists under the new or *You uncheck the box below In those you will have to move or merge the page manually if desired</td >< td > be sure to &You are responsible for making sure that links continue to point where they are supposed to go Note that the page will &a page at the new title
$wgLanguageCode
Site language code.
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not.
$wgUser
Definition Setup.php:817
global $wgCommandLineMode
Definition Setup.php:526
if(! $wgDBerrorLogTZ) $wgRequest
Definition Setup.php:662
if(! $wgRequest->checkUrlExtension()) if(isset($_SERVER[ 'PATH_INFO']) &&$_SERVER[ 'PATH_INFO'] !='') if(! $wgEnableAPI) $wgTitle
Definition api.php:68
if( $line===false) $args
Definition cdb.php:63
setContext(IContextSource $context)
Set the IContextSource object.
WebRequest clone which takes values from a provided array.
Internationalisation code.
Definition Language.php:35
MediaWiki exception.
PSR-3 logger instance factory.
MediaWikiServices is the service locator for the application scope of MediaWiki.
This class should be covered by a general architecture document which does not exist as of January 20...
Group all the pieces relevant to the context of a request into one instance.
static getMainAndWarn( $func=__METHOD__)
Get the RequestContext object associated with the main request and gives a warning to the log,...
getRequest()
Get the WebRequest object.
canUseWikiPage()
Check whether a WikiPage object can be get with getWikiPage().
getSkin()
Get the Skin object.
OutputPage $output
static importScopedSession(array $params)
Import an client IP address, HTTP headers, user ID, and session ID.
setSkin(Skin $s)
Set the Skin object.
setOutput(OutputPage $o)
getTiming()
Get the timing object.
setRequest(WebRequest $r)
Set the WebRequest object.
WebRequest $request
static RequestContext $instance
static sanitizeLangCode( $code)
Accepts a language code and ensures it's sane.
setConfig(Config $c)
Set the Config object.
getUser()
Get the User object.
hasTitle()
Check, if a Title object is set.
msg( $key)
Helpful methods.
getStats()
Get the Stats object.
setUser(User $u)
Set the User object.
getTitle()
Get the Title object.
getConfig()
Get the Config object.
setTitle(Title $title=null)
Set the Title object.
setWikiPage(WikiPage $p)
Set the WikiPage object.
static newExtraneousContext(Title $title, $request=[])
Create a new extraneous context.
exportSession()
Export the resolved user IP, HTTP headers, user ID, and session ID.
getOutput()
Get the OutputPage object.
static resetMain()
Resets singleton returned by getMain().
setLanguage( $l)
Set the Language object.
static getMain()
Static methods.
getLanguage()
Get the Language object.
getWikiPage()
Get the WikiPage object.
The main skin class which provides methods and properties for all other skins.
Definition Skin.php:36
static normalizeKey( $key)
Normalize a skin preference value to a form that can be loaded.
Definition Skin.php:95
An interface to help developers measure the performance of their applications.
Definition Timing.php:45
Represents a title within MediaWiki.
Definition Title.php:39
canExist()
Is this in a namespace that allows actual pages?
Definition Title.php:1104
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:51
getId()
Get the user's ID.
Definition User.php:2224
getOption( $oname, $defaultOverride=null, $ignoreHidden=false)
Get the user's current setting for a given option.
Definition User.php:2882
load( $flags=self::READ_NORMAL)
Load the user table data for this object from the source given by mFrom.
Definition User.php:362
The WebRequest class encapsulates getting at data passed in the URL or via a POSTed form stripping il...
getVal( $name, $default=null)
Fetch a scalar from the input or return $default if it's not set.
Class representing a MediaWiki article and history.
Definition WikiPage.php:37
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition WikiPage.php:121
getTitle()
Get the title object of the article.
Definition WikiPage.php:239
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a skin(according to that user 's preference)
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add in any and then calling output() to send it all. It could be easily changed to send incrementally if that becomes useful
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such and we might be restricted by PHP settings such as safe mode or open_basedir We cannot assume that the software even has read access anywhere useful Many shared hosts run all users web applications under the same user
Wikitext formatted, in the key only.
the array() calling protocol came about after MediaWiki 1.4rc1.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition hooks.txt:863
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2780
returning false will NOT prevent logging a wrapping ErrorException instead of letting the login form give the generic error message that the account does not exist For when the account has been renamed or deleted or an array to pass a message key and parameters create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment this hook should only be used to add variables that depend on the current page request
Definition hooks.txt:2194
Allows to change the fields on the form that will be generated $name
Definition hooks.txt:302
returning false will NOT prevent logging $e
Definition hooks.txt:2146
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Interface for objects which can provide a MediaWiki context on request.
A helper class for throttling authentication attempts.
$params