'mbstring',
'xml_parser_create' => 'xml',
'ctype_digit' => 'ctype',
'json_decode' => 'json',
'iconv' => 'iconv',
'mime_content_type' => 'fileinfo',
);
/**
* @var string 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;
}
/**
* Displays an error, if the installed PHP version does not meet the minimum requirement.
*/
function checkRequiredPHPVersion() {
$minimumVersion = '7.3.19';
if ( version_compare( PHP_VERSION, $minimumVersion ) < 0 ) {
$cliText = "Error: You might be using an older PHP version (PHP " . PHP_VERSION . ").\n"
. "MediaWiki $this->mwVersion needs PHP $minimumVersion or higher.\n\nCheck if you "
. "have a newer PHP executable with a different name.\n\n";
$web = array();
$web['intro'] = "MediaWiki $this->mwVersion requires at least PHP version $minimumVersion; "
. "you are using PHP " . PHP_VERSION . ".";
$web['longTitle'] = "Supported PHP versions";
// phpcs:disable Generic.Files.LineLength
$web['longHtml'] = <<
Please consider upgrading your copy of PHP.
PHP versions less than v7.2.0 are no longer supported by the PHP Group and will not receive
security or bugfix updates.
If for some reason you are unable to upgrade your PHP version, you will need to
download an older version of
MediaWiki from our website. See our
compatibility page
for details of which versions are compatible with prior versions of PHP.
HTML;
// phpcs:enable Generic.Files.LineLength
$this->triggerError(
$web,
$cliText
);
}
}
/**
* Displays an error, if the vendor/autoload.php file could not be found.
*/
function checkVendorExistence() {
if ( !file_exists( dirname( __FILE__ ) . '/../vendor/autoload.php' ) ) {
$cliText = "Error: You are missing some external dependencies. \n"
. "MediaWiki 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.";
$web = array();
$web['intro'] = "Installing some external dependencies (e.g. via composer) is required.";
$web['longTitle'] = 'External dependencies';
// phpcs:disable Generic.Files.LineLength
$web['longHtml'] = <<
MediaWiki also has some external dependencies that need to be installed via
composer or from a separate git repo. Please see
mediawiki.org
for help on installing the required components.
HTML;
// phpcs:enable Generic.Files.LineLength
$this->triggerError( $web, $cliText );
}
}
/**
* 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 ) {
$missingExtText = '';
$missingExtHtml = '';
$baseUrl = 'https://www.php.net';
foreach ( $missingExtensions as $ext ) {
$missingExtText .= " * $ext <$baseUrl/$ext>\n";
$missingExtHtml .= "$ext "
. "(more information)";
}
$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;
$web = array();
$web['intro'] = "Installing some PHP extensions is required.";
$web['longTitle'] = 'Required components';
$web['longHtml'] = <<
You are missing a required extension to PHP that MediaWiki
requires to run. Please install:
HTML;
$this->triggerError( $web, $cliText );
}
}
/**
* 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 $introText
* @param string $longTitle
* @param string $longHtml
* @return string
*/
function getIndexErrorOutput( $introText, $longTitle, $longHtml ) {
$encLogo =
htmlspecialchars( str_replace( '//', '/', $this->scriptPath . '/' ) .
'resources/assets/mediawiki.png' );
$introHtml = htmlspecialchars( $introText );
$longTitleHtml = htmlspecialchars( $longTitle );
header( 'Content-type: text/html; charset=UTF-8' );
$finalOutput = <<
MediaWiki {$this->mwVersion}
MediaWiki {$this->mwVersion} internal error
{$introHtml}
{$longTitleHtml}
{$longHtml}
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).
*
* This function immediately terminates the PHP process.
*
* @param string[] $web
* - (string) intro: Short error message, displayed on top.
* - (string) longTitle: Title for the longer message.
* - (string) longHtml: The longer message, as raw HTML.
* @param string $cliText
*/
function triggerError( $web, $cliText ) {
if ( $this->format === 'html' ) {
// Used by index.php and mw-config/index.php
$this->outputHTMLHeader();
$finalOutput = $this->getIndexErrorOutput(
$web['intro'],
$web['longTitle'],
$web['longHtml']
);
} else {
// Used by Maintenance.php (CLI)
$finalOutput = $cliText;
}
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();
}