The MediaWiki class is the helper class for the index.php entry point. More...

Collaboration diagram for MediaWiki:

[legend]

Classes
class	MediaWikiServices
	MediaWikiServices is the service locator for the application scope of MediaWiki. More...

class	OutputHandler

Public Member Functions
	__construct (IContextSource $context=null)

	doPostOutputShutdown ()
	This function does work that can be done after the user gets the HTTP response so they don't block on it. More...

	doPreOutputCommit (callable $postCommitWork=null)

	getAction ()
	Returns the name of the action that will be executed. More...

	getTitle ()
	Get the Title object that we'll be acting on, as specified in the WebRequest. More...

	restInPeace ()
	Ends this task peacefully. More...

	run ()
	Run the current MediaWiki instance; index.php just calls this. More...

Static Public Member Functions
static	emitBufferedStatsdData (IBufferingStatsdDataFactory $stats, Config $config)
	Send out any buffered statsd data according to sampling rules. More...

static	preOutputCommit (IContextSource $context, callable $postCommitWork=null)
	This function commits all DB and session changes as needed before the client can receive a response (in case DB commit fails) and thus also before the response can trigger a subsequent related request by the client. More...

Private Member Functions
	initializeArticle ()
	Initialize the main Article object for "standard" actions (view, etc) Create an Article object for the page, following redirects if needed. More...

	main ()
	Determine and send the response headers and body for this web request. More...

	maybeDoHttpsRedirect ()
	If the stars are suitably aligned, do an HTTP->HTTPS redirect. More...

	outputResponsePayload ( $content)
	Print a response body to the current buffer (if there is one) or the server (otherwise) More...

	parseTitle ()
	Parse the request to get the Title object. More...

	performAction (Article $article, Title $requestTitle)
	Perform one of the "standard" actions. More...

	performRequest ()
	Performs the request. More...

	schedulePostSendJobs ()
	If enabled, after everything specific to this request is done, occasionally run jobs. More...

	setDBProfilingAgent ()
	Add a comment to future SQL queries for easy SHOW PROCESSLIST interpretation. More...

	shouldDoHttpRedirect ()
	Check if an HTTP->HTTPS redirect should be done. More...

	triggerAsyncJobs ( $n, LoggerInterface $runJobsLogger)

	triggerSyncJobs ( $n)

	tryNormaliseRedirect (Title $title)
	Handle redirects for uncanonical title requests. More...

Static Private Member Functions
static	getUrlDomainDistance ( $url)

Private Attributes
string	$action
	Cache what action this request is. More...

Config	$config

IContextSource	$context

int	$postSendStrategy
	Class DEFER_* constant; how non-blocking post-response tasks should run. More...

