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
;
31 // Hide compatibility functions from Doxygen
35 * Compatibility functions
37 * We support PHP 5.5.9 and up.
38 * Re-implementations of newer functions or functions in non-standard
39 * PHP extensions may be included here.
42 if ( !function_exists( 'mb_substr' ) ) {
45 * @see Fallback::mb_substr
48 function mb_substr( $str, $start, $count = 'end' ) {
49 return Fallback
::mb_substr( $str, $start, $count );
54 * @see Fallback::mb_substr_split_unicode
57 function mb_substr_split_unicode( $str, $splitPos ) {
58 return Fallback
::mb_substr_split_unicode( $str, $splitPos );
62 if ( !function_exists( 'mb_strlen' ) ) {
65 * @see Fallback::mb_strlen
68 function mb_strlen( $str, $enc = '' ) {
69 return Fallback
::mb_strlen( $str, $enc );
73 if ( !function_exists( 'mb_strpos' ) ) {
76 * @see Fallback::mb_strpos
79 function mb_strpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
80 return Fallback
::mb_strpos( $haystack, $needle, $offset, $encoding );
84 if ( !function_exists( 'mb_strrpos' ) ) {
87 * @see Fallback::mb_strrpos
90 function mb_strrpos( $haystack, $needle, $offset = 0, $encoding = '' ) {
91 return Fallback
::mb_strrpos( $haystack, $needle, $offset, $encoding );
95 // hash_equals function only exists in PHP >= 5.6.0
96 // http://php.net/hash_equals
97 if ( !function_exists( 'hash_equals' ) ) {
99 * Check whether a user-provided string is equal to a fixed-length secret string
100 * without revealing bytes of the secret string through timing differences.
102 * The usual way to compare strings (PHP's === operator or the underlying memcmp()
103 * function in C) is to compare corresponding bytes and stop at the first difference,
104 * which would take longer for a partial match than for a complete mismatch. This
105 * is not secure when one of the strings (e.g. an HMAC or token) must remain secret
106 * and the other may come from an attacker. Statistical analysis of timing measurements
107 * over many requests may allow the attacker to guess the string's bytes one at a time
108 * (and check his guesses) even if the timing differences are extremely small.
110 * When making such a security-sensitive comparison, it is essential that the sequence
111 * in which instructions are executed and memory locations are accessed not depend on
112 * the secret string's value. HOWEVER, for simplicity, we do not attempt to minimize
113 * the inevitable leakage of the string's length. That is generally known anyway as
114 * a chararacteristic of the hash function used to compute the secret value.
116 * Longer explanation: http://www.emerose.com/timing-attacks-explained
118 * @codeCoverageIgnore
119 * @param string $known_string Fixed-length secret string to compare against
120 * @param string $user_string User-provided string
121 * @return bool True if the strings are the same, false otherwise
123 function hash_equals( $known_string, $user_string ) {
124 // Strict type checking as in PHP's native implementation
125 if ( !is_string( $known_string ) ) {
126 trigger_error( 'hash_equals(): Expected known_string to be a string, ' .
127 gettype( $known_string ) . ' given', E_USER_WARNING
);
132 if ( !is_string( $user_string ) ) {
133 trigger_error( 'hash_equals(): Expected user_string to be a string, ' .
134 gettype( $user_string ) . ' given', E_USER_WARNING
);
139 $known_string_len = strlen( $known_string );
140 if ( $known_string_len !== strlen( $user_string ) ) {
145 for ( $i = 0; $i < $known_string_len; $i++
) {
146 $result |
= ord( $known_string[$i] ) ^
ord( $user_string[$i] );
149 return ( $result === 0 );
157 * This queues an extension to be loaded through
158 * the ExtensionRegistry system.
160 * @param string $ext Name of the extension to load
161 * @param string|null $path Absolute path of where to find the extension.json file
164 function wfLoadExtension( $ext, $path = null ) {
166 global $wgExtensionDirectory;
167 $path = "$wgExtensionDirectory/$ext/extension.json";
169 ExtensionRegistry
::getInstance()->queue( $path );
173 * Load multiple extensions at once
175 * Same as wfLoadExtension, but more efficient if you
176 * are loading multiple extensions.
178 * If you want to specify custom paths, you should interact with
179 * ExtensionRegistry directly.
181 * @see wfLoadExtension
182 * @param string[] $exts Array of extension names to load
185 function wfLoadExtensions( array $exts ) {
186 global $wgExtensionDirectory;
187 $registry = ExtensionRegistry
::getInstance();
188 foreach ( $exts as $ext ) {
189 $registry->queue( "$wgExtensionDirectory/$ext/extension.json" );
196 * @see wfLoadExtension
197 * @param string $skin Name of the extension to load
198 * @param string|null $path Absolute path of where to find the skin.json file
201 function wfLoadSkin( $skin, $path = null ) {
203 global $wgStyleDirectory;
204 $path = "$wgStyleDirectory/$skin/skin.json";
206 ExtensionRegistry
::getInstance()->queue( $path );
210 * Load multiple skins at once
212 * @see wfLoadExtensions
213 * @param string[] $skins Array of extension names to load
216 function wfLoadSkins( array $skins ) {
217 global $wgStyleDirectory;
218 $registry = ExtensionRegistry
::getInstance();
219 foreach ( $skins as $skin ) {
220 $registry->queue( "$wgStyleDirectory/$skin/skin.json" );
225 * Like array_diff( $a, $b ) except that it works with two-dimensional arrays.
230 function wfArrayDiff2( $a, $b ) {
231 return array_udiff( $a, $b, 'wfArrayDiff2_cmp' );
235 * @param array|string $a
236 * @param array|string $b
239 function wfArrayDiff2_cmp( $a, $b ) {
240 if ( is_string( $a ) && is_string( $b ) ) {
241 return strcmp( $a, $b );
242 } elseif ( count( $a ) !== count( $b ) ) {
243 return count( $a ) < count( $b ) ?
-1 : 1;
247 while ( ( list( , $valueA ) = each( $a ) ) && ( list( , $valueB ) = each( $b ) ) ) {
248 $cmp = strcmp( $valueA, $valueB );
258 * Appends to second array if $value differs from that in $default
260 * @param string|int $key
261 * @param mixed $value
262 * @param mixed $default
263 * @param array $changed Array to alter
264 * @throws MWException
266 function wfAppendToArrayIfNotDefault( $key, $value, $default, &$changed ) {
267 if ( is_null( $changed ) ) {
268 throw new MWException( 'GlobalFunctions::wfAppendToArrayIfNotDefault got null' );
270 if ( $default[$key] !== $value ) {
271 $changed[$key] = $value;
276 * Merge arrays in the style of getUserPermissionsErrors, with duplicate removal
278 * wfMergeErrorArrays(
279 * array( array( 'x' ) ),
280 * array( array( 'x', '2' ) ),
281 * array( array( 'x' ) ),
282 * array( array( 'y' ) )
291 * @param array $array1,...
294 function wfMergeErrorArrays( /*...*/ ) {
295 $args = func_get_args();
297 foreach ( $args as $errors ) {
298 foreach ( $errors as $params ) {
299 $originalParams = $params;
300 if ( $params[0] instanceof MessageSpecifier
) {
302 $params = array_merge( [ $msg->getKey() ], $msg->getParams() );
304 # @todo FIXME: Sometimes get nested arrays for $params,
305 # which leads to E_NOTICEs
306 $spec = implode( "\t", $params );
307 $out[$spec] = $originalParams;
310 return array_values( $out );
314 * Insert array into another array after the specified *KEY*
316 * @param array $array The array.
317 * @param array $insert The array to insert.
318 * @param mixed $after The key to insert after
321 function wfArrayInsertAfter( array $array, array $insert, $after ) {
322 // Find the offset of the element to insert after.
323 $keys = array_keys( $array );
324 $offsetByKey = array_flip( $keys );
326 $offset = $offsetByKey[$after];
328 // Insert at the specified offset
329 $before = array_slice( $array, 0, $offset +
1, true );
330 $after = array_slice( $array, $offset +
1, count( $array ) - $offset, true );
332 $output = $before +
$insert +
$after;
338 * Recursively converts the parameter (an object) to an array with the same data
340 * @param object|array $objOrArray
341 * @param bool $recursive
344 function wfObjectToArray( $objOrArray, $recursive = true ) {
346 if ( is_object( $objOrArray ) ) {
347 $objOrArray = get_object_vars( $objOrArray );
349 foreach ( $objOrArray as $key => $value ) {
350 if ( $recursive && ( is_object( $value ) ||
is_array( $value ) ) ) {
351 $value = wfObjectToArray( $value );
354 $array[$key] = $value;
361 * Get a random decimal value between 0 and 1, in a way
362 * not likely to give duplicate values for any realistic
363 * number of articles.
365 * @note This is designed for use in relation to Special:RandomPage
366 * and the page_random database field.
370 function wfRandom() {
371 // The maximum random value is "only" 2^31-1, so get two random
372 // values to reduce the chance of dupes
373 $max = mt_getrandmax() +
1;
374 $rand = number_format( ( mt_rand() * $max +
mt_rand() ) / $max / $max, 12, '.', '' );
379 * Get a random string containing a number of pseudo-random hex characters.
381 * @note This is not secure, if you are trying to generate some sort
382 * of token please use MWCryptRand instead.
384 * @param int $length The length of the string to generate
388 function wfRandomString( $length = 32 ) {
390 for ( $n = 0; $n < $length; $n +
= 7 ) {
391 $str .= sprintf( '%07x', mt_rand() & 0xfffffff );
393 return substr( $str, 0, $length );
397 * We want some things to be included as literal characters in our title URLs
398 * for prettiness, which urlencode encodes by default. According to RFC 1738,
399 * all of the following should be safe:
403 * RFC 1738 says ~ is unsafe, however RFC 3986 considers it an unreserved
404 * character which should not be encoded. More importantly, google chrome
405 * always converts %7E back to ~, and converting it in this function can
406 * cause a redirect loop (T105265).
408 * But + is not safe because it's used to indicate a space; &= are only safe in
409 * paths and not in queries (and we don't distinguish here); ' seems kind of
410 * scary; and urlencode() doesn't touch -_. to begin with. Plus, although /
411 * is reserved, we don't care. So the list we unescape is:
415 * However, IIS7 redirects fail when the url contains a colon (Bug 22709),
416 * so no fancy : for IIS7.
418 * %2F in the page titles seems to fatally break for some reason.
423 function wfUrlencode( $s ) {
426 if ( is_null( $s ) ) {
431 if ( is_null( $needle ) ) {
432 $needle = [ '%3B', '%40', '%24', '%21', '%2A', '%28', '%29', '%2C', '%2F', '%7E' ];
433 if ( !isset( $_SERVER['SERVER_SOFTWARE'] ) ||
434 ( strpos( $_SERVER['SERVER_SOFTWARE'], 'Microsoft-IIS/7' ) === false )
440 $s = urlencode( $s );
443 [ ';', '@', '$', '!', '*', '(', ')', ',', '/', '~', ':' ],
451 * This function takes one or two arrays as input, and returns a CGI-style string, e.g.
452 * "days=7&limit=100". Options in the first array override options in the second.
453 * Options set to null or false will not be output.
455 * @param array $array1 ( String|Array )
456 * @param array|null $array2 ( String|Array )
457 * @param string $prefix
460 function wfArrayToCgi( $array1, $array2 = null, $prefix = '' ) {
461 if ( !is_null( $array2 ) ) {
462 $array1 = $array1 +
$array2;
466 foreach ( $array1 as $key => $value ) {
467 if ( !is_null( $value ) && $value !== false ) {
471 if ( $prefix !== '' ) {
472 $key = $prefix . "[$key]";
474 if ( is_array( $value ) ) {
476 foreach ( $value as $k => $v ) {
477 $cgi .= $firstTime ?
'' : '&';
478 if ( is_array( $v ) ) {
479 $cgi .= wfArrayToCgi( $v, null, $key . "[$k]" );
481 $cgi .= urlencode( $key . "[$k]" ) . '=' . urlencode( $v );
486 if ( is_object( $value ) ) {
487 $value = $value->__toString();
489 $cgi .= urlencode( $key ) . '=' . urlencode( $value );
497 * This is the logical opposite of wfArrayToCgi(): it accepts a query string as
498 * its argument and returns the same string in array form. This allows compatibility
499 * with legacy functions that accept raw query strings instead of nice
500 * arrays. Of course, keys and values are urldecode()d.
502 * @param string $query Query string
503 * @return string[] Array version of input
505 function wfCgiToArray( $query ) {
506 if ( isset( $query[0] ) && $query[0] == '?' ) {
507 $query = substr( $query, 1 );
509 $bits = explode( '&', $query );
511 foreach ( $bits as $bit ) {
515 if ( strpos( $bit, '=' ) === false ) {
516 // Pieces like &qwerty become 'qwerty' => '' (at least this is what php does)
520 list( $key, $value ) = explode( '=', $bit );
522 $key = urldecode( $key );
523 $value = urldecode( $value );
524 if ( strpos( $key, '[' ) !== false ) {
525 $keys = array_reverse( explode( '[', $key ) );
526 $key = array_pop( $keys );
528 foreach ( $keys as $k ) {
529 $k = substr( $k, 0, -1 );
530 $temp = [ $k => $temp ];
532 if ( isset( $ret[$key] ) ) {
533 $ret[$key] = array_merge( $ret[$key], $temp );
545 * Append a query string to an existing URL, which may or may not already
546 * have query string parameters already. If so, they will be combined.
549 * @param string|string[] $query String or associative array
552 function wfAppendQuery( $url, $query ) {
553 if ( is_array( $query ) ) {
554 $query = wfArrayToCgi( $query );
556 if ( $query != '' ) {
557 if ( false === strpos( $url, '?' ) ) {
568 * Expand a potentially local URL to a fully-qualified URL. Assumes $wgServer
571 * The meaning of the PROTO_* constants is as follows:
572 * PROTO_HTTP: Output a URL starting with http://
573 * PROTO_HTTPS: Output a URL starting with https://
574 * PROTO_RELATIVE: Output a URL starting with // (protocol-relative URL)
575 * PROTO_CURRENT: Output a URL starting with either http:// or https:// , depending
576 * on which protocol was used for the current incoming request
577 * PROTO_CANONICAL: For URLs without a domain, like /w/index.php , use $wgCanonicalServer.
578 * For protocol-relative URLs, use the protocol of $wgCanonicalServer
579 * PROTO_INTERNAL: Like PROTO_CANONICAL, but uses $wgInternalServer instead of $wgCanonicalServer
581 * @todo this won't work with current-path-relative URLs
582 * like "subdir/foo.html", etc.
584 * @param string $url Either fully-qualified or a local path + query
585 * @param string $defaultProto One of the PROTO_* constants. Determines the
586 * protocol to use if $url or $wgServer is protocol-relative
587 * @return string Fully-qualified URL, current-path-relative URL or false if
588 * no valid URL can be constructed
590 function wfExpandUrl( $url, $defaultProto = PROTO_CURRENT
) {
591 global $wgServer, $wgCanonicalServer, $wgInternalServer, $wgRequest,
593 if ( $defaultProto === PROTO_CANONICAL
) {
594 $serverUrl = $wgCanonicalServer;
595 } elseif ( $defaultProto === PROTO_INTERNAL
&& $wgInternalServer !== false ) {
596 // Make $wgInternalServer fall back to $wgServer if not set
597 $serverUrl = $wgInternalServer;
599 $serverUrl = $wgServer;
600 if ( $defaultProto === PROTO_CURRENT
) {
601 $defaultProto = $wgRequest->getProtocol() . '://';
605 // Analyze $serverUrl to obtain its protocol
606 $bits = wfParseUrl( $serverUrl );
607 $serverHasProto = $bits && $bits['scheme'] != '';
609 if ( $defaultProto === PROTO_CANONICAL ||
$defaultProto === PROTO_INTERNAL
) {
610 if ( $serverHasProto ) {
611 $defaultProto = $bits['scheme'] . '://';
613 // $wgCanonicalServer or $wgInternalServer doesn't have a protocol.
614 // This really isn't supposed to happen. Fall back to HTTP in this
616 $defaultProto = PROTO_HTTP
;
620 $defaultProtoWithoutSlashes = substr( $defaultProto, 0, -2 );
622 if ( substr( $url, 0, 2 ) == '//' ) {
623 $url = $defaultProtoWithoutSlashes . $url;
624 } elseif ( substr( $url, 0, 1 ) == '/' ) {
625 // If $serverUrl is protocol-relative, prepend $defaultProtoWithoutSlashes,
626 // otherwise leave it alone.
627 $url = ( $serverHasProto ?
'' : $defaultProtoWithoutSlashes ) . $serverUrl . $url;
630 $bits = wfParseUrl( $url );
632 // ensure proper port for HTTPS arrives in URL
633 // https://phabricator.wikimedia.org/T67184
634 if ( $defaultProto === PROTO_HTTPS
&& $wgHttpsPort != 443 ) {
635 $bits['port'] = $wgHttpsPort;
638 if ( $bits && isset( $bits['path'] ) ) {
639 $bits['path'] = wfRemoveDotSegments( $bits['path'] );
640 return wfAssembleUrl( $bits );
644 } elseif ( substr( $url, 0, 1 ) != '/' ) {
645 # URL is a relative path
646 return wfRemoveDotSegments( $url );
649 # Expanded URL is not valid.
654 * This function will reassemble a URL parsed with wfParseURL. This is useful
655 * if you need to edit part of a URL and put it back together.
657 * This is the basic structure used (brackets contain keys for $urlParts):
658 * [scheme][delimiter][user]:[pass]@[host]:[port][path]?[query]#[fragment]
660 * @todo Need to integrate this into wfExpandUrl (bug 32168)
663 * @param array $urlParts URL parts, as output from wfParseUrl
664 * @return string URL assembled from its component parts
666 function wfAssembleUrl( $urlParts ) {
669 if ( isset( $urlParts['delimiter'] ) ) {
670 if ( isset( $urlParts['scheme'] ) ) {
671 $result .= $urlParts['scheme'];
674 $result .= $urlParts['delimiter'];
677 if ( isset( $urlParts['host'] ) ) {
678 if ( isset( $urlParts['user'] ) ) {
679 $result .= $urlParts['user'];
680 if ( isset( $urlParts['pass'] ) ) {
681 $result .= ':' . $urlParts['pass'];
686 $result .= $urlParts['host'];
688 if ( isset( $urlParts['port'] ) ) {
689 $result .= ':' . $urlParts['port'];
693 if ( isset( $urlParts['path'] ) ) {
694 $result .= $urlParts['path'];
697 if ( isset( $urlParts['query'] ) ) {
698 $result .= '?' . $urlParts['query'];
701 if ( isset( $urlParts['fragment'] ) ) {
702 $result .= '#' . $urlParts['fragment'];
709 * Remove all dot-segments in the provided URL path. For example,
710 * '/a/./b/../c/' becomes '/a/c/'. For details on the algorithm, please see
711 * RFC3986 section 5.2.4.
713 * @todo Need to integrate this into wfExpandUrl (bug 32168)
715 * @param string $urlPath URL path, potentially containing dot-segments
716 * @return string URL path with all dot-segments removed
718 function wfRemoveDotSegments( $urlPath ) {
721 $inputLength = strlen( $urlPath );
723 while ( $inputOffset < $inputLength ) {
724 $prefixLengthOne = substr( $urlPath, $inputOffset, 1 );
725 $prefixLengthTwo = substr( $urlPath, $inputOffset, 2 );
726 $prefixLengthThree = substr( $urlPath, $inputOffset, 3 );
727 $prefixLengthFour = substr( $urlPath, $inputOffset, 4 );
730 if ( $prefixLengthTwo == './' ) {
731 # Step A, remove leading "./"
733 } elseif ( $prefixLengthThree == '../' ) {
734 # Step A, remove leading "../"
736 } elseif ( ( $prefixLengthTwo == '/.' ) && ( $inputOffset +
2 == $inputLength ) ) {
737 # Step B, replace leading "/.$" with "/"
739 $urlPath[$inputOffset] = '/';
740 } elseif ( $prefixLengthThree == '/./' ) {
741 # Step B, replace leading "/./" with "/"
743 } elseif ( $prefixLengthThree == '/..' && ( $inputOffset +
3 == $inputLength ) ) {
744 # Step C, replace leading "/..$" with "/" and
745 # remove last path component in output
747 $urlPath[$inputOffset] = '/';
749 } elseif ( $prefixLengthFour == '/../' ) {
750 # Step C, replace leading "/../" with "/" and
751 # remove last path component in output
754 } elseif ( ( $prefixLengthOne == '.' ) && ( $inputOffset +
1 == $inputLength ) ) {
755 # Step D, remove "^.$"
757 } elseif ( ( $prefixLengthTwo == '..' ) && ( $inputOffset +
2 == $inputLength ) ) {
758 # Step D, remove "^..$"
761 # Step E, move leading path segment to output
762 if ( $prefixLengthOne == '/' ) {
763 $slashPos = strpos( $urlPath, '/', $inputOffset +
1 );
765 $slashPos = strpos( $urlPath, '/', $inputOffset );
767 if ( $slashPos === false ) {
768 $output .= substr( $urlPath, $inputOffset );
769 $inputOffset = $inputLength;
771 $output .= substr( $urlPath, $inputOffset, $slashPos - $inputOffset );
772 $inputOffset +
= $slashPos - $inputOffset;
777 $slashPos = strrpos( $output, '/' );
778 if ( $slashPos === false ) {
781 $output = substr( $output, 0, $slashPos );
790 * Returns a regular expression of url protocols
792 * @param bool $includeProtocolRelative If false, remove '//' from the returned protocol list.
793 * DO NOT USE this directly, use wfUrlProtocolsWithoutProtRel() instead
796 function wfUrlProtocols( $includeProtocolRelative = true ) {
797 global $wgUrlProtocols;
799 // Cache return values separately based on $includeProtocolRelative
800 static $withProtRel = null, $withoutProtRel = null;
801 $cachedValue = $includeProtocolRelative ?
$withProtRel : $withoutProtRel;
802 if ( !is_null( $cachedValue ) ) {
806 // Support old-style $wgUrlProtocols strings, for backwards compatibility
807 // with LocalSettings files from 1.5
808 if ( is_array( $wgUrlProtocols ) ) {
810 foreach ( $wgUrlProtocols as $protocol ) {
811 // Filter out '//' if !$includeProtocolRelative
812 if ( $includeProtocolRelative ||
$protocol !== '//' ) {
813 $protocols[] = preg_quote( $protocol, '/' );
817 $retval = implode( '|', $protocols );
819 // Ignore $includeProtocolRelative in this case
820 // This case exists for pre-1.6 compatibility, and we can safely assume
821 // that '//' won't appear in a pre-1.6 config because protocol-relative
822 // URLs weren't supported until 1.18
823 $retval = $wgUrlProtocols;
826 // Cache return value
827 if ( $includeProtocolRelative ) {
828 $withProtRel = $retval;
830 $withoutProtRel = $retval;
836 * Like wfUrlProtocols(), but excludes '//' from the protocol list. Use this if
837 * you need a regex that matches all URL protocols but does not match protocol-
841 function wfUrlProtocolsWithoutProtRel() {
842 return wfUrlProtocols( false );
846 * parse_url() work-alike, but non-broken. Differences:
848 * 1) Does not raise warnings on bad URLs (just returns false).
849 * 2) Handles protocols that don't use :// (e.g., mailto: and news:, as well as
850 * protocol-relative URLs) correctly.
851 * 3) Adds a "delimiter" element to the array, either '://', ':' or '//' (see (2)).
853 * @param string $url A URL to parse
854 * @return string[] Bits of the URL in an associative array, per PHP docs
856 function wfParseUrl( $url ) {
857 global $wgUrlProtocols; // Allow all protocols defined in DefaultSettings/LocalSettings.php
859 // Protocol-relative URLs are handled really badly by parse_url(). It's so
860 // bad that the easiest way to handle them is to just prepend 'http:' and
861 // strip the protocol out later.
862 $wasRelative = substr( $url, 0, 2 ) == '//';
863 if ( $wasRelative ) {
866 MediaWiki\
suppressWarnings();
867 $bits = parse_url( $url );
868 MediaWiki\restoreWarnings
();
869 // parse_url() returns an array without scheme for some invalid URLs, e.g.
870 // parse_url("%0Ahttp://example.com") == array( 'host' => '%0Ahttp', 'path' => 'example.com' )
871 if ( !$bits ||
!isset( $bits['scheme'] ) ) {
875 // parse_url() incorrectly handles schemes case-sensitively. Convert it to lowercase.
876 $bits['scheme'] = strtolower( $bits['scheme'] );
878 // most of the protocols are followed by ://, but mailto: and sometimes news: not, check for it
879 if ( in_array( $bits['scheme'] . '://', $wgUrlProtocols ) ) {
880 $bits['delimiter'] = '://';
881 } elseif ( in_array( $bits['scheme'] . ':', $wgUrlProtocols ) ) {
882 $bits['delimiter'] = ':';
883 // parse_url detects for news: and mailto: the host part of an url as path
884 // We have to correct this wrong detection
885 if ( isset( $bits['path'] ) ) {
886 $bits['host'] = $bits['path'];
893 /* Provide an empty host for eg. file:/// urls (see bug 28627) */
894 if ( !isset( $bits['host'] ) ) {
898 if ( isset( $bits['path'] ) ) {
899 /* parse_url loses the third / for file:///c:/ urls (but not on variants) */
900 if ( substr( $bits['path'], 0, 1 ) !== '/' ) {
901 $bits['path'] = '/' . $bits['path'];
908 // If the URL was protocol-relative, fix scheme and delimiter
909 if ( $wasRelative ) {
910 $bits['scheme'] = '';
911 $bits['delimiter'] = '//';
917 * Take a URL, make sure it's expanded to fully qualified, and replace any
918 * encoded non-ASCII Unicode characters with their UTF-8 original forms
919 * for more compact display and legibility for local audiences.
921 * @todo handle punycode domains too
926 function wfExpandIRI( $url ) {
927 return preg_replace_callback(
928 '/((?:%[89A-F][0-9A-F])+)/i',
929 'wfExpandIRI_callback',
935 * Private callback for wfExpandIRI
936 * @param array $matches
939 function wfExpandIRI_callback( $matches ) {
940 return urldecode( $matches[1] );
944 * Make URL indexes, appropriate for the el_index field of externallinks.
949 function wfMakeUrlIndexes( $url ) {
950 $bits = wfParseUrl( $url );
952 // Reverse the labels in the hostname, convert to lower case
953 // For emails reverse domainpart only
954 if ( $bits['scheme'] == 'mailto' ) {
955 $mailparts = explode( '@', $bits['host'], 2 );
956 if ( count( $mailparts ) === 2 ) {
957 $domainpart = strtolower( implode( '.', array_reverse( explode( '.', $mailparts[1] ) ) ) );
959 // No domain specified, don't mangle it
962 $reversedHost = $domainpart . '@' . $mailparts[0];
964 $reversedHost = strtolower( implode( '.', array_reverse( explode( '.', $bits['host'] ) ) ) );
966 // Add an extra dot to the end
967 // Why? Is it in wrong place in mailto links?
968 if ( substr( $reversedHost, -1, 1 ) !== '.' ) {
969 $reversedHost .= '.';
971 // Reconstruct the pseudo-URL
972 $prot = $bits['scheme'];
973 $index = $prot . $bits['delimiter'] . $reversedHost;
974 // Leave out user and password. Add the port, path, query and fragment
975 if ( isset( $bits['port'] ) ) {
976 $index .= ':' . $bits['port'];
978 if ( isset( $bits['path'] ) ) {
979 $index .= $bits['path'];
983 if ( isset( $bits['query'] ) ) {
984 $index .= '?' . $bits['query'];
986 if ( isset( $bits['fragment'] ) ) {
987 $index .= '#' . $bits['fragment'];
991 return [ "http:$index", "https:$index" ];
998 * Check whether a given URL has a domain that occurs in a given set of domains
999 * @param string $url URL
1000 * @param array $domains Array of domains (strings)
1001 * @return bool True if the host part of $url ends in one of the strings in $domains
1003 function wfMatchesDomainList( $url, $domains ) {
1004 $bits = wfParseUrl( $url );
1005 if ( is_array( $bits ) && isset( $bits['host'] ) ) {
1006 $host = '.' . $bits['host'];
1007 foreach ( (array)$domains as $domain ) {
1008 $domain = '.' . $domain;
1009 if ( substr( $host, -strlen( $domain ) ) === $domain ) {
1018 * Sends a line to the debug log if enabled or, optionally, to a comment in output.
1019 * In normal operation this is a NOP.
1021 * Controlling globals:
1022 * $wgDebugLogFile - points to the log file
1023 * $wgDebugRawPage - if false, 'action=raw' hits will not result in debug output.
1024 * $wgDebugComments - if on, some debug items may appear in comments in the HTML output.
1026 * @since 1.25 support for additional context data
1028 * @param string $text
1029 * @param string|bool $dest Destination of the message:
1030 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1031 * - 'private': excluded from HTML output
1032 * For backward compatibility, it can also take a boolean:
1033 * - true: same as 'all'
1034 * - false: same as 'private'
1035 * @param array $context Additional logging context data
1037 function wfDebug( $text, $dest = 'all', array $context = [] ) {
1038 global $wgDebugRawPage, $wgDebugLogPrefix;
1039 global $wgDebugTimestamps, $wgRequestTime;
1041 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1045 $text = trim( $text );
1047 if ( $wgDebugTimestamps ) {
1048 $context['seconds_elapsed'] = sprintf(
1050 microtime( true ) - $wgRequestTime
1052 $context['memory_used'] = sprintf(
1054 ( memory_get_usage( true ) / ( 1024 * 1024 ) )
1058 if ( $wgDebugLogPrefix !== '' ) {
1059 $context['prefix'] = $wgDebugLogPrefix;
1061 $context['private'] = ( $dest === false ||
$dest === 'private' );
1063 $logger = LoggerFactory
::getInstance( 'wfDebug' );
1064 $logger->debug( $text, $context );
1068 * Returns true if debug logging should be suppressed if $wgDebugRawPage = false
1071 function wfIsDebugRawPage() {
1073 if ( $cache !== null ) {
1076 # Check for raw action using $_GET not $wgRequest, since the latter might not be initialised yet
1077 if ( ( isset( $_GET['action'] ) && $_GET['action'] == 'raw' )
1079 isset( $_SERVER['SCRIPT_NAME'] )
1080 && substr( $_SERVER['SCRIPT_NAME'], -8 ) == 'load.php'
1091 * Send a line giving PHP memory usage.
1093 * @param bool $exact Print exact byte values instead of kibibytes (default: false)
1095 function wfDebugMem( $exact = false ) {
1096 $mem = memory_get_usage();
1098 $mem = floor( $mem / 1024 ) . ' KiB';
1102 wfDebug( "Memory usage: $mem\n" );
1106 * Send a line to a supplementary debug log file, if configured, or main debug
1109 * To configure a supplementary log file, set $wgDebugLogGroups[$logGroup] to
1110 * a string filename or an associative array mapping 'destination' to the
1111 * desired filename. The associative array may also contain a 'sample' key
1112 * with an integer value, specifying a sampling factor. Sampled log events
1113 * will be emitted with a 1 in N random chance.
1115 * @since 1.23 support for sampling log messages via $wgDebugLogGroups.
1116 * @since 1.25 support for additional context data
1117 * @since 1.25 sample behavior dependent on configured $wgMWLoggerDefaultSpi
1119 * @param string $logGroup
1120 * @param string $text
1121 * @param string|bool $dest Destination of the message:
1122 * - 'all': both to the log and HTML (debug toolbar or HTML comments)
1123 * - 'private': only to the specific log if set in $wgDebugLogGroups and
1124 * discarded otherwise
1125 * For backward compatibility, it can also take a boolean:
1126 * - true: same as 'all'
1127 * - false: same as 'private'
1128 * @param array $context Additional logging context data
1130 function wfDebugLog(
1131 $logGroup, $text, $dest = 'all', array $context = []
1133 $text = trim( $text );
1135 $logger = LoggerFactory
::getInstance( $logGroup );
1136 $context['private'] = ( $dest === false ||
$dest === 'private' );
1137 $logger->info( $text, $context );
1141 * Log for database errors
1143 * @since 1.25 support for additional context data
1145 * @param string $text Database error message.
1146 * @param array $context Additional logging context data
1148 function wfLogDBError( $text, array $context = [] ) {
1149 $logger = LoggerFactory
::getInstance( 'wfLogDBError' );
1150 $logger->error( trim( $text ), $context );
1154 * Throws a warning that $function is deprecated
1156 * @param string $function
1157 * @param string|bool $version Version of MediaWiki that the function
1158 * was deprecated in (Added in 1.19).
1159 * @param string|bool $component Added in 1.19.
1160 * @param int $callerOffset How far up the call stack is the original
1161 * caller. 2 = function that called the function that called
1162 * wfDeprecated (Added in 1.20)
1166 function wfDeprecated( $function, $version = false, $component = false, $callerOffset = 2 ) {
1167 MWDebug
::deprecated( $function, $version, $component, $callerOffset +
1 );
1171 * Send a warning either to the debug log or in a PHP error depending on
1172 * $wgDevelopmentWarnings. To log warnings in production, use wfLogWarning() instead.
1174 * @param string $msg Message to send
1175 * @param int $callerOffset Number of items to go back in the backtrace to
1176 * find the correct caller (1 = function calling wfWarn, ...)
1177 * @param int $level PHP error level; defaults to E_USER_NOTICE;
1178 * only used when $wgDevelopmentWarnings is true
1180 function wfWarn( $msg, $callerOffset = 1, $level = E_USER_NOTICE
) {
1181 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'auto' );
1185 * Send a warning as a PHP error and the debug log. This is intended for logging
1186 * warnings in production. For logging development warnings, use WfWarn instead.
1188 * @param string $msg Message to send
1189 * @param int $callerOffset Number of items to go back in the backtrace to
1190 * find the correct caller (1 = function calling wfLogWarning, ...)
1191 * @param int $level PHP error level; defaults to E_USER_WARNING
1193 function wfLogWarning( $msg, $callerOffset = 1, $level = E_USER_WARNING
) {
1194 MWDebug
::warning( $msg, $callerOffset +
1, $level, 'production' );
1198 * Log to a file without getting "file size exceeded" signals.
1200 * Can also log to TCP or UDP with the syntax udp://host:port/prefix. This will
1201 * send lines to the specified port, prefixed by the specified prefix and a space.
1202 * @since 1.25 support for additional context data
1204 * @param string $text
1205 * @param string $file Filename
1206 * @param array $context Additional logging context data
1207 * @throws MWException
1208 * @deprecated since 1.25 Use \MediaWiki\Logger\LegacyLogger::emit or UDPTransport
1210 function wfErrorLog( $text, $file, array $context = [] ) {
1211 wfDeprecated( __METHOD__
, '1.25' );
1212 $logger = LoggerFactory
::getInstance( 'wfErrorLog' );
1213 $context['destination'] = $file;
1214 $logger->info( trim( $text ), $context );
1220 function wfLogProfilingData() {
1221 global $wgDebugLogGroups, $wgDebugRawPage;
1223 $context = RequestContext
::getMain();
1224 $request = $context->getRequest();
1226 $profiler = Profiler
::instance();
1227 $profiler->setContext( $context );
1228 $profiler->logData();
1230 $config = $context->getConfig();
1231 if ( $config->get( 'StatsdServer' ) ) {
1233 $statsdServer = explode( ':', $config->get( 'StatsdServer' ) );
1234 $statsdHost = $statsdServer[0];
1235 $statsdPort = isset( $statsdServer[1] ) ?
$statsdServer[1] : 8125;
1236 $statsdSender = new SocketSender( $statsdHost, $statsdPort );
1237 $statsdClient = new SamplingStatsdClient( $statsdSender, true, false );
1238 $statsdClient->send( $context->getStats()->getBuffer() );
1239 } catch ( Exception
$ex ) {
1240 MWExceptionHandler
::logException( $ex );
1244 # Profiling must actually be enabled...
1245 if ( $profiler instanceof ProfilerStub
) {
1249 if ( isset( $wgDebugLogGroups['profileoutput'] )
1250 && $wgDebugLogGroups['profileoutput'] === false
1252 // Explicitly disabled
1255 if ( !$wgDebugRawPage && wfIsDebugRawPage() ) {
1259 $ctx = [ 'elapsed' => $request->getElapsedTime() ];
1260 if ( !empty( $_SERVER['HTTP_X_FORWARDED_FOR'] ) ) {
1261 $ctx['forwarded_for'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
1263 if ( !empty( $_SERVER['HTTP_CLIENT_IP'] ) ) {
1264 $ctx['client_ip'] = $_SERVER['HTTP_CLIENT_IP'];
1266 if ( !empty( $_SERVER['HTTP_FROM'] ) ) {
1267 $ctx['from'] = $_SERVER['HTTP_FROM'];
1269 if ( isset( $ctx['forwarded_for'] ) ||
1270 isset( $ctx['client_ip'] ) ||
1271 isset( $ctx['from'] ) ) {
1272 $ctx['proxy'] = $_SERVER['REMOTE_ADDR'];
1275 // Don't load $wgUser at this late stage just for statistics purposes
1276 // @todo FIXME: We can detect some anons even if it is not loaded.
1277 // See User::getId()
1278 $user = $context->getUser();
1279 $ctx['anon'] = $user->isItemLoaded( 'id' ) && $user->isAnon();
1281 // Command line script uses a FauxRequest object which does not have
1282 // any knowledge about an URL and throw an exception instead.
1284 $ctx['url'] = urldecode( $request->getRequestURL() );
1285 } catch ( Exception
$ignored ) {
1289 $ctx['output'] = $profiler->getOutput();
1291 $log = LoggerFactory
::getInstance( 'profileoutput' );
1292 $log->info( "Elapsed: {elapsed}; URL: <{url}>\n{output}", $ctx );
1296 * Increment a statistics counter
1298 * @param string $key
1302 function wfIncrStats( $key, $count = 1 ) {
1303 $stats = RequestContext
::getMain()->getStats();
1304 $stats->updateCount( $key, $count );
1308 * Check whether the wiki is in read-only mode.
1312 function wfReadOnly() {
1313 return wfReadOnlyReason() !== false;
1317 * Check if the site is in read-only mode and return the message if so
1319 * This checks wfConfiguredReadOnlyReason() and the main load balancer
1320 * for slave lag. This may result in DB_SLAVE connection being made.
1322 * @return string|bool String when in read-only mode; false otherwise
1324 function wfReadOnlyReason() {
1325 $readOnly = wfConfiguredReadOnlyReason();
1326 if ( $readOnly !== false ) {
1330 static $lbReadOnly = null;
1331 if ( $lbReadOnly === null ) {
1332 // Callers use this method to be aware that data presented to a user
1333 // may be very stale and thus allowing submissions can be problematic.
1334 $lbReadOnly = wfGetLB()->getReadOnlyReason();
1341 * Get the value of $wgReadOnly or the contents of $wgReadOnlyFile.
1343 * @return string|bool String when in read-only mode; false otherwise
1346 function wfConfiguredReadOnlyReason() {
1347 global $wgReadOnly, $wgReadOnlyFile;
1349 if ( $wgReadOnly === null ) {
1350 // Set $wgReadOnly for faster access next time
1351 if ( is_file( $wgReadOnlyFile ) && filesize( $wgReadOnlyFile ) > 0 ) {
1352 $wgReadOnly = file_get_contents( $wgReadOnlyFile );
1354 $wgReadOnly = false;
1362 * Return a Language object from $langcode
1364 * @param Language|string|bool $langcode Either:
1365 * - a Language object
1366 * - code of the language to get the message for, if it is
1367 * a valid code create a language for that language, if
1368 * it is a string but not a valid code then make a basic
1370 * - a boolean: if it's false then use the global object for
1371 * the current user's language (as a fallback for the old parameter
1372 * functionality), or if it is true then use global object
1373 * for the wiki's content language.
1376 function wfGetLangObj( $langcode = false ) {
1377 # Identify which language to get or create a language object for.
1378 # Using is_object here due to Stub objects.
1379 if ( is_object( $langcode ) ) {
1380 # Great, we already have the object (hopefully)!
1384 global $wgContLang, $wgLanguageCode;
1385 if ( $langcode === true ||
$langcode === $wgLanguageCode ) {
1386 # $langcode is the language code of the wikis content language object.
1387 # or it is a boolean and value is true
1392 if ( $langcode === false ||
$langcode === $wgLang->getCode() ) {
1393 # $langcode is the language code of user language object.
1394 # or it was a boolean and value is false
1398 $validCodes = array_keys( Language
::fetchLanguageNames() );
1399 if ( in_array( $langcode, $validCodes ) ) {
1400 # $langcode corresponds to a valid language.
1401 return Language
::factory( $langcode );
1404 # $langcode is a string, but not a valid language code; use content language.
1405 wfDebug( "Invalid language code passed to wfGetLangObj, falling back to content language.\n" );
1410 * This is the function for getting translated interface messages.
1412 * @see Message class for documentation how to use them.
1413 * @see https://www.mediawiki.org/wiki/Manual:Messages_API
1415 * This function replaces all old wfMsg* functions.
1417 * @param string|string[]|MessageSpecifier $key Message key, or array of keys, or a MessageSpecifier
1418 * @param mixed $params,... Normal message parameters
1423 * @see Message::__construct
1425 function wfMessage( $key /*...*/ ) {
1426 $params = func_get_args();
1427 array_shift( $params );
1428 if ( isset( $params[0] ) && is_array( $params[0] ) ) {
1429 $params = $params[0];
1431 return new Message( $key, $params );
1435 * This function accepts multiple message keys and returns a message instance
1436 * for the first message which is non-empty. If all messages are empty then an
1437 * instance of the first message key is returned.
1439 * @param string|string[] $keys,... Message keys
1444 * @see Message::newFallbackSequence
1446 function wfMessageFallback( /*...*/ ) {
1447 $args = func_get_args();
1448 return call_user_func_array( 'Message::newFallbackSequence', $args );
1452 * Replace message parameter keys on the given formatted output.
1454 * @param string $message
1455 * @param array $args
1459 function wfMsgReplaceArgs( $message, $args ) {
1460 # Fix windows line-endings
1461 # Some messages are split with explode("\n", $msg)
1462 $message = str_replace( "\r", '', $message );
1464 // Replace arguments
1465 if ( is_array( $args ) && $args ) {
1466 if ( is_array( $args[0] ) ) {
1467 $args = array_values( $args[0] );
1469 $replacementKeys = [];
1470 foreach ( $args as $n => $param ) {
1471 $replacementKeys['$' . ( $n +
1 )] = $param;
1473 $message = strtr( $message, $replacementKeys );
1480 * Fetch server name for use in error reporting etc.
1481 * Use real server name if available, so we know which machine
1482 * in a server farm generated the current page.
1486 function wfHostname() {
1488 if ( is_null( $host ) ) {
1490 # Hostname overriding
1491 global $wgOverrideHostname;
1492 if ( $wgOverrideHostname !== false ) {
1493 # Set static and skip any detection
1494 $host = $wgOverrideHostname;
1498 if ( function_exists( 'posix_uname' ) ) {
1499 // This function not present on Windows
1500 $uname = posix_uname();
1504 if ( is_array( $uname ) && isset( $uname['nodename'] ) ) {
1505 $host = $uname['nodename'];
1506 } elseif ( getenv( 'COMPUTERNAME' ) ) {
1507 # Windows computer name
1508 $host = getenv( 'COMPUTERNAME' );
1510 # This may be a virtual server.
1511 $host = $_SERVER['SERVER_NAME'];
1518 * Returns a script tag that stores the amount of time it took MediaWiki to
1519 * handle the request in milliseconds as 'wgBackendResponseTime'.
1521 * If $wgShowHostnames is true, the script will also set 'wgHostname' to the
1522 * hostname of the server handling the request.
1526 function wfReportTime() {
1527 global $wgRequestTime, $wgShowHostnames;
1529 $responseTime = round( ( microtime( true ) - $wgRequestTime ) * 1000 );
1530 $reportVars = [ 'wgBackendResponseTime' => $responseTime ];
1531 if ( $wgShowHostnames ) {
1532 $reportVars['wgHostname'] = wfHostname();
1534 return Skin
::makeVariablesScript( $reportVars );
1538 * Safety wrapper for debug_backtrace().
1540 * Will return an empty array if debug_backtrace is disabled, otherwise
1541 * the output from debug_backtrace() (trimmed).
1543 * @param int $limit This parameter can be used to limit the number of stack frames returned
1545 * @return array Array of backtrace information
1547 function wfDebugBacktrace( $limit = 0 ) {
1548 static $disabled = null;
1550 if ( is_null( $disabled ) ) {
1551 $disabled = !function_exists( 'debug_backtrace' );
1553 wfDebug( "debug_backtrace() is disabled\n" );
1561 return array_slice( debug_backtrace( DEBUG_BACKTRACE_PROVIDE_OBJECT
, $limit +
1 ), 1 );
1563 return array_slice( debug_backtrace(), 1 );
1568 * Get a debug backtrace as a string
1570 * @param bool|null $raw If true, the return value is plain text. If false, HTML.
1571 * Defaults to $wgCommandLineMode if unset.
1573 * @since 1.25 Supports $raw parameter.
1575 function wfBacktrace( $raw = null ) {
1576 global $wgCommandLineMode;
1578 if ( $raw === null ) {
1579 $raw = $wgCommandLineMode;
1583 $frameFormat = "%s line %s calls %s()\n";
1584 $traceFormat = "%s";
1586 $frameFormat = "<li>%s line %s calls %s()</li>\n";
1587 $traceFormat = "<ul>\n%s</ul>\n";
1590 $frames = array_map( function ( $frame ) use ( $frameFormat ) {
1591 $file = !empty( $frame['file'] ) ?
basename( $frame['file'] ) : '-';
1592 $line = isset( $frame['line'] ) ?
$frame['line'] : '-';
1593 $call = $frame['function'];
1594 if ( !empty( $frame['class'] ) ) {
1595 $call = $frame['class'] . $frame['type'] . $call;
1597 return sprintf( $frameFormat, $file, $line, $call );
1598 }, wfDebugBacktrace() );
1600 return sprintf( $traceFormat, implode( '', $frames ) );
1604 * Get the name of the function which called this function
1605 * wfGetCaller( 1 ) is the function with the wfGetCaller() call (ie. __FUNCTION__)
1606 * wfGetCaller( 2 ) [default] is the caller of the function running wfGetCaller()
1607 * wfGetCaller( 3 ) is the parent of that.
1612 function wfGetCaller( $level = 2 ) {
1613 $backtrace = wfDebugBacktrace( $level +
1 );
1614 if ( isset( $backtrace[$level] ) ) {
1615 return wfFormatStackFrame( $backtrace[$level] );
1622 * Return a string consisting of callers in the stack. Useful sometimes
1623 * for profiling specific points.
1625 * @param int $limit The maximum depth of the stack frame to return, or false for the entire stack.
1628 function wfGetAllCallers( $limit = 3 ) {
1629 $trace = array_reverse( wfDebugBacktrace() );
1630 if ( !$limit ||
$limit > count( $trace ) - 1 ) {
1631 $limit = count( $trace ) - 1;
1633 $trace = array_slice( $trace, -$limit - 1, $limit );
1634 return implode( '/', array_map( 'wfFormatStackFrame', $trace ) );
1638 * Return a string representation of frame
1640 * @param array $frame
1643 function wfFormatStackFrame( $frame ) {
1644 if ( !isset( $frame['function'] ) ) {
1645 return 'NO_FUNCTION_GIVEN';
1647 return isset( $frame['class'] ) && isset( $frame['type'] ) ?
1648 $frame['class'] . $frame['type'] . $frame['function'] :
1652 /* Some generic result counters, pulled out of SearchEngine */
1657 * @param int $offset
1661 function wfShowingResults( $offset, $limit ) {
1662 return wfMessage( 'showingresults' )->numParams( $limit, $offset +
1 )->parse();
1667 * @todo FIXME: We may want to blacklist some broken browsers
1669 * @param bool $force
1670 * @return bool Whereas client accept gzip compression
1672 function wfClientAcceptsGzip( $force = false ) {
1673 static $result = null;
1674 if ( $result === null ||
$force ) {
1676 if ( isset( $_SERVER['HTTP_ACCEPT_ENCODING'] ) ) {
1677 # @todo FIXME: We may want to blacklist some broken browsers
1680 '/\bgzip(?:;(q)=([0-9]+(?:\.[0-9]+)))?\b/',
1681 $_SERVER['HTTP_ACCEPT_ENCODING'],
1685 if ( isset( $m[2] ) && ( $m[1] == 'q' ) && ( $m[2] == 0 ) ) {
1689 wfDebug( "wfClientAcceptsGzip: client accepts gzip.\n" );
1698 * Escapes the given text so that it may be output using addWikiText()
1699 * without any linking, formatting, etc. making its way through. This
1700 * is achieved by substituting certain characters with HTML entities.
1701 * As required by the callers, "<nowiki>" is not used.
1703 * @param string $text Text to be escaped
1706 function wfEscapeWikiText( $text ) {
1707 static $repl = null, $repl2 = null;
1708 if ( $repl === null ) {
1710 '"' => '"', '&' => '&', "'" => ''', '<' => '<',
1711 '=' => '=', '>' => '>', '[' => '[', ']' => ']',
1712 '{' => '{', '|' => '|', '}' => '}', ';' => ';',
1713 "\n#" => "\n#", "\r#" => "\r#",
1714 "\n*" => "\n*", "\r*" => "\r*",
1715 "\n:" => "\n:", "\r:" => "\r:",
1716 "\n " => "\n ", "\r " => "\r ",
1717 "\n\n" => "\n ", "\r\n" => " \n",
1718 "\n\r" => "\n ", "\r\r" => "\r ",
1719 "\n\t" => "\n	", "\r\t" => "\r	", // "\n\t\n" is treated like "\n\n"
1720 "\n----" => "\n----", "\r----" => "\r----",
1721 '__' => '__', '://' => '://',
1724 // We have to catch everything "\s" matches in PCRE
1725 foreach ( [ 'ISBN', 'RFC', 'PMID' ] as $magic ) {
1726 $repl["$magic "] = "$magic ";
1727 $repl["$magic\t"] = "$magic	";
1728 $repl["$magic\r"] = "$magic ";
1729 $repl["$magic\n"] = "$magic ";
1730 $repl["$magic\f"] = "$magic";
1733 // And handle protocols that don't use "://"
1734 global $wgUrlProtocols;
1736 foreach ( $wgUrlProtocols as $prot ) {
1737 if ( substr( $prot, -1 ) === ':' ) {
1738 $repl2[] = preg_quote( substr( $prot, 0, -1 ), '/' );
1741 $repl2 = $repl2 ?
'/\b(' . join( '|', $repl2 ) . '):/i' : '/^(?!)/';
1743 $text = substr( strtr( "\n$text", $repl ), 1 );
1744 $text = preg_replace( $repl2, '$1:', $text );
1749 * Sets dest to source and returns the original value of dest
1750 * If source is NULL, it just returns the value, it doesn't set the variable
1751 * If force is true, it will set the value even if source is NULL
1753 * @param mixed $dest
1754 * @param mixed $source
1755 * @param bool $force
1758 function wfSetVar( &$dest, $source, $force = false ) {
1760 if ( !is_null( $source ) ||
$force ) {
1767 * As for wfSetVar except setting a bit
1771 * @param bool $state
1775 function wfSetBit( &$dest, $bit, $state = true ) {
1776 $temp = (bool)( $dest & $bit );
1777 if ( !is_null( $state ) ) {
1788 * A wrapper around the PHP function var_export().
1789 * Either print it or add it to the regular output ($wgOut).
1791 * @param mixed $var A PHP variable to dump.
1793 function wfVarDump( $var ) {
1795 $s = str_replace( "\n", "<br />\n", var_export( $var, true ) . "\n" );
1796 if ( headers_sent() ||
!isset( $wgOut ) ||
!is_object( $wgOut ) ) {
1799 $wgOut->addHTML( $s );
1804 * Provide a simple HTTP error.
1806 * @param int|string $code
1807 * @param string $label
1808 * @param string $desc
1810 function wfHttpError( $code, $label, $desc ) {
1812 HttpStatus
::header( $code );
1815 $wgOut->sendCacheControl();
1818 header( 'Content-type: text/html; charset=utf-8' );
1819 print '<!DOCTYPE html>' .
1820 '<html><head><title>' .
1821 htmlspecialchars( $label ) .
1822 '</title></head><body><h1>' .
1823 htmlspecialchars( $label ) .
1825 nl2br( htmlspecialchars( $desc ) ) .
1826 "</p></body></html>\n";
1830 * Clear away any user-level output buffers, discarding contents.
1832 * Suitable for 'starting afresh', for instance when streaming
1833 * relatively large amounts of data without buffering, or wanting to
1834 * output image files without ob_gzhandler's compression.
1836 * The optional $resetGzipEncoding parameter controls suppression of
1837 * the Content-Encoding header sent by ob_gzhandler; by default it
1838 * is left. See comments for wfClearOutputBuffers() for why it would
1841 * Note that some PHP configuration options may add output buffer
1842 * layers which cannot be removed; these are left in place.
1844 * @param bool $resetGzipEncoding
1846 function wfResetOutputBuffers( $resetGzipEncoding = true ) {
1847 if ( $resetGzipEncoding ) {
1848 // Suppress Content-Encoding and Content-Length
1849 // headers from 1.10+s wfOutputHandler
1850 global $wgDisableOutputCompression;
1851 $wgDisableOutputCompression = true;
1853 while ( $status = ob_get_status() ) {
1854 if ( isset( $status['flags'] ) ) {
1855 $flags = PHP_OUTPUT_HANDLER_CLEANABLE | PHP_OUTPUT_HANDLER_REMOVABLE
;
1856 $deleteable = ( $status['flags'] & $flags ) === $flags;
1857 } elseif ( isset( $status['del'] ) ) {
1858 $deleteable = $status['del'];
1860 // Guess that any PHP-internal setting can't be removed.
1861 $deleteable = $status['type'] !== 0; /* PHP_OUTPUT_HANDLER_INTERNAL */
1863 if ( !$deleteable ) {
1864 // Give up, and hope the result doesn't break
1868 if ( $status['name'] === 'MediaWikiTestCase::wfResetOutputBuffersBarrier' ) {
1869 // Unit testing barrier to prevent this function from breaking PHPUnit.
1872 if ( !ob_end_clean() ) {
1873 // Could not remove output buffer handler; abort now
1874 // to avoid getting in some kind of infinite loop.
1877 if ( $resetGzipEncoding ) {
1878 if ( $status['name'] == 'ob_gzhandler' ) {
1879 // Reset the 'Content-Encoding' field set by this handler
1880 // so we can start fresh.
1881 header_remove( 'Content-Encoding' );
1889 * More legible than passing a 'false' parameter to wfResetOutputBuffers():
1891 * Clear away output buffers, but keep the Content-Encoding header
1892 * produced by ob_gzhandler, if any.
1894 * This should be used for HTTP 304 responses, where you need to
1895 * preserve the Content-Encoding header of the real result, but
1896 * also need to suppress the output of ob_gzhandler to keep to spec
1897 * and avoid breaking Firefox in rare cases where the headers and
1898 * body are broken over two packets.
1900 function wfClearOutputBuffers() {
1901 wfResetOutputBuffers( false );
1905 * Converts an Accept-* header into an array mapping string values to quality
1908 * @param string $accept
1909 * @param string $def Default
1910 * @return float[] Associative array of string => float pairs
1912 function wfAcceptToPrefs( $accept, $def = '*/*' ) {
1913 # No arg means accept anything (per HTTP spec)
1915 return [ $def => 1.0 ];
1920 $parts = explode( ',', $accept );
1922 foreach ( $parts as $part ) {
1923 # @todo FIXME: Doesn't deal with params like 'text/html; level=1'
1924 $values = explode( ';', trim( $part ) );
1926 if ( count( $values ) == 1 ) {
1927 $prefs[$values[0]] = 1.0;
1928 } elseif ( preg_match( '/q\s*=\s*(\d*\.\d+)/', $values[1], $match ) ) {
1929 $prefs[$values[0]] = floatval( $match[1] );
1937 * Checks if a given MIME type matches any of the keys in the given
1938 * array. Basic wildcards are accepted in the array keys.
1940 * Returns the matching MIME type (or wildcard) if a match, otherwise
1943 * @param string $type
1944 * @param array $avail
1948 function mimeTypeMatch( $type, $avail ) {
1949 if ( array_key_exists( $type, $avail ) ) {
1952 $mainType = explode( '/', $type )[0];
1953 if ( array_key_exists( "$mainType/*", $avail ) ) {
1954 return "$mainType/*";
1955 } elseif ( array_key_exists( '*/*', $avail ) ) {
1964 * Returns the 'best' match between a client's requested internet media types
1965 * and the server's list of available types. Each list should be an associative
1966 * array of type to preference (preference is a float between 0.0 and 1.0).
1967 * Wildcards in the types are acceptable.
1969 * @param array $cprefs Client's acceptable type list
1970 * @param array $sprefs Server's offered types
1973 * @todo FIXME: Doesn't handle params like 'text/plain; charset=UTF-8'
1974 * XXX: generalize to negotiate other stuff
1976 function wfNegotiateType( $cprefs, $sprefs ) {
1979 foreach ( array_keys( $sprefs ) as $type ) {
1980 $subType = explode( '/', $type )[1];
1981 if ( $subType != '*' ) {
1982 $ckey = mimeTypeMatch( $type, $cprefs );
1984 $combine[$type] = $sprefs[$type] * $cprefs[$ckey];
1989 foreach ( array_keys( $cprefs ) as $type ) {
1990 $subType = explode( '/', $type )[1];
1991 if ( $subType != '*' && !array_key_exists( $type, $sprefs ) ) {
1992 $skey = mimeTypeMatch( $type, $sprefs );
1994 $combine[$type] = $sprefs[$skey] * $cprefs[$type];
2002 foreach ( array_keys( $combine ) as $type ) {
2003 if ( $combine[$type] > $bestq ) {
2005 $bestq = $combine[$type];
2013 * Reference-counted warning suppression
2015 * @deprecated since 1.26, use MediaWiki\suppressWarnings() directly
2018 function wfSuppressWarnings( $end = false ) {
2019 MediaWiki\
suppressWarnings( $end );
2023 * @deprecated since 1.26, use MediaWiki\restoreWarnings() directly
2024 * Restore error level to previous value
2026 function wfRestoreWarnings() {
2027 MediaWiki\
suppressWarnings( true );
2030 # Autodetect, convert and provide timestamps of various types
2033 * Unix time - the number of seconds since 1970-01-01 00:00:00 UTC
2035 define( 'TS_UNIX', 0 );
2038 * MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
2040 define( 'TS_MW', 1 );
2043 * MySQL DATETIME (YYYY-MM-DD HH:MM:SS)
2045 define( 'TS_DB', 2 );
2048 * RFC 2822 format, for E-mail and HTTP headers
2050 define( 'TS_RFC2822', 3 );
2053 * ISO 8601 format with no timezone: 1986-02-09T20:00:00Z
2055 * This is used by Special:Export
2057 define( 'TS_ISO_8601', 4 );
2060 * An Exif timestamp (YYYY:MM:DD HH:MM:SS)
2062 * @see http://exif.org/Exif2-2.PDF The Exif 2.2 spec, see page 28 for the
2063 * DateTime tag and page 36 for the DateTimeOriginal and
2064 * DateTimeDigitized tags.
2066 define( 'TS_EXIF', 5 );
2069 * Oracle format time.
2071 define( 'TS_ORACLE', 6 );
2074 * Postgres format time.
2076 define( 'TS_POSTGRES', 7 );
2079 * ISO 8601 basic format with no timezone: 19860209T200000Z. This is used by ResourceLoader
2081 define( 'TS_ISO_8601_BASIC', 9 );
2084 * Get a timestamp string in one of various formats
2086 * @param mixed $outputtype A timestamp in one of the supported formats, the
2087 * function will autodetect which format is supplied and act accordingly.
2088 * @param mixed $ts Optional timestamp to convert, default 0 for the current time
2089 * @return string|bool String / false The same date in the format specified in $outputtype or false
2091 function wfTimestamp( $outputtype = TS_UNIX
, $ts = 0 ) {
2093 $timestamp = new MWTimestamp( $ts );
2094 return $timestamp->getTimestamp( $outputtype );
2095 } catch ( TimestampException
$e ) {
2096 wfDebug( "wfTimestamp() fed bogus time value: TYPE=$outputtype; VALUE=$ts\n" );
2102 * Return a formatted timestamp, or null if input is null.
2103 * For dealing with nullable timestamp columns in the database.
2105 * @param int $outputtype
2109 function wfTimestampOrNull( $outputtype = TS_UNIX
, $ts = null ) {
2110 if ( is_null( $ts ) ) {
2113 return wfTimestamp( $outputtype, $ts );
2118 * Convenience function; returns MediaWiki timestamp for the present time.
2122 function wfTimestampNow() {
2124 return wfTimestamp( TS_MW
, time() );
2128 * Check if the operating system is Windows
2130 * @return bool True if it's Windows, false otherwise.
2132 function wfIsWindows() {
2133 static $isWindows = null;
2134 if ( $isWindows === null ) {
2135 $isWindows = strtoupper( substr( PHP_OS
, 0, 3 ) ) === 'WIN';
2141 * Check if we are running under HHVM
2145 function wfIsHHVM() {
2146 return defined( 'HHVM_VERSION' );
2150 * Tries to get the system directory for temporary files. First
2151 * $wgTmpDirectory is checked, and then the TMPDIR, TMP, and TEMP
2152 * environment variables are then checked in sequence, then
2153 * sys_get_temp_dir(), then upload_tmp_dir from php.ini.
2155 * NOTE: When possible, use instead the tmpfile() function to create
2156 * temporary files to avoid race conditions on file creation, etc.
2160 function wfTempDir() {
2161 global $wgTmpDirectory;
2163 if ( $wgTmpDirectory !== false ) {
2164 return $wgTmpDirectory;
2167 $tmpDir = array_map( "getenv", [ 'TMPDIR', 'TMP', 'TEMP' ] );
2168 $tmpDir[] = sys_get_temp_dir();
2169 $tmpDir[] = ini_get( 'upload_tmp_dir' );
2171 foreach ( $tmpDir as $tmp ) {
2172 if ( $tmp && file_exists( $tmp ) && is_dir( $tmp ) && is_writable( $tmp ) ) {
2176 throw new MWException( 'No writable temporary directory could be found. ' .
2177 'Please set $wgTmpDirectory to a writable directory.' );
2181 * Make directory, and make all parent directories if they don't exist
2183 * @param string $dir Full path to directory to create
2184 * @param int $mode Chmod value to use, default is $wgDirectoryMode
2185 * @param string $caller Optional caller param for debugging.
2186 * @throws MWException
2189 function wfMkdirParents( $dir, $mode = null, $caller = null ) {
2190 global $wgDirectoryMode;
2192 if ( FileBackend
::isStoragePath( $dir ) ) { // sanity
2193 throw new MWException( __FUNCTION__
. " given storage path '$dir'." );
2196 if ( !is_null( $caller ) ) {
2197 wfDebug( "$caller: called wfMkdirParents($dir)\n" );
2200 if ( strval( $dir ) === '' ||
is_dir( $dir ) ) {
2204 $dir = str_replace( [ '\\', '/' ], DIRECTORY_SEPARATOR
, $dir );
2206 if ( is_null( $mode ) ) {
2207 $mode = $wgDirectoryMode;
2210 // Turn off the normal warning, we're doing our own below
2211 MediaWiki\
suppressWarnings();
2212 $ok = mkdir( $dir, $mode, true ); // PHP5 <3
2213 MediaWiki\restoreWarnings
();
2216 // directory may have been created on another request since we last checked
2217 if ( is_dir( $dir ) ) {
2221 // PHP doesn't report the path in its warning message, so add our own to aid in diagnosis.
2222 wfLogWarning( sprintf( "failed to mkdir \"%s\" mode 0%o", $dir, $mode ) );
2228 * Remove a directory and all its content.
2229 * Does not hide error.
2230 * @param string $dir
2232 function wfRecursiveRemoveDir( $dir ) {
2233 wfDebug( __FUNCTION__
. "( $dir )\n" );
2234 // taken from http://de3.php.net/manual/en/function.rmdir.php#98622
2235 if ( is_dir( $dir ) ) {
2236 $objects = scandir( $dir );
2237 foreach ( $objects as $object ) {
2238 if ( $object != "." && $object != ".." ) {
2239 if ( filetype( $dir . '/' . $object ) == "dir" ) {
2240 wfRecursiveRemoveDir( $dir . '/' . $object );
2242 unlink( $dir . '/' . $object );
2252 * @param int $nr The number to format
2253 * @param int $acc The number of digits after the decimal point, default 2
2254 * @param bool $round Whether or not to round the value, default true
2257 function wfPercent( $nr, $acc = 2, $round = true ) {
2258 $ret = sprintf( "%.${acc}f", $nr );
2259 return $round ?
round( $ret, $acc ) . '%' : "$ret%";
2263 * Safety wrapper around ini_get() for boolean settings.
2264 * The values returned from ini_get() are pre-normalized for settings
2265 * set via php.ini or php_flag/php_admin_flag... but *not*
2266 * for those set via php_value/php_admin_value.
2268 * It's fairly common for people to use php_value instead of php_flag,
2269 * which can leave you with an 'off' setting giving a false positive
2270 * for code that just takes the ini_get() return value as a boolean.
2272 * To make things extra interesting, setting via php_value accepts
2273 * "true" and "yes" as true, but php.ini and php_flag consider them false. :)
2274 * Unrecognized values go false... again opposite PHP's own coercion
2275 * from string to bool.
2277 * Luckily, 'properly' set settings will always come back as '0' or '1',
2278 * so we only have to worry about them and the 'improper' settings.
2280 * I frickin' hate PHP... :P
2282 * @param string $setting
2285 function wfIniGetBool( $setting ) {
2286 $val = strtolower( ini_get( $setting ) );
2287 // 'on' and 'true' can't have whitespace around them, but '1' can.
2291 ||
preg_match( "/^\s*[+-]?0*[1-9]/", $val ); // approx C atoi() function
2295 * Windows-compatible version of escapeshellarg()
2296 * Windows doesn't recognise single-quotes in the shell, but the escapeshellarg()
2297 * function puts single quotes in regardless of OS.
2299 * Also fixes the locale problems on Linux in PHP 5.2.6+ (bug backported to
2300 * earlier distro releases of PHP)
2302 * @param string ... strings to escape and glue together, or a single array of strings parameter
2305 function wfEscapeShellArg( /*...*/ ) {
2306 wfInitShellLocale();
2308 $args = func_get_args();
2309 if ( count( $args ) === 1 && is_array( reset( $args ) ) ) {
2310 // If only one argument has been passed, and that argument is an array,
2311 // treat it as a list of arguments
2312 $args = reset( $args );
2317 foreach ( $args as $arg ) {
2324 if ( wfIsWindows() ) {
2325 // Escaping for an MSVC-style command line parser and CMD.EXE
2326 // @codingStandardsIgnoreStart For long URLs
2328 // * http://web.archive.org/web/20020708081031/http://mailman.lyra.org/pipermail/scite-interest/2002-March/000436.html
2329 // * http://technet.microsoft.com/en-us/library/cc723564.aspx
2332 // Double the backslashes before any double quotes. Escape the double quotes.
2333 // @codingStandardsIgnoreEnd
2334 $tokens = preg_split( '/(\\\\*")/', $arg, -1, PREG_SPLIT_DELIM_CAPTURE
);
2337 foreach ( $tokens as $token ) {
2338 if ( $iteration %
2 == 1 ) {
2339 // Delimiter, a double quote preceded by zero or more slashes
2340 $arg .= str_replace( '\\', '\\\\', substr( $token, 0, -1 ) ) . '\\"';
2341 } elseif ( $iteration %
4 == 2 ) {
2342 // ^ in $token will be outside quotes, need to be escaped
2343 $arg .= str_replace( '^', '^^', $token );
2344 } else { // $iteration % 4 == 0
2345 // ^ in $token will appear inside double quotes, so leave as is
2350 // Double the backslashes before the end of the string, because
2351 // we will soon add a quote
2353 if ( preg_match( '/^(.*?)(\\\\+)$/', $arg, $m ) ) {
2354 $arg = $m[1] . str_replace( '\\', '\\\\', $m[2] );
2357 // Add surrounding quotes
2358 $retVal .= '"' . $arg . '"';
2360 $retVal .= escapeshellarg( $arg );
2367 * Check if wfShellExec() is effectively disabled via php.ini config
2369 * @return bool|string False or 'disabled'
2372 function wfShellExecDisabled() {
2373 static $disabled = null;
2374 if ( is_null( $disabled ) ) {
2375 if ( !function_exists( 'proc_open' ) ) {
2376 wfDebug( "proc_open() is disabled\n" );
2377 $disabled = 'disabled';
2386 * Execute a shell command, with time and memory limits mirrored from the PHP
2387 * configuration if supported.
2389 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2390 * or an array of unescaped arguments, in which case each value will be escaped
2391 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2392 * @param null|mixed &$retval Optional, will receive the program's exit code.
2393 * (non-zero is usually failure). If there is an error from
2394 * read, select, or proc_open(), this will be set to -1.
2395 * @param array $environ Optional environment variables which should be
2396 * added to the executed command environment.
2397 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2398 * this overwrites the global wgMaxShell* limits.
2399 * @param array $options Array of options:
2400 * - duplicateStderr: Set this to true to duplicate stderr to stdout,
2401 * including errors from limit.sh
2402 * - profileMethod: By default this function will profile based on the calling
2403 * method. Set this to a string for an alternative method to profile from
2405 * @return string Collected stdout as a string
2407 function wfShellExec( $cmd, &$retval = null, $environ = [],
2408 $limits = [], $options = []
2410 global $IP, $wgMaxShellMemory, $wgMaxShellFileSize, $wgMaxShellTime,
2411 $wgMaxShellWallClockTime, $wgShellCgroup;
2413 $disabled = wfShellExecDisabled();
2416 return 'Unable to run external programs, proc_open() is disabled.';
2419 $includeStderr = isset( $options['duplicateStderr'] ) && $options['duplicateStderr'];
2420 $profileMethod = isset( $options['profileMethod'] ) ?
$options['profileMethod'] : wfGetCaller();
2422 wfInitShellLocale();
2425 foreach ( $environ as $k => $v ) {
2426 if ( wfIsWindows() ) {
2427 /* Surrounding a set in quotes (method used by wfEscapeShellArg) makes the quotes themselves
2428 * appear in the environment variable, so we must use carat escaping as documented in
2429 * http://technet.microsoft.com/en-us/library/cc723564.aspx
2430 * Note however that the quote isn't listed there, but is needed, and the parentheses
2431 * are listed there but doesn't appear to need it.
2433 $envcmd .= "set $k=" . preg_replace( '/([&|()<>^"])/', '^\\1', $v ) . '&& ';
2435 /* Assume this is a POSIX shell, thus required to accept variable assignments before the command
2436 * http://www.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_09_01
2438 $envcmd .= "$k=" . escapeshellarg( $v ) . ' ';
2441 if ( is_array( $cmd ) ) {
2442 $cmd = wfEscapeShellArg( $cmd );
2445 $cmd = $envcmd . $cmd;
2447 $useLogPipe = false;
2448 if ( is_executable( '/bin/bash' ) ) {
2449 $time = intval( isset( $limits['time'] ) ?
$limits['time'] : $wgMaxShellTime );
2450 if ( isset( $limits['walltime'] ) ) {
2451 $wallTime = intval( $limits['walltime'] );
2452 } elseif ( isset( $limits['time'] ) ) {
2455 $wallTime = intval( $wgMaxShellWallClockTime );
2457 $mem = intval( isset( $limits['memory'] ) ?
$limits['memory'] : $wgMaxShellMemory );
2458 $filesize = intval( isset( $limits['filesize'] ) ?
$limits['filesize'] : $wgMaxShellFileSize );
2460 if ( $time > 0 ||
$mem > 0 ||
$filesize > 0 ||
$wallTime > 0 ) {
2461 $cmd = '/bin/bash ' . escapeshellarg( "$IP/includes/limit.sh" ) . ' ' .
2462 escapeshellarg( $cmd ) . ' ' .
2464 "MW_INCLUDE_STDERR=" . ( $includeStderr ?
'1' : '' ) . ';' .
2465 "MW_CPU_LIMIT=$time; " .
2466 'MW_CGROUP=' . escapeshellarg( $wgShellCgroup ) . '; ' .
2467 "MW_MEM_LIMIT=$mem; " .
2468 "MW_FILE_SIZE_LIMIT=$filesize; " .
2469 "MW_WALL_CLOCK_LIMIT=$wallTime; " .
2470 "MW_USE_LOG_PIPE=yes"
2473 } elseif ( $includeStderr ) {
2476 } elseif ( $includeStderr ) {
2479 wfDebug( "wfShellExec: $cmd\n" );
2482 0 => [ 'file', 'php://stdin', 'r' ],
2483 1 => [ 'pipe', 'w' ],
2484 2 => [ 'file', 'php://stderr', 'w' ] ];
2485 if ( $useLogPipe ) {
2486 $desc[3] = [ 'pipe', 'w' ];
2489 $scoped = Profiler
::instance()->scopedProfileIn( __FUNCTION__
. '-' . $profileMethod );
2490 $proc = proc_open( $cmd, $desc, $pipes );
2492 wfDebugLog( 'exec', "proc_open() failed: $cmd" );
2496 $outBuffer = $logBuffer = '';
2501 /* According to the documentation, it is possible for stream_select()
2502 * to fail due to EINTR. I haven't managed to induce this in testing
2503 * despite sending various signals. If it did happen, the error
2504 * message would take the form:
2506 * stream_select(): unable to select [4]: Interrupted system call (max_fd=5)
2508 * where [4] is the value of the macro EINTR and "Interrupted system
2509 * call" is string which according to the Linux manual is "possibly"
2510 * localised according to LC_MESSAGES.
2512 $eintr = defined( 'SOCKET_EINTR' ) ? SOCKET_EINTR
: 4;
2513 $eintrMessage = "stream_select(): unable to select [$eintr]";
2515 // Build a table mapping resource IDs to pipe FDs to work around a
2516 // PHP 5.3 issue in which stream_select() does not preserve array keys
2517 // <https://bugs.php.net/bug.php?id=53427>.
2519 foreach ( $pipes as $fd => $pipe ) {
2520 $fds[(int)$pipe] = $fd;
2527 while ( $running === true ||
$numReadyPipes !== 0 ) {
2529 $status = proc_get_status( $proc );
2530 // If the process has terminated, switch to nonblocking selects
2531 // for getting any data still waiting to be read.
2532 if ( !$status['running'] ) {
2538 $readyPipes = $pipes;
2541 // @codingStandardsIgnoreStart Generic.PHP.NoSilencedErrors.Discouraged
2542 @trigger_error
( '' );
2543 $numReadyPipes = @stream_select
( $readyPipes, $emptyArray, $emptyArray, $timeout );
2544 if ( $numReadyPipes === false ) {
2545 // @codingStandardsIgnoreEnd
2546 $error = error_get_last();
2547 if ( strncmp( $error['message'], $eintrMessage, strlen( $eintrMessage ) ) == 0 ) {
2550 trigger_error( $error['message'], E_USER_WARNING
);
2551 $logMsg = $error['message'];
2555 foreach ( $readyPipes as $pipe ) {
2556 $block = fread( $pipe, 65536 );
2557 $fd = $fds[(int)$pipe];
2558 if ( $block === '' ) {
2560 fclose( $pipes[$fd] );
2561 unset( $pipes[$fd] );
2565 } elseif ( $block === false ) {
2567 $logMsg = "Error reading from pipe";
2569 } elseif ( $fd == 1 ) {
2571 $outBuffer .= $block;
2572 } elseif ( $fd == 3 ) {
2574 $logBuffer .= $block;
2575 if ( strpos( $block, "\n" ) !== false ) {
2576 $lines = explode( "\n", $logBuffer );
2577 $logBuffer = array_pop( $lines );
2578 foreach ( $lines as $line ) {
2579 wfDebugLog( 'exec', $line );
2586 foreach ( $pipes as $pipe ) {
2590 // Use the status previously collected if possible, since proc_get_status()
2591 // just calls waitpid() which will not return anything useful the second time.
2593 $status = proc_get_status( $proc );
2596 if ( $logMsg !== false ) {
2597 // Read/select error
2599 proc_close( $proc );
2600 } elseif ( $status['signaled'] ) {
2601 $logMsg = "Exited with signal {$status['termsig']}";
2602 $retval = 128 +
$status['termsig'];
2603 proc_close( $proc );
2605 if ( $status['running'] ) {
2606 $retval = proc_close( $proc );
2608 $retval = $status['exitcode'];
2609 proc_close( $proc );
2611 if ( $retval == 127 ) {
2612 $logMsg = "Possibly missing executable file";
2613 } elseif ( $retval >= 129 && $retval <= 192 ) {
2614 $logMsg = "Probably exited with signal " . ( $retval - 128 );
2618 if ( $logMsg !== false ) {
2619 wfDebugLog( 'exec', "$logMsg: $cmd" );
2626 * Execute a shell command, returning both stdout and stderr. Convenience
2627 * function, as all the arguments to wfShellExec can become unwieldy.
2629 * @note This also includes errors from limit.sh, e.g. if $wgMaxShellFileSize is exceeded.
2630 * @param string|string[] $cmd If string, a properly shell-escaped command line,
2631 * or an array of unescaped arguments, in which case each value will be escaped
2632 * Example: [ 'convert', '-font', 'font name' ] would produce "'convert' '-font' 'font name'"
2633 * @param null|mixed &$retval Optional, will receive the program's exit code.
2634 * (non-zero is usually failure)
2635 * @param array $environ Optional environment variables which should be
2636 * added to the executed command environment.
2637 * @param array $limits Optional array with limits(filesize, memory, time, walltime)
2638 * this overwrites the global wgMaxShell* limits.
2639 * @return string Collected stdout and stderr as a string
2641 function wfShellExecWithStderr( $cmd, &$retval = null, $environ = [], $limits = [] ) {
2642 return wfShellExec( $cmd, $retval, $environ, $limits,
2643 [ 'duplicateStderr' => true, 'profileMethod' => wfGetCaller() ] );
2647 * Workaround for http://bugs.php.net/bug.php?id=45132
2648 * escapeshellarg() destroys non-ASCII characters if LANG is not a UTF-8 locale
2650 function wfInitShellLocale() {
2651 static $done = false;
2656 global $wgShellLocale;
2657 putenv( "LC_CTYPE=$wgShellLocale" );
2658 setlocale( LC_CTYPE
, $wgShellLocale );
2662 * Generate a shell-escaped command line string to run a MediaWiki cli script.
2663 * Note that $parameters should be a flat array and an option with an argument
2664 * should consist of two consecutive items in the array (do not use "--option value").
2666 * @param string $script MediaWiki cli script path
2667 * @param array $parameters Arguments and options to the script
2668 * @param array $options Associative array of options:
2669 * 'php': The path to the php executable
2670 * 'wrapper': Path to a PHP wrapper to handle the maintenance script
2673 function wfShellWikiCmd( $script, array $parameters = [], array $options = [] ) {
2675 // Give site config file a chance to run the script in a wrapper.
2676 // The caller may likely want to call wfBasename() on $script.
2677 Hooks
::run( 'wfShellWikiCmd', [ &$script, &$parameters, &$options ] );
2678 $cmd = isset( $options['php'] ) ?
[ $options['php'] ] : [ $wgPhpCli ];
2679 if ( isset( $options['wrapper'] ) ) {
2680 $cmd[] = $options['wrapper'];
2683 // Escape each parameter for shell
2684 return wfEscapeShellArg( array_merge( $cmd, $parameters ) );
2688 * wfMerge attempts to merge differences between three texts.
2689 * Returns true for a clean merge and false for failure or a conflict.
2691 * @param string $old
2692 * @param string $mine
2693 * @param string $yours
2694 * @param string $result
2697 function wfMerge( $old, $mine, $yours, &$result ) {
2700 # This check may also protect against code injection in
2701 # case of broken installations.
2702 MediaWiki\
suppressWarnings();
2703 $haveDiff3 = $wgDiff3 && file_exists( $wgDiff3 );
2704 MediaWiki\restoreWarnings
();
2706 if ( !$haveDiff3 ) {
2707 wfDebug( "diff3 not found\n" );
2711 # Make temporary files
2713 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2714 $mytextFile = fopen( $mytextName = tempnam( $td, 'merge-mine-' ), 'w' );
2715 $yourtextFile = fopen( $yourtextName = tempnam( $td, 'merge-your-' ), 'w' );
2717 # NOTE: diff3 issues a warning to stderr if any of the files does not end with
2718 # a newline character. To avoid this, we normalize the trailing whitespace before
2719 # creating the diff.
2721 fwrite( $oldtextFile, rtrim( $old ) . "\n" );
2722 fclose( $oldtextFile );
2723 fwrite( $mytextFile, rtrim( $mine ) . "\n" );
2724 fclose( $mytextFile );
2725 fwrite( $yourtextFile, rtrim( $yours ) . "\n" );
2726 fclose( $yourtextFile );
2728 # Check for a conflict
2729 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '--overlap-only', $mytextName,
2730 $oldtextName, $yourtextName );
2731 $handle = popen( $cmd, 'r' );
2733 if ( fgets( $handle, 1024 ) ) {
2741 $cmd = wfEscapeShellArg( $wgDiff3, '-a', '-e', '--merge', $mytextName,
2742 $oldtextName, $yourtextName );
2743 $handle = popen( $cmd, 'r' );
2746 $data = fread( $handle, 8192 );
2747 if ( strlen( $data ) == 0 ) {
2753 unlink( $mytextName );
2754 unlink( $oldtextName );
2755 unlink( $yourtextName );
2757 if ( $result === '' && $old !== '' && !$conflict ) {
2758 wfDebug( "Unexpected null result from diff3. Command: $cmd\n" );
2765 * Returns unified plain-text diff of two texts.
2766 * "Useful" for machine processing of diffs.
2768 * @deprecated since 1.25, use DiffEngine/UnifiedDiffFormatter directly
2770 * @param string $before The text before the changes.
2771 * @param string $after The text after the changes.
2772 * @param string $params Command-line options for the diff command.
2773 * @return string Unified diff of $before and $after
2775 function wfDiff( $before, $after, $params = '-u' ) {
2776 if ( $before == $after ) {
2781 MediaWiki\
suppressWarnings();
2782 $haveDiff = $wgDiff && file_exists( $wgDiff );
2783 MediaWiki\restoreWarnings
();
2785 # This check may also protect against code injection in
2786 # case of broken installations.
2788 wfDebug( "diff executable not found\n" );
2789 $diffs = new Diff( explode( "\n", $before ), explode( "\n", $after ) );
2790 $format = new UnifiedDiffFormatter();
2791 return $format->format( $diffs );
2794 # Make temporary files
2796 $oldtextFile = fopen( $oldtextName = tempnam( $td, 'merge-old-' ), 'w' );
2797 $newtextFile = fopen( $newtextName = tempnam( $td, 'merge-your-' ), 'w' );
2799 fwrite( $oldtextFile, $before );
2800 fclose( $oldtextFile );
2801 fwrite( $newtextFile, $after );
2802 fclose( $newtextFile );
2804 // Get the diff of the two files
2805 $cmd = "$wgDiff " . $params . ' ' . wfEscapeShellArg( $oldtextName, $newtextName );
2807 $h = popen( $cmd, 'r' );
2809 unlink( $oldtextName );
2810 unlink( $newtextName );
2811 throw new Exception( __METHOD__
. '(): popen() failed' );
2817 $data = fread( $h, 8192 );
2818 if ( strlen( $data ) == 0 ) {
2826 unlink( $oldtextName );
2827 unlink( $newtextName );
2829 // Kill the --- and +++ lines. They're not useful.
2830 $diff_lines = explode( "\n", $diff );
2831 if ( isset( $diff_lines[0] ) && strpos( $diff_lines[0], '---' ) === 0 ) {
2832 unset( $diff_lines[0] );
2834 if ( isset( $diff_lines[1] ) && strpos( $diff_lines[1], '+++' ) === 0 ) {
2835 unset( $diff_lines[1] );
2838 $diff = implode( "\n", $diff_lines );
2844 * This function works like "use VERSION" in Perl, the program will die with a
2845 * backtrace if the current version of PHP is less than the version provided
2847 * This is useful for extensions which due to their nature are not kept in sync
2848 * with releases, and might depend on other versions of PHP than the main code
2850 * Note: PHP might die due to parsing errors in some cases before it ever
2851 * manages to call this function, such is life
2853 * @see perldoc -f use
2855 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2856 * @throws MWException
2858 function wfUsePHP( $req_ver ) {
2859 $php_ver = PHP_VERSION
;
2861 if ( version_compare( $php_ver, (string)$req_ver, '<' ) ) {
2862 throw new MWException( "PHP $req_ver required--this is only $php_ver" );
2867 * This function works like "use VERSION" in Perl except it checks the version
2868 * of MediaWiki, the program will die with a backtrace if the current version
2869 * of MediaWiki is less than the version provided.
2871 * This is useful for extensions which due to their nature are not kept in sync
2874 * Note: Due to the behavior of PHP's version_compare() which is used in this
2875 * function, if you want to allow the 'wmf' development versions add a 'c' (or
2876 * any single letter other than 'a', 'b' or 'p') as a post-fix to your
2877 * targeted version number. For example if you wanted to allow any variation
2878 * of 1.22 use `wfUseMW( '1.22c' )`. Using an 'a' or 'b' instead of 'c' will
2879 * not result in the same comparison due to the internal logic of
2880 * version_compare().
2882 * @see perldoc -f use
2884 * @deprecated since 1.26, use the "requires' property of extension.json
2885 * @param string|int|float $req_ver The version to check, can be a string, an integer, or a float
2886 * @throws MWException
2888 function wfUseMW( $req_ver ) {
2891 if ( version_compare( $wgVersion, (string)$req_ver, '<' ) ) {
2892 throw new MWException( "MediaWiki $req_ver required--this is only $wgVersion" );
2897 * Return the final portion of a pathname.
2898 * Reimplemented because PHP5's "basename()" is buggy with multibyte text.
2899 * http://bugs.php.net/bug.php?id=33898
2901 * PHP's basename() only considers '\' a pathchar on Windows and Netware.
2902 * We'll consider it so always, as we don't want '\s' in our Unix paths either.
2904 * @param string $path
2905 * @param string $suffix String to remove if present
2908 function wfBaseName( $path, $suffix = '' ) {
2909 if ( $suffix == '' ) {
2912 $encSuffix = '(?:' . preg_quote( $suffix, '#' ) . ')?';
2916 if ( preg_match( "#([^/\\\\]*?){$encSuffix}[/\\\\]*$#", $path, $matches ) ) {
2924 * Generate a relative path name to the given file.
2925 * May explode on non-matching case-insensitive paths,
2926 * funky symlinks, etc.
2928 * @param string $path Absolute destination path including target filename
2929 * @param string $from Absolute source path, directory only
2932 function wfRelativePath( $path, $from ) {
2933 // Normalize mixed input on Windows...
2934 $path = str_replace( '/', DIRECTORY_SEPARATOR
, $path );
2935 $from = str_replace( '/', DIRECTORY_SEPARATOR
, $from );
2937 // Trim trailing slashes -- fix for drive root
2938 $path = rtrim( $path, DIRECTORY_SEPARATOR
);
2939 $from = rtrim( $from, DIRECTORY_SEPARATOR
);
2941 $pieces = explode( DIRECTORY_SEPARATOR
, dirname( $path ) );
2942 $against = explode( DIRECTORY_SEPARATOR
, $from );
2944 if ( $pieces[0] !== $against[0] ) {
2945 // Non-matching Windows drive letters?
2946 // Return a full path.
2950 // Trim off common prefix
2951 while ( count( $pieces ) && count( $against )
2952 && $pieces[0] == $against[0] ) {
2953 array_shift( $pieces );
2954 array_shift( $against );
2957 // relative dots to bump us to the parent
2958 while ( count( $against ) ) {
2959 array_unshift( $pieces, '..' );
2960 array_shift( $against );
2963 array_push( $pieces, wfBaseName( $path ) );
2965 return implode( DIRECTORY_SEPARATOR
, $pieces );
2969 * Convert an arbitrarily-long digit string from one numeric base
2970 * to another, optionally zero-padding to a minimum column width.
2972 * Supports base 2 through 36; digit values 10-36 are represented
2973 * as lowercase letters a-z. Input is case-insensitive.
2975 * @deprecated 1.27 Use Wikimedia\base_convert() directly
2977 * @param string $input Input number
2978 * @param int $sourceBase Base of the input number
2979 * @param int $destBase Desired base of the output
2980 * @param int $pad Minimum number of digits in the output (pad with zeroes)
2981 * @param bool $lowercase Whether to output in lowercase or uppercase
2982 * @param string $engine Either "gmp", "bcmath", or "php"
2983 * @return string|bool The output number as a string, or false on error
2985 function wfBaseConvert( $input, $sourceBase, $destBase, $pad = 1,
2986 $lowercase = true, $engine = 'auto'
2988 return Wikimedia\base_convert
( $input, $sourceBase, $destBase, $pad, $lowercase, $engine );
2992 * @deprecated since 1.27, PHP's session generation isn't used with
2993 * MediaWiki\\Session\\SessionManager
2995 function wfFixSessionID() {
2996 wfDeprecated( __FUNCTION__
, '1.27' );
3000 * Reset the session id
3002 * @deprecated since 1.27, use MediaWiki\\Session\\SessionManager instead
3005 function wfResetSessionID() {
3006 wfDeprecated( __FUNCTION__
, '1.27' );
3007 $session = SessionManager
::getGlobalSession();
3008 $delay = $session->delaySave();
3010 $session->resetId();
3012 // Make sure a session is started, since that's what the old
3013 // wfResetSessionID() did.
3014 if ( session_id() !== $session->getId() ) {
3015 wfSetupSession( $session->getId() );
3018 ScopedCallback
::consume( $delay );
3022 * Initialise php session
3024 * @deprecated since 1.27, use MediaWiki\\Session\\SessionManager instead.
3025 * Generally, "using" SessionManager will be calling ->getSessionById() or
3026 * ::getGlobalSession() (depending on whether you were passing $sessionId
3027 * here), then calling $session->persist().
3028 * @param bool|string $sessionId
3030 function wfSetupSession( $sessionId = false ) {
3031 wfDeprecated( __FUNCTION__
, '1.27' );
3034 session_id( $sessionId );
3037 $session = SessionManager
::getGlobalSession();
3038 $session->persist();
3040 if ( session_id() !== $session->getId() ) {
3041 session_id( $session->getId() );
3043 MediaWiki\
quietCall( 'session_start' );
3047 * Get an object from the precompiled serialized directory
3049 * @param string $name
3050 * @return mixed The variable on success, false on failure
3052 function wfGetPrecompiledData( $name ) {
3055 $file = "$IP/serialized/$name";
3056 if ( file_exists( $file ) ) {
3057 $blob = file_get_contents( $file );
3059 return unserialize( $blob );
3066 * Make a cache key for the local wiki.
3068 * @param string $args,...
3071 function wfMemcKey( /*...*/ ) {
3072 return call_user_func_array(
3073 [ ObjectCache
::getLocalClusterInstance(), 'makeKey' ],
3079 * Make a cache key for a foreign DB.
3081 * Must match what wfMemcKey() would produce in context of the foreign wiki.
3084 * @param string $prefix
3085 * @param string $args,...
3088 function wfForeignMemcKey( $db, $prefix /*...*/ ) {
3089 $args = array_slice( func_get_args(), 2 );
3090 $keyspace = $prefix ?
"$db-$prefix" : $db;
3091 return call_user_func_array(
3092 [ ObjectCache
::getLocalClusterInstance(), 'makeKeyInternal' ],
3093 [ $keyspace, $args ]
3098 * Make a cache key with database-agnostic prefix.
3100 * Doesn't have a wiki-specific namespace. Uses a generic 'global' prefix
3101 * instead. Must have a prefix as otherwise keys that use a database name
3102 * in the first segment will clash with wfMemcKey/wfForeignMemcKey.
3105 * @param string $args,...
3108 function wfGlobalCacheKey( /*...*/ ) {
3109 return call_user_func_array(
3110 [ ObjectCache
::getLocalClusterInstance(), 'makeGlobalKey' ],
3116 * Get an ASCII string identifying this wiki
3117 * This is used as a prefix in memcached keys
3121 function wfWikiID() {
3122 global $wgDBprefix, $wgDBname;
3123 if ( $wgDBprefix ) {
3124 return "$wgDBname-$wgDBprefix";
3131 * Split a wiki ID into DB name and table prefix
3133 * @param string $wiki
3137 function wfSplitWikiID( $wiki ) {
3138 $bits = explode( '-', $wiki, 2 );
3139 if ( count( $bits ) < 2 ) {
3146 * Get a Database object.
3148 * @param int $db Index of the connection to get. May be DB_MASTER for the
3149 * master (for write queries), DB_SLAVE for potentially lagged read
3150 * queries, or an integer >= 0 for a particular server.
3152 * @param string|string[] $groups Query groups. An array of group names that this query
3153 * belongs to. May contain a single string if the query is only
3156 * @param string|bool $wiki The wiki ID, or false for the current wiki
3158 * Note: multiple calls to wfGetDB(DB_SLAVE) during the course of one request
3159 * will always return the same object, unless the underlying connection or load
3160 * balancer is manually destroyed.
3162 * Note 2: use $this->getDB() in maintenance scripts that may be invoked by
3163 * updater to ensure that a proper database is being updated.
3165 * @return DatabaseBase
3167 function wfGetDB( $db, $groups = [], $wiki = false ) {
3168 return wfGetLB( $wiki )->getConnection( $db, $groups, $wiki );
3172 * Get a load balancer object.
3174 * @param string|bool $wiki Wiki ID, or false for the current wiki
3175 * @return LoadBalancer
3177 function wfGetLB( $wiki = false ) {
3178 return wfGetLBFactory()->getMainLB( $wiki );
3182 * Get the load balancer factory object
3186 function wfGetLBFactory() {
3187 return LBFactory
::singleton();
3192 * Shortcut for RepoGroup::singleton()->findFile()
3194 * @param string $title String or Title object
3195 * @param array $options Associative array of options (see RepoGroup::findFile)
3196 * @return File|bool File, or false if the file does not exist
3198 function wfFindFile( $title, $options = [] ) {
3199 return RepoGroup
::singleton()->findFile( $title, $options );
3203 * Get an object referring to a locally registered file.
3204 * Returns a valid placeholder object if the file does not exist.
3206 * @param Title|string $title
3207 * @return LocalFile|null A File, or null if passed an invalid Title
3209 function wfLocalFile( $title ) {
3210 return RepoGroup
::singleton()->getLocalRepo()->newFile( $title );
3214 * Should low-performance queries be disabled?
3217 * @codeCoverageIgnore
3219 function wfQueriesMustScale() {
3220 global $wgMiserMode;
3222 ||
( SiteStats
::pages() > 100000
3223 && SiteStats
::edits() > 1000000
3224 && SiteStats
::users() > 10000 );
3228 * Get the path to a specified script file, respecting file
3229 * extensions; this is a wrapper around $wgScriptPath etc.
3230 * except for 'index' and 'load' which use $wgScript/$wgLoadScript
3232 * @param string $script Script filename, sans extension
3235 function wfScript( $script = 'index' ) {
3236 global $wgScriptPath, $wgScript, $wgLoadScript;
3237 if ( $script === 'index' ) {
3239 } elseif ( $script === 'load' ) {
3240 return $wgLoadScript;
3242 return "{$wgScriptPath}/{$script}.php";
3247 * Get the script URL.
3249 * @return string Script URL
3251 function wfGetScriptUrl() {
3252 if ( isset( $_SERVER['SCRIPT_NAME'] ) ) {
3253 /* as it was called, minus the query string.
3255 * Some sites use Apache rewrite rules to handle subdomains,
3256 * and have PHP set up in a weird way that causes PHP_SELF
3257 * to contain the rewritten URL instead of the one that the
3258 * outside world sees.
3260 * If in this mode, use SCRIPT_URL instead, which mod_rewrite
3261 * provides containing the "before" URL.
3263 return $_SERVER['SCRIPT_NAME'];
3265 return $_SERVER['URL'];
3270 * Convenience function converts boolean values into "true"
3271 * or "false" (string) values
3273 * @param bool $value
3276 function wfBoolToStr( $value ) {
3277 return $value ?
'true' : 'false';
3281 * Get a platform-independent path to the null file, e.g. /dev/null
3285 function wfGetNull() {
3286 return wfIsWindows() ?
'NUL' : '/dev/null';
3290 * Waits for the slaves to catch up to the master position
3292 * Use this when updating very large numbers of rows, as in maintenance scripts,
3293 * to avoid causing too much lag. Of course, this is a no-op if there are no slaves.
3295 * By default this waits on the main DB cluster of the current wiki.
3296 * If $cluster is set to "*" it will wait on all DB clusters, including
3297 * external ones. If the lag being waiting on is caused by the code that
3298 * does this check, it makes since to use $ifWritesSince, particularly if
3299 * cluster is "*", to avoid excess overhead.
3301 * Never call this function after a big DB write that is still in a transaction.
3302 * This only makes sense after the possible lag inducing changes were committed.
3304 * @param float|null $ifWritesSince Only wait if writes were done since this UNIX timestamp
3305 * @param string|bool $wiki Wiki identifier accepted by wfGetLB
3306 * @param string|bool $cluster Cluster name accepted by LBFactory. Default: false.
3307 * @param int|null $timeout Max wait time. Default: 1 day (cli), ~10 seconds (web)
3308 * @return bool Success (able to connect and no timeouts reached)
3309 * @deprecated since 1.27 Use LBFactory::waitForReplication
3311 function wfWaitForSlaves(
3312 $ifWritesSince = null, $wiki = false, $cluster = false, $timeout = null
3314 if ( $timeout === null ) {
3315 $timeout = ( PHP_SAPI
=== 'cli' ) ?
86400 : 10;
3318 if ( $cluster === '*' ) {
3321 } elseif ( $wiki === false ) {
3326 wfGetLBFactory()->waitForReplication( [
3328 'cluster' => $cluster,
3329 'timeout' => $timeout,
3330 // B/C: first argument used to be "max seconds of lag"; ignore such values
3331 'ifWritesSince' => ( $ifWritesSince > 1e9
) ?
$ifWritesSince : null
3333 } catch ( DBReplicationWaitError
$e ) {
3341 * Count down from $seconds to zero on the terminal, with a one-second pause
3342 * between showing each number. For use in command-line scripts.
3344 * @codeCoverageIgnore
3345 * @param int $seconds
3347 function wfCountDown( $seconds ) {
3348 for ( $i = $seconds; $i >= 0; $i-- ) {
3349 if ( $i != $seconds ) {
3350 echo str_repeat( "\x08", strlen( $i +
1 ) );
3362 * Replace all invalid characters with -
3363 * Additional characters can be defined in $wgIllegalFileChars (see bug 20489)
3364 * By default, $wgIllegalFileChars = ':'
3366 * @param string $name Filename to process
3369 function wfStripIllegalFilenameChars( $name ) {
3370 global $wgIllegalFileChars;
3371 $illegalFileChars = $wgIllegalFileChars ?
"|[" . $wgIllegalFileChars . "]" : '';
3372 $name = wfBaseName( $name );
3373 $name = preg_replace(
3374 "/[^" . Title
::legalChars() . "]" . $illegalFileChars . "/",
3382 * Set PHP's memory limit to the larger of php.ini or $wgMemoryLimit
3384 * @return int Resulting value of the memory limit.
3386 function wfMemoryLimit() {
3387 global $wgMemoryLimit;
3388 $memlimit = wfShorthandToInteger( ini_get( 'memory_limit' ) );
3389 if ( $memlimit != -1 ) {
3390 $conflimit = wfShorthandToInteger( $wgMemoryLimit );
3391 if ( $conflimit == -1 ) {
3392 wfDebug( "Removing PHP's memory limit\n" );
3393 MediaWiki\
suppressWarnings();
3394 ini_set( 'memory_limit', $conflimit );
3395 MediaWiki\restoreWarnings
();
3397 } elseif ( $conflimit > $memlimit ) {
3398 wfDebug( "Raising PHP's memory limit to $conflimit bytes\n" );
3399 MediaWiki\
suppressWarnings();
3400 ini_set( 'memory_limit', $conflimit );
3401 MediaWiki\restoreWarnings
();
3409 * Set PHP's time limit to the larger of php.ini or $wgTransactionalTimeLimit
3411 * @return int Prior time limit
3414 function wfTransactionalTimeLimit() {
3415 global $wgTransactionalTimeLimit;
3417 $timeLimit = ini_get( 'max_execution_time' );
3418 // Note that CLI scripts use 0
3419 if ( $timeLimit > 0 && $wgTransactionalTimeLimit > $timeLimit ) {
3420 set_time_limit( $wgTransactionalTimeLimit );
3423 ignore_user_abort( true ); // ignore client disconnects
3429 * Converts shorthand byte notation to integer form
3431 * @param string $string
3432 * @param int $default Returned if $string is empty
3435 function wfShorthandToInteger( $string = '', $default = -1 ) {
3436 $string = trim( $string );
3437 if ( $string === '' ) {
3440 $last = $string[strlen( $string ) - 1];
3441 $val = intval( $string );
3446 // break intentionally missing
3450 // break intentionally missing
3460 * Get the normalised IETF language tag
3461 * See unit test for examples.
3463 * @param string $code The language code.
3464 * @return string The language code which complying with BCP 47 standards.
3466 function wfBCP47( $code ) {
3467 $codeSegment = explode( '-', $code );
3469 foreach ( $codeSegment as $segNo => $seg ) {
3470 // when previous segment is x, it is a private segment and should be lc
3471 if ( $segNo > 0 && strtolower( $codeSegment[( $segNo - 1 )] ) == 'x' ) {
3472 $codeBCP[$segNo] = strtolower( $seg );
3473 // ISO 3166 country code
3474 } elseif ( ( strlen( $seg ) == 2 ) && ( $segNo > 0 ) ) {
3475 $codeBCP[$segNo] = strtoupper( $seg );
3476 // ISO 15924 script code
3477 } elseif ( ( strlen( $seg ) == 4 ) && ( $segNo > 0 ) ) {
3478 $codeBCP[$segNo] = ucfirst( strtolower( $seg ) );
3479 // Use lowercase for other cases
3481 $codeBCP[$segNo] = strtolower( $seg );
3484 $langCode = implode( '-', $codeBCP );
3489 * Get a specific cache object.
3491 * @param int|string $cacheType A CACHE_* constants, or other key in $wgObjectCaches
3494 function wfGetCache( $cacheType ) {
3495 return ObjectCache
::getInstance( $cacheType );
3499 * Get the main cache object
3503 function wfGetMainCache() {
3504 global $wgMainCacheType;
3505 return ObjectCache
::getInstance( $wgMainCacheType );
3509 * Get the cache object used by the message cache
3513 function wfGetMessageCacheStorage() {
3514 global $wgMessageCacheType;
3515 return ObjectCache
::getInstance( $wgMessageCacheType );
3519 * Get the cache object used by the parser cache
3523 function wfGetParserCacheStorage() {
3524 global $wgParserCacheType;
3525 return ObjectCache
::getInstance( $wgParserCacheType );
3529 * Call hook functions defined in $wgHooks
3531 * @param string $event Event name
3532 * @param array $args Parameters passed to hook functions
3533 * @param string|null $deprecatedVersion Optionally mark hook as deprecated with version number
3535 * @return bool True if no handler aborted the hook
3536 * @deprecated 1.25 - use Hooks::run
3538 function wfRunHooks( $event, array $args = [], $deprecatedVersion = null ) {
3539 return Hooks
::run( $event, $args, $deprecatedVersion );
3543 * Wrapper around php's unpack.
3545 * @param string $format The format string (See php's docs)
3546 * @param string $data A binary string of binary data
3547 * @param int|bool $length The minimum length of $data or false. This is to
3548 * prevent reading beyond the end of $data. false to disable the check.
3550 * Also be careful when using this function to read unsigned 32 bit integer
3551 * because php might make it negative.
3553 * @throws MWException If $data not long enough, or if unpack fails
3554 * @return array Associative array of the extracted data
3556 function wfUnpack( $format, $data, $length = false ) {
3557 if ( $length !== false ) {
3558 $realLen = strlen( $data );
3559 if ( $realLen < $length ) {
3560 throw new MWException( "Tried to use wfUnpack on a "
3561 . "string of length $realLen, but needed one "
3562 . "of at least length $length."
3567 MediaWiki\
suppressWarnings();
3568 $result = unpack( $format, $data );
3569 MediaWiki\restoreWarnings
();
3571 if ( $result === false ) {
3572 // If it cannot extract the packed data.
3573 throw new MWException( "unpack could not unpack binary data" );
3579 * Determine if an image exists on the 'bad image list'.
3581 * The format of MediaWiki:Bad_image_list is as follows:
3582 * * Only list items (lines starting with "*") are considered
3583 * * The first link on a line must be a link to a bad image
3584 * * Any subsequent links on the same line are considered to be exceptions,
3585 * i.e. articles where the image may occur inline.
3587 * @param string $name The image name to check
3588 * @param Title|bool $contextTitle The page on which the image occurs, if known
3589 * @param string $blacklist Wikitext of a file blacklist
3592 function wfIsBadImage( $name, $contextTitle = false, $blacklist = null ) {
3593 # Handle redirects; callers almost always hit wfFindFile() anyway,
3594 # so just use that method because it has a fast process cache.
3595 $file = wfFindFile( $name ); // get the final name
3596 $name = $file ?
$file->getTitle()->getDBkey() : $name;
3598 # Run the extension hook
3600 if ( !Hooks
::run( 'BadImage', [ $name, &$bad ] ) ) {
3604 $cache = ObjectCache
::getLocalServerInstance( 'hash' );
3605 $key = wfMemcKey( 'bad-image-list', ( $blacklist === null ) ?
'default' : md5( $blacklist ) );
3606 $badImages = $cache->get( $key );
3608 if ( $badImages === false ) { // cache miss
3609 if ( $blacklist === null ) {
3610 $blacklist = wfMessage( 'bad_image_list' )->inContentLanguage()->plain(); // site list
3612 # Build the list now
3614 $lines = explode( "\n", $blacklist );
3615 foreach ( $lines as $line ) {
3617 if ( substr( $line, 0, 1 ) !== '*' ) {
3623 if ( !preg_match_all( '/\[\[:?(.*?)\]\]/', $line, $m ) ) {
3628 $imageDBkey = false;
3629 foreach ( $m[1] as $i => $titleText ) {
3630 $title = Title
::newFromText( $titleText );
3631 if ( !is_null( $title ) ) {
3633 $imageDBkey = $title->getDBkey();
3635 $exceptions[$title->getPrefixedDBkey()] = true;
3640 if ( $imageDBkey !== false ) {
3641 $badImages[$imageDBkey] = $exceptions;
3644 $cache->set( $key, $badImages, 60 );
3647 $contextKey = $contextTitle ?
$contextTitle->getPrefixedDBkey() : false;
3648 $bad = isset( $badImages[$name] ) && !isset( $badImages[$name][$contextKey] );
3654 * Determine whether the client at a given source IP is likely to be able to
3655 * access the wiki via HTTPS.
3657 * @param string $ip The IPv4/6 address in the normal human-readable form
3660 function wfCanIPUseHTTPS( $ip ) {
3662 Hooks
::run( 'CanIPUseHTTPS', [ $ip, &$canDo ] );
3667 * Determine input string is represents as infinity
3669 * @param string $str The string to determine
3673 function wfIsInfinity( $str ) {
3674 $infinityValues = [ 'infinite', 'indefinite', 'infinity', 'never' ];
3675 return in_array( $str, $infinityValues );
3679 * Returns true if these thumbnail parameters match one that MediaWiki
3680 * requests from file description pages and/or parser output.
3682 * $params is considered non-standard if they involve a non-standard
3683 * width or any non-default parameters aside from width and page number.
3684 * The number of possible files with standard parameters is far less than
3685 * that of all combinations; rate-limiting for them can thus be more generious.
3688 * @param array $params
3690 * @since 1.24 Moved from thumb.php to GlobalFunctions in 1.25
3692 function wfThumbIsStandard( File
$file, array $params ) {
3693 global $wgThumbLimits, $wgImageLimits, $wgResponsiveImages;
3695 $multipliers = [ 1 ];
3696 if ( $wgResponsiveImages ) {
3697 // These available sizes are hardcoded currently elsewhere in MediaWiki.
3698 // @see Linker::processResponsiveImages
3699 $multipliers[] = 1.5;
3703 $handler = $file->getHandler();
3704 if ( !$handler ||
!isset( $params['width'] ) ) {
3709 if ( isset( $params['page'] ) ) {
3710 $basicParams['page'] = $params['page'];
3715 // Expand limits to account for multipliers
3716 foreach ( $multipliers as $multiplier ) {
3717 $thumbLimits = array_merge( $thumbLimits, array_map(
3718 function ( $width ) use ( $multiplier ) {
3719 return round( $width * $multiplier );
3722 $imageLimits = array_merge( $imageLimits, array_map(
3723 function ( $pair ) use ( $multiplier ) {
3725 round( $pair[0] * $multiplier ),
3726 round( $pair[1] * $multiplier ),
3732 // Check if the width matches one of $wgThumbLimits
3733 if ( in_array( $params['width'], $thumbLimits ) ) {
3734 $normalParams = $basicParams +
[ 'width' => $params['width'] ];
3735 // Append any default values to the map (e.g. "lossy", "lossless", ...)
3736 $handler->normaliseParams( $file, $normalParams );
3738 // If not, then check if the width matchs one of $wgImageLimits
3740 foreach ( $imageLimits as $pair ) {
3741 $normalParams = $basicParams +
[ 'width' => $pair[0], 'height' => $pair[1] ];
3742 // Decide whether the thumbnail should be scaled on width or height.
3743 // Also append any default values to the map (e.g. "lossy", "lossless", ...)
3744 $handler->normaliseParams( $file, $normalParams );
3745 // Check if this standard thumbnail size maps to the given width
3746 if ( $normalParams['width'] == $params['width'] ) {
3752 return false; // not standard for description pages
3756 // Check that the given values for non-page, non-width, params are just defaults
3757 foreach ( $params as $key => $value ) {
3758 if ( !isset( $normalParams[$key] ) ||
$normalParams[$key] != $value ) {
3767 * Merges two (possibly) 2 dimensional arrays into the target array ($baseArray).
3769 * Values that exist in both values will be combined with += (all values of the array
3770 * of $newValues will be added to the values of the array of $baseArray, while values,
3771 * that exists in both, the value of $baseArray will be used).
3773 * @param array $baseArray The array where you want to add the values of $newValues to
3774 * @param array $newValues An array with new values
3775 * @return array The combined array
3778 function wfArrayPlus2d( array $baseArray, array $newValues ) {
3779 // First merge items that are in both arrays
3780 foreach ( $baseArray as $name => &$groupVal ) {
3781 if ( isset( $newValues[$name] ) ) {
3782 $groupVal +
= $newValues[$name];
3785 // Now add items that didn't exist yet
3786 $baseArray +
= $newValues;