From f468fb867ddc1cd983a5541181be265ba785c0f7 Mon Sep 17 00:00:00 2001
From: Florian Schmidt
Date: Tue, 13 Sep 2016 17:45:36 +0200
Subject: [PATCH] Rebuilt PHPVersionCheck to be an own class
The class keyword should work in all reasonable working php installations,
as far as I know. In this way, the php version check does not rely on a
set of global functions. It also should make maintaining the different
checks a bit easier.
Change-Id: I73ee098a8cf931ca4df6263c6e0a3e215555b612
---
autoload.php | 1 +
includes/PHPVersionCheck.php | 383 +++++++++++++++++++----------------
2 files changed, 213 insertions(+), 171 deletions(-)
diff --git a/autoload.php b/autoload.php
index 17e5df6597..e4f39d4b5c 100644
--- a/autoload.php
+++ b/autoload.php
@@ -1009,6 +1009,7 @@ $wgAutoloadLocalClasses = [
'OrphanStats' => __DIR__ . '/maintenance/storage/orphanStats.php',
'Orphans' => __DIR__ . '/maintenance/orphans.php',
'OutputPage' => __DIR__ . '/includes/OutputPage.php',
+ 'PHPVersionCheck' => __DIR__ . '/includes/PHPVersionCheck.php',
'PNGHandler' => __DIR__ . '/includes/media/PNG.php',
'PNGMetadataExtractor' => __DIR__ . '/includes/media/PNGMetadataExtractor.php',
'PPCustomFrame_DOM' => __DIR__ . '/includes/parser/Preprocessor_DOM.php',
diff --git a/includes/PHPVersionCheck.php b/includes/PHPVersionCheck.php
index 656ba43d4d..e6e96c7ede 100644
--- a/includes/PHPVersionCheck.php
+++ b/includes/PHPVersionCheck.php
@@ -1,4 +1,7 @@
'mbstring',
'utf8_encode' => 'xml',
'ctype_digit' => 'ctype',
'json_decode' => 'json',
'iconv' => 'iconv',
);
- // List of extensions we're missing
- $missingExtensions = array();
- // @codingStandardsIgnoreEnd
- foreach ( $extensions as $function => $extension ) {
- if ( !function_exists( $function ) ) {
- $missingExtensions[] = $extension;
+ /**
+ * @var string Which entry point we are protecting. One of:
+ * - index.php
+ * - load.php
+ * - api.php
+ * - mw-config/index.php
+ * - cli
+ */
+ var $entryPoint = null;
+
+ /**
+ * @param string $entryPoint Which entry point we are protecting. One of:
+ * - index.php
+ * - load.php
+ * - api.php
+ * - mw-config/index.php
+ * - cli
+ * @return $this
+ */
+ function setEntryPoint( $entryPoint ) {
+ $this->entryPoint = $entryPoint;
+ }
+
+ /**
+ * Returns the version of the installed php implementation.
+ *
+ * @return string
+ */
+ function getPHPImplVersion() {
+ return PHP_VERSION;
+ }
+
+ /**
+ * Displays an error, if the installed php version does not meet the minimum requirement.
+ *
+ * @return $this
+ */
+ function checkRequiredPHPVersion() {
+ if ( !function_exists( 'version_compare' )
+ || version_compare( $this->getPHPImplVersion(), $this->minimumVersionPHP ) < 0
+ ) {
+ $shortText = "MediaWiki $this->mwVersion requires at least PHP version"
+ . " $this->minimumVersionPHP, you are using PHP {$this->getPHPImplVersion()}.";
+
+ $longText = "Error: You might be using on older PHP version. \n"
+ . "MediaWiki $this->mwVersion needs PHP $this->minimumVersionPHP or higher.\n\n"
+ . "Check if you have a newer php executable with a different name, "
+ . "such as php5.\n\n";
+
+ $longHtml = <<upgrading your copy of PHP.
+ PHP versions less than 5.5.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;
+ $this->triggerError( 'Supported PHP versions', $shortText, $longText, $longHtml );
}
}
- if ( $missingExtensions ) {
- wfMissingExtensions( $entryPoint, $mwVersion, $missingExtensions );
+ /**
+ * Displays an error, if the vendor/autoload.php file could not be found.
+ *
+ * @return $this
+ */
+ 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.";
+
+ $longHtml = <<mediawiki.org
+ for help on installing the required components.
+HTML;
+
+ $this->triggerError( 'External dependencies', $shortText, $longText, $longHtml );
+ }
}
-}
-/**
- * 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 $type Which entry point we are protecting. One of:
- * - index.php
- * - load.php
- * - api.php
- * - mw-config/index.php
- * - cli
- * @param string $mwVersion The number of the MediaWiki version used
- * @param string $title HTML code to be put within an
tag
- * @param string $shortText
- * @param string $longText
- * @param string $longHtml
- */
-function wfGenericError( $type, $mwVersion, $title, $shortText, $longText, $longHtml ) {
- $protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0';
+ /**
+ * Displays an error, if a PHP extension does not exist.
+ *
+ * @return $this
+ */
+ 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://secure.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;
+
+ $longHtml = <<
+ $missingExtHtml
+
+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';
- if ( $type == 'cli' ) {
- $finalOutput = $longText;
- } else {
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' );
+ }
- if ( $type == 'index.php' || $type == 'mw-config/index.php' ) {
- $pathinfo = pathinfo( $_SERVER['SCRIPT_NAME'] );
- if ( $type == 'mw-config/index.php' ) {
- $dirname = dirname( $pathinfo['dirname'] );
- } else {
- $dirname = $pathinfo['dirname'];
- }
- $encLogo = htmlspecialchars(
- str_replace( '//', '/', $dirname . '/' ) .
- 'resources/assets/mediawiki.png'
- );
- $shortHtml = htmlspecialchars( $shortText );
+ /**
+ * Returns an error page, which is suitable for output to the end user via a web browser.
+ *
+ * @param $title
+ * @param $longHtml
+ * @param $shortText
+ * @return string
+ */
+ function getIndexErrorOutput( $title, $longHtml, $shortText ) {
+ $pathinfo = pathinfo( $_SERVER['SCRIPT_NAME'] );
+ if ( $this->entryPoint == 'mw-config/index.php' ) {
+ $dirname = dirname( $pathinfo['dirname'] );
+ } else {
+ $dirname = $pathinfo['dirname'];
+ }
+ $encLogo =
+ htmlspecialchars( str_replace( '//', '/', $dirname . '/' ) .
+ 'resources/assets/mediawiki.png' );
+ $shortHtml = htmlspecialchars( $shortText );
- header( 'Content-type: text/html; charset=UTF-8' );
+ header( 'Content-type: text/html; charset=UTF-8' );
- $finalOutput = <<
- MediaWiki {$mwVersion}
+ MediaWiki {$this->mwVersion}