Check for dependencies in entry point and Maintenance.php

This way, if someone tries to install MediaWiki via
either web installer or install.php maintenance script,
after obtaining from git, they get some useful information
on what to do.

Put the checks alongside the php version check, as
stuff installed via composer (mustache / lightncandy)
is used for NoLocalSettings.php and install.php
attempts to use logging stuff.

Also tried to make PHPVersionError look slightly nicer,
with some <h2> elements and more padding for the <p>
elements.

and centralized this code in one place, as much as possible,
for improved ease of maintenance.

Bug: T90438
Bug: T88951
Change-Id: Iae4eb42c4266dbe9213c5de8a96fccfbeaa9acb0

diff --git a/api.php b/api.php
index 9721c4f..a9e5683 100644 (file)
--- a/api.php
+++ b/api.php
@@ -35,12 +35,10 @@ use MediaWiki\Logger\LegacyLogger;
 // So extensions (and other code) can check whether they're running in API mode
 define( 'MW_API', true );
 
-// Bail if PHP is too low
-if ( !function_exists( 'version_compare' ) || version_compare( PHP_VERSION, '5.3.3' ) < 0 ) {
-       // We need to use dirname( __FILE__ ) here cause __DIR__ is PHP5.3+
-       require dirname( __FILE__ ) . '/includes/PHPVersionError.php';
-       wfPHPVersionError( 'api.php' );
-}
+// Bail on old versions of PHP, or if composer has not been run yet to install
+// dependencies. Using dirname( __FILE__ ) here because __DIR__ is PHP5.3+.
+require_once dirname( __FILE__ ) . '/includes/PHPVersionCheck.php';
+wfEntryPointCheck( 'api.php' );
 
 require __DIR__ . '/includes/WebStart.php';
 

diff --git a/includes/PHPVersionCheck.php b/includes/PHPVersionCheck.php
new file mode 100644 (file)
index 0000000..d11d021
--- /dev/null
+++ b/includes/PHPVersionCheck.php
@@ -0,0 +1,157 @@
+<?php
+/**
+ * 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.
+ *
+ * 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
+ */
+
+/**
+ * Check php version and that external dependencies are installed, and
+ * display an informative error if either condition is not satisfied.
+ */
+function wfEntryPointCheck( $entryPoint ) {
+       if ( !function_exists( 'version_compare' )
+               || version_compare( PHP_VERSION, '5.3.3' ) < 0
+               || !file_exists( dirname( __FILE__ ) . '/../vendor/autoload.php' )
+       ) {
+               wfPHPVersionError( $entryPoint );
+       }
+}
+
+/**
+ * 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
+ *
+ * @note Since we can't rely on anything, the minimum PHP versions and MW current
+ * version are hardcoded here
+ */
+function wfPHPVersionError( $type ) {
+       $mwVersion = '1.26';
+       $minimumVersionPHP = '5.3.3';
+
+       $phpVersion = PHP_VERSION;
+       $protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0';
+       $message = "MediaWiki $mwVersion requires at least "
+               . "PHP version $minimumVersionPHP, you are using PHP $phpVersion. Installing some "
+               . " external dependencies (e.g. via composer) is also required.";
+
+       if ( $type == 'cli' ) {
+               $finalOutput = "Error: You are missing some external dependencies or are using on older PHP version. \n"
+                       . "MediaWiki $mwVersion needs PHP $minimumVersionPHP or higher.\n\n"
+                       . "Check if you have a newer php executable with a different name, such as php5.\n\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.";
+       } elseif ( $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'
+               );
+
+               header( "$protocol 500 MediaWiki configuration Error" );
+               header( 'Content-type: text/html; charset=UTF-8' );
+               // Don't cache error pages!  They cause no end of trouble...
+               header( 'Cache-control: none' );
+               header( 'Pragma: no-cache' );
+
+               $finalOutput = <<<HTML
+<!DOCTYPE html>
+<html lang="en" dir="ltr">
+       <head>
+               <meta charset="UTF-8" />
+               <title>MediaWiki {$mwVersion}</title>
+               <style media='screen'>
+                       body {
+                               color: #000;
+                               background-color: #fff;
+                               font-family: sans-serif;
+                               padding: 2em;
+                               text-align: center;
+                       }
+                       p, img, h1, h2 {
+                               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 {$mwVersion} internal error</h1>
+               <div class='error'>
+               <p>
+                       {$message}
+               </p>
+               <h2>Supported PHP versions</h2>
+               <p>
+                       Please consider <a href="http://www.php.net/downloads.php">upgrading your copy of PHP</a>.
+                       PHP versions less than 5.3.0 are no longer supported by the PHP Group and will not receive
+                       security or bugfix updates.
+               </p>
+               <p>
+                       If for some reason you are unable to upgrade your PHP 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 PHP.
+               </p>
+               <h2>External dependencies</h2>
+               <p>
+                       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.
+               </p>
+               </div>
+       </body>
+</html>
+HTML;
+       // Handle everything that's not index.php
+       } else {
+               // So nothing thinks this is JS or CSS
+               $finalOutput = ( $type == 'load.php' ) ? "/* $message */" : $message;
+               header( "$protocol 500 MediaWiki configuration Error" );
+       }
+       echo "$finalOutput\n";
+       die( 1 );
+}

