includes/PHPVersionCheck.php

   1 <?php
   2 /**
   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.
   7  *
   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.
  12  *
  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
  17  *
  18  * @file
  19  */
  20
  21 // phpcs:disable Generic.Arrays.DisallowLongArraySyntax,PSR2.Classes.PropertyDeclaration,MediaWiki.Usage.DirUsage
  22 // phpcs:disable Squiz.Scope.MemberVarScope.Missing,Squiz.Scope.MethodScope.Missing
  23 // @phan-file-suppress PhanPluginDuplicateConditionalNullCoalescing
  24 /**
  25  * Check PHP Version, as well as for composer dependencies in entry points,
  26  * and display something vaguely comprehensible in the event of a totally
  27  * unrecoverable error.
  28  *
  29  * @note Since we can't rely on anything external, the minimum PHP versions
  30  * and MW current version are hardcoded in this class.
  31  *
  32  * @note This class uses setter methods instead of a constructor so that
  33  * it can be compatible with PHP 4, PHP 5 and PHP 7 (without warnings).
  34  *
  35  * @class
  36  */
  37 class PHPVersionCheck {
  38         /* @var string The number of the MediaWiki version used. */
  39         var $mwVersion = '1.34';
  40
  41         /* @var array A mapping of PHP functions to PHP extensions. */
  42         var $functionsExtensionsMapping = array(
  43                 'mb_substr'   => 'mbstring',
  44                 'xml_parser_create' => 'xml',
  45                 'ctype_digit' => 'ctype',
  46                 'json_decode' => 'json',
  47                 'iconv'       => 'iconv',
  48                 'mime_content_type' => 'fileinfo',
  49         );
  50
  51         /**
  52          * @var string $format The format used for errors. One of "text" or "html"
  53          */
  54         var $format = 'text';
  55
  56         /**
  57          * @var string $scriptPath
  58          */
  59         var $scriptPath = '/';
  60
  61         /**
  62          * Set the format used for errors.
  63          *
  64          * @param string $format One of "text" or "html"
  65          */
  66         function setFormat( $format ) {
  67                 $this->format = $format;
  68         }
  69
  70         /**
  71          * Set the script path used for images in HTML-formatted errors.
  72          *
  73          * @param string $scriptPath
  74          */
  75         function setScriptPath( $scriptPath ) {
  76                 $this->scriptPath = $scriptPath;
  77         }
  78
  79         /**
  80          * Return the version of the installed PHP implementation.
  81          *
  82          * @param string $impl By default, the function returns the info of the currently installed PHP
  83          *  implementation. Using this parameter the caller can decide, what version info will be
  84          *  returned. Valid values: HHVM, PHP
  85          * @return array An array of information about the PHP implementation, containing:
  86          *  - 'version': The version of the PHP implementation (specific to the implementation, not
  87          *  the version of the implemented PHP version)
  88          *  - 'implementation': The name of the implementation used
  89          *  - 'vendor': The development group, vendor or developer of the implementation.
  90          *  - 'upstreamSupported': The minimum version of the implementation supported by the named vendor.
  91          *  - 'minSupported': The minimum version supported by MediaWiki
  92          *  - 'upgradeURL': The URL to the website of the implementation that contains
  93          *  upgrade/installation instructions.
  94          */
  95         function getPHPInfo( $impl = false ) {
  96                 if (
  97                         ( defined( 'HHVM_VERSION' ) && $impl !== 'PHP' ) ||
  98                         $impl === 'HHVM'
  99                 ) {
 100                         return array(
 101                                 'implementation' => 'HHVM',
 102                                 'version' => defined( 'HHVM_VERSION' ) ? HHVM_VERSION : 'undefined',
 103                                 'vendor' => 'Facebook',
 104                                 'upstreamSupported' => '3.18.5',
 105                                 'minSupported' => '3.18.5',
 106                                 'upgradeURL' => 'https://docs.hhvm.com/hhvm/installation/introduction',
 107                         );
 108                 }
 109                 return array(
 110                         'implementation' => 'PHP',
 111                         'version' => PHP_VERSION,
 112                         'vendor' => 'the PHP Group',
 113                         'upstreamSupported' => '5.6.0',
 114                         'minSupported' => '7.0.13',
 115                         'upgradeURL' => 'https://www.php.net/downloads.php',
 116                 );
 117         }
 118
 119         /**
 120          * Displays an error, if the installed PHP version does not meet the minimum requirement.
 121          */
 122         function checkRequiredPHPVersion() {
 123                 $phpInfo = $this->getPHPInfo();
 124                 $minimumVersion = $phpInfo['minSupported'];
 125                 $otherInfo = $this->getPHPInfo( $phpInfo['implementation'] === 'HHVM' ? 'PHP' : 'HHVM' );
 126                 if ( version_compare( $phpInfo['version'], $minimumVersion ) < 0 ) {
 127                         $shortText = "MediaWiki $this->mwVersion requires at least {$phpInfo['implementation']}"
 128                                 . " version $minimumVersion or {$otherInfo['implementation']} version "
 129                                 . "{$otherInfo['minSupported']}, you are using {$phpInfo['implementation']} "
 130                                 . "{$phpInfo['version']}.";
 131
 132                         $longText = "Error: You might be using an older {$phpInfo['implementation']} version "
 133                                 . "({$phpInfo['implementation']} {$phpInfo['version']}). \n"
 134                                 . "MediaWiki $this->mwVersion needs {$phpInfo['implementation']}"
 135                                 . " $minimumVersion or higher or {$otherInfo['implementation']} version "
 136                                 . "{$otherInfo['minSupported']}.\n\nCheck if you have a"
 137                                 . " newer PHP executable with a different name.\n\n";
 138
 139                         // phpcs:disable Generic.Files.LineLength
 140                         $longHtml = <<<HTML
 141                         Please consider <a href="{$phpInfo['upgradeURL']}">upgrading your copy of
 142                         {$phpInfo['implementation']}</a>.
 143                         {$phpInfo['implementation']} versions less than {$phpInfo['upstreamSupported']} are no
 144                         longer supported by {$phpInfo['vendor']} and will not receive
 145                         security or bugfix updates.
 146                 </p>
 147                 <p>
 148                         If for some reason you are unable to upgrade your {$phpInfo['implementation']} version,
 149                         you will need to <a href="https://www.mediawiki.org/wiki/Download">download</a> an
 150                         older version of MediaWiki from our website.
 151                         See our <a href="https://www.mediawiki.org/wiki/Compatibility#PHP">compatibility page</a>
 152                         for details of which versions are compatible with prior versions of {$phpInfo['implementation']}.
 153 HTML;
 154                         // phpcs:enable Generic.Files.LineLength
 155                         $this->triggerError(
 156                                 "Supported {$phpInfo['implementation']} versions",
 157                                 $shortText,
 158                                 $longText,
 159                                 $longHtml
 160                         );
 161                 }
 162         }
 163
 164         /**
 165          * Displays an error, if the vendor/autoload.php file could not be found.
 166          */
 167         function checkVendorExistence() {
 168                 if ( !file_exists( dirname( __FILE__ ) . '/../vendor/autoload.php' ) ) {
 169                         $shortText = "Installing some external dependencies (e.g. via composer) is required.";
 170
 171                         $longText = "Error: You are missing some external dependencies. \n"
 172                                 . "MediaWiki now also has some external dependencies that need to be installed\n"
 173                                 . "via composer or from a separate git repo. Please see\n"
 174                                 . "https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries\n"
 175                                 . "for help on installing the required components.";
 176
 177                         // phpcs:disable Generic.Files.LineLength
 178                         $longHtml = <<<HTML
 179                 MediaWiki now also has some external dependencies that need to be installed via
 180                 composer or from a separate git repo. Please see
 181                 <a href="https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries">mediawiki.org</a>
 182                 for help on installing the required components.
 183 HTML;
 184                         // phpcs:enable Generic.Files.LineLength
 185
 186                         $this->triggerError( 'External dependencies', $shortText, $longText, $longHtml );
 187                 }
 188         }
 189
 190         /**
 191          * Displays an error, if a PHP extension does not exist.
 192          */
 193         function checkExtensionExistence() {
 194                 $missingExtensions = array();
 195                 foreach ( $this->functionsExtensionsMapping as $function => $extension ) {
 196                         if ( !function_exists( $function ) ) {
 197                                 $missingExtensions[] = $extension;
 198                         }
 199                 }
 200
 201                 if ( $missingExtensions ) {
 202                         $shortText = "Installing some PHP extensions is required.";
 203
 204                         $missingExtText = '';
 205                         $missingExtHtml = '';
 206                         $baseUrl = 'https://www.php.net';
 207                         foreach ( $missingExtensions as $ext ) {
 208                                 $missingExtText .= " * $ext <$baseUrl/$ext>\n";
 209                                 $missingExtHtml .= "<li><b>$ext</b> "
 210                                         . "(<a href=\"$baseUrl/$ext\">more information</a>)</li>";
 211                         }
 212
 213                         $cliText = "Error: Missing one or more required components of PHP.\n"
 214                                 . "You are missing a required extension to PHP that MediaWiki needs.\n"
 215                                 . "Please install:\n" . $missingExtText;
 216
 217                         $longHtml = <<<HTML
 218                 You are missing a required extension to PHP that MediaWiki
 219                 requires to run. Please install:
 220                 <ul>
 221                 $missingExtHtml
 222                 </ul>
 223 HTML;
 224
 225                         $this->triggerError( 'Required components', $shortText, $cliText, $longHtml );
 226                 }
 227         }
 228
 229         /**
 230          * Output headers that prevents error pages to be cached.
 231          */
 232         function outputHTMLHeader() {
 233                 $protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0';
 234
 235                 header( "$protocol 500 MediaWiki configuration Error" );
 236                 // Don't cache error pages!  They cause no end of trouble...
 237                 header( 'Cache-control: none' );
 238                 header( 'Pragma: no-cache' );
 239         }
 240
 241         /**
 242          * Returns an error page, which is suitable for output to the end user via a web browser.
 243          *
 244          * @param string $title
 245          * @param string $longHtml
 246          * @param string $shortText
 247          * @return string
 248          */
 249         function getIndexErrorOutput( $title, $longHtml, $shortText ) {
 250                 $encLogo =
 251                         htmlspecialchars( str_replace( '//', '/', $this->scriptPath . '/' ) .
 252                                 'resources/assets/mediawiki.png' );
 253                 $shortHtml = htmlspecialchars( $shortText );
 254
 255                 header( 'Content-type: text/html; charset=UTF-8' );
 256
 257                 $finalOutput = <<<HTML
 258 <!DOCTYPE html>
 259 <html lang="en" dir="ltr">
 260         <head>
 261                 <meta charset="UTF-8" />
 262                 <title>MediaWiki {$this->mwVersion}</title>
 263                 <style media='screen'>
 264                         body {
 265                                 color: #000;
 266                                 background-color: #fff;
 267                                 font-family: sans-serif;
 268                                 padding: 2em;
 269                                 text-align: center;
 270                         }
 271                         p, img, h1, h2, ul  {
 272                                 text-align: left;
 273                                 margin: 0.5em 0 1em;
 274                         }
 275                         h1 {
 276                                 font-size: 120%;
 277                         }
 278                         h2 {
 279                                 font-size: 110%;
 280                         }
 281                 </style>
 282         </head>
 283         <body>
 284                 <img src="{$encLogo}" alt='The MediaWiki logo' />
 285                 <h1>MediaWiki {$this->mwVersion} internal error</h1>
 286                 <div class='error'>
 287                 <p>
 288                         {$shortHtml}
 289                 </p>
 290                 <h2>{$title}</h2>
 291                 <p>
 292                         {$longHtml}
 293                 </p>
 294                 </div>
 295         </body>
 296 </html>
 297 HTML;
 298
 299                 return $finalOutput;
 300         }
 301
 302         /**
 303          * Display something vaguely comprehensible in the event of a totally unrecoverable error.
 304          * Does not assume access to *anything*; no globals, no autoloader, no database, no localisation.
 305          * Safe for PHP4 (and putting this here means that WebStart.php and GlobalSettings.php
 306          * no longer need to be).
 307          *
 308          * Calling this function kills execution immediately.
 309          *
 310          * @param string $title HTML code to be put within an <h2> tag
 311          * @param string $shortText
 312          * @param string $longText
 313          * @param string $longHtml
 314          */
 315         function triggerError( $title, $shortText, $longText, $longHtml ) {
 316                 if ( $this->format === 'html' ) {
 317                         // Used by index.php and mw-config/index.php
 318                         $this->outputHTMLHeader();
 319                         $finalOutput = $this->getIndexErrorOutput( $title, $longHtml, $shortText );
 320                 } else {
 321                         // Used by Maintenance.php (CLI)
 322                         $finalOutput = $longText;
 323                 }
 324
 325                 echo "$finalOutput\n";
 326                 die( 1 );
 327         }
 328 }
 329
 330 /**
 331  * Check PHP version and that external dependencies are installed, and
 332  * display an informative error if either condition is not satisfied.
 333  *
 334  * @param string $format One of "text" or "html"
 335  * @param string $scriptPath Used when an error is formatted as HTML.
 336  */
 337 function wfEntryPointCheck( $format = 'text', $scriptPath = '/' ) {
 338         $phpVersionCheck = new PHPVersionCheck();
 339         $phpVersionCheck->setFormat( $format );
 340         $phpVersionCheck->setScriptPath( $scriptPath );
 341         $phpVersionCheck->checkRequiredPHPVersion();
 342         $phpVersionCheck->checkVendorExistence();
 343         $phpVersionCheck->checkExtensionExistence();
 344 }