MediaWiki  master
MediaWiki Class Reference

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...
 
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...
 
 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 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...
 
 outputResponsePayload ( $content)
 Set the actual output and attempt to flush it to the client if necessary. More...
 
 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...
 
 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...
 
 triggerAsyncJobs ( $n, LoggerInterface $runJobsLogger)
 
 triggerSyncJobs ( $n, LoggerInterface $runJobsLogger)
 
 tryNormaliseRedirect (Title $title)
 Handle redirects for uncanonical title requests. More...
 

Static Private Member Functions

static getChronProtStrategy (ILBFactory $lbFactory, OutputPage $output)
 
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...
 

Detailed Description

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

Definition at line 35 of file MediaWiki.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki::__construct ( IContextSource  $context = null)
Parameters
IContextSource | null$context

Definition at line 54 of file MediaWiki.php.

References $context, 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 813 of file MediaWiki.php.

References WebResponse\disableForPostSend(), Profiler\instance(), MWExceptionHandler\logException(), restInPeace(), and MWExceptionHandler\rollbackMasterChangesAndLog().

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

References preOutputCommit().

Referenced by main(), and run().

◆ emitBufferedStatsdData()

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

◆ getAction()

MediaWiki::getAction ( )

Returns the name of the action that will be executed.

Returns
string Action

Definition at line 155 of file MediaWiki.php.

References $action, and Action\getActionName().

Referenced by main(), and performAction().

◆ getChronProtStrategy()

static MediaWiki::getChronProtStrategy ( ILBFactory  $lbFactory,
OutputPage  $output 
)
staticprivate
Parameters
ILBFactory$lbFactory
OutputPage$output
Returns
array

Definition at line 761 of file MediaWiki.php.

References getUrlDomainDistance(), and Wikimedia\Rdbms\ILBFactory\hasOrMadeRecentMasterChanges().

Referenced by preOutputCommit().

◆ getTitle()

MediaWiki::getTitle ( )

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

Returns
Title

Definition at line 139 of file MediaWiki.php.

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

Referenced by main(), schedulePostSendJobs(), and triggerJobs().

◆ getUrlDomainDistance()

static MediaWiki::getUrlDomainDistance (   $url)
staticprivate
Parameters
string$url
Returns
string Either "local", "remote" if in the farm, "external" otherwise

Definition at line 792 of file MediaWiki.php.

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

Referenced by getChronProtStrategy().

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

References $action, $file, $title, WikiPage\factory(), ContentHandler\getForTitle(), Article\newFromWikiPage(), Hooks\run(), and wfWarn().

Referenced by performRequest().

◆ main()

MediaWiki::main ( )
private

◆ outputResponsePayload()

MediaWiki::outputResponsePayload (   $content)
private

Set the actual output and attempt to flush it to the client if necessary.

No PHP buffers should be active at this point

Parameters
string$content

Definition at line 997 of file MediaWiki.php.

References $content, $response, and DeferredUpdates\pendingUpdatesCount().

Referenced by main().

◆ parseTitle()

MediaWiki::parseTitle ( )
private

Parse the request to get the Title object.

Exceptions
MalformedTitleExceptionIf a title has been provided by the user, but is invalid.
Returns
Title Title object to be $wgTitle

Definition at line 70 of file MediaWiki.php.

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

Referenced by getTitle(), and performRequest().

◆ performAction()

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

Perform one of the "standard" actions.

Parameters
Page$page
Title$requestTitleThe original title, before any redirects were applied

Definition at line 479 of file MediaWiki.php.

References $action, $title, Action\factory(), getAction(), Title\getCdnUrls(), Profiler\instance(), PROTO_INTERNAL, Hooks\run(), 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 175 of file MediaWiki.php.

References $title, $wgTitle, MediaWiki\MediaWikiServices\getInstance(), SpecialPage\getTitleFor(), initializeArticle(), parseTitle(), performAction(), Hooks\run(), FauxRequest\setRequestURL(), 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 649 of file MediaWiki.php.

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

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

◆ restInPeace()

MediaWiki::restInPeace ( )

◆ run()

◆ schedulePostSendJobs()

MediaWiki::schedulePostSendJobs ( )
private

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

Definition at line 586 of file MediaWiki.php.

References DeferredUpdates\addCallableUpdate(), 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 575 of file MediaWiki.php.

