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

Collaboration diagram for MediaWiki:

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

Public Member Functions
	__construct (IContextSource $context=null)

	doPostOutputShutdown ($mode= 'normal')
	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 ($mode= 'fast')
	Ends this task peacefully. More...

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

	triggerJobs ()
	Potentially open a socket and sent an HTTP request back to the server to run a specified number of jobs. More...

Static Public Member Functions
static	preOutputCommit (IContextSource $context, callable $postCommitWork=null)
	This function commits all DB changes as needed before the user can receive a response (in case commit fails) 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 ()

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

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

	performRequest ()
	Performs the request. More...

	setDBProfilingAgent ()

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

Static Private Member Functions
static	getUrlDomainDistance ($url, IContextSource $context)

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

Config	$config

IContextSource	$context

Detailed Description

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

Definition at line 29 of file MediaWiki.php.

Constructor & Destructor Documentation

MediaWiki::__construct ( IContextSource $context = null )

Parameters

IContextSource | null $context

Definition at line 48 of file MediaWiki.php.

References $context, IContextSource\getConfig(), and RequestContext\getMain().

Member Function Documentation

MediaWiki::doPostOutputShutdown ( $mode = 'normal' )

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

Parameters

string $mode Use 'fast' to always skip job running

Since: 1.26

Definition at line 711 of file MediaWiki.php.

References $e, MWExceptionHandler\handleException(), Profiler\instance(), restInPeace(), and use.

Referenced by run().

MediaWiki::doPreOutputCommit ( callable $postCommitWork = null )

See also: MediaWiki::preOutputCommit()

Parameters

callable $postCommitWork [default: null]

Since: 1.26

Definition at line 560 of file MediaWiki.php.

Referenced by main(), and run().

MediaWiki::getAction ( )

Returns the name of the action that will be executed.

Returns: string Action

Definition at line 149 of file MediaWiki.php.

References $action, and Action\getActionName().

Referenced by main(), and performAction().

MediaWiki::getTitle ( )

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

Returns: Title

Definition at line 133 of file MediaWiki.php.

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

Referenced by main(), and triggerJobs().

static MediaWiki::getUrlDomainDistance	(		$url,
		IContextSource	$context
	)

staticprivate

Parameters

string	$url
IContextSource	$context

Returns: string|bool Either "local" or "remote" if in the farm, false otherwise

Definition at line 671 of file MediaWiki.php.

References as, IContextSource\getConfig(), true, and wfParseUrl().

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 377 of file MediaWiki.php.

References $article, $page, $request, $title, WikiPage\factory(), ContentHandler\getForTitle(), ContextSource\getRequest(), Article\newFromWikiPage(), Hooks\run(), and wfWarn().

Referenced by performRequest().

MediaWiki::main ( )

private

Definition at line 743 of file MediaWiki.php.

References $buffer, $cache, $output, $request, $timestamp, $title, $wgTitle, doPreOutputCommit(), getAction(), ContextSource\getRequest(), getTitle(), global, Profiler\instance(), Title\makeTitle(), Title\newFromText(), NS_MAIN, NS_SPECIAL, performRequest(), print, PROTO_HTTPS, Hooks\run(), use, HTMLFileCache\useFileCache(), wfDebugLog(), and wfExpandUrl().

Referenced by run().

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 63 of file MediaWiki.php.

References $request, $ret, $rev, $title, $wgContLang, ContextSource\getRequest(), SpecialPage\getTitleFor(), global, Title\makeTitle(), Revision\newFromId(), Title\newFromID(), Title\newFromTextThrow(), Title\newFromURL(), Title\newMainPage(), NS_FILE, and NS_MEDIA.

Referenced by getTitle(), and performRequest().

MediaWiki::performAction	(	Page	$page,
		Title	$requestTitle
	)

private

Perform one of the "standard" actions.

Parameters

Page	$page
Title	$requestTitle	The original title, before any redirects were applied

Definition at line 460 of file MediaWiki.php.

References $output, $page, $request, $title, $user, Action\factory(), getAction(), Title\getCdnUrls(), ContextSource\getRequest(), Profiler\instance(), PROTO_INTERNAL, Hooks\run(), and wfExpandUrl().

Referenced by 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 169 of file MediaWiki.php.

References $article, $output, $query, $request, $title, $user, $wgTitle, ParserOutput\addJsConfigVars(), ParserOutput\addModules(), SpecialPageFactory\executePath(), ContextSource\getOutput(), SpecialPageFactory\getPage(), ContextSource\getRequest(), SpecialPage\getTitleFor(), global, initializeArticle(), list, NS_SPECIAL, parseTitle(), performAction(), SpecialPageFactory\resolveAlias(), Hooks\run(), and tryNormaliseRedirect().

Referenced by main().

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

static

This function commits all DB changes as needed before the user can receive a response (in case commit fails)

Parameters

IContextSource	$context
callable	$postCommitWork	[default: null]

Since: 1.27

Definition at line 572 of file MediaWiki.php.

References $context, $flags, $lbFactory, $options, $output, $request, DeferredUpdates\doUpdates(), Config\get(), IContextSource\getConfig(), MediaWiki\MediaWikiServices\getInstance(), IContextSource\getOutput(), IContextSource\getRequest(), DeferredUpdates\PRESEND, MessageCache\singleton(), wfDebug(), and wfDebugLog().

Referenced by ApiMain\executeActionWithErrorHandling().

MediaWiki::restInPeace ( $mode = 'fast' )

Ends this task peacefully.

Parameters

string $mode Use 'fast' to always skip job running

Definition at line 877 of file MediaWiki.php.

References $lbFactory, DeferredUpdates\addCallableUpdate(), class, DeferredUpdates\doUpdates(), MediaWiki\MediaWikiServices\getInstance(), Profiler\instance(), ILBFactory\SHUTDOWN_NO_CHRONPROT, triggerJobs(), wfDebug(), and wfLogProfilingData().

Referenced by doPostOutputShutdown().

MediaWiki::run ( )

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

Definition at line 508 of file MediaWiki.php.

References $cache, $context, $e, doPostOutputShutdown(), doPreOutputCommit(), MWExceptionRenderer\getHTML(), IContextSource\getRequest(), IContextSource\getTitle(), MWExceptionHandler\handleException(), main(), HTMLFileCache\MODE_OUTAGE, print, ErrorPageError\report(), setDBProfilingAgent(), and HTMLFileCache\useFileCache().

MediaWiki::setDBProfilingAgent ( )

private

Definition at line 546 of file MediaWiki.php.

References $name, $services, and MediaWiki\MediaWikiServices\getInstance().

Referenced by run().

MediaWiki::triggerJobs ( )

Potentially open a socket and sent an HTTP request back to the server to run a specified number of jobs.

This registers a callback to cleanup the socket once it's done.

Definition at line 917 of file MediaWiki.php.

References $e, $query, $req, $special, $status, SpecialPageFactory\getPage(), SpecialRunJobs\getQuerySignature(), getTitle(), MWExceptionHandler\logException(), JobQueueGroup\singleton(), JobQueueGroup\TYPE_DEFAULT, wfParseUrl(), and wfReadOnly().

Referenced by restInPeace().

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