1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
<?php
// @codingStandardsIgnoreFile Generic.Arrays.DisallowLongArraySyntax
// @codingStandardsIgnoreFile Generic.Files.LineLength
// @codingStandardsIgnoreFile MediaWiki.Usage.DirUsage.FunctionFound
/**
* 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
*/
class PHPVersionCheck {
/* @var string The number of the MediaWiki version used */
var $mwVersion = '1.29';
/* @var string The minimum php version for MediaWiki to run */
var $minimumVersionPHP = '5.5.9';
var $functionsExtensionsMapping = array(
'mb_substr' => 'mbstring',
'utf8_encode' => 'xml',
'ctype_digit' => 'ctype',
'json_decode' => 'json',
'iconv' => 'iconv',
);
/**
* @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 = <<<HTML
Please consider <a href="http://www.php.net/downloads.php">upgrading your copy of PHP</a>.
PHP versions less than 5.5.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.
HTML;
$this->triggerError( 'Supported PHP versions', $shortText, $longText, $longHtml );
}
}
/**
* 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 = <<<HTML
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.
HTML;
$this->triggerError( 'External dependencies', $shortText, $longText, $longHtml );
}
}
/**
* 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 .= "<li><b>$ext</b> "
. "(<a href=\"$baseUrl/$ext\">more information</a>)</li>";
}
$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 = <<<HTML
You are missing a required extension to PHP that MediaWiki
requires to run. Please install:
<ul>
$missingExtHtml
</ul>
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';
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 $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' );
$finalOutput = <<<HTML
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
<meta charset="UTF-8" />
<title>MediaWiki {$this->mwVersion}</title>
<style media='screen'>
body {
color: #000;
background-color: #fff;
font-family: sans-serif;
padding: 2em;
text-align: center;
}
p, img, h1, h2, ul {
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 {$this->mwVersion} internal error</h1>
<div class='error'>
<p>
{$shortHtml}
</p>
<h2>{$title}</h2>
<p>
{$longHtml}
</p>
</div>
</body>
</html>
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).
*
* Calling this function kills execution immediately.
*
* @param string $title HTML code to be put within an <h2> tag
* @param string $shortText
* @param string $longText
* @param string $longHtml
*/
function triggerError( $title, $shortText, $longText, $longHtml ) {
switch ( $this->entryPoint ) {
case 'cli':
$finalOutput = $longText;
break;
case 'index.php':
case 'mw-config/index.php':
$this->outputHTMLHeader();
$finalOutput = $this->getIndexErrorOutput( $title, $longHtml, $shortText );
break;
case 'load.php':
$this->outputHTMLHeader();
$finalOutput = "/* $shortText */";
break;
default:
$this->outputHTMLHeader();
// Handle everything that's not index.php
$finalOutput = $shortText;
}
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.
*
* @note Since we can't rely on anything, the minimum PHP versions and MW current
* version are hardcoded here
*/
function wfEntryPointCheck( $entryPoint ) {
$phpVersionCheck = new PHPVersionCheck();
$phpVersionCheck->setEntryPoint( $entryPoint );
$phpVersionCheck->checkRequiredPHPVersion();
$phpVersionCheck->checkVendorExistence();
$phpVersionCheck->checkExtensionExistence();
}
|