const	DEFER_CLI_MODE = 3
	Do not try to make post-send updates async (e.g. More...

const	DEFER_FASTCGI_FINISH_REQUEST = 1
	Call fastcgi_finish_request() to make post-send updates async. More...

const	DEFER_SET_LENGTH_AND_FLUSH = 2
	Set Content-Length and call ob_end_flush()/flush() to make post-send updates async. More...

Detailed Description

The MediaWiki class is the helper class for the index.php entry point.

Definition at line 36 of file MediaWiki.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki::__construct ( IContextSource $context = null )

Parameters

IContextSource | null $context

Definition at line 59 of file MediaWiki.php.

References $context, DEFER_CLI_MODE, DEFER_FASTCGI_FINISH_REQUEST, DEFER_SET_LENGTH_AND_FLUSH, and RequestContext\getMain().

Member Function Documentation

◆ doPostOutputShutdown()

MediaWiki::doPostOutputShutdown ( )

This function does work that can be done after the user gets the HTTP response so they don't block on it.

This manages deferred updates, job insertion, final commit, and the logging of profiling data

Since: 1.26

Definition at line 818 of file MediaWiki.php.

References WebResponse\disableForPostSend(), restInPeace(), and MWExceptionHandler\rollbackPrimaryChangesAndLog().

Referenced by run().

◆ doPreOutputCommit()

MediaWiki::doPreOutputCommit ( callable $postCommitWork = null )

See also: MediaWiki::preOutputCommit()

Parameters

callable | null $postCommitWork [default: null]

Since: 1.26

Definition at line 653 of file MediaWiki.php.

References preOutputCommit().

Referenced by main().

◆ emitBufferedStatsdData()

static MediaWiki::emitBufferedStatsdData	(	IBufferingStatsdDataFactory	$stats,
		Config	$config
	)

static

Send out any buffered statsd data according to sampling rules.

For web requests, this is called once by MediaWiki::restInPeace(), which is post-send (after the response is sent to the client).

For maintenance scripts, especially long-running CLI scripts, it is called more often, to avoid OOM, since we buffer stats (T181385), based on the following heuristics:

Long-running scripts that involve database writes often use transactions to commit chunks of work. We flush from IDatabase::setTransactionListener, as wired up by MWLBFactory::applyGlobalState.
Long-running scripts that involve database writes but don't need any transactions will still periodically wait for replication to be graceful to the databases. We flush from ILBFactory::setWaitForReplicationListener as wired up by MWLBFactory::applyGlobalState.
Any other long-running scripts will probably report progress to stdout in some way. We also flush from Maintenance::output().

Parameters

IBufferingStatsdDataFactory	$stats
Config	$config

Exceptions

ConfigException

Since: 1.31

Definition at line 1185 of file MediaWiki.php.

References $config, IBufferingStatsdDataFactory\clearData(), Config\get(), IBufferingStatsdDataFactory\getData(), IBufferingStatsdDataFactory\hasData(), and MWExceptionHandler\logException().

Referenced by MWLBFactory\applyGlobalState(), Maintenance\output(), restInPeace(), Maintenance\shutdown(), and wfLogProfilingData().

◆ getAction()

MediaWiki::getAction ( )

Returns the name of the action that will be executed.

Returns: string Action

Definition at line 174 of file MediaWiki.php.

References $action, and Action\getActionName().

Referenced by main(), and performAction().

◆ getTitle()

MediaWiki::getTitle ( )

Get the Title object that we'll be acting on, as specified in the WebRequest.

Returns: Title

Definition at line 158 of file MediaWiki.php.

References SpecialPage\getTitleFor(), and parseTitle().

Referenced by main(), and schedulePostSendJobs().

◆ getUrlDomainDistance()

static MediaWiki::getUrlDomainDistance ( $url )

staticprivate

Parameters

string $url

Returns: string Either "local", "remote" if in the farm, "external" otherwise

Definition at line 797 of file MediaWiki.php.

References WikiMap\getWikiFromUrl(), and WikiMap\isCurrentWikiId().

Referenced by preOutputCommit().

◆ initializeArticle()

MediaWiki::initializeArticle ( )

private

Initialize the main Article object for "standard" actions (view, etc) Create an Article object for the page, following redirects if needed.

Returns: Article|string An Article, or a string to redirect to another URL

Definition at line 414 of file MediaWiki.php.

References $action, $file, $title, MediaWiki\MediaWikiServices\getInstance(), Article\newFromWikiPage(), and wfWarn().

Referenced by performRequest().

◆ main()

MediaWiki::main ( )

private

Determine and send the response headers and body for this web request.

Definition at line 863 of file MediaWiki.php.

References $action, $cache, $title, $wgTitle, doPreOutputCommit(), getAction(), MediaWiki\Logger\LoggerFactory\getInstance(), getTitle(), Profiler\instance(), Title\makeTitle(), maybeDoHttpsRedirect(), NS_SPECIAL, outputResponsePayload(), performRequest(), ErrorPageError\report(), schedulePostSendJobs(), ErrorPageError\STAGE_OUTPUT, and HTMLFileCache\useFileCache().

Referenced by run().

◆ maybeDoHttpsRedirect()

MediaWiki::maybeDoHttpsRedirect ( )

private

If the stars are suitably aligned, do an HTTP->HTTPS redirect.

Note: Do this after $wgTitle is setup, otherwise the hooks run from isRegistered() will do all sorts of weird stuff.

Returns: bool True if the redirect was done. Handling of the request should be aborted. False if no redirect was done.

Definition at line 1005 of file MediaWiki.php.

References $title, Title\newFromText(), NS_MAIN, shouldDoHttpRedirect(), and wfDebugLog().

Referenced by main().

◆ outputResponsePayload()

MediaWiki::outputResponsePayload ( $content )

private

Print a response body to the current buffer (if there is one) or the server (otherwise)

This method should be called after doPreOutputCommit() and before doPostOutputShutdown()

Any accompanying Content-Type header is assumed to have already been set

Parameters

string $content Response content, usually from OutputPage::output()

Definition at line 1046 of file MediaWiki.php.

References $content, Profiler\instance(), and DeferredUpdates\pendingUpdatesCount().

Referenced by main().

◆ parseTitle()

MediaWiki::parseTitle ( )

private

Parse the request to get the Title object.

Exceptions

MalformedTitleException If a title has been provided by the user, but is invalid.

Returns: Title Title object to be $wgTitle

Definition at line 78 of file MediaWiki.php.

References $action, $title, MediaWiki\MediaWikiServices\getInstance(), SpecialPage\getTitleFor(), Title\makeTitle(), Title\newFromID(), Title\newFromLinkTarget(), Title\newFromTextThrow(), Title\newFromURL(), Title\newMainPage(), NS_FILE, and NS_MEDIA.

Referenced by getTitle(), and performRequest().

◆ performAction()

MediaWiki::performAction	(	Article	$article,
		Title	$requestTitle
	)

private

Perform one of the "standard" actions.

Parameters

Article	$article
Title	$requestTitle	The original title, before any redirects were applied

Definition at line 499 of file MediaWiki.php.

References $action, $t, $title, Action\factory(), getAction(), MediaWiki\MediaWikiServices\getInstance(), Profiler\instance(), PROTO_INTERNAL, and wfExpandUrl().

Referenced by performRequest().

◆ performRequest()

MediaWiki::performRequest ( )

private

Performs the request.

bad titles
read restriction
local interwiki redirects
redirect loop
special pages
normal pages

Exceptions

MWException|PermissionsError|BadTitleError|HttpError

Returns: void

Definition at line 194 of file MediaWiki.php.

References $title, $wgTitle, MediaWiki\MediaWikiServices\getInstance(), SpecialPage\getTitleFor(), initializeArticle(), parseTitle(), performAction(), and tryNormaliseRedirect().

Referenced by main().

◆ preOutputCommit()

static MediaWiki::preOutputCommit	(	IContextSource	$context,
		callable	$postCommitWork = `null`
	)

static

This function commits all DB and session changes as needed before the client can receive a response (in case DB commit fails) and thus also before the response can trigger a subsequent related request by the client.

If there is a significant amount of content to flush, it can be done in $postCommitWork

Parameters

IContextSource	$context
callable \| null	$postCommitWork	[default: null]

Since: 1.27

Definition at line 668 of file MediaWiki.php.

References $config, $context, DeferredUpdates\doUpdates(), Config\get(), IContextSource\getConfig(), MediaWiki\MediaWikiServices\getInstance(), IContextSource\getOutput(), IContextSource\getRequest(), getUrlDomainDistance(), IContextSource\getUser(), MWExceptionHandler\logException(), wfDebug(), and wfDebugLog().

Referenced by doPreOutputCommit(), MediaWiki\Rest\EntryPoint\execute(), and ApiMain\executeActionWithErrorHandling().

◆ restInPeace()

MediaWiki::restInPeace ( )

Ends this task peacefully.

Definition at line 1117 of file MediaWiki.php.

References DeferredUpdates\doUpdates(), emitBufferedStatsdData(), MediaWiki\MediaWikiServices\getInstance(), Profiler\instance(), and wfDebug().

Referenced by doPostOutputShutdown().

◆ run()

MediaWiki::run ( )

Run the current MediaWiki instance; index.php just calls this.

Definition at line 556 of file MediaWiki.php.

References $action, $cache, $context, doPostOutputShutdown(), MWExceptionRenderer\getHTML(), IContextSource\getRequest(), IContextSource\getTitle(), MWExceptionHandler\handleException(), main(), HTMLFileCache\MODE_OUTAGE, setDBProfilingAgent(), and HTMLFileCache\useFileCache().

Referenced by MediaWiki\Rest\SimpleHandler\execute().

◆ schedulePostSendJobs()

MediaWiki::schedulePostSendJobs ( )

private

If enabled, after everything specific to this request is done, occasionally run jobs.

Definition at line 601 of file MediaWiki.php.

References DeferredUpdates\addUpdate(), MediaWiki\Logger\LoggerFactory\getInstance(), getTitle(), triggerAsyncJobs(), triggerSyncJobs(), and wfReadOnly().

Referenced by main().

◆ setDBProfilingAgent()

MediaWiki::setDBProfilingAgent ( )

private

Add a comment to future SQL queries for easy SHOW PROCESSLIST interpretation.

Definition at line 590 of file MediaWiki.php.

References MediaWiki\MediaWikiServices\getInstance().

Referenced by run().

◆ shouldDoHttpRedirect()

MediaWiki::shouldDoHttpRedirect ( )

private

Check if an HTTP->HTTPS redirect should be done.

It may still be aborted by a hook, so this is not the final word.

Returns: bool

Definition at line 961 of file MediaWiki.php.

References PROTO_HTTPS, and wfExpandUrl().

Referenced by maybeDoHttpsRedirect().

◆ triggerAsyncJobs()

MediaWiki::triggerAsyncJobs	(		$n,
		LoggerInterface	$runJobsLogger
	)

private

Parameters

int	$n	Number of jobs to try to run
LoggerInterface	$runJobsLogger

Returns: bool Success

Definition at line 1220 of file MediaWiki.php.

References MediaWiki\MediaWikiServices\getInstance(), SpecialRunJobs\getQuerySignature(), JobQueueGroup\TYPE_DEFAULT, and wfParseUrl().

Referenced by schedulePostSendJobs().

◆ triggerSyncJobs()

MediaWiki::triggerSyncJobs ( $n )

private

Parameters

int $n Number of jobs to try to run

Definition at line 1208 of file MediaWiki.php.

References MediaWiki\MediaWikiServices\getInstance(), and Profiler\instance().

Referenced by schedulePostSendJobs().

◆ tryNormaliseRedirect()

MediaWiki::tryNormaliseRedirect ( Title $title )

private

Handle redirects for uncanonical title requests.

Handles:

Redirect loops.
No title in URL.
$wgUsePathInfo URLs.
URLs with a variant.
Other non-standard URLs (as long as they have no extra query parameters).

Behaviour:

Normalise title values: /wiki/Foo%20Bar -> /wiki/Foo_Bar
Normalise empty title: /wiki/ -> /wiki/Main /w/index.php?title= -> /wiki/Main
Don't redirect anything with query parameters other than 'title' or 'action=view'.

Parameters

Title $title

Returns: bool True if a redirect was set.

Exceptions

HttpError

Definition at line 354 of file MediaWiki.php.

References $title, MediaWiki\MediaWikiServices\getInstance(), SpecialPage\getTitleFor(), PROTO_CURRENT, and wfExpandUrl().

Referenced by performRequest().

Member Data Documentation

◆ $action

string MediaWiki::$action

private

Cache what action this request is.

Definition at line 45 of file MediaWiki.php.

◆ $config

Config MediaWiki::$config

private

Definition at line 42 of file MediaWiki.php.

◆ $context

IContextSource MediaWiki::$context

private

Definition at line 40 of file MediaWiki.php.

◆ $postSendStrategy

int MediaWiki::$postSendStrategy

private

Class DEFER_* constant; how non-blocking post-response tasks should run.

Definition at line 47 of file MediaWiki.php.

◆ DEFER_CLI_MODE

const MediaWiki::DEFER_CLI_MODE = 3

private

Do not try to make post-send updates async (e.g.

for CLI mode)

Definition at line 54 of file MediaWiki.php.

Referenced by __construct().

◆ DEFER_FASTCGI_FINISH_REQUEST

const MediaWiki::DEFER_FASTCGI_FINISH_REQUEST = 1

private

Call fastcgi_finish_request() to make post-send updates async.

Definition at line 50 of file MediaWiki.php.

Referenced by __construct().

◆ DEFER_SET_LENGTH_AND_FLUSH

const MediaWiki::DEFER_SET_LENGTH_AND_FLUSH = 2

private

Set Content-Length and call ob_end_flush()/flush() to make post-send updates async.

Definition at line 52 of file MediaWiki.php.

Referenced by __construct().

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

includes/MediaWiki.php

Classes

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doPostOutputShutdown()

◆ doPreOutputCommit()

◆ emitBufferedStatsdData()

◆ getAction()

◆ getTitle()

◆ getUrlDomainDistance()

◆ initializeArticle()

◆ main()

◆ maybeDoHttpsRedirect()

◆ outputResponsePayload()

◆ parseTitle()

◆ performAction()

◆ performRequest()

◆ preOutputCommit()

◆ restInPeace()

◆ run()

◆ schedulePostSendJobs()

◆ setDBProfilingAgent()

◆ shouldDoHttpRedirect()

◆ triggerAsyncJobs()

◆ triggerSyncJobs()

◆ tryNormaliseRedirect()

Member Data Documentation

◆ $action

◆ $config

◆ $context

◆ $postSendStrategy

◆ DEFER_CLI_MODE

◆ DEFER_FASTCGI_FINISH_REQUEST

◆ DEFER_SET_LENGTH_AND_FLUSH