MediaWiki  master
RequestContext.php
Go to the documentation of this file.
1 <?php
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 
87  public function setConfig( Config $config ) {
88  $this->config = $config;
89  }
90 
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();
99  }
100 
101  return $this->config;
102  }
103 
107  public function setRequest( WebRequest $request ) {
108  $this->request = $request;
109  }
110 
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( [] );
120  } else {
121  $this->request = new WebRequest();
122  }
123  }
124 
125  return $this->request;
126  }
127 
133  public function getStats() {
134  return MediaWikiServices::getInstance()->getStatsdDataFactory();
135  }
136 
140  public function getTiming() {
141  if ( $this->timing === null ) {
142  $this->timing = new Timing( [
143  'logger' => LoggerFactory::getInstance( 'Timing' )
144  ] );
145  }
146  return $this->timing;
147  }
148 
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;
156  }
157 
161  public function getTitle() {
162  if ( $this->title === null ) {
163  global $wgTitle; # fallback to $wg till we can improve this
164  $this->title = $wgTitle;
165  wfDebugLog(
166  'GlobalTitleFail',
167  __METHOD__ . ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
168  );
169  }
170 
171  return $this->title;
172  }
173 
180  public function hasTitle() {
181  return $this->title !== null;
182  }
183 
192  public function canUseWikiPage() {
193  if ( $this->wikipage ) {
194  // If there's a WikiPage object set, we can for sure get it
195  return true;
196  }
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;
201  }
202 
207  public function setWikiPage( WikiPage $wikiPage ) {
208  $pageTitle = $wikiPage->getTitle();
209  if ( !$this->hasTitle() || !$pageTitle->equals( $this->getTitle() ) ) {
210  $this->setTitle( $pageTitle );
211  }
212  // Defer this to the end since setTitle sets it to null.
213  $this->wikipage = $wikiPage;
214  }
215 
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' );
231  }
232  $this->wikipage = WikiPage::factory( $title );
233  }
234 
235  return $this->wikipage;
236  }
237 
241  public function setOutput( OutputPage $output ) {
242  $this->output = $output;
243  }
244 
248  public function getOutput() {
249  if ( $this->output === null ) {
250  $this->output = new OutputPage( $this );
251  }
252 
253  return $this->output;
254  }
255 
259  public function setUser( User $user ) {
260  $this->user = $user;
261  // Invalidate cached user interface language
262  $this->lang = null;
263  }
264 
268  public function getUser() {
269  if ( $this->user === null ) {
270  $this->user = User::newFromSession( $this->getRequest() );
271  }
272 
273  return $this->user;
274  }
275 
282  public static function sanitizeLangCode( $code ) {
283  global $wgLanguageCode;
284 
285  // BCP 47 - letter case MUST NOT carry meaning
286  $code = strtolower( $code );
287 
288  # Validate $code
289  if ( !$code || !Language::isValidCode( $code ) || $code === 'qqq' ) {
291  }
292 
293  return $code;
294  }
295 
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 );
307  $this->lang = $obj;
308  } else {
309  throw new MWException( __METHOD__ . " was passed an invalid type of data." );
310  }
311  }
312 
320  public function getLanguage() {
321  if ( isset( $this->recursion ) ) {
322  trigger_error( "Recursion detected in " . __METHOD__, E_USER_WARNING );
323  $e = new Exception;
324  wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
325 
326  $code = $this->getConfig()->get( 'LanguageCode' ) ?: 'en';
327  $this->lang = Language::factory( $code );
328  } elseif ( $this->lang === null ) {
329  $this->recursion = true;
330 
331  try {
332  $request = $this->getRequest();
333  $user = $this->getUser();
334 
335  $code = $request->getVal( 'uselang', 'user' );
336  if ( $code === 'user' ) {
337  $code = $user->getOption( 'language' );
338  }
339  $code = self::sanitizeLangCode( $code );
340 
341  Hooks::run( 'UserGetLanguageObject', [ $user, &$code, $this ] );
342 
343  if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
344  $this->lang = MediaWikiServices::getInstance()->getContentLanguage();
345  } else {
346  $obj = Language::factory( $code );
347  $this->lang = $obj;
348  }
349  } finally {
350  unset( $this->recursion );
351  }
352  }
353 
354  return $this->lang;
355  }
356 
360  public function setSkin( Skin $skin ) {
361  $this->skin = clone $skin;
362  $this->skin->setContext( $this );
363  }
364 
368  public function getSkin() {
369  if ( $this->skin === null ) {
370  $skin = null;
371  Hooks::run( 'RequestContextCreateSkin', [ $this, &$skin ] );
372  $factory = MediaWikiServices::getInstance()->getSkinFactory();
373 
374  // If the hook worked try to set a skin from it
375  if ( $skin instanceof Skin ) {
376  $this->skin = $skin;
377  } elseif ( is_string( $skin ) ) {
378  // Normalize the key, just in case the hook did something weird.
379  $normalized = Skin::normalizeKey( $skin );
380  $this->skin = $factory->makeSkin( $normalized );
381  }
382 
383  // If this is still null (the hook didn't run or didn't work)
384  // then go through the normal processing to load a skin
385  if ( $this->skin === null ) {
386  if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
387  # get the user skin
388  $userSkin = $this->getUser()->getOption( 'skin' );
389  $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
390  } else {
391  # if we're not allowing users to override, then use the default
392  $userSkin = $this->getConfig()->get( 'DefaultSkin' );
393  }
394 
395  // Normalize the key in case the user is passing gibberish
396  // or has old preferences (T71566).
397  $normalized = Skin::normalizeKey( $userSkin );
398 
399  // Skin::normalizeKey will also validate it, so
400  // this won't throw an exception
401  $this->skin = $factory->makeSkin( $normalized );
402  }
403 
404  // After all that set a context on whatever skin got created
405  $this->skin->setContext( $this );
406  }
407 
408  return $this->skin;
409  }
410 
420  public function msg( $key ) {
421  $args = func_get_args();
422 
423  return wfMessage( ...$args )->setContext( $this );
424  }
425 
431  public static function getMain() {
432  if ( self::$instance === null ) {
433  self::$instance = new self;
434  }
435 
436  return self::$instance;
437  }
438 
447  public static function getMainAndWarn( $func = __METHOD__ ) {
448  wfDebug( $func . ' called without context. ' .
449  "Using RequestContext::getMain() for sanity\n" );
450 
451  return self::getMain();
452  }
453 
457  public static function resetMain() {
458  if ( !( defined( 'MW_PHPUNIT_TEST' ) || defined( 'MW_PARSER_TEST' ) ) ) {
459  throw new MWException( __METHOD__ . '() should be called only from unit tests!' );
460  }
461  self::$instance = null;
462  }
463 
471  public function exportSession() {
473  return [
474  'ip' => $this->getRequest()->getIP(),
475  'headers' => $this->getRequest()->getAllHeaders(),
476  'sessionId' => $session->isPersistent() ? $session->getId() : '',
477  'userId' => $this->getUser()->getId()
478  ];
479  }
480 
503  public static function importScopedSession( array $params ) {
504  if ( strlen( $params['sessionId'] ) &&
505  MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent()
506  ) {
507  // Sanity check to avoid sending random cookies for the wrong users.
508  // This method should only called by CLI scripts or by HTTP job runners.
509  throw new MWException( "Sessions can only be imported when none is active." );
510  } elseif ( !IP::isValid( $params['ip'] ) ) {
511  throw new MWException( "Invalid client IP address '{$params['ip']}'." );
512  }
513 
514  if ( $params['userId'] ) { // logged-in user
515  $user = User::newFromId( $params['userId'] );
516  $user->load();
517  if ( !$user->getId() ) {
518  throw new MWException( "No user with ID '{$params['userId']}'." );
519  }
520  } else { // anon user
521  $user = User::newFromName( $params['ip'], false );
522  }
523 
524  $importSessionFunc = function ( User $user, array $params ) {
525  global $wgRequest, $wgUser;
526 
528 
529  // Commit and close any current session
530  if ( MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
531  session_write_close(); // persist
532  session_id( '' ); // detach
533  $_SESSION = []; // clear in-memory array
534  }
535 
536  // Get new session, if applicable
537  $session = null;
538  if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
540  $session = $manager->getSessionById( $params['sessionId'], true )
541  ?: $manager->getEmptySession();
542  }
543 
544  // Remove any user IP or agent information, and attach the request
545  // with the new session.
546  $context->setRequest( new FauxRequest( [], false, $session ) );
547  $wgRequest = $context->getRequest(); // b/c
548 
549  // Now that all private information is detached from the user, it should
550  // be safe to load the new user. If errors occur or an exception is thrown
551  // and caught (leaving the main context in a mixed state), there is no risk
552  // of the User object being attached to the wrong IP, headers, or session.
553  $context->setUser( $user );
554  $wgUser = $context->getUser(); // b/c
555  if ( $session && MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
556  session_id( $session->getId() );
557  AtEase::quietCall( 'session_start' );
558  }
559  $request = new FauxRequest( [], false, $session );
560  $request->setIP( $params['ip'] );
561  foreach ( $params['headers'] as $name => $value ) {
562  $request->setHeader( $name, $value );
563  }
564  // Set the current context to use the new WebRequest
565  $context->setRequest( $request );
566  $wgRequest = $context->getRequest(); // b/c
567  };
568 
569  // Stash the old session and load in the new one
570  $oUser = self::getMain()->getUser();
571  $oParams = self::getMain()->exportSession();
572  $oRequest = self::getMain()->getRequest();
573  $importSessionFunc( $user, $params );
574 
575  // Set callback to save and close the new session and reload the old one
576  return new ScopedCallback(
577  function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
578  global $wgRequest;
579  $importSessionFunc( $oUser, $oParams );
580  // Restore the exact previous Request object (instead of leaving FauxRequest)
581  RequestContext::getMain()->setRequest( $oRequest );
582  $wgRequest = RequestContext::getMain()->getRequest(); // b/c
583  }
584  );
585  }
586 
601  public static function newExtraneousContext( Title $title, $request = [] ) {
602  $context = new self;
603  $context->setTitle( $title );
604  if ( $request instanceof WebRequest ) {
605  $context->setRequest( $request );
606  } else {
607  $context->setRequest( new FauxRequest( $request ) );
608  }
609  $context->user = User::newFromName( '127.0.0.1', false );
610 
611  return $context;
612  }
613 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
setContext(IContextSource $context)
static normalizeKey( $key)
Normalize a skin preference value to a form that can be loaded.
Definition: Skin.php:102
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getVal( $name, $default=null)
Fetch a scalar from the input or return $default if it&#39;s not set.
Definition: WebRequest.php:448
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2159
getOption( $oname, $defaultOverride=null, $ignoreHidden=false)
Get the user&#39;s current setting for a given option.
Definition: User.php:3028
$value
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 MediaWikiServices
Definition: injection.txt:23
A helper class for throttling authentication attempts.
exportSession()
Export the resolved user IP, HTTP headers, user ID, and session ID.
title
static importScopedSession(array $params)
Import an client IP address, HTTP headers, user ID, and session ID.
if( $line===false) $args
Definition: cdb.php:64
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:51
setSkin(Skin $skin)
wfGetAllCallers( $limit=3)
Return a string consisting of callers in the stack.
$wgLanguageCode
Site language code.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation use $formDescriptor instead default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock() - offset Set to overwrite offset parameter in $wgRequest set to '' to unset offset - wrap String Wrap the message in html(usually something like "&lt
static getMain()
Get the RequestContext object associated with the main request.
Interface for configuration instances.
Definition: Config.php:28
canExist()
Is this in a namespace that allows actual pages?
Definition: Title.php:1146
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
canUseWikiPage()
Check whether a WikiPage object can be get with getWikiPage().
static isValid( $ip)
Validate an IP address.
Definition: IP.php:111
load( $flags=self::READ_NORMAL)
Load the user table data for this object from the source given by mFrom.
Definition: User.php:367
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.
Definition: distributors.txt:9
setWikiPage(WikiPage $wikiPage)
$params
getTitle()
Get the title object of the article.
Definition: WikiPage.php:294
static resetMain()
Resets singleton returned by getMain().
OutputPage $output
static newExtraneousContext(Title $title, $request=[])
Create a new extraneous context.
hasTitle()
Check, if a Title object is set.
setTitle(Title $title=null)
An interface to help developers measure the performance of their applications.
Definition: Timing.php:45
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
static factory( $code)
Get a cached or new language object for a given language code.
Definition: Language.php:216
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging a wrapping ErrorException create2 Corresponds to logging log_action database field and which is displayed in the UI similar to $comment or false if none Defaults to false if not set multiOccurrence Can this option be passed multiple times Defaults to false if not set this hook should only be used to add variables that depend on the current page request
Definition: hooks.txt:2159
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
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
Definition: distributors.txt:9
getWikiPage()
Get the WikiPage object.
static singleton()
Get the global SessionManager.
setUser(User $user)
static getGlobalSession()
Get the "global" session.
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:35
static newFromId( $id)
Static factory method for creation from a given user ID.
Definition: User.php:618
getId()
Get the user&#39;s ID.
Definition: User.php:2284
WikiPage $wikipage
wfDebugLog( $logGroup, $text, $dest='all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
static sanitizeLangCode( $code)
Accepts a language code and ensures it&#39;s sane.
global $wgCommandLineMode
static newFromSession(WebRequest $request=null)
Create a new user object using data from session.
Definition: User.php:768
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:2633
setLanguage( $language)
MediaWiki Logger LoggerFactory implements a PSR [0] compatible message logging system Named Psr Log LoggerInterface instances can be obtained from the MediaWiki Logger LoggerFactory::getInstance() static method. MediaWiki\Logger\LoggerFactory expects a class implementing the MediaWiki\Logger\Spi interface to act as a factory for new Psr\Log\LoggerInterface instances. The "Spi" in MediaWiki\Logger\Spi stands for "service provider interface". An SPI is an API intended to be implemented or extended by a third party. This software design pattern is intended to enable framework extension and replaceable components. It is specifically used in the MediaWiki\Logger\LoggerFactory service to allow alternate PSR-3 logging implementations to be easily integrated with MediaWiki. The service provider interface allows the backend logging library to be implemented in multiple ways. The $wgMWLoggerDefaultSpi global provides the classname of the default MediaWiki\Logger\Spi implementation to be loaded at runtime. This can either be the name of a class implementing the MediaWiki\Logger\Spi with a zero argument const ructor or a callable that will return an MediaWiki\Logger\Spi instance. Alternately the MediaWiki\Logger\LoggerFactory MediaWiki Logger LoggerFactory
Definition: logger.txt:5
static getMainAndWarn( $func=__METHOD__)
Get the RequestContext object associated with the main request and gives a warning to the log...
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
if(! $wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:783
WebRequest $request
setRequest(WebRequest $request)
if(! $wgRequest->checkUrlExtension()) if(isset( $_SERVER['PATH_INFO']) && $_SERVER['PATH_INFO'] !='') $wgTitle
Definition: api.php:57
static newFromName( $name, $validate='valid')
Static factory method for creation from username.
Definition: User.php:594
setOutput(OutputPage $output)
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
static isValidCode( $code)
Returns true if a language code string is of a valid form, whether or not it exists.
Definition: Language.php:388
getLanguage()
Get the Language object.
static RequestContext $instance
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
setConfig(Config $config)