MediaWiki  master
RequestContext.php
Go to the documentation of this file.
1 <?php
28 
36  private $request;
37 
41  private $title;
42 
46  private $wikipage;
47 
51  private $output;
52 
56  private $user;
57 
61  private $lang;
62 
66  private $skin;
67 
71  private $timing;
72 
76  private $config;
77 
81  private static $instance = null;
82 
86  public function setConfig( Config $config ) {
87  $this->config = $config;
88  }
89 
93  public function getConfig() {
94  if ( $this->config === null ) {
95  // @todo In the future, we could move this to WebStart.php so
96  // the Config object is ready for when initialization happens
97  $this->config = MediaWikiServices::getInstance()->getMainConfig();
98  }
99 
100  return $this->config;
101  }
102 
106  public function setRequest( WebRequest $request ) {
107  $this->request = $request;
108  }
109 
113  public function getRequest() {
114  if ( $this->request === null ) {
115  global $wgCommandLineMode;
116  // create the WebRequest object on the fly
117  if ( $wgCommandLineMode ) {
118  $this->request = new FauxRequest( [] );
119  } else {
120  $this->request = new WebRequest();
121  }
122  }
123 
124  return $this->request;
125  }
126 
132  public function getStats() {
133  return MediaWikiServices::getInstance()->getStatsdDataFactory();
134  }
135 
139  public function getTiming() {
140  if ( $this->timing === null ) {
141  $this->timing = new Timing( [
142  'logger' => LoggerFactory::getInstance( 'Timing' )
143  ] );
144  }
145  return $this->timing;
146  }
147 
151  public function setTitle( Title $title = null ) {
152  $this->title = $title;
153  // Erase the WikiPage so a new one with the new title gets created.
154  $this->wikipage = null;
155  }
156 
160  public function getTitle() {
161  if ( $this->title === null ) {
162  global $wgTitle; # fallback to $wg till we can improve this
163  $this->title = $wgTitle;
164  wfDebugLog(
165  'GlobalTitleFail',
166  __METHOD__ . ' called by ' . wfGetAllCallers( 5 ) . ' with no title set.'
167  );
168  }
169 
170  return $this->title;
171  }
172 
179  public function hasTitle() {
180  return $this->title !== null;
181  }
182 
191  public function canUseWikiPage() {
192  if ( $this->wikipage ) {
193  // If there's a WikiPage object set, we can for sure get it
194  return true;
195  }
196  // Only pages with legitimate titles can have WikiPages.
197  // That usually means pages in non-virtual namespaces.
198  $title = $this->getTitle();
199  return $title ? $title->canExist() : false;
200  }
201 
206  public function setWikiPage( WikiPage $wikiPage ) {
207  $pageTitle = $wikiPage->getTitle();
208  if ( !$this->hasTitle() || !$pageTitle->equals( $this->getTitle() ) ) {
209  $this->setTitle( $pageTitle );
210  }
211  // Defer this to the end since setTitle sets it to null.
212  $this->wikipage = $wikiPage;
213  }
214 
225  public function getWikiPage() {
226  if ( $this->wikipage === null ) {
227  $title = $this->getTitle();
228  if ( $title === null ) {
229  throw new MWException( __METHOD__ . ' called without Title object set' );
230  }
231  $this->wikipage = WikiPage::factory( $title );
232  }
233 
234  return $this->wikipage;
235  }
236 
240  public function setOutput( OutputPage $output ) {
241  $this->output = $output;
242  }
243 
247  public function getOutput() {
248  if ( $this->output === null ) {
249  $this->output = new OutputPage( $this );
250  }
251 
252  return $this->output;
253  }
254 
258  public function setUser( User $user ) {
259  $this->user = $user;
260  // Invalidate cached user interface language
261  $this->lang = null;
262  }
263 
267  public function getUser() {
268  if ( $this->user === null ) {
269  $this->user = User::newFromSession( $this->getRequest() );
270  }
271 
272  return $this->user;
273  }
274 
281  public static function sanitizeLangCode( $code ) {
282  global $wgLanguageCode;
283 
284  // BCP 47 - letter case MUST NOT carry meaning
285  $code = strtolower( $code );
286 
287  # Validate $code
288  if ( !$code || !Language::isValidCode( $code ) || $code === 'qqq' ) {
290  }
291 
292  return $code;
293  }
294 
300  public function setLanguage( $language ) {
301  if ( $language instanceof Language ) {
302  $this->lang = $language;
303  } elseif ( is_string( $language ) ) {
304  $language = self::sanitizeLangCode( $language );
305  $obj = Language::factory( $language );
306  $this->lang = $obj;
307  } else {
308  throw new MWException( __METHOD__ . " was passed an invalid type of data." );
309  }
310  }
311 
319  public function getLanguage() {
320  if ( isset( $this->recursion ) ) {
321  trigger_error( "Recursion detected in " . __METHOD__, E_USER_WARNING );
322  $e = new Exception;
323  wfDebugLog( 'recursion-guard', "Recursion detected:\n" . $e->getTraceAsString() );
324 
325  $code = $this->getConfig()->get( 'LanguageCode' ) ?: 'en';
326  $this->lang = Language::factory( $code );
327  } elseif ( $this->lang === null ) {
328  $this->recursion = true;
329 
330  try {
331  $request = $this->getRequest();
332  $user = $this->getUser();
333 
334  $code = $request->getVal( 'uselang', 'user' );
335  if ( $code === 'user' ) {
336  $code = $user->getOption( 'language' );
337  }
338  $code = self::sanitizeLangCode( $code );
339 
340  Hooks::run( 'UserGetLanguageObject', [ $user, &$code, $this ] );
341 
342  if ( $code === $this->getConfig()->get( 'LanguageCode' ) ) {
343  $this->lang = MediaWikiServices::getInstance()->getContentLanguage();
344  } else {
345  $obj = Language::factory( $code );
346  $this->lang = $obj;
347  }
348 
349  unset( $this->recursion );
350  }
351  catch ( Exception $ex ) {
352  unset( $this->recursion );
353  throw $ex;
354  }
355  }
356 
357  return $this->lang;
358  }
359 
363  public function setSkin( Skin $skin ) {
364  $this->skin = clone $skin;
365  $this->skin->setContext( $this );
366  }
367 
371  public function getSkin() {
372  if ( $this->skin === null ) {
373  $skin = null;
374  Hooks::run( 'RequestContextCreateSkin', [ $this, &$skin ] );
375  $factory = SkinFactory::getDefaultInstance();
376 
377  // If the hook worked try to set a skin from it
378  if ( $skin instanceof Skin ) {
379  $this->skin = $skin;
380  } elseif ( is_string( $skin ) ) {
381  // Normalize the key, just in case the hook did something weird.
382  $normalized = Skin::normalizeKey( $skin );
383  $this->skin = $factory->makeSkin( $normalized );
384  }
385 
386  // If this is still null (the hook didn't run or didn't work)
387  // then go through the normal processing to load a skin
388  if ( $this->skin === null ) {
389  if ( !in_array( 'skin', $this->getConfig()->get( 'HiddenPrefs' ) ) ) {
390  # get the user skin
391  $userSkin = $this->getUser()->getOption( 'skin' );
392  $userSkin = $this->getRequest()->getVal( 'useskin', $userSkin );
393  } else {
394  # if we're not allowing users to override, then use the default
395  $userSkin = $this->getConfig()->get( 'DefaultSkin' );
396  }
397 
398  // Normalize the key in case the user is passing gibberish
399  // or has old preferences (T71566).
400  $normalized = Skin::normalizeKey( $userSkin );
401 
402  // Skin::normalizeKey will also validate it, so
403  // this won't throw an exception
404  $this->skin = $factory->makeSkin( $normalized );
405  }
406 
407  // After all that set a context on whatever skin got created
408  $this->skin->setContext( $this );
409  }
410 
411  return $this->skin;
412  }
413 
423  public function msg( $key ) {
424  $args = func_get_args();
425 
426  return wfMessage( ...$args )->setContext( $this );
427  }
428 
434  public static function getMain() {
435  if ( self::$instance === null ) {
436  self::$instance = new self;
437  }
438 
439  return self::$instance;
440  }
441 
450  public static function getMainAndWarn( $func = __METHOD__ ) {
451  wfDebug( $func . ' called without context. ' .
452  "Using RequestContext::getMain() for sanity\n" );
453 
454  return self::getMain();
455  }
456 
460  public static function resetMain() {
461  if ( !( defined( 'MW_PHPUNIT_TEST' ) || defined( 'MW_PARSER_TEST' ) ) ) {
462  throw new MWException( __METHOD__ . '() should be called only from unit tests!' );
463  }
464  self::$instance = null;
465  }
466 
474  public function exportSession() {
476  return [
477  'ip' => $this->getRequest()->getIP(),
478  'headers' => $this->getRequest()->getAllHeaders(),
479  'sessionId' => $session->isPersistent() ? $session->getId() : '',
480  'userId' => $this->getUser()->getId()
481  ];
482  }
483 
506  public static function importScopedSession( array $params ) {
507  if ( strlen( $params['sessionId'] ) &&
508  MediaWiki\Session\SessionManager::getGlobalSession()->isPersistent()
509  ) {
510  // Sanity check to avoid sending random cookies for the wrong users.
511  // This method should only called by CLI scripts or by HTTP job runners.
512  throw new MWException( "Sessions can only be imported when none is active." );
513  } elseif ( !IP::isValid( $params['ip'] ) ) {
514  throw new MWException( "Invalid client IP address '{$params['ip']}'." );
515  }
516 
517  if ( $params['userId'] ) { // logged-in user
518  $user = User::newFromId( $params['userId'] );
519  $user->load();
520  if ( !$user->getId() ) {
521  throw new MWException( "No user with ID '{$params['userId']}'." );
522  }
523  } else { // anon user
524  $user = User::newFromName( $params['ip'], false );
525  }
526 
527  $importSessionFunc = function ( User $user, array $params ) {
528  global $wgRequest, $wgUser;
529 
531 
532  // Commit and close any current session
533  if ( MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
534  session_write_close(); // persist
535  session_id( '' ); // detach
536  $_SESSION = []; // clear in-memory array
537  }
538 
539  // Get new session, if applicable
540  $session = null;
541  if ( strlen( $params['sessionId'] ) ) { // don't make a new random ID
543  $session = $manager->getSessionById( $params['sessionId'], true )
544  ?: $manager->getEmptySession();
545  }
546 
547  // Remove any user IP or agent information, and attach the request
548  // with the new session.
549  $context->setRequest( new FauxRequest( [], false, $session ) );
550  $wgRequest = $context->getRequest(); // b/c
551 
552  // Now that all private information is detached from the user, it should
553  // be safe to load the new user. If errors occur or an exception is thrown
554  // and caught (leaving the main context in a mixed state), there is no risk
555  // of the User object being attached to the wrong IP, headers, or session.
556  $context->setUser( $user );
557  $wgUser = $context->getUser(); // b/c
558  if ( $session && MediaWiki\Session\PHPSessionHandler::isEnabled() ) {
559  session_id( $session->getId() );
560  Wikimedia\quietCall( 'session_start' );
561  }
562  $request = new FauxRequest( [], false, $session );
563  $request->setIP( $params['ip'] );
564  foreach ( $params['headers'] as $name => $value ) {
565  $request->setHeader( $name, $value );
566  }
567  // Set the current context to use the new WebRequest
568  $context->setRequest( $request );
569  $wgRequest = $context->getRequest(); // b/c
570  };
571 
572  // Stash the old session and load in the new one
573  $oUser = self::getMain()->getUser();
574  $oParams = self::getMain()->exportSession();
575  $oRequest = self::getMain()->getRequest();
576  $importSessionFunc( $user, $params );
577 
578  // Set callback to save and close the new session and reload the old one
579  return new ScopedCallback(
580  function () use ( $importSessionFunc, $oUser, $oParams, $oRequest ) {
581  global $wgRequest;
582  $importSessionFunc( $oUser, $oParams );
583  // Restore the exact previous Request object (instead of leaving FauxRequest)
584  RequestContext::getMain()->setRequest( $oRequest );
585  $wgRequest = RequestContext::getMain()->getRequest(); // b/c
586  }
587  );
588  }
589 
604  public static function newExtraneousContext( Title $title, $request = [] ) {
605  $context = new self;
606  $context->setTitle( $title );
607  if ( $request instanceof WebRequest ) {
608  $context->setRequest( $request );
609  } else {
610  $context->setRequest( new FauxRequest( $request ) );
611  }
612  $context->user = User::newFromName( '127.0.0.1', false );
613 
614  return $context;
615  }
616 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:128
setContext(IContextSource $context)
static normalizeKey( $key)
Normalize a skin preference value to a form that can be loaded.
Definition: Skin.php:101
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:440
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException' returning false will NOT prevent logging $e
Definition: hooks.txt:2172
getOption( $oname, $defaultOverride=null, $ignoreHidden=false)
Get the user&#39;s current setting for a given option.
Definition: User.php:3208
$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:47
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:1074
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:357
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:284
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:214
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 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: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:608
getId()
Get the user&#39;s ID.
Definition: User.php:2460
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:749
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 this hook should only be used to add variables that depend on the current page request
Definition: hooks.txt:2172
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:2625
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:728
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:584
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:386
getLanguage()
Get the Language object.
static getDefaultInstance()
Definition: SkinFactory.php:50
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)