MediaWiki  1.28.1
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 
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 = ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
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;
181  wfDebugLog(
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  }
366  $code = self::sanitizeLangCode( $code );
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 (bug 69566).
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 
455  public function msg() {
456  $args = func_get_args();
457 
458  return call_user_func_array( 'wfMessage', $args )->setContext( $this );
459  }
460 
468  public static function getMain() {
469  if ( self::$instance === null ) {
470  self::$instance = new self;
471  }
472 
473  return self::$instance;
474  }
475 
484  public static function getMainAndWarn( $func = __METHOD__ ) {
485  wfDebug( $func . ' called without context. ' .
486  "Using RequestContext::getMain() for sanity\n" );
487 
488  return self::getMain();
489  }
490 
494  public static function resetMain() {
495  if ( !( defined( 'MW_PHPUNIT_TEST' ) || defined( 'MW_PARSER_TEST' ) ) ) {
496  throw new MWException( __METHOD__ . '() should be called only from unit tests!' );
497  }
498  self::$instance = null;
499  }
500 
508  public function exportSession() {
510  return [
511  'ip' => $this->getRequest()->getIP(),
512  'headers' => $this->getRequest()->getAllHeaders(),
513  'sessionId' => $session->isPersistent() ? $session->getId() : '',
514  'userId' => $this->getUser()->getId()
515  ];
516  }
517 
540  public static function importScopedSession( array $params ) {
541  if ( strlen( $params['sessionId'] ) &&
542  MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent()
543  ) {
544  // Sanity check to avoid sending random cookies for the wrong users.
545  // This method should only called by CLI scripts or by HTTP job runners.
546  throw new MWException( "Sessions can only be imported when none is active." );
547  } elseif ( !IP::isValid( $params['ip'] ) ) {
548  throw new MWException( "Invalid client IP address '{$params['ip']}'." );
549  }
550 
551  if ( $params['userId'] ) { // logged-in user
552  $user = User::newFromId( $params['userId'] );
553  $user->load();
554  if ( !$user->getId() ) {
555  throw new MWException( "No user with ID '{$params['userId']}'." );
556  }
557  } else { // anon user
558  $user = User::newFromName( $params['ip'], false );
559  }
560 
561  $importSessionFunc = function ( User $user, array $params ) {
563 
565 
566  // Commit and close any current session
567  if ( MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
568  session_write_close(); // persist
569  session_id( '' ); // detach
570  $_SESSION = []; // clear in-memory array
571  }
572 
573  // Get new session, if applicable
574  $session = null;
575  if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
577  $session = $manager->getSessionById( $params['sessionId'], true )
578  ?: $manager->getEmptySession();
579  }
580 
581  // Remove any user IP or agent information, and attach the request
582  // with the new session.
583  $context->setRequest( new FauxRequest( [], false, $session ) );
584  $wgRequest = $context->getRequest(); // b/c
585 
586  // Now that all private information is detached from the user, it should
587  // be safe to load the new user. If errors occur or an exception is thrown
588  // and caught (leaving the main context in a mixed state), there is no risk
589  // of the User object being attached to the wrong IP, headers, or session.
590  $context->setUser( $user );
591  $wgUser = $context->getUser(); // b/c
592  if ( $session && MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
593  session_id( $session->getId() );
594  MediaWiki\quietCall( 'session_start' );
595  }
596  $request = new FauxRequest( [], false, $session );
597  $request->setIP( $params['ip'] );
598  foreach ( $params['headers'] as $name => $value ) {
599  $request->setHeader( $name, $value );
600  }
601  // Set the current context to use the new WebRequest
602  $context->setRequest( $request );
603  $wgRequest = $context->getRequest(); // b/c
604  };
605 
606  // Stash the old session and load in the new one
607  $oUser = self::getMain()->getUser();
608  $oParams = self::getMain()->exportSession();
609  $oRequest = self::getMain()->getRequest();
610  $importSessionFunc( $user, $params );
611 
612  // Set callback to save and close the new session and reload the old one
613  return new ScopedCallback(
614  function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
616  $importSessionFunc( $oUser, $oParams );
617  // Restore the exact previous Request object (instead of leaving FauxRequest)
618  RequestContext::getMain()->setRequest( $oRequest );
619  $wgRequest = RequestContext::getMain()->getRequest(); // b/c
620  }
621  );
622  }
623 
638  public static function newExtraneousContext( Title $title, $request = [] ) {
639  $context = new self;
640  $context->setTitle( $title );
641  if ( $request instanceof WebRequest ) {
642  $context->setRequest( $request );
643  } else {
644  $context->setRequest( new FauxRequest( $request ) );
645  }
646  $context->user = User::newFromName( '127.0.0.1', false );
647 
648  return $context;
649  }
650 }
static newFromName($name, $validate= 'valid')
Static factory method for creation from username.
Definition: User.php:525
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
setContext(IContextSource $context)
Set the IContextSource object.
setWikiPage(WikiPage $p)
Set the WikiPage object.
Interface for objects which can provide a MediaWiki context on request.
the array() calling protocol came about after MediaWiki 1.4rc1.
getTiming()
Get the timing object.
getConfig()
Get the Config object.
The main skin class which provides methods and properties for all other skins.
Definition: Skin.php:34
setRequest(WebRequest $r)
Set the WebRequest object.
Group all the pieces relevant to the context of a request into one instance.
$context
Definition: load.php:50
load($flags=self::READ_NORMAL)
Load the user table data for this object from the source given by mFrom.
Definition: User.php:358
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(!$wgDBerrorLogTZ) $wgRequest
Definition: Setup.php:664
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
$value
static newFromId($id)
Static factory method for creation from a given user ID.
Definition: User.php:548
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.
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
exportSession()
Export the resolved user IP, HTTP headers, user ID, and session ID.
title
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
static importScopedSession(array $params)
Import an client IP address, HTTP headers, user ID, and session ID.
static sanitizeLangCode($code)
Accepts a language code and ensures it's sane.
if($line===false) $args
Definition: cdb.php:64
$wgLanguageCode
Site language code.
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
global $wgCommandLineMode
Definition: Setup.php:495
getSkin()
Get the Skin object.
static getMain()
Static methods.
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'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:2102
static isValid($ip)
Validate an IP address.
Definition: IP.php:113
getUser()
Get the User object.
canExist()
Is this in a namespace that allows actual pages?
Definition: Title.php:1033
canUseWikiPage()
Check whether a WikiPage object can be get with getWikiPage().
getTitle()
Get the Title object.
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
static isValidCode($code)
Returns true if a language code string is of a valid form, whether or not it exists.
Definition: Language.php:335
$params
getTitle()
Get the title object of the article.
Definition: WikiPage.php:232
static resetMain()
Resets singleton returned by getMain().
OutputPage $output
static newExtraneousContext(Title $title, $request=[])
Create a new extraneous context.
setOutput(OutputPage $o)
hasTitle()
Check, if a Title object is set.
setTitle(Title $title=null)
Set the Title object.
An interface to help developers measure the performance of their applications.
Definition: Timing.php:45
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
getOutput()
Get the OutputPage object.
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
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:802
This class should be covered by a general architecture document which does not exist as of January 20...
Definition: OutputPage.php:43
getWikiPage()
Get the WikiPage object.
static singleton()
Get the global SessionManager.
static normalizeKey($key)
Normalize a skin preference value to a form that can be loaded.
Definition: Skin.php:93
setLanguage($l)
Set the Language object.
setConfig(Config $c)
Set the Config object.
getOption($oname, $defaultOverride=null, $ignoreHidden=false)
Get the user's current setting for a given option.
Definition: User.php:2766
getVal($name, $default=null)
Fetch a scalar from the input or return $default if it's not set.
Definition: WebRequest.php:437
static getDefaultInstance()
Class representing a MediaWiki article and history.
Definition: WikiPage.php:32
wfGetAllCallers($limit=3)
Return a string consisting of callers in the stack.
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
setUser(User $u)
Set the User object.
getId()
Get the user's ID.
Definition: User.php:2083
WikiPage $wikipage
getStats()
Get the Stats object.
msg()
Helpful methods.
getRequest()
Get the WebRequest object.
static newFromSession(WebRequest $request=null)
Create a new user object using data from session.
Definition: User.php:591
static getMainAndWarn($func=__METHOD__)
Get the RequestContext object associated with the main request and gives a warning to the log...
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:56
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
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
WebRequest $request
setSkin(Skin $s)
Set the Skin object.
if(!$wgRequest->checkUrlExtension()) if(!$wgEnableAPI) $wgTitle
Definition: api.php:57
static factory($code)
Get a cached or new language object for a given language code.
Definition: Language.php:181
getLanguage()
Get the Language object.
static getDefaultInstance()
Definition: SkinFactory.php:50
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)
static RequestContext $instance
$wgUser
Definition: Setup.php:806
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300