References MediaWiki\MediaWikiServices\getInstance().

Referenced by run().

◆ triggerAsyncJobs()

MediaWiki::triggerAsyncJobs (   $n,
LoggerInterface  $runJobsLogger 
)
private
Parameters
int$nNumber of jobs to try to run
LoggerInterface$runJobsLogger
Returns
bool Success

Definition at line 1157 of file MediaWiki.php.

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

Referenced by schedulePostSendJobs(), and triggerJobs().

◆ triggerJobs()

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.

Deprecated:
Since 1.34

Definition at line 1099 of file MediaWiki.php.

References getTitle(), MWExceptionHandler\logException(), triggerAsyncJobs(), triggerSyncJobs(), and wfReadOnly().

◆ triggerSyncJobs()

MediaWiki::triggerSyncJobs (   $n,
LoggerInterface  $runJobsLogger 
)
private
Parameters
int$nNumber of jobs to try to run
LoggerInterface$runJobsLogger

Definition at line 1141 of file MediaWiki.php.

References Profiler\instance().

Referenced by schedulePostSendJobs(), and triggerJobs().

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

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

Referenced by performRequest().

Member Data Documentation

◆ $action

string MediaWiki::$action
private

Cache what action this request is.

Definition at line 42 of file MediaWiki.php.

Referenced by MediaWiki\Permissions\PermissionManager\checkActionPermissions(), MediaWiki\Permissions\PermissionManager\checkCascadingSourcesRestrictions(), MediaWiki\Permissions\PermissionManager\checkPageRestrictions(), MediaWiki\Permissions\PermissionManager\checkPermissionHooks(), MediaWiki\Permissions\PermissionManager\checkQuickPermissions(), MediaWiki\Permissions\PermissionManager\checkReadPermissions(), MediaWiki\Permissions\PermissionManager\checkSiteConfigPermissions(), MediaWiki\Permissions\PermissionManager\checkSpecialsAndNSPermissions(), MediaWiki\Permissions\PermissionManager\checkUserBlock(), MediaWiki\Permissions\PermissionManager\checkUserConfigPermissions(), MediaWiki\Auth\AuthManager\fillRequests(), getAction(), MediaWiki\Auth\TemporaryPasswordPrimaryAuthenticationProvider\getAuthenticationRequests(), MediaWiki\Auth\AbstractPasswordPrimaryAuthenticationProvider\getAuthenticationRequests(), MediaWiki\Auth\AuthManager\getAuthenticationRequests(), MediaWiki\Permissions\PermissionManager\getPermissionErrors(), MediaWiki\Permissions\PermissionManager\getPermissionErrorsInternal(), initializeArticle(), MediaWiki\Rest\BasicAccess\MWBasicRequestAuthorizer\isAllowed(), main(), MediaWiki\Permissions\PermissionManager\missingPermissionError(), parseTitle(), performAction(), MediaWiki\Block\AbstractBlock\prevents(), MediaWiki\Permissions\PermissionManager\quickUserCan(), run(), MediaWiki\Permissions\PermissionManager\userCan(), MediaWiki\Permissions\PermissionManager\userHasAllRights(), MediaWiki\Permissions\PermissionManager\userHasAnyRight(), MediaWiki\Permissions\PermissionManager\userHasRight(), and MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().

◆ $config

Config MediaWiki::$config
private

Definition at line 39 of file MediaWiki.php.

