bf206185aa
This was only used in two PHP files in all of core. It is not needed (the block above the class keyword is naturally for that class) and only emits a warning from Doxygen: > PHPVersionCheck.php:35: warning: missing argument after \class. > SpecialPageData.php:28: warning: missing argument after \class. This is unlike JSDuck, where it is used to differentiate a function from a constructor/class. In Doxygen, `@class` is only used to create a virtual class within the docs that isn't explicitly in an indexed file, and thus requires a name. Bug: T232104 Change-Id: Ie504a8e2b72be8f370dc0c90da6a03f64d93df2d
342 lines
11 KiB
PHP
342 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
// phpcs:disable Generic.Arrays.DisallowLongArraySyntax,PSR2.Classes.PropertyDeclaration,MediaWiki.Usage.DirUsage
|
|
// phpcs:disable Squiz.Scope.MemberVarScope.Missing,Squiz.Scope.MethodScope.Missing
|
|
// @phan-file-suppress PhanPluginDuplicateConditionalNullCoalescing
|
|
/**
|
|
* Check PHP Version, as well as for composer dependencies in entry points,
|
|
* and display something vaguely comprehensible in the event of a totally
|
|
* unrecoverable error.
|
|
*
|
|
* @note Since we can't rely on anything external, the minimum PHP versions
|
|
* and MW current version are hardcoded in this class.
|
|
*
|
|
* @note This class uses setter methods instead of a constructor so that
|
|
* it can be compatible with PHP 4, PHP 5 and PHP 7 (without warnings).
|
|
*/
|
|
class PHPVersionCheck {
|
|
/* @var string The number of the MediaWiki version used. */
|
|
var $mwVersion = '1.34';
|
|
|
|
/* @var array A mapping of PHP functions to PHP extensions. */
|
|
var $functionsExtensionsMapping = array(
|
|
'mb_substr' => 'mbstring',
|
|
'xml_parser_create' => 'xml',
|
|
'ctype_digit' => 'ctype',
|
|
'json_decode' => 'json',
|
|
'iconv' => 'iconv',
|
|
'mime_content_type' => 'fileinfo',
|
|
);
|
|
|
|
/**
|
|
* @var string $format The format used for errors. One of "text" or "html"
|
|
*/
|
|
var $format = 'text';
|
|
|
|
/**
|
|
* @var string $scriptPath
|
|
*/
|
|
var $scriptPath = '/';
|
|
|
|
/**
|
|
* Set the format used for errors.
|
|
*
|
|
* @param string $format One of "text" or "html"
|
|
*/
|
|
function setFormat( $format ) {
|
|
$this->format = $format;
|
|
}
|
|
|
|
/**
|
|
* Set the script path used for images in HTML-formatted errors.
|
|
*
|
|
* @param string $scriptPath
|
|
*/
|
|
function setScriptPath( $scriptPath ) {
|
|
$this->scriptPath = $scriptPath;
|
|
}
|
|
|
|
/**
|
|
* Return the version of the installed PHP implementation.
|
|
*
|
|
* @param string $impl By default, the function returns the info of the currently installed PHP
|
|
* implementation. Using this parameter the caller can decide, what version info will be
|
|
* returned. Valid values: HHVM, PHP
|
|
* @return array An array of information about the PHP implementation, containing:
|
|
* - 'version': The version of the PHP implementation (specific to the implementation, not
|
|
* the version of the implemented PHP version)
|
|
* - 'implementation': The name of the implementation used
|
|
* - 'vendor': The development group, vendor or developer of the implementation.
|
|
* - 'upstreamSupported': The minimum version of the implementation supported by the named vendor.
|
|
* - 'minSupported': The minimum version supported by MediaWiki
|
|
* - 'upgradeURL': The URL to the website of the implementation that contains
|
|
* upgrade/installation instructions.
|
|
*/
|
|
function getPHPInfo( $impl = false ) {
|
|
if (
|
|
( defined( 'HHVM_VERSION' ) && $impl !== 'PHP' ) ||
|
|
$impl === 'HHVM'
|
|
) {
|
|
return array(
|
|
'implementation' => 'HHVM',
|
|
'version' => defined( 'HHVM_VERSION' ) ? HHVM_VERSION : 'undefined',
|
|
'vendor' => 'Facebook',
|
|
'upstreamSupported' => '3.18.5',
|
|
'minSupported' => '3.18.5',
|
|
'upgradeURL' => 'https://docs.hhvm.com/hhvm/installation/introduction',
|
|
);
|
|
}
|
|
return array(
|
|
'implementation' => 'PHP',
|
|
'version' => PHP_VERSION,
|
|
'vendor' => 'the PHP Group',
|
|
'upstreamSupported' => '5.6.0',
|
|
'minSupported' => '7.0.13',
|
|
'upgradeURL' => 'https://www.php.net/downloads.php',
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Displays an error, if the installed PHP version does not meet the minimum requirement.
|
|
*/
|
|
function checkRequiredPHPVersion() {
|
|
$phpInfo = $this->getPHPInfo();
|
|
$minimumVersion = $phpInfo['minSupported'];
|
|
$otherInfo = $this->getPHPInfo( $phpInfo['implementation'] === 'HHVM' ? 'PHP' : 'HHVM' );
|
|
if ( version_compare( $phpInfo['version'], $minimumVersion ) < 0 ) {
|
|
$shortText = "MediaWiki $this->mwVersion requires at least {$phpInfo['implementation']}"
|
|
. " version $minimumVersion or {$otherInfo['implementation']} version "
|
|
. "{$otherInfo['minSupported']}, you are using {$phpInfo['implementation']} "
|
|
. "{$phpInfo['version']}.";
|
|
|
|
$longText = "Error: You might be using an older {$phpInfo['implementation']} version "
|
|
. "({$phpInfo['implementation']} {$phpInfo['version']}). \n"
|
|
. "MediaWiki $this->mwVersion needs {$phpInfo['implementation']}"
|
|
. " $minimumVersion or higher or {$otherInfo['implementation']} version "
|
|
. "{$otherInfo['minSupported']}.\n\nCheck if you have a"
|
|
. " newer PHP executable with a different name.\n\n";
|
|
|
|
// phpcs:disable Generic.Files.LineLength
|
|
$longHtml = <<<HTML
|
|
Please consider <a href="{$phpInfo['upgradeURL']}">upgrading your copy of
|
|
{$phpInfo['implementation']}</a>.
|
|
{$phpInfo['implementation']} versions less than {$phpInfo['upstreamSupported']} are no
|
|
longer supported by {$phpInfo['vendor']} and will not receive
|
|
security or bugfix updates.
|
|
</p>
|
|
<p>
|
|
If for some reason you are unable to upgrade your {$phpInfo['implementation']} version,
|
|
you will need to <a href="https://www.mediawiki.org/wiki/Download">download</a> an
|
|
older version of MediaWiki from our website.
|
|
See our <a href="https://www.mediawiki.org/wiki/Compatibility#PHP">compatibility page</a>
|
|
for details of which versions are compatible with prior versions of {$phpInfo['implementation']}.
|
|
HTML;
|
|
// phpcs:enable Generic.Files.LineLength
|
|
$this->triggerError(
|
|
"Supported {$phpInfo['implementation']} versions",
|
|
$shortText,
|
|
$longText,
|
|
$longHtml
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Displays an error, if the vendor/autoload.php file could not be found.
|
|
*/
|
|
function checkVendorExistence() {
|
|
if ( !file_exists( dirname( __FILE__ ) . '/../vendor/autoload.php' ) ) {
|
|
$shortText = "Installing some external dependencies (e.g. via composer) is required.";
|
|
|
|
$longText = "Error: You are missing some external dependencies. \n"
|
|
. "MediaWiki now also has some external dependencies that need to be installed\n"
|
|
. "via composer or from a separate git repo. Please see\n"
|
|
. "https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries\n"
|
|
. "for help on installing the required components.";
|
|
|
|
// phpcs:disable Generic.Files.LineLength
|
|
$longHtml = <<<HTML
|
|
MediaWiki now also has some external dependencies that need to be installed via
|
|
composer or from a separate git repo. Please see
|
|
<a href="https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries">mediawiki.org</a>
|
|
for help on installing the required components.
|
|
HTML;
|
|
// phpcs:enable Generic.Files.LineLength
|
|
|
|
$this->triggerError( 'External dependencies', $shortText, $longText, $longHtml );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Displays an error, if a PHP extension does not exist.
|
|
*/
|
|
function checkExtensionExistence() {
|
|
$missingExtensions = array();
|
|
foreach ( $this->functionsExtensionsMapping as $function => $extension ) {
|
|
if ( !function_exists( $function ) ) {
|
|
$missingExtensions[] = $extension;
|
|
}
|
|
}
|
|
|
|
if ( $missingExtensions ) {
|
|
$shortText = "Installing some PHP extensions is required.";
|
|
|
|
$missingExtText = '';
|
|
$missingExtHtml = '';
|
|
$baseUrl = 'https://www.php.net';
|
|
foreach ( $missingExtensions as $ext ) {
|
|
$missingExtText .= " * $ext <$baseUrl/$ext>\n";
|
|
$missingExtHtml .= "<li><b>$ext</b> "
|
|
. "(<a href=\"$baseUrl/$ext\">more information</a>)</li>";
|
|
}
|
|
|
|
$cliText = "Error: Missing one or more required components of PHP.\n"
|
|
. "You are missing a required extension to PHP that MediaWiki needs.\n"
|
|
. "Please install:\n" . $missingExtText;
|
|
|
|
$longHtml = <<<HTML
|
|
You are missing a required extension to PHP that MediaWiki
|
|
requires to run. Please install:
|
|
<ul>
|
|
$missingExtHtml
|
|
</ul>
|
|
HTML;
|
|
|
|
$this->triggerError( 'Required components', $shortText, $cliText, $longHtml );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Output headers that prevents error pages to be cached.
|
|
*/
|
|
function outputHTMLHeader() {
|
|
$protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0';
|
|
|
|
header( "$protocol 500 MediaWiki configuration Error" );
|
|
// Don't cache error pages! They cause no end of trouble...
|
|
header( 'Cache-control: none' );
|
|
header( 'Pragma: no-cache' );
|
|
}
|
|
|
|
/**
|
|
* Returns an error page, which is suitable for output to the end user via a web browser.
|
|
*
|
|
* @param string $title
|
|
* @param string $longHtml
|
|
* @param string $shortText
|
|
* @return string
|
|
*/
|
|
function getIndexErrorOutput( $title, $longHtml, $shortText ) {
|
|
$encLogo =
|
|
htmlspecialchars( str_replace( '//', '/', $this->scriptPath . '/' ) .
|
|
'resources/assets/mediawiki.png' );
|
|
$shortHtml = htmlspecialchars( $shortText );
|
|
|
|
header( 'Content-type: text/html; charset=UTF-8' );
|
|
|
|
$finalOutput = <<<HTML
|
|
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<title>MediaWiki {$this->mwVersion}</title>
|
|
<style media='screen'>
|
|
body {
|
|
color: #000;
|
|
background-color: #fff;
|
|
font-family: sans-serif;
|
|
padding: 2em;
|
|
text-align: center;
|
|
}
|
|
p, img, h1, h2, ul {
|
|
text-align: left;
|
|
margin: 0.5em 0 1em;
|
|
}
|
|
h1 {
|
|
font-size: 120%;
|
|
}
|
|
h2 {
|
|
font-size: 110%;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<img src="{$encLogo}" alt='The MediaWiki logo' />
|
|
<h1>MediaWiki {$this->mwVersion} internal error</h1>
|
|
<div class='error'>
|
|
<p>
|
|
{$shortHtml}
|
|
</p>
|
|
<h2>{$title}</h2>
|
|
<p>
|
|
{$longHtml}
|
|
</p>
|
|
</div>
|
|
</body>
|
|
</html>
|
|
HTML;
|
|
|
|
return $finalOutput;
|
|
}
|
|
|
|
/**
|
|
* Display something vaguely comprehensible in the event of a totally unrecoverable error.
|
|
* Does not assume access to *anything*; no globals, no autoloader, no database, no localisation.
|
|
* Safe for PHP4 (and putting this here means that WebStart.php and GlobalSettings.php
|
|
* no longer need to be).
|
|
*
|
|
* Calling this function kills execution immediately.
|
|
*
|
|
* @param string $title HTML code to be put within an <h2> tag
|
|
* @param string $shortText
|
|
* @param string $longText
|
|
* @param string $longHtml
|
|
*/
|
|
function triggerError( $title, $shortText, $longText, $longHtml ) {
|
|
if ( $this->format === 'html' ) {
|
|
// Used by index.php and mw-config/index.php
|
|
$this->outputHTMLHeader();
|
|
$finalOutput = $this->getIndexErrorOutput( $title, $longHtml, $shortText );
|
|
} else {
|
|
// Used by Maintenance.php (CLI)
|
|
$finalOutput = $longText;
|
|
}
|
|
|
|
echo "$finalOutput\n";
|
|
die( 1 );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Check PHP version and that external dependencies are installed, and
|
|
* display an informative error if either condition is not satisfied.
|
|
*
|
|
* @param string $format One of "text" or "html"
|
|
* @param string $scriptPath Used when an error is formatted as HTML.
|
|
*/
|
|
function wfEntryPointCheck( $format = 'text', $scriptPath = '/' ) {
|
|
$phpVersionCheck = new PHPVersionCheck();
|
|
$phpVersionCheck->setFormat( $format );
|
|
$phpVersionCheck->setScriptPath( $scriptPath );
|
|
$phpVersionCheck->checkRequiredPHPVersion();
|
|
$phpVersionCheck->checkVendorExistence();
|
|
$phpVersionCheck->checkExtensionExistence();
|
|
}
|