MediaWiki master
WebStart.php
Go to the documentation of this file.
1<?php
14use MediaWiki\Context\RequestContext;
15use MediaWiki\Deferred\DeferredUpdates;
16use MediaWiki\MediaWikiServices;
17use MediaWiki\Output\OutputHandler;
18use MediaWiki\Settings\SettingsBuilder;
19use Wikimedia\Http\HttpStatus;
20
21# T17461: Make IE8 turn off content sniffing. Everybody else should ignore this
22# We're adding it here so that it's *always* set, even for alternate entry
23# points and when $wgOut gets disabled or overridden.
24header( 'X-Content-Type-Options: nosniff' );
25
26# Valid web server entry point, enable includes.
27# Please don't move this line to includes/Defines.php. This line essentially
28# defines a valid entry point. If you put it in includes/Defines.php, then
29# any script that includes it becomes an entry point, thereby defeating
30# its purpose.
31define( 'MEDIAWIKI', true );
32
37function wfWebStartNoLocalSettings( SettingsBuilder $settings ): never {
38 # LocalSettings.php is the per-site customization file. If it does not exist
39 # the wiki installer needs to be launched or the generated file uploaded to
40 # the root wiki directory. Give a hint, if it is not readable by the server.
41 require_once __DIR__ . '/Output/NoLocalSettings.php';
42 die();
43}
44
45require_once __DIR__ . '/BootstrapHelperFunctions.php';
46
47// If no LocalSettings file exists, try to display an error page
48// (use a callback because it depends on TemplateParser)
49if ( !defined( 'MW_CONFIG_CALLBACK' ) ) {
50 wfDetectLocalSettingsFile();
51 if ( !is_readable( MW_CONFIG_FILE ) ) {
52 define( 'MW_CONFIG_CALLBACK', 'wfWebStartNoLocalSettings' );
53 }
54}
55
56function wfWebStartSetup( SettingsBuilder $settings ) {
57 // Initialize the default MediaWiki output buffering if no buffer is already active.
58 // This avoids clashes with existing buffers in order to avoid problems,
59 // like mixing gzip and non-gzip output.
60 if ( ob_get_level() == 0 ) {
61 // During HTTP requests, MediaWiki normally buffers the response body in a string
62 // within OutputPage and prints it when ready. PHP buffers provide protection against
63 // premature sending of HTTP headers due to output from PHP warnings and notices.
64 // They also can be used to implement gzip support in PHP without the webserver knowing
65 // which requests yield HTML and which yield large files that can be streamed.
66 ob_start( OutputHandler::handle( ... ) );
67 }
68}
69
70// Custom setup for WebStart entry point
71if ( !defined( 'MW_SETUP_CALLBACK' ) ) {
72 define( 'MW_SETUP_CALLBACK', 'wfWebStartSetup' );
73}
74
75require_once __DIR__ . '/Setup.php';
76
77// Optimization: Avoid overhead from DeferredUpdates and Pingback deps when turned off.
78//
79// NOTE: Do not refactor to inject Config or otherwise unconditionally call services.
80//
81// On a plain install of MediaWiki, Pingback is likely the *only* feature involving
82// DeferredUpdates or DB_PRIMARY on a regular page view. To allow for error recovery and fault
83// isolation, let admins turn this off completely. (T269516)
84if ( MW_ENTRY_POINT !== 'cli' && $wgPingback ) {
85 DeferredUpdates::addCallableUpdate( static function () {
86 MediaWikiServices::getInstance()->getPingback()->run();
87 } );
88}
89
90# Multiple DBs or commits might be used; keep the request as transactional as possible
91if ( isset( $_SERVER['REQUEST_METHOD'] ) && $_SERVER['REQUEST_METHOD'] === 'POST' ) {
92 ignore_user_abort( true );
93}
94
95if ( !defined( 'MW_API' ) && !defined( 'MW_REST_API' ) &&
96 RequestContext::getMain()->getRequest()->getHeader( 'Promise-Non-Write-API-Action' )
97) {
98 header( 'Cache-Control: no-cache' );
99 header( 'Content-Type: text/html; charset=utf-8' );
100 HttpStatus::header( 400 );
101 $errorHtml = wfMessage( 'nonwrite-api-promise-error' )
102 ->useDatabase( false )
103 ->inContentLanguage()
104 ->escaped();
105 $content = <<<HTML
106<!DOCTYPE html>
107<html>
108<head><meta charset="UTF-8" /><meta name="color-scheme" content="light dark" /></head>
109<body>
110$errorHtml
111</body>
112</html>
113
114HTML;
115 header( 'Content-Length: ' . strlen( $content ) );
116 echo $content;
117 die();
118}
wfDetectLocalSettingsFile
wfDetectLocalSettingsFile(?string $installationPath=null)
Decide and remember where to load LocalSettings from.
Definition BootstrapHelperFunctions.php:30
wfMessage
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
Definition GlobalFunctions.php:570
wfWebStartSetup
if(!defined('MW_CONFIG_CALLBACK')) wfWebStartSetup(SettingsBuilder $settings)
Definition WebStart.php:56
if
if(!defined('MW_SETUP_CALLBACK'))
Definition WebStart.php:71
wfWebStartNoLocalSettings
wfWebStartNoLocalSettings(SettingsBuilder $settings)
Definition WebStart.php:37
MW_ENTRY_POINT
const MW_ENTRY_POINT
Definition api.php:21
MediaWiki\Context\RequestContext
Group all the pieces relevant to the context of a request into one instance.
Definition RequestContext.php:50
MediaWiki\Deferred\DeferredUpdates
Defer callable updates to run later in the PHP process.
Definition DeferredUpdates.php:85
MediaWiki\MediaWikiServices
Service locator for MediaWiki core services.
Definition MediaWikiServices.php:272
MediaWiki\Settings\SettingsBuilder
Builder class for constructing a Config object from a set of sources during bootstrap.
Definition SettingsBuilder.php:55
$wgPingback
$wgPingback
Config variable stub for the Pingback setting, for use by phpdoc and IDEs.
Definition config-vars.php:4520