3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 // phpcs:disable Generic.Arrays.DisallowLongArraySyntax,PSR2.Classes.PropertyDeclaration,MediaWiki.Usage.DirUsage
22 // phpcs:disable Squiz.Scope.MemberVarScope.Missing,Squiz.Scope.MethodScope.Missing
24 * Check PHP Version, as well as for composer dependencies in entry points,
25 * and display something vaguely comprehensible in the event of a totally
26 * unrecoverable error.
29 class PHPVersionCheck
{
30 /* @var string The number of the MediaWiki version used. */
31 var $mwVersion = '1.33';
33 /* @var array A mapping of PHP functions to PHP extensions. */
34 var $functionsExtensionsMapping = array(
35 'mb_substr' => 'mbstring',
36 'xml_parser_create' => 'xml',
37 'ctype_digit' => 'ctype',
38 'json_decode' => 'json',
40 'mime_content_type' => 'fileinfo',
44 * @var string Which entry point we are protecting. One of:
48 * - mw-config/index.php
51 var $entryPoint = null;
54 * @param string $entryPoint Which entry point we are protecting. One of:
58 * - mw-config/index.php
61 function setEntryPoint( $entryPoint ) {
62 $this->entryPoint
= $entryPoint;
66 * Returns the version of the installed PHP implementation.
68 * @param string $impl By default, the function returns the info of the currently installed PHP
69 * implementation. Using this parameter the caller can decide, what version info will be
70 * returned. Valid values: HHVM, PHP
71 * @return array An array of information about the PHP implementation, containing:
72 * - 'version': The version of the PHP implementation (specific to the implementation, not
73 * the version of the implemented PHP version)
74 * - 'implementation': The name of the implementation used
75 * - 'vendor': The development group, vendor or developer of the implementation.
76 * - 'upstreamSupported': The minimum version of the implementation supported by the named vendor.
77 * - 'minSupported': The minimum version supported by MediaWiki
78 * - 'upgradeURL': The URL to the website of the implementation that contains
79 * upgrade/installation instructions.
81 function getPHPInfo( $impl = false ) {
83 ( defined( 'HHVM_VERSION' ) && $impl !== 'PHP' ) ||
87 'implementation' => 'HHVM',
88 'version' => defined( 'HHVM_VERSION' ) ? HHVM_VERSION
: 'undefined',
89 'vendor' => 'Facebook',
90 'upstreamSupported' => '3.18.5',
91 'minSupported' => '3.18.5',
92 'upgradeURL' => 'https://docs.hhvm.com/hhvm/installation/introduction',
96 'implementation' => 'PHP',
97 'version' => PHP_VERSION
,
98 'vendor' => 'the PHP Group',
99 'upstreamSupported' => '5.6.0',
100 'minSupported' => '7.0.0',
101 'upgradeURL' => 'https://secure.php.net/downloads.php',
106 * Displays an error, if the installed PHP version does not meet the minimum requirement.
108 function checkRequiredPHPVersion() {
109 $phpInfo = $this->getPHPInfo();
110 $minimumVersion = $phpInfo['minSupported'];
111 $otherInfo = $this->getPHPInfo( $phpInfo['implementation'] === 'HHVM' ?
'PHP' : 'HHVM' );
113 !function_exists( 'version_compare' )
114 ||
version_compare( $phpInfo['version'], $minimumVersion ) < 0
116 $shortText = "MediaWiki $this->mwVersion requires at least {$phpInfo['implementation']}"
117 . " version $minimumVersion or {$otherInfo['implementation']} version "
118 . "{$otherInfo['minSupported']}, you are using {$phpInfo['implementation']} "
119 . "{$phpInfo['version']}.";
121 $longText = "Error: You might be using an older {$phpInfo['implementation']} version "
122 . "({$phpInfo['implementation']} {$phpInfo['version']}). \n"
123 . "MediaWiki $this->mwVersion needs {$phpInfo['implementation']}"
124 . " $minimumVersion or higher or {$otherInfo['implementation']} version "
125 . "{$otherInfo['minSupported']}.\n\nCheck if you have a"
126 . " newer PHP executable with a different name.\n\n";
128 // phpcs:disable Generic.Files.LineLength
130 Please consider <a href="{$phpInfo['upgradeURL']}">upgrading your copy of
131 {$phpInfo['implementation']}</a>.
132 {$phpInfo['implementation']} versions less than {$phpInfo['upstreamSupported']} are no
133 longer supported by {$phpInfo['vendor']} and will not receive
134 security or bugfix updates.
137 If for some reason you are unable to upgrade your {$phpInfo['implementation']} version,
138 you will need to <a href="https://www.mediawiki.org/wiki/Download">download</a> an
139 older version of MediaWiki from our website.
140 See our <a href="https://www.mediawiki.org/wiki/Compatibility#PHP">compatibility page</a>
141 for details of which versions are compatible with prior versions of {$phpInfo['implementation']}.
143 // phpcs:enable Generic.Files.LineLength
145 "Supported {$phpInfo['implementation']} versions",
154 * Displays an error, if the vendor/autoload.php file could not be found.
156 function checkVendorExistence() {
157 if ( !file_exists( dirname( __FILE__
) . '/../vendor/autoload.php' ) ) {
158 $shortText = "Installing some external dependencies (e.g. via composer) is required.";
160 $longText = "Error: You are missing some external dependencies. \n"
161 . "MediaWiki now also has some external dependencies that need to be installed\n"
162 . "via composer or from a separate git repo. Please see\n"
163 . "https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries\n"
164 . "for help on installing the required components.";
166 // phpcs:disable Generic.Files.LineLength
168 MediaWiki now also has some external dependencies that need to be installed via
169 composer or from a separate git repo. Please see
170 <a href="https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries">mediawiki.org</a>
171 for help on installing the required components.
173 // phpcs:enable Generic.Files.LineLength
175 $this->triggerError( 'External dependencies', $shortText, $longText, $longHtml );
180 * Displays an error, if a PHP extension does not exist.
182 function checkExtensionExistence() {
183 $missingExtensions = array();
184 foreach ( $this->functionsExtensionsMapping
as $function => $extension ) {
185 if ( !function_exists( $function ) ) {
186 $missingExtensions[] = $extension;
190 if ( $missingExtensions ) {
191 $shortText = "Installing some PHP extensions is required.";
193 $missingExtText = '';
194 $missingExtHtml = '';
195 $baseUrl = 'https://secure.php.net';
196 foreach ( $missingExtensions as $ext ) {
197 $missingExtText .= " * $ext <$baseUrl/$ext>\n";
198 $missingExtHtml .= "<li><b>$ext</b> "
199 . "(<a href=\"$baseUrl/$ext\">more information</a>)</li>";
202 $cliText = "Error: Missing one or more required components of PHP.\n"
203 . "You are missing a required extension to PHP that MediaWiki needs.\n"
204 . "Please install:\n" . $missingExtText;
207 You are missing a required extension to PHP that MediaWiki
208 requires to run. Please install:
214 $this->triggerError( 'Required components', $shortText, $cliText, $longHtml );
219 * Output headers that prevents error pages to be cached.
221 function outputHTMLHeader() {
222 $protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ?
$_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0';
224 header( "$protocol 500 MediaWiki configuration Error" );
225 // Don't cache error pages! They cause no end of trouble...
226 header( 'Cache-control: none' );
227 header( 'Pragma: no-cache' );
231 * Returns an error page, which is suitable for output to the end user via a web browser.
233 * @param string $title
234 * @param string $longHtml
235 * @param string $shortText
238 function getIndexErrorOutput( $title, $longHtml, $shortText ) {
239 $pathinfo = pathinfo( $_SERVER['SCRIPT_NAME'] );
240 if ( $this->entryPoint
== 'mw-config/index.php' ) {
241 $dirname = dirname( $pathinfo['dirname'] );
243 $dirname = $pathinfo['dirname'];
246 htmlspecialchars( str_replace( '//', '/', $dirname . '/' ) .
247 'resources/assets/mediawiki.png' );
248 $shortHtml = htmlspecialchars( $shortText );
250 header( 'Content-type: text/html; charset=UTF-8' );
252 $finalOutput = <<<HTML
254 <html lang="en" dir="ltr">
256 <meta charset="UTF-8" />
257 <title>MediaWiki {$this->mwVersion}</title>
258 <style media='screen'>
261 background-color: #fff;
262 font-family: sans-serif;
279 <img src="{$encLogo}" alt='The MediaWiki logo' />
280 <h1>MediaWiki {$this->mwVersion} internal error</h1>
298 * Display something vaguely comprehensible in the event of a totally unrecoverable error.
299 * Does not assume access to *anything*; no globals, no autoloader, no database, no localisation.
300 * Safe for PHP4 (and putting this here means that WebStart.php and GlobalSettings.php
301 * no longer need to be).
303 * Calling this function kills execution immediately.
305 * @param string $title HTML code to be put within an <h2> tag
306 * @param string $shortText
307 * @param string $longText
308 * @param string $longHtml
310 function triggerError( $title, $shortText, $longText, $longHtml ) {
311 switch ( $this->entryPoint
) {
313 $finalOutput = $longText;
316 case 'mw-config/index.php':
317 $this->outputHTMLHeader();
318 $finalOutput = $this->getIndexErrorOutput( $title, $longHtml, $shortText );
321 $this->outputHTMLHeader();
322 $finalOutput = "/* $shortText */";
325 $this->outputHTMLHeader();
326 // Handle everything that's not index.php
327 $finalOutput = $shortText;
330 echo "$finalOutput\n";
336 * Check PHP version and that external dependencies are installed, and
337 * display an informative error if either condition is not satisfied.
339 * @note Since we can't rely on anything, the minimum PHP versions and MW current
340 * version are hardcoded here.
342 function wfEntryPointCheck( $entryPoint ) {
343 $phpVersionCheck = new PHPVersionCheck();
344 $phpVersionCheck->setEntryPoint( $entryPoint );
345 $phpVersionCheck->checkRequiredPHPVersion();
346 $phpVersionCheck->checkVendorExistence();
347 $phpVersionCheck->checkExtensionExistence();