diff --git a/includes/PHPVersionError.php b/includes/PHPVersionError.php
index 3a2f9f8..007ea89 100644 (file)
--- a/includes/PHPVersionError.php
+++ b/includes/PHPVersionError.php
@@ -1,6 +1,7 @@
 <?php
 /**
- * Display something vaguely comprehensible in the event of a totally unrecoverable error.
+ * Backwards compatibility. The PHP version error function is now
+ * included in PHPVersionCheck.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
@@ -17,110 +18,7 @@
  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
+ * @deprecated 1.25
  * @file
  */
-
-/**
- * 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
- *
- * @note Since we can't rely on anything, the minimum PHP versions and MW current
- * version are hardcoded here
- */
-function wfPHPVersionError( $type ) {
-       $mwVersion = '1.26';
-       $minimumVersionPHP = '5.3.3';
-
-       $phpVersion = PHP_VERSION;
-       $protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0';
-       $message = "MediaWiki $mwVersion requires at least "
-               . "PHP version $minimumVersionPHP, you are using PHP $phpVersion.";
-
-       if ( $type == 'cli' ) {
-               $finalOutput = "You are using PHP version $phpVersion "
-                       . "but MediaWiki $mwVersion needs PHP $minimumVersionPHP or higher. ABORTING.\n"
-                       . "Check if you have a newer php executable with a different name, such as php5.\n";
-       } elseif ( $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'
-               );
-
-               header( "$protocol 500 MediaWiki configuration Error" );
-               header( 'Content-type: text/html; charset=UTF-8' );
-               // Don't cache error pages!  They cause no end of trouble...
-               header( 'Cache-control: none' );
-               header( 'Pragma: no-cache' );
-
-               $finalOutput = <<<HTML
-<!DOCTYPE html>
-<html lang="en" dir="ltr">
-       <head>
-               <meta charset="UTF-8" />
-               <title>MediaWiki {$mwVersion}</title>
-               <style media='screen'>
-                       body {
-                               color: #000;
-                               background-color: #fff;
-                               font-family: sans-serif;
-                               padding: 2em;
-                               text-align: center;
-                       }
-                       p, img, h1 {
-                               text-align: left;
-                               margin: 0.5em 0;
-                       }
-                       h1 {
-                               font-size: 120%;
-                       }
-               </style>
-       </head>
-       <body>
-               <img src="{$encLogo}" alt='The MediaWiki logo' />
-               <h1>MediaWiki {$mwVersion} internal error</h1>
-               <div class='error'>
-               <p>
-                       {$message}
-               </p>
-               <p>
-                       Please consider <a href="http://www.php.net/downloads.php">upgrading your copy of PHP</a>.
-                       PHP versions less than 5.3.0 are no longer supported by the PHP Group and will not receive
-                       security or bugfix updates.
-               </p>
-               <p>
-                       If for some reason you are unable to upgrade your PHP 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 PHP.
-               </p>
-               </div>
-       </body>
-</html>
-HTML;
-       // Handle everything that's not index.php
-       } else {
-               // So nothing thinks this is JS or CSS
-               $finalOutput = ( $type == 'load.php' ) ? "/* $message */" : $message;
-               header( "$protocol 500 MediaWiki configuration Error" );
-       }
-       echo "$finalOutput\n";
-       die( 1 );
-}
+require_once dirname( __FILE__ ) . '/PHPVersionCheck.php';

diff --git a/index.php b/index.php
index c32bd3a..67bd0c9 100644 (file)
--- a/index.php
+++ b/index.php
@@ -30,15 +30,10 @@
  * @file
  */
 