Referenced by MediaWiki\Widget\PendingTextInputWidget\__construct(), MediaWiki\Widget\UserInputWidget\__construct(), MediaWiki\Widget\NamespacesMultiselectWidget\__construct(), MediaWiki\Widget\TitlesMultiselectWidget\__construct(), MediaWiki\Widget\NamespaceInputWidget\__construct(), MediaWiki\Widget\DateTimeInputWidget\__construct(), MediaWiki\Widget\UsersMultiselectWidget\__construct(), MediaWiki\Widget\SearchInputWidget\__construct(), MediaWiki\Widget\TitleInputWidget\__construct(), MediaWiki\Widget\TagMultiselectWidget\__construct(), MediaWiki\Widget\CheckMatrixWidget\__construct(), MediaWiki\Widget\DateInputWidget\__construct(), MediaWiki\Auth\Throttler\__construct(), MediaWiki\Config\ConfigRepository\add(), MediaWiki\Block\AbstractBlock\appliesToRight(), MediaWiki\Block\AbstractBlock\appliesToUsertalk(), emitBufferedStatsdData(), MediaWiki\Widget\NamespacesMultiselectWidget\getConfig(), MediaWiki\Widget\UserInputWidget\getConfig(), MediaWiki\Widget\TitlesMultiselectWidget\getConfig(), MediaWiki\Widget\UsersMultiselectWidget\getConfig(), MediaWiki\Widget\DateTimeInputWidget\getConfig(), MediaWiki\Widget\ExpiryInputWidget\getConfig(), MediaWiki\Widget\NamespaceInputWidget\getConfig(), MediaWiki\Widget\TagMultiselectWidget\getConfig(), MediaWiki\Widget\TitleInputWidget\getConfig(), MediaWiki\Widget\SearchInputWidget\getConfig(), MediaWiki\Widget\DateInputWidget\getConfig(), MediaWiki\Widget\CheckMatrixWidget\getConfig(), MediaWiki\Config\ConfigRepository\getDescriptionOf(), MediaWiki\Auth\UserDataAuthenticationRequest\getFieldInfo(), MediaWiki\Widget\DateInputWidget\getInputElement(), MediaWiki\Widget\NamespaceInputWidget\getNamespaceDropdownOptions(), MediaWiki\Config\ConfigRepository\getValueOf(), MediaWiki\Auth\TemporaryPasswordAuthenticationRequest\newRandom(), preOutputCommit(), MediaWiki\Block\AbstractBlock\prevents(), and MediaWiki\Block\DatabaseBlock\shouldTrackWithCookie().

◆ $context

IContextSource MediaWiki::$context
private

Definition at line 37 of file MediaWiki.php.

Referenced by __construct(), MediaWiki\Shell\Command\__destruct(), MediaWiki\Special\SpecialPageFactory\capturePath(), MediaWiki\Storage\PageEditStash\checkCache(), MediaWiki\Permissions\PermissionManager\checkUserBlock(), MediaWiki\Logger\LogCapturingSpi\createLogger(), MediaWiki\Preferences\DefaultPreferencesFactory\datetimePreferences(), MediaWiki\Logger\LegacyLogger\destination(), MediaWiki\Special\SpecialPageFactory\executePath(), MediaWiki\Logger\Monolog\LogstashFormatter\fixKeyConflicts(), MediaWiki\Logger\LegacyLogger\format(), MediaWiki\Logger\LegacyLogger\formatAsWfDebug(), MediaWiki\Logger\Monolog\LogstashFormatter\formatV0(), MediaWiki\Logger\Monolog\LogstashFormatter\formatV1(), MediaWiki\Preferences\DefaultPreferencesFactory\generateSkinOptions(), MediaWiki\Block\AbstractBlock\getBlockErrorParams(), MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions(), MediaWiki\Preferences\DefaultPreferencesFactory\getForm(), MediaWiki\Preferences\DefaultPreferencesFactory\getFormDescriptor(), MediaWiki\Block\AbstractBlock\getPermissionsError(), MediaWiki\Preferences\DefaultPreferencesFactory\getTimezoneOptions(), MediaWiki\Logger\LegacyLogger\interpolate(), MediaWiki\Preferences\DefaultPreferencesFactory\loadPreferenceValues(), MediaWiki\Logger\ConsoleLogger\log(), MediaWiki\Logger\LegacyLogger\log(), MediaWiki\Auth\Throttler\logRejection(), Revision\RenderedRevision\outputVariesOnRevisionMetaData(), MediaWiki\Storage\PageEditStash\parseAndCache(), preOutputCommit(), MediaWiki\Preferences\DefaultPreferencesFactory\profilePreferences(), run(), MediaWiki\Logger\LegacyLogger\shouldEmit(), MediaWiki\Preferences\DefaultPreferencesFactory\skinPreferences(), MediaWiki\Preferences\DefaultPreferencesFactory\submitForm(), MediaWiki\Logger\Monolog\KafkaHandler\warning(), and MediaWiki\Preferences\DefaultPreferencesFactory\watchlistPreferences().

◆ $postSendStrategy

int MediaWiki::$postSendStrategy
private

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

Definition at line 44 of file MediaWiki.php.


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