3 * Global functions used everywhere.
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.
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.
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
23 if ( !defined( 'MEDIAWIKI' ) ) {
24 die( "This file is part of MediaWiki, it is not a valid entry point" );
27 use Liuggio\StatsdClient\Sender\SocketSender
;
28 use MediaWiki\Logger\LoggerFactory
;
29 use MediaWiki\Session\SessionManager
;
30 use MediaWiki\MediaWikiServices
;
31 use Wikimedia\ScopedCallback
;
32 use Wikimedia\Rdbms\DBReplicationWaitError
;
34 // Hide compatibility functions from Doxygen
37 * Compatibility functions
39 * We support PHP 5.5.9 and up.
40 * Re-implementations of newer functions or functions in non-standard
41 * PHP extensions may be included here.
44 // hash_equals function only exists in PHP >= 5.6.0
45 // https://secure.php.net/hash_equals
46 if ( !function_exists( 'hash_equals' ) ) {
48 * Check whether a user-provided string is equal to a fixed-length secret string
49 * without revealing bytes of the secret string through timing differences.
51 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
52 * function in C) is to compare corresponding bytes and stop at the first difference,
53 * which would take longer for a partial match than for a complete mismatch. This
54 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
55 * and the other may come from an attacker. Statistical analysis of timing measurements
56 * over many requests may allow the attacker to guess the string's bytes one at a time
57 * (and check his guesses) even if the timing differences are extremely small.
59 * When making such a security-sensitive comparison, it is essential that the sequence
60 * in which instructions are executed and memory locations are accessed not depend on
61 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
62 * the inevitable leakage of the string's length. That is generally known anyway as
63 * a chararacteristic of the hash function used to compute the secret value.
65 * Longer explanation: http://www.emerose.com/timing-attacks-explained
68 * @param string $known_string Fixed-length secret string to compare against
69 * @param string $user_string User-provided string
70 * @return bool True if the strings are the same, false otherwise
72 function hash_equals( $known_string, $user_string ) {
73 // Strict type checking as in PHP's native implementation
74 if ( !is_string( $known_string ) ) {
75 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
76 gettype( $known_string ) . ' given', E_USER_WARNING
);
81 if ( !is_string( $user_string ) ) {
82 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
83 gettype( $user_string ) . ' given', E_USER_WARNING
);
88 $known_string_len = strlen( $known_string );
89 if ( $known_string_len !== strlen( $user_string ) ) {
94 for ( $i = 0; $i < $known_string_len; $i++
) {
95 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
98 return ( $result === 0 );
106 * This queues an extension to be loaded through
107 * the ExtensionRegistry system.
109 * @param string $ext Name of the extension to load
110 * @param string|null $path Absolute path of where to find the extension.json file
113 function wfLoadExtension( $ext, $path = null ) {
115 global $wgExtensionDirectory;
116 $path = "$wgExtensionDirectory/$ext/extension.json";
118 ExtensionRegistry
::getInstance()->queue( $path );
122 * Load multiple extensions at once
124 * Same as wfLoadExtension, but more efficient if you
125 * are loading multiple extensions.
127 * If you want to specify custom paths, you should interact with
128 * ExtensionRegistry directly.
130 * @see wfLoadExtension
131 * @param string[] $exts Array of extension names to load
134 function wfLoadExtensions( array $exts ) {
135 global $wgExtensionDirectory;
136 $registry = ExtensionRegistry
::getInstance();
137 foreach ( $exts as $ext ) {
138 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
145 * @see wfLoadExtension
146 * @param string $skin Name of the extension to load
147 * @param string|null $path Absolute path of where to find the skin.json file
150 function wfLoadSkin( $skin, $path = null ) {
152 global $wgStyleDirectory;
153 $path = "$wgStyleDirectory/$skin/skin.json";
155 ExtensionRegistry
::getInstance()->queue( $path );
159 * Load multiple skins at once
161 * @see wfLoadExtensions
162 * @param string[] $skins Array of extension names to load
165 function wfLoadSkins( array $skins ) {
166 global $wgStyleDirectory;
167 $registry = ExtensionRegistry
::getInstance();
168 foreach ( $skins as $skin ) {
169 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
174 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
179 function wfArrayDiff2( $a, $b ) {
180 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
184 * @param array|string $a
185 * @param array|string $b
188 function wfArrayDiff2_cmp( $a, $b ) {
189 if ( is_string( $a ) && is_string( $b ) ) {
190 return strcmp( $a, $b );
191 } elseif ( count( $a ) !== count( $b ) ) {
192 return count( $a ) < count( $b ) ?
-1 : 1;
196 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
197 $cmp = strcmp( $valueA, $valueB );
207 * Appends to second array if $value differs from that in $default
209 * @param string|int $key
210 * @param mixed $value
211 * @param mixed $default
212 * @param array $changed Array to alter
213 * @throws MWException
215 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
216 if ( is_null( $changed ) ) {
217 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
219 if ( $default[$key] !== $value ) {
220 $changed[$key] = $value;
225 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
227 * wfMergeErrorArrays(
240 * @param array $array1,...
243 function wfMergeErrorArrays( /*...*/ ) {
244 $args = func_get_args();
246 foreach ( $args as $errors ) {
247 foreach ( $errors as $params ) {
248 $originalParams = $params;
249 if ( $params[0] instanceof MessageSpecifier
) {
251 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
253 # @todo FIXME: Sometimes get nested arrays for $params,
254 # which leads to E_NOTICEs
255 $spec = implode( "\t", $params );
256 $out[$spec] = $originalParams;
259 return array_values( $out );
263 * Insert array into another array after the specified *KEY*
265 * @param array $array The array.
266 * @param array $insert The array to insert.
267 * @param mixed $after The key to insert after
270 function wfArrayInsertAfter( array $array, array $insert, $after ) {
271 // Find the offset of the element to insert after.
272 $keys = array_keys( $array );
273 $offsetByKey = array_flip( $keys );
275 $offset = $offsetByKey[$after];
277 // Insert at the specified offset
278 $before = array_slice( $array, 0, $offset +
1, true );
279 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
281 $output = $before +
$insert +
$after;
287 * Recursively converts the parameter (an object) to an array with the same data
289 * @param object|array $objOrArray
290 * @param bool $recursive
293 function wfObjectToArray( $objOrArray, $recursive = true ) {
295 if ( is_object( $objOrArray ) ) {
296 $objOrArray = get_object_vars( $objOrArray );
298 foreach ( $objOrArray as $key => $value ) {
299 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
300 $value = wfObjectToArray( $value );
303 $array[$key] = $value;
310 * Get a random decimal value between 0 and 1, in a way
311 * not likely to give duplicate values for any realistic
312 * number of articles.
314 * @note This is designed for use in relation to Special:RandomPage
315 * and the page_random database field.
319 function wfRandom() {
320 // The maximum random value is "only" 2^31-1, so get two random
321 // values to reduce the chance of dupes
322 $max = mt_getrandmax() +
1;
323 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
328 * Get a random string containing a number of pseudo-random hex characters.
330 * @note This is not secure, if you are trying to generate some sort
331 * of token please use MWCryptRand instead.
333 * @param int $length The length of the string to generate
337 function wfRandomString( $length = 32 ) {
339 for ( $n = 0; $n < $length; $n +
= 7 ) {
340 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
342 return substr( $str, 0, $length );
346 * We want some things to be included as literal characters in our title URLs
347 * for prettiness, which urlencode encodes by default. According to RFC 1738,
348 * all of the following should be safe:
352 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
353 * character which should not be encoded. More importantly, google chrome
354 * always converts %7E back to ~, and converting it in this function can
355 * cause a redirect loop (T105265).
357 * But + is not safe because it's used to indicate a space; &= are only safe in
358 * paths and not in queries (and we don't distinguish here); ' seems kind of
359 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
360 * is reserved, we don't care. So the list we unescape is:
364 * However, IIS7 redirects fail when the url contains a colon (see T24709),
365 * so no fancy : for IIS7.
367 * %2F in the page titles seems to fatally break for some reason.
372 function wfUrlencode( $s ) {
375 if ( is_null( $s ) ) {
380 if ( is_null( $needle ) ) {
381 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
382 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
383 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
389 $s = urlencode( $s );
392 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
400 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
401 * "days=7&limit=100". Options in the first array override options in the second.
402 * Options set to null or false will not be output.
404 * @param array $array1 ( String|Array )
405 * @param array|null $array2 ( String|Array )
406 * @param string $prefix
409 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
410 if ( !is_null( $array2 ) ) {
411 $array1 = $array1 +
$array2;
415 foreach ( $array1 as $key => $value ) {
416 if ( !is_null( $value ) && $value !== false ) {
420 if ( $prefix !== '' ) {
421 $key = $prefix . "[$key]";
423 if ( is_array( $value ) ) {
425 foreach ( $value as $k => $v ) {
426 $cgi .= $firstTime ?
'' : '&';
427 if ( is_array( $v ) ) {
428 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
430 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
435 if ( is_object( $value ) ) {
436 $value = $value->__toString();
438 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
446 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
447 * its argument and returns the same string in array form. This allows compatibility
448 * with legacy functions that accept raw query strings instead of nice
449 * arrays. Of course, keys and values are urldecode()d.
451 * @param string $query Query string
452 * @return string[] Array version of input
454 function wfCgiToArray( $query ) {
455 if ( isset( $query[0] ) && $query[0] == '?' ) {
456 $query = substr( $query, 1 );
458 $bits = explode( '&', $query );
460 foreach ( $bits as $bit ) {
464 if ( strpos( $bit, '=' ) === false ) {
465 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
469 list( $key, $value ) = explode( '=', $bit );
471 $key = urldecode( $key );
472 $value = urldecode( $value );
473 if ( strpos( $key, '[' ) !== false ) {
474 $keys = array_reverse( explode( '[', $key ) );
475 $key = array_pop( $keys );
477 foreach ( $keys as $k ) {
478 $k = substr( $k, 0, -1 );
479 $temp = [ $k => $temp ];
481 if ( isset( $ret[$key] ) ) {
482 $ret[$key] = array_merge( $ret[$key], $temp );
494 * Append a query string to an existing URL, which may or may not already
495 * have query string parameters already. If so, they will be combined.
498 * @param string|string[] $query String or associative array
501 function wfAppendQuery( $url, $query ) {
502 if ( is_array( $query ) ) {
503 $query = wfArrayToCgi( $query );
505 if ( $query != '' ) {
506 // Remove the fragment, if there is one
508 $hashPos = strpos( $url, '#' );
509 if ( $hashPos !== false ) {
510 $fragment = substr( $url, $hashPos );
511 $url = substr( $url, 0, $hashPos );
515 if ( false === strpos( $url, '?' ) ) {
522 // Put the fragment back
523 if ( $fragment !== false ) {
531 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
534 * The meaning of the PROTO_* constants is as follows:
535 * PROTO_HTTP: Output a URL starting with http://
536 * PROTO_HTTPS: Output a URL starting with https://
537 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
538 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
539 * on which protocol was used for the current incoming request
540 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
541 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
542 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
544 * @todo this won't work with current-path-relative URLs
545 * like "subdir/foo.html", etc.
547 * @param string $url Either fully-qualified or a local path + query
548 * @param string $defaultProto One of the PROTO_* constants. Determines the
549 * protocol to use if $url or $wgServer is protocol-relative
550 * @return string|false Fully-qualified URL, current-path-relative URL or false if
551 * no valid URL can be constructed
553 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
554 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
556 if ( $defaultProto === PROTO_CANONICAL
) {
557 $serverUrl = $wgCanonicalServer;
558 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
559 // Make $wgInternalServer fall back to $wgServer if not set
560 $serverUrl = $wgInternalServer;
562 $serverUrl = $wgServer;
563 if ( $defaultProto === PROTO_CURRENT
) {
564 $defaultProto = $wgRequest->getProtocol() . '://';
568 // Analyze $serverUrl to obtain its protocol
569 $bits = wfParseUrl( $serverUrl );
570 $serverHasProto = $bits && $bits['scheme'] != '';
572 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
573 if ( $serverHasProto ) {
574 $defaultProto = $bits['scheme'] . '://';
576 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
577 // This really isn't supposed to happen. Fall back to HTTP in this
579 $defaultProto = PROTO_HTTP
;
583 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
585 if ( substr( $url, 0, 2 ) == '//' ) {
586 $url = $defaultProtoWithoutSlashes . $url;
587 } elseif ( substr( $url, 0, 1 ) == '/' ) {
588 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
589 // otherwise leave it alone.
590 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
593 $bits = wfParseUrl( $url );
595 // ensure proper port for HTTPS arrives in URL
596 // https://phabricator.wikimedia.org/T67184
597 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
598 $bits['port'] = $wgHttpsPort;
601 if ( $bits && isset( $bits['path'] ) ) {
602 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
603 return wfAssembleUrl( $bits );
607 } elseif ( substr( $url, 0, 1 ) != '/' ) {
608 # URL is a relative path
609 return wfRemoveDotSegments( $url );
612 # Expanded URL is not valid.
617 * This function will reassemble a URL parsed with wfParseURL. This is useful
618 * if you need to edit part of a URL and put it back together.
620 * This is the basic structure used (brackets contain keys for $urlParts):
621 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
623 * @todo Need to integrate this into wfExpandUrl (see T34168)
626 * @param array $urlParts URL parts, as output from wfParseUrl
627 * @return string URL assembled from its component parts
629 function wfAssembleUrl( $urlParts ) {
632 if ( isset( $urlParts['delimiter'] ) ) {
633 if ( isset( $urlParts['scheme'] ) ) {
634 $result .= $urlParts['scheme'];
637 $result .= $urlParts['delimiter'];
640 if ( isset( $urlParts['host'] ) ) {
641 if ( isset( $urlParts['user'] ) ) {
642 $result .= $urlParts['user'];
643 if ( isset( $urlParts['pass'] ) ) {
644 $result .= ':' . $urlParts['pass'];
649 $result .= $urlParts['host'];
651 if ( isset( $urlParts['port'] ) ) {
652 $result .= ':' . $urlParts['port'];
656 if ( isset( $urlParts['path'] ) ) {
657 $result .= $urlParts['path'];
660 if ( isset( $urlParts['query'] ) ) {
661 $result .= '?' . $urlParts['query'];
664 if ( isset( $urlParts['fragment'] ) ) {
665 $result .= '#' . $urlParts['fragment'];
672 * Remove all dot-segments in the provided URL path. For example,
673 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
674 * RFC3986 section 5.2.4.
676 * @todo Need to integrate this into wfExpandUrl (see T34168)
678 * @param string $urlPath URL path, potentially containing dot-segments
679 * @return string URL path with all dot-segments removed
681 function wfRemoveDotSegments( $urlPath ) {
684 $inputLength = strlen( $urlPath );
686 while ( $inputOffset < $inputLength ) {
687 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
688 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
689 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
690 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
693 if ( $prefixLengthTwo == './' ) {
694 # Step A, remove leading "./"
696 } elseif ( $prefixLengthThree == '../' ) {
697 # Step A, remove leading "../"
699 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
700 # Step B, replace leading "/.$" with "/"
702 $urlPath[$inputOffset] = '/';
703 } elseif ( $prefixLengthThree == '/./' ) {
704 # Step B, replace leading "/./" with "/"
706 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
707 # Step C, replace leading "/..$" with "/" and
708 # remove last path component in output
710 $urlPath[$inputOffset] = '/';
712 } elseif ( $prefixLengthFour == '/../' ) {
713 # Step C, replace leading "/../" with "/" and
714 # remove last path component in output
717 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
718 # Step D, remove "^.$"
720 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
721 # Step D, remove "^..$"
724 # Step E, move leading path segment to output
725 if ( $prefixLengthOne == '/' ) {
726 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
728 $slashPos = strpos( $urlPath, '/', $inputOffset );
730 if ( $slashPos === false ) {
731 $output .= substr( $urlPath, $inputOffset );
732 $inputOffset = $inputLength;
734 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
735 $inputOffset +
= $slashPos - $inputOffset;
740 $slashPos = strrpos( $output, '/' );
741 if ( $slashPos === false ) {
744 $output = substr( $output, 0, $slashPos );
753 * Returns a regular expression of url protocols
755 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
756 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
759 function wfUrlProtocols( $includeProtocolRelative = true ) {
760 global $wgUrlProtocols;
762 // Cache return values separately based on $includeProtocolRelative
763 static $withProtRel = null, $withoutProtRel = null;
764 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
765 if ( !is_null( $cachedValue ) ) {
769 // Support old-style $wgUrlProtocols strings, for backwards compatibility
770 // with LocalSettings files from 1.5
771 if ( is_array( $wgUrlProtocols ) ) {
773 foreach ( $wgUrlProtocols as $protocol ) {
774 // Filter out '//' if !$includeProtocolRelative
775 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
776 $protocols[] = preg_quote( $protocol, '/' );
780 $retval = implode( '|', $protocols );
782 // Ignore $includeProtocolRelative in this case
783 // This case exists for pre-1.6 compatibility, and we can safely assume
784 // that '//' won't appear in a pre-1.6 config because protocol-relative
785 // URLs weren't supported until 1.18
786 $retval = $wgUrlProtocols;
789 // Cache return value
790 if ( $includeProtocolRelative ) {
791 $withProtRel = $retval;
793 $withoutProtRel = $retval;
799 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
800 * you need a regex that matches all URL protocols but does not match protocol-
804 function wfUrlProtocolsWithoutProtRel() {
805 return wfUrlProtocols( false );
809 * parse_url() work-alike, but non-broken. Differences:
811 * 1) Does not raise warnings on bad URLs (just returns false).
812 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
813 * protocol-relative URLs) correctly.
814 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
816 * @param string $url A URL to parse
817 * @return string[]|bool Bits of the URL in an associative array, per PHP docs, false on failure
819 function wfParseUrl( $url ) {
820 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
822 // Protocol-relative URLs are handled really badly by parse_url(). It's so
823 // bad that the easiest way to handle them is to just prepend 'http:' and
824 // strip the protocol out later.
825 $wasRelative = substr( $url, 0, 2 ) == '//';
826 if ( $wasRelative ) {
829 MediaWiki\
suppressWarnings();
830 $bits = parse_url( $url );
831 MediaWiki\restoreWarnings
();
832 // parse_url() returns an array without scheme for some invalid URLs, e.g.
833 // parse_url("%0Ahttp://example.com") == [ 'host' => '%0Ahttp', 'path' => 'example.com' ]
834 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
838 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
839 $bits['scheme'] = strtolower( $bits['scheme'] );
841 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
842 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
843 $bits['delimiter'] = '://';
844 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
845 $bits['delimiter'] = ':';
846 // parse_url detects for news: and mailto: the host part of an url as path
847 // We have to correct this wrong detection
848 if ( isset( $bits['path'] ) ) {
849 $bits['host'] = $bits['path'];
856 /* Provide an empty host for eg. file:/// urls (see T30627) */
857 if ( !isset( $bits['host'] ) ) {
861 if ( isset( $bits['path'] ) ) {
862 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
863 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
864 $bits['path'] = '/' . $bits['path'];
871 // If the URL was protocol-relative, fix scheme and delimiter
872 if ( $wasRelative ) {
873 $bits['scheme'] = '';
874 $bits['delimiter'] = '//';
880 * Take a URL, make sure it's expanded to fully qualified, and replace any
881 * encoded non-ASCII Unicode characters with their UTF-8 original forms
882 * for more compact display and legibility for local audiences.
884 * @todo handle punycode domains too
889 function wfExpandIRI( $url ) {
890 return preg_replace_callback(
891 '/((?:%[89A-F][0-9A-F])+)/i',
892 'wfExpandIRI_callback',
898 * Private callback for wfExpandIRI
899 * @param array $matches
902 function wfExpandIRI_callback( $matches ) {
903 return urldecode( $matches[1] );
907 * Make URL indexes, appropriate for the el_index field of externallinks.
912 function wfMakeUrlIndexes( $url ) {
913 $bits = wfParseUrl( $url );
915 // Reverse the labels in the hostname, convert to lower case
916 // For emails reverse domainpart only
917 if ( $bits['scheme'] == 'mailto' ) {
918 $mailparts = explode( '@', $bits['host'], 2 );
919 if ( count( $mailparts ) === 2 ) {
920 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
922 // No domain specified, don't mangle it
925 $reversedHost = $domainpart . '@' . $mailparts[0];
927 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
929 // Add an extra dot to the end
930 // Why? Is it in wrong place in mailto links?
931 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
932 $reversedHost .= '.';
934 // Reconstruct the pseudo-URL
935 $prot = $bits['scheme'];
936 $index = $prot . $bits['delimiter'] . $reversedHost;
937 // Leave out user and password. Add the port, path, query and fragment
938 if ( isset( $bits['port'] ) ) {
939 $index .= ':' . $bits['port'];
941 if ( isset( $bits['path'] ) ) {
942 $index .= $bits['path'];
946 if ( isset( $bits['query'] ) ) {
947 $index .= '?' . $bits['query'];
949 if ( isset( $bits['fragment'] ) ) {
950 $index .= '#' . $bits['fragment'];
954 return [ "http:$index", "https:$index" ];
961 * Check whether a given URL has a domain that occurs in a given set of domains
962 * @param string $url URL
963 * @param array $domains Array of domains (strings)
964 * @return bool True if the host part of $url ends in one of the strings in $domains
966 function wfMatchesDomainList( $url, $domains ) {
967 $bits = wfParseUrl( $url );
968 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
969 $host = '.' . $bits['host'];
970 foreach ( (array)$domains as $domain ) {
971 $domain = '.' . $domain;
972 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
981 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
982 * In normal operation this is a NOP.
984 * Controlling globals:
985 * $wgDebugLogFile - points to the log file
986 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
987 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
989 * @since 1.25 support for additional context data
991 * @param string $text
992 * @param string|bool $dest Destination of the message:
993 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
994 * - 'private': excluded from HTML output
995 * For backward compatibility, it can also take a boolean:
996 * - true: same as 'all'
997 * - false: same as 'private'
998 * @param array $context Additional logging context data
1000 function wfDebug( $text, $dest = 'all', array $context = [] ) {
1001 global $wgDebugRawPage, $wgDebugLogPrefix;
1002 global $wgDebugTimestamps, $wgRequestTime;
1004 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1008 $text = trim( $text );
1010 if ( $wgDebugTimestamps ) {
1011 $context['seconds_elapsed'] = sprintf(
1013 microtime( true ) - $wgRequestTime
1015 $context['memory_used'] = sprintf(
1017 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1021 if ( $wgDebugLogPrefix !== '' ) {
1022 $context['prefix'] = $wgDebugLogPrefix;
1024 $context['private'] = ( $dest === false ||
$dest === 'private' );
1026 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1027 $logger->debug( $text, $context );
1031 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1034 function wfIsDebugRawPage() {
1036 if ( $cache !== null ) {
1039 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1040 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1042 isset( $_SERVER['SCRIPT_NAME'] )
1043 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1054 * Send a line giving PHP memory usage.
1056 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1058 function wfDebugMem( $exact = false ) {
1059 $mem = memory_get_usage();
1061 $mem = floor( $mem / 1024 ) . ' KiB';
1065 wfDebug( "Memory usage: $mem\n" );
1069 * Send a line to a supplementary debug log file, if configured, or main debug
1072 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1073 * a string filename or an associative array mapping 'destination' to the
1074 * desired filename. The associative array may also contain a 'sample' key
1075 * with an integer value, specifying a sampling factor. Sampled log events
1076 * will be emitted with a 1 in N random chance.
1078 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1079 * @since 1.25 support for additional context data
1080 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1082 * @param string $logGroup
1083 * @param string $text
1084 * @param string|bool $dest Destination of the message:
1085 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1086 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1087 * discarded otherwise
1088 * For backward compatibility, it can also take a boolean:
1089 * - true: same as 'all'
1090 * - false: same as 'private'
1091 * @param array $context Additional logging context data
1093 function wfDebugLog(
1094 $logGroup, $text, $dest = 'all', array $context = []
1096 $text = trim( $text );
1098 $logger = LoggerFactory
::getInstance( $logGroup );
1099 $context['private'] = ( $dest === false ||
$dest === 'private' );
1100 $logger->info( $text, $context );
1104 * Log for database errors
1106 * @since 1.25 support for additional context data
1108 * @param string $text Database error message.
1109 * @param array $context Additional logging context data
1111 function wfLogDBError( $text, array $context = [] ) {
1112 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1113 $logger->error( trim( $text ), $context );
1117 * Throws a warning that $function is deprecated
1119 * @param string $function
1120 * @param string|bool $version Version of MediaWiki that the function
1121 * was deprecated in (Added in 1.19).
1122 * @param string|bool $component Added in 1.19.
1123 * @param int $callerOffset How far up the call stack is the original
1124 * caller. 2 = function that called the function that called
1125 * wfDeprecated (Added in 1.20)
1129 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1130 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1134 * Send a warning either to the debug log or in a PHP error depending on
1135 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1137 * @param string $msg Message to send
1138 * @param int $callerOffset Number of items to go back in the backtrace to
1139 * find the correct caller (1 = function calling wfWarn, ...)
1140 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1141 * only used when $wgDevelopmentWarnings is true
1143 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1144 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1148 * Send a warning as a PHP error and the debug log. This is intended for logging
1149 * warnings in production. For logging development warnings, use WfWarn instead.
1151 * @param string $msg Message to send
1152 * @param int $callerOffset Number of items to go back in the backtrace to
1153 * find the correct caller (1 = function calling wfLogWarning, ...)
1154 * @param int $level PHP error level; defaults to E_USER_WARNING
1156 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1157 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1161 * Log to a file without getting "file size exceeded" signals.
1163 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1164 * send lines to the specified port, prefixed by the specified prefix and a space.
1165 * @since 1.25 support for additional context data
1167 * @param string $text
1168 * @param string $file Filename
1169 * @param array $context Additional logging context data
1170 * @throws MWException
1171 * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1173 function wfErrorLog( $text, $file, array $context = [] ) {
1174 wfDeprecated( __METHOD__
, '1.25' );
1175 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1176 $context['destination'] = $file;
1177 $logger->info( trim( $text ), $context );
1183 function wfLogProfilingData() {
1184 global $wgDebugLogGroups, $wgDebugRawPage;
1186 $context = RequestContext
::getMain();
1187 $request = $context->getRequest();
1189 $profiler = Profiler
::instance();
1190 $profiler->setContext( $context );
1191 $profiler->logData();
1193 $config = $context->getConfig();
1194 if ( $config->get( 'StatsdServer' ) ) {
1196 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1197 $statsdHost = $statsdServer[0];
1198 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1199 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1200 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
1201 $statsdClient->setSamplingRates( $config->get( 'StatsdSamplingRates' ) );
1202 $statsdClient->send(
1203 MediaWikiServices
::getInstance()->getStatsdDataFactory()->getBuffer()
1205 } catch ( Exception
$ex ) {
1206 MWExceptionHandler
::logException( $ex );
1210 # Profiling must actually be enabled...
1211 if ( $profiler instanceof ProfilerStub
) {
1215 if ( isset( $wgDebugLogGroups['profileoutput'] )
1216 && $wgDebugLogGroups['profileoutput'] === false
1218 // Explicitly disabled
1221 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1225 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1226 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1227 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1229 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1230 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1232 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1233 $ctx['from'] = $_SERVER['HTTP_FROM'];
1235 if ( isset( $ctx['forwarded_for'] ) ||
1236 isset( $ctx['client_ip'] ) ||
1237 isset( $ctx['from'] ) ) {
1238 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1241 // Don't load $wgUser at this late stage just for statistics purposes
1242 // @todo FIXME: We can detect some anons even if it is not loaded.
1243 // See User::getId()
1244 $user = $context->getUser();
1245 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1247 // Command line script uses a FauxRequest object which does not have
1248 // any knowledge about an URL and throw an exception instead.
1250 $ctx['url'] = urldecode( $request->getRequestURL() );
1251 } catch ( Exception
$ignored ) {
1255 $ctx['output'] = $profiler->getOutput();
1257 $log = LoggerFactory
::getInstance( 'profileoutput' );
1258 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1262 * Increment a statistics counter
1264 * @param string $key
1268 function wfIncrStats( $key, $count = 1 ) {
1269 $stats = MediaWikiServices
::getInstance()->getStatsdDataFactory();
1270 $stats->updateCount( $key, $count );
1274 * Check whether the wiki is in read-only mode.
1278 function wfReadOnly() {
1279 return \MediaWiki\MediaWikiServices
::getInstance()->getReadOnlyMode()
1284 * Check if the site is in read-only mode and return the message if so
1286 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1287 * for replica DB lag. This may result in DB connection being made.
1289 * @return string|bool String when in read-only mode; false otherwise
1291 function wfReadOnlyReason() {
1292 return \MediaWiki\MediaWikiServices
::getInstance()->getReadOnlyMode()
1297 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1299 * @return string|bool String when in read-only mode; false otherwise
1302 function wfConfiguredReadOnlyReason() {
1303 return \MediaWiki\MediaWikiServices
::getInstance()->getConfiguredReadOnlyMode()
1308 * Return a Language object from $langcode
1310 * @param Language|string|bool $langcode Either:
1311 * - a Language object
1312 * - code of the language to get the message for, if it is
1313 * a valid code create a language for that language, if
1314 * it is a string but not a valid code then make a basic
1316 * - a boolean: if it's false then use the global object for
1317 * the current user's language (as a fallback for the old parameter
1318 * functionality), or if it is true then use global object
1319 * for the wiki's content language.
1322 function wfGetLangObj( $langcode = false ) {
1323 # Identify which language to get or create a language object for.
1324 # Using is_object here due to Stub objects.
1325 if ( is_object( $langcode ) ) {
1326 # Great, we already have the object (hopefully)!
1330 global $wgContLang, $wgLanguageCode;
1331 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1332 # $langcode is the language code of the wikis content language object.
1333 # or it is a boolean and value is true
1338 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1339 # $langcode is the language code of user language object.
1340 # or it was a boolean and value is false
1344 $validCodes = array_keys( Language
::fetchLanguageNames() );
1345 if ( in_array( $langcode, $validCodes ) ) {
1346 # $langcode corresponds to a valid language.
1347 return Language
::factory( $langcode );
1350 # $langcode is a string, but not a valid language code; use content language.
1351 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1356 * This is the function for getting translated interface messages.
1358 * @see Message class for documentation how to use them.
1359 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1361 * This function replaces all old wfMsg* functions.
1363 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1364 * @param mixed $params,... Normal message parameters
1369 * @see Message::__construct
1371 function wfMessage( $key /*...*/ ) {
1372 $message = new Message( $key );
1374 // We call Message::params() to reduce code duplication
1375 $params = func_get_args();
1376 array_shift( $params );
1378 call_user_func_array( [ $message, 'params' ], $params );
1385 * This function accepts multiple message keys and returns a message instance
1386 * for the first message which is non-empty. If all messages are empty then an
1387 * instance of the first message key is returned.
1389 * @param string|string[] $keys,... Message keys
1394 * @see Message::newFallbackSequence
1396 function wfMessageFallback( /*...*/ ) {
1397 $args = func_get_args();
1398 return call_user_func_array( 'Message::newFallbackSequence', $args );
1402 * Replace message parameter keys on the given formatted output.
1404 * @param string $message
1405 * @param array $args
1409 function wfMsgReplaceArgs( $message, $args ) {
1410 # Fix windows line-endings
1411 # Some messages are split with explode("\n", $msg)
1412 $message = str_replace( "\r", '', $message );
1414 // Replace arguments
1415 if ( is_array( $args ) && $args ) {
1416 if ( is_array( $args[0] ) ) {
1417 $args = array_values( $args[0] );
1419 $replacementKeys = [];
1420 foreach ( $args as $n => $param ) {
1421 $replacementKeys['$' . ( $n +
1 )] = $param;
1423 $message = strtr( $message, $replacementKeys );
1430 * Fetch server name for use in error reporting etc.
1431 * Use real server name if available, so we know which machine
1432 * in a server farm generated the current page.
1436 function wfHostname() {
1438 if ( is_null( $host ) ) {
1440 # Hostname overriding
1441 global $wgOverrideHostname;
1442 if ( $wgOverrideHostname !== false ) {
1443 # Set static and skip any detection
1444 $host = $wgOverrideHostname;
1448 if ( function_exists( 'posix_uname' ) ) {
1449 // This function not present on Windows
1450 $uname = posix_uname();
1454 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1455 $host = $uname['nodename'];
1456 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1457 # Windows computer name
1458 $host = getenv( 'COMPUTERNAME' );
1460 # This may be a virtual server.
1461 $host = $_SERVER['SERVER_NAME'];
1468 * Returns a script tag that stores the amount of time it took MediaWiki to
1469 * handle the request in milliseconds as 'wgBackendResponseTime'.
1471 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1472 * hostname of the server handling the request.
1476 function wfReportTime() {
1477 global $wgRequestTime, $wgShowHostnames;
1479 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1480 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1481 if ( $wgShowHostnames ) {
1482 $reportVars['wgHostname'] = wfHostname();
1484 return Skin
::makeVariablesScript( $reportVars );
1488 * Safety wrapper for debug_backtrace().
1490 * Will return an empty array if debug_backtrace is disabled, otherwise
1491 * the output from debug_backtrace() (trimmed).
1493 * @param int $limit This parameter can be used to limit the number of stack frames returned
1495 * @return array Array of backtrace information
1497 function wfDebugBacktrace( $limit = 0 ) {
1498 static $disabled = null;
1500 if ( is_null( $disabled ) ) {
1501 $disabled = !function_exists( 'debug_backtrace' );
1503 wfDebug( "debug_backtrace() is disabled\n" );
1511 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1513 return array_slice( debug_backtrace(), 1 );
1518 * Get a debug backtrace as a string
1520 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1521 * Defaults to $wgCommandLineMode if unset.
1523 * @since 1.25 Supports $raw parameter.
1525 function wfBacktrace( $raw = null ) {
1526 global $wgCommandLineMode;
1528 if ( $raw === null ) {
1529 $raw = $wgCommandLineMode;
1533 $frameFormat = "%s line %s calls %s()\n";
1534 $traceFormat = "%s";
1536 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1537 $traceFormat = "<ul>\n%s</ul>\n";
1540 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1541 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1542 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1543 $call = $frame['function'];
1544 if ( !empty( $frame['class'] ) ) {
1545 $call = $frame['class'] . $frame['type'] . $call;
1547 return sprintf( $frameFormat, $file, $line, $call );
1548 }, wfDebugBacktrace() );
1550 return sprintf( $traceFormat, implode( '', $frames ) );
1554 * Get the name of the function which called this function
1555 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1556 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1557 * wfGetCaller( 3 ) is the parent of that.
1562 function wfGetCaller( $level = 2 ) {
1563 $backtrace = wfDebugBacktrace( $level +
1 );
1564 if ( isset( $backtrace[$level] ) ) {
1565 return wfFormatStackFrame( $backtrace[$level] );
1572 * Return a string consisting of callers in the stack. Useful sometimes
1573 * for profiling specific points.
1575 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1578 function wfGetAllCallers( $limit = 3 ) {
1579 $trace = array_reverse( wfDebugBacktrace() );
1580 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1581 $limit = count( $trace ) - 1;
1583 $trace = array_slice( $trace, -$limit - 1, $limit );
1584 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1588 * Return a string representation of frame
1590 * @param array $frame
1593 function wfFormatStackFrame( $frame ) {
1594 if ( !isset( $frame['function'] ) ) {
1595 return 'NO_FUNCTION_GIVEN';
1597 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1598 $frame['class'] . $frame['type'] . $frame['function'] :
1602 /* Some generic result counters, pulled out of SearchEngine */
1607 * @param int $offset
1611 function wfShowingResults( $offset, $limit ) {
1612 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1616 * Whether the client accept gzip encoding
1618 * Uses the Accept-Encoding header to check if the client supports gzip encoding.
1619 * Use this when considering to send a gzip-encoded response to the client.
1621 * @param bool $force Forces another check even if we already have a cached result.
1624 function wfClientAcceptsGzip( $force = false ) {
1625 static $result = null;
1626 if ( $result === null ||
$force ) {
1628 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1629 # @todo FIXME: We may want to blacklist some broken browsers
1632 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1633 $_SERVER['HTTP_ACCEPT_ENCODING'],
1637 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1641 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1650 * Escapes the given text so that it may be output using addWikiText()
1651 * without any linking, formatting, etc. making its way through. This
1652 * is achieved by substituting certain characters with HTML entities.
1653 * As required by the callers, "<nowiki>" is not used.
1655 * @param string $text Text to be escaped
1658 function wfEscapeWikiText( $text ) {
1659 global $wgEnableMagicLinks;
1660 static $repl = null, $repl2 = null;
1661 if ( $repl === null ||
defined( 'MW_PARSER_TEST' ) ||
defined( 'MW_PHPUNIT_TEST' ) ) {
1662 // Tests depend upon being able to change $wgEnableMagicLinks, so don't cache
1663 // in those situations
1665 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1666 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1667 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1668 "\n#" => "\n#", "\r#" => "\r#",
1669 "\n*" => "\n*", "\r*" => "\r*",
1670 "\n:" => "\n:", "\r:" => "\r:",
1671 "\n " => "\n ", "\r " => "\r ",
1672 "\n\n" => "\n ", "\r\n" => " \n",
1673 "\n\r" => "\n ", "\r\r" => "\r ",
1674 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1675 "\n----" => "\n----", "\r----" => "\r----",
1676 '__' => '__', '://' => '://',
1679 $magicLinks = array_keys( array_filter( $wgEnableMagicLinks ) );
1680 // We have to catch everything "\s" matches in PCRE
1681 foreach ( $magicLinks as $magic ) {
1682 $repl["$magic "] = "$magic ";
1683 $repl["$magic\t"] = "$magic	";
1684 $repl["$magic\r"] = "$magic ";
1685 $repl["$magic\n"] = "$magic ";
1686 $repl["$magic\f"] = "$magic";
1689 // And handle protocols that don't use "://"
1690 global $wgUrlProtocols;
1692 foreach ( $wgUrlProtocols as $prot ) {
1693 if ( substr( $prot, -1 ) === ':' ) {
1694 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1697 $repl2 = $repl2 ?
'/\b(' . implode( '|', $repl2 ) . '):/i' : '/^(?!)/';
1699 $text = substr( strtr( "\n$text", $repl ), 1 );
1700 $text = preg_replace( $repl2, '$1:', $text );
1705 * Sets dest to source and returns the original value of dest
1706 * If source is NULL, it just returns the value, it doesn't set the variable
1707 * If force is true, it will set the value even if source is NULL
1709 * @param mixed $dest
1710 * @param mixed $source
1711 * @param bool $force
1714 function wfSetVar( &$dest, $source, $force = false ) {
1716 if ( !is_null( $source ) ||
$force ) {
1723 * As for wfSetVar except setting a bit
1727 * @param bool $state
1731 function wfSetBit( &$dest, $bit, $state = true ) {
1732 $temp = (bool)( $dest & $bit );
1733 if ( !is_null( $state ) ) {
1744 * A wrapper around the PHP function var_export().
1745 * Either print it or add it to the regular output ($wgOut).
1747 * @param mixed $var A PHP variable to dump.
1749 function wfVarDump( $var ) {
1751 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1752 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1755 $wgOut->addHTML( $s );
1760 * Provide a simple HTTP error.
1762 * @param int|string $code
1763 * @param string $label
1764 * @param string $desc
1766 function wfHttpError( $code, $label, $desc ) {
1768 HttpStatus
::header( $code );
1771 $wgOut->sendCacheControl();
1774 MediaWiki\HeaderCallback
::warnIfHeadersSent();
1775 header( 'Content-type: text/html; charset=utf-8' );
1776 print '<!DOCTYPE html>' .
1777 '<html><head><title>' .
1778 htmlspecialchars( $label ) .
1779 '</title></head><body><h1>' .
1780 htmlspecialchars( $label ) .
1782 nl2br( htmlspecialchars( $desc ) ) .
1783 "</p></body></html>\n";
1787 * Clear away any user-level output buffers, discarding contents.
1789 * Suitable for 'starting afresh', for instance when streaming
1790 * relatively large amounts of data without buffering, or wanting to
1791 * output image files without ob_gzhandler's compression.
1793 * The optional $resetGzipEncoding parameter controls suppression of
1794 * the Content-Encoding header sent by ob_gzhandler; by default it
1795 * is left. See comments for wfClearOutputBuffers() for why it would
1798 * Note that some PHP configuration options may add output buffer
1799 * layers which cannot be removed; these are left in place.
1801 * @param bool $resetGzipEncoding
1803 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1804 if ( $resetGzipEncoding ) {
1805 // Suppress Content-Encoding and Content-Length
1806 // headers from 1.10+s wfOutputHandler
1807 global $wgDisableOutputCompression;
1808 $wgDisableOutputCompression = true;
1810 while ( $status = ob_get_status() ) {
1811 if ( isset( $status['flags'] ) ) {
1812 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1813 $deleteable = ( $status['flags'] & $flags ) === $flags;
1814 } elseif ( isset( $status['del'] ) ) {
1815 $deleteable = $status['del'];
1817 // Guess that any PHP-internal setting can't be removed.
1818 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1820 if ( !$deleteable ) {
1821 // Give up, and hope the result doesn't break
1825 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1826 // Unit testing barrier to prevent this function from breaking PHPUnit.
1829 if ( !ob_end_clean() ) {
1830 // Could not remove output buffer handler; abort now
1831 // to avoid getting in some kind of infinite loop.
1834 if ( $resetGzipEncoding ) {
1835 if ( $status['name'] == 'ob_gzhandler' ) {
1836 // Reset the 'Content-Encoding' field set by this handler
1837 // so we can start fresh.
1838 header_remove( 'Content-Encoding' );
1846 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1848 * Clear away output buffers, but keep the Content-Encoding header
1849 * produced by ob_gzhandler, if any.
1851 * This should be used for HTTP 304 responses, where you need to
1852 * preserve the Content-Encoding header of the real result, but
1853 * also need to suppress the output of ob_gzhandler to keep to spec
1854 * and avoid breaking Firefox in rare cases where the headers and
1855 * body are broken over two packets.
1857 function wfClearOutputBuffers() {
1858 wfResetOutputBuffers( false );
1862 * Converts an Accept-* header into an array mapping string values to quality
1865 * @param string $accept
1866 * @param string $def Default
1867 * @return float[] Associative array of string => float pairs
1869 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1870 # No arg means accept anything (per HTTP spec)
1872 return [ $def => 1.0 ];
1877 $parts = explode( ',', $accept );
1879 foreach ( $parts as $part ) {
1880 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1881 $values = explode( ';', trim( $part ) );
1883 if ( count( $values ) == 1 ) {
1884 $prefs[$values[0]] = 1.0;
1885 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1886 $prefs[$values[0]] = floatval( $match[1] );
1894 * Checks if a given MIME type matches any of the keys in the given
1895 * array. Basic wildcards are accepted in the array keys.
1897 * Returns the matching MIME type (or wildcard) if a match, otherwise
1900 * @param string $type
1901 * @param array $avail
1905 function mimeTypeMatch( $type, $avail ) {
1906 if ( array_key_exists( $type, $avail ) ) {
1909 $mainType = explode( '/', $type )[0];
1910 if ( array_key_exists( "$mainType/*", $avail ) ) {
1911 return "$mainType/*";
1912 } elseif ( array_key_exists( '*/*', $avail ) ) {
1921 * Returns the 'best' match between a client's requested internet media types
1922 * and the server's list of available types. Each list should be an associative
1923 * array of type to preference (preference is a float between 0.0 and 1.0).
1924 * Wildcards in the types are acceptable.
1926 * @param array $cprefs Client's acceptable type list
1927 * @param array $sprefs Server's offered types
1930 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1931 * XXX: generalize to negotiate other stuff
1933 function wfNegotiateType( $cprefs, $sprefs ) {
1936 foreach ( array_keys( $sprefs ) as $type ) {
1937 $subType = explode( '/', $type )[1];
1938 if ( $subType != '*' ) {
1939 $ckey = mimeTypeMatch( $type, $cprefs );
1941 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1946 foreach ( array_keys( $cprefs ) as $type ) {
1947 $subType = explode( '/', $type )[1];
1948 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1949 $skey = mimeTypeMatch( $type, $sprefs );
1951 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
1959 foreach ( array_keys( $combine ) as $type ) {
1960 if ( $combine[$type] > $bestq ) {
1962 $bestq = $combine[$type];
1970 * Reference-counted warning suppression
1972 * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly
1975 function wfSuppressWarnings( $end = false ) {
1976 MediaWiki\
suppressWarnings( $end );
1980 * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly
1981 * Restore error level to previous value
1983 function wfRestoreWarnings() {
1984 MediaWiki\
suppressWarnings( true );
1988 * Get a timestamp string in one of various formats
1990 * @param mixed $outputtype A timestamp in one of the supported formats, the
1991 * function will autodetect which format is supplied and act accordingly.
1992 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
1993 * @return string|bool String / false The same date in the format specified in $outputtype or false
1995 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
1996 $ret = MWTimestamp
::convert( $outputtype, $ts );
1997 if ( $ret === false ) {
1998 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2004 * Return a formatted timestamp, or null if input is null.
2005 * For dealing with nullable timestamp columns in the database.
2007 * @param int $outputtype
2011 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2012 if ( is_null( $ts ) ) {
2015 return wfTimestamp( $outputtype, $ts );
2020 * Convenience function; returns MediaWiki timestamp for the present time.
2024 function wfTimestampNow() {
2026 return MWTimestamp
::now( TS_MW
);
2030 * Check if the operating system is Windows
2032 * @return bool True if it's Windows, false otherwise.
2034 function wfIsWindows() {
2035 static $isWindows = null;
2036 if ( $isWindows === null ) {
2037 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2043 * Check if we are running under HHVM
2047 function wfIsHHVM() {
2048 return defined( 'HHVM_VERSION' );
2052 * Tries to get the system directory for temporary files. First
2053 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2054 * environment variables are then checked in sequence, then
2055 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
2057 * NOTE: When possible, use instead the tmpfile() function to create
2058 * temporary files to avoid race conditions on file creation, etc.
2062 function wfTempDir() {
2063 global $wgTmpDirectory;
2065 if ( $wgTmpDirectory !== false ) {
2066 return $wgTmpDirectory;
2069 return TempFSFile
::getUsableTempDirectory();
2073 * Make directory, and make all parent directories if they don't exist
2075 * @param string $dir Full path to directory to create
2076 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2077 * @param string $caller Optional caller param for debugging.
2078 * @throws MWException
2081 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2082 global $wgDirectoryMode;
2084 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2085 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2088 if ( !is_null( $caller ) ) {
2089 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2092 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2096 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2098 if ( is_null( $mode ) ) {
2099 $mode = $wgDirectoryMode;
2102 // Turn off the normal warning, we're doing our own below
2103 MediaWiki\
suppressWarnings();
2104 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2105 MediaWiki\restoreWarnings
();
2108 // directory may have been created on another request since we last checked
2109 if ( is_dir( $dir ) ) {
2113 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2114 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2120 * Remove a directory and all its content.
2121 * Does not hide error.
2122 * @param string $dir
2124 function wfRecursiveRemoveDir( $dir ) {
2125 wfDebug( __FUNCTION__
. "( $dir )\n" );
2126 // taken from https://secure.php.net/manual/en/function.rmdir.php#98622
2127 if ( is_dir( $dir ) ) {
2128 $objects = scandir( $dir );
2129 foreach ( $objects as $object ) {
2130 if ( $object != "." && $object != ".." ) {
2131 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2132 wfRecursiveRemoveDir( $dir . '/' . $object );
2134 unlink( $dir . '/' . $object );
2144 * @param int $nr The number to format
2145 * @param int $acc The number of digits after the decimal point, default 2
2146 * @param bool $round Whether or not to round the value, default true
2149 function wfPercent( $nr, $acc = 2, $round = true ) {
2150 $ret = sprintf( "%.${acc}f", $nr );
2151 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2155 * Safety wrapper around ini_get() for boolean settings.
2156 * The values returned from ini_get() are pre-normalized for settings
2157 * set via php.ini or php_flag/php_admin_flag... but *not*
2158 * for those set via php_value/php_admin_value.
2160 * It's fairly common for people to use php_value instead of php_flag,
2161 * which can leave you with an 'off' setting giving a false positive
2162 * for code that just takes the ini_get() return value as a boolean.
2164 * To make things extra interesting, setting via php_value accepts
2165 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2166 * Unrecognized values go false... again opposite PHP's own coercion
2167 * from string to bool.
2169 * Luckily, 'properly' set settings will always come back as '0' or '1',
2170 * so we only have to worry about them and the 'improper' settings.
2172 * I frickin' hate PHP... :P
2174 * @param string $setting
2177 function wfIniGetBool( $setting ) {
2178 $val = strtolower( ini_get( $setting ) );
2179 // 'on' and 'true' can't have whitespace around them, but '1' can.
2183 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2187 * Version of escapeshellarg() that works better on Windows.
2189 * Originally, this fixed the incorrect use of single quotes on Windows
2190 * (https://bugs.php.net/bug.php?id=26285) and the locale problems on Linux in
2191 * PHP 5.2.6+ (bug backported to earlier distro releases of PHP).
2193 * @param string ... strings to escape and glue together, or a single array of strings parameter
2196 function wfEscapeShellArg( /*...*/ ) {
2197 wfInitShellLocale();
2199 $args = func_get_args();
2200 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2201 // If only one argument has been passed, and that argument is an array,
2202 // treat it as a list of arguments
2203 $args = reset( $args );
2208 foreach ( $args as $arg ) {
2215 if ( wfIsWindows() ) {
2216 // Escaping for an MSVC-style command line parser and CMD.EXE
2217 // @codingStandardsIgnoreStart For long URLs
2219 // * https://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2220 // * https://technet.microsoft.com/en-us/library/cc723564.aspx
2223 // Double the backslashes before any double quotes. Escape the double quotes.
2224 // @codingStandardsIgnoreEnd
2225 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2228 foreach ( $tokens as $token ) {
2229 if ( $iteration %
2 == 1 ) {
2230 // Delimiter, a double quote preceded by zero or more slashes
2231 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2232 } elseif ( $iteration %
4 == 2 ) {
2233 // ^ in $token will be outside quotes, need to be escaped
2234 $arg .= str_replace( '^', '^^', $token );
2235 } else { // $iteration % 4 == 0
2236 // ^ in $token will appear inside double quotes, so leave as is
2241 // Double the backslashes before the end of the string, because
2242 // we will soon add a quote
2244 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2245 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2248 // Add surrounding quotes
2249 $retVal .= '"' . $arg . '"';
2251 $retVal .= escapeshellarg( $arg );
2258 * Check if wfShellExec() is effectively disabled via php.ini config
2260 * @return bool|string False or 'disabled'
2263 function wfShellExecDisabled() {
2264 static $disabled = null;
2265 if ( is_null( $disabled ) ) {
2266 if ( !function_exists( 'proc_open' ) ) {
2267 wfDebug( "proc_open() is disabled\n" );
2268 $disabled = 'disabled';
2277 * Execute a shell command, with time and memory limits mirrored from the PHP
2278 * configuration if supported.
2280 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2281 * or an array of unescaped arguments, in which case each value will be escaped
2282 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2283 * @param null|mixed &$retval Optional, will receive the program's exit code.
2284 * (non-zero is usually failure). If there is an error from
2285 * read, select, or proc_open(), this will be set to -1.
2286 * @param array $environ Optional environment variables which should be
2287 * added to the executed command environment.
2288 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2289 * this overwrites the global wgMaxShell* limits.
2290 * @param array $options Array of options:
2291 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2292 * including errors from limit.sh
2293 * - profileMethod: By default this function will profile based on the calling
2294 * method. Set this to a string for an alternative method to profile from
2296 * @return string Collected stdout as a string
2298 function wfShellExec( $cmd, &$retval = null, $environ = [],
2299 $limits = [], $options = []
2301 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2302 $wgMaxShellWallClockTime, $wgShellCgroup;
2304 $disabled = wfShellExecDisabled();
2307 return 'Unable to run external programs, proc_open() is disabled.';
2310 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2311 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2313 wfInitShellLocale();
2316 foreach ( $environ as $k => $v ) {
2317 if ( wfIsWindows() ) {
2318 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2319 * appear in the environment variable, so we must use carat escaping as documented in
2320 * https://technet.microsoft.com/en-us/library/cc723564.aspx
2321 * Note however that the quote isn't listed there, but is needed, and the parentheses
2322 * are listed there but doesn't appear to need it.
2324 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2326 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2327 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2329 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2332 if ( is_array( $cmd ) ) {
2333 $cmd = wfEscapeShellArg( $cmd );
2336 $cmd = $envcmd . $cmd;
2338 $useLogPipe = false;
2339 if ( is_executable( '/bin/bash' ) ) {
2340 $time = intval( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2341 if ( isset( $limits['walltime'] ) ) {
2342 $wallTime = intval( $limits['walltime'] );
2343 } elseif ( isset( $limits['time'] ) ) {
2346 $wallTime = intval( $wgMaxShellWallClockTime );
2348 $mem = intval( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2349 $filesize = intval( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2351 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2352 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2353 escapeshellarg( $cmd ) . ' ' .
2355 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2356 "MW_CPU_LIMIT=$time; " .
2357 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2358 "MW_MEM_LIMIT=$mem; " .
2359 "MW_FILE_SIZE_LIMIT=$filesize; " .
2360 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2361 "MW_USE_LOG_PIPE=yes"
2364 } elseif ( $includeStderr ) {
2367 } elseif ( $includeStderr ) {
2370 wfDebug( "wfShellExec: $cmd\n" );
2372 // Don't try to execute commands that exceed Linux's MAX_ARG_STRLEN.
2373 // Other platforms may be more accomodating, but we don't want to be
2374 // accomodating, because very long commands probably include user
2375 // input. See T129506.
2376 if ( strlen( $cmd ) > SHELL_MAX_ARG_STRLEN
) {
2377 throw new Exception( __METHOD__
.
2378 '(): total length of $cmd must not exceed SHELL_MAX_ARG_STRLEN' );
2382 0 => [ 'file', 'php://stdin', 'r' ],
2383 1 => [ 'pipe', 'w' ],
2384 2 => [ 'file', 'php://stderr', 'w' ] ];
2385 if ( $useLogPipe ) {
2386 $desc[3] = [ 'pipe', 'w' ];
2389 $scoped = Profiler
::instance()->scopedProfileIn( __FUNCTION__
. '-' . $profileMethod );
2390 $proc = proc_open( $cmd, $desc, $pipes );
2392 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2396 $outBuffer = $logBuffer = '';
2401 /* According to the documentation, it is possible for stream_select()
2402 * to fail due to EINTR. I haven't managed to induce this in testing
2403 * despite sending various signals. If it did happen, the error
2404 * message would take the form:
2406 * stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2408 * where [4] is the value of the macro EINTR and "Interrupted system
2409 * call" is string which according to the Linux manual is "possibly"
2410 * localised according to LC_MESSAGES.
2412 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2413 $eintrMessage = "stream_select(): unable to select [$eintr]";
2419 while ( $running === true ||
$numReadyPipes !== 0 ) {
2421 $status = proc_get_status( $proc );
2422 // If the process has terminated, switch to nonblocking selects
2423 // for getting any data still waiting to be read.
2424 if ( !$status['running'] ) {
2430 $readyPipes = $pipes;
2433 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2434 @trigger_error
( '' );
2435 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2436 if ( $numReadyPipes === false ) {
2437 // @codingStandardsIgnoreEnd
2438 $error = error_get_last();
2439 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2442 trigger_error( $error['message'], E_USER_WARNING
);
2443 $logMsg = $error['message'];
2447 foreach ( $readyPipes as $fd => $pipe ) {
2448 $block = fread( $pipe, 65536 );
2449 if ( $block === '' ) {
2451 fclose( $pipes[$fd] );
2452 unset( $pipes[$fd] );
2456 } elseif ( $block === false ) {
2458 $logMsg = "Error reading from pipe";
2460 } elseif ( $fd == 1 ) {
2462 $outBuffer .= $block;
2463 } elseif ( $fd == 3 ) {
2465 $logBuffer .= $block;
2466 if ( strpos( $block, "\n" ) !== false ) {
2467 $lines = explode( "\n", $logBuffer );
2468 $logBuffer = array_pop( $lines );
2469 foreach ( $lines as $line ) {
2470 wfDebugLog( 'exec', $line );
2477 foreach ( $pipes as $pipe ) {
2481 // Use the status previously collected if possible, since proc_get_status()
2482 // just calls waitpid() which will not return anything useful the second time.
2484 $status = proc_get_status( $proc );
2487 if ( $logMsg !== false ) {
2488 // Read/select error
2490 proc_close( $proc );
2491 } elseif ( $status['signaled'] ) {
2492 $logMsg = "Exited with signal {$status['termsig']}";
2493 $retval = 128 +
$status['termsig'];
2494 proc_close( $proc );
2496 if ( $status['running'] ) {
2497 $retval = proc_close( $proc );
2499 $retval = $status['exitcode'];
2500 proc_close( $proc );
2502 if ( $retval == 127 ) {
2503 $logMsg = "Possibly missing executable file";
2504 } elseif ( $retval >= 129 && $retval <= 192 ) {
2505 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2509 if ( $logMsg !== false ) {
2510 wfDebugLog( 'exec', "$logMsg: $cmd" );
2517 * Execute a shell command, returning both stdout and stderr. Convenience
2518 * function, as all the arguments to wfShellExec can become unwieldy.
2520 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2521 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2522 * or an array of unescaped arguments, in which case each value will be escaped
2523 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2524 * @param null|mixed &$retval Optional, will receive the program's exit code.
2525 * (non-zero is usually failure)
2526 * @param array $environ Optional environment variables which should be
2527 * added to the executed command environment.
2528 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2529 * this overwrites the global wgMaxShell* limits.
2530 * @return string Collected stdout and stderr as a string
2532 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2533 return wfShellExec( $cmd, $retval, $environ, $limits,
2534 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2538 * Workaround for https://bugs.php.net/bug.php?id=45132
2539 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2541 function wfInitShellLocale() {
2542 static $done = false;
2547 global $wgShellLocale;
2548 putenv( "LC_CTYPE=$wgShellLocale" );
2549 setlocale( LC_CTYPE
, $wgShellLocale );
2553 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2554 * Note that $parameters should be a flat array and an option with an argument
2555 * should consist of two consecutive items in the array (do not use "--option value").
2557 * @param string $script MediaWiki cli script path
2558 * @param array $parameters Arguments and options to the script
2559 * @param array $options Associative array of options:
2560 * 'php': The path to the php executable
2561 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2564 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2566 // Give site config file a chance to run the script in a wrapper.
2567 // The caller may likely want to call wfBasename() on $script.
2568 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2569 $cmd = isset( $options['php'] ) ?
[ $options['php'] ] : [ $wgPhpCli ];
2570 if ( isset( $options['wrapper'] ) ) {
2571 $cmd[] = $options['wrapper'];
2574 // Escape each parameter for shell
2575 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
2579 * wfMerge attempts to merge differences between three texts.
2580 * Returns true for a clean merge and false for failure or a conflict.
2582 * @param string $old
2583 * @param string $mine
2584 * @param string $yours
2585 * @param string $result
2588 function wfMerge( $old, $mine, $yours, &$result ) {
2591 # This check may also protect against code injection in
2592 # case of broken installations.
2593 MediaWiki\
suppressWarnings();
2594 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2595 MediaWiki\restoreWarnings
();
2597 if ( !$haveDiff3 ) {
2598 wfDebug( "diff3 not found\n" );
2602 # Make temporary files
2604 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2605 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2606 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2608 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2609 # a newline character. To avoid this, we normalize the trailing whitespace before
2610 # creating the diff.
2612 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2613 fclose( $oldtextFile );
2614 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2615 fclose( $mytextFile );
2616 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2617 fclose( $yourtextFile );
2619 # Check for a conflict
2620 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName,
2621 $oldtextName, $yourtextName );
2622 $handle = popen( $cmd, 'r' );
2624 if ( fgets( $handle, 1024 ) ) {
2632 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2633 $oldtextName, $yourtextName );
2634 $handle = popen( $cmd, 'r' );
2637 $data = fread( $handle, 8192 );
2638 if ( strlen( $data ) == 0 ) {
2644 unlink( $mytextName );
2645 unlink( $oldtextName );
2646 unlink( $yourtextName );
2648 if ( $result === '' && $old !== '' && !$conflict ) {
2649 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2656 * Returns unified plain-text diff of two texts.
2657 * "Useful" for machine processing of diffs.
2659 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2661 * @param string $before The text before the changes.
2662 * @param string $after The text after the changes.
2663 * @param string $params Command-line options for the diff command.
2664 * @return string Unified diff of $before and $after
2666 function wfDiff( $before, $after, $params = '-u' ) {
2667 if ( $before == $after ) {
2672 MediaWiki\
suppressWarnings();
2673 $haveDiff = $wgDiff && file_exists( $wgDiff );
2674 MediaWiki\restoreWarnings
();
2676 # This check may also protect against code injection in
2677 # case of broken installations.
2679 wfDebug( "diff executable not found\n" );
2680 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2681 $format = new UnifiedDiffFormatter();
2682 return $format->format( $diffs );
2685 # Make temporary files
2687 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2688 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2690 fwrite( $oldtextFile, $before );
2691 fclose( $oldtextFile );
2692 fwrite( $newtextFile, $after );
2693 fclose( $newtextFile );
2695 // Get the diff of the two files
2696 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2698 $h = popen( $cmd, 'r' );
2700 unlink( $oldtextName );
2701 unlink( $newtextName );
2702 throw new Exception( __METHOD__
. '(): popen() failed' );
2708 $data = fread( $h, 8192 );
2709 if ( strlen( $data ) == 0 ) {
2717 unlink( $oldtextName );
2718 unlink( $newtextName );
2720 // Kill the --- and +++ lines. They're not useful.
2721 $diff_lines = explode( "\n", $diff );
2722 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2723 unset( $diff_lines[0] );
2725 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2726 unset( $diff_lines[1] );
2729 $diff = implode( "\n", $diff_lines );
2735 * This function works like "use VERSION" in Perl, the program will die with a
2736 * backtrace if the current version of PHP is less than the version provided
2738 * This is useful for extensions which due to their nature are not kept in sync
2739 * with releases, and might depend on other versions of PHP than the main code
2741 * Note: PHP might die due to parsing errors in some cases before it ever
2742 * manages to call this function, such is life
2744 * @see perldoc -f use
2746 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2747 * @throws MWException
2749 function wfUsePHP( $req_ver ) {
2750 $php_ver = PHP_VERSION
;
2752 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2753 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2758 * This function works like "use VERSION" in Perl except it checks the version
2759 * of MediaWiki, the program will die with a backtrace if the current version
2760 * of MediaWiki is less than the version provided.
2762 * This is useful for extensions which due to their nature are not kept in sync
2765 * Note: Due to the behavior of PHP's version_compare() which is used in this
2766 * function, if you want to allow the 'wmf' development versions add a 'c' (or
2767 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
2768 * targeted version number. For example if you wanted to allow any variation
2769 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
2770 * not result in the same comparison due to the internal logic of
2771 * version_compare().
2773 * @see perldoc -f use
2775 * @deprecated since 1.26, use the "requires' property of extension.json
2776 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2777 * @throws MWException
2779 function wfUseMW( $req_ver ) {
2782 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2783 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2788 * Return the final portion of a pathname.
2789 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2790 * https://bugs.php.net/bug.php?id=33898
2792 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2793 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2795 * @param string $path
2796 * @param string $suffix String to remove if present
2799 function wfBaseName( $path, $suffix = '' ) {
2800 if ( $suffix == '' ) {
2803 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2807 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2815 * Generate a relative path name to the given file.
2816 * May explode on non-matching case-insensitive paths,
2817 * funky symlinks, etc.
2819 * @param string $path Absolute destination path including target filename
2820 * @param string $from Absolute source path, directory only
2823 function wfRelativePath( $path, $from ) {
2824 // Normalize mixed input on Windows...
2825 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2826 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2828 // Trim trailing slashes -- fix for drive root
2829 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2830 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2832 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2833 $against = explode( DIRECTORY_SEPARATOR
, $from );
2835 if ( $pieces[0] !== $against[0] ) {
2836 // Non-matching Windows drive letters?
2837 // Return a full path.
2841 // Trim off common prefix
2842 while ( count( $pieces ) && count( $against )
2843 && $pieces[0] == $against[0] ) {
2844 array_shift( $pieces );
2845 array_shift( $against );
2848 // relative dots to bump us to the parent
2849 while ( count( $against ) ) {
2850 array_unshift( $pieces, '..' );
2851 array_shift( $against );
2854 array_push( $pieces, wfBaseName( $path ) );
2856 return implode( DIRECTORY_SEPARATOR
, $pieces );
2860 * Convert an arbitrarily-long digit string from one numeric base
2861 * to another, optionally zero-padding to a minimum column width.
2863 * Supports base 2 through 36; digit values 10-36 are represented
2864 * as lowercase letters a-z. Input is case-insensitive.
2866 * @deprecated since 1.27 Use Wikimedia\base_convert() directly
2868 * @param string $input Input number
2869 * @param int $sourceBase Base of the input number
2870 * @param int $destBase Desired base of the output
2871 * @param int $pad Minimum number of digits in the output (pad with zeroes)
2872 * @param bool $lowercase Whether to output in lowercase or uppercase
2873 * @param string $engine Either "gmp", "bcmath", or "php"
2874 * @return string|bool The output number as a string, or false on error
2876 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
2877 $lowercase = true, $engine = 'auto'
2879 return Wikimedia\base_convert
( $input, $sourceBase, $destBase, $pad, $lowercase, $engine );
2883 * @deprecated since 1.27, PHP's session generation isn't used with
2884 * MediaWiki\Session\SessionManager
2886 function wfFixSessionID() {
2887 wfDeprecated( __FUNCTION__
, '1.27' );
2891 * Reset the session id
2893 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead
2896 function wfResetSessionID() {
2897 wfDeprecated( __FUNCTION__
, '1.27' );
2898 $session = SessionManager
::getGlobalSession();
2899 $delay = $session->delaySave();
2901 $session->resetId();
2903 // Make sure a session is started, since that's what the old
2904 // wfResetSessionID() did.
2905 if ( session_id() !== $session->getId() ) {
2906 wfSetupSession( $session->getId() );
2909 ScopedCallback
::consume( $delay );
2913 * Initialise php session
2915 * @deprecated since 1.27, use MediaWiki\Session\SessionManager instead.
2916 * Generally, "using" SessionManager will be calling ->getSessionById() or
2917 * ::getGlobalSession() (depending on whether you were passing $sessionId
2918 * here), then calling $session->persist().
2919 * @param bool|string $sessionId
2921 function wfSetupSession( $sessionId = false ) {
2922 wfDeprecated( __FUNCTION__
, '1.27' );
2925 session_id( $sessionId );
2928 $session = SessionManager
::getGlobalSession();
2929 $session->persist();
2931 if ( session_id() !== $session->getId() ) {
2932 session_id( $session->getId() );
2934 MediaWiki\
quietCall( 'session_start' );
2938 * Get an object from the precompiled serialized directory
2940 * @param string $name
2941 * @return mixed The variable on success, false on failure
2943 function wfGetPrecompiledData( $name ) {
2946 $file = "$IP/serialized/$name";
2947 if ( file_exists( $file ) ) {
2948 $blob = file_get_contents( $file );
2950 return unserialize( $blob );
2957 * Make a cache key for the local wiki.
2959 * @param string $args,...
2962 function wfMemcKey( /*...*/ ) {
2963 return call_user_func_array(
2964 [ ObjectCache
::getLocalClusterInstance(), 'makeKey' ],
2970 * Make a cache key for a foreign DB.
2972 * Must match what wfMemcKey() would produce in context of the foreign wiki.
2975 * @param string $prefix
2976 * @param string $args,...
2979 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
2980 $args = array_slice( func_get_args(), 2 );
2981 $keyspace = $prefix ?
"$db-$prefix" : $db;
2982 return call_user_func_array(
2983 [ ObjectCache
::getLocalClusterInstance(), 'makeKeyInternal' ],
2984 [ $keyspace, $args ]
2989 * Make a cache key with database-agnostic prefix.
2991 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
2992 * instead. Must have a prefix as otherwise keys that use a database name
2993 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
2996 * @param string $args,...
2999 function wfGlobalCacheKey( /*...*/ ) {
3000 return call_user_func_array(
3001 [ ObjectCache
::getLocalClusterInstance(), 'makeGlobalKey' ],
3007 * Get an ASCII string identifying this wiki
3008 * This is used as a prefix in memcached keys
3012 function wfWikiID() {
3013 global $wgDBprefix, $wgDBname;
3014 if ( $wgDBprefix ) {
3015 return "$wgDBname-$wgDBprefix";
3022 * Split a wiki ID into DB name and table prefix
3024 * @param string $wiki
3028 function wfSplitWikiID( $wiki ) {
3029 $bits = explode( '-', $wiki, 2 );
3030 if ( count( $bits ) < 2 ) {
3037 * Get a Database object.
3039 * @param int $db Index of the connection to get. May be DB_MASTER for the
3040 * master (for write queries), DB_REPLICA for potentially lagged read
3041 * queries, or an integer >= 0 for a particular server.
3043 * @param string|string[] $groups Query groups. An array of group names that this query
3044 * belongs to. May contain a single string if the query is only
3047 * @param string|bool $wiki The wiki ID, or false for the current wiki
3049 * Note: multiple calls to wfGetDB(DB_REPLICA) during the course of one request
3050 * will always return the same object, unless the underlying connection or load
3051 * balancer is manually destroyed.
3053 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3054 * updater to ensure that a proper database is being updated.
3056 * @todo Replace calls to wfGetDB with calls to LoadBalancer::getConnection()
3057 * on an injected instance of LoadBalancer.
3059 * @return \Wikimedia\Rdbms\Database
3061 function wfGetDB( $db, $groups = [], $wiki = false ) {
3062 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3066 * Get a load balancer object.
3068 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancer()
3069 * or MediaWikiServices::getDBLoadBalancerFactory() instead.
3071 * @param string|bool $wiki Wiki ID, or false for the current wiki
3072 * @return \Wikimedia\Rdbms\LoadBalancer
3074 function wfGetLB( $wiki = false ) {
3075 if ( $wiki === false ) {
3076 return \MediaWiki\MediaWikiServices
::getInstance()->getDBLoadBalancer();
3078 $factory = \MediaWiki\MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3079 return $factory->getMainLB( $wiki );
3084 * Get the load balancer factory object
3086 * @deprecated since 1.27, use MediaWikiServices::getDBLoadBalancerFactory() instead.
3088 * @return \Wikimedia\Rdbms\LBFactory
3090 function wfGetLBFactory() {
3091 return \MediaWiki\MediaWikiServices
::getInstance()->getDBLoadBalancerFactory();
3096 * Shortcut for RepoGroup::singleton()->findFile()
3098 * @param string $title String or Title object
3099 * @param array $options Associative array of options (see RepoGroup::findFile)
3100 * @return File|bool File, or false if the file does not exist
3102 function wfFindFile( $title, $options = [] ) {
3103 return RepoGroup
::singleton()->findFile( $title, $options );
3107 * Get an object referring to a locally registered file.
3108 * Returns a valid placeholder object if the file does not exist.
3110 * @param Title|string $title
3111 * @return LocalFile|null A File, or null if passed an invalid Title
3113 function wfLocalFile( $title ) {
3114 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3118 * Should low-performance queries be disabled?
3121 * @codeCoverageIgnore
3123 function wfQueriesMustScale() {
3124 global $wgMiserMode;
3126 ||
( SiteStats
::pages() > 100000
3127 && SiteStats
::edits() > 1000000
3128 && SiteStats
::users() > 10000 );
3132 * Get the path to a specified script file, respecting file
3133 * extensions; this is a wrapper around $wgScriptPath etc.
3134 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3136 * @param string $script Script filename, sans extension
3139 function wfScript( $script = 'index' ) {
3140 global $wgScriptPath, $wgScript, $wgLoadScript;
3141 if ( $script === 'index' ) {
3143 } elseif ( $script === 'load' ) {
3144 return $wgLoadScript;
3146 return "{$wgScriptPath}/{$script}.php";
3151 * Get the script URL.
3153 * @return string Script URL
3155 function wfGetScriptUrl() {
3156 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3157 /* as it was called, minus the query string.
3159 * Some sites use Apache rewrite rules to handle subdomains,
3160 * and have PHP set up in a weird way that causes PHP_SELF
3161 * to contain the rewritten URL instead of the one that the
3162 * outside world sees.
3164 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
3165 * provides containing the "before" URL.
3167 return $_SERVER['SCRIPT_NAME'];
3169 return $_SERVER['URL'];
3174 * Convenience function converts boolean values into "true"
3175 * or "false" (string) values
3177 * @param bool $value
3180 function wfBoolToStr( $value ) {
3181 return $value ?
'true' : 'false';
3185 * Get a platform-independent path to the null file, e.g. /dev/null
3189 function wfGetNull() {
3190 return wfIsWindows() ?
'NUL' : '/dev/null';
3194 * Waits for the replica DBs to catch up to the master position
3196 * Use this when updating very large numbers of rows, as in maintenance scripts,
3197 * to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.
3199 * By default this waits on the main DB cluster of the current wiki.
3200 * If $cluster is set to "*" it will wait on all DB clusters, including
3201 * external ones. If the lag being waiting on is caused by the code that
3202 * does this check, it makes since to use $ifWritesSince, particularly if
3203 * cluster is "*", to avoid excess overhead.
3205 * Never call this function after a big DB write that is still in a transaction.
3206 * This only makes sense after the possible lag inducing changes were committed.
3208 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3209 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3210 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3211 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3212 * @return bool Success (able to connect and no timeouts reached)
3213 * @deprecated since 1.27 Use LBFactory::waitForReplication
3215 function wfWaitForSlaves(
3216 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3218 if ( $timeout === null ) {
3219 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3222 if ( $cluster === '*' ) {
3225 } elseif ( $wiki === false ) {
3230 wfGetLBFactory()->waitForReplication( [
3232 'cluster' => $cluster,
3233 'timeout' => $timeout,
3234 // B/C: first argument used to be "max seconds of lag"; ignore such values
3235 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
3237 } catch ( DBReplicationWaitError
$e ) {
3245 * Count down from $seconds to zero on the terminal, with a one-second pause
3246 * between showing each number. For use in command-line scripts.
3248 * @codeCoverageIgnore
3249 * @param int $seconds
3251 function wfCountDown( $seconds ) {
3252 for ( $i = $seconds; $i >= 0; $i-- ) {
3253 if ( $i != $seconds ) {
3254 echo str_repeat( "\x08", strlen( $i +
1 ) );
3266 * Replace all invalid characters with '-'.
3267 * Additional characters can be defined in $wgIllegalFileChars (see T22489).
3268 * By default, $wgIllegalFileChars includes ':', '/', '\'.
3270 * @param string $name Filename to process
3273 function wfStripIllegalFilenameChars( $name ) {
3274 global $wgIllegalFileChars;
3275 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3276 $name = preg_replace(
3277 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3281 // $wgIllegalFileChars may not include '/' and '\', so we still need to do this
3282 $name = wfBaseName( $name );
3287 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3289 * @return int Resulting value of the memory limit.
3291 function wfMemoryLimit() {
3292 global $wgMemoryLimit;
3293 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3294 if ( $memlimit != -1 ) {
3295 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3296 if ( $conflimit == -1 ) {
3297 wfDebug( "Removing PHP's memory limit\n" );
3298 MediaWiki\
suppressWarnings();
3299 ini_set( 'memory_limit', $conflimit );
3300 MediaWiki\restoreWarnings
();
3302 } elseif ( $conflimit > $memlimit ) {
3303 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3304 MediaWiki\
suppressWarnings();
3305 ini_set( 'memory_limit', $conflimit );
3306 MediaWiki\restoreWarnings
();
3314 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3316 * @return int Prior time limit
3319 function wfTransactionalTimeLimit() {
3320 global $wgTransactionalTimeLimit;
3322 $timeLimit = ini_get( 'max_execution_time' );
3323 // Note that CLI scripts use 0
3324 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3325 set_time_limit( $wgTransactionalTimeLimit );
3328 ignore_user_abort( true ); // ignore client disconnects
3334 * Converts shorthand byte notation to integer form
3336 * @param string $string
3337 * @param int $default Returned if $string is empty
3340 function wfShorthandToInteger( $string = '', $default = -1 ) {
3341 $string = trim( $string );
3342 if ( $string === '' ) {
3345 $last = $string[strlen( $string ) - 1];
3346 $val = intval( $string );
3351 // break intentionally missing
3355 // break intentionally missing
3365 * Get the normalised IETF language tag
3366 * See unit test for examples.
3368 * @param string $code The language code.
3369 * @return string The language code which complying with BCP 47 standards.
3371 function wfBCP47( $code ) {
3372 $codeSegment = explode( '-', $code );
3374 foreach ( $codeSegment as $segNo => $seg ) {
3375 // when previous segment is x, it is a private segment and should be lc
3376 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3377 $codeBCP[$segNo] = strtolower( $seg );
3378 // ISO 3166 country code
3379 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3380 $codeBCP[$segNo] = strtoupper( $seg );
3381 // ISO 15924 script code
3382 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3383 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3384 // Use lowercase for other cases
3386 $codeBCP[$segNo] = strtolower( $seg );
3389 $langCode = implode( '-', $codeBCP );
3394 * Get a specific cache object.
3396 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3399 function wfGetCache( $cacheType ) {
3400 return ObjectCache
::getInstance( $cacheType );
3404 * Get the main cache object
3408 function wfGetMainCache() {
3409 global $wgMainCacheType;
3410 return ObjectCache
::getInstance( $wgMainCacheType );
3414 * Get the cache object used by the message cache
3418 function wfGetMessageCacheStorage() {
3419 global $wgMessageCacheType;
3420 return ObjectCache
::getInstance( $wgMessageCacheType );
3424 * Get the cache object used by the parser cache
3428 function wfGetParserCacheStorage() {
3429 global $wgParserCacheType;
3430 return ObjectCache
::getInstance( $wgParserCacheType );
3434 * Call hook functions defined in $wgHooks
3436 * @param string $event Event name
3437 * @param array $args Parameters passed to hook functions
3438 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3440 * @return bool True if no handler aborted the hook
3441 * @deprecated since 1.25 - use Hooks::run
3443 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3444 return Hooks
::run( $event, $args, $deprecatedVersion );
3448 * Wrapper around php's unpack.
3450 * @param string $format The format string (See php's docs)
3451 * @param string $data A binary string of binary data
3452 * @param int|bool $length The minimum length of $data or false. This is to
3453 * prevent reading beyond the end of $data. false to disable the check.
3455 * Also be careful when using this function to read unsigned 32 bit integer
3456 * because php might make it negative.
3458 * @throws MWException If $data not long enough, or if unpack fails
3459 * @return array Associative array of the extracted data
3461 function wfUnpack( $format, $data, $length = false ) {
3462 if ( $length !== false ) {
3463 $realLen = strlen( $data );
3464 if ( $realLen < $length ) {
3465 throw new MWException( "Tried to use wfUnpack on a "
3466 . "string of length $realLen, but needed one "
3467 . "of at least length $length."
3472 MediaWiki\
suppressWarnings();
3473 $result = unpack( $format, $data );
3474 MediaWiki\restoreWarnings
();
3476 if ( $result === false ) {
3477 // If it cannot extract the packed data.
3478 throw new MWException( "unpack could not unpack binary data" );
3484 * Determine if an image exists on the 'bad image list'.
3486 * The format of MediaWiki:Bad_image_list is as follows:
3487 * * Only list items (lines starting with "*") are considered
3488 * * The first link on a line must be a link to a bad image
3489 * * Any subsequent links on the same line are considered to be exceptions,
3490 * i.e. articles where the image may occur inline.
3492 * @param string $name The image name to check
3493 * @param Title|bool $contextTitle The page on which the image occurs, if known
3494 * @param string $blacklist Wikitext of a file blacklist
3497 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3498 # Handle redirects; callers almost always hit wfFindFile() anyway,
3499 # so just use that method because it has a fast process cache.
3500 $file = wfFindFile( $name ); // get the final name
3501 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3503 # Run the extension hook
3505 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3509 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3510 $key = wfMemcKey( 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist ) );
3511 $badImages = $cache->get( $key );
3513 if ( $badImages === false ) { // cache miss
3514 if ( $blacklist === null ) {
3515 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3517 # Build the list now
3519 $lines = explode( "\n", $blacklist );
3520 foreach ( $lines as $line ) {
3522 if ( substr( $line, 0, 1 ) !== '*' ) {
3528 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3533 $imageDBkey = false;
3534 foreach ( $m[1] as $i => $titleText ) {
3535 $title = Title
::newFromText( $titleText );
3536 if ( !is_null( $title ) ) {
3538 $imageDBkey = $title->getDBkey();
3540 $exceptions[$title->getPrefixedDBkey()] = true;
3545 if ( $imageDBkey !== false ) {
3546 $badImages[$imageDBkey] = $exceptions;
3549 $cache->set( $key, $badImages, 60 );
3552 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3553 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3559 * Determine whether the client at a given source IP is likely to be able to
3560 * access the wiki via HTTPS.
3562 * @param string $ip The IPv4/6 address in the normal human-readable form
3565 function wfCanIPUseHTTPS( $ip ) {
3567 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3572 * Determine input string is represents as infinity
3574 * @param string $str The string to determine
3578 function wfIsInfinity( $str ) {
3579 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3580 return in_array( $str, $infinityValues );
3584 * Returns true if these thumbnail parameters match one that MediaWiki
3585 * requests from file description pages and/or parser output.
3587 * $params is considered non-standard if they involve a non-standard
3588 * width or any non-default parameters aside from width and page number.
3589 * The number of possible files with standard parameters is far less than
3590 * that of all combinations; rate-limiting for them can thus be more generious.
3593 * @param array $params
3595 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3597 function wfThumbIsStandard( File
$file, array $params ) {
3598 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3600 $multipliers = [ 1 ];
3601 if ( $wgResponsiveImages ) {
3602 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3603 // @see Linker::processResponsiveImages
3604 $multipliers[] = 1.5;
3608 $handler = $file->getHandler();
3609 if ( !$handler ||
!isset( $params['width'] ) ) {
3614 if ( isset( $params['page'] ) ) {
3615 $basicParams['page'] = $params['page'];
3620 // Expand limits to account for multipliers
3621 foreach ( $multipliers as $multiplier ) {
3622 $thumbLimits = array_merge( $thumbLimits, array_map(
3623 function ( $width ) use ( $multiplier ) {
3624 return round( $width * $multiplier );
3627 $imageLimits = array_merge( $imageLimits, array_map(
3628 function ( $pair ) use ( $multiplier ) {
3630 round( $pair[0] * $multiplier ),
3631 round( $pair[1] * $multiplier ),
3637 // Check if the width matches one of $wgThumbLimits
3638 if ( in_array( $params['width'], $thumbLimits ) ) {
3639 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3640 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3641 $handler->normaliseParams( $file, $normalParams );
3643 // If not, then check if the width matchs one of $wgImageLimits
3645 foreach ( $imageLimits as $pair ) {
3646 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3647 // Decide whether the thumbnail should be scaled on width or height.
3648 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3649 $handler->normaliseParams( $file, $normalParams );
3650 // Check if this standard thumbnail size maps to the given width
3651 if ( $normalParams['width'] == $params['width'] ) {
3657 return false; // not standard for description pages
3661 // Check that the given values for non-page, non-width, params are just defaults
3662 foreach ( $params as $key => $value ) {
3663 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3672 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3674 * Values that exist in both values will be combined with += (all values of the array
3675 * of $newValues will be added to the values of the array of $baseArray, while values,
3676 * that exists in both, the value of $baseArray will be used).
3678 * @param array $baseArray The array where you want to add the values of $newValues to
3679 * @param array $newValues An array with new values
3680 * @return array The combined array
3683 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3684 // First merge items that are in both arrays
3685 foreach ( $baseArray as $name => &$groupVal ) {
3686 if ( isset( $newValues[$name] ) ) {
3687 $groupVal +
= $newValues[$name];
3690 // Now add items that didn't exist yet
3691 $baseArray +
= $newValues;