MediaWiki  master
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | List of all members
RequestContext Class Reference

Group all the pieces relevant to the context of a request into one instance. More...

Inheritance diagram for RequestContext:
Inheritance graph
[legend]
Collaboration diagram for RequestContext:
Collaboration graph
[legend]

Public Member Functions

 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 hasTitle ()
 Check, if a Title object is set. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setConfig (Config $config)
 
 setLanguage ( $language)
 
 setOutput (OutputPage $output)
 
 setRequest (WebRequest $request)
 
 setSkin (Skin $skin)
 
 setTitle (Title $title=null)
 
 setUser (User $user)
 
 setWikiPage (WikiPage $wikiPage)
 

Static Public Member Functions

static getMain ()
 Get the RequestContext object associated with the main request. More...
 
static getMainAndWarn ( $func=__METHOD__)
 Get the RequestContext object associated with the main request and gives a warning to the log, to find places, where a context maybe is missing. More...
 
static importScopedSession (array $params)
 Import an client IP address, HTTP headers, user ID, and session ID. More...
 
static newExtraneousContext (Title $title, $request=[])
 Create a new extraneous context. More...
 
static resetMain ()
 Resets singleton returned by getMain(). More...
 
static sanitizeLangCode ( $code)
 Accepts a language code and ensures it's sane. More...
 

Private Attributes

Config $config
 
Language $lang
 
bool $languageRecursion = false
 Boolean flag to guard against recursion in getLanguage. More...
 
OutputPage $output
 
WebRequest $request
 
Skin $skin
 
Timing $timing
 
Title $title
 
User $user
 
WikiPage $wikipage
 

Static Private Attributes

static RequestContext $instance = null
 

Detailed Description

Group all the pieces relevant to the context of a request into one instance.

Definition at line 34 of file RequestContext.php.

Member Function Documentation

◆ canUseWikiPage()

RequestContext::canUseWikiPage ( )

Check whether a WikiPage object can be get with getWikiPage().

Callers should expect that an exception is thrown from getWikiPage() if this method returns false.

Since
1.19
Returns
bool

Implements IContextSource.

Definition at line 200 of file RequestContext.php.

References $title, Title\canExist(), and getTitle().

◆ exportSession()

RequestContext::exportSession ( )

Export the resolved user IP, HTTP headers, user ID, and session ID.

The result will be reasonably sized to allow for serialization.

Returns
array
Since
1.21

Implements IContextSource.

Definition at line 487 of file RequestContext.php.

References MediaWiki\Session\SessionManager\getGlobalSession(), getRequest(), and getUser().

◆ getConfig()

RequestContext::getConfig ( )
Returns
Config

Implements IContextSource.

Definition at line 101 of file RequestContext.php.

References $config.

Referenced by getLanguage(), and getSkin().

◆ getLanguage()

RequestContext::getLanguage ( )

Get the Language object.

Initialization of user or request objects can depend on this.

Returns
Language
Exceptions
Exception
Since
1.19

Implements IContextSource.

Definition at line 328 of file RequestContext.php.

References $lang, $request, $user, getConfig(), User\getOption(), WebRequest\getRawVal(), getRequest(), getUser(), Hooks\run(), sanitizeLangCode(), and wfDebugLog().

◆ getMain()

static RequestContext::getMain ( )
static

Get the RequestContext object associated with the main request.

Returns
RequestContext

Definition at line 447 of file RequestContext.php.

References $instance.

Referenced by MediaWiki\Rest\Handler\RevisionHandler\__construct(), UserBlockedError\__construct(), PermissionsError\__construct(), MediaWiki\Rest\Handler\CompareHandler\__construct(), SpecialMute\__construct(), MediaWiki\Rest\Handler\SearchHandler\__construct(), MediaWiki\__construct(), MediaWiki\Rest\Handler\LanguageLinksHandler\__construct(), MediaWiki\Rest\Handler\PageHistoryHandler\__construct(), MediaWiki\Session\PHPSessionHandler\__construct(), Pingback\__construct(), MediaWiki\Rest\Handler\PageSourceHandler\__construct(), MediaWiki\Rest\Handler\PageHistoryCountHandler\__construct(), LogFormatter\__construct(), MediaWiki\Session\SessionBackend\__construct(), ApiMain\__construct(), Installer\__construct(), StubUserLang\_newObject(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Block\AbstractBlock\appliesToUsertalk(), SpecialBlock\blockLogFlags(), Linker\buildRollbackLink(), ChangeTags\buildTagFilterSelector(), Preprocessor\cacheGetTree(), Preprocessor\cacheSetTree(), MediaWiki\Special\SpecialPageFactory\capturePath(), MediaWiki\Auth\AuthManager\checkAccountCreatePermissions(), MediaWiki\Permissions\PermissionManager\checkUserBlock(), TextSlotDiffRenderer\diff(), Undelete\execute(), RebuildFileCache\execute(), UpdateMediaWiki\execute(), LoginSignupSpecialPage\execute(), ChangesList\flag(), FeedUtils\formatDiffRow(), ChangeTags\formatSummaryRow(), Linker\generateRollback(), MediaWiki\Auth\AuthManager\getAuthenticationRequestsInternal(), User\getBlockedStatus(), ContextSource\getContext(), Profiler\getContext(), Action\getContext(), SpecialPage\getContext(), Article\getContext(), MediaWiki\Session\SessionManager\getGlobalSession(), MWTimestamp\getHumanTimestamp(), Language\getHumanTimestamp(), getMainAndWarn(), MediaWiki\Block\AbstractBlock\getReason(), MWTimestamp\getRelativeTimestamp(), WebRequest\getRequestId(), ParserOutput\getText(), MediaWiki\Special\SpecialPageFactory\getUsablePages(), ApiMain\handleApiBeforeMainException(), DeferredUpdates\handleUpdateQueue(), importScopedSession(), HTMLButtonField\isBadIE(), WikitextContent\isCountable(), MediaWiki\Rest\EntryPoint\main(), User\newFatalPermissionDeniedStatus(), EmailNotification\notifyOnPageChange(), CategoryMembershipChangeJob\notifyUpdatesForRevision(), SpecialUserLogout\onSubmit(), MediaWiki\Block\AbstractBlock\prevents(), WikiImporter\processTitle(), UserNotLoggedIn\report(), User\resetOptions(), ChangeTags\restrictedTagError(), AssembleUploadChunksJob\run(), PublishStashedFileJob\run(), MediaWiki\Auth\AuthManager\setDefaultUserOptions(), LoginSignupSpecialPage\setSessionUserForCurrentRequest(), WebInstaller\setupLanguage(), MediaWiki\Block\DatabaseBlock\shouldTrackWithCookie(), ChangesList\showCharacterDifference(), LogEventsList\showLogExtract(), MediaWiki\Auth\AuthManager\singleton(), MediaWiki\Auth\CheckBlocksSecondaryAuthenticationProvider\testUserForCreation(), Linker\tocList(), WikiPage\triggerOpportunisticLinksUpdate(), MWExceptionRenderer\useOutputPage(), ChangesList\userCan(), wfInstallerMain(), wfLogProfilingData(), and wfStreamThumb().

◆ getMainAndWarn()

static RequestContext::getMainAndWarn (   $func = __METHOD__)
static

Get the RequestContext object associated with the main request and gives a warning to the log, to find places, where a context maybe is missing.

Parameters
string$func
Returns
RequestContext
Since
1.24

Definition at line 463 of file RequestContext.php.

References getMain(), and wfDebug().

Referenced by ImageGalleryBase\factory().

◆ getOutput()

RequestContext::getOutput ( )
Returns
OutputPage

Implements IContextSource.

Definition at line 256 of file RequestContext.php.

References $output.

◆ getRequest()

RequestContext::getRequest ( )
Returns
WebRequest

Implements IContextSource.

Definition at line 121 of file RequestContext.php.

References $request, and $wgCommandLineMode.

Referenced by exportSession(), getLanguage(), getSkin(), and getUser().

◆ getSkin()

RequestContext::getSkin ( )
Returns
Skin

Implements IContextSource.

Definition at line 391 of file RequestContext.php.

References $skin, getConfig(), getRequest(), getUser(), Skin\normalizeKey(), and Hooks\run().

◆ getStats()

RequestContext::getStats ( )
Deprecated:
since 1.27 use a StatsdDataFactory from MediaWikiServices (preferably injected)
Returns
IBufferingStatsdDataFactory

Implements IContextSource.

Definition at line 140 of file RequestContext.php.

◆ getTiming()

RequestContext::getTiming ( )
Returns
Timing

Implements IContextSource.

Definition at line 147 of file RequestContext.php.

References $timing.

◆ getTitle()

RequestContext::getTitle ( )
Returns
Title|null

Implements IContextSource.

Definition at line 168 of file RequestContext.php.

References $title, and $wgTitle.

Referenced by canUseWikiPage(), and getWikiPage().

◆ getUser()

RequestContext::getUser ( )
Returns
User

Implements IContextSource.

Definition at line 276 of file RequestContext.php.

References $user, getRequest(), and User\newFromSession().

Referenced by exportSession(), getLanguage(), getSkin(), and MediaWiki\Rest\EntryPoint\main().

◆ getWikiPage()

RequestContext::getWikiPage ( )

Get the WikiPage object.

May throw an exception if there's no Title object set or the Title object belongs to a special namespace that doesn't have WikiPage, so use first canUseWikiPage() to check whether this method can be called safely.

Since
1.19
Exceptions
MWException
Returns
WikiPage

Implements IContextSource.

Definition at line 234 of file RequestContext.php.

References $title, $wikipage, WikiPage\factory(), and getTitle().

◆ hasTitle()

RequestContext::hasTitle ( )

Check, if a Title object is set.

Since
1.25
Returns
bool

Definition at line 188 of file RequestContext.php.

Referenced by setWikiPage().

◆ importScopedSession()

static RequestContext::importScopedSession ( array  $params)
static

Import an client IP address, HTTP headers, user ID, and session ID.

This sets the current session, $wgUser, and $wgRequest from $params. Once the return value falls out of scope, the old context is restored. This method should only be called in contexts where there is no session ID or end user receiving the response (CLI or HTTP job runners). This is partly enforced, and is done so to avoid leaking cookies if certain error conditions arise.

This is useful when background scripts inherit context when acting on behalf of a user. In general the 'sessionId' parameter should be set to an empty string unless session importing is truly needed. This feature is somewhat deprecated.

Note
suhosin.session.encrypt may interfere with this method.
Parameters
array$paramsResult of RequestContext::exportSession()
Returns
ScopedCallback
Exceptions
MWException
Since
1.21

Definition at line 519 of file RequestContext.php.

References $context, $request, $user, $wgRequest, User\getId(), getMain(), User\load(), User\newFromId(), User\newFromName(), WebRequest\setIP(), and MediaWiki\Session\SessionManager\singleton().

Referenced by AssembleUploadChunksJob\run(), and PublishStashedFileJob\run().

◆ msg()

RequestContext::msg (   $key,
  $params 
)

Get a Message object with context set Parameters are the same as wfMessage()

Parameters
string | string[] | MessageSpecifier$keyMessage key, or array of keys, or a MessageSpecifier.
mixed...$params
Returns
Message

Implements MessageLocalizer.

Definition at line 438 of file RequestContext.php.

References wfMessage().

◆ newExtraneousContext()

static RequestContext::newExtraneousContext ( Title  $title,
  $request = [] 
)
static

Create a new extraneous context.

The context is filled with information external to the current session.

  • Title is specified by argument
  • Request is a FauxRequest, or a FauxRequest can be specified by argument
  • User is an anonymous user, for separation IPv4 localhost is used
  • Language will be based on the anonymous user and request, may be content language or a uselang param in the fauxrequest data may change the lang
  • Skin will be based on the anonymous user, should be the wiki's default skin
Parameters
Title$titleTitle to use for the extraneous request
WebRequest | array$requestA WebRequest or data to use for a FauxRequest
Returns
RequestContext

Definition at line 617 of file RequestContext.php.

References $context, $request, $title, and User\newFromName().

Referenced by LogPage\addEntry(), ManualLogEntry\getRecentChange(), MovePage\moveToInternal(), SpecialChangeContentModel\onSubmit(), and LocalFile\recordUpload2().

◆ resetMain()

static RequestContext::resetMain ( )
static

Resets singleton returned by getMain().

Should be called only from unit tests.

Definition at line 473 of file RequestContext.php.

◆ sanitizeLangCode()

static RequestContext::sanitizeLangCode (   $code)
static

Accepts a language code and ensures it's sane.

Outputs a cleaned up language code and replaces with $wgLanguageCode if not sane.

Parameters
string$codeLanguage code
Returns
string

Definition at line 290 of file RequestContext.php.

References $wgLanguageCode, and Language\isValidCode().

Referenced by ApiMain\__construct(), getLanguage(), DerivativeContext\setLanguage(), and setLanguage().

◆ setConfig()

RequestContext::setConfig ( Config  $config)
Parameters
Config$config

Implements MutableContext.

Definition at line 94 of file RequestContext.php.

References $config.

◆ setLanguage()

RequestContext::setLanguage (   $language)
Parameters
Language | string$languageLanguage instance or language code
Exceptions
MWException
Since
1.19

Implements MutableContext.

Definition at line 309 of file RequestContext.php.

References sanitizeLangCode().

◆ setOutput()

RequestContext::setOutput ( OutputPage  $output)
Parameters
OutputPage$output

Implements MutableContext.

Definition at line 249 of file RequestContext.php.

References $output.

◆ setRequest()

RequestContext::setRequest ( WebRequest  $request)
Parameters
WebRequest$request

Implements MutableContext.

Definition at line 114 of file RequestContext.php.

References $request.

Referenced by ApiEditPage\execute().

◆ setSkin()

RequestContext::setSkin ( Skin  $skin)
Parameters
Skin$skin

Implements MutableContext.

Definition at line 383 of file RequestContext.php.

References $skin, and ContextSource\setContext().

◆ setTitle()

RequestContext::setTitle ( Title  $title = null)
Parameters
Title | null$title

Implements MutableContext.

Definition at line 159 of file RequestContext.php.

References $title.

Referenced by MediaWiki\Rest\EntryPoint\main(), and setWikiPage().

◆ setUser()

RequestContext::setUser ( User  $user)
Parameters
User$user

Implements MutableContext.

Definition at line 267 of file RequestContext.php.

References $user.

Referenced by ApiParamInfo\execute().

◆ setWikiPage()

RequestContext::setWikiPage ( WikiPage  $wikiPage)
Since
1.19
Parameters
WikiPage$wikiPage

Implements MutableContext.

Definition at line 215 of file RequestContext.php.

References WikiPage\getTitle(), hasTitle(), and setTitle().

Member Data Documentation

◆ $config

Config RequestContext::$config
private

Definition at line 78 of file RequestContext.php.

Referenced by getConfig(), and setConfig().

◆ $instance

RequestContext RequestContext::$instance = null
staticprivate

Definition at line 83 of file RequestContext.php.

Referenced by getMain().

◆ $lang

Language RequestContext::$lang
private

Definition at line 63 of file RequestContext.php.

Referenced by getLanguage().

◆ $languageRecursion

bool RequestContext::$languageRecursion = false
private

Boolean flag to guard against recursion in getLanguage.

Definition at line 89 of file RequestContext.php.

◆ $output

OutputPage RequestContext::$output
private

Definition at line 53 of file RequestContext.php.

Referenced by getOutput(), and setOutput().

◆ $request

WebRequest RequestContext::$request
private

Definition at line 38 of file RequestContext.php.

Referenced by getLanguage(), getRequest(), importScopedSession(), newExtraneousContext(), and setRequest().

◆ $skin

Skin RequestContext::$skin
private

Definition at line 68 of file RequestContext.php.

Referenced by getSkin(), and setSkin().

◆ $timing

Timing RequestContext::$timing
private

Definition at line 73 of file RequestContext.php.

Referenced by getTiming().

◆ $title

Title RequestContext::$title
private

Definition at line 43 of file RequestContext.php.

Referenced by canUseWikiPage(), getTitle(), getWikiPage(), newExtraneousContext(), and setTitle().

◆ $user

User RequestContext::$user
private

Definition at line 58 of file RequestContext.php.

Referenced by getLanguage(), getUser(), importScopedSession(), and setUser().

◆ $wikipage

WikiPage RequestContext::$wikipage
private

Definition at line 48 of file RequestContext.php.

Referenced by getWikiPage().

The documentation for this class was generated from the following file: