MediaWiki  master
PHPVersionCheck.php
Go to the documentation of this file.
1 <?php
21 // phpcs:disable Generic.Arrays.DisallowLongArraySyntax,PSR2.Classes.PropertyDeclaration,MediaWiki.Usage.DirUsage
22 // phpcs:disable Squiz.Scope.MemberVarScope.Missing,Squiz.Scope.MethodScope.Missing
36  var $mwVersion = '1.41';
37 
40  'mb_substr' => 'mbstring',
41  'xml_parser_create' => 'xml',
42  'ctype_digit' => 'ctype',
43  'json_decode' => 'json',
44  'iconv' => 'iconv',
45  'mime_content_type' => 'fileinfo',
46  'intl_is_failure' => 'intl',
47  );
48 
52  var $format = 'text';
53 
57  var $scriptPath = '/';
58 
64  function setFormat( $format ) {
65  $this->format = $format;
66  }
67 
73  function setScriptPath( $scriptPath ) {
74  $this->scriptPath = $scriptPath;
75  }
76 
81  $minimumVersion = '7.4.3';
82 
96  $knownBad = array(
97  );
98 
99  $passes = version_compare( PHP_VERSION, $minimumVersion, '>=' );
100 
101  $versionString = "PHP $minimumVersion or higher";
102 
103  // Left as a programmatic check to make it easier to update.
104  if ( count( $knownBad ) ) {
105  $versionString .= ' (and not ' . implode( ', ', array_values( $knownBad ) ) . ')';
106 
107  foreach ( $knownBad as $range ) {
108  // As we don't have composer at this point, we have to do our own version range checking.
109  if ( strpos( $range, '-' ) ) {
110  $passes = $passes && !(
111  version_compare( PHP_VERSION, trim( strstr( $range, '-', true ) ), '>=' )
112  && version_compare( PHP_VERSION, trim( substr( strstr( $range, '-', false ), 1 ) ), '<' )
113  );
114  } else {
115  $passes = $passes && version_compare( PHP_VERSION, trim( $range ), '<>' );
116  }
117  }
118  }
119 
120  if ( !$passes ) {
121  $cliText = "Error: You are using an unsupported PHP version (PHP " . PHP_VERSION . ").\n"
122  . "MediaWiki $this->mwVersion needs $versionString.\n\nCheck if you might have a newer "
123  . "PHP executable with a different name.\n\n";
124 
125  $web = array();
126  $web['intro'] = "MediaWiki $this->mwVersion requires $versionString; you are using PHP "
127  . PHP_VERSION . ".";
128 
129  $web['longTitle'] = "Supported PHP versions";
130  // phpcs:disable Generic.Files.LineLength
131  $web['longHtml'] = <<<HTML
132  <p>
133  Please consider <a href="https://www.php.net/downloads.php">upgrading your copy of PHP</a>.
134  PHP versions less than v7.3.0 are no longer supported by the PHP Group and will not receive
135  security or bugfix updates.
136  </p>
137  <p>
138  If for some reason you are unable to upgrade your PHP version, you will need to
139  <a href="https://www.mediawiki.org/wiki/Download">download</a> an older version of
140  MediaWiki from our website. See our
141  <a href="https://www.mediawiki.org/wiki/Compatibility#PHP">compatibility page</a>
142  for details of which versions are compatible with prior versions of PHP.
143  </p>
144 HTML;
145  // phpcs:enable Generic.Files.LineLength
146  $this->triggerError(
147  $web,
148  $cliText
149  );
150  }
151  }
152 
156  function checkVendorExistence() {
157  if ( !file_exists( dirname( __FILE__ ) . '/../vendor/autoload.php' ) ) {
158  $cliText = "Error: You are missing some external dependencies. \n"
159  . "MediaWiki has external dependencies that need to be installed via Composer\n"
160  . "or from a separate repository. Please see\n"
161  . "https://www.mediawiki.org/wiki/Manual:Installation_requirements#PHP and\n"
162  . "https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries\n"
163  . "for help on installing the required components.";
164 
165  $web = array();
166  $web['intro'] = "Installing some external dependencies (e.g. via composer) is required.";
167  $web['longTitle'] = 'External dependencies';
168  // phpcs:disable Generic.Files.LineLength
169  $web['longHtml'] = <<<HTML
170  <p>
171  MediaWiki has external dependencies that need to be installed via Composer
172  or from a separate repository. Please see the
173  <a href="https://www.mediawiki.org/wiki/Manual:Installation_requirements#PHP">PHP
174  installation requirements</a> and the
175  <a href="https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries">instructions
176  for installing PHP libraries</a> on mediawiki.org for help on installing the required components.
177  </p>
178 HTML;
179  // phpcs:enable Generic.Files.LineLength
180 
181  $this->triggerError( $web, $cliText );
182  }
183  }
184 
189  $missingExtensions = array();
190  foreach ( $this->functionsExtensionsMapping as $function => $extension ) {
191  if ( !function_exists( $function ) ) {
192  $missingExtensions[] = $extension;
193  }
194  }
195 
196  if ( $missingExtensions ) {
197  $missingExtText = '';
198  $missingExtHtml = '';
199  $baseUrl = 'https://www.php.net';
200  foreach ( $missingExtensions as $ext ) {
201  $missingExtText .= " * $ext <$baseUrl/$ext>\n";
202  $missingExtHtml .= "<li><b>$ext</b> "
203  . "(<a href=\"$baseUrl/$ext\">more information</a>)</li>";
204  }
205 
206  $cliText = "Error: Missing one or more required components of PHP.\n"
207  . "You are missing a required extension to PHP that MediaWiki needs.\n"
208  . "Please install:\n" . $missingExtText;
209 
210  $web = array();
211  $web['intro'] = "Installing some PHP extensions is required.";
212  $web['longTitle'] = 'Required components';
213  $web['longHtml'] = <<<HTML
214  <p>
215  You are missing a required extension to PHP that MediaWiki
216  requires to run. Please install:
217  </p>
218  <ul>
219  $missingExtHtml
220  </ul>
221 HTML;
222 
223  $this->triggerError( $web, $cliText );
224  }
225  }
226 
230  function outputHTMLHeader() {
231  $protocol = isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0';
232 
233  header( "$protocol 500 MediaWiki configuration Error" );
234  // Don't cache error pages! They cause no end of trouble...
235  header( 'Cache-Control: no-cache' );
236  }
237 
246  function getIndexErrorOutput( $introText, $longTitle, $longHtml ) {
247  $encLogo =
248  htmlspecialchars( str_replace( '//', '/', $this->scriptPath . '/' ) .
249  'resources/assets/mediawiki.png' );
250 
251  $introHtml = htmlspecialchars( $introText );
252  $longTitleHtml = htmlspecialchars( $longTitle );
253 
254  header( 'Content-type: text/html; charset=UTF-8' );
255 
256  $finalOutput = <<<HTML
257 <!DOCTYPE html>
258 <html lang="en" dir="ltr">
259  <head>
260  <meta charset="UTF-8" />
261  <title>MediaWiki {$this->mwVersion}</title>
262  <style media="screen">
263  body {
264  color: #000;
265  background-color: #fff;
266  font-family: sans-serif;
267  padding: 2em;
268  text-align: center;
269  }
270  p, img, h1, h2, ul {
271  text-align: left;
272  margin: 0.5em 0 1em;
273  }
274  h1 {
275  font-size: 120%;
276  }
277  h2 {
278  font-size: 110%;
279  }
280  </style>
281  </head>
282  <body>
283  <img src="{$encLogo}" alt="The MediaWiki logo" />
284  <h1>MediaWiki {$this->mwVersion} internal error</h1>
285  <p>
286  {$introHtml}
287  </p>
288  <h2>{$longTitleHtml}</h2>
289  {$longHtml}
290  </body>
291 </html>
292 HTML;
293 
294  return $finalOutput;
295  }
296 
311  function triggerError( $web, $cliText ) {
312  if ( $this->format === 'html' ) {
313  // Used by index.php and mw-config/index.php
314  $this->outputHTMLHeader();
315  $finalOutput = $this->getIndexErrorOutput(
316  $web['intro'],
317  $web['longTitle'],
318  $web['longHtml']
319  );
320  } else {
321  // Used by Maintenance.php (CLI)
322  $finalOutput = $cliText;
323  }
324 
325  echo "$finalOutput\n";
326  die( 1 );
327  }
328 }
329 
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 }
wfEntryPointCheck( $format='text', $scriptPath='/')
Check PHP version and that external dependencies are installed, and display an informative error if e...
The MediaWiki class is the helper class for the index.php entry point.
Definition: MediaWiki.php:50
Check PHP Version, as well as for composer dependencies in entry points, and display something vaguel...
setFormat( $format)
Set the format used for errors.
string $mwVersion
The number of the MediaWiki version used.
outputHTMLHeader()
Output headers that prevents error pages to be cached.
setScriptPath( $scriptPath)
Set the script path used for images in HTML-formatted errors.
triggerError( $web, $cliText)
Display something vaguely comprehensible in the event of a totally unrecoverable error.
getIndexErrorOutput( $introText, $longTitle, $longHtml)
Returns an error page, which is suitable for output to the end user via a web browser.
checkExtensionExistence()
Displays an error, if a PHP extension does not exist.
checkRequiredPHPVersion()
Displays an error, if the installed PHP version does not meet the minimum requirement.
string[] $functionsExtensionsMapping
A mapping of PHP functions to PHP extensions.
checkVendorExistence()
Displays an error, if the vendor/autoload.php file could not be found.
string $format
The format used for errors.
if(!is_readable( $file)) $ext
Definition: router.php:48