MediaWiki master
WebStart.php
Go to the documentation of this file.
1<?php
28use MediaWiki\Context\RequestContext;
29use MediaWiki\Settings\SettingsBuilder;
30use Wikimedia\Http\HttpStatus;
31
32# T17461: Make IE8 turn off content sniffing. Everybody else should ignore this
33# We're adding it here so that it's *always* set, even for alternate entry
34# points and when $wgOut gets disabled or overridden.
35header( 'X-Content-Type-Options: nosniff' );
36
37# Valid web server entry point, enable includes.
38# Please don't move this line to includes/Defines.php. This line essentially
39# defines a valid entry point. If you put it in includes/Defines.php, then
40# any script that includes it becomes an entry point, thereby defeating
41# its purpose.
42define( 'MEDIAWIKI', true );
43
48function wfWebStartNoLocalSettings( SettingsBuilder $settings ): never {
49 # LocalSettings.php is the per-site customization file. If it does not exist
50 # the wiki installer needs to be launched or the generated file uploaded to
51 # the root wiki directory. Give a hint, if it is not readable by the server.
52 require_once __DIR__ . '/Output/NoLocalSettings.php';
53 die();
54}
55
56require_once __DIR__ . '/BootstrapHelperFunctions.php';
57
58// If no LocalSettings file exists, try to display an error page
59// (use a callback because it depends on TemplateParser)
60if ( !defined( 'MW_CONFIG_CALLBACK' ) ) {
61 wfDetectLocalSettingsFile();
62 if ( !is_readable( MW_CONFIG_FILE ) ) {
63 define( 'MW_CONFIG_CALLBACK', 'wfWebStartNoLocalSettings' );
64 }
65}
66
67function wfWebStartSetup( SettingsBuilder $settings ) {
68 // Initialize the default MediaWiki output buffering if no buffer is already active.
69 // This avoids clashes with existing buffers in order to avoid problems,
70 // like mixing gzip and non-gzip output.
71 if ( ob_get_level() == 0 ) {
72 // During HTTP requests, MediaWiki normally buffers the response body in a string
73 // within OutputPage and prints it when ready. PHP buffers provide protection against
74 // premature sending of HTTP headers due to output from PHP warnings and notices.
75 // They also can be used to implement gzip support in PHP without the webserver knowing
76 // which requests yield HTML and which yield large files that can be streamed.
77 ob_start( [ MediaWiki\Output\OutputHandler::class, 'handle' ] );
78 }
79}
80
81// Custom setup for WebStart entry point
82if ( !defined( 'MW_SETUP_CALLBACK' ) ) {
83 define( 'MW_SETUP_CALLBACK', 'wfWebStartSetup' );
84}
85
86require_once __DIR__ . '/Setup.php';
87
88# Multiple DBs or commits might be used; keep the request as transactional as possible
89if ( isset( $_SERVER['REQUEST_METHOD'] ) && $_SERVER['REQUEST_METHOD'] === 'POST' ) {
90 ignore_user_abort( true );
91}
92
93if ( !defined( 'MW_API' ) && !defined( 'MW_REST_API' ) &&
94 RequestContext::getMain()->getRequest()->getHeader( 'Promise-Non-Write-API-Action' )
95) {
96 header( 'Cache-Control: no-cache' );
97 header( 'Content-Type: text/html; charset=utf-8' );
98 HttpStatus::header( 400 );
99 $errorHtml = wfMessage( 'nonwrite-api-promise-error' )
100 ->useDatabase( false )
101 ->inContentLanguage()
102 ->escaped();
103 $content = <<<HTML
104<!DOCTYPE html>
105<html>
106<head><meta charset="UTF-8" /><meta name="color-scheme" content="light dark" /></head>
107<body>
108$errorHtml
109</body>
110</html>
111
112HTML;
113 header( 'Content-Length: ' . strlen( $content ) );
114 echo $content;
115 die();
116}
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:859
wfWebStartSetup
if(!defined('MW_CONFIG_CALLBACK')) wfWebStartSetup(SettingsBuilder $settings)
Definition WebStart.php:67
if
if(!defined('MW_SETUP_CALLBACK'))
Definition WebStart.php:82
wfWebStartNoLocalSettings
wfWebStartNoLocalSettings(SettingsBuilder $settings)
Definition WebStart.php:48
MediaWiki\Context\RequestContext
Group all the pieces relevant to the context of a request into one instance.
Definition RequestContext.php:68
MediaWiki\Settings\SettingsBuilder
Builder class for constructing a Config object from a set of sources during bootstrap.
Definition SettingsBuilder.php:55
MediaWiki
A helper class for throttling authentication attempts.