HHVM removal: Deprecate and simplify wfIsHHVM()
[lhc/web/wiklou.git] / includes / GlobalFunctions.php
1 <?php
2 /**
3 * Global functions used everywhere.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
25 }
26
27 use MediaWiki\BadFileLookup;
28 use MediaWiki\Linker\LinkTarget;
29 use MediaWiki\Logger\LoggerFactory;
30 use MediaWiki\MediaWikiServices;
31 use MediaWiki\ProcOpenError;
32 use MediaWiki\Session\SessionManager;
33 use MediaWiki\Shell\Shell;
34 use Wikimedia\AtEase\AtEase;
35 use Wikimedia\WrappedString;
36
37 /**
38 * Load an extension
39 *
40 * This queues an extension to be loaded through
41 * the ExtensionRegistry system.
42 *
43 * @param string $ext Name of the extension to load
44 * @param string|null $path Absolute path of where to find the extension.json file
45 * @since 1.25
46 */
47 function wfLoadExtension( $ext, $path = null ) {
48 if ( !$path ) {
49 global $wgExtensionDirectory;
50 $path = "$wgExtensionDirectory/$ext/extension.json";
51 }
52 ExtensionRegistry::getInstance()->queue( $path );
53 }
54
55 /**
56 * Load multiple extensions at once
57 *
58 * Same as wfLoadExtension, but more efficient if you
59 * are loading multiple extensions.
60 *
61 * If you want to specify custom paths, you should interact with
62 * ExtensionRegistry directly.
63 *
64 * @see wfLoadExtension
65 * @param string[] $exts Array of extension names to load
66 * @since 1.25
67 */
68 function wfLoadExtensions( array $exts ) {
69 global $wgExtensionDirectory;
70 $registry = ExtensionRegistry::getInstance();
71 foreach ( $exts as $ext ) {
72 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
73 }
74 }
75
76 /**
77 * Load a skin
78 *
79 * @see wfLoadExtension
80 * @param string $skin Name of the extension to load
81 * @param string|null $path Absolute path of where to find the skin.json file
82 * @since 1.25
83 */
84 function wfLoadSkin( $skin, $path = null ) {
85 if ( !$path ) {
86 global $wgStyleDirectory;
87 $path = "$wgStyleDirectory/$skin/skin.json";
88 }
89 ExtensionRegistry::getInstance()->queue( $path );
90 }
91
92 /**
93 * Load multiple skins at once
94 *
95 * @see wfLoadExtensions
96 * @param string[] $skins Array of extension names to load
97 * @since 1.25
98 */
99 function wfLoadSkins( array $skins ) {
100 global $wgStyleDirectory;
101 $registry = ExtensionRegistry::getInstance();
102 foreach ( $skins as $skin ) {
103 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
104 }
105 }
106
107 /**
108 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
109 * @param array $a
110 * @param array $b
111 * @return array
112 */
113 function wfArrayDiff2( $a, $b ) {
114 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
115 }
116
117 /**
118 * @param array|string $a
119 * @param array|string $b
120 * @return int
121 */
122 function wfArrayDiff2_cmp( $a, $b ) {
123 if ( is_string( $a ) && is_string( $b ) ) {
124 return strcmp( $a, $b );
125 } elseif ( count( $a ) !== count( $b ) ) {
126 return count( $a ) <=> count( $b );
127 } else {
128 reset( $a );
129 reset( $b );
130 while ( key( $a ) !== null && key( $b ) !== null ) {
131 $valueA = current( $a );
132 $valueB = current( $b );
133 $cmp = strcmp( $valueA, $valueB );
134 if ( $cmp !== 0 ) {
135 return $cmp;
136 }
137 next( $a );
138 next( $b );
139 }
140 return 0;
141 }
142 }
143
144 /**
145 * Appends to second array if $value differs from that in $default
146 *
147 * @param string|int $key
148 * @param mixed $value
149 * @param mixed $default
150 * @param array &$changed Array to alter
151 * @throws MWException
152 */
153 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
154 if ( is_null( $changed ) ) {
155 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
156 }
157 if ( $default[$key] !== $value ) {
158 $changed[$key] = $value;
159 }
160 }
161
162 /**
163 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
164 * e.g.
165 * wfMergeErrorArrays(
166 * [ [ 'x' ] ],
167 * [ [ 'x', '2' ] ],
168 * [ [ 'x' ] ],
169 * [ [ 'y' ] ]
170 * );
171 * returns:
172 * [
173 * [ 'x', '2' ],
174 * [ 'x' ],
175 * [ 'y' ]
176 * ]
177 *
178 * @param array ...$args
179 * @return array
180 */
181 function wfMergeErrorArrays( ...$args ) {
182 $out = [];
183 foreach ( $args as $errors ) {
184 foreach ( $errors as $params ) {
185 $originalParams = $params;
186 if ( $params[0] instanceof MessageSpecifier ) {
187 $msg = $params[0];
188 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
189 }
190 # @todo FIXME: Sometimes get nested arrays for $params,
191 # which leads to E_NOTICEs
192 $spec = implode( "\t", $params );
193 $out[$spec] = $originalParams;
194 }
195 }
196 return array_values( $out );
197 }
198
199 /**
200 * Insert array into another array after the specified *KEY*
201 *
202 * @param array $array The array.
203 * @param array $insert The array to insert.
204 * @param mixed $after The key to insert after. Callers need to make sure the key is set.
205 * @return array
206 */
207 function wfArrayInsertAfter( array $array, array $insert, $after ) {
208 // Find the offset of the element to insert after.
209 $keys = array_keys( $array );
210 $offsetByKey = array_flip( $keys );
211
212 $offset = $offsetByKey[$after];
213
214 // Insert at the specified offset
215 $before = array_slice( $array, 0, $offset + 1, true );
216 $after = array_slice( $array, $offset + 1, count( $array ) - $offset, true );
217
218 $output = $before + $insert + $after;
219
220 return $output;
221 }
222
223 /**
224 * Recursively converts the parameter (an object) to an array with the same data
225 *
226 * @param object|array $objOrArray
227 * @param bool $recursive
228 * @return array
229 */
230 function wfObjectToArray( $objOrArray, $recursive = true ) {
231 $array = [];
232 if ( is_object( $objOrArray ) ) {
233 $objOrArray = get_object_vars( $objOrArray );
234 }
235 foreach ( $objOrArray as $key => $value ) {
236 if ( $recursive && ( is_object( $value ) || is_array( $value ) ) ) {
237 $value = wfObjectToArray( $value );
238 }
239
240 $array[$key] = $value;
241 }
242
243 return $array;
244 }
245
246 /**
247 * Get a random decimal value in the domain of [0, 1), in a way
248 * not likely to give duplicate values for any realistic
249 * number of articles.
250 *
251 * @note This is designed for use in relation to Special:RandomPage
252 * and the page_random database field.
253 *
254 * @return string
255 */
256 function wfRandom() {
257 // The maximum random value is "only" 2^31-1, so get two random
258 // values to reduce the chance of dupes
259 $max = mt_getrandmax() + 1;
260 $rand = number_format( ( mt_rand() * $max + mt_rand() ) / $max / $max, 12, '.', '' );
261 return $rand;
262 }
263
264 /**
265 * Get a random string containing a number of pseudo-random hex characters.
266 *
267 * @note This is not secure, if you are trying to generate some sort
268 * of token please use MWCryptRand instead.
269 *
270 * @param int $length The length of the string to generate
271 * @return string
272 * @since 1.20
273 */
274 function wfRandomString( $length = 32 ) {
275 $str = '';
276 for ( $n = 0; $n < $length; $n += 7 ) {
277 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
278 }
279 return substr( $str, 0, $length );
280 }
281
282 /**
283 * We want some things to be included as literal characters in our title URLs
284 * for prettiness, which urlencode encodes by default. According to RFC 1738,
285 * all of the following should be safe:
286 *
287 * ;:@&=$-_.+!*'(),
288 *
289 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
290 * character which should not be encoded. More importantly, google chrome
291 * always converts %7E back to ~, and converting it in this function can
292 * cause a redirect loop (T105265).
293 *
294 * But + is not safe because it's used to indicate a space; &= are only safe in
295 * paths and not in queries (and we don't distinguish here); ' seems kind of
296 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
297 * is reserved, we don't care. So the list we unescape is:
298 *
299 * ;:@$!*(),/~
300 *
301 * However, IIS7 redirects fail when the url contains a colon (see T24709),
302 * so no fancy : for IIS7.
303 *
304 * %2F in the page titles seems to fatally break for some reason.
305 *
306 * @param string $s
307 * @return string
308 */
309 function wfUrlencode( $s ) {
310 static $needle;
311
312 if ( is_null( $s ) ) {
313 // Reset $needle for testing.
314 $needle = null;
315 return '';
316 }
317
318 if ( is_null( $needle ) ) {
319 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
320 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
321 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
322 ) {
323 $needle[] = '%3A';
324 }
325 }
326
327 $s = urlencode( $s );
328 $s = str_ireplace(
329 $needle,
330 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
331 $s
332 );
333
334 return $s;
335 }
336
337 /**
338 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
339 * "days=7&limit=100". Options in the first array override options in the second.
340 * Options set to null or false will not be output.
341 *
342 * @param array $array1 ( String|Array )
343 * @param array|null $array2 ( String|Array )
344 * @param string $prefix
345 * @return string
346 */
347 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
348 if ( !is_null( $array2 ) ) {
349 $array1 = $array1 + $array2;
350 }
351
352 $cgi = '';
353 foreach ( $array1 as $key => $value ) {
354 if ( !is_null( $value ) && $value !== false ) {
355 if ( $cgi != '' ) {
356 $cgi .= '&';
357 }
358 if ( $prefix !== '' ) {
359 $key = $prefix . "[$key]";
360 }
361 if ( is_array( $value ) ) {
362 $firstTime = true;
363 foreach ( $value as $k => $v ) {
364 $cgi .= $firstTime ? '' : '&';
365 if ( is_array( $v ) ) {
366 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
367 } else {
368 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
369 }
370 $firstTime = false;
371 }
372 } else {
373 if ( is_object( $value ) ) {
374 $value = $value->__toString();
375 }
376 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
377 }
378 }
379 }
380 return $cgi;
381 }
382
383 /**
384 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
385 * its argument and returns the same string in array form. This allows compatibility
386 * with legacy functions that accept raw query strings instead of nice
387 * arrays. Of course, keys and values are urldecode()d.
388 *
389 * @param string $query Query string
390 * @return string[] Array version of input
391 */
392 function wfCgiToArray( $query ) {
393 if ( isset( $query[0] ) && $query[0] == '?' ) {
394 $query = substr( $query, 1 );
395 }
396 $bits = explode( '&', $query );
397 $ret = [];
398 foreach ( $bits as $bit ) {
399 if ( $bit === '' ) {
400 continue;
401 }
402 if ( strpos( $bit, '=' ) === false ) {
403 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
404 $key = $bit;
405 $value = '';
406 } else {
407 list( $key, $value ) = explode( '=', $bit );
408 }
409 $key = urldecode( $key );
410 $value = urldecode( $value );
411 if ( strpos( $key, '[' ) !== false ) {
412 $keys = array_reverse( explode( '[', $key ) );
413 $key = array_pop( $keys );
414 $temp = $value;
415 foreach ( $keys as $k ) {
416 $k = substr( $k, 0, -1 );
417 $temp = [ $k => $temp ];
418 }
419 if ( isset( $ret[$key] ) ) {
420 $ret[$key] = array_merge( $ret[$key], $temp );
421 } else {
422 $ret[$key] = $temp;
423 }
424 } else {
425 $ret[$key] = $value;
426 }
427 }
428 return $ret;
429 }
430
431 /**
432 * Append a query string to an existing URL, which may or may not already
433 * have query string parameters already. If so, they will be combined.
434 *
435 * @param string $url
436 * @param string|string[] $query String or associative array
437 * @return string
438 */
439 function wfAppendQuery( $url, $query ) {
440 if ( is_array( $query ) ) {
441 $query = wfArrayToCgi( $query );
442 }
443 if ( $query != '' ) {
444 // Remove the fragment, if there is one
445 $fragment = false;
446 $hashPos = strpos( $url, '#' );
447 if ( $hashPos !== false ) {
448 $fragment = substr( $url, $hashPos );
449 $url = substr( $url, 0, $hashPos );
450 }
451
452 // Add parameter
453 if ( strpos( $url, '?' ) === false ) {
454 $url .= '?';
455 } else {
456 $url .= '&';
457 }
458 $url .= $query;
459
460 // Put the fragment back
461 if ( $fragment !== false ) {
462 $url .= $fragment;
463 }
464 }
465 return $url;
466 }
467
468 /**
469 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
470 * is correct.
471 *
472 * The meaning of the PROTO_* constants is as follows:
473 * PROTO_HTTP: Output a URL starting with http://
474 * PROTO_HTTPS: Output a URL starting with https://
475 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
476 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
477 * on which protocol was used for the current incoming request
478 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
479 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
480 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
481 *
482 * @todo this won't work with current-path-relative URLs
483 * like "subdir/foo.html", etc.
484 *
485 * @param string $url Either fully-qualified or a local path + query
486 * @param string|int|null $defaultProto One of the PROTO_* constants. Determines the
487 * protocol to use if $url or $wgServer is protocol-relative
488 * @return string|false Fully-qualified URL, current-path-relative URL or false if
489 * no valid URL can be constructed
490 */
491 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT ) {
492 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
493 $wgHttpsPort;
494 if ( $defaultProto === PROTO_CANONICAL ) {
495 $serverUrl = $wgCanonicalServer;
496 } elseif ( $defaultProto === PROTO_INTERNAL && $wgInternalServer !== false ) {
497 // Make $wgInternalServer fall back to $wgServer if not set
498 $serverUrl = $wgInternalServer;
499 } else {
500 $serverUrl = $wgServer;
501 if ( $defaultProto === PROTO_CURRENT ) {
502 $defaultProto = $wgRequest->getProtocol() . '://';
503 }
504 }
505
506 // Analyze $serverUrl to obtain its protocol
507 $bits = wfParseUrl( $serverUrl );
508 $serverHasProto = $bits && $bits['scheme'] != '';
509
510 if ( $defaultProto === PROTO_CANONICAL || $defaultProto === PROTO_INTERNAL ) {
511 if ( $serverHasProto ) {
512 $defaultProto = $bits['scheme'] . '://';
513 } else {
514 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
515 // This really isn't supposed to happen. Fall back to HTTP in this
516 // ridiculous case.
517 $defaultProto = PROTO_HTTP;
518 }
519 }
520
521 $defaultProtoWithoutSlashes = $defaultProto !== null ? substr( $defaultProto, 0, -2 ) : '';
522
523 if ( substr( $url, 0, 2 ) == '//' ) {
524 $url = $defaultProtoWithoutSlashes . $url;
525 } elseif ( substr( $url, 0, 1 ) == '/' ) {
526 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
527 // otherwise leave it alone.
528 if ( $serverHasProto ) {
529 $url = $serverUrl . $url;
530 } else {
531 // If an HTTPS URL is synthesized from a protocol-relative $wgServer, allow the
532 // user to override the port number (T67184)
533 if ( $defaultProto === PROTO_HTTPS && $wgHttpsPort != 443 ) {
534 if ( isset( $bits['port'] ) ) {
535 throw new Exception( 'A protocol-relative $wgServer may not contain a port number' );
536 }
537 $url = $defaultProtoWithoutSlashes . $serverUrl . ':' . $wgHttpsPort . $url;
538 } else {
539 $url = $defaultProtoWithoutSlashes . $serverUrl . $url;
540 }
541 }
542 }
543
544 $bits = wfParseUrl( $url );
545
546 if ( $bits && isset( $bits['path'] ) ) {
547 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
548 return wfAssembleUrl( $bits );
549 } elseif ( $bits ) {
550 # No path to expand
551 return $url;
552 } elseif ( substr( $url, 0, 1 ) != '/' ) {
553 # URL is a relative path
554 return wfRemoveDotSegments( $url );
555 }
556
557 # Expanded URL is not valid.
558 return false;
559 }
560
561 /**
562 * Get the wiki's "server", i.e. the protocol and host part of the URL, with a
563 * protocol specified using a PROTO_* constant as in wfExpandUrl()
564 *
565 * @since 1.32
566 * @param string|int|null $proto One of the PROTO_* constants.
567 * @return string The URL
568 */
569 function wfGetServerUrl( $proto ) {
570 $url = wfExpandUrl( '/', $proto );
571 return substr( $url, 0, -1 );
572 }
573
574 /**
575 * This function will reassemble a URL parsed with wfParseURL. This is useful
576 * if you need to edit part of a URL and put it back together.
577 *
578 * This is the basic structure used (brackets contain keys for $urlParts):
579 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
580 *
581 * @todo Need to integrate this into wfExpandUrl (see T34168)
582 *
583 * @since 1.19
584 * @param array $urlParts URL parts, as output from wfParseUrl
585 * @return string URL assembled from its component parts
586 */
587 function wfAssembleUrl( $urlParts ) {
588 $result = '';
589
590 if ( isset( $urlParts['delimiter'] ) ) {
591 if ( isset( $urlParts['scheme'] ) ) {
592 $result .= $urlParts['scheme'];
593 }
594
595 $result .= $urlParts['delimiter'];
596 }
597
598 if ( isset( $urlParts['host'] ) ) {
599 if ( isset( $urlParts['user'] ) ) {
600 $result .= $urlParts['user'];
601 if ( isset( $urlParts['pass'] ) ) {
602 $result .= ':' . $urlParts['pass'];
603 }
604 $result .= '@';
605 }
606
607 $result .= $urlParts['host'];
608
609 if ( isset( $urlParts['port'] ) ) {
610 $result .= ':' . $urlParts['port'];
611 }
612 }
613
614 if ( isset( $urlParts['path'] ) ) {
615 $result .= $urlParts['path'];
616 }
617
618 if ( isset( $urlParts['query'] ) ) {
619 $result .= '?' . $urlParts['query'];
620 }
621
622 if ( isset( $urlParts['fragment'] ) ) {
623 $result .= '#' . $urlParts['fragment'];
624 }
625
626 return $result;
627 }
628
629 /**
630 * Remove all dot-segments in the provided URL path. For example,
631 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
632 * RFC3986 section 5.2.4.
633 *
634 * @todo Need to integrate this into wfExpandUrl (see T34168)
635 *
636 * @since 1.19
637 *
638 * @param string $urlPath URL path, potentially containing dot-segments
639 * @return string URL path with all dot-segments removed
640 */
641 function wfRemoveDotSegments( $urlPath ) {
642 $output = '';
643 $inputOffset = 0;
644 $inputLength = strlen( $urlPath );
645
646 while ( $inputOffset < $inputLength ) {
647 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
648 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
649 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
650 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
651 $trimOutput = false;
652
653 if ( $prefixLengthTwo == './' ) {
654 # Step A, remove leading "./"
655 $inputOffset += 2;
656 } elseif ( $prefixLengthThree == '../' ) {
657 # Step A, remove leading "../"
658 $inputOffset += 3;
659 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset + 2 == $inputLength ) ) {
660 # Step B, replace leading "/.$" with "/"
661 $inputOffset += 1;
662 $urlPath[$inputOffset] = '/';
663 } elseif ( $prefixLengthThree == '/./' ) {
664 # Step B, replace leading "/./" with "/"
665 $inputOffset += 2;
666 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset + 3 == $inputLength ) ) {
667 # Step C, replace leading "/..$" with "/" and
668 # remove last path component in output
669 $inputOffset += 2;
670 $urlPath[$inputOffset] = '/';
671 $trimOutput = true;
672 } elseif ( $prefixLengthFour == '/../' ) {
673 # Step C, replace leading "/../" with "/" and
674 # remove last path component in output
675 $inputOffset += 3;
676 $trimOutput = true;
677 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset + 1 == $inputLength ) ) {
678 # Step D, remove "^.$"
679 $inputOffset += 1;
680 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset + 2 == $inputLength ) ) {
681 # Step D, remove "^..$"
682 $inputOffset += 2;
683 } else {
684 # Step E, move leading path segment to output
685 if ( $prefixLengthOne == '/' ) {
686 $slashPos = strpos( $urlPath, '/', $inputOffset + 1 );
687 } else {
688 $slashPos = strpos( $urlPath, '/', $inputOffset );
689 }
690 if ( $slashPos === false ) {
691 $output .= substr( $urlPath, $inputOffset );
692 $inputOffset = $inputLength;
693 } else {
694 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
695 $inputOffset += $slashPos - $inputOffset;
696 }
697 }
698
699 if ( $trimOutput ) {
700 $slashPos = strrpos( $output, '/' );
701 if ( $slashPos === false ) {
702 $output = '';
703 } else {
704 $output = substr( $output, 0, $slashPos );
705 }
706 }
707 }
708
709 return $output;
710 }
711
712 /**
713 * Returns a regular expression of url protocols
714 *
715 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
716 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
717 * @return string
718 */
719 function wfUrlProtocols( $includeProtocolRelative = true ) {
720 global $wgUrlProtocols;
721
722 // Cache return values separately based on $includeProtocolRelative
723 static $withProtRel = null, $withoutProtRel = null;
724 $cachedValue = $includeProtocolRelative ? $withProtRel : $withoutProtRel;
725 if ( !is_null( $cachedValue ) ) {
726 return $cachedValue;
727 }
728
729 // Support old-style $wgUrlProtocols strings, for backwards compatibility
730 // with LocalSettings files from 1.5
731 if ( is_array( $wgUrlProtocols ) ) {
732 $protocols = [];
733 foreach ( $wgUrlProtocols as $protocol ) {
734 // Filter out '//' if !$includeProtocolRelative
735 if ( $includeProtocolRelative || $protocol !== '//' ) {
736 $protocols[] = preg_quote( $protocol, '/' );
737 }
738 }
739
740 $retval = implode( '|', $protocols );
741 } else {
742 // Ignore $includeProtocolRelative in this case
743 // This case exists for pre-1.6 compatibility, and we can safely assume
744 // that '//' won't appear in a pre-1.6 config because protocol-relative
745 // URLs weren't supported until 1.18
746 $retval = $wgUrlProtocols;
747 }
748
749 // Cache return value
750 if ( $includeProtocolRelative ) {
751 $withProtRel = $retval;
752 } else {
753 $withoutProtRel = $retval;
754 }
755 return $retval;
756 }
757
758 /**
759 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
760 * you need a regex that matches all URL protocols but does not match protocol-
761 * relative URLs
762 * @return string
763 */
764 function wfUrlProtocolsWithoutProtRel() {
765 return wfUrlProtocols( false );
766 }
767
768 /**
769 * parse_url() work-alike, but non-broken. Differences:
770 *
771 * 1) Does not raise warnings on bad URLs (just returns false).
772 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
773 * protocol-relative URLs) correctly.
774 * 3) Adds a "delimiter" element to the array (see (2)).
775 * 4) Verifies that the protocol is on the $wgUrlProtocols whitelist.
776 * 5) Rejects some invalid URLs that parse_url doesn't, e.g. the empty string or URLs starting with
777 * a line feed character.
778 *
779 * @param string $url A URL to parse
780 * @return string[]|bool Bits of the URL in an associative array, or false on failure.
781 * Possible fields:
782 * - scheme: URI scheme (protocol), e.g. 'http', 'mailto'. Lowercase, always present, but can
783 * be an empty string for protocol-relative URLs.
784 * - delimiter: either '://', ':' or '//'. Always present.
785 * - host: domain name / IP. Always present, but could be an empty string, e.g. for file: URLs.
786 * - user: user name, e.g. for HTTP Basic auth URLs such as http://user:pass@example.com/
787 * Missing when there is no username.
788 * - pass: password, same as above.
789 * - path: path including the leading /. Will be missing when empty (e.g. 'http://example.com')
790 * - query: query string (as a string; see wfCgiToArray() for parsing it), can be missing.
791 * - fragment: the part after #, can be missing.
792 */
793 function wfParseUrl( $url ) {
794 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
795
796 // Protocol-relative URLs are handled really badly by parse_url(). It's so
797 // bad that the easiest way to handle them is to just prepend 'http:' and
798 // strip the protocol out later.
799 $wasRelative = substr( $url, 0, 2 ) == '//';
800 if ( $wasRelative ) {
801 $url = "http:$url";
802 }
803 AtEase::suppressWarnings();
804 $bits = parse_url( $url );
805 AtEase::restoreWarnings();
806 // parse_url() returns an array without scheme for some invalid URLs, e.g.
807 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
808 if ( !$bits || !isset( $bits['scheme'] ) ) {
809 return false;
810 }
811
812 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
813 $bits['scheme'] = strtolower( $bits['scheme'] );
814
815 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
816 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
817 $bits['delimiter'] = '://';
818 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
819 $bits['delimiter'] = ':';
820 // parse_url detects for news: and mailto: the host part of an url as path
821 // We have to correct this wrong detection
822 if ( isset( $bits['path'] ) ) {
823 $bits['host'] = $bits['path'];
824 $bits['path'] = '';
825 }
826 } else {
827 return false;
828 }
829
830 /* Provide an empty host for eg. file:/// urls (see T30627) */
831 if ( !isset( $bits['host'] ) ) {
832 $bits['host'] = '';
833
834 // See T47069
835 if ( isset( $bits['path'] ) ) {
836 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
837 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
838 $bits['path'] = '/' . $bits['path'];
839 }
840 } else {
841 $bits['path'] = '';
842 }
843 }
844
845 // If the URL was protocol-relative, fix scheme and delimiter
846 if ( $wasRelative ) {
847 $bits['scheme'] = '';
848 $bits['delimiter'] = '//';
849 }
850 return $bits;
851 }
852
853 /**
854 * Take a URL, make sure it's expanded to fully qualified, and replace any
855 * encoded non-ASCII Unicode characters with their UTF-8 original forms
856 * for more compact display and legibility for local audiences.
857 *
858 * @todo handle punycode domains too
859 *
860 * @param string $url
861 * @return string
862 */
863 function wfExpandIRI( $url ) {
864 return preg_replace_callback(
865 '/((?:%[89A-F][0-9A-F])+)/i',
866 function ( array $matches ) {
867 return urldecode( $matches[1] );
868 },
869 wfExpandUrl( $url )
870 );
871 }
872
873 /**
874 * Check whether a given URL has a domain that occurs in a given set of domains
875 * @param string $url
876 * @param array $domains Array of domains (strings)
877 * @return bool True if the host part of $url ends in one of the strings in $domains
878 */
879 function wfMatchesDomainList( $url, $domains ) {
880 $bits = wfParseUrl( $url );
881 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
882 $host = '.' . $bits['host'];
883 foreach ( (array)$domains as $domain ) {
884 $domain = '.' . $domain;
885 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
886 return true;
887 }
888 }
889 }
890 return false;
891 }
892
893 /**
894 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
895 * In normal operation this is a NOP.
896 *
897 * Controlling globals:
898 * $wgDebugLogFile - points to the log file
899 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
900 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
901 *
902 * @since 1.25 support for additional context data
903 *
904 * @param string $text
905 * @param string|bool $dest Destination of the message:
906 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
907 * - 'private': excluded from HTML output
908 * For backward compatibility, it can also take a boolean:
909 * - true: same as 'all'
910 * - false: same as 'private'
911 * @param array $context Additional logging context data
912 */
913 function wfDebug( $text, $dest = 'all', array $context = [] ) {
914 global $wgDebugRawPage, $wgDebugLogPrefix;
915 global $wgDebugTimestamps;
916
917 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
918 return;
919 }
920
921 $text = trim( $text );
922
923 if ( $wgDebugTimestamps ) {
924 $context['seconds_elapsed'] = sprintf(
925 '%6.4f',
926 microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT']
927 );
928 $context['memory_used'] = sprintf(
929 '%5.1fM',
930 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
931 );
932 }
933
934 if ( $wgDebugLogPrefix !== '' ) {
935 $context['prefix'] = $wgDebugLogPrefix;
936 }
937 $context['private'] = ( $dest === false || $dest === 'private' );
938
939 $logger = LoggerFactory::getInstance( 'wfDebug' );
940 $logger->debug( $text, $context );
941 }
942
943 /**
944 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
945 * @return bool
946 */
947 function wfIsDebugRawPage() {
948 static $cache;
949 if ( $cache !== null ) {
950 return $cache;
951 }
952 // Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
953 // phpcs:ignore MediaWiki.Usage.SuperGlobalsUsage.SuperGlobals
954 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
955 || (
956 isset( $_SERVER['SCRIPT_NAME'] )
957 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
958 )
959 ) {
960 $cache = true;
961 } else {
962 $cache = false;
963 }
964 return $cache;
965 }
966
967 /**
968 * Send a line giving PHP memory usage.
969 *
970 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
971 */
972 function wfDebugMem( $exact = false ) {
973 $mem = memory_get_usage();
974 if ( !$exact ) {
975 $mem = floor( $mem / 1024 ) . ' KiB';
976 } else {
977 $mem .= ' B';
978 }
979 wfDebug( "Memory usage: $mem\n" );
980 }
981
982 /**
983 * Send a line to a supplementary debug log file, if configured, or main debug
984 * log if not.
985 *
986 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
987 * a string filename or an associative array mapping 'destination' to the
988 * desired filename. The associative array may also contain a 'sample' key
989 * with an integer value, specifying a sampling factor. Sampled log events
990 * will be emitted with a 1 in N random chance.
991 *
992 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
993 * @since 1.25 support for additional context data
994 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
995 *
996 * @param string $logGroup
997 * @param string $text
998 * @param string|bool $dest Destination of the message:
999 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1000 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1001 * discarded otherwise
1002 * For backward compatibility, it can also take a boolean:
1003 * - true: same as 'all'
1004 * - false: same as 'private'
1005 * @param array $context Additional logging context data
1006 */
1007 function wfDebugLog(
1008 $logGroup, $text, $dest = 'all', array $context = []
1009 ) {
1010 $text = trim( $text );
1011
1012 $logger = LoggerFactory::getInstance( $logGroup );
1013 $context['private'] = ( $dest === false || $dest === 'private' );
1014 $logger->info( $text, $context );
1015 }
1016
1017 /**
1018 * Log for database errors
1019 *
1020 * @since 1.25 support for additional context data
1021 *
1022 * @param string $text Database error message.
1023 * @param array $context Additional logging context data
1024 */
1025 function wfLogDBError( $text, array $context = [] ) {
1026 $logger = LoggerFactory::getInstance( 'wfLogDBError' );
1027 $logger->error( trim( $text ), $context );
1028 }
1029
1030 /**
1031 * Throws a warning that $function is deprecated
1032 *
1033 * @param string $function Function that is deprecated.
1034 * @param string|bool $version Version of MediaWiki that the function
1035 * was deprecated in (Added in 1.19).
1036 * @param string|bool $component Component to which the function belongs.
1037 * If false, it is assumed the function is in MediaWiki core (Added in 1.19).
1038 * @param int $callerOffset How far up the call stack is the original
1039 * caller. 2 = function that called the function that called
1040 * wfDeprecated (Added in 1.20).
1041 *
1042 * @throws Exception If the MediaWiki version number is not a string or boolean.
1043 */
1044 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1045 if ( is_string( $version ) || is_bool( $version ) ) {
1046 MWDebug::deprecated( $function, $version, $component, $callerOffset + 1 );
1047 } else {
1048 throw new Exception(
1049 "MediaWiki version must either be a string or a boolean. " .
1050 "Example valid version: '1.33'"
1051 );
1052 }
1053 }
1054
1055 /**
1056 * Send a warning either to the debug log or in a PHP error depending on
1057 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1058 *
1059 * @param string $msg Message to send
1060 * @param int $callerOffset Number of items to go back in the backtrace to
1061 * find the correct caller (1 = function calling wfWarn, ...)
1062 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1063 * only used when $wgDevelopmentWarnings is true
1064 */
1065 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE ) {
1066 MWDebug::warning( $msg, $callerOffset + 1, $level, 'auto' );
1067 }
1068
1069 /**
1070 * Send a warning as a PHP error and the debug log. This is intended for logging
1071 * warnings in production. For logging development warnings, use WfWarn instead.
1072 *
1073 * @param string $msg Message to send
1074 * @param int $callerOffset Number of items to go back in the backtrace to
1075 * find the correct caller (1 = function calling wfLogWarning, ...)
1076 * @param int $level PHP error level; defaults to E_USER_WARNING
1077 */
1078 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING ) {
1079 MWDebug::warning( $msg, $callerOffset + 1, $level, 'production' );
1080 }
1081
1082 /**
1083 * @todo document
1084 * @todo Move logic to MediaWiki.php
1085 */
1086 function wfLogProfilingData() {
1087 global $wgDebugLogGroups, $wgDebugRawPage;
1088
1089 $context = RequestContext::getMain();
1090 $request = $context->getRequest();
1091
1092 $profiler = Profiler::instance();
1093 $profiler->setContext( $context );
1094 $profiler->logData();
1095
1096 // Send out any buffered statsd metrics as needed
1097 MediaWiki::emitBufferedStatsdData(
1098 MediaWikiServices::getInstance()->getStatsdDataFactory(),
1099 $context->getConfig()
1100 );
1101
1102 // Profiling must actually be enabled...
1103 if ( $profiler instanceof ProfilerStub ) {
1104 return;
1105 }
1106
1107 if ( isset( $wgDebugLogGroups['profileoutput'] )
1108 && $wgDebugLogGroups['profileoutput'] === false
1109 ) {
1110 // Explicitly disabled
1111 return;
1112 }
1113 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1114 return;
1115 }
1116
1117 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1118 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1119 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1120 }
1121 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1122 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1123 }
1124 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1125 $ctx['from'] = $_SERVER['HTTP_FROM'];
1126 }
1127 if ( isset( $ctx['forwarded_for'] ) ||
1128 isset( $ctx['client_ip'] ) ||
1129 isset( $ctx['from'] ) ) {
1130 // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
1131 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1132 }
1133
1134 // Don't load $wgUser at this late stage just for statistics purposes
1135 // @todo FIXME: We can detect some anons even if it is not loaded.
1136 // See User::getId()
1137 $user = $context->getUser();
1138 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1139
1140 // Command line script uses a FauxRequest object which does not have
1141 // any knowledge about an URL and throw an exception instead.
1142 try {
1143 $ctx['url'] = urldecode( $request->getRequestURL() );
1144 } catch ( Exception $ignored ) {
1145 // no-op
1146 }
1147
1148 $ctx['output'] = $profiler->getOutput();
1149
1150 $log = LoggerFactory::getInstance( 'profileoutput' );
1151 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1152 }
1153
1154 /**
1155 * Increment a statistics counter
1156 *
1157 * @param string $key
1158 * @param int $count
1159 * @return void
1160 */
1161 function wfIncrStats( $key, $count = 1 ) {
1162 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
1163 $stats->updateCount( $key, $count );
1164 }
1165
1166 /**
1167 * Check whether the wiki is in read-only mode.
1168 *
1169 * @return bool
1170 */
1171 function wfReadOnly() {
1172 return MediaWikiServices::getInstance()->getReadOnlyMode()
1173 ->isReadOnly();
1174 }
1175
1176 /**
1177 * Check if the site is in read-only mode and return the message if so
1178 *
1179 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1180 * for replica DB lag. This may result in DB connection being made.
1181 *
1182 * @return string|bool String when in read-only mode; false otherwise
1183 */
1184 function wfReadOnlyReason() {
1185 return MediaWikiServices::getInstance()->getReadOnlyMode()
1186 ->getReason();
1187 }
1188
1189 /**
1190 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1191 *
1192 * @return string|bool String when in read-only mode; false otherwise
1193 * @since 1.27
1194 */
1195 function wfConfiguredReadOnlyReason() {
1196 return MediaWikiServices::getInstance()->getConfiguredReadOnlyMode()
1197 ->getReason();
1198 }
1199
1200 /**
1201 * Return a Language object from $langcode
1202 *
1203 * @param Language|string|bool $langcode Either:
1204 * - a Language object
1205 * - code of the language to get the message for, if it is
1206 * a valid code create a language for that language, if
1207 * it is a string but not a valid code then make a basic
1208 * language object
1209 * - a boolean: if it's false then use the global object for
1210 * the current user's language (as a fallback for the old parameter
1211 * functionality), or if it is true then use global object
1212 * for the wiki's content language.
1213 * @return Language
1214 */
1215 function wfGetLangObj( $langcode = false ) {
1216 # Identify which language to get or create a language object for.
1217 # Using is_object here due to Stub objects.
1218 if ( is_object( $langcode ) ) {
1219 # Great, we already have the object (hopefully)!
1220 return $langcode;
1221 }
1222
1223 global $wgLanguageCode;
1224 if ( $langcode === true || $langcode === $wgLanguageCode ) {
1225 # $langcode is the language code of the wikis content language object.
1226 # or it is a boolean and value is true
1227 return MediaWikiServices::getInstance()->getContentLanguage();
1228 }
1229
1230 global $wgLang;
1231 if ( $langcode === false || $langcode === $wgLang->getCode() ) {
1232 # $langcode is the language code of user language object.
1233 # or it was a boolean and value is false
1234 return $wgLang;
1235 }
1236
1237 $validCodes = array_keys( Language::fetchLanguageNames() );
1238 if ( in_array( $langcode, $validCodes ) ) {
1239 # $langcode corresponds to a valid language.
1240 return Language::factory( $langcode );
1241 }
1242
1243 # $langcode is a string, but not a valid language code; use content language.
1244 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1245 return MediaWikiServices::getInstance()->getContentLanguage();
1246 }
1247
1248 /**
1249 * This is the function for getting translated interface messages.
1250 *
1251 * @see Message class for documentation how to use them.
1252 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1253 *
1254 * This function replaces all old wfMsg* functions.
1255 *
1256 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1257 * @param string|string[] ...$params Normal message parameters
1258 * @return Message
1259 *
1260 * @since 1.17
1261 *
1262 * @see Message::__construct
1263 */
1264 function wfMessage( $key, ...$params ) {
1265 $message = new Message( $key );
1266
1267 // We call Message::params() to reduce code duplication
1268 if ( $params ) {
1269 $message->params( ...$params );
1270 }
1271
1272 return $message;
1273 }
1274
1275 /**
1276 * This function accepts multiple message keys and returns a message instance
1277 * for the first message which is non-empty. If all messages are empty then an
1278 * instance of the first message key is returned.
1279 *
1280 * @param string ...$keys Message keys
1281 * @return Message
1282 *
1283 * @since 1.18
1284 *
1285 * @see Message::newFallbackSequence
1286 */
1287 function wfMessageFallback( ...$keys ) {
1288 return Message::newFallbackSequence( ...$keys );
1289 }
1290
1291 /**
1292 * Replace message parameter keys on the given formatted output.
1293 *
1294 * @param string $message
1295 * @param array $args
1296 * @return string
1297 * @private
1298 */
1299 function wfMsgReplaceArgs( $message, $args ) {
1300 # Fix windows line-endings
1301 # Some messages are split with explode("\n", $msg)
1302 $message = str_replace( "\r", '', $message );
1303
1304 // Replace arguments
1305 if ( is_array( $args ) && $args ) {
1306 if ( is_array( $args[0] ) ) {
1307 $args = array_values( $args[0] );
1308 }
1309 $replacementKeys = [];
1310 foreach ( $args as $n => $param ) {
1311 $replacementKeys['$' . ( $n + 1 )] = $param;
1312 }
1313 $message = strtr( $message, $replacementKeys );
1314 }
1315
1316 return $message;
1317 }
1318
1319 /**
1320 * Fetch server name for use in error reporting etc.
1321 * Use real server name if available, so we know which machine
1322 * in a server farm generated the current page.
1323 *
1324 * @return string
1325 */
1326 function wfHostname() {
1327 static $host;
1328 if ( is_null( $host ) ) {
1329 # Hostname overriding
1330 global $wgOverrideHostname;
1331 if ( $wgOverrideHostname !== false ) {
1332 # Set static and skip any detection
1333 $host = $wgOverrideHostname;
1334 return $host;
1335 }
1336
1337 if ( function_exists( 'posix_uname' ) ) {
1338 // This function not present on Windows
1339 $uname = posix_uname();
1340 } else {
1341 $uname = false;
1342 }
1343 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1344 $host = $uname['nodename'];
1345 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1346 # Windows computer name
1347 $host = getenv( 'COMPUTERNAME' );
1348 } else {
1349 # This may be a virtual server.
1350 $host = $_SERVER['SERVER_NAME'];
1351 }
1352 }
1353 return $host;
1354 }
1355
1356 /**
1357 * Returns a script tag that stores the amount of time it took MediaWiki to
1358 * handle the request in milliseconds as 'wgBackendResponseTime'.
1359 *
1360 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1361 * hostname of the server handling the request.
1362 *
1363 * @param string|null $nonce Value from OutputPage::getCSPNonce
1364 * @return string|WrappedString HTML
1365 */
1366 function wfReportTime( $nonce = null ) {
1367 global $wgShowHostnames;
1368
1369 $elapsed = ( microtime( true ) - $_SERVER['REQUEST_TIME_FLOAT'] );
1370 // seconds to milliseconds
1371 $responseTime = round( $elapsed * 1000 );
1372 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1373 if ( $wgShowHostnames ) {
1374 $reportVars['wgHostname'] = wfHostname();
1375 }
1376 return Skin::makeVariablesScript( $reportVars, $nonce );
1377 }
1378
1379 /**
1380 * Safety wrapper for debug_backtrace().
1381 *
1382 * Will return an empty array if debug_backtrace is disabled, otherwise
1383 * the output from debug_backtrace() (trimmed).
1384 *
1385 * @param int $limit This parameter can be used to limit the number of stack frames returned
1386 *
1387 * @return array Array of backtrace information
1388 */
1389 function wfDebugBacktrace( $limit = 0 ) {
1390 static $disabled = null;
1391
1392 if ( is_null( $disabled ) ) {
1393 $disabled = !function_exists( 'debug_backtrace' );
1394 if ( $disabled ) {
1395 wfDebug( "debug_backtrace() is disabled\n" );
1396 }
1397 }
1398 if ( $disabled ) {
1399 return [];
1400 }
1401
1402 if ( $limit ) {
1403 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT, $limit + 1 ), 1 );
1404 } else {
1405 return array_slice( debug_backtrace(), 1 );
1406 }
1407 }
1408
1409 /**
1410 * Get a debug backtrace as a string
1411 *
1412 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1413 * Defaults to $wgCommandLineMode if unset.
1414 * @return string
1415 * @since 1.25 Supports $raw parameter.
1416 */
1417 function wfBacktrace( $raw = null ) {
1418 global $wgCommandLineMode;
1419
1420 if ( $raw === null ) {
1421 $raw = $wgCommandLineMode;
1422 }
1423
1424 if ( $raw ) {
1425 $frameFormat = "%s line %s calls %s()\n";
1426 $traceFormat = "%s";
1427 } else {
1428 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1429 $traceFormat = "<ul>\n%s</ul>\n";
1430 }
1431
1432 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1433 $file = !empty( $frame['file'] ) ? basename( $frame['file'] ) : '-';
1434 $line = $frame['line'] ?? '-';
1435 $call = $frame['function'];
1436 if ( !empty( $frame['class'] ) ) {
1437 $call = $frame['class'] . $frame['type'] . $call;
1438 }
1439 return sprintf( $frameFormat, $file, $line, $call );
1440 }, wfDebugBacktrace() );
1441
1442 return sprintf( $traceFormat, implode( '', $frames ) );
1443 }
1444
1445 /**
1446 * Get the name of the function which called this function
1447 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1448 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1449 * wfGetCaller( 3 ) is the parent of that.
1450 *
1451 * @param int $level
1452 * @return string
1453 */
1454 function wfGetCaller( $level = 2 ) {
1455 $backtrace = wfDebugBacktrace( $level + 1 );
1456 if ( isset( $backtrace[$level] ) ) {
1457 return wfFormatStackFrame( $backtrace[$level] );
1458 } else {
1459 return 'unknown';
1460 }
1461 }
1462
1463 /**
1464 * Return a string consisting of callers in the stack. Useful sometimes
1465 * for profiling specific points.
1466 *
1467 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1468 * @return string
1469 */
1470 function wfGetAllCallers( $limit = 3 ) {
1471 $trace = array_reverse( wfDebugBacktrace() );
1472 if ( !$limit || $limit > count( $trace ) - 1 ) {
1473 $limit = count( $trace ) - 1;
1474 }
1475 $trace = array_slice( $trace, -$limit - 1, $limit );
1476 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1477 }
1478
1479 /**
1480 * Return a string representation of frame
1481 *
1482 * @param array $frame
1483 * @return string
1484 */
1485 function wfFormatStackFrame( $frame ) {
1486 if ( !isset( $frame['function'] ) ) {
1487 return 'NO_FUNCTION_GIVEN';
1488 }
1489 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1490 $frame['class'] . $frame['type'] . $frame['function'] :
1491 $frame['function'];
1492 }
1493
1494 /* Some generic result counters, pulled out of SearchEngine */
1495
1496 /**
1497 * @todo document
1498 *
1499 * @param int $offset
1500 * @param int $limit
1501 * @return string
1502 */
1503 function wfShowingResults( $offset, $limit ) {
1504 return wfMessage( 'showingresults' )->numParams( $limit, $offset + 1 )->parse();
1505 }
1506
1507 /**
1508 * Whether the client accept gzip encoding
1509 *
1510 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1511 * Use this when considering to send a gzip-encoded response to the client.
1512 *
1513 * @param bool $force Forces another check even if we already have a cached result.
1514 * @return bool
1515 */
1516 function wfClientAcceptsGzip( $force = false ) {
1517 static $result = null;
1518 if ( $result === null || $force ) {
1519 $result = false;
1520 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1521 # @todo FIXME: We may want to blacklist some broken browsers
1522 $m = [];
1523 if ( preg_match(
1524 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1525 $_SERVER['HTTP_ACCEPT_ENCODING'],
1526 $m
1527 )
1528 ) {
1529 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1530 $result = false;
1531 return $result;
1532 }
1533 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1534 $result = true;
1535 }
1536 }
1537 }
1538 return $result;
1539 }
1540
1541 /**
1542 * Escapes the given text so that it may be output using addWikiText()
1543 * without any linking, formatting, etc. making its way through. This
1544 * is achieved by substituting certain characters with HTML entities.
1545 * As required by the callers, "<nowiki>" is not used.
1546 *
1547 * @param string $text Text to be escaped
1548 * @param-taint $text escapes_html
1549 * @return string
1550 */
1551 function wfEscapeWikiText( $text ) {
1552 global $wgEnableMagicLinks;
1553 static $repl = null, $repl2 = null;
1554 if ( $repl === null || defined( 'MW_PARSER_TEST' ) || defined( 'MW_PHPUNIT_TEST' ) ) {
1555 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1556 // in those situations
1557 $repl = [
1558 '"' => '&#34;', '&' => '&#38;', "'" => '&#39;', '<' => '&#60;',
1559 '=' => '&#61;', '>' => '&#62;', '[' => '&#91;', ']' => '&#93;',
1560 '{' => '&#123;', '|' => '&#124;', '}' => '&#125;', ';' => '&#59;',
1561 "\n#" => "\n&#35;", "\r#" => "\r&#35;",
1562 "\n*" => "\n&#42;", "\r*" => "\r&#42;",
1563 "\n:" => "\n&#58;", "\r:" => "\r&#58;",
1564 "\n " => "\n&#32;", "\r " => "\r&#32;",
1565 "\n\n" => "\n&#10;", "\r\n" => "&#13;\n",
1566 "\n\r" => "\n&#13;", "\r\r" => "\r&#13;",
1567 "\n\t" => "\n&#9;", "\r\t" => "\r&#9;", // "\n\t\n" is treated like "\n\n"
1568 "\n----" => "\n&#45;---", "\r----" => "\r&#45;---",
1569 '__' => '_&#95;', '://' => '&#58;//',
1570 ];
1571
1572 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1573 // We have to catch everything "\s" matches in PCRE
1574 foreach ( $magicLinks as $magic ) {
1575 $repl["$magic "] = "$magic&#32;";
1576 $repl["$magic\t"] = "$magic&#9;";
1577 $repl["$magic\r"] = "$magic&#13;";
1578 $repl["$magic\n"] = "$magic&#10;";
1579 $repl["$magic\f"] = "$magic&#12;";
1580 }
1581
1582 // And handle protocols that don't use "://"
1583 global $wgUrlProtocols;
1584 $repl2 = [];
1585 foreach ( $wgUrlProtocols as $prot ) {
1586 if ( substr( $prot, -1 ) === ':' ) {
1587 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1588 }
1589 }
1590 $repl2 = $repl2 ? '/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1591 }
1592 $text = substr( strtr( "\n$text", $repl ), 1 );
1593 $text = preg_replace( $repl2, '$1&#58;', $text );
1594 return $text;
1595 }
1596
1597 /**
1598 * Sets dest to source and returns the original value of dest
1599 * If source is NULL, it just returns the value, it doesn't set the variable
1600 * If force is true, it will set the value even if source is NULL
1601 *
1602 * @param mixed &$dest
1603 * @param mixed $source
1604 * @param bool $force
1605 * @return mixed
1606 */
1607 function wfSetVar( &$dest, $source, $force = false ) {
1608 $temp = $dest;
1609 if ( !is_null( $source ) || $force ) {
1610 $dest = $source;
1611 }
1612 return $temp;
1613 }
1614
1615 /**
1616 * As for wfSetVar except setting a bit
1617 *
1618 * @param int &$dest
1619 * @param int $bit
1620 * @param bool $state
1621 *
1622 * @return bool
1623 */
1624 function wfSetBit( &$dest, $bit, $state = true ) {
1625 $temp = (bool)( $dest & $bit );
1626 if ( !is_null( $state ) ) {
1627 if ( $state ) {
1628 $dest |= $bit;
1629 } else {
1630 $dest &= ~$bit;
1631 }
1632 }
1633 return $temp;
1634 }
1635
1636 /**
1637 * A wrapper around the PHP function var_export().
1638 * Either print it or add it to the regular output ($wgOut).
1639 *
1640 * @param mixed $var A PHP variable to dump.
1641 */
1642 function wfVarDump( $var ) {
1643 global $wgOut;
1644 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1645 if ( headers_sent() || !isset( $wgOut ) || !is_object( $wgOut ) ) {
1646 print $s;
1647 } else {
1648 $wgOut->addHTML( $s );
1649 }
1650 }
1651
1652 /**
1653 * Provide a simple HTTP error.
1654 *
1655 * @param int|string $code
1656 * @param string $label
1657 * @param string $desc
1658 */
1659 function wfHttpError( $code, $label, $desc ) {
1660 global $wgOut;
1661 HttpStatus::header( $code );
1662 if ( $wgOut ) {
1663 $wgOut->disable();
1664 $wgOut->sendCacheControl();
1665 }
1666
1667 MediaWiki\HeaderCallback::warnIfHeadersSent();
1668 header( 'Content-type: text/html; charset=utf-8' );
1669 print '<!DOCTYPE html>' .
1670 '<html><head><title>' .
1671 htmlspecialchars( $label ) .
1672 '</title></head><body><h1>' .
1673 htmlspecialchars( $label ) .
1674 '</h1><p>' .
1675 nl2br( htmlspecialchars( $desc ) ) .
1676 "</p></body></html>\n";
1677 }
1678
1679 /**
1680 * Clear away any user-level output buffers, discarding contents.
1681 *
1682 * Suitable for 'starting afresh', for instance when streaming
1683 * relatively large amounts of data without buffering, or wanting to
1684 * output image files without ob_gzhandler's compression.
1685 *
1686 * The optional $resetGzipEncoding parameter controls suppression of
1687 * the Content-Encoding header sent by ob_gzhandler; by default it
1688 * is left. See comments for wfClearOutputBuffers() for why it would
1689 * be used.
1690 *
1691 * Note that some PHP configuration options may add output buffer
1692 * layers which cannot be removed; these are left in place.
1693 *
1694 * @param bool $resetGzipEncoding
1695 */
1696 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1697 if ( $resetGzipEncoding ) {
1698 // Suppress Content-Encoding and Content-Length
1699 // headers from OutputHandler::handle.
1700 global $wgDisableOutputCompression;
1701 $wgDisableOutputCompression = true;
1702 }
1703 while ( $status = ob_get_status() ) {
1704 if ( isset( $status['flags'] ) ) {
1705 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE;
1706 $deleteable = ( $status['flags'] & $flags ) === $flags;
1707 } elseif ( isset( $status['del'] ) ) {
1708 $deleteable = $status['del'];
1709 } else {
1710 // Guess that any PHP-internal setting can't be removed.
1711 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1712 }
1713 if ( !$deleteable ) {
1714 // Give up, and hope the result doesn't break
1715 // output behavior.
1716 break;
1717 }
1718 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1719 // Unit testing barrier to prevent this function from breaking PHPUnit.
1720 break;
1721 }
1722 if ( !ob_end_clean() ) {
1723 // Could not remove output buffer handler; abort now
1724 // to avoid getting in some kind of infinite loop.
1725 break;
1726 }
1727 if ( $resetGzipEncoding && $status['name'] == 'ob_gzhandler' ) {
1728 // Reset the 'Content-Encoding' field set by this handler
1729 // so we can start fresh.
1730 header_remove( 'Content-Encoding' );
1731 break;
1732 }
1733 }
1734 }
1735
1736 /**
1737 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1738 *
1739 * Clear away output buffers, but keep the Content-Encoding header
1740 * produced by ob_gzhandler, if any.
1741 *
1742 * This should be used for HTTP 304 responses, where you need to
1743 * preserve the Content-Encoding header of the real result, but
1744 * also need to suppress the output of ob_gzhandler to keep to spec
1745 * and avoid breaking Firefox in rare cases where the headers and
1746 * body are broken over two packets.
1747 */
1748 function wfClearOutputBuffers() {
1749 wfResetOutputBuffers( false );
1750 }
1751
1752 /**
1753 * Converts an Accept-* header into an array mapping string values to quality
1754 * factors
1755 *
1756 * @param string $accept
1757 * @param string $def Default
1758 * @return float[] Associative array of string => float pairs
1759 */
1760 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1761 # No arg means accept anything (per HTTP spec)
1762 if ( !$accept ) {
1763 return [ $def => 1.0 ];
1764 }
1765
1766 $prefs = [];
1767
1768 $parts = explode( ',', $accept );
1769
1770 foreach ( $parts as $part ) {
1771 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1772 $values = explode( ';', trim( $part ) );
1773 $match = [];
1774 if ( count( $values ) == 1 ) {
1775 $prefs[$values[0]] = 1.0;
1776 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1777 $prefs[$values[0]] = floatval( $match[1] );
1778 }
1779 }
1780
1781 return $prefs;
1782 }
1783
1784 /**
1785 * Checks if a given MIME type matches any of the keys in the given
1786 * array. Basic wildcards are accepted in the array keys.
1787 *
1788 * Returns the matching MIME type (or wildcard) if a match, otherwise
1789 * NULL if no match.
1790 *
1791 * @param string $type
1792 * @param array $avail
1793 * @return string
1794 * @private
1795 */
1796 function mimeTypeMatch( $type, $avail ) {
1797 if ( array_key_exists( $type, $avail ) ) {
1798 return $type;
1799 } else {
1800 $mainType = explode( '/', $type )[0];
1801 if ( array_key_exists( "$mainType/*", $avail ) ) {
1802 return "$mainType/*";
1803 } elseif ( array_key_exists( '*/*', $avail ) ) {
1804 return '*/*';
1805 } else {
1806 return null;
1807 }
1808 }
1809 }
1810
1811 /**
1812 * Returns the 'best' match between a client's requested internet media types
1813 * and the server's list of available types. Each list should be an associative
1814 * array of type to preference (preference is a float between 0.0 and 1.0).
1815 * Wildcards in the types are acceptable.
1816 *
1817 * @param array $cprefs Client's acceptable type list
1818 * @param array $sprefs Server's offered types
1819 * @return string|null
1820 *
1821 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1822 * XXX: generalize to negotiate other stuff
1823 * @todo The function appears unused. Is it worth to keep?
1824 */
1825 function wfNegotiateType( $cprefs, $sprefs ) {
1826 $combine = [];
1827
1828 foreach ( array_keys( $sprefs ) as $type ) {
1829 $subType = explode( '/', $type )[1];
1830 if ( $subType != '*' ) {
1831 $ckey = mimeTypeMatch( $type, $cprefs );
1832 if ( $ckey ) {
1833 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1834 }
1835 }
1836 }
1837
1838 foreach ( array_keys( $cprefs ) as $type ) {
1839 $subType = explode( '/', $type )[1];
1840 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1841 $skey = mimeTypeMatch( $type, $sprefs );
1842 if ( $skey ) {
1843 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1844 }
1845 }
1846 }
1847
1848 $bestq = 0;
1849 $besttype = null;
1850
1851 foreach ( array_keys( $combine ) as $type ) {
1852 if ( $combine[$type] > $bestq ) {
1853 $besttype = $type;
1854 $bestq = $combine[$type];
1855 }
1856 }
1857
1858 return $besttype;
1859 }
1860
1861 /**
1862 * Get a timestamp string in one of various formats
1863 *
1864 * @param mixed $outputtype A timestamp in one of the supported formats, the
1865 * function will autodetect which format is supplied and act accordingly.
1866 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
1867 * @return string|bool String / false The same date in the format specified in $outputtype or false
1868 */
1869 function wfTimestamp( $outputtype = TS_UNIX, $ts = 0 ) {
1870 $ret = MWTimestamp::convert( $outputtype, $ts );
1871 if ( $ret === false ) {
1872 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
1873 }
1874 return $ret;
1875 }
1876
1877 /**
1878 * Return a formatted timestamp, or null if input is null.
1879 * For dealing with nullable timestamp columns in the database.
1880 *
1881 * @param int $outputtype
1882 * @param string|null $ts
1883 * @return string
1884 */
1885 function wfTimestampOrNull( $outputtype = TS_UNIX, $ts = null ) {
1886 if ( is_null( $ts ) ) {
1887 return null;
1888 } else {
1889 return wfTimestamp( $outputtype, $ts );
1890 }
1891 }
1892
1893 /**
1894 * Convenience function; returns MediaWiki timestamp for the present time.
1895 *
1896 * @return string TS_MW timestamp
1897 */
1898 function wfTimestampNow() {
1899 return MWTimestamp::now( TS_MW );
1900 }
1901
1902 /**
1903 * Check if the operating system is Windows
1904 *
1905 * @return bool True if it's Windows, false otherwise.
1906 */
1907 function wfIsWindows() {
1908 static $isWindows = null;
1909 if ( $isWindows === null ) {
1910 $isWindows = strtoupper( substr( PHP_OS, 0, 3 ) ) === 'WIN';
1911 }
1912 return $isWindows;
1913 }
1914
1915 /**
1916 * Check if we are running under HHVM
1917 *
1918 * @deprecated since 1.34, HHVM is no longer supported
1919 * @return bool
1920 */
1921 function wfIsHHVM() {
1922 // wfDeprecated( __FUNCTION__, '1.34' );
1923 return false;
1924 }
1925
1926 /**
1927 * Check if we are running from the commandline
1928 *
1929 * @since 1.31
1930 * @return bool
1931 */
1932 function wfIsCLI() {
1933 return PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg';
1934 }
1935
1936 /**
1937 * Tries to get the system directory for temporary files. First
1938 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
1939 * environment variables are then checked in sequence, then
1940 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
1941 *
1942 * NOTE: When possible, use instead the tmpfile() function to create
1943 * temporary files to avoid race conditions on file creation, etc.
1944 *
1945 * @return string
1946 */
1947 function wfTempDir() {
1948 global $wgTmpDirectory;
1949
1950 if ( $wgTmpDirectory !== false ) {
1951 return $wgTmpDirectory;
1952 }
1953
1954 return TempFSFile::getUsableTempDirectory();
1955 }
1956
1957 /**
1958 * Make directory, and make all parent directories if they don't exist
1959 *
1960 * @param string $dir Full path to directory to create
1961 * @param int|null $mode Chmod value to use, default is $wgDirectoryMode
1962 * @param string|null $caller Optional caller param for debugging.
1963 * @throws MWException
1964 * @return bool
1965 */
1966 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
1967 global $wgDirectoryMode;
1968
1969 if ( FileBackend::isStoragePath( $dir ) ) { // sanity
1970 throw new MWException( __FUNCTION__ . " given storage path '$dir'." );
1971 }
1972
1973 if ( !is_null( $caller ) ) {
1974 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
1975 }
1976
1977 if ( strval( $dir ) === '' || is_dir( $dir ) ) {
1978 return true;
1979 }
1980
1981 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR, $dir );
1982
1983 if ( is_null( $mode ) ) {
1984 $mode = $wgDirectoryMode;
1985 }
1986
1987 // Turn off the normal warning, we're doing our own below
1988 AtEase::suppressWarnings();
1989 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
1990 AtEase::restoreWarnings();
1991
1992 if ( !$ok ) {
1993 // directory may have been created on another request since we last checked
1994 if ( is_dir( $dir ) ) {
1995 return true;
1996 }
1997
1998 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
1999 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2000 }
2001 return $ok;
2002 }
2003
2004 /**
2005 * Remove a directory and all its content.
2006 * Does not hide error.
2007 * @param string $dir
2008 */
2009 function wfRecursiveRemoveDir( $dir ) {
2010 wfDebug( __FUNCTION__ . "( $dir )\n" );
2011 // taken from https://www.php.net/manual/en/function.rmdir.php#98622
2012 if ( is_dir( $dir ) ) {
2013 $objects = scandir( $dir );
2014 foreach ( $objects as $object ) {
2015 if ( $object != "." && $object != ".." ) {
2016 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2017 wfRecursiveRemoveDir( $dir . '/' . $object );
2018 } else {
2019 unlink( $dir . '/' . $object );
2020 }
2021 }
2022 }
2023 reset( $objects );
2024 rmdir( $dir );
2025 }
2026 }
2027
2028 /**
2029 * @param int $nr The number to format
2030 * @param int $acc The number of digits after the decimal point, default 2
2031 * @param bool $round Whether or not to round the value, default true
2032 * @return string
2033 */
2034 function wfPercent( $nr, $acc = 2, $round = true ) {
2035 $ret = sprintf( "%.${acc}f", $nr );
2036 return $round ? round( (float)$ret, $acc ) . '%' : "$ret%";
2037 }
2038
2039 /**
2040 * Safety wrapper around ini_get() for boolean settings.
2041 * The values returned from ini_get() are pre-normalized for settings
2042 * set via php.ini or php_flag/php_admin_flag... but *not*
2043 * for those set via php_value/php_admin_value.
2044 *
2045 * It's fairly common for people to use php_value instead of php_flag,
2046 * which can leave you with an 'off' setting giving a false positive
2047 * for code that just takes the ini_get() return value as a boolean.
2048 *
2049 * To make things extra interesting, setting via php_value accepts
2050 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2051 * Unrecognized values go false... again opposite PHP's own coercion
2052 * from string to bool.
2053 *
2054 * Luckily, 'properly' set settings will always come back as '0' or '1',
2055 * so we only have to worry about them and the 'improper' settings.
2056 *
2057 * I frickin' hate PHP... :P
2058 *
2059 * @param string $setting
2060 * @return bool
2061 */
2062 function wfIniGetBool( $setting ) {
2063 return wfStringToBool( ini_get( $setting ) );
2064 }
2065
2066 /**
2067 * Convert string value to boolean, when the following are interpreted as true:
2068 * - on
2069 * - true
2070 * - yes
2071 * - Any number, except 0
2072 * All other strings are interpreted as false.
2073 *
2074 * @param string $val
2075 * @return bool
2076 * @since 1.31
2077 */
2078 function wfStringToBool( $val ) {
2079 $val = strtolower( $val );
2080 // 'on' and 'true' can't have whitespace around them, but '1' can.
2081 return $val == 'on'
2082 || $val == 'true'
2083 || $val == 'yes'
2084 || preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2085 }
2086
2087 /**
2088 * Version of escapeshellarg() that works better on Windows.
2089 *
2090 * Originally, this fixed the incorrect use of single quotes on Windows
2091 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2092 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2093 *
2094 * @param string|string[] ...$args strings to escape and glue together,
2095 * or a single array of strings parameter
2096 * @return string
2097 * @deprecated since 1.30 use MediaWiki\Shell\Shell::escape()
2098 */
2099 function wfEscapeShellArg( ...$args ) {
2100 return Shell::escape( ...$args );
2101 }
2102
2103 /**
2104 * Execute a shell command, with time and memory limits mirrored from the PHP
2105 * configuration if supported.
2106 *
2107 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2108 * or an array of unescaped arguments, in which case each value will be escaped
2109 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2110 * @param null|mixed &$retval Optional, will receive the program's exit code.
2111 * (non-zero is usually failure). If there is an error from
2112 * read, select, or proc_open(), this will be set to -1.
2113 * @param array $environ Optional environment variables which should be
2114 * added to the executed command environment.
2115 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2116 * this overwrites the global wgMaxShell* limits.
2117 * @param array $options Array of options:
2118 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2119 * including errors from limit.sh
2120 * - profileMethod: By default this function will profile based on the calling
2121 * method. Set this to a string for an alternative method to profile from
2122 * @phan-param array{duplicateStderr?:bool,profileMethod?:string} $options
2123 *
2124 * @return string Collected stdout as a string
2125 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2126 */
2127 function wfShellExec( $cmd, &$retval = null, $environ = [],
2128 $limits = [], $options = []
2129 ) {
2130 if ( Shell::isDisabled() ) {
2131 $retval = 1;
2132 // Backwards compatibility be upon us...
2133 return 'Unable to run external programs, proc_open() is disabled.';
2134 }
2135
2136 if ( is_array( $cmd ) ) {
2137 $cmd = Shell::escape( $cmd );
2138 }
2139
2140 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2141 $profileMethod = $options['profileMethod'] ?? wfGetCaller();
2142
2143 try {
2144 $result = Shell::command( [] )
2145 ->unsafeParams( (array)$cmd )
2146 ->environment( $environ )
2147 ->limits( $limits )
2148 ->includeStderr( $includeStderr )
2149 ->profileMethod( $profileMethod )
2150 // For b/c
2151 ->restrict( Shell::RESTRICT_NONE )
2152 ->execute();
2153 } catch ( ProcOpenError $ex ) {
2154 $retval = -1;
2155 return '';
2156 }
2157
2158 $retval = $result->getExitCode();
2159
2160 return $result->getStdout();
2161 }
2162
2163 /**
2164 * Execute a shell command, returning both stdout and stderr. Convenience
2165 * function, as all the arguments to wfShellExec can become unwieldy.
2166 *
2167 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2168 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2169 * or an array of unescaped arguments, in which case each value will be escaped
2170 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2171 * @param null|mixed &$retval Optional, will receive the program's exit code.
2172 * (non-zero is usually failure)
2173 * @param array $environ Optional environment variables which should be
2174 * added to the executed command environment.
2175 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2176 * this overwrites the global wgMaxShell* limits.
2177 * @return string Collected stdout and stderr as a string
2178 * @deprecated since 1.30 use class MediaWiki\Shell\Shell
2179 */
2180 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2181 return wfShellExec( $cmd, $retval, $environ, $limits,
2182 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2183 }
2184
2185 /**
2186 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2187 * Note that $parameters should be a flat array and an option with an argument
2188 * should consist of two consecutive items in the array (do not use "--option value").
2189 *
2190 * @deprecated since 1.31, use Shell::makeScriptCommand()
2191 *
2192 * @param string $script MediaWiki cli script path
2193 * @param array $parameters Arguments and options to the script
2194 * @param array $options Associative array of options:
2195 * 'php': The path to the php executable
2196 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2197 * @phan-param array{php?:string,wrapper?:string} $options
2198 * @return string
2199 */
2200 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2201 global $wgPhpCli;
2202 // Give site config file a chance to run the script in a wrapper.
2203 // The caller may likely want to call wfBasename() on $script.
2204 Hooks::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2205 $cmd = [ $options['php'] ?? $wgPhpCli ];
2206 if ( isset( $options['wrapper'] ) ) {
2207 $cmd[] = $options['wrapper'];
2208 }
2209 $cmd[] = $script;
2210 // Escape each parameter for shell
2211 return Shell::escape( array_merge( $cmd, $parameters ) );
2212 }
2213
2214 /**
2215 * wfMerge attempts to merge differences between three texts.
2216 * Returns true for a clean merge and false for failure or a conflict.
2217 *
2218 * @param string $old
2219 * @param string $mine
2220 * @param string $yours
2221 * @param string &$result
2222 * @param string|null &$mergeAttemptResult
2223 * @return bool
2224 */
2225 function wfMerge( $old, $mine, $yours, &$result, &$mergeAttemptResult = null ) {
2226 global $wgDiff3;
2227
2228 # This check may also protect against code injection in
2229 # case of broken installations.
2230 AtEase::suppressWarnings();
2231 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2232 AtEase::restoreWarnings();
2233
2234 if ( !$haveDiff3 ) {
2235 wfDebug( "diff3 not found\n" );
2236 return false;
2237 }
2238
2239 # Make temporary files
2240 $td = wfTempDir();
2241 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2242 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2243 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2244
2245 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2246 # a newline character. To avoid this, we normalize the trailing whitespace before
2247 # creating the diff.
2248
2249 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2250 fclose( $oldtextFile );
2251 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2252 fclose( $mytextFile );
2253 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2254 fclose( $yourtextFile );
2255
2256 # Check for a conflict
2257 $cmd = Shell::escape( $wgDiff3, '-a', '--overlap-only', $mytextName,
2258 $oldtextName, $yourtextName );
2259 $handle = popen( $cmd, 'r' );
2260
2261 $mergeAttemptResult = '';
2262 do {
2263 $data = fread( $handle, 8192 );
2264 if ( strlen( $data ) == 0 ) {
2265 break;
2266 }
2267 $mergeAttemptResult .= $data;
2268 } while ( true );
2269 pclose( $handle );
2270
2271 $conflict = $mergeAttemptResult !== '';
2272
2273 # Merge differences
2274 $cmd = Shell::escape( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2275 $oldtextName, $yourtextName );
2276 $handle = popen( $cmd, 'r' );
2277 $result = '';
2278 do {
2279 $data = fread( $handle, 8192 );
2280 if ( strlen( $data ) == 0 ) {
2281 break;
2282 }
2283 $result .= $data;
2284 } while ( true );
2285 pclose( $handle );
2286 unlink( $mytextName );
2287 unlink( $oldtextName );
2288 unlink( $yourtextName );
2289
2290 if ( $result === '' && $old !== '' && !$conflict ) {
2291 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2292 $conflict = true;
2293 }
2294 return !$conflict;
2295 }
2296
2297 /**
2298 * Returns unified plain-text diff of two texts.
2299 * "Useful" for machine processing of diffs.
2300 *
2301 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2302 *
2303 * @param string $before The text before the changes.
2304 * @param string $after The text after the changes.
2305 * @param string $params Command-line options for the diff command.
2306 * @return string Unified diff of $before and $after
2307 */
2308 function wfDiff( $before, $after, $params = '-u' ) {
2309 if ( $before == $after ) {
2310 return '';
2311 }
2312
2313 global $wgDiff;
2314 AtEase::suppressWarnings();
2315 $haveDiff = $wgDiff && file_exists( $wgDiff );
2316 AtEase::restoreWarnings();
2317
2318 # This check may also protect against code injection in
2319 # case of broken installations.
2320 if ( !$haveDiff ) {
2321 wfDebug( "diff executable not found\n" );
2322 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2323 $format = new UnifiedDiffFormatter();
2324 return $format->format( $diffs );
2325 }
2326
2327 # Make temporary files
2328 $td = wfTempDir();
2329 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2330 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2331
2332 fwrite( $oldtextFile, $before );
2333 fclose( $oldtextFile );
2334 fwrite( $newtextFile, $after );
2335 fclose( $newtextFile );
2336
2337 // Get the diff of the two files
2338 $cmd = "$wgDiff " . $params . ' ' . Shell::escape( $oldtextName, $newtextName );
2339
2340 $h = popen( $cmd, 'r' );
2341 if ( !$h ) {
2342 unlink( $oldtextName );
2343 unlink( $newtextName );
2344 throw new Exception( __METHOD__ . '(): popen() failed' );
2345 }
2346
2347 $diff = '';
2348
2349 do {
2350 $data = fread( $h, 8192 );
2351 if ( strlen( $data ) == 0 ) {
2352 break;
2353 }
2354 $diff .= $data;
2355 } while ( true );
2356
2357 // Clean up
2358 pclose( $h );
2359 unlink( $oldtextName );
2360 unlink( $newtextName );
2361
2362 // Kill the --- and +++ lines. They're not useful.
2363 $diff_lines = explode( "\n", $diff );
2364 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2365 unset( $diff_lines[0] );
2366 }
2367 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2368 unset( $diff_lines[1] );
2369 }
2370
2371 $diff = implode( "\n", $diff_lines );
2372
2373 return $diff;
2374 }
2375
2376 /**
2377 * Return the final portion of a pathname.
2378 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2379 * https://bugs.php.net/bug.php?id=33898
2380 *
2381 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2382 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2383 *
2384 * @param string $path
2385 * @param string $suffix String to remove if present
2386 * @return string
2387 */
2388 function wfBaseName( $path, $suffix = '' ) {
2389 if ( $suffix == '' ) {
2390 $encSuffix = '';
2391 } else {
2392 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2393 }
2394
2395 $matches = [];
2396 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2397 return $matches[1];
2398 } else {
2399 return '';
2400 }
2401 }
2402
2403 /**
2404 * Generate a relative path name to the given file.
2405 * May explode on non-matching case-insensitive paths,
2406 * funky symlinks, etc.
2407 *
2408 * @param string $path Absolute destination path including target filename
2409 * @param string $from Absolute source path, directory only
2410 * @return string
2411 */
2412 function wfRelativePath( $path, $from ) {
2413 // Normalize mixed input on Windows...
2414 $path = str_replace( '/', DIRECTORY_SEPARATOR, $path );
2415 $from = str_replace( '/', DIRECTORY_SEPARATOR, $from );
2416
2417 // Trim trailing slashes -- fix for drive root
2418 $path = rtrim( $path, DIRECTORY_SEPARATOR );
2419 $from = rtrim( $from, DIRECTORY_SEPARATOR );
2420
2421 $pieces = explode( DIRECTORY_SEPARATOR, dirname( $path ) );
2422 $against = explode( DIRECTORY_SEPARATOR, $from );
2423
2424 if ( $pieces[0] !== $against[0] ) {
2425 // Non-matching Windows drive letters?
2426 // Return a full path.
2427 return $path;
2428 }
2429
2430 // Trim off common prefix
2431 while ( count( $pieces ) && count( $against )
2432 && $pieces[0] == $against[0] ) {
2433 array_shift( $pieces );
2434 array_shift( $against );
2435 }
2436
2437 // relative dots to bump us to the parent
2438 while ( count( $against ) ) {
2439 array_unshift( $pieces, '..' );
2440 array_shift( $against );
2441 }
2442
2443 array_push( $pieces, wfBaseName( $path ) );
2444
2445 return implode( DIRECTORY_SEPARATOR, $pieces );
2446 }
2447
2448 /**
2449 * Initialise php session
2450 *
2451 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2452 * Generally, "using" SessionManager will be calling ->getSessionById() or
2453 * ::getGlobalSession() (depending on whether you were passing $sessionId
2454 * here), then calling $session->persist().
2455 * @param bool|string $sessionId
2456 */
2457 function wfSetupSession( $sessionId = false ) {
2458 wfDeprecated( __FUNCTION__, '1.27' );
2459
2460 if ( $sessionId ) {
2461 session_id( $sessionId );
2462 }
2463
2464 $session = SessionManager::getGlobalSession();
2465 $session->persist();
2466
2467 if ( session_id() !== $session->getId() ) {
2468 session_id( $session->getId() );
2469 }
2470 AtEase::quietCall( 'session_start' );
2471 }
2472
2473 /**
2474 * Get an object from the precompiled serialized directory
2475 *
2476 * @param string $name
2477 * @return mixed The variable on success, false on failure
2478 */
2479 function wfGetPrecompiledData( $name ) {
2480 global $IP;
2481
2482 $file = "$IP/serialized/$name";
2483 if ( file_exists( $file ) ) {
2484 $blob = file_get_contents( $file );
2485 if ( $blob ) {
2486 return unserialize( $blob );
2487 }
2488 }
2489 return false;
2490 }
2491
2492 /**
2493 * Make a cache key for the local wiki.
2494 *
2495 * @deprecated since 1.30 Call makeKey on a BagOStuff instance
2496 * @param string ...$args
2497 * @return string
2498 */
2499 function wfMemcKey( ...$args ) {
2500 return ObjectCache::getLocalClusterInstance()->makeKey( ...$args );
2501 }
2502
2503 /**
2504 * Make a cache key for a foreign DB.
2505 *
2506 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2507 *
2508 * @param string $db
2509 * @param string $prefix
2510 * @param string ...$args
2511 * @return string
2512 */
2513 function wfForeignMemcKey( $db, $prefix, ...$args ) {
2514 $keyspace = $prefix ? "$db-$prefix" : $db;
2515 return ObjectCache::getLocalClusterInstance()->makeKeyInternal( $keyspace, $args );
2516 }
2517
2518 /**
2519 * Make a cache key with database-agnostic prefix.
2520 *
2521 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2522 * instead. Must have a prefix as otherwise keys that use a database name
2523 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2524 *
2525 * @deprecated since 1.30 Call makeGlobalKey on a BagOStuff instance
2526 * @since 1.26
2527 * @param string ...$args
2528 * @return string
2529 */
2530 function wfGlobalCacheKey( ...$args ) {
2531 wfDeprecated( __METHOD__, '1.30' );
2532 return ObjectCache::getLocalClusterInstance()->makeGlobalKey( ...$args );
2533 }
2534
2535 /**
2536 * Get an ASCII string identifying this wiki
2537 * This is used as a prefix in memcached keys
2538 *
2539 * @return string
2540 */
2541 function wfWikiID() {
2542 global $wgDBprefix, $wgDBname;
2543 if ( $wgDBprefix ) {
2544 return "$wgDBname-$wgDBprefix";
2545 } else {
2546 return $wgDBname;
2547 }
2548 }
2549
2550 /**
2551 * Get a Database object.
2552 *
2553 * @param int $db Index of the connection to get. May be DB_MASTER for the
2554 * master (for write queries), DB_REPLICA for potentially lagged read
2555 * queries, or an integer >= 0 for a particular server.
2556 *
2557 * @param string|string[] $groups Query groups. An array of group names that this query
2558 * belongs to. May contain a single string if the query is only
2559 * in one group.
2560 *
2561 * @param string|bool $wiki The wiki ID, or false for the current wiki
2562 *
2563 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
2564 * will always return the same object, unless the underlying connection or load
2565 * balancer is manually destroyed.
2566 *
2567 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
2568 * updater to ensure that a proper database is being updated.
2569 *
2570 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
2571 * on an injected instance of LoadBalancer.
2572 *
2573 * @return \Wikimedia\Rdbms\DBConnRef
2574 */
2575 function wfGetDB( $db, $groups = [], $wiki = false ) {
2576 return wfGetLB( $wiki )->getMaintenanceConnectionRef( $db, $groups, $wiki );
2577 }
2578
2579 /**
2580 * Get a load balancer object.
2581 *
2582 * @deprecated since 1.27, use MediaWikiServices::getInstance()->getDBLoadBalancer()
2583 * or MediaWikiServices::getInstance()->getDBLoadBalancerFactory() instead.
2584 *
2585 * @param string|bool $wiki Wiki ID, or false for the current wiki
2586 * @return \Wikimedia\Rdbms\LoadBalancer
2587 */
2588 function wfGetLB( $wiki = false ) {
2589 if ( $wiki === false ) {
2590 return MediaWikiServices::getInstance()->getDBLoadBalancer();
2591 } else {
2592 $factory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2593 return $factory->getMainLB( $wiki );
2594 }
2595 }
2596
2597 /**
2598 * Find a file.
2599 * @deprecated since 1.34, use MediaWikiServices
2600 * @param string|LinkTarget $title String or LinkTarget object
2601 * @param array $options Associative array of options (see RepoGroup::findFile)
2602 * @return File|bool File, or false if the file does not exist
2603 */
2604 function wfFindFile( $title, $options = [] ) {
2605 return MediaWikiServices::getInstance()->getRepoGroup()->findFile( $title, $options );
2606 }
2607
2608 /**
2609 * Get an object referring to a locally registered file.
2610 * Returns a valid placeholder object if the file does not exist.
2611 *
2612 * @deprecated since 1.34, use MediaWikiServices
2613 * @param Title|string $title
2614 * @return LocalFile|null A File, or null if passed an invalid Title
2615 */
2616 function wfLocalFile( $title ) {
2617 return MediaWikiServices::getInstance()->getRepoGroup()->getLocalRepo()->newFile( $title );
2618 }
2619
2620 /**
2621 * Should low-performance queries be disabled?
2622 *
2623 * @return bool
2624 * @codeCoverageIgnore
2625 */
2626 function wfQueriesMustScale() {
2627 global $wgMiserMode;
2628 return $wgMiserMode
2629 || ( SiteStats::pages() > 100000
2630 && SiteStats::edits() > 1000000
2631 && SiteStats::users() > 10000 );
2632 }
2633
2634 /**
2635 * Get the path to a specified script file, respecting file
2636 * extensions; this is a wrapper around $wgScriptPath etc.
2637 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
2638 *
2639 * @param string $script Script filename, sans extension
2640 * @return string
2641 */
2642 function wfScript( $script = 'index' ) {
2643 global $wgScriptPath, $wgScript, $wgLoadScript;
2644 if ( $script === 'index' ) {
2645 return $wgScript;
2646 } elseif ( $script === 'load' ) {
2647 return $wgLoadScript;
2648 } else {
2649 return "{$wgScriptPath}/{$script}.php";
2650 }
2651 }
2652
2653 /**
2654 * Get the script URL.
2655 *
2656 * @return string Script URL
2657 */
2658 function wfGetScriptUrl() {
2659 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
2660 /* as it was called, minus the query string.
2661 *
2662 * Some sites use Apache rewrite rules to handle subdomains,
2663 * and have PHP set up in a weird way that causes PHP_SELF
2664 * to contain the rewritten URL instead of the one that the
2665 * outside world sees.
2666 *
2667 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
2668 * provides containing the "before" URL.
2669 */
2670 return $_SERVER['SCRIPT_NAME'];
2671 } else {
2672 return $_SERVER['URL'];
2673 }
2674 }
2675
2676 /**
2677 * Convenience function converts boolean values into "true"
2678 * or "false" (string) values
2679 *
2680 * @param bool $value
2681 * @return string
2682 */
2683 function wfBoolToStr( $value ) {
2684 return $value ? 'true' : 'false';
2685 }
2686
2687 /**
2688 * Get a platform-independent path to the null file, e.g. /dev/null
2689 *
2690 * @return string
2691 */
2692 function wfGetNull() {
2693 return wfIsWindows() ? 'NUL' : '/dev/null';
2694 }
2695
2696 /**
2697 * Waits for the replica DBs to catch up to the master position
2698 *
2699 * Use this when updating very large numbers of rows, as in maintenance scripts,
2700 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
2701 *
2702 * By default this waits on the main DB cluster of the current wiki.
2703 * If $cluster is set to "*" it will wait on all DB clusters, including
2704 * external ones. If the lag being waiting on is caused by the code that
2705 * does this check, it makes since to use $ifWritesSince, particularly if
2706 * cluster is "*", to avoid excess overhead.
2707 *
2708 * Never call this function after a big DB write that is still in a transaction.
2709 * This only makes sense after the possible lag inducing changes were committed.
2710 *
2711 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
2712 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
2713 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
2714 * @param int|null $timeout Max wait time. Default: 60 seconds (cli), 1 second (web)
2715 * @return bool Success (able to connect and no timeouts reached)
2716 * @deprecated since 1.27 Use LBFactory::waitForReplication
2717 */
2718 function wfWaitForSlaves(
2719 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
2720 ) {
2721 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
2722
2723 if ( $cluster === '*' ) {
2724 $cluster = false;
2725 $domain = false;
2726 } elseif ( $wiki === false ) {
2727 $domain = $lbFactory->getLocalDomainID();
2728 } else {
2729 $domain = $wiki;
2730 }
2731
2732 $opts = [
2733 'domain' => $domain,
2734 'cluster' => $cluster,
2735 // B/C: first argument used to be "max seconds of lag"; ignore such values
2736 'ifWritesSince' => ( $ifWritesSince > 1e9 ) ? $ifWritesSince : null
2737 ];
2738 if ( $timeout !== null ) {
2739 $opts['timeout'] = $timeout;
2740 }
2741
2742 return $lbFactory->waitForReplication( $opts );
2743 }
2744
2745 /**
2746 * Replace all invalid characters with '-'.
2747 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
2748 * By default, $wgIllegalFileChars includes ':', '/', '\'.
2749 *
2750 * @param string $name Filename to process
2751 * @return string
2752 */
2753 function wfStripIllegalFilenameChars( $name ) {
2754 global $wgIllegalFileChars;
2755 $illegalFileChars = $wgIllegalFileChars ? "|[" . $wgIllegalFileChars . "]" : '';
2756 $name = preg_replace(
2757 "/[^" . Title::legalChars() . "]" . $illegalFileChars . "/",
2758 '-',
2759 $name
2760 );
2761 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
2762 $name = wfBaseName( $name );
2763 return $name;
2764 }
2765
2766 /**
2767 * Raise PHP's memory limit (if needed).
2768 *
2769 * @internal For use by Setup.php
2770 */
2771 function wfMemoryLimit( $newLimit ) {
2772 $oldLimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
2773 // If the INI config is already unlimited, there is nothing larger
2774 if ( $oldLimit != -1 ) {
2775 $newLimit = wfShorthandToInteger( $newLimit );
2776 if ( $newLimit == -1 ) {
2777 wfDebug( "Removing PHP's memory limit\n" );
2778 Wikimedia\suppressWarnings();
2779 ini_set( 'memory_limit', $newLimit );
2780 Wikimedia\restoreWarnings();
2781 } elseif ( $newLimit > $oldLimit ) {
2782 wfDebug( "Raising PHP's memory limit to $newLimit bytes\n" );
2783 Wikimedia\suppressWarnings();
2784 ini_set( 'memory_limit', $newLimit );
2785 Wikimedia\restoreWarnings();
2786 }
2787 }
2788 }
2789
2790 /**
2791 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
2792 *
2793 * @return int Prior time limit
2794 * @since 1.26
2795 */
2796 function wfTransactionalTimeLimit() {
2797 global $wgTransactionalTimeLimit;
2798
2799 $timeLimit = (int)ini_get( 'max_execution_time' );
2800 // Note that CLI scripts use 0
2801 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
2802 set_time_limit( $wgTransactionalTimeLimit );
2803 }
2804
2805 ignore_user_abort( true ); // ignore client disconnects
2806
2807 return $timeLimit;
2808 }
2809
2810 /**
2811 * Converts shorthand byte notation to integer form
2812 *
2813 * @param string $string
2814 * @param int $default Returned if $string is empty
2815 * @return int
2816 */
2817 function wfShorthandToInteger( $string = '', $default = -1 ) {
2818 $string = trim( $string );
2819 if ( $string === '' ) {
2820 return $default;
2821 }
2822 $last = $string[strlen( $string ) - 1];
2823 $val = intval( $string );
2824 switch ( $last ) {
2825 case 'g':
2826 case 'G':
2827 $val *= 1024;
2828 // break intentionally missing
2829 case 'm':
2830 case 'M':
2831 $val *= 1024;
2832 // break intentionally missing
2833 case 'k':
2834 case 'K':
2835 $val *= 1024;
2836 }
2837
2838 return $val;
2839 }
2840
2841 /**
2842 * Get a specific cache object.
2843 *
2844 * @deprecated since 1.32, use ObjectCache::getInstance() instead
2845 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
2846 * @return BagOStuff
2847 */
2848 function wfGetCache( $cacheType ) {
2849 return ObjectCache::getInstance( $cacheType );
2850 }
2851
2852 /**
2853 * Get the main cache object
2854 *
2855 * @deprecated since 1.32, use ObjectCache::getLocalClusterInstance() instead
2856 * @return BagOStuff
2857 */
2858 function wfGetMainCache() {
2859 return ObjectCache::getLocalClusterInstance();
2860 }
2861
2862 /**
2863 * Get the cache object used by the message cache
2864 *
2865 * @return BagOStuff
2866 */
2867 function wfGetMessageCacheStorage() {
2868 global $wgMessageCacheType;
2869 return ObjectCache::getInstance( $wgMessageCacheType );
2870 }
2871
2872 /**
2873 * Wrapper around php's unpack.
2874 *
2875 * @param string $format The format string (See php's docs)
2876 * @param string $data A binary string of binary data
2877 * @param int|bool $length The minimum length of $data or false. This is to
2878 * prevent reading beyond the end of $data. false to disable the check.
2879 *
2880 * Also be careful when using this function to read unsigned 32 bit integer
2881 * because php might make it negative.
2882 *
2883 * @throws MWException If $data not long enough, or if unpack fails
2884 * @return array Associative array of the extracted data
2885 */
2886 function wfUnpack( $format, $data, $length = false ) {
2887 if ( $length !== false ) {
2888 $realLen = strlen( $data );
2889 if ( $realLen < $length ) {
2890 throw new MWException( "Tried to use wfUnpack on a "
2891 . "string of length $realLen, but needed one "
2892 . "of at least length $length."
2893 );
2894 }
2895 }
2896
2897 Wikimedia\suppressWarnings();
2898 $result = unpack( $format, $data );
2899 Wikimedia\restoreWarnings();
2900
2901 if ( $result === false ) {
2902 // If it cannot extract the packed data.
2903 throw new MWException( "unpack could not unpack binary data" );
2904 }
2905 return $result;
2906 }
2907
2908 /**
2909 * Determine if an image exists on the 'bad image list'.
2910 *
2911 * The format of MediaWiki:Bad_image_list is as follows:
2912 * * Only list items (lines starting with "*") are considered
2913 * * The first link on a line must be a link to a bad image
2914 * * Any subsequent links on the same line are considered to be exceptions,
2915 * i.e. articles where the image may occur inline.
2916 *
2917 * @deprecated since 1.34, use the BadFileLookup service directly instead
2918 *
2919 * @param string $name The image name to check
2920 * @param Title|bool $contextTitle The page on which the image occurs, if known
2921 * @param string|null $blacklist Wikitext of a file blacklist
2922 * @return bool
2923 */
2924 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
2925 $services = MediaWikiServices::getInstance();
2926 if ( $blacklist !== null ) {
2927 wfDeprecated( __METHOD__ . ' with $blacklist parameter', '1.34' );
2928 return ( new BadFileLookup(
2929 function () use ( $blacklist ) {
2930 return $blacklist;
2931 },
2932 $services->getLocalServerObjectCache(),
2933 $services->getRepoGroup(),
2934 $services->getTitleParser()
2935 ) )->isBadFile( $name, $contextTitle ?: null );
2936 }
2937 return $services->getBadFileLookup()->isBadFile( $name, $contextTitle ?: null );
2938 }
2939
2940 /**
2941 * Determine whether the client at a given source IP is likely to be able to
2942 * access the wiki via HTTPS.
2943 *
2944 * @param string $ip The IPv4/6 address in the normal human-readable form
2945 * @return bool
2946 */
2947 function wfCanIPUseHTTPS( $ip ) {
2948 $canDo = true;
2949 Hooks::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
2950 return (bool)$canDo;
2951 }
2952
2953 /**
2954 * Determine input string is represents as infinity
2955 *
2956 * @param string $str The string to determine
2957 * @return bool
2958 * @since 1.25
2959 */
2960 function wfIsInfinity( $str ) {
2961 // These are hardcoded elsewhere in MediaWiki (e.g. mediawiki.special.block.js).
2962 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
2963 return in_array( $str, $infinityValues );
2964 }
2965
2966 /**
2967 * Returns true if these thumbnail parameters match one that MediaWiki
2968 * requests from file description pages and/or parser output.
2969 *
2970 * $params is considered non-standard if they involve a non-standard
2971 * width or any non-default parameters aside from width and page number.
2972 * The number of possible files with standard parameters is far less than
2973 * that of all combinations; rate-limiting for them can thus be more generious.
2974 *
2975 * @param File $file
2976 * @param array $params
2977 * @return bool
2978 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
2979 */
2980 function wfThumbIsStandard( File $file, array $params ) {
2981 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
2982
2983 $multipliers = [ 1 ];
2984 if ( $wgResponsiveImages ) {
2985 // These available sizes are hardcoded currently elsewhere in MediaWiki.
2986 // @see Linker::processResponsiveImages
2987 $multipliers[] = 1.5;
2988 $multipliers[] = 2;
2989 }
2990
2991 $handler = $file->getHandler();
2992 if ( !$handler || !isset( $params['width'] ) ) {
2993 return false;
2994 }
2995
2996 $basicParams = [];
2997 if ( isset( $params['page'] ) ) {
2998 $basicParams['page'] = $params['page'];
2999 }
3000
3001 $thumbLimits = [];
3002 $imageLimits = [];
3003 // Expand limits to account for multipliers
3004 foreach ( $multipliers as $multiplier ) {
3005 $thumbLimits = array_merge( $thumbLimits, array_map(
3006 function ( $width ) use ( $multiplier ) {
3007 return round( $width * $multiplier );
3008 }, $wgThumbLimits )
3009 );
3010 $imageLimits = array_merge( $imageLimits, array_map(
3011 function ( $pair ) use ( $multiplier ) {
3012 return [
3013 round( $pair[0] * $multiplier ),
3014 round( $pair[1] * $multiplier ),
3015 ];
3016 }, $wgImageLimits )
3017 );
3018 }
3019
3020 // Check if the width matches one of $wgThumbLimits
3021 if ( in_array( $params['width'], $thumbLimits ) ) {
3022 $normalParams = $basicParams + [ 'width' => $params['width'] ];
3023 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3024 $handler->normaliseParams( $file, $normalParams );
3025 } else {
3026 // If not, then check if the width matchs one of $wgImageLimits
3027 $match = false;
3028 foreach ( $imageLimits as $pair ) {
3029 $normalParams = $basicParams + [ 'width' => $pair[0], 'height' => $pair[1] ];
3030 // Decide whether the thumbnail should be scaled on width or height.
3031 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3032 $handler->normaliseParams( $file, $normalParams );
3033 // Check if this standard thumbnail size maps to the given width
3034 if ( $normalParams['width'] == $params['width'] ) {
3035 $match = true;
3036 break;
3037 }
3038 }
3039 if ( !$match ) {
3040 return false; // not standard for description pages
3041 }
3042 }
3043
3044 // Check that the given values for non-page, non-width, params are just defaults
3045 foreach ( $params as $key => $value ) {
3046 if ( !isset( $normalParams[$key] ) || $normalParams[$key] != $value ) {
3047 return false;
3048 }
3049 }
3050
3051 return true;
3052 }
3053
3054 /**
3055 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3056 *
3057 * Values that exist in both values will be combined with += (all values of the array
3058 * of $newValues