-# Bail on old versions of PHP.  Pretty much every other file in the codebase
-# has structures (try/catch, foo()->bar(), etc etc) which throw parse errors in
-# PHP 4. Setup.php and ObjectCache.php have structures invalid in PHP 5.0 and
-# 5.1, respectively.
-if ( !function_exists( 'version_compare' ) || version_compare( PHP_VERSION, '5.3.3' ) < 0 ) {
-       // We need to use dirname( __FILE__ ) here cause __DIR__ is PHP5.3+
-       require dirname( __FILE__ ) . '/includes/PHPVersionError.php';
-       wfPHPVersionError( 'index.php' );
-}
+// Bail on old versions of PHP, or if composer has not been run yet to install
+// dependencies. Using dirname( __FILE__ ) here because __DIR__ is PHP5.3+.
+require_once dirname( __FILE__ ) . '/includes/PHPVersionCheck.php';
+wfEntryPointCheck( 'index.php' );
 
 require __DIR__ . '/includes/WebStart.php';
 

diff --git a/load.php b/load.php
index d77a689..0c7ea62 100644 (file)
--- a/load.php
+++ b/load.php
@@ -22,12 +22,10 @@
  * @author Trevor Parscal
  */
 
-// Bail if PHP is too low
-if ( !function_exists( 'version_compare' ) || version_compare( PHP_VERSION, '5.3.3' ) < 0 ) {
-       // We need to use dirname( __FILE__ ) here cause __DIR__ is PHP5.3+
-       require dirname( __FILE__ ) . '/includes/PHPVersionError.php';
-       wfPHPVersionError( 'load.php' );
-}
+// Bail on old versions of PHP, or if composer has not been run yet to install
+// dependencies. Using dirname( __FILE__ ) here because __DIR__ is PHP5.3+.
+require_once dirname( __FILE__ ) . '/includes/PHPVersionCheck.php';
+wfEntryPointCheck( 'load.php' );
 
 require __DIR__ . '/includes/WebStart.php';
 

diff --git a/maintenance/Maintenance.php b/maintenance/Maintenance.php
index c97c6a3..e4ac467 100644 (file)
--- a/maintenance/Maintenance.php
+++ b/maintenance/Maintenance.php
@@ -20,12 +20,10 @@
  * @defgroup Maintenance Maintenance
  */
 
-// Make sure we're on PHP5.3.3 or better
-if ( !function_exists( 'version_compare' ) || version_compare( PHP_VERSION, '5.3.3' ) < 0 ) {
-       // We need to use dirname( __FILE__ ) here cause __DIR__ is PHP5.3+
-       require_once dirname( __FILE__ ) . '/../includes/PHPVersionError.php';
-       wfPHPVersionError( 'cli' );
-}
+// Bail on old versions of PHP, or if composer has not been run yet to install
+// dependencies. Using dirname( __FILE__ ) here because __DIR__ is PHP5.3+.
+require_once dirname( __FILE__ ) . '/../includes/PHPVersionCheck.php';
+wfEntryPointCheck( 'cli' );
 
 /**
  * @defgroup MaintenanceArchive Maintenance archives

diff --git a/maintenance/update.php b/maintenance/update.php
index b8af5e9..3bb722e 100755 (executable)
--- a/maintenance/update.php
+++ b/maintenance/update.php
@@ -26,11 +26,6 @@
  * @ingroup Maintenance
  */
 
-if ( !function_exists( 'version_compare' ) || ( version_compare( PHP_VERSION, '5.3.3' ) < 0 ) ) {
-       require dirname( __FILE__ ) . '/../includes/PHPVersionError.php';
-       wfPHPVersionError( 'cli' );
-}
-
 $wgUseMasterForMaintenance = true;
 require_once __DIR__ . '/Maintenance.php';
 

diff --git a/mw-config/index.php b/mw-config/index.php
index ed3e7f4..be811dc 100644 (file)
--- a/mw-config/index.php
+++ b/mw-config/index.php
@@ -20,12 +20,10 @@
  * @file
  */
 
-// Bail if PHP is too low
-if ( !function_exists( 'version_compare' ) || version_compare( PHP_VERSION, '5.3.3' ) < 0 ) {
-       // We need to use dirname( __FILE__ ) here cause __DIR__ is PHP5.3+
-       require dirname( dirname( __FILE__ ) ) . '/includes/PHPVersionError.php';
-       wfPHPVersionError( 'mw-config/index.php' );
-}
+// Bail on old versions of PHP, or if composer has not been run yet to install
+// dependencies. Using dirname( __FILE__ ) here because __DIR__ is PHP5.3+.
+require_once dirname( __FILE__ ) . '/../includes/PHPVersionCheck.php';
+wfEntryPointCheck( 'mw-config/index.php' );
 
 define( 'MW_CONFIG_CALLBACK', 'Installer::overrideConfig' );
 define( 'MEDIAWIKI_INSTALL